Test(rpc): Test support for different api modules (#1288)

Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>

Cargo.lock

@@ -4649,6 +4649,7 @@ dependencies = [
  "reth-provider",
  "reth-rpc",
  "reth-rpc-api",
+ "reth-rpc-types",
  "reth-tracing",
  "reth-transaction-pool",
  "serde",

crates/rpc/rpc-builder/Cargo.toml

@@ -13,6 +13,7 @@ reth-network-api = { path = "../../net/network-api" }
 reth-provider = { path = "../../storage/provider" }
 reth-rpc = { path = "../rpc" }
 reth-rpc-api = { path = "../rpc-api" }
+reth-rpc-types = { path = "../rpc-types" }
 reth-transaction-pool = { path = "../../transaction-pool" }
 
 jsonrpsee = { version = "0.16", features = ["server"] }

crates/rpc/rpc-builder/tests/it/http.rs

@@ -1,10 +1,36 @@
 //! Standalone http tests
 
+use std::collections::HashSet;
+
 use crate::utils::{launch_http, launch_http_ws, launch_ws};
-use jsonrpsee::core::client::{ClientT, SubscriptionClientT};
-use reth_primitives::NodeRecord;
-use reth_rpc_api::clients::AdminApiClient;
+use jsonrpsee::{
+    core::{
+        client::{ClientT, SubscriptionClientT},
+        error::Error,
+    },
+    types::error::{CallError, ErrorCode},
+};
+use reth_primitives::{
+    hex_literal::hex,
+    rpc::{BlockId, BlockNumber as RpcBlockNumber},
+    Address, BlockNumber, Bytes, NodeRecord, H256, H64, U256,
+};
+use reth_rpc_api::{
+    clients::{AdminApiClient, EthApiClient},
+    DebugApiClient, NetApiClient, TraceApiClient, Web3ApiClient,
+};
 use reth_rpc_builder::RethRpcModule;
+use reth_rpc_types::{trace::filter::TraceFilter, CallRequest, Index, TransactionRequest};
+
+fn is_unimplemented(err: Error) -> bool {
+    match err {
+        Error::Call(CallError::Custom(error_obj)) => {
+            error_obj.code() == ErrorCode::InternalError.code() &&
+                error_obj.message() == "unimplemented"
+        }
+        _ => return false,
+    }
+}
 
 async fn test_basic_admin_calls<C>(client: &C)
 where
@@ -20,6 +46,206 @@ where
     AdminApiClient::node_info(client).await.unwrap();
 }
 
+async fn test_basic_eth_calls<C>(client: &C)
+where
+    C: ClientT + SubscriptionClientT + Sync,
+{
+    let address = Address::default();
+    let index = Index::default();
+    let hash = H256::default();
+    let block_number = BlockNumber::default();
+    let call_request = CallRequest::default();
+    let transaction_request = TransactionRequest::default();
+    let bytes = Bytes::default();
+    let tx = Bytes::from(hex!("02f871018303579880850555633d1b82520894eee27662c2b8eba3cd936a23f039f3189633e4c887ad591c62bdaeb180c080a07ea72c68abfb8fca1bd964f0f99132ed9280261bdca3e549546c0205e800f7d0a05b4ef3039e9c9b9babc179a1878fb825b5aaf5aed2fa8744854150157b08d6f3"));
+
+    // Implemented
+    EthApiClient::protocol_version(client).await.unwrap();
+    EthApiClient::chain_id(client).await.unwrap();
+    EthApiClient::chain_id(client).await.unwrap();
+    EthApiClient::accounts(client).await.unwrap();
+    EthApiClient::block_number(client).await.unwrap();
+    EthApiClient::get_code(client, address, None).await.unwrap();
+    EthApiClient::send_raw_transaction(client, tx).await.unwrap();
+
+    // Unimplemented
+    assert!(is_unimplemented(EthApiClient::syncing(client).await.err().unwrap()));
+    assert!(is_unimplemented(EthApiClient::author(client).await.err().unwrap()));
+    assert!(is_unimplemented(
+        EthApiClient::block_by_hash(client, hash, false).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::block_by_number(client, block_number, false).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::block_transaction_count_by_hash(client, hash).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::block_transaction_count_by_number(client, block_number).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::block_uncles_count_by_hash(client, hash).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::block_uncles_count_by_number(client, block_number).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::uncle_by_block_hash_and_index(client, hash, index).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::uncle_by_block_number_and_index(client, block_number, index)
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(EthApiClient::transaction_by_hash(client, hash).await.err().unwrap()));
+    assert!(is_unimplemented(
+        EthApiClient::transaction_by_block_hash_and_index(client, hash, index).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::transaction_by_block_number_and_index(client, block_number, index)
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(EthApiClient::transaction_receipt(client, hash).await.err().unwrap()));
+    assert!(is_unimplemented(EthApiClient::balance(client, address, None).await.err().unwrap()));
+    assert!(is_unimplemented(
+        EthApiClient::storage_at(client, address, U256::default(), None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::transaction_count(client, address, None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::call(client, call_request.clone(), None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::create_access_list(client, call_request.clone(), None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::estimate_gas(client, call_request.clone(), None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(EthApiClient::gas_price(client).await.err().unwrap()));
+    assert!(is_unimplemented(
+        EthApiClient::fee_history(client, U256::default(), block_number, None).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(EthApiClient::max_priority_fee_per_gas(client).await.err().unwrap()));
+    assert!(is_unimplemented(EthApiClient::is_mining(client).await.err().unwrap()));
+    assert!(is_unimplemented(EthApiClient::hashrate(client).await.err().unwrap()));
+    assert!(is_unimplemented(EthApiClient::get_work(client).await.err().unwrap()));
+    assert!(is_unimplemented(
+        EthApiClient::submit_hashrate(client, U256::default(), H256::default())
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::submit_work(client, H64::default(), H256::default(), H256::default())
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::send_transaction(client, transaction_request).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::sign(client, address, bytes.clone()).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::sign_transaction(client, call_request.clone()).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::sign_typed_data(client, address, jsonrpsee::core::JsonValue::Null)
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(
+        EthApiClient::get_proof(client, address, vec![], None).await.err().unwrap()
+    ));
+}
+
+async fn test_basic_debug_calls<C>(client: &C)
+where
+    C: ClientT + SubscriptionClientT + Sync,
+{
+    let block_id = BlockId::Number(RpcBlockNumber::default());
+
+    assert!(is_unimplemented(DebugApiClient::raw_header(client, block_id).await.err().unwrap()));
+    assert!(is_unimplemented(DebugApiClient::raw_block(client, block_id).await.err().unwrap()));
+    assert!(is_unimplemented(
+        DebugApiClient::raw_transaction(client, H256::default()).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(DebugApiClient::raw_receipts(client, block_id).await.err().unwrap()));
+    assert!(is_unimplemented(DebugApiClient::bad_blocks(client).await.err().unwrap()));
+}
+
+async fn test_basic_net_calls<C>(client: &C)
+where
+    C: ClientT + SubscriptionClientT + Sync,
+{
+    NetApiClient::version(client).await.unwrap();
+    NetApiClient::peer_count(client).await.unwrap();
+    NetApiClient::is_listening(client).await.unwrap();
+}
+
+async fn test_basic_trace_calls<C>(client: &C)
+where
+    C: ClientT + SubscriptionClientT + Sync,
+{
+    let block_id = BlockId::Number(RpcBlockNumber::default());
+    let trace_filter = TraceFilter {
+        from_block: None,
+        to_block: None,
+        from_address: None,
+        to_address: None,
+        after: None,
+        count: None,
+    };
+
+    assert!(is_unimplemented(
+        TraceApiClient::call(client, CallRequest::default(), HashSet::default(), None)
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(TraceApiClient::call_many(client, vec![], None).await.err().unwrap()));
+    assert!(is_unimplemented(
+        TraceApiClient::raw_transaction(client, Bytes::default(), HashSet::default(), None)
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(
+        TraceApiClient::replay_block_transactions(client, block_id, HashSet::default())
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(
+        TraceApiClient::replay_transaction(client, H256::default(), HashSet::default())
+            .await
+            .err()
+            .unwrap()
+    ));
+    assert!(is_unimplemented(TraceApiClient::block(client, block_id).await.err().unwrap()));
+    assert!(is_unimplemented(TraceApiClient::filter(client, trace_filter).await.err().unwrap()));
+    assert!(is_unimplemented(
+        TraceApiClient::trace(client, H256::default(), vec![]).await.err().unwrap()
+    ));
+    assert!(is_unimplemented(
+        TraceApiClient::transaction_traces(client, H256::default()).await.err().unwrap()
+    ));
+}
+
+async fn test_basic_web3_calls<C>(client: &C)
+where
+    C: ClientT + SubscriptionClientT + Sync,
+{
+    Web3ApiClient::client_version(client).await.unwrap();
+    Web3ApiClient::sha3(client, Bytes::default()).await.unwrap();
+}
+
 #[tokio::test(flavor = "multi_thread")]
 async fn test_call_admin_functions_http() {
     reth_tracing::init_test_tracing();
@@ -46,3 +272,138 @@ async fn test_call_admin_functions_http_and_ws() {
     let client = handle.http_client().unwrap();
     test_basic_admin_calls(&client).await;
 }
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_eth_functions_http() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http(vec![RethRpcModule::Eth]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_eth_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_eth_functions_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_ws(vec![RethRpcModule::Eth]).await;
+    let client = handle.ws_client().await.unwrap();
+    test_basic_eth_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_eth_functions_http_and_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http_ws(vec![RethRpcModule::Eth]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_eth_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_debug_functions_http() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http(vec![RethRpcModule::Debug]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_debug_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_debug_functions_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_ws(vec![RethRpcModule::Debug]).await;
+    let client = handle.ws_client().await.unwrap();
+    test_basic_debug_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_debug_functions_http_and_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http_ws(vec![RethRpcModule::Debug]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_debug_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_net_functions_http() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http(vec![RethRpcModule::Net]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_net_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_net_functions_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_ws(vec![RethRpcModule::Net]).await;
+    let client = handle.ws_client().await.unwrap();
+    test_basic_net_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_net_functions_http_and_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http_ws(vec![RethRpcModule::Net]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_net_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_trace_functions_http() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http(vec![RethRpcModule::Trace]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_trace_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_trace_functions_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_ws(vec![RethRpcModule::Trace]).await;
+    let client = handle.ws_client().await.unwrap();
+    test_basic_trace_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_trace_functions_http_and_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http_ws(vec![RethRpcModule::Trace]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_trace_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_web3_functions_http() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http(vec![RethRpcModule::Web3]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_web3_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_web3_functions_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_ws(vec![RethRpcModule::Web3]).await;
+    let client = handle.ws_client().await.unwrap();
+    test_basic_web3_calls(&client).await;
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn test_call_web3_functions_http_and_ws() {
+    reth_tracing::init_test_tracing();
+
+    let handle = launch_http_ws(vec![RethRpcModule::Web3]).await;
+    let client = handle.http_client().unwrap();
+    test_basic_web3_calls(&client).await;
+}

crates/rpc/rpc-types/src/eth/index.rs

@@ -5,7 +5,7 @@ use serde::{
 use std::fmt;
 
 /// A hex encoded or decimal index
-#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
+#[derive(Debug, PartialEq, Eq, Hash, Clone, Copy, Default)]
 pub struct Index(usize);
 
 impl From<Index> for usize {