Server backend for indexed ETH IPLD objects

Go to file

Roy Crihfield bee4391f24 All checks were successful Test the stack. / Run unit tests (pull_request) Successful in 6m6s Details Test the stack. / Run integration tests (pull_request) Successful in 55m17s Details update system-tests ref		2024-08-06 22:40:05 -05:00
.github/workflows	update system-tests ref	2024-08-06 22:40:05 -05:00
cmd	validate chain ID against config, or defer to config	2024-08-05 11:47:01 -05:00
documentation	Upgrade to v5 schema	2023-05-25 21:39:48 +08:00
environments	rm config files from image, entrypoint noise	2024-08-05 11:47:01 -05:00
integration	Geth 1.13 (Deneb/Cancun) update (#264 )	2024-05-29 12:29:55 +00:00
monitoring	monitoring documentation, prometheus config, grafana dashboard	2020-10-21 15:38:48 +03:00
pkg	validate chain ID against config, or defer to config	2024-08-05 11:47:01 -05:00
scripts	don't run server as part of stack	2024-08-06 19:03:20 -05:00
test	update ipld-eth-db for blob hashes	2024-08-05 11:47:01 -05:00
version	Geth 1.13 (Deneb/Cancun) update (#264 )	2024-05-29 12:29:55 +00:00
.dockerignore	rm config files from image, entrypoint noise	2024-08-05 11:47:01 -05:00
.gitignore	Refactor to use plugeth-statediff (#1 )	2023-09-21 06:55:26 +00:00
Dockerfile	rm config files from image, entrypoint noise	2024-08-05 11:47:01 -05:00
entrypoint.sh	rm config files from image, entrypoint noise	2024-08-05 11:47:01 -05:00
go.mod	Support validator withdrawals (#265 )	2024-08-05 15:50:53 +00:00
go.sum	Support validator withdrawals (#265 )	2024-08-05 15:50:53 +00:00
LICENSE	Edits to address PR issues; change license from apache to AGPL; and work	2018-11-15 12:32:52 -06:00
main.go	Upgrade to v5 schema	2023-05-25 21:39:48 +08:00
README.md	Refactor to use plugeth-statediff (#1 )	2023-09-21 06:55:26 +00:00

README.md

ipld-eth-server

ipld-eth-server is the server backend for indexed ETH IPLD objects

Background
Install
Usage
Contributing
License

Background

NOTE: WIP

ipld-eth-server is used to service queries against the Ethereum IPLD objects indexed by ipld-eth-indexer.

It exposes standard Ethereum JSON RPC endpoints on top of the database, in some cases these endpoints can leverage the unique indexes to improve query performance. Additional, unique endpoints are exposed which utilize the new indexes and state diff data objects.

Dependencies

Minimal build dependencies

Go (1.19)
Git
GCC compiler
This repository

External dependency

Postgres database populated by ipld-eth-db

Install

Start by downloading ipld-eth-server and moving into the repo:

GO111MODULE=off go get -d github.com/cerc-io/ipld-eth-server/v5

cd $GOPATH/src/github.com/cerc-io/ipld-eth-server/v5@v5.x.x

Then, build the binary:

make build

Usage

After building the binary, run as

./ipld-eth-server serve --config=<the name of your config file.toml>

Configuration

Below is the set of parameters for the ipld-eth-server command, in .toml form, with the respective environmental variables commented to the side. The corresponding CLI flags can be found with the ./ipld-eth-server serve --help command.

[database]
    name     = "vulcanize_public" # $DATABASE_NAME
    hostname = "localhost" # $DATABASE_HOSTNAME
    port     = 5432 # $DATABASE_PORT
    user     = "postgres" # $DATABASE_USER
    password = "" # $DATABASE_PASSWORD

[log]
    level = "info" # $LOG_LEVEL

[server]
    ipcPath = "~/.vulcanize/vulcanize.ipc" # $SERVER_IPC_PATH
    wsPath = "127.0.0.1:8081" # $SERVER_WS_PATH
    httpPath = "127.0.0.1:8082" # $SERVER_HTTP_PATH
    graphql = true # $SERVER_GRAPHQL
    graphqlPath = "" # $SERVER_GRAPHQL_PATH

[ethereum]
    chainID = "1" # $ETH_CHAIN_ID
    rpcGasCap = "1000000000000" # $ETH_RPC_GAS_CAP
    httpPath = "127.0.0.1:8545" # $ETH_HTTP_PATH
    nodeID = "arch1" # $ETH_NODE_ID
    clientName = "Geth" # $ETH_CLIENT_NAME
    genesisBlock = "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3" # $ETH_GENESIS_BLOCK
    networkID = "1" # $ETH_NETWORK_ID

The database fields are for connecting to a Postgres database that has been/is being populated by ipld-eth-indexer The server fields set the paths for exposing the ipld-eth-server endpoints The ethereum fields set the chainID and default sender address to use for EVM simulation, and can optionally be used to configure a remote eth node to forward cache misses to

Endpoints

IPLD subscription

TODO: Port the IPLD RPC subscription endpoints after the decoupling

Ethereum JSON-RPC

ipld-eth-server currently recapitulates portions of the Ethereum JSON-RPC api standard.

The currently supported standard endpoints are:

eth_call
eth_getBalance
eth_getStorageAt
eth_getCode
eth_getProof
eth_blockNumber
eth_getHeaderByNumber
eth_getHeaderByHash
eth_getBlockByNumber
eth_getBlockByHash
eth_getTransactionCount
eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber
eth_getTransactionByHash
eth_getRawTransactionByHash
eth_getTransactionByBlockHashAndIndex
eth_getTransactionByBlockNumberAndIndex
eth_getRawTransactionByBlockHashAndIndex
eth_getRawTransactionByBlockNumberAndIndex
eth_getTransactionReceipt
eth_getLogs
eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber
eth_getUncleByBlockHashAndIndex
eth_getUncleByBlockNumberAndIndex

TODO: Add the rest of the standard endpoints and unique endpoints (e.g. getSlice)

Testing

Follow steps in test/README.md

Monitoring

Enable http server and metrics using parameters --http --metrics
ipld-eth-server exposes prometheus metrics at /metric endpoint
start prometheus using monitoring/prometheus.yml config (prometheus --config.file=monitoring/prometheus.yml)
start grafana, connect to prometheus datasource and import dashboard from monitoring/grafana/dashboard_main.json

Contributing

Contributions are welcome!

VulcanizeDB follows the Contributor Covenant Code of Conduct.