Skip to content

Latest commit

 

History

History
141 lines (109 loc) · 4.8 KB

README.md

File metadata and controls

141 lines (109 loc) · 4.8 KB
Raw

sourcify-monitor

Sourcify Monitor is a standalone service that listens to various EVM chains for new contract creations and automatically submits them to the Sourcify API for verification.

This is only possible for Solidity contracts that has its metadata hash published in a DecentralizedStorage (IPFS, Swarm, etc). Currently only IPFS is supported.

Learn more about the contract metadata in the Solidity docs and Sourcify docs. We also have a nice playground showing everthing in action at playground.sourcify.dev.

Config

Chains to Monitor

First you need to provide which chains to monitor in a json file.

[
  {
    "chainId": 1,
    "name": "Ethereum Mainnet",
    "rpc": ["http://localhost:8545", "https://mainnet.infura.io/v3/{INFURA_API_KEY}"],
  },
  {
    "chainId": 11155111,
    "name": "Ethereum Sepolia Testnet",
    "rpc": ["http://localhost:8545", "https://rpc2.sepolia.org/ "],
  },
  ...
]

Infura and Alchemy keys must be placed in the url string as above in {INFURA_API_KEY}

See chains.json for a full example and to see which chains we monitor ourselves. You can also use the chainid.network/chains.json to find chains.

Monitor Config

Optionally you can pass a monitor config in a config.json file. If you don't, the default config will be used. If you leave any field blank, it will be filled with the default config.

The structure of the file is as such:

  decentralizedStorages: {
    ipfs: {
      enabled: true,
      gateways: ["https://ipfs.io/ipfs/", "http://localhost:8080/ipfs/"],
      // Time when the request to the gateway will timeout i.e. canceled in ms
      timeout: 30000,
      // Time between each request to the gateway in ms
      interval: 5000,
      // Number of retries before giving up
      retries: 5,
    },
    // can also have swarm
  },
  // Sourcify instances to verify the contracts on. Can be multiple
  sourcifyServerURLs: ["https://sourcify.dev/server/", "http://localhost:5555/"],
  defaultChainConfig: {
    // Block to start monitoring from. If undefined, it will start from the latest block by asking the RPC `eth_blockNumber`
    startBlock: undefined,
    // Time between each block check in ms. This value is dynamically adjusted based on the block time.
    // When a block is successfully fetched, it's decreased by `blockIntervalFactor`, and vice versa.
    blockInterval: 10000,
    // The factor to increase/decrease the block interval by. Must be greater than 1.
    blockIntervalFactor: 1.1,
    // The upper and lower limit of the block interval in ms
    blockIntervalUpperLimit: 300000,
    blockIntervalLowerLimit: 100,
    // Time between each `eth_getCode` requets in ms
    bytecodeInterval: 5000,
    // Number of retries before giving up getting the contract bytecode.
    bytecodeNumberOfTries: 5,
  },
  // Can also pass each chain the same config as above. Non specified fields will be filled with the defaultChainConfig. Non specified chains will use the whole defaultChainConfig.
  chainConfigs: {
    1: {
      startBlock: 10000000,
      blockInterval: 12000, // Ethereum mainnet is set to 12s
    }
  }

Environment variables

By default you can pass the following environment variables in .env.template for authenticating with the RPCs:

# If your RPCs are Alchemy or Infura
# In the rpc url it must have {INFURA_API_KEY} or {ALCHEMY_API_KEY}
ALCHEMY_API_KEY=
INFURA_API_KEY=

# ethpandaops.io authentication
CF_ACCESS_CLIENT_ID=
CF_ACCESS_CLIENT_SECRET=

Usage

You can run the Sourcify Monitor in two ways:

1. Run locally

Clone the Sourcify monorepo

git clone [email protected]:ethereum/sourcify.git
cd sourcify

Install and build the project:

npm install
npx lerna run build --scope sourcify-monitor

Run

node dist/index.js --chainsPath /path/to/chains.json --configPath /path/to/config.json

The --chainsPath and --configPath are optional. If not provided, the default paths will be used.

2. Run via Docker

The containers are published in the Github Container Registry

The recommended way to run the Sourcify Monitor is via Docker.

You need to pass the chains.json and config.json files to the container. You can do this by mounting them as volumes:

$ docker pull ghcr.io/ethereum/sourcify/monitor:latest
$ docker run \
  -v /path/to/chains.json:/home/app/services/monitor/chains.json \
  -v /path/to/config.json:/home/app/services/monitor/config.json \
  -e ALCHEMY_API_KEY=xxx \
  -e INFURA_API_KEY=xxx \
  ghcr.io/ethereum/sourcify/monitor:latest