feat: Implement web3_clientVersion (#223)

* feat: Implement web3_clientVersion * lint fix --------- Co-authored-by: Dustin Brickwood <[email protected]>
matter-labs · Nov 27, 2023 · 7f68fc4 · 7f68fc4
1 parent 134805d
commit 7f68fc4
Show file tree

Hide file tree

Showing 13 changed files with 99 additions and 12 deletions.
diff --git a/SUPPORTED_APIS.md b/SUPPORTED_APIS.md
@@ -111,6 +111,7 @@ The `status` options are:
 | [`NETWORK`](#network-namespace) | [`net_version`](#net_version) | `SUPPORTED` | Returns the current network id <br />_(default is `260`)_ |
 | [`NETWORK`](#network-namespace) | [`net_peerCount`](#net_peercount) | `SUPPORTED` | Returns the number of peers currently connected to the client <br/>_(hard-coded to `0`)_ |
 | [`NETWORK`](#network-namespace) | [`net_listening`](#net_listening) | `SUPPORTED` | Returns `true` if the client is actively listening for network connections <br />_(hard-coded to `false`)_ |
+| [`WEB3`](#web3-namespace) | [`web3_clientVersion`](#web3_clientversion) | `SUPPORTED` | Returns `zkSync/v2.0` |
 | [`ZKS`](#zks-namespace) | [`zks_estimateFee`](#zks_estimateFee) | `SUPPORTED` | Gets the Fee estimation data for a given Request |
 | `ZKS` | `zks_estimateGasL1ToL2` | `NOT IMPLEMENTED` | Estimate of the gas required for a L1 to L2 transaction |
 | [`ZKS`](#zks-namespace) | [`zks_getAllAccountBalances`](#zks_getallaccountbalances) | `SUPPORTED` | Returns all balances for confirmed tokens given by an account address |
@@ -1708,6 +1709,35 @@ curl --request POST \
   --data '{"jsonrpc": "2.0","id": "1","method": "evm_revert","params": ["0x1"]}'
 ```
 
+## `WEB3 NAMESPACE`
+
+### `web3_clientVersion`
+
+[source](src/node/web3.rs)
+
+Returns the client version
+
+#### Arguments
+
++ _NONE_
+
+#### Status
+
+`SUPPORTED`
+
+#### Example
+
+```bash
+curl --request POST \
+  --url http://localhost:8011/ \
+  --header 'content-type: application/json' \
+  --data '{
+    "jsonrpc": "2.0",
+    "id": "1",
+    "method": "web3_clientVersion"
+  }'
+```
+
 ## `ZKS NAMESPACE`
 
 ### `zks_estimateFee`

diff --git a/e2e-tests/test/evm-apis.test.ts b/e2e-tests/test/evm-apis.test.ts
@@ -102,13 +102,12 @@ describe("evm_snapshot", function () {
     expect(await greeter.greet()).to.eq("Hi");
 
     // Act
-    const snapshotId1 = await provider.send("evm_snapshot", []);
-    const snapshotId2 = await provider.send("evm_snapshot", []);
+    const snapshotId1: string = await provider.send("evm_snapshot", []);
+    const snapshotId2: string = await provider.send("evm_snapshot", []);
 
     // Assert
     expect(await greeter.greet()).to.eq("Hi");
-    expect(BigNumber.from(snapshotId1).toString()).to.eq("1");
-    expect(BigNumber.from(snapshotId2).toString()).to.eq("2");
+    expect(BigNumber.from(snapshotId2).toString()).to.eq(BigNumber.from(snapshotId1).add(1).toString());
   });
 });
 

diff --git a/e2e-tests/test/web3-apis.test.ts b/e2e-tests/test/web3-apis.test.ts
@@ -0,0 +1,17 @@
+import { expect } from "chai";
+import { getTestProvider } from "../helpers/utils";
+
+const provider = getTestProvider();
+
+describe("web3_clientVersion", function () {
+  it("Should return zkSync/v2.0", async function () {
+    // Arrange
+    const expectedClientVersion = "zkSync/v2.0";
+
+    // Act
+    const response: string = await provider.send("web3_clientVersion", []);
+
+    // Assert
+    expect(response).to.equal(expectedClientVersion);
+  });
+});
diff --git a/src/fork.rs b/src/fork.rs
@@ -301,6 +301,10 @@ pub struct ForkDetails<S> {
 }
 
 const SUPPORTED_VERSIONS: &[ProtocolVersionId] = &[
+    ProtocolVersionId::Version9,
+    ProtocolVersionId::Version10,
+    ProtocolVersionId::Version11,
+    ProtocolVersionId::Version12,
     ProtocolVersionId::Version13,
     ProtocolVersionId::Version14,
     ProtocolVersionId::Version15,

diff --git a/src/http_fork_source.rs b/src/http_fork_source.rs
@@ -700,8 +700,8 @@ mod tests {
                 "result": {
                     "l1Erc20DefaultBridge": format!("{:#x}", input_bridge_addresses.l1_erc20_default_bridge),
                     "l2Erc20DefaultBridge": format!("{:#x}", input_bridge_addresses.l2_erc20_default_bridge),
-                    "l1WethBridge": format!("{:#x}", input_bridge_addresses.l1_weth_bridge.clone().unwrap()),
-                    "l2WethBridge": format!("{:#x}", input_bridge_addresses.l2_weth_bridge.clone().unwrap())
+                    "l1WethBridge": format!("{:#x}", input_bridge_addresses.l1_weth_bridge.unwrap()),
+                    "l2WethBridge": format!("{:#x}", input_bridge_addresses.l2_weth_bridge.unwrap())
                 },
                 "id": 0
             }),

diff --git a/src/main.rs b/src/main.rs
@@ -44,7 +44,7 @@ use zksync_basic_types::{H160, H256};
 
 use crate::namespaces::{
     ConfigurationApiNamespaceT, DebugNamespaceT, EthNamespaceT, EvmNamespaceT, HardhatNamespaceT,
-    NetNamespaceT, ZksNamespaceT,
+    NetNamespaceT, Web3NamespaceT, ZksNamespaceT,
 };
 
 /// List of wallets (address, private key) that we seed with tokens at start.
@@ -105,6 +105,7 @@ async fn build_json_http<
         let mut io = MetaIoHandler::with_middleware(LoggingMiddleware::new(log_level_filter));
 
         io.extend_with(NetNamespaceT::to_delegate(node.clone()));
+        io.extend_with(Web3NamespaceT::to_delegate(node.clone()));
         io.extend_with(ConfigurationApiNamespaceT::to_delegate(node.clone()));
         io.extend_with(DebugNamespaceT::to_delegate(node.clone()));
         io.extend_with(EthNamespaceT::to_delegate(node.clone()));

diff --git a/src/namespaces/mod.rs b/src/namespaces/mod.rs
@@ -2,6 +2,7 @@ mod config;
 mod evm;
 mod hardhat;
 mod net;
+mod web3;
 
 use zksync_core::api_server::web3::backend_jsonrpc::namespaces::{debug, eth, zks};
 
@@ -11,6 +12,7 @@ pub use eth::EthNamespaceT;
 pub use evm::EvmNamespaceT;
 pub use hardhat::HardhatNamespaceT;
 pub use net::NetNamespaceT;
+pub use web3::Web3NamespaceT;
 pub use zks::ZksNamespaceT;
 
 pub type Result<T> = jsonrpc_core::Result<T>;

diff --git a/src/namespaces/web3.rs b/src/namespaces/web3.rs
@@ -0,0 +1,9 @@
+use jsonrpc_derive::rpc;
+
+use crate::namespaces::Result;
+
+#[rpc]
+pub trait Web3NamespaceT {
+    #[rpc(name = "web3_clientVersion", returns = "String")]
+    fn web3_client_version(&self) -> Result<String>;
+}
diff --git a/src/node/debug.rs b/src/node/debug.rs
@@ -256,7 +256,7 @@ mod tests {
         );
         let secondary_deployed_address = deployed_address_create(from_account, U256::zero());
         testing::deploy_contract(
-            &node,
+            node,
             H256::repeat_byte(0x1),
             private_key,
             secondary_bytecode,
@@ -271,7 +271,7 @@ mod tests {
         );
         let primary_deployed_address = deployed_address_create(from_account, U256::one());
         testing::deploy_contract(
-            &node,
+            node,
             H256::repeat_byte(0x1),
             private_key,
             primary_bytecode,
@@ -306,7 +306,7 @@ mod tests {
 
         // check that the call was successful
         let output =
-            ethers::abi::decode(&[ParamType::Uint(256)], &trace.output.0.as_slice()).unwrap();
+            ethers::abi::decode(&[ParamType::Uint(256)], trace.output.0.as_slice()).unwrap();
         assert_eq!(output[0], Token::Uint(U256::from(84)));
 
         // find the call to primary contract in the trace

diff --git a/src/node/mod.rs b/src/node/mod.rs
@@ -8,6 +8,7 @@ mod hardhat;
 mod in_memory;
 mod in_memory_ext;
 mod net;
+mod web3;
 mod zks;
 
 pub use in_memory::*;
diff --git a/src/node/web3.rs b/src/node/web3.rs
@@ -0,0 +1,13 @@
+use crate::{
+    fork::ForkSource,
+    namespaces::{Result, Web3NamespaceT},
+    node::InMemoryNode,
+};
+
+impl<S: ForkSource + std::fmt::Debug + Clone + Send + Sync + 'static> Web3NamespaceT
+    for InMemoryNode<S>
+{
+    fn web3_client_version(&self) -> Result<String> {
+        Ok("zkSync/v2.0".to_string())
+    }
+}
diff --git a/src/node/zks.rs b/src/node/zks.rs
@@ -814,8 +814,8 @@ mod tests {
                 "result": {
                     "l1Erc20DefaultBridge": format!("{:#x}", input_bridge_addresses.l1_erc20_default_bridge),
                     "l2Erc20DefaultBridge": format!("{:#x}", input_bridge_addresses.l2_erc20_default_bridge),
-                    "l1WethBridge": format!("{:#x}", input_bridge_addresses.l1_weth_bridge.clone().unwrap()),
-                    "l2WethBridge": format!("{:#x}", input_bridge_addresses.l2_weth_bridge.clone().unwrap())
+                    "l1WethBridge": format!("{:#x}", input_bridge_addresses.l1_weth_bridge.unwrap()),
+                    "l2WethBridge": format!("{:#x}", input_bridge_addresses.l2_weth_bridge.unwrap())
                 },
                 "id": 0
             }),

diff --git a/test_endpoints.http b/test_endpoints.http
@@ -790,3 +790,14 @@ content-type: application/json
     "method": "config_setLogging",
     "params": ["era_test_node=info,hyper=debug"]
 }
+
+###
+POST http://localhost:8011
+content-type: application/json
+
+{
+    "jsonrpc": "2.0",
+    "id": "1",
+    "method": "web3_clientVersion",
+    "params": []
+}