erigon-pulse/turbo/README.md
Evgeny Danilenko 74847d77e6
Rename to Erigon (#2018)
* turbo-geth to erigon

* tg, turbo to erigon
2021-05-26 11:35:39 +01:00

23 lines
785 B
Markdown

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