Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 4.47 KB

new_network.md

File metadata and controls

104 lines (75 loc) · 4.47 KB
Error in user YAML: (<unknown>): did not find expected key while parsing a block mapping at line 1 column 1
---
name:  Support new network
title: 'feat: add support for ' 'network'
labels: enhancement, network

---

Add relevant issue here

Fixes #

Fill out the following fields

Network:
Chain ID:

Make sure all points are addressed. This is a list for adding full network support to the exporter.

To configure the network correctly you must add the following constants:

  • in ./yearn/networks.py:

    • specify the chainid in the same way as the others.
    • specify a network label in Networks.label.

  • in ./yearn/constants.py:

    • specify Treasury address. (if Yearn has a treasury contract deployed) This would be the rewards() address of any vault.
    • specify Multisig address. This would be the governance() address of any vault
    • specify Strategist Multisig address. (if Yearn has a SMS deployed) This would be the management() address of any vault.

  • in ./yearn/prices/constants.py:

    • add weth address to tokens_by_network.
    • add usdc address to tokens_by_network.
    • add dai address to tokens_by_network.
    • configure stablecoins using popular + "safe" stablecoins on the chain.
    • add the {{network}} gas token address to wrapped_gas_coin field.

  • in ./yearn/multicall2.py:

    • specify the appropriate multicall2 contract address.

  • in ./yearn/prices/chainlink.py:

    • specify any chainlink feeds available on the chain in feeds.
    • specify the chainlink registry address in registries if applicable, or specify None if not applicable.

  • in ./yearn/ironbank.py:

    • add ironbank deployment address

  • in ./yearn/prices/compound.py:

    • add ib comptroller

  • in ./yearn/v2/registry.py:

    • add v2 vault registry

  • in yearn/yearn.py:

    • add v2 vault registry and
    • [ ]ironbank registry

  • in ./yearn/prices/constants.py:

    • specify ib_snapshot_block_by_network, if any, the start block of Ironbank on this network or specify '1' if not applicable.

  • in ./yearn/prices/uniswap/v2.py:

    • specify the factory and router address for any important uni v2 forks on the chain.

in ./yearn/prices/uniswap/v3.py:

  • add info about uni v3 deployed on network

  • in ./yearn/utils.py:

    • specify BINARY_SEARCH_BARRIER as 0 if all historical data is available. If historical data not available due to a network upgrade/etc, specify the first block of the available historical data.

  • in ./yearn/middleware/middleware.py:

    • specify BATCH_SIZE of approx 1 day based on avg block times on the chain.

  • in ./scripts/historical-exporter.py:

    • configure end to equal the date + hour of deployment for the first Yearn product on the chain.
    • configure data_query. See mapping in ./yearn/outputs/victoria/output_helper.py to figure out the metric to specify based on what type of product was the first deployed on the chain.

  • in ./scripts/historical-treasury-exporter.py:

    • configure end to equal the date + hour of deployment for the Yearn Treasury on the chain.
    • configure data_query using the existing networks as an example.

  • in ./scripts/historical-sms-exporter.py:

    • configure end to equal the date + hour of deployment for the Strategist Multisig on the chain.
    • configure data_query using the existing networks as an example.

You also need to set up containers for each exporter on the new chain. This is a little more complicated but you can use existing containers as an example:

  • define common envs for the chain
  • add one new service entry for forwards exporter
  • add one new service entry for historical exporter
  • add one new service entry for treasury exporter
  • add one new service entry for historical treasury exporter
  • add one new service entry for sms exporter
  • add one new service entry for historical sms exporter
  • add one new service entry for wallet exporter
  • add one new service entry for transactions exporter
  • adapt entrypoint.sh

in ./Makefile: Set up network specific make command.

  • network
  • logs-network

It's important to test to make sure everything works!

Once you've handled everything above, type make up <network> into your terminal replacing network with your network name at the project root. The network specific exporters will start running in docker and any exceptions will show in your terminal. If there are no exceptions, and everything appears to be running smoothly then it should be working correctly.

  • yes I have tested it and it is running as expected