README.md

Examples

These examples demonstrate the main features of some of Reth's crates and how to use them.

To run an example, use the command cargo run -p <example>.

If you've got an example you'd like to see here, please feel free to open an issue. Otherwise if you've got an example you'd like to add, please feel free to make a PR!

Node Builder

Example	Description
Additional RPC namespace	Illustrates how to add custom CLI parameters and set up a custom RPC namespace
Custom event hooks	Illustrates how to hook to various node lifecycle events
Custom dev node	Illustrates how to run a custom dev node programmatically and submit a transaction to it via RPC
Custom EVM	Illustrates how to implement a node with a custom EVM
Custom Stateful Precompile	Illustrates how to implement a node with a stateful precompile
Custom inspector	Illustrates how to use a custom EVM inspector to trace new transactions
Custom engine types	Illustrates how to create a node with custom engine types
Custom node components	Illustrates how to configure custom node components
Custom payload builder	Illustrates how to use a custom payload builder

ExEx

See examples in a dedicated repository.

RPC

Example	Description
DB over RPC	Illustrates how to run a standalone RPC server over a Rethdatabase instance

Database

Example	Description
DB access	Illustrates how to access Reth's database in a separate process

Network

Example	Description
Standalone network	Illustrates how to use the network as a standalone component

Mempool

Example	Description
Trace pending transactions	Illustrates how to trace pending transactions as they arrive in the mempool
Standalone txpool	Illustrates how to use the network as a standalone component together with a transaction pool with a custom pool validator

P2P

Example	Description
Manual P2P	Illustrates how to connect and communicate with a peer
Polygon P2P	Illustrates how to connect and communicate with a peer on Polygon
BSC P2P	Illustrates how to connect and communicate with a peer on Binance Smart Chain

Misc

Example	Description
Beacon API SSE	Illustrates how to subscribe to beacon chain events via SSE