feat: add vm.getChain(chainAlias) (#10226)

* add Chain struct

* generate interface

* define getChain cheatcode

* add getChain(alias) implementation

* add GetChain test

* run fmt

* fix: add alloy_chain for check chain validity

---------

Co-authored-by: grandizzy <[email protected]>

Author: redtrama

Cargo.lock

@@ -40,6 +40,7 @@ parking_lot.workspace = true
 alloy-consensus = { workspace = true, features = ["k256"] }
 alloy-network.workspace = true
 alloy-rlp.workspace = true
+alloy-chains.workspace = true
 
 base64.workspace = true
 dialoguer = "0.11"

crates/cheatcodes/Cargo.toml

@@ -83,6 +83,7 @@ impl Cheatcodes<'static> {
                 Vm::Wallet::STRUCT.clone(),
                 Vm::FfiResult::STRUCT.clone(),
                 Vm::ChainInfo::STRUCT.clone(),
+                Vm::Chain::STRUCT.clone(),
                 Vm::AccountAccess::STRUCT.clone(),
                 Vm::StorageAccess::STRUCT.clone(),
                 Vm::Gas::STRUCT.clone(),

crates/cheatcodes/assets/cheatcodes.json

@@ -207,6 +207,18 @@ interface Vm {
         uint256 chainId;
     }
 
+    /// Information about a blockchain.
+    struct Chain {
+        /// The chain name.
+        string name;
+        /// The chain's Chain ID.
+        uint256 chainId;
+        /// The chain's alias. (i.e. what gets specified in `foundry.toml`).
+        string chainAlias;
+        /// A default RPC endpoint for this chain.
+        string rpcUrl;
+    }
+
     /// The storage accessed during an `AccountAccess`.
     struct StorageAccess {
         /// The account whose storage was accessed.
@@ -967,6 +979,14 @@ interface Vm {
     #[cheatcode(group = Testing, safety = Safe)]
     function rpcUrlStructs() external view returns (Rpc[] memory urls);
 
+    /// Returns a Chain struct for specific alias
+    #[cheatcode(group = Testing, safety = Safe)]
+    function getChain(string calldata chainAlias) external view returns (Chain memory chain);
+
+    /// Returns a Chain struct for specific chainId
+    #[cheatcode(group = Testing, safety = Safe)]
+    function getChain(uint256 chainId) external view returns (Chain memory chain);
+
     /// Suspends execution of the main thread for `duration` milliseconds.
     #[cheatcode(group = Testing, safety = Safe)]
     function sleep(uint256 duration) external;