Contracts through which API3 services are delivered
This package provides the tools to integrate data feeds that can be found at the API3 Market. The typical workflow is as follows:
- Purchase data feed subscriptions at the API3 Market
- Deploy the respective DapiProxyWithOev contracts at the API3 Market
- Use the proxy contract interfaces provided by this package in the reader contract, as demonstrated in https://github.com/api3dao/data-feed-reader-example
- Use the proxy address computation utility functions provided by this package to validate the proxy addresses being used
A more complete list of what this package includes is as follows:
- All contracts that facilitate API3 data feed services
@typechain/ethers-v6
typings of these contracts- Addresses of the API3 deployments of these contracts
- Proxy address computation utility functions
We have conducted 10+ audits of our contracts and their off-chain components. Below are the reports of the ones that are directly related to the contracts in this repo (or in some cases, earlier versions of them).
- 2024-02-20 Quantstamp
- 2023-12-20 Quantstamp
- 2023-03-02 Sigma Prime
- 2022-03-30 Trail of Bits
- 2021-12-16 Sigma Prime
For bug reports, contact [email protected]
Install the dependencies and build
pnpm i && pnpm build
Test the contracts, get coverage and gas reports
pnpm test
pnpm test:extended
# Outputs to `./coverage`
pnpm test:coverage
# Outputs to `gas_report`
pnpm test:gas
Verify that the vendor contracts are identical to the ones from their respective packages.
pnpm verify-vendor-contracts
It should print
Checking if contracts in @openzeppelin/[email protected] are identical to the ones in the package at https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-4.8.2.tgz
Strings.sol is identical!
Create2.sol is identical!
Context.sol is identical!
Address.sol is identical!
Ownable.sol is identical!
IAccessControl.sol is identical!
AccessControl.sol is identical!
Math.sol is identical!
IERC165.sol is identical!
ERC165.sol is identical!
ECDSA.sol is identical!
Checking if contracts in @openzeppelin/[email protected] are identical to the ones in the package at https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-4.9.5.tgz
Strings.sol is identical!
Context.sol is identical!
Ownable.sol is identical!
SignedMath.sol is identical!
SafeCast.sol is identical!
Math.sol is identical!
EnumerableSet.sol is identical!
MerkleProof.sol is identical!
ECDSA.sol is identical!
Validate the deployment config
pnpm validate-deployment-config
Verify the deployments and validate their current state
# on all chains
pnpm verify-deployments
# or a single chain
NETWORK=ethereum pnpm verify-deployments
# on all chains
pnpm validate-deployments
# or a single chain
NETWORK=ethereum pnpm validate-deployments