github/reth
1
1
Fork 0
mirror of https://github.com/paradigmxyz/reth.git synced 2026-01-09 23:38:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs/sdk): heading hierarchy (#17079)

Browse Source
This commit is contained in:
Yash Atreya
2025-06-26 16:45:59 +05:30
committed by GitHub
parent 2e799062f1
commit 777ee2de29
1 changed files with 39 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
book/vocs/docs/pages/sdk/overview.mdx
View File

@@ -5,19 +5,20 @@ Reth can be used as a library to build custom Ethereum nodes, interact with bloc
## What is the Reth SDK?
The Reth SDK allows developers to:
- Use components of the Reth node as libraries
- Build custom Ethereum execution nodes with modified behavior (e.g. payload building)
- Access blockchain data directly from the database
- Create high-performance indexing solutions
- Extend a new with new RPC endpoints and functionality
- Implement custom consensus mechanisms
- Build specialized tools for blockchain analysis
- Use components of the Reth node as libraries
- Build custom Ethereum execution nodes with modified behavior (e.g. payload building)
- Access blockchain data directly from the database
- Create high-performance indexing solutions
- Extend a new with new RPC endpoints and functionality
- Implement custom consensus mechanisms
- Build specialized tools for blockchain analysis
## Quick Start
Add Reth to your project:
Add Reth to your project
## Ethereum
### Ethereum
```toml
[dependencies]
@@ -25,7 +26,7 @@ Add Reth to your project:
reth-ethereum = { git = "https://github.com/paradigmxyz/reth" }
```
## Opstack
### Opstack
```toml
[dependencies]
@@ -38,27 +39,27 @@ reth-op = { git = "https://github.com/paradigmxyz/reth" }
Reth is built with modularity in mind. The main components include:
- **Primitives**: Core data type abstractions like `Block`
- **Node Builder**: Constructs and configures node instances
- **Database**: Efficient storage using MDBX and static files
- **Network**: P2P communication and block synchronization
- **Consensus**: Block validation and chain management
- **EVM**: Transaction execution and state transitions
- **RPC**: JSON-RPC server for external communication
- **Transaction Pool**: Pending transaction management
- **Primitives**: Core data type abstractions like `Block`
- **Node Builder**: Constructs and configures node instances
- **Database**: Efficient storage using MDBX and static files
- **Network**: P2P communication and block synchronization
- **Consensus**: Block validation and chain management
- **EVM**: Transaction execution and state transitions
- **RPC**: JSON-RPC server for external communication
- **Transaction Pool**: Pending transaction management
### Dependency Management
Reth is primarily built on top of the [alloy](https://github.com/alloy-rs/alloy) ecosystem, which provides the necessary abstractions and implementations for core ethereum blockchain data types, transaction handling, and EVM execution.
Reth is primarily built on top of the [alloy](https://github.com/alloy-rs/alloy) ecosystem, which provides the necessary abstractions and implementations for core ethereum blockchain data types, transaction handling, and EVM execution.
### Type System
Reth uses its own type system to handle different representations of blockchain data:
- **Primitives**: Core types like `B256`, `Address`, `U256`
- **Transactions**: Multiple representations for different contexts (pooled, consensus, RPC)
- **Blocks**: Headers, bodies, and sealed blocks with proven properties
- **State**: Accounts, storage, and state transitions
- **Primitives**: Core types like `B256`, `Address`, `U256`
- **Transactions**: Multiple representations for different contexts (pooled, consensus, RPC)
- **Blocks**: Headers, bodies, and sealed blocks with proven properties
- **State**: Accounts, storage, and state transitions
### Building Custom Nodes
@@ -89,13 +90,13 @@ graph TD
A --> E[EVM]
A --> F[RPC Server]
A --> G[Transaction Pool]
B --> H[DB Storage]
B --> I[Static Files]
C --> J[Discovery]
C --> K[ETH Protocol]
E --> L[State Provider]
E --> M[Block Executor]
```
@@ -104,24 +105,21 @@ graph TD
Several production networks have been built using Reth's node builder pattern:
### [BSC Reth](https://github.com/loocapro/reth-bsc)
A Binance Smart Chain execution client, implementing BSC-specific consensus rules and features.
### [Bera Reth](https://github.com/berachain/bera-reth)
Berachain's execution client.
### [Gnosis Reth](https://github.com/gnosischain/reth_gnosis)
Gnosis Chain's implementation using Reth.
| Node | Company | Description | Lines of Code |
|------|---------|-------------|---------------|
| [Base Node](https://github.com/base/node-reth) | Coinbase | Coinbase's L2 scaling solution node implementation | ~3K |
| [Bera Reth](https://github.com/berachain/bera-reth) | Berachain | Berachain's high-performance EVM node with custom features | ~1K |
| [Reth Gnosis](https://github.com/gnosischain/reth_gnosis) | Gnosis | Gnosis Chain's xDai-compatible execution client | ~5K |
| [Reth BSC](https://github.com/loocapro/reth-bsc) | Binance Smart Chain | BNB Smart Chain execution client implementation | ~6K |
## Next Steps
- **[Node Components](/sdk/node-components)**: Deep dive into each component
- **[Type System](/sdk/typesystem/block)**: Understanding Reth's type system
- **[Custom Nodes](/sdk/custom-node/prerequisites)**: Building production nodes
- **[Examples](/sdk/examples/modify-node)**: Real-world implementations
- **[Node Components](/sdk/node-components)**: Deep dive into each component
- **[Type System](/sdk/typesystem/block)**: Understanding Reth's type system
- **[Custom Nodes](/sdk/custom-node/prerequisites)**: Building production nodes
- **[Examples](/sdk/examples/modify-node)**: Real-world implementations
## Resources
- [API Documentation](https://docs.rs/reth/latest/reth/)
- [GitHub Repository](https://github.com/paradigmxyz/reth)
- [API Documentation](https://docs.rs/reth/latest/reth/)
- [GitHub Repository](https://github.com/paradigmxyz/reth)