2021-05-26 10:35:39 +00:00
|
|
|
Erigon-API
|
2020-09-21 14:10:25 +00:00
|
|
|
---
|
|
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
Erigon-API is a set of tools for building applications containing Erigon node.
|
2020-09-21 14:10:25 +00:00
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
Our own binary [`erigon`](../cmd/erigon) is built using it.
|
2020-09-21 14:10:25 +00:00
|
|
|
|
|
|
|
|
## Modules
|
|
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
* [`cli`](./cli) - erigon-cli, methods & helpers to run a CLI app with Erigon node.
|
2020-09-21 14:10:25 +00:00
|
|
|
|
|
|
|
|
* [`node`](./node) - represents an Ethereum node, running devp2p and sync and writing state to the database.
|
|
|
|
|
|
|
|
|
|
* [`stagedsync`](../eth/stagedsync) - staged sync algorithm.
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
* [`erigon`](../cmd/erigon/main.go) - our binary is using erigon-api with all defaults
|
2020-09-21 14:10:25 +00:00
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
* [`erigoncustom`](../cmd/erigoncustom/main.go) - a very simple example of adding a custom stage, a custom bucket and a custom command-line parameter
|
2020-09-21 14:10:25 +00:00
|
|
|
|
2021-05-26 10:35:39 +00:00
|
|
|
* [erigon-examples](https://github.com/mandrigin/turbo-api-examples) - a series of examples for Erigon api
|
