Server backend for indexed ETH IPLD objects

Go to file

Ian Norden 1dee766014 update readme		2020-09-02 09:18:31 -05:00
cmd	continue refactor/purge	2020-09-01 16:15:31 -05:00
db	remove btc stuff	2020-08-31 10:42:01 -05:00
dockerfiles	update deps/paths/names	2020-08-31 10:52:47 -05:00
documentation	continue refactor/purge	2020-09-01 16:15:31 -05:00
environments	update readme	2020-09-02 09:18:31 -05:00
pkg	continue refactor/purge	2020-09-01 16:15:31 -05:00
scripts	update deps/paths/names	2020-08-31 10:52:47 -05:00
test_config	continue refactor/purge	2020-09-01 16:15:31 -05:00
version	bump minor version	2020-08-31 10:59:44 -05:00
.dockerignore	Add container service files and docker README	2019-02-11 11:26:12 +01:00
.gitignore	update deps/paths/names	2020-08-31 10:52:47 -05:00
go.mod	continue refactor/purge	2020-09-01 16:15:31 -05:00
go.sum	continue refactor/purge	2020-09-01 16:15:31 -05: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	watch => serve	2020-08-31 10:59:41 -05:00
Makefile	specify GO111MODLE state in readme, explicitly use GO111MODULE=on in make build	2020-08-07 23:17:16 -05:00
README.md	update readme	2020-09-02 09:18:31 -05: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 indexed 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.13)
Git
GCC compiler
This repository

External dependency

Postgres database populated by ipld-eth-indexer

Install

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

GO111MODULE=off go get -d github.com/vulcanize/ipld-eth-server

cd $GOPATH/src/github.com/vulcanize/ipld-eth-server

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" # $LOGRUS_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

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

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_blockNumber eth_getLogs eth_getHeaderByNumber eth_getBlockByNumber eth_getBlockByHash eth_getTransactionByHash

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

Testing

make test will run the unit tests
make test setups a clean vulcanize_testing db

Contributing

Contributions are welcome!

VulcanizeDB follows the Contributor Covenant Code of Conduct.