feat: add rpc-types-anvil (alloy-rs#526)

* feat: add rpc-types-anvil

* Update crates/rpc-types-anvil/README.md

Co-authored-by: Oliver Nordbjerg <[email protected]>

* Update crates/rpc-types-anvil/src/lib.rs

Co-authored-by: Oliver Nordbjerg <[email protected]>

* add docs

---------

Co-authored-by: Oliver Nordbjerg <[email protected]>

Cargo.toml

@@ -29,6 +29,7 @@ alloy-provider = { version = "0.1.0", default-features = false, path = "crates/p
 alloy-pubsub = { version = "0.1.0", default-features = false, path = "crates/pubsub" }
 alloy-rpc-client = { version = "0.1.0", default-features = false, path = "crates/rpc-client" }
 alloy-rpc-types-engine = { version = "0.1.0", default-features = false, path = "crates/rpc-types-engine" }
+alloy-rpc-types-anvil = { version = "0.1.0", default-features = false, path = "crates/rpc-types-anvil" }
 alloy-rpc-types-trace = { version = "0.1.0", default-features = false, path = "crates/rpc-types-trace" }
 alloy-rpc-types = { version = "0.1.0", default-features = false, path = "crates/rpc-types" }
 alloy-serde = { version = "0.1.0", default-features = false, path = "crates/serde" }

crates/rpc-types-anvil/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "alloy-rpc-types-anvil"
+description = "Anvil RPC types"
+
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+exclude.workspace = true
+
+[dependencies]
+alloy-primitives = { workspace = true, features = ["serde"] }
+alloy-serde.workspace = true
+
+serde.workspace = true
+
+[dev-dependencies]
+serde_json.workspace = true

crates/rpc-types-anvil/README.md

@@ -0,0 +1,3 @@
+# alloy-rpc-types-anvil
+
+RPC types for Anvil, Hardhat, and Ganache dev nodes. 

crates/rpc-types-anvil/src/lib.rs

@@ -0,0 +1,195 @@
+#![doc = include_str!("../README.md")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
+    html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"
+)]
+#![warn(
+    missing_copy_implementations,
+    missing_debug_implementations,
+    missing_docs,
+    unreachable_pub,
+    clippy::missing_const_for_fn,
+    rustdoc::all
+)]
+#![cfg_attr(not(test), warn(unused_crate_dependencies))]
+#![deny(unused_must_use, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
+use alloy_primitives::{TxHash, B256, U256};
+use serde::{Deserialize, Deserializer, Serialize};
+use std::collections::BTreeMap;
+
+/// Represents the params to set forking which can take various forms:
+///  - untagged
+///  - tagged forking
+#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Forking {
+    /// The URL of the JSON-RPC endpoint to fork from
+    pub json_rpc_url: Option<String>,
+    /// The block number to fork from
+    pub block_number: Option<u64>,
+}
+
+impl<'de> serde::Deserialize<'de> for Forking {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        #[derive(serde::Deserialize)]
+        #[serde(rename_all = "camelCase")]
+        struct ForkOpts {
+            json_rpc_url: Option<String>,
+            #[serde(default, with = "alloy_serde::u64_hex_or_decimal_opt")]
+            block_number: Option<u64>,
+        }
+
+        #[derive(serde::Deserialize)]
+        struct Tagged {
+            forking: ForkOpts,
+        }
+        #[derive(serde::Deserialize)]
+        #[serde(untagged)]
+        enum ForkingVariants {
+            Tagged(Tagged),
+            Fork(ForkOpts),
+        }
+        let f = match ForkingVariants::deserialize(deserializer)? {
+            ForkingVariants::Fork(ForkOpts { json_rpc_url, block_number }) => {
+                Forking { json_rpc_url, block_number }
+            }
+            ForkingVariants::Tagged(f) => Forking {
+                json_rpc_url: f.forking.json_rpc_url,
+                block_number: f.forking.block_number,
+            },
+        };
+        Ok(f)
+    }
+}
+
+/// Anvil equivalent of `node_info`.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NodeInfo {
+    /// The current block number
+    #[serde(with = "alloy_serde::u64_hex")]
+    pub current_block_number: u64,
+    /// The current block timestamp
+    pub current_block_timestamp: u64,
+    /// The current block hash
+    pub current_block_hash: B256,
+    /// The enabled hardfork
+    pub hard_fork: String,
+    /// How transactions are ordered for mining
+    pub transaction_order: String,
+    /// Info about the node's block environment
+    pub environment: NodeEnvironment,
+    /// Info about the node's fork configuration
+    pub fork_config: NodeForkConfig,
+}
+
+/// The current block environment of the node.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NodeEnvironment {
+    /// Base fee of the current block
+    pub base_fee: U256,
+    /// Chain id of the node.
+    pub chain_id: u64,
+    /// Configured block gas limit
+    pub gas_limit: U256,
+    /// Configured gas price
+    pub gas_price: U256,
+}
+
+/// The node's fork configuration.
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NodeForkConfig {
+    /// URL of the forked network
+    pub fork_url: Option<String>,
+    /// Block number of the forked network
+    pub fork_block_number: Option<u64>,
+    /// Retry backoff for requests
+    pub fork_retry_backoff: Option<u128>,
+}
+
+/// Anvil equivalent of `hardhat_metadata`.
+/// Metadata about the current Anvil instance.
+/// See <https://hardhat.org/hardhat-network/docs/reference#hardhat_metadata>
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Metadata {
+    /// client version
+    pub client_version: String,
+    /// Chain id of the node.
+    pub chain_id: u64,
+    /// Unique instance id
+    pub instance_id: B256,
+    /// Latest block number
+    pub latest_block_number: u64,
+    /// Latest block hash
+    pub latest_block_hash: B256,
+    /// Forked network info
+    pub forked_network: Option<ForkedNetwork>,
+    /// Snapshots of the chain
+    pub snapshots: BTreeMap<U256, (u64, B256)>,
+}
+
+/// Information about the forked network.
+/// See <https://hardhat.org/hardhat-network/docs/reference#hardhat_metadata>
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ForkedNetwork {
+    /// Chain id of the node.
+    pub chain_id: u64,
+    /// Block number of the forked chain
+    pub fork_block_number: u64,
+    /// Block hash of the forked chain
+    pub fork_block_hash: TxHash,
+}
+
+/// Additional `evm_mine` options
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub enum MineOptions {
+    /// The options for mining
+    Options {
+        /// The timestamp the block should be mined with
+        #[serde(with = "alloy_serde::u64_hex_or_decimal_opt")]
+        timestamp: Option<u64>,
+        /// If `blocks` is given, it will mine exactly blocks number of blocks, regardless of any
+        /// other blocks mined or reverted during it's operation
+        blocks: Option<u64>,
+    },
+    /// The timestamp the block should be mined with
+    #[serde(with = "alloy_serde::u64_hex_or_decimal_opt")]
+    Timestamp(Option<u64>),
+}
+
+impl Default for MineOptions {
+    fn default() -> Self {
+        MineOptions::Options { timestamp: None, blocks: None }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn serde_forking() {
+        let s = r#"{"forking": {"jsonRpcUrl": "https://ethereumpublicnode.com",
+        "blockNumber": "18441649"
+      }
+    }"#;
+        let f: Forking = serde_json::from_str(s).unwrap();
+        assert_eq!(
+            f,
+            Forking {
+                json_rpc_url: Some("https://ethereumpublicnode.com".into()),
+                block_number: Some(18441649)
+            }
+        );
+    }
+}