Liquidity-weighted dex price oracle for offchain price discovery
The 1inch spot price aggregator is a set of smart contracts that extract price data for tokens traded on DEXes from the blockchain. To avoid price manipulations within a transaction, the spot price aggregator should ONLY be used off-chain. DO NOT use it on-chain. For off-chain usage see Examples section below.
To handle wrapped tokens, such as wETH, cDAI, aDAI etc., the 1inch spot price aggregator uses custom wrapper smart contracts that wrap/unwrap tokens at the current wrapping exchange rate.
If no direct liquidity pair exists between two tokens, the spot price aggregator calculates rates for those coins using another token that has pairs with both of them – a connector token.
This section provides a comprehensive guide on deploying an oracle, including the nuances of script parameters and additional setup steps. Follow these steps to ensure accurate and reliable oracle deployment for price data retrieval.
SpotPriceAggregator
or are forks of supported protocols. Supported DEXes can be found in the contracts/oracles/
directory of the project.registerAll
method in the Networks
class. If your network is listed there, it's considered supported, and no further action is required for registration in this step.Networks
class from solidity-utils for network registration....
const { Networks } = require('@1inch/solidity-utils/hardhat-setup');
const net = new Networks(true, 'mainnet', true);
net.register(your_network_name, networkId, process.env.YOURNETWORK_RPC_URL, process.env.YOURNETWORK_PRIVATE_KEY, etherscan_network_name, process.env.YOURNETWORK_ETHERSCAN_KEY);
const networks = net.networks;
const etherscan = net.etherscan;
...
Set Environment Variables: Define necessary environment variables in the .env
file located at the project root. Include variables such as YOURNETWORK_RPC_URL
, YOURNETWORK_PRIVATE_KEY
, and YOURNETWORK_ETHERSCAN_KEY
with appropriate values:
YOURNETWORK_RPC_URL
: The RPC URL for accessing your network's node. This URL can support the HTTP header 'auth-key'. To use this header, append the header value to the URL using the |
symbol. For example: http://localhost:8545|HeaderValue
. This format allows you to authenticate requests to your node.
YOURNETWORK_PRIVATE_KEY
: Your account's private key, which should be entered without the 0x
prefix. This key is used for deploying contracts and executing transactions on the network.
YOURNETWORK_ETHERSCAN_KEY
: The API key for an Etherscan-like blockchain explorer that supports your network. This key is necessary for verifying and publishing your contract's source code. Ensure you register for an API key with a compatible explorer service for your network.
deploy/commands/simple-deploy.js
. You can find a description of the script and how to use it in the scripts description.PARAMS
object for each protocol you wish to deploy an oracle for. The parameters include:
contracts/oracles/
directory.deployments/
directory.skip
flag is set to false
to proceed with deployment.yarn && yarn deploy <your_network_name>
.MultiWrapper
. You can find different wrappers in the contracts/wrappers/
directory. After MultiWrapper
is deployed, it will be possible to edit these lists of wrappers.OffchainOracle
. Make sure to include the deployed oracles (from step 5), MultiWrapper
with wrappers (from step 6) and specifying the tokens you wish to use as connectors for price discovery. After OffchainOracle
is deployed, it will be possible to edit these lists of oracles and connectors.For any questions or further assistance, don't hesitate to reach out (for example via issue). This guide aims to facilitate your oracle deployment process, ensuring a smooth and reliable setup.