minor updates to readme #18

Merged
telackey merged 1 commits from readme into master 2020-10-23 16:04:40 +00:00

View File

@ -14,7 +14,7 @@
## Background ## Background
NOTE: WIP NOTE: WIP
ipld-eth-server is used to service queries against the indexed Ethereum IPLD objects indexed by [ipld-eth-indexer](https://github.com/vulcanize/ipld-eth-indexer). ipld-eth-server is used to service queries against the Ethereum IPLD objects indexed by [ipld-eth-indexer](https://github.com/vulcanize/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. 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. Additional, unique endpoints are exposed which utilize the new indexes and state diff data objects.
@ -85,6 +85,7 @@ TODO: Port the IPLD RPC subscription endpoints after the decoupling
ipld-eth-server currently recapitulates portions of the Ethereum JSON-RPC api standard. ipld-eth-server currently recapitulates portions of the Ethereum JSON-RPC api standard.
The currently supported standard endpoints are: The currently supported standard endpoints are:
`eth_call`
`eth_blockNumber` `eth_blockNumber`
`eth_getLogs` `eth_getLogs`
`eth_getHeaderByNumber` `eth_getHeaderByNumber`
@ -92,7 +93,7 @@ The currently supported standard endpoints are:
`eth_getBlockByHash` `eth_getBlockByHash`
`eth_getTransactionByHash` `eth_getTransactionByHash`
TODO: Add the rest of the standard endpoints add unique endpoints (e.g. getSlice) TODO: Add the rest of the standard endpoints and unique endpoints (e.g. getSlice)
### Testing ### Testing
`make test` will run the unit tests `make test` will run the unit tests