Struct OpPayloadBuilderCtx

pub struct OpPayloadBuilderCtx<EvmConfig> {
    pub evm_config: EvmConfig,
    pub chain_spec: Arc<OpChainSpec>,
    pub config: PayloadConfig<OpPayloadBuilderAttributes>,
    pub initialized_cfg: CfgEnvWithHandlerCfg,
    pub initialized_block_env: BlockEnv,
    pub cancel: Cancelled,
    pub best_payload: Option<OpBuiltPayload>,
}

Available on crate feature optimism only.

Container type that holds all necessities to build a new payload.

Fields

evm_config: EvmConfig

The type that knows how to perform system calls and configure the evm.

chain_spec: Arc<OpChainSpec>

The chainspec

config: PayloadConfig<OpPayloadBuilderAttributes>

How to build the payload.

initialized_cfg: CfgEnvWithHandlerCfg

Evm Settings

initialized_block_env: BlockEnv

Block config

cancel: Cancelled

Marker to check whether the job has been cancelled.

best_payload: Option<OpBuiltPayload>

The currently best payload.

Implementations

impl<EvmConfig> OpPayloadBuilderCtx<EvmConfig>

pub fn parent(&self) -> &SealedHeader

Returns the parent block the payload will be build on.

pub const fn attributes(&self) -> &OpPayloadBuilderAttributes

Returns the builder attributes.

pub fn withdrawals(&self) -> Option<&Withdrawals>

Returns the withdrawals if shanghai is active.

pub fn block_gas_limit(&self) -> u64

Returns the block gas limit to target.

pub fn block_number(&self) -> u64

Returns the block number for the block.

pub fn base_fee(&self) -> u64

Returns the current base fee

pub fn get_blob_gasprice(&self) -> Option<u64>

Returns the current blob gas price.

pub fn blob_fields(&self) -> (Option<u64>, Option<u64>)

Returns the blob fields for the header.

This will always return Some(0) after ecotone.

pub fn extra_data(&self) -> Result<Bytes, PayloadBuilderError>

Returns the extra data for the block.

After holocene this extracts the extra data from the payload

pub fn best_transaction_attributes(&self) -> BestTransactionsAttributes

Returns the current fee settings for transactions from the mempool

pub fn payload_id(&self) -> PayloadId

Returns the unique id for this payload job.

pub fn is_regolith_active(&self) -> bool

Returns true if regolith is active for the payload.

pub fn is_ecotone_active(&self) -> bool

Returns true if ecotone is active for the payload.

pub fn is_canyon_active(&self) -> bool

Returns true if canyon is active for the payload.

pub fn is_holocene_active(&self) -> bool

Returns true if holocene is active for the payload.

pub fn is_better_payload(&self, total_fees: Uint<256, 4>) -> bool

Returns true if the fees are higher than the previous payload.

pub fn commit_withdrawals<DB>( &self, db: &mut State<DB>, ) -> Result<Option<FixedBytes<32>>, ProviderError>

where DB: Database<Error = ProviderError>,

Commits the withdrawals from the payload attributes to the state.

pub fn ensure_create2_deployer<DB>( &self, db: &mut State<DB>, ) -> Result<(), PayloadBuilderError>

where DB: Database, <DB as Database>::Error: Display,

Ensure that the create2deployer is force-deployed at the canyon transition. Optimism blocks will always have at least a single transaction in them (the L1 info transaction), so we can safely assume that this will always be triggered upon the transition and that the above check for empty blocks will never be hit on OP chains.

impl<EvmConfig> OpPayloadBuilderCtx<EvmConfig>

where EvmConfig: ConfigureEvm<Header = Header, Transaction = TransactionSigned>,

pub fn apply_pre_beacon_root_contract_call<DB>( &self, db: &mut DB, ) -> Result<(), PayloadBuilderError>

where DB: Database + DatabaseCommit, <DB as Database>::Error: Display,

apply eip-4788 pre block contract call

pub fn execute_sequencer_transactions<DB>( &self, db: &mut State<DB>, ) -> Result<ExecutionInfo, PayloadBuilderError>

where DB: Database<Error = ProviderError>,

Executes all sequencer transactions that are included in the payload attributes.

pub fn execute_best_transactions<DB, Pool>( &self, info: &mut ExecutionInfo, db: &mut State<DB>, best_txs: impl PayloadTransactions<Transaction = TransactionSigned>, ) -> Result<Option<()>, PayloadBuilderError>

where DB: Database<Error = ProviderError>,

Executes the given best transactions and updates the execution info.

Returns Ok(Some(()) if the job was cancelled.

Trait Implementations

impl<EvmConfig> Debug for OpPayloadBuilderCtx<EvmConfig>

where EvmConfig: Debug,

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

Formats the value using the given formatter.

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.