Merge pull request #119 from 1inch/feature/deployment-guide

[SC-1084] Oracle Deployment Guide

README.md

@@ -510,3 +510,67 @@ If no direct liquidity pair exists between two tokens, the spot price aggregator
 * [Single token-to-ETH price usage](https://github.com/1inch-exchange/offchain-oracle/blob/master/examples/single-price.js)
 
 * [Multiple token-to-ETH prices usage](https://github.com/1inch-exchange/offchain-oracle/blob/master/examples/multiple-prices.js)
+
+## Oracle Deployment Guide
+
+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.
+
+### Step 1: Surveying DEX Liquidity
+
+1. **Identify DEXes with Sufficient Liquidity:** Begin by surveying the network for Decentralized Exchanges (DEXes) that offer sufficient liquidity. This ensures the oracle can retrieve reliable and accurate price data.
+
+### Step 2: Selection of DEXes
+
+2. **Select Supported DEXes:** Choose DEXes that are supported by `SpotPriceAggregator` or are forks of supported protocols. Supported DEXes can be found in the `contracts/oracles/` directory of the project.
+
+### Step 3: Network Configuration
+
+3. **Configure the Network Settings:**
+   - Skip this step if your network is supported. This can be checked by observing whether the network is mentioned (registered or not) during a test run, visible in the console output. This verification can be done also by reviewing the `registerAll` method in the [`Networks` class](https://github.com/1inch/solidity-utils/blob/master/hardhat-setup/networks.ts#L108-L128). If your network is listed there, it's considered supported, and no further action is required for registration in this step.
+   - Update the [Hardhat settings file](https://github.com/1inch/spot-price-aggregator/blob/master/hardhat.config.js) to configure the network.
+   - Utilize the `Networks` class from [solidity-utils](https://github.com/1inch/solidity-utils/blob/master/hardhat-setup/networks.ts) for network registration.
+   - Example configuration snippet:
+     ```javascript
+     ...
+     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;
+     ...
+     ```
+
+### Step 4: Environment Variables
+
+4. **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.
+
+### Step 5: Deploying Oracles
+
+5. **Deploy Oracles:**
+   - Use the deploy script located at `deploy/commands/simple-deploy.js`.
+   - Configure the `PARAMS` object for each protocol you wish to deploy an oracle for. The parameters include:
+      - **contractName**: Name of the contract from the `contracts/oracles/` directory.
+      - **args**: Arguments required by the contract (See contract's constructor).
+      - **deploymentName**: A name for your deployment, which will be used to create a file in the `deployments/` directory.
+   - Ensure the `skip` [flag](https://github.com/1inch/spot-price-aggregator/blob/master/deploy/commands/simple-deploy.js#L25) is set to `false` to proceed with deployment.
+   - Example command for deployment: `yarn && yarn deploy <your_network_name>`.
+
+### Step 6: Deploying Wrappers
+
+6. **Deploy Wrappers:**
+   - Follow similar steps as step 5 to deploy necessary wrappers. You can find it in the `contracts/wrappers/` directory. 
+
+### Step 7: Deploying OffchainOracle
+
+7. **Deploy OffchainOracle:**
+   - Follow similar steps as step 5 to deploy the `OffchainOracle`. Make sure to include the deployed oracles (from step 5), 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, wrappers and connectors.
+
+### Support and Assistance
+
+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.