reth/examples/custom-node/src/lib.rs

//! This example shows how implement a custom node.
//!
//! A node consists of:
//! - primitives: block,header,transactions
//! - components: network,pool,evm
//! - engine: advances the node

#![cfg_attr(not(test), warn(unused_crate_dependencies))]

use crate::{
    evm::CustomExecutorBuilder,
    network::CustomNetworkPrimitives,
    primitives::{CustomTransaction, CustomTransactionEnvelope},
};
use chainspec::CustomChainSpec;
use consensus::CustomConsensusBuilder;
use op_alloy_consensus::OpPooledTransaction;
use primitives::CustomNodePrimitives;
use reth_ethereum::{
    node::api::{FullNodeTypes, NodeTypes},
    primitives::Extended,
};
use reth_node_builder::{
    components::{BasicPayloadServiceBuilder, ComponentsBuilder},
    Node,
};
use reth_op::node::{
    node::{OpNetworkBuilder, OpPayloadBuilder, OpPoolBuilder},
    txpool, OpNode, OpPayloadTypes,
};

pub mod chainspec;
pub mod consensus;
pub mod engine;
pub mod engine_api;
pub mod evm;
pub mod network;
pub mod primitives;

#[derive(Debug, Clone)]
pub struct CustomNode {}

impl NodeTypes for CustomNode {
    type Primitives = CustomNodePrimitives;
    type ChainSpec = CustomChainSpec;
    type StateCommitment = <OpNode as NodeTypes>::StateCommitment;
    type Storage = <OpNode as NodeTypes>::Storage;
    type Payload = OpPayloadTypes<CustomNodePrimitives>;
}

impl<N> Node<N> for CustomNode
where
    N: FullNodeTypes<Types = Self>,
{
    type ComponentsBuilder = ComponentsBuilder<
        N,
        OpPoolBuilder<
            txpool::OpPooledTransaction<
                CustomTransaction,
                Extended<OpPooledTransaction, CustomTransactionEnvelope>,
            >,
        >,
        BasicPayloadServiceBuilder<OpPayloadBuilder>,
        OpNetworkBuilder<
            CustomNetworkPrimitives,
            Extended<OpPooledTransaction, CustomTransactionEnvelope>,
        >,
        CustomExecutorBuilder,
        CustomConsensusBuilder,
    >;

    type AddOns = ();

    fn components_builder(&self) -> Self::ComponentsBuilder {
        ComponentsBuilder::default()
            .node_types::<N>()
            .pool(OpPoolBuilder::default())
            .executor(CustomExecutorBuilder::default())
            .payload(BasicPayloadServiceBuilder::new(OpPayloadBuilder::new(false)))
            .network(OpNetworkBuilder::new(false, false))
            .consensus(CustomConsensusBuilder)
    }

    fn add_ons(&self) -> Self::AddOns {}
}