jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
062b3d76b94ce54ef56c2c421a3e11340365e20f
nanoreth/examples/README.md
Andrzej Sulkowski 062b3d76b9 refactor: move network-txpool.rs example to its own folder (#7892) 
Co-authored-by: Oliver Nordbjerg <hi@notbjerg.me>
2024-04-25 18:36:09 +00:00

4.8 KiB
Raw Blame History

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 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

Example Description
Minimal ExEx Illustrates how to build a simple ExEx
OP Bridge ExEx Illustrates an ExEx that decodes Optimism deposit and withdrawal receipts from L1

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

Misc

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