Implementing Otterscan support

anvil/Cargo.toml

@@ -17,7 +17,7 @@ vergen = { version = "8", default-features = false, features = ["build", "git",
 [dependencies]
 # foundry internal
 foundry-evm = { path = "../evm" }
-anvil-core = { path = "core", features = ["fastrlp", "serde", "impersonated-tx"] }
+anvil-core = { path = "core", features = ["otterscan", "fastrlp", "serde", "impersonated-tx"] }
 anvil-rpc = { path = "rpc" }
 anvil-server = { path = "server" }
 foundry-utils = { path = "../utils" }
@@ -55,6 +55,7 @@ serde = { version = "1", features = ["derive"] }
 thiserror = "1"
 yansi = "0.5"
 tempfile = "3"
+itertools = "0.10"
 
 # cli
 clap = { version = "4", features = ["derive", "env", "wrap_help"], optional = true }
@@ -75,6 +76,7 @@ tokio = { version = "1", features = ["full"] }
 crc = "3.0.1"
 
 [features]
-default = ["cli"]
+default = ["cli", "otterscan"]
 cmd = ["foundry-common", "forge", "clap", "clap_complete", "ctrlc", "anvil-server/clap"]
 cli = ["tokio/full", "cmd", "fdlimit"]
+otterscan = []

anvil/core/Cargo.toml

@@ -30,3 +30,4 @@ default = []
 impersonated-tx = []
 fastrlp = ["dep:open-fastrlp"]
 serde = ["dep:serde"]
+otterscan = []

anvil/core/src/eth/mod.rs

@@ -600,6 +600,106 @@ pub enum EthRequest {
     /// Ref: [Here](https://geth.ethereum.org/docs/rpc/ns-txpool#txpool_content)
     #[cfg_attr(feature = "serde", serde(rename = "txpool_content", with = "empty_params"))]
     TxPoolContent(()),
+
+    /// Otterscan's `ots_getApiLevel` endpoint
+    /// Otterscan currently requires this endpoint, even though it's not part of the ots_*
+    /// https://github.com/otterscan/otterscan/blob/071d8c55202badf01804f6f8d53ef9311d4a9e47/src/useProvider.ts#L71
+    /// Related upstream issue: https://github.com/otterscan/otterscan/issues/1081
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "erigon_getHeaderByNumber"))]
+    ErigonGetHeaderByNumber(
+        #[cfg_attr(feature = "serde", serde(deserialize_with = "lenient_block_number_seq"))]
+        BlockNumber,
+    ),
+
+    /// Otterscan's `ots_getApiLevel` endpoint
+    /// Used as a simple API versioning scheme for the ots_* namespace
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getApiLevel", with = "empty_params"))]
+    OtsGetApiLevel(()),
+
+    /// Otterscan's `ots_getInternalOperations` endpoint
+    /// Traces internal ETH transfers, contracts creation (CREATE/CREATE2) and self-destructs for a
+    /// certain transaction.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getInternalOperations", with = "sequence"))]
+    OtsGetInternalOperations(H256),
+
+    /// Otterscan's `ots_hasCode` endpoint
+    /// Check if an ETH address contains code at a certain block number.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_hasCode"))]
+    OtsHasCode(
+        Address,
+        #[cfg_attr(feature = "serde", serde(deserialize_with = "lenient_block_number", default))]
+        BlockNumber,
+    ),
+
+    /// Otterscan's `ots_traceTransaction` endpoint
+    /// Trace a transaction and generate a trace call tree.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_traceTransaction", with = "sequence"))]
+    OtsTraceTransaction(H256),
+
+    /// Otterscan's `ots_getTransactionError` endpoint
+    /// Given a transaction hash, returns its raw revert reason.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getTransactionError", with = "sequence"))]
+    OtsGetTransactionError(H256),
+
+    /// Otterscan's `ots_getBlockDetails` endpoint
+    /// Given a block number, return its data. Similar to the standard eth_getBlockByNumber/Hash
+    /// method, but can be optimized by excluding unnecessary data such as transactions and
+    /// logBloom
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getBlockDetails"))]
+    OtsGetBlockDetails(
+        #[cfg_attr(feature = "serde", serde(deserialize_with = "lenient_block_number_seq"))]
+        BlockNumber,
+    ),
+
+    /// Otterscan's `ots_getBlockDetails` endpoint
+    /// Same as `ots_getBlockDetails`, but receiving a block hash instead of number
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getBlockDetailsByHash", with = "sequence"))]
+    OtsGetBlockDetailsByHash(H256),
+
+    /// Otterscan's `ots_getBlockTransactions` endpoint
+    /// Gets paginated transaction data for a certain block. Return data is similar to
+    /// eth_getBlockBy* + eth_getTransactionReceipt.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getBlockTransactions"))]
+    OtsGetBlockTransactions(u64, usize, usize),
+
+    /// Otterscan's `ots_searchTransactionsBefore` endpoint
+    /// Address history navigation. searches backwards from certain point in time.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_searchTransactionsBefore"))]
+    OtsSearchTransactionsBefore(Address, u64, usize),
+
+    /// Otterscan's `ots_searchTransactionsAfter` endpoint
+    /// Address history navigation. searches forward from certain point in time.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_searchTransactionsAfter"))]
+    OtsSearchTransactionsAfter(Address, u64, usize),
+
+    /// Otterscan's `ots_getTransactionBySenderAndNonce` endpoint
+    /// Given a sender address and a nonce, returns the tx hash or null if not found. It returns
+    /// only the tx hash on success, you can use the standard eth_getTransactionByHash after that
+    /// to get the full transaction data.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getTransactionBySenderAndNonce",))]
+    OtsGetTransactionBySenderAndNonce(
+        Address,
+        #[cfg_attr(feature = "serde", serde(deserialize_with = "deserialize_number"))] U256,
+    ),
+
+    /// Otterscan's `ots_getTransactionBySenderAndNonce` endpoint
+    /// Given an ETH contract address, returns the tx hash and the direct address who created the
+    /// contract.
+    #[cfg(feature = "otterscan")]
+    #[cfg_attr(feature = "serde", serde(rename = "ots_getContractCreator", with = "sequence"))]
+    OtsGetContractCreator(Address),
 }
 
 /// Represents ethereum JSON-RPC API