Skip to content

Commit

Permalink
fix new chain docs
Browse files Browse the repository at this point in the history
  • Loading branch information
0xSpuddy committed Jan 26, 2024
1 parent 9f32ed5 commit d823970
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/add-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

### Steps
1. Skip this entire first step if your chain is listed [here](https://github.com/mds1/multicall#multicall3-contract-addresses). If your chain was not listed at that link (already supported in the multicall package), then deploy your own Multicall contract on your new chain, and after, update `src/telliot_feeds/reporters/tips/__init__.py` to include that contract's address. Again, skip this step if your chain is listed [here](https://github.com/mds1/multicall#multicall3-contract-addresses).
2. Add chain ID to `AUTOPAY_CHAINS` constant in `src/telliot_feeds/reporters/reporter_autopay_utils.py`.
3. Make sure there's a datafeed for the chain's native token in `src/telliot_feeds/feeds/`. If there isn't, add one by following the steps [here](https://tellor-io.github.io/telliot-feeds/add-spot-price/).
4. Support profit checks by updating `get_native_token_feed` in `src/telliot_feeds/utils/reporter_utils.py` to return the datafeed for your new chain's native token.
5. Once you've done a new release of `telliot-core`, update that dependency in this package's `setup.cfg` to the new version.
2. Check if there is a a previously defined feed for the new chain's native token price defined in `src/telliot_feeds/feeds/`. If there is not, add the feed by following the steps [here](https://tellor-io.github.io/telliot-feeds/add-spot-price/).
3. Add the new network ID to the appropriate list in `src/telliot_feeds/constants.py`.
4. If the chain uses a different native token from any of the other networks listed, add the set of chain ids that will use the same native token. E.g.:
`MANTLE_CHAINS = {5001, 5000}`
5. Add your network to `src.telliot_feeds.utils.reporter_utils.get_native_token_feed` and `src.telliot_feeds.utils.reporter_utils.tkn_symbol` (if not already there).
6. Once you've done a new release of `telliot-core`, update that dependency in this package's `setup.cfg` to the new version.

0 comments on commit d823970

Please sign in to comment.