Struct EngineClient

pub struct EngineClient { /* private fields */ }

An Engine API client that provides authenticated HTTP communication with an execution layer.

The EngineClient handles JWT authentication and manages connections to both L1 and L2 execution layers. It automatically selects the appropriate Engine API version based on the rollup configuration and block timestamps.

Examples

use alloy_rpc_types_engine::JwtSecret;
use kona_engine::EngineClient;
use kona_genesis::RollupConfig;
use std::sync::Arc;
use url::Url;

let engine_url = Url::parse("http://localhost:8551")?;
let l1_url = Url::parse("http://localhost:8545")?;
let config = Arc::new(RollupConfig::default());
let jwt = JwtSecret::from_hex("0xabcd")?;

let client = EngineClient::new_http(engine_url, l1_url, config, jwt);

Implementations

impl EngineClient

pub fn new_http( engine: Url, l1_rpc: Url, cfg: Arc<RollupConfig>, jwt: JwtSecret, ) -> Self

Creates a new EngineClient with authenticated HTTP connections.

Sets up JWT-authenticated connections to the Engine API endpoint, along with an unauthenticated connection to the L1 chain.

Arguments

• engine - L2 Engine API endpoint URL (typically port 8551)
• l1_rpc - L1 chain RPC endpoint URL
• cfg - Rollup configuration for version selection
• jwt - JWT secret for authentication

pub const fn l2_engine(&self) -> &RootProvider<Optimism>

Returns a reference to the inner L2 RootProvider.

pub const fn l1_provider(&self) -> &RootProvider

Returns a reference to the inner L1 RootProvider.

pub fn cfg(&self) -> &RollupConfig

Returns a reference to the inner RollupConfig.

pub async fn l2_block_by_label( &self, numtag: BlockNumberOrTag, ) -> Result<Option<Block<Transaction>>, EngineClientError>

Fetches the Block<T> for the given BlockNumberOrTag.

pub async fn l2_block_info_by_label( &self, numtag: BlockNumberOrTag, ) -> Result<Option<L2BlockInfo>, EngineClientError>

Fetches the L2BlockInfo by BlockNumberOrTag.

Methods from Deref<Target = RootProvider<Optimism>>

pub async fn get_subscription<R>( &self, id: FixedBytes<32>, ) -> Result<Subscription<R>, RpcError<TransportErrorKind>>

where R: RpcRecv,

Gets the subscription corresponding to the given RPC subscription ID.

pub fn unsubscribe( &self, id: FixedBytes<32>, ) -> Result<(), RpcError<TransportErrorKind>>

Unsubscribes from the subscription corresponding to the given RPC subscription ID.

Trait Implementations

impl Clone for EngineClient

fn clone(&self) -> EngineClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineClient

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

Formats the value using the given formatter.

impl Deref for EngineClient

type Target = RootProvider<Optimism>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl OpEngineApi<Optimism, Http<HyperClient<Full<Bytes>, AuthService<Client<HttpConnector, Full<Bytes>>>>>> for EngineClient

fn new_payload_v2<'life0, 'async_trait>( &'life0 self, payload: ExecutionPayloadInputV2, ) -> Pin<Box<dyn Future<Output = TransportResult<PayloadStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the given payload to the execution layer client, as specified for the Shanghai fork.

fn new_payload_v3<'life0, 'async_trait>( &'life0 self, payload: ExecutionPayloadV3, parent_beacon_block_root: B256, ) -> Pin<Box<dyn Future<Output = TransportResult<PayloadStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the given payload to the execution layer client, as specified for the Cancun fork.

fn new_payload_v4<'life0, 'async_trait>( &'life0 self, payload: OpExecutionPayloadV4, parent_beacon_block_root: B256, ) -> Pin<Box<dyn Future<Output = TransportResult<PayloadStatus>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the given payload to the execution layer client, as specified for the Prague fork.

fn fork_choice_updated_v2<'life0, 'async_trait>( &'life0 self, fork_choice_state: ForkchoiceState, payload_attributes: Option<OpPayloadAttributes>, ) -> Pin<Box<dyn Future<Output = TransportResult<ForkchoiceUpdated>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the execution layer client with the given fork choice, as specified for the Shanghai fork.

fn fork_choice_updated_v3<'life0, 'async_trait>( &'life0 self, fork_choice_state: ForkchoiceState, payload_attributes: Option<OpPayloadAttributes>, ) -> Pin<Box<dyn Future<Output = TransportResult<ForkchoiceUpdated>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the execution layer client with the given fork choice, as specified for the Cancun fork.

fn get_payload_v2<'life0, 'async_trait>( &'life0 self, payload_id: PayloadId, ) -> Pin<Box<dyn Future<Output = TransportResult<ExecutionPayloadEnvelopeV2>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves an execution payload from a previously started build process, as specified for the Shanghai fork.

fn get_payload_v3<'life0, 'async_trait>( &'life0 self, payload_id: PayloadId, ) -> Pin<Box<dyn Future<Output = TransportResult<OpExecutionPayloadEnvelopeV3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves an execution payload from a previously started build process, as specified for the Cancun fork.

fn get_payload_v4<'life0, 'async_trait>( &'life0 self, payload_id: PayloadId, ) -> Pin<Box<dyn Future<Output = TransportResult<OpExecutionPayloadEnvelopeV4>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the most recent version of the payload that is available in the corresponding payload build process at the time of receiving this call.

fn get_payload_bodies_by_hash_v1<'life0, 'async_trait>( &'life0 self, block_hashes: Vec<BlockHash>, ) -> Pin<Box<dyn Future<Output = TransportResult<ExecutionPayloadBodiesV1>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the execution payload bodies by the given hash.

fn get_payload_bodies_by_range_v1<'life0, 'async_trait>( &'life0 self, start: u64, count: u64, ) -> Pin<Box<dyn Future<Output = TransportResult<ExecutionPayloadBodiesV1>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the execution payload bodies by the range starting at start, containing count blocks.

fn get_client_version_v1<'life0, 'async_trait>( &'life0 self, client_version: ClientVersionV1, ) -> Pin<Box<dyn Future<Output = TransportResult<Vec<ClientVersionV1>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the execution client version information.

fn signal_superchain_v1<'life0, 'async_trait>( &'life0 self, recommended: ProtocolVersion, required: ProtocolVersion, ) -> Pin<Box<dyn Future<Output = TransportResult<ProtocolVersion>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Optional extension to the Engine API.

fn exchange_capabilities<'life0, 'async_trait>( &'life0 self, capabilities: Vec<String>, ) -> Pin<Box<dyn Future<Output = TransportResult<Vec<String>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the list of Engine API methods supported by the execution layer client software.