Struct OpAddOns 

pub struct OpAddOns<N, EthB, PVB, EB = OpEngineApiBuilder<PVB>, EVB = BasicEngineValidatorBuilder<PVB>, RpcMiddleware = Identity>
where
    N: FullNodeComponents,
    EthB: EthApiBuilder<N>,
{
    pub rpc_add_ons: RpcAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>,
    pub da_config: OpDAConfig,
    pub gas_limit_config: OpGasLimitConfig,
    pub sequencer_url: Option<String>,
    pub sequencer_headers: Vec<String>,
    pub historical_rpc: Option<String>,
    /* private fields */
}

Add-ons w.r.t. optimism.

This type provides optimism-specific addons to the node and exposes the RPC server and engine API.

Fields

rpc_add_ons: RpcAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

Rpc add-ons responsible for launching the RPC servers and instantiating the RPC handlers and eth-api.

da_config: OpDAConfig

Data availability configuration for the OP builder.

gas_limit_config: OpGasLimitConfig

Gas limit configuration for the OP builder.

sequencer_url: Option<String>

Sequencer client, configured to forward submitted transactions to sequencer of given OP network.

sequencer_headers: Vec<String>

Headers to use for the sequencer client requests.

historical_rpc: Option<String>

RPC endpoint for historical data.

This can be used to forward pre-bedrock rpc requests (op-mainnet).

Implementations

impl<N, EthB, PVB, EB, EVB, RpcMiddleware> OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: FullNodeComponents, EthB: EthApiBuilder<N>,

pub const fn new( rpc_add_ons: RpcAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>, da_config: OpDAConfig, gas_limit_config: OpGasLimitConfig, sequencer_url: Option<String>, sequencer_headers: Vec<String>, historical_rpc: Option<String>, enable_tx_conditional: bool, min_suggested_priority_fee: u64, ) -> OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

Creates a new instance from components.

impl<N, NetworkT, RpcMiddleware> OpAddOns<N, OpEthApiBuilder<NetworkT>, OpEngineValidatorBuilder, OpEngineApiBuilder<OpEngineValidatorBuilder>, RpcMiddleware>

where N: FullNodeComponents, <N as FullNodeTypes>::Types: OpNodeTypes, OpEthApiBuilder<NetworkT>: EthApiBuilder<N>,

pub fn builder() -> OpAddOnsBuilder<NetworkT>

Build a OpAddOns using OpAddOnsBuilder.

impl<N, EthB, PVB, EB, EVB, RpcMiddleware> OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: FullNodeComponents, EthB: EthApiBuilder<N>,

pub fn with_engine_api<T>( self, engine_api_builder: T, ) -> OpAddOns<N, EthB, PVB, T, EVB, RpcMiddleware>

Maps the reth_node_builder::rpc::EngineApiBuilder builder type.

pub fn with_payload_validator<T>( self, payload_validator_builder: T, ) -> OpAddOns<N, EthB, T, EB, EVB, RpcMiddleware>

Maps the PayloadValidatorBuilder builder type.

pub fn with_rpc_middleware<T>( self, rpc_middleware: T, ) -> OpAddOns<N, EthB, PVB, EB, EVB, T>

Sets the RPC middleware stack for processing RPC requests.

This method configures a custom middleware stack that will be applied to all RPC requests across HTTP, WebSocket, and IPC transports. The middleware is applied to the RPC service layer, allowing you to intercept, modify, or enhance RPC request processing.

See also RpcAddOns::with_rpc_middleware.

pub fn on_rpc_started<F>( self, hook: F, ) -> OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where F: FnOnce(RpcContext<'_, N, <EthB as EthApiBuilder<N>>::EthApi>, RethRpcServerHandles) -> Result<(), Report> + Send + 'static,

Sets the hook that is run once the rpc server is started.

pub fn extend_rpc_modules<F>( self, hook: F, ) -> OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where F: FnOnce(RpcContext<'_, N, <EthB as EthApiBuilder<N>>::EthApi>) -> Result<(), Report> + Send + 'static,

Sets the hook that is run to configure the rpc modules.

Trait Implementations

impl<N, EthB, PVB, EB, EVB, RpcMiddleware> Debug for OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: Debug + FullNodeComponents, EthB: Debug + EthApiBuilder<N>, PVB: Debug, EB: Debug, EVB: Debug, RpcMiddleware: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<N> Default for OpAddOns<N, OpEthApiBuilder, OpEngineValidatorBuilder>

where N: FullNodeComponents, <N as FullNodeTypes>::Types: OpNodeTypes, OpEthApiBuilder: EthApiBuilder<N>,

fn default() -> OpAddOns<N, OpEthApiBuilder, OpEngineValidatorBuilder>

Returns the “default value” for a type.

impl<N, EthB, PVB, EB, EVB, RpcMiddleware> EngineValidatorAddOn<N> for OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: FullNodeComponents, EthB: EthApiBuilder<N>, PVB: Send, EB: EngineApiBuilder<N>, EVB: EngineValidatorBuilder<N>, RpcMiddleware: Send,

type ValidatorBuilder = EVB

The validator builder type to use.

fn engine_validator_builder( &self, ) -> <OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware> as EngineValidatorAddOn<N>>::ValidatorBuilder

Returns the validator builder.

impl<N, EthB, PVB, EB, EVB, Attrs, RpcMiddleware> NodeAddOns<N> for OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: FullNodeComponents, <N as FullNodeTypes>::Types: NodeTypes, <<N as FullNodeTypes>::Types as NodeTypes>::ChainSpec: OpHardforks, <<N as FullNodeTypes>::Types as NodeTypes>::Primitives: OpPayloadPrimitives, <<N as FullNodeTypes>::Types as NodeTypes>::Payload: PayloadTypes<PayloadBuilderAttributes = Attrs>, <N as FullNodeComponents>::Evm: ConfigureEvm, <<N as FullNodeComponents>::Evm as ConfigureEvm>::NextBlockEnvCtx: BuildNextEnv<Attrs, <<<N as FullNodeTypes>::Types as NodeTypes>::Primitives as NodePrimitives>::BlockHeader, <<N as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, <N as FullNodeComponents>::Pool: TransactionPool, <<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: OpPooledTx, EthB: EthApiBuilder<N>, PVB: Send, EB: EngineApiBuilder<N>, EVB: EngineValidatorBuilder<N>, RpcMiddleware: RethRpcMiddleware, Attrs: OpAttributes<Transaction = <<<N as FullNodeTypes>::Types as NodeTypes>::Primitives as NodePrimitives>::SignedTx>, <Attrs as PayloadBuilderAttributes>::RpcPayloadAttributes: DeserializeOwned,

type Handle = RpcHandle<N, <EthB as EthApiBuilder<N>>::EthApi>

Handle to add-ons.

async fn launch_add_ons( self, ctx: AddOnsContext<'_, N>, ) -> Result<<OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware> as NodeAddOns<N>>::Handle, Report>

Configures and launches the add-ons.

impl<N, EthB, PVB, EB, EVB, Attrs, RpcMiddleware> RethRpcAddOns<N> for OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware>

where N: FullNodeComponents, <N as FullNodeTypes>::Types: NodeTypes, <<N as FullNodeTypes>::Types as NodeTypes>::ChainSpec: OpHardforks, <<N as FullNodeTypes>::Types as NodeTypes>::Primitives: OpPayloadPrimitives, <<N as FullNodeTypes>::Types as NodeTypes>::Payload: PayloadTypes<PayloadBuilderAttributes = Attrs>, <N as FullNodeComponents>::Evm: ConfigureEvm, <<N as FullNodeComponents>::Evm as ConfigureEvm>::NextBlockEnvCtx: BuildNextEnv<Attrs, <<<N as FullNodeTypes>::Types as NodeTypes>::Primitives as NodePrimitives>::BlockHeader, <<N as FullNodeTypes>::Types as NodeTypes>::ChainSpec>, <<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: OpPooledTx, EthB: EthApiBuilder<N>, PVB: PayloadValidatorBuilder<N>, EB: EngineApiBuilder<N>, EVB: EngineValidatorBuilder<N>, RpcMiddleware: RethRpcMiddleware, Attrs: OpAttributes<Transaction = <<<N as FullNodeTypes>::Types as NodeTypes>::Primitives as NodePrimitives>::SignedTx>, <Attrs as PayloadBuilderAttributes>::RpcPayloadAttributes: DeserializeOwned,

type EthApi = <EthB as EthApiBuilder<N>>::EthApi

eth API implementation.

fn hooks_mut( &mut self, ) -> &mut RpcHooks<N, <OpAddOns<N, EthB, PVB, EB, EVB, RpcMiddleware> as RethRpcAddOns<N>>::EthApi>

Returns a mutable reference to RPC hooks.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.