Create a ChainSpec Wrapper to manage Anvil genesis config (paritytech#293)

* draft chainspec wrapper

* inject Anvil Node Config into Substrate CLI

* Set chain_id from config.json

* Add extra fields

* inject storage items into ChainSpec

* implement ChainSpec trait for wrapper

* fix clippy

* CR reorg

* set System::Number as u32

* nit

* nit

* Add genesis timestamp to time manager of mining node

* add custom genesis block number support in RPC

* fmt

* fmt

* clippy + comments

* CR nits + reorg

* Add genesis integration tests (chain ID missing)

* comment nit

Co-authored-by: Alin Dima <[email protected]>

* add chain id test

* fix time manager creation

* changed genesis milliseconds mismatch + clippy for unused import

* undo clippy change

* merge fix - missing import

* fix rpc client creation

* clippy nit

* fix

* CR fixes

* fix types

* nit

* Use genesis block number to compute genesis hash

* improve error handling

* fix metadata retrieval

* use the impersonation executor

* use latest available metadata + error handling

* add Chain Id RPC

* nit

* fmt + clippy

* add `InternalError` variant

* make test less flaky

* fix test with chain id RPC

* Use chain id RPC in genesis tests

* fix deny license

---------

Co-authored-by: Alin Dima <[email protected]>
Co-authored-by: alindima <[email protected]>

Author: re-gius

Cargo.lock

@@ -19,6 +19,7 @@ path = "bin/main.rs"
 
 [dependencies]
 # foundry internal
+codec = { version = "3.7.5", default-features = true, package = "parity-scale-codec" }
 substrate-runtime = { path = "substrate-runtime" }
 secp256k1 = { version = "0.28.0", default-features = false }
 libsecp256k1 = { version = "0.7.0", default-features = false }
@@ -37,13 +38,16 @@ polkadot-sdk = { git = "https://github.com/paritytech/polkadot-sdk.git", branch
 	"sc-executor-common",
 	"sc-executor-wasmtime",
 	"sc-keystore",
+	"sc-network",
 	"sc-network-types",
     "sc-rpc",
 	"sc-rpc-api",
 	"sc-rpc-server",
 	"sc-rpc-spec-v2",
+	"sc-runtime-utilities",
 	"sc-service",
 	"sc-state-db",
+	"sc-telemetry",
 	"sc-tracing",
 	"sc-transaction-pool",
 	"sc-transaction-pool-api",
@@ -131,10 +135,10 @@ clap = { version = "4", features = [
 clap_complete = { version = "4" }
 chrono.workspace = true
 clap_complete_fig = "4"
-parity-scale-codec = "3.7.5"
 subxt = "0.43.0"
 subxt-signer = "0.43.0"
 tokio-stream = "0.1.17"
+jsonrpsee = "0.24.9"
 sqlx = "0.8.6"
 
 [dev-dependencies]

crates/anvil-polkadot/Cargo.toml

@@ -13,6 +13,8 @@ pub enum Error {
     InvalidParams(String),
     #[error("Revive call failed: {0}")]
     ReviveRpc(#[from] EthRpcError),
+    #[error("Internal error: {0}")]
+    InternalError(String),
 }
 impl From<subxt::Error> for Error {
     fn from(err: subxt::Error) -> Self {
@@ -72,6 +74,9 @@ impl<T: Serialize> ToRpcResponseResult for Result<T> {
                 Error::ReviveRpc(client_error) => {
                     RpcError::internal_error_with(format!("{client_error}")).into()
                 }
+                Error::InternalError(error_message) => {
+                    RpcError::internal_error_with(error_message).into()
+                }
             },
         }
     }

crates/anvil-polkadot/src/api_server/error.rs

@@ -9,8 +9,10 @@ use crate::{
     logging::LoggingManager,
     macros::node_info,
     substrate_node::{
-        impersonation::ImpersonationManager, in_mem_rpc::InMemoryRpcClient,
-        mining_engine::MiningEngine, service::Service,
+        impersonation::ImpersonationManager,
+        in_mem_rpc::InMemoryRpcClient,
+        mining_engine::MiningEngine,
+        service::{Backend, Service},
     },
 };
 use alloy_eips::{BlockId, BlockNumberOrTag};
@@ -19,6 +21,7 @@ use alloy_rpc_types::{TransactionRequest, anvil::MineOptions};
 use alloy_serde::WithOtherFields;
 use anvil_core::eth::{EthRequest, Params as MineParams};
 use anvil_rpc::response::ResponseResult;
+use codec::Decode;
 use futures::{StreamExt, channel::mpsc};
 use polkadot_sdk::{
     pallet_revive::evm::{Account, Block, Bytes, ReceiptInfo, TransactionSigned},
@@ -27,12 +30,16 @@ use polkadot_sdk::{
         client::{Client as EthRpcClient, ClientError, SubscriptionType},
         subxt_client::{self, SrcChainConfig},
     },
+    parachains_common::Hash,
+    sc_client_api::{Backend as _, HeaderBackend, StateBackend, TrieCacheContext},
+    sp_api::{Metadata, ProvideRuntimeApi},
     sp_core::{self, keccak_256},
 };
 use sqlx::sqlite::SqlitePoolOptions;
 use std::{sync::Arc, time::Duration};
 use subxt::{
-    OnlineClient, backend::rpc::RpcClient, config::substrate::H256,
+    Metadata as SubxtMetadata, OnlineClient, backend::rpc::RpcClient,
+    client::RuntimeVersion as SubxtRuntimeVersion, config::substrate::H256,
     ext::subxt_rpcs::LegacyRpcMethods, utils::H160,
 };
 
@@ -43,6 +50,7 @@ pub struct Wallet {
 pub struct ApiServer {
     req_receiver: mpsc::Receiver<ApiRequest>,
     logging_manager: LoggingManager,
+    backend: Arc<Backend>,
     mining_engine: Arc<MiningEngine>,
     eth_rpc_client: EthRpcClient,
     wallet: Wallet,
@@ -61,6 +69,7 @@ impl ApiServer {
         Ok(Self {
             req_receiver,
             logging_manager,
+            backend: substrate_service.backend.clone(),
             mining_engine: substrate_service.mining_engine.clone(),
             eth_rpc_client,
             impersonation_manager,
@@ -257,12 +266,14 @@ impl ApiServer {
     // Eth RPCs
     fn eth_chain_id(&self) -> Result<U64> {
         node_info!("eth_chainId");
-        Ok(U256::from(self.eth_rpc_client.chain_id()).to::<U64>())
+        let latest_block_hash = self.backend.blockchain().info().best_hash;
+        Ok(U256::from(self.chain_id(latest_block_hash)).to::<U64>())
     }
 
     fn network_id(&self) -> Result<u64> {
         node_info!("eth_networkId");
-        Ok(self.eth_rpc_client.chain_id())
+        let latest_block_hash = self.backend.blockchain().info().best_hash;
+        Ok(self.chain_id(latest_block_hash))
     }
 
     fn net_listening(&self) -> Result<bool> {
@@ -446,11 +457,83 @@ impl ApiServer {
         self.impersonation_manager.stop_impersonating(addr);
         Ok(())
     }
+
+    fn chain_id(&self, at: Hash) -> u64 {
+        let chain_id_key: [u8; 16] = [
+            149u8, 39u8, 54u8, 105u8, 39u8, 71u8, 142u8, 113u8, 13u8, 63u8, 127u8, 183u8, 124u8,
+            109u8, 31u8, 137u8,
+        ];
+        if let Ok(state_at) = self.backend.state_at(at, TrieCacheContext::Trusted)
+            && let Ok(Some(encoded_chain_id)) = state_at.storage(chain_id_key.as_slice())
+            && let Ok(chain_id) = u64::decode(&mut &encoded_chain_id[..])
+        {
+            return chain_id;
+        }
+
+        // if the chain id is not found, use the default chain id
+        self.eth_rpc_client.chain_id()
+    }
 }
 
 async fn create_revive_rpc_client(substrate_service: &Service) -> Result<EthRpcClient> {
     let rpc_client = RpcClient::new(InMemoryRpcClient(substrate_service.rpc_handlers.clone()));
-    let api = OnlineClient::<SrcChainConfig>::from_rpc_client(rpc_client.clone()).await?;
+
+    let genesis_block_number = substrate_service.genesis_block_number.try_into().map_err(|_| {
+        Error::InternalError(format!(
+            "Genesis block number {} is too large for u32 (max: {})",
+            substrate_service.genesis_block_number,
+            u32::MAX
+        ))
+    })?;
+
+    let Some(genesis_hash) = substrate_service.client.hash(genesis_block_number).ok().flatten()
+    else {
+        return Err(Error::InternalError(format!(
+            "Genesis hash not found for genesis block number {}",
+            substrate_service.genesis_block_number
+        )));
+    };
+
+    let Ok(runtime_version) = substrate_service.client.runtime_version_at(genesis_hash) else {
+        return Err(Error::InternalError(
+            "Runtime version not found for given genesis hash".to_string(),
+        ));
+    };
+
+    let subxt_runtime_version = SubxtRuntimeVersion {
+        spec_version: runtime_version.spec_version,
+        transaction_version: runtime_version.transaction_version,
+    };
+
+    let Ok(supported_metadata_versions) =
+        substrate_service.client.runtime_api().metadata_versions(genesis_hash)
+    else {
+        return Err(Error::InternalError("Unable to fetch metadata versions".to_string()));
+    };
+    let Some(latest_metadata_version) = supported_metadata_versions.into_iter().max() else {
+        return Err(Error::InternalError("No stable metadata versions supported".to_string()));
+    };
+    let opaque_metadata = substrate_service
+        .client
+        .runtime_api()
+        .metadata_at_version(genesis_hash, latest_metadata_version)
+        .map_err(|_| {
+            Error::InternalError("Failed to get runtime API for genesis hash".to_string())
+        })?
+        .ok_or_else(|| {
+            Error::InternalError(format!(
+                "Metadata not found for version {latest_metadata_version} at genesis hash"
+            ))
+        })?;
+    let subxt_metadata = SubxtMetadata::decode(&mut (*opaque_metadata).as_slice())
+        .map_err(|_| Error::InternalError("Unable to decode metadata".to_string()))?;
+
+    let api = OnlineClient::<SrcChainConfig>::from_rpc_client_with(
+        genesis_hash,
+        subxt_runtime_version,
+        subxt_metadata,
+        rpc_client.clone(),
+    )?;
     let rpc = LegacyRpcMethods::<SrcChainConfig>::new(rpc_client.clone());
 
     let block_provider = SubxtBlockInfoProvider::new(api.clone(), rpc.clone()).await?;

crates/anvil-polkadot/src/api_server/server.rs

@@ -6,7 +6,7 @@ use crate::{
     api_server::ApiHandle,
     config::AnvilNodeConfig,
     logging::{LoggingManager, NodeLogLayer},
-    substrate_node::service::Service,
+    substrate_node::{genesis::GenesisConfig, service::Service},
 };
 use clap::{CommandFactory, Parser};
 use eyre::Result;
@@ -83,10 +83,12 @@ pub fn run_command(args: Anvil) -> Result<()> {
         }
         return Ok(());
     }
-    let substrate_client = opts::SubstrateCli {};
 
     let (anvil_config, substrate_config) = args.node.into_node_config()?;
 
+    let substrate_client =
+        opts::SubstrateCli { genesis_config: GenesisConfig::from(&anvil_config) };
+
     let tokio_runtime = build_runtime()?;
 
     let signals = tokio_runtime.block_on(async { sc_cli::Signals::capture() })?;

crates/anvil-polkadot/src/lib.rs

@@ -1,4 +1,7 @@
-use crate::{cmd::NodeArgs, substrate_node::chain_spec};
+use crate::{
+    cmd::NodeArgs,
+    substrate_node::{chain_spec, genesis::GenesisConfig},
+};
 use clap::{Parser, Subcommand};
 use foundry_cli::opts::GlobalArgs;
 use foundry_common::version::{LONG_VERSION, SHORT_VERSION};
@@ -31,7 +34,10 @@ pub enum AnvilSubcommand {
     GenerateFigSpec,
 }
 
-pub struct SubstrateCli;
+pub struct SubstrateCli {
+    // Used to inject the anvil config into the chain spec
+    pub genesis_config: GenesisConfig,
+}
 
 // Implementation of the SubstrateCli, which enables us to launch an in-process substrate node.
 impl sc_cli::SubstrateCli for SubstrateCli {
@@ -63,12 +69,7 @@ impl sc_cli::SubstrateCli for SubstrateCli {
         "anvil-polkadot".into()
     }
 
-    fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {
-        Ok(match id {
-            "dev" | "" => Box::new(chain_spec::development_chain_spec()?),
-            path => {
-                Box::new(chain_spec::ChainSpec::from_json_file(std::path::PathBuf::from(path))?)
-            }
-        })
+    fn load_spec(&self, _: &str) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {
+        Ok(Box::new(chain_spec::development_chain_spec(self.genesis_config.clone())?))
     }
 }