Struct OpPayloadBuilder

pub struct OpPayloadBuilder<EvmConfig, Txs = ()> {
    pub compute_pending_block: bool,
    pub evm_config: EvmConfig,
    pub best_transactions: Txs,
}

Available on crate feature optimism only.

Optimism’s payload builder

Fields

compute_pending_block: bool

The rollup’s compute pending block configuration option.

evm_config: EvmConfig

The type responsible for creating the evm.

best_transactions: Txs

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

Implementations

impl<EvmConfig> OpPayloadBuilder<EvmConfig>

pub const fn new(evm_config: EvmConfig) -> OpPayloadBuilder<EvmConfig>

OpPayloadBuilder constructor.

impl<EvmConfig, Txs> OpPayloadBuilder<EvmConfig, Txs>

pub const fn set_compute_pending_block( self, compute_pending_block: bool, ) -> OpPayloadBuilder<EvmConfig, Txs>

Sets the rollup’s compute pending block configuration option.

pub fn with_transactions<T>( self, best_transactions: T, ) -> OpPayloadBuilder<EvmConfig, T>

where T: OpPayloadTransactions,

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

pub const fn compute_pending_block(self) -> OpPayloadBuilder<EvmConfig, Txs>

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<EvmConfig, Txs> OpPayloadBuilder<EvmConfig, Txs>

where EvmConfig: ConfigureEvm<Header = Header>, Txs: OpPayloadTransactions,

pub fn cfg_and_block_env( &self, config: &PayloadConfig<OpPayloadBuilderAttributes>, parent: &Header, ) -> Result<(CfgEnvWithHandlerCfg, BlockEnv), <EvmConfig as ConfigureEvmEnv>::Error>

Returns the configured [CfgEnvWithHandlerCfg] and [BlockEnv] for the targeted payload (that has the parent as its parent).

Trait Implementations

impl<EvmConfig, Txs> Clone for OpPayloadBuilder<EvmConfig, Txs>

where EvmConfig: Clone, Txs: Clone,

fn clone(&self) -> OpPayloadBuilder<EvmConfig, Txs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<EvmConfig, Txs> Debug for OpPayloadBuilder<EvmConfig, Txs>

where EvmConfig: Debug, Txs: Debug,

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

Formats the value using the given formatter.

impl<EvmConfig, Txs> PartialEq for OpPayloadBuilder<EvmConfig, Txs>

where EvmConfig: PartialEq, Txs: PartialEq,

fn eq(&self, other: &OpPayloadBuilder<EvmConfig, Txs>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Pool, Client, EvmConfig, Txs> PayloadBuilder<Pool, Client> for OpPayloadBuilder<EvmConfig, Txs>

where Client: StateProviderFactory + ChainSpecProvider<ChainSpec = OpChainSpec>, Pool: TransactionPool, EvmConfig: ConfigureEvm<Header = Header>, Txs: OpPayloadTransactions,

Implementation of the [PayloadBuilder] trait for OpPayloadBuilder.

type Attributes = OpPayloadBuilderAttributes

The payload attributes type to accept for building.

type BuiltPayload = OpBuiltPayload

The type of the built payload.

fn try_build( &self, args: BuildArguments<Pool, Client, OpPayloadBuilderAttributes, OpBuiltPayload>, ) -> Result<BuildOutcome<OpBuiltPayload>, PayloadBuilderError>

Tries to build a transaction payload using provided arguments.

fn on_missing_payload( &self, _args: BuildArguments<Pool, Client, OpPayloadBuilderAttributes, OpBuiltPayload>, ) -> MissingPayloadBehaviour<<OpPayloadBuilder<EvmConfig, Txs> as PayloadBuilder<Pool, Client>>::BuiltPayload>

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

fn build_empty_payload( &self, client: &Client, config: PayloadConfig<<OpPayloadBuilder<EvmConfig, Txs> as PayloadBuilder<Pool, Client>>::Attributes>, ) -> Result<OpBuiltPayload, PayloadBuilderError>

Builds an empty payload without any transaction.

impl<EvmConfig, Txs> Eq for OpPayloadBuilder<EvmConfig, Txs>

where EvmConfig: Eq, Txs: Eq,

impl<EvmConfig, Txs> StructuralPartialEq for OpPayloadBuilder<EvmConfig, Txs>

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.