Skip to content

feat: add jsonrpsee trait for SuperchainSignal #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattsse merged 6 commits into from
Nov 3, 2024
Merged

feat: add jsonrpsee trait for SuperchainSignal #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
73c887b
feat: add jsonrpsee trait for SuperchainSignal
hoank101 Nov 2, 2024
d646616
bet
hoank101 Nov 2, 2024
1831260
bet
hoank101 Nov 2, 2024
c078275
bet
hoank101 Nov 2, 2024
cd24350
bet
hoank101 Nov 2, 2024
af3af3e
move
mattsse Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/rpc-jsonrpsee/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ workspace = true
[dependencies]
# Alloy
op-alloy-rpc-types.workspace = true
op-alloy-rpc-types-engine = { workspace = true, features = ["serde"] }
alloy-eips.workspace = true
alloy-primitives.workspace = true

Expand Down
19 changes: 19 additions & 0 deletions crates/rpc-jsonrpsee/src/traits.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use op_alloy_rpc_types::{
safe_head::SafeHeadResponse,
sync::SyncStatus,
};
use op_alloy_rpc_types_engine::{ProtocolVersion, SuperchainSignal};
use std::net::IpAddr;

/// Optimism specified rpc interface.
Expand Down Expand Up @@ -120,3 +121,21 @@ pub trait OpAdminApi {
#[method(name = "sequencerActive")]
async fn admin_sequencer_active(&self) -> RpcResult<bool>;
}

/// Engine API extension for Optimism superchain signaling
#[cfg_attr(not(feature = "client"), rpc(server, namespace = "engine"))]
#[cfg_attr(feature = "client", rpc(server, client, namespace = "engine"))]
pub trait EngineApiExt {
/// 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>
#[method(name = "signalSuperchainV1")]
async fn signal_superchain_v1(&self, signal: SuperchainSignal) -> RpcResult<ProtocolVersion>;
}