add rpc types for eth_callMany, eth_simulateV1, eth_createAccessList

Author: Pana

Cargo.lock

@@ -37,7 +37,7 @@ impl OverlayAccount {
         }
 
         if let Some(nonce) = acc_overrides.nonce {
-            acc.set_nonce(&U256::from(nonce));
+            acc.set_nonce(&U256::from(nonce.as_u64()));
         }
 
         if let Some(code) = acc_overrides.code.as_ref() {

crates/cfxcore/executor/src/state/overlay_account/state_override.rs

@@ -1,7 +1,9 @@
 use cfx_rpc_eth_types::{
-    AccountPendingTransactions, Block, BlockNumber as BlockId, BlockOverrides,
+    AccessListResult, AccountPendingTransactions, Block,
+    BlockNumber as BlockId, BlockOverrides, Bundle, EthCallResponse,
     EthRpcLogFilter as Filter, FeeHistory, Header, Log, Receipt,
-    RpcStateOverride, SyncStatus, Transaction, TransactionRequest,
+    RpcStateOverride, SimulatePayload, SimulatedBlock, StateContext,
+    SyncStatus, Transaction, TransactionRequest,
 };
 use cfx_rpc_primitives::{Bytes, Index};
 use cfx_types::{Address, H256, H64, U256, U64};
@@ -189,12 +191,10 @@ pub trait EthApi {
     /// `eth_simulateV1` executes an arbitrary number of transactions on top of
     /// the requested state. The transactions are packed into individual
     /// blocks. Overrides can be provided.
-    // #[method(name = "simulateV1")]
-    // async fn simulate_v1(
-    //     &self,
-    //     opts: SimBlock,
-    //     block_number: Option<BlockId>,
-    // ) -> RpcResult<Vec<SimulatedBlock>>;
+    #[method(name = "simulateV1")]
+    async fn simulate_v1(
+        &self, opts: SimulatePayload, block_number: Option<BlockId>,
+    ) -> RpcResult<Vec<SimulatedBlock>>;
 
     /// Executes a new message call immediately without creating a transaction
     /// on the block chain.
@@ -207,13 +207,11 @@ pub trait EthApi {
 
     /// Simulate arbitrary number of transactions at an arbitrary blockchain
     /// index, with the optionality of state overrides
-    // #[method(name = "callMany")]
-    // async fn call_many(
-    //     &self,
-    //     bundle: Bundle,
-    //     state_context: Option<StateContext>,
-    //     state_override: Option<StateOverride>,
-    // ) -> RpcResult<Vec<EthCallResponse>>;
+    #[method(name = "callMany")]
+    async fn call_many(
+        &self, bundle: Bundle, state_context: Option<StateContext>,
+        state_override: Option<RpcStateOverride>,
+    ) -> RpcResult<Vec<EthCallResponse>>;
 
     /// Generates an access list for a transaction.
     ///
@@ -231,12 +229,10 @@ pub trait EthApi {
     /// could change when the transaction is actually mined. Adding an
     /// accessList to your transaction does not necessary result in lower
     /// gas usage compared to a transaction without an access list.
-    // #[method(name = "createAccessList")]
-    // async fn create_access_list(
-    //     &self,
-    //     request: TransactionRequest,
-    //     block_number: Option<BlockId>,
-    // ) -> RpcResult<AccessListResult>;
+    #[method(name = "createAccessList")]
+    async fn create_access_list(
+        &self, request: TransactionRequest, block_number: Option<BlockId>,
+    ) -> RpcResult<AccessListResult>;
 
     /// Generates and returns an estimate of how much gas is necessary to allow
     /// the transaction to complete.

crates/rpc/rpc-eth-api/src/eth.rs

@@ -10,10 +10,11 @@ use cfx_rpc_cfx_types::{
 };
 use cfx_rpc_eth_api::EthApiServer;
 use cfx_rpc_eth_types::{
-    AccountOverride, AccountPendingTransactions, Block, BlockNumber as BlockId,
-    BlockOverrides, EthRpcLogFilter, EthRpcLogFilter as Filter, EvmOverrides,
-    FeeHistory, Header, Log, Receipt, RpcStateOverride, SyncInfo, SyncStatus,
-    Transaction, TransactionRequest,
+    AccessListResult, AccountOverride, AccountPendingTransactions, Block,
+    BlockNumber as BlockId, BlockOverrides, Bundle, EthCallResponse,
+    EthRpcLogFilter, EthRpcLogFilter as Filter, EvmOverrides, FeeHistory,
+    Header, Log, Receipt, RpcStateOverride, SimulatePayload, SimulatedBlock,
+    StateContext, SyncInfo, SyncStatus, Transaction, TransactionRequest,
 };
 use cfx_rpc_primitives::{Bytes, Index, U64 as HexU64};
 use cfx_rpc_utils::error::{
@@ -1281,11 +1282,13 @@ impl EthApiServer for EthApi {
     /// `eth_simulateV1` executes an arbitrary number of transactions on top of
     /// the requested state. The transactions are packed into individual
     /// blocks. Overrides can be provided.
-    // async fn simulate_v1(
-    //     &self,
-    //     opts: SimBlock,
-    //     block_number: Option<BlockId>,
-    // ) -> RpcResult<Vec<SimulatedBlock>>;
+    async fn simulate_v1(
+        &self, opts: SimulatePayload, block_number: Option<BlockId>,
+    ) -> RpcResult<Vec<SimulatedBlock>> {
+        let _ = block_number;
+        let _ = opts;
+        Err(jsonrpsee_internal_error("Not implemented"))
+    }
 
     /// Executes a new message call immediately without creating a transaction
     /// on the block chain.
@@ -1306,12 +1309,15 @@ impl EthApiServer for EthApi {
 
     /// Simulate arbitrary number of transactions at an arbitrary blockchain
     /// index, with the optionality of state overrides
-    // async fn call_many(
-    //     &self,
-    //     bundle: Bundle,
-    //     state_context: Option<StateContext>,
-    //     state_override: Option<StateOverride>,
-    // ) -> RpcResult<Vec<EthCallResponse>>;
+    async fn call_many(
+        &self, bundle: Bundle, state_context: Option<StateContext>,
+        state_override: Option<RpcStateOverride>,
+    ) -> RpcResult<Vec<EthCallResponse>> {
+        let _ = bundle;
+        let _ = state_context;
+        let _ = state_override;
+        Err(jsonrpsee_internal_error("Not implemented"))
+    }
 
     /// Generates an access list for a transaction.
     ///
@@ -1329,11 +1335,13 @@ impl EthApiServer for EthApi {
     /// could change when the transaction is actually mined. Adding an
     /// accessList to your transaction does not necessary result in lower
     /// gas usage compared to a transaction without an access list.
-    // async fn create_access_list(
-    //     &self,
-    //     request: TransactionRequest,
-    //     block_number: Option<BlockId>,
-    // ) -> RpcResult<AccessListResult>;
+    async fn create_access_list(
+        &self, request: TransactionRequest, block_number: Option<BlockId>,
+    ) -> RpcResult<AccessListResult> {
+        let _ = block_number;
+        let _ = request;
+        Err(jsonrpsee_internal_error("Not implemented"))
+    }
 
     /// Generates and returns an estimate of how much gas is necessary to allow
     /// the transaction to complete.

crates/rpc/rpc-eth-impl/src/eth.rs

@@ -27,4 +27,8 @@ cfx-rpc-primitives = { workspace = true }
 cfx-rpc-cfx-types = { workspace = true }
 cfx-parity-trace-types = { workspace = true }
 jsonrpsee = { workspace = true, features = ["jsonrpsee-types"] }
-similar-asserts = { workspace = true }
+similar-asserts = { workspace = true }
+
+[features]
+default = ["serde"]
+serde = []

crates/rpc/rpc-eth-types/Cargo.toml

@@ -0,0 +1,48 @@
+use cfx_types::U256;
+use primitives::AccessList;
+
+/// Access list with gas used appended.
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+pub struct AccessListWithGasUsed {
+    /// List with accounts accessed during transaction.
+    pub access_list: AccessList,
+    /// Estimated gas used with access list.
+    pub gas_used: U256,
+}
+
+/// `AccessListResult` for handling errors from `eth_createAccessList`
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+pub struct AccessListResult {
+    /// List with accounts accessed during transaction.
+    pub access_list: AccessList,
+    /// Estimated gas used with access list.
+    pub gas_used: U256,
+    /// Optional error message if the transaction failed.
+    #[cfg_attr(
+        feature = "serde",
+        serde(default, skip_serializing_if = "Option::is_none")
+    )]
+    pub error: Option<String>,
+}
+
+impl AccessListResult {
+    /// Ensures the result is OK, returning [`AccessListWithGasUsed`] if so, or
+    /// an error message if not.
+    pub fn ensure_ok(self) -> Result<AccessListWithGasUsed, String> {
+        match self.error {
+            Some(err) => Err(err),
+            None => Ok(AccessListWithGasUsed {
+                access_list: self.access_list,
+                gas_used: self.gas_used,
+            }),
+        }
+    }
+
+    /// Checks if there is an error in the result.
+    #[inline]
+    pub const fn is_err(&self) -> bool { self.error.is_some() }
+}

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

@@ -28,7 +28,7 @@ use serde::{
 use std::{convert::TryFrom, fmt};
 
 /// Represents rpc api block number param.
-#[derive(Debug, PartialEq, Clone, Hash, Eq)]
+#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
 pub enum BlockNumber {
     /// Hash
     Hash {