Struct OpPayloadBuilder

pub struct OpPayloadBuilder<EvmConfig, Txs = ()> {
    pub compute_pending_block: bool,
    pub evm_config: EvmConfig,
    pub config: OpBuilderConfig,
    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.

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

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

OpPayloadBuilder constructor.

Configures the builder with the default settings.

pub const fn with_builder_config( evm_config: EvmConfig, config: OpBuilderConfig, ) -> OpPayloadBuilder<EvmConfig>

Configures the builder with the given OpBuilderConfig.

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, Transaction = TransactionSigned>,

pub fn cfg_and_block_env( &self, attributes: &OpPayloadBuilderAttributes, parent: &Header, ) -> Result<EvmEnv, <EvmConfig as ConfigureEvmEnv>::Error>

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

pub fn payload_witness<Client>( &self, client: &Client, parent: SealedHeader, attributes: OpPayloadAttributes, ) -> Result<ExecutionWitness, PayloadBuilderError>

where Client: StateProviderFactory + ChainSpecProvider<ChainSpec = OpChainSpec>,

Computes the witness for the payload.

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<Pool, Client, EvmConfig, Txs> PayloadBuilder<Pool, Client> for OpPayloadBuilder<EvmConfig, Txs>

where Client: StateProviderFactory + ChainSpecProvider<ChainSpec = OpChainSpec>, Pool: TransactionPool, <Pool as TransactionPool>::Transaction: PoolTransaction<Consensus = TransactionSigned>, EvmConfig: ConfigureEvm<Header = Header, Transaction = TransactionSigned>, 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.

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.