-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "chore: Remove rpc-jsonrpsee Crate (#376)"
This reverts commit 835c340.
- Loading branch information
Showing
11 changed files
with
238 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| [package] | ||
| name = "op-alloy-rpc-jsonrpsee" | ||
| description = "Optimism RPC Client" | ||
|
|
||
| version.workspace = true | ||
| edition.workspace = true | ||
| rust-version.workspace = true | ||
| license.workspace = true | ||
| homepage.workspace = true | ||
| authors.workspace = true | ||
| repository.workspace = true | ||
| exclude.workspace = true | ||
|
|
||
| [lints] | ||
| 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 | ||
|
|
||
| # Maili | ||
| maili-protocol.workspace = true | ||
|
|
||
| # rpc | ||
| jsonrpsee.workspace = true | ||
|
|
||
| [features] | ||
| default = ["std"] | ||
| std = [ | ||
| "op-alloy-rpc-types/std", | ||
| "op-alloy-rpc-types-engine/std", | ||
| "alloy-eips/std", | ||
| "alloy-primitives/std", | ||
| ] | ||
| client = [ | ||
| "jsonrpsee/client", | ||
| "jsonrpsee/async-client", | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## `op-alloy-rpc-jsonrpsee` | ||
|
|
||
| <a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a> | ||
| <a href="https://crates.io/crates/op-alloy-rpc-jsonrpsee"><img src="https://img.shields.io/crates/v/op-alloy-rpc-jsonrpsee.svg" alt="op-alloy-rpc-jsonrpsee crate"></a> | ||
| <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="MIT License"></a> | ||
| <a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="Apache License"></a> | ||
| <a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a> | ||
|
|
||
|
|
||
| Low-level Optimism JSON-RPC server and client implementations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| #![doc = include_str!("../README.md")] | ||
| #![doc( | ||
| html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg", | ||
| html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico" | ||
| )] | ||
| #![cfg_attr(not(test), warn(unused_crate_dependencies))] | ||
| #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] | ||
| #![cfg_attr(not(feature = "std"), no_std)] | ||
|
|
||
| extern crate alloc; | ||
|
|
||
| pub mod traits; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| #![allow(missing_docs)] | ||
|
|
||
| //! Rollup Node | ||
| use alloc::{boxed::Box, string::String, vec::Vec}; | ||
| use core::net::IpAddr; | ||
|
|
||
| use alloy_eips::BlockNumberOrTag; | ||
| use alloy_primitives::{B256, U64}; | ||
| use jsonrpsee::{core::RpcResult, proc_macros::rpc}; | ||
| use maili_protocol::{ExecutingMessage, SafetyLevel}; | ||
| use op_alloy_rpc_types::{ | ||
| OutputResponse, PeerDump, PeerInfo, PeerStats, RollupConfig, SafeHeadResponse, SyncStatus, | ||
| }; | ||
| use op_alloy_rpc_types_engine::{ProtocolVersion, SuperchainSignal}; | ||
|
|
||
| /// Optimism specified rpc interface. | ||
| /// | ||
| /// https://docs.optimism.io/builders/node-operators/json-rpc | ||
| /// https://github.com/ethereum-optimism/optimism/blob/8dd17a7b114a7c25505cd2e15ce4e3d0f7e3f7c1/op-node/node/api.go#L114 | ||
| #[cfg_attr(not(feature = "client"), rpc(server, namespace = "optimism"))] | ||
| #[cfg_attr(feature = "client", rpc(server, client, namespace = "optimism"))] | ||
| pub trait RollupNode { | ||
| /// Get the output root at a specific block. | ||
| #[method(name = "outputAtBlock")] | ||
| async fn op_output_at_block(&self, block_number: BlockNumberOrTag) | ||
| -> RpcResult<OutputResponse>; | ||
|
|
||
| /// Gets the safe head at an L1 block height. | ||
| #[method(name = "safeHeadAtL1Block")] | ||
| async fn op_safe_head_at_l1_block( | ||
| &self, | ||
| block_number: BlockNumberOrTag, | ||
| ) -> RpcResult<SafeHeadResponse>; | ||
|
|
||
| /// Get the synchronization status. | ||
| #[method(name = "syncStatus")] | ||
| async fn op_sync_status(&self) -> RpcResult<SyncStatus>; | ||
|
|
||
| /// Get the rollup configuration parameters. | ||
| #[method(name = "rollupConfig")] | ||
| async fn op_rollup_config(&self) -> RpcResult<RollupConfig>; | ||
|
|
||
| /// Get the software version. | ||
| #[method(name = "version")] | ||
| async fn op_version(&self) -> RpcResult<String>; | ||
| } | ||
|
|
||
| /// The opp2p namespace handles peer interactions. | ||
| #[cfg_attr(not(feature = "client"), rpc(server, namespace = "opp2p"))] | ||
| #[cfg_attr(feature = "client", rpc(server, client, namespace = "opp2p"))] | ||
| pub trait OpP2PApi { | ||
| /// Returns information of node | ||
| #[method(name = "self")] | ||
| async fn opp2p_self(&self) -> RpcResult<PeerInfo>; | ||
|
|
||
| #[method(name = "peers")] | ||
| async fn opp2p_peers(&self) -> RpcResult<PeerDump>; | ||
|
|
||
| #[method(name = "peerStats")] | ||
| async fn opp2p_peer_stats(&self) -> RpcResult<PeerStats>; | ||
|
|
||
| #[method(name = "discoveryTable")] | ||
| async fn opp2p_discovery_table(&self) -> RpcResult<Vec<String>>; | ||
|
|
||
| #[method(name = "blockPeer")] | ||
| async fn opp2p_block_peer(&self, peer: String) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "listBlockedPeers")] | ||
| async fn opp2p_list_blocked_peers(&self) -> RpcResult<Vec<String>>; | ||
|
|
||
| #[method(name = "blocAddr")] | ||
| async fn opp2p_block_addr(&self, ip: IpAddr) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "unblockAddr")] | ||
| async fn opp2p_unblock_addr(&self, ip: IpAddr) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "listBlockedAddrs")] | ||
| async fn opp2p_list_blocked_addrs(&self) -> RpcResult<Vec<IpAddr>>; | ||
|
|
||
| /// todo: should be IPNet? | ||
| #[method(name = "blockSubnet")] | ||
| async fn opp2p_block_subnet(&self, subnet: String) -> RpcResult<()>; | ||
|
|
||
| /// todo: should be IPNet? | ||
| #[method(name = "unblockSubnet")] | ||
| async fn opp2p_unblock_subnet(&self, subnet: String) -> RpcResult<()>; | ||
|
|
||
| /// todo: should be IPNet? | ||
| #[method(name = "listBlockedSubnets")] | ||
| async fn opp2p_list_blocked_subnets(&self) -> RpcResult<Vec<String>>; | ||
|
|
||
| #[method(name = "protectPeer")] | ||
| async fn opp2p_protect_peer(&self, peer: String) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "unprotectPeer")] | ||
| async fn opp2p_unprotect_peer(&self, peer: String) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "connectPeer")] | ||
| async fn opp2p_connect_peer(&self, peer: String) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "disconnectPeer")] | ||
| async fn opp2p_disconnect_peer(&self, peer: String) -> RpcResult<()>; | ||
| } | ||
|
|
||
| /// The admin namespace endpoints | ||
| /// https://github.com/ethereum-optimism/optimism/blob/c7ad0ebae5dca3bf8aa6f219367a95c15a15ae41/op-node/node/api.go#L28-L36 | ||
| #[cfg_attr(not(feature = "client"), rpc(server, namespace = "admin"))] | ||
| #[cfg_attr(feature = "client", rpc(server, client, namespace = "admin"))] | ||
| pub trait OpAdminApi { | ||
| #[method(name = "resetDerivationPipeline")] | ||
| async fn admin_reset_derivation_pipeline(&self) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "startSequencer")] | ||
| async fn admin_start_sequencer(&self, block_hash: B256) -> RpcResult<()>; | ||
|
|
||
| #[method(name = "stopSequencer")] | ||
| async fn admin_stop_sequencer(&self) -> RpcResult<B256>; | ||
|
|
||
| #[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>; | ||
| } | ||
|
|
||
| /// Op API extension for controlling the miner. | ||
| #[cfg_attr(not(feature = "client"), rpc(server, namespace = "miner"))] | ||
| #[cfg_attr(feature = "client", rpc(server, client, namespace = "miner"))] | ||
| pub trait MinerApiExt { | ||
| /// Sets the maximum data availability size of any tx allowed in a block, and the total max l1 | ||
| /// data size of the block. 0 means no maximum. | ||
| #[method(name = "setMaxDASize")] | ||
| async fn set_max_da_size(&self, max_tx_size: U64, max_block_size: U64) -> RpcResult<bool>; | ||
| } | ||
|
|
||
| /// Supervisor API for interop. | ||
| #[rpc(client, namespace = "supervisor")] | ||
| pub trait SupervisorApi { | ||
| /// Checks if the given messages meet the given minimum safety level. | ||
| #[method(name = "checkMessages")] | ||
| async fn check_messages( | ||
| &self, | ||
| messages: Vec<ExecutingMessage>, | ||
| min_safety: SafetyLevel, | ||
| ) -> RpcResult<()>; | ||
| } |