eth-statediff-service

standalone statediffing service ontop of LevelDB

Purpose:

Stand up a statediffing service directly on top of a go-ethereum LevelDB instance. This service can serve historical state data over the same rpc interface as statediffing geth without needing to run a full node

Setup

Build the binary:

make build

Local Setup

• Create a chain config file chain.json according to chain config in genesis json file used by local geth.

  Example:

  {
    "chainId": 41337,
    "homesteadBlock": 0,
    "eip150Block": 0,
    "eip150Hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "eip155Block": 0,
    "eip158Block": 0,
    "byzantiumBlock": 0,
    "constantinopleBlock": 0,
    "petersburgBlock": 0,
    "istanbulBlock": 0,
    "clique": {
      "period": 5,
      "epoch": 30000
    }
  }
  

• Change the following in config file

  [leveldb]
      mode = "local"
      # Path to geth LevelDB data
      path = "/path-to-local-geth-data/chaindata"
      ancient = "/path-to-local-geth-data/chaindata/ancient"
  
  [ethereum]
      chainConfig = "./chain.json" # Path to custom chain config file
      chainID = 41337 # Same chain ID as in chain.json
  
  [database]
      # Update database config
      name     = "vulcanize_testing"
      hostname = "localhost"
      port     = 5432
      user     = "postgres"
      password = "postgres"
      type = "postgres"
  

• To write statediff for a range of block make changes in config file

  [prerun]
      only = false
      ranges = [
          [8, 15] # Block number range for which to write statediff.
      ]
  

• To use remote LevelDB RPC endpoint change the following in config file

  [leveldb]
      mode = "remote"
      url = "http://127.0.0.1:8082/" # Remote LevelDB RPC url
  

Usage

serve

To serve state diffs over RPC:

eth-statediff-service serve --config=<config path>

Example:

./eth-statediff-service serve --config environments/config.toml

Available RPC methods are:

• statediff_stateTrieAt()
• statediff_streamCodeAndCodeHash()
• statediff_stateDiffAt()
• statediff_writeStateDiffAt()
• statediff_writeStateDiffsInRange()

e.g. curl -X POST -H 'Content-Type: application/json' --data '{"jsonrpc":"2.0","method":"statediff_writeStateDiffsInRange","params":['"$BEGIN"', '"$END"', {"intermediateStateNodes":true,"intermediateStorageNodes":true,"includeBlock":true,"includeReceipts":true,"includeTD":true,"includeCode":true}],"id":1}' "$HOST":"$PORT"

The process can be configured locally with sets of ranges to process as a "prerun" to processing directed by the server endpoints. This is done by turning "prerun" on in the config (statediff.prerun = true) and defining ranged and params in the prerun section of the config as shown below.

Configuration

An example config file:

[leveldb]
    mode = "local"
    # path and ancient LevelDB paths required in local mode
    path = "/Users/user/Library/Ethereum/geth/chaindata"
    ancient = "/Users/user/Library/Ethereum/geth/chaindata/ancient"
    # url for leveldb-ethdb-rpc endpoint required in remote mode
    url = "http://127.0.0.1:8082/"

[server]
    ipcPath = ".ipc"
    httpPath = "127.0.0.1:8545"

[statediff]
    prerun = true
    serviceWorkers = 1
    workerQueueSize = 1024
    trieWorkers = 4

[prerun]
    only = false
    ranges = [
        [0, 1000]
    ]
    [prerun.params]
        intermediateStateNodes = true
        intermediateStorageNodes = true
        includeBlock = true
        includeReceipts = true
        includeTD = true
        includeCode = true
        watchedAddresses = []

[log]
    file = ""
    level = "info"

[eth]
    chainID = 1

[database]
    name     = "vulcanize_test"
    hostname = "localhost"
    port     = 5432
    user     = "vulcanize"
    password = "..."
    type = "postgres"
    driver = "sqlx"
    dumpDestination = ""
    filePath = ""

[cache]
    database = 1024
    trie = 1024

[prom]
    dbStats = false
    metrics = true
    http = true
    httpAddr = "localhost"
    httpPort = "8889"

[ethereum]
    nodeID = ""
    clientName = "eth-statediff-service"
    genesisBlock = "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3"
    networkID = 1
    chainID = 1