Struct OpPayloadBuilder 

pub struct OpPayloadBuilder<Pool, Client, Evm, Txs = (), Attrs = OpPayloadBuilderAttributes<<<Evm as ConfigureEvm>::Primitives as NodePrimitives>::SignedTx>> {
    pub compute_pending_block: bool,
    pub evm_config: Evm,
    pub pool: Pool,
    pub client: Client,
    pub config: OpBuilderConfig,
    pub best_transactions: Txs,
    /* private fields */
}

Optimism’s payload builder

Fields

compute_pending_block: bool

The rollup’s compute pending block configuration option.

evm_config: Evm

The type responsible for creating the evm.

pool: Pool

Transaction pool.

client: Client

Node client.

config: OpBuilderConfig

Settings for the builder, e.g. DA settings.

best_transactions: Txs

The type responsible for yielding the best transactions for the payload if mempool transactions are allowed.

Implementations

impl<Pool, Client, Evm, Attrs> OpPayloadBuilder<Pool, Client, Evm, (), Attrs>

pub fn new( pool: Pool, client: Client, evm_config: Evm, ) -> OpPayloadBuilder<Pool, Client, Evm, (), Attrs>

OpPayloadBuilder constructor.

Configures the builder with the default settings.

pub const fn with_builder_config( pool: Pool, client: Client, evm_config: Evm, config: OpBuilderConfig, ) -> OpPayloadBuilder<Pool, Client, Evm, (), Attrs>

Configures the builder with the given [OpBuilderConfig].

impl<Pool, Client, Evm, Txs, Attrs> OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

pub const fn set_compute_pending_block( self, compute_pending_block: bool, ) -> OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

Sets the rollup’s compute pending block configuration option.

pub fn with_transactions<T>( self, best_transactions: T, ) -> OpPayloadBuilder<Pool, Client, Evm, T, Attrs>

Configures the type responsible for yielding the transactions that should be included in the payload.

pub const fn compute_pending_block( self, ) -> OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

Enables the rollup’s compute pending block configuration option.

pub const fn is_compute_pending_block(&self) -> bool

Returns the rollup’s compute pending block configuration option.

impl<Pool, Client, Evm, N, T, Attrs> OpPayloadBuilder<Pool, Client, Evm, T, Attrs>

where Pool: TransactionPool, <Pool as TransactionPool>::Transaction: OpPooledTx<Consensus = <N as NodePrimitives>::SignedTx>, Client: StateProviderFactory + ChainSpecProvider, <Client as ChainSpecProvider>::ChainSpec: OpHardforks, N: OpPayloadPrimitives, Evm: ConfigureEvm<Primitives = N>, <Evm as ConfigureEvm>::NextBlockEnvCtx: BuildNextEnv<Attrs, <N as NodePrimitives>::BlockHeader, <Client as ChainSpecProvider>::ChainSpec>, Attrs: OpAttributes<Transaction = <<Evm as ConfigureEvm>::Primitives as NodePrimitives>::SignedTx>,

pub fn payload_witness( &self, parent: SealedHeader<<N as NodePrimitives>::BlockHeader>, attributes: <Attrs as PayloadBuilderAttributes>::RpcPayloadAttributes, ) -> Result<ExecutionWitness, PayloadBuilderError>

where Attrs: PayloadBuilderAttributes,

Computes the witness for the payload.

Trait Implementations

impl<Pool, Client, Evm, Txs, Attrs> Clone for OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

where Pool: Clone, Client: Clone, Evm: ConfigureEvm, Txs: Clone,

fn clone(&self) -> OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Pool, Client, Evm, Txs, Attrs> Debug for OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

where Pool: Debug, Client: Debug, Evm: Debug, Txs: Debug, Attrs: Debug,

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

Formats the value using the given formatter.

impl<Pool, Client, Evm, N, Txs, Attrs> PayloadBuilder for OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs>

where N: OpPayloadPrimitives, Client: StateProviderFactory + ChainSpecProvider + Clone, <Client as ChainSpecProvider>::ChainSpec: OpHardforks, Pool: TransactionPool, <Pool as TransactionPool>::Transaction: OpPooledTx<Consensus = <N as NodePrimitives>::SignedTx>, Evm: ConfigureEvm<Primitives = N>, <Evm as ConfigureEvm>::NextBlockEnvCtx: BuildNextEnv<Attrs, <N as NodePrimitives>::BlockHeader, <Client as ChainSpecProvider>::ChainSpec>, Txs: OpPayloadTransactions<<Pool as TransactionPool>::Transaction>, Attrs: OpAttributes<Transaction = <N as NodePrimitives>::SignedTx>,

Implementation of the PayloadBuilder trait for OpPayloadBuilder.

type Attributes = Attrs

The payload attributes type to accept for building.

type BuiltPayload = OpBuiltPayload<N>

The type of the built payload.

fn try_build( &self, args: BuildArguments<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::Attributes, <OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::BuiltPayload>, ) -> Result<BuildOutcome<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::BuiltPayload>, PayloadBuilderError>

Tries to build a transaction payload using provided arguments.

fn on_missing_payload( &self, _args: BuildArguments<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::Attributes, <OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::BuiltPayload>, ) -> MissingPayloadBehaviour<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::BuiltPayload>

Invoked when the payload job is being resolved and there is no payload yet.

fn build_empty_payload( &self, config: PayloadConfig<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::Attributes, <N as NodePrimitives>::BlockHeader>, ) -> Result<<OpPayloadBuilder<Pool, Client, Evm, Txs, Attrs> as PayloadBuilder>::BuiltPayload, PayloadBuilderError>

Builds an empty payload without any transaction.

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.