Trait EngineApiExtServer

pub trait EngineApiExtServer:
    Sized
    + Send
    + Sync
    + 'static {
    // Required method
    fn signal_superchain_v1<'life0, 'async_trait>(
        &'life0 self,
        signal: SuperchainSignal,
    ) -> Pin<Box<dyn Future<Output = Result<ProtocolVersion, ErrorObject<'static>>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;

    // Provided method
    fn into_rpc(self) -> RpcModule<Self> { ... }
}

Available on crate feature rpc-jsonrpsee only.

Server trait implementation for the EngineApiExt RPC API.

Required Methods

fn signal_superchain_v1<'life0, 'async_trait>( &'life0 self, signal: SuperchainSignal, ) -> Pin<Box<dyn Future<Output = Result<ProtocolVersion, ErrorObject<'static>>> + Send + 'async_trait>>

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

Signal superchain v1 message

The execution engine SHOULD warn when the recommended version is newer than the current version. The execution engine SHOULD take safety precautions if it does not meet the required version.

Returns

The latest supported OP-Stack protocol version of the execution engine.

See: https://specs.optimism.io/protocol/exec-engine.html#engine_signalsuperchainv1

Provided Methods

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors