Add get block info RPC endpoints (#3957)

* move context into the another module, make it more general

* share context to the RPC service

* add block/header type converters, add first version of the eth_getBlockByHash rpc method

* add another RPC endpoints

* fix CI

* update

* add transaction wrapper type

* update

* fix test

* fix CI

* fix clippy

* update block struct

* add comments

* add correct corresponded ethereum rpc block number type

* fix suggestions

* update changelog

* fix clippy, rename rpc to jrpc

* Revert "update changelog"

This reverts commit b7ba5b4.

* update changelog

* update

Author: Mr-Leshiy

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Bump ed25519-bip32 from 0.4.0 to 0.4.1
 - Now the tally is incremental and is always available in the rest API. The
 - Add standalone explorer crate.
+- Add new Ethreum RPC endpoints for the getting block info: eth_getBlockByHash, eth_getBlockByNumber, eth_getBlockTransactionCountByHash, eth_getBlockTransactionCountByNumber, eth_getUncleCountByBlockHash, eth_getUncleCountByBlockNumber, eth_blockNumber
 - Bump clap from 2.34.0 to 3.1.13
 - Bump time from 0.3.7 to 0.3.9
 - Bump libc from 0.2.117 to 0.2.124

Cargo.lock

@@ -26,7 +26,6 @@ warp = {version = "0.3.1", features = ["tls"]}
 tracing = "0.1"
 tracing-futures = "0.2"
 tracing-gelf = { version = "0.6", optional = true }
-tracing-journald = { version = "0.2.0", optional = true }
 tracing-subscriber = { version = "0.3", features = ["fmt", "json"] }
 tracing-appender = "0.2"
 tokio = { version = "^1.4", features = ["rt-multi-thread", "time", "sync", "rt", "signal", "test-util"] }

explorer/Cargo.toml

@@ -6,7 +6,7 @@ mod secret;
 pub use log::{Log, LogEntry, LogOutput};
 pub use mempool::{LogMaxEntries, Mempool, PersistentLog, PoolMaxEntries};
 pub use node::{
-    Cors, CorsOrigin, LayersConfig, NodeConfig, NodeId, P2p, Policy, PreferredListConfig, Rest,
-    Rpc, Tls, TopicsOfInterest, TrustedPeer,
+    Cors, CorsOrigin, JRpc, LayersConfig, NodeConfig, NodeId, P2p, Policy, PreferredListConfig,
+    Rest, Tls, TopicsOfInterest, TrustedPeer,
 };
 pub use secret::{Bft, GenesisPraos, NodeSecret};

jormungandr-lib/src/interfaces/config/mod.rs

@@ -21,7 +21,7 @@ pub struct Rest {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
-pub struct Rpc {
+pub struct JRpc {
     pub listen: SocketAddr,
 }
 
@@ -294,7 +294,7 @@ pub struct NodeConfig {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub storage: Option<PathBuf>,
     pub rest: Rest,
-    pub rpc: Rpc,
+    pub jrpc: JRpc,
     pub p2p: P2p,
     pub log: Option<Log>,
     pub mempool: Option<Mempool>,

jormungandr-lib/src/interfaces/config/node.rs

@@ -20,6 +20,7 @@ chain-network = { git = "https://github.com/input-output-hk/chain-libs.git", bra
 chain-storage   = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
 chain-time      = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
 chain-vote = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-evm = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master", optional = true }
 cardano-legacy-address = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
 imhamt = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
 
@@ -60,12 +61,9 @@ warp = { version = "0.3.2", features = ["tls"] }
 serde_with = { version = "1.12", features = ["macros"] }
 http-zipkin = "0.3.0"
 prometheus = { version = "0.13", optional = true }
-jsonrpsee-http-server = "0.11.0"
-
-[dependencies.reqwest]
-version = "0.11"
-default-features = false
-features = ["rustls-tls"]
+jsonrpsee-http-server = { version = "0.11.0" }
+jsonrpsee-core = { version = "0.11.0" }
+reqwest = { version = "0.11",  default-features = false, features = ["rustls-tls"] }
 
 [dev-dependencies]
 tokio = { version = "^1.15", features = ["full"] }
@@ -97,4 +95,4 @@ soak-test = []
 systemd = ["tracing-journald"]
 gelf = ["tracing-gelf"]
 prometheus-metrics = ["prometheus"]
-evm = [ "chain-impl-mockchain/evm", "jormungandr-lib/evm" ]
+evm = [ "chain-impl-mockchain/evm", "jormungandr-lib/evm", "chain-evm" ]

jormungandr/Cargo.toml

@@ -1,8 +1,8 @@
 use criterion::black_box;
 use criterion::Criterion;
 use criterion::{criterion_group, criterion_main};
+use jormungandr::context::Context;
 use jormungandr::rest::v0::logic::get_message_logs;
-use jormungandr::rest::Context;
 use tokio::runtime::Runtime;
 
 fn tokio() -> Runtime {

jormungandr/benches/rest_v0.rs

@@ -1,27 +1,38 @@
-use std::sync::Arc;
-
 use crate::{
     blockchain::{Blockchain, Tip},
     diagnostic::Diagnostic,
     intercom::{NetworkMsg, TopologyMsg, TransactionMsg},
     leadership::Logs as LeadershipLogs,
     metrics::backends::SimpleCounter,
     network::GlobalStateR as NetworkStateR,
-    rest::ServerStopper,
     secure::enclave::Enclave,
     utils::async_msg::MessageBox,
 };
+use futures::channel::mpsc;
 use jormungandr_lib::interfaces::NodeState;
-
+use std::sync::Arc;
 use tokio::sync::RwLock;
 use tokio_util::sync::CancellationToken;
 use tracing::Span;
 
 pub type ContextLock = Arc<RwLock<Context>>;
 
+#[derive(Clone)]
+pub struct ServerStopper(mpsc::Sender<()>);
+
+impl ServerStopper {
+    pub fn new(sender: mpsc::Sender<()>) -> Self {
+        Self(sender)
+    }
+
+    pub fn stop(&self) {
+        self.0.clone().try_send(()).unwrap();
+    }
+}
+
 pub struct Context {
     full: Option<FullContext>,
-    server_stopper: Option<ServerStopper>,
+    rest_server_stopper: Option<ServerStopper>,
     node_state: NodeState,
     span: Option<Span>,
     diagnostic: Option<Diagnostic>,
@@ -32,17 +43,17 @@ pub struct Context {
 
 #[derive(Debug, thiserror::Error)]
 pub enum Error {
-    #[error("Full REST context not available yet")]
+    #[error("Full REST/RPC context not available yet")]
     FullContext,
-    #[error("Server stopper not set in REST context")]
+    #[error("Server stopper not set in REST/RPC context")]
     ServerStopper,
-    #[error("Log span not set in REST context")]
+    #[error("Log span not set in REST/RPC context")]
     Span,
-    #[error("Blockchain not set in REST context")]
+    #[error("Blockchain not set in REST/RPC context")]
     Blockchain,
-    #[error("Blockchain tip not set in REST context")]
+    #[error("Blockchain tip not set in REST/RPC context")]
     BlockchainTip,
-    #[error("Diagnostic data not set in REST context")]
+    #[error("Diagnostic data not set in REST/RPC context")]
     Diagnostic,
 }
 
@@ -58,7 +69,7 @@ impl Context {
     pub fn new() -> Self {
         Context {
             full: Default::default(),
-            server_stopper: Default::default(),
+            rest_server_stopper: Default::default(),
             node_state: NodeState::StartingRestServer,
             span: Default::default(),
             diagnostic: Default::default(),
@@ -76,12 +87,14 @@ impl Context {
         self.full.as_ref().ok_or(Error::FullContext)
     }
 
-    pub fn set_server_stopper(&mut self, server_stopper: ServerStopper) {
-        self.server_stopper = Some(server_stopper);
+    pub fn set_rest_server_stopper(&mut self, server_stopper: ServerStopper) {
+        self.rest_server_stopper = Some(server_stopper);
     }
 
-    pub fn server_stopper(&self) -> Result<&ServerStopper, Error> {
-        self.server_stopper.as_ref().ok_or(Error::ServerStopper)
+    pub fn rest_server_stopper(&self) -> Result<&ServerStopper, Error> {
+        self.rest_server_stopper
+            .as_ref()
+            .ok_or(Error::ServerStopper)
     }
 
     pub fn set_node_state(&mut self, node_state: NodeState) {

jormungandr/src/rest/context.rs renamed to jormungandr/src/context/mod.rs

@@ -0,0 +1,55 @@
+use super::Error;
+use crate::{
+    context::Context,
+    jrpc::eth_types::{block::Block, block_number::BlockNumber},
+};
+use chain_evm::ethereum_types::{H256, U256};
+
+pub fn get_block_by_hash(
+    _hash: H256,
+    full: bool,
+    _context: &Context,
+) -> Result<Option<Block>, Error> {
+    // TODO implement
+    Ok(Some(Block::build(full)))
+}
+
+pub fn get_block_by_number(
+    _number: BlockNumber,
+    _full: bool,
+    _context: &Context,
+) -> Result<Option<Block>, Error> {
+    // TODO implement
+    Ok(Some(Block::default()))
+}
+
+pub fn get_transaction_count_by_hash(
+    _hash: H256,
+    _context: &Context,
+) -> Result<Option<U256>, Error> {
+    // TODO implement
+    Ok(Some(0.into()))
+}
+
+pub fn get_transaction_count_by_number(
+    _number: BlockNumber,
+    _context: &Context,
+) -> Result<Option<U256>, Error> {
+    // TODO implement
+    Ok(Some(0.into()))
+}
+
+pub fn get_uncle_count_by_hash(_: H256, _: &Context) -> Result<Option<U256>, Error> {
+    // jormungandr block does not have any ethereum "uncles" so we allways return 0
+    Ok(Some(0.into()))
+}
+
+pub fn get_uncle_count_by_number(_: BlockNumber, _: &Context) -> Result<Option<U256>, Error> {
+    // jormungandr block does not have any ethereum "uncles" so we allways return 0
+    Ok(Some(0.into()))
+}
+
+pub fn get_block_number(_: &Context) -> Result<U256, Error> {
+    // TODO implement
+    Ok(0.into())
+}

jormungandr/src/jrpc/eth_block_info/logic.rs

@@ -0,0 +1,93 @@
+use crate::{blockchain::StorageError, context::ContextLock};
+use jsonrpsee_http_server::RpcModule;
+
+mod logic;
+
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    #[error(transparent)]
+    ContextError(#[from] crate::context::Error),
+    #[error(transparent)]
+    Storage(#[from] StorageError),
+}
+
+pub fn eth_get_blocks_info_module(context: ContextLock) -> RpcModule<ContextLock> {
+    let mut module = RpcModule::new(context);
+
+    module
+        .register_async_method("eth_getBlockByHash", |params, context| async move {
+            let context = context.read().await;
+            let (block_hash, full) = params.parse()?;
+            logic::get_block_by_hash(block_hash, full, &context)
+                .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+        })
+        .unwrap();
+
+    module
+        .register_async_method("eth_getBlockByNumber", |params, context| async move {
+            let context = context.read().await;
+            let (block_number, full) = params.parse()?;
+            logic::get_block_by_number(block_number, full, &context)
+                .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+        })
+        .unwrap();
+
+    module
+        .register_async_method(
+            "eth_getBlockTransactionCountByHash",
+            |params, context| async move {
+                let context = context.read().await;
+                let block_hash = params.parse()?;
+                logic::get_transaction_count_by_hash(block_hash, &context)
+                    .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+            },
+        )
+        .unwrap();
+
+    module
+        .register_async_method(
+            "eth_getBlockTransactionCountByNumber",
+            |params, context| async move {
+                let context = context.read().await;
+                let block_number = params.parse()?;
+                logic::get_transaction_count_by_number(block_number, &context)
+                    .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+            },
+        )
+        .unwrap();
+
+    module
+        .register_async_method(
+            "eth_getUncleCountByBlockHash",
+            |params, context| async move {
+                let context = context.read().await;
+                let block_hash = params.parse()?;
+                logic::get_uncle_count_by_hash(block_hash, &context)
+                    .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+            },
+        )
+        .unwrap();
+
+    module
+        .register_async_method(
+            "eth_getUncleCountByBlockNumber",
+            |params, context| async move {
+                let context = context.read().await;
+                let block_number = params.parse()?;
+                logic::get_uncle_count_by_number(block_number, &context)
+                    .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+            },
+        )
+        .unwrap();
+
+    module
+        .register_async_method("eth_blockNumber", |_, context| async move {
+            let context = context.read().await;
+
+            logic::get_block_number(&context)
+                .map_err(|err| jsonrpsee_core::Error::Custom(err.to_string()))
+        })
+        .unwrap();
+
+    module
+}