feat: split off binding generation from foundry-evm (#4935)

* feat: split off binding generation from foundry-evm

* chore: add linguist-language

* fix test

.gitattributes

@@ -0,0 +1,2 @@
+# auto-detection may fail for human-readable files, like the ones in abi/abi/*.sol
+**/*.sol linguist-language=Solidity

Cargo.toml

@@ -4,6 +4,7 @@ members = [
     "anvil/core",
     "anvil/rpc",
     "anvil/server",
+    "abi",
     "binder",
     "cast",
     "chisel",
@@ -63,6 +64,7 @@ ethers = { version = "2.0.4", default-features = false }
 ethers-addressbook = { version = "2.0.4", default-features = false }
 ethers-core = { version = "2.0.4", default-features = false }
 ethers-contract = { version = "2.0.4", default-features = false }
+ethers-contract-abigen = { version = "2.0.4", default-features = false }
 ethers-providers = { version = "2.0.4", default-features = false }
 ethers-signers = { version = "2.0.4", default-features = false }
 ethers-middleware = { version = "2.0.4", default-features = false }
@@ -73,6 +75,7 @@ ethers-solc = { version = "2.0.4", default-features = false }
 # ethers = { path = "../ethers-rs/ethers" }
 # ethers-addressbook = { path = "../ethers-rs/ethers-addressbook" }
 # ethers-contract = { path = "../ethers-rs/ethers-contract" }
+# ethers-contract-abigen = { path = "../ethers-rs/ethers-contract/ethers-contract-abigen" }
 # ethers-core = { path = "../ethers-rs/ethers-core" }
 # ethers-etherscan = { path = "../ethers-rs/ethers-etherscan" }
 # ethers-middleware = { path = "../ethers-rs/ethers-middleware" }

abi/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "foundry-abi"
+version = "0.1.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+description = "Foundry's Solidity ABI bindings"
+repository = "https://github.com/foundry-rs/foundry"
+exclude = ["abi", "build.rs"]
+
+[build-dependencies]
+ethers-contract-abigen = { workspace = true }
+eyre = "0.6"
+syn = "2.0"
+
+[dependencies]
+foundry-macros = { path = "../macros" }
+
+ethers-core = { workspace = true }
+ethers-contract = { workspace = true }
+ethers-providers = { workspace = true }

abi/README.md

@@ -0,0 +1,10 @@
+# foundry-abi
+
+Contains automatically-generated Rust bindings from Solidity ABI.
+
+Additional bindings can be generated by doing the following:
+
+1. add an ABI file in the [`abi` directory](./abi/), using the [ethers-js ABI formats](https://docs.ethers.org/v5/api/utils/abi/formats);
+2. update the [build script](./build.rs)'s `MultiAbigen::new` call;
+3. build the crate once with `cargo build -p foundry-abi`, generating the bindings for the first time;
+4. export the newly-generated bindings at the root of the crate, in [`lib.rs`](./src/lib.rs).

abi/abi/Console.sol

@@ -0,0 +1,22 @@
+event log(string)
+event logs                   (bytes)
+event log_address            (address)
+event log_bytes32            (bytes32)
+event log_int                (int)
+event log_uint               (uint)
+event log_bytes              (bytes)
+event log_string             (string)
+event log_array              (uint256[] val)
+event log_array              (int256[] val)
+event log_array              (address[] val)
+event log_named_address      (string key, address val)
+event log_named_bytes32      (string key, bytes32 val)
+event log_named_decimal_int  (string key, int val, uint decimals)
+event log_named_decimal_uint (string key, uint val, uint decimals)
+event log_named_int          (string key, int val)
+event log_named_uint         (string key, uint val)
+event log_named_bytes        (string key, bytes val)
+event log_named_string       (string key, string val)
+event log_named_array        (string key, uint256[] val)
+event log_named_array        (string key, int256[] val)
+event log_named_array        (string key, address[] val)

abi/abi/HEVM.sol

@@ -0,0 +1,207 @@
+struct Log { bytes32[] topics; bytes data; }
+struct Rpc { string name; string url; }
+struct DirEntry { string errorMessage; string path; uint64 depth; bool isDir; bool isSymlink; }
+struct FsMetadata { bool isDir; bool isSymlink; uint256 length; bool readOnly; uint256 modified; uint256 accessed; uint256 created; }
+
+allowCheatcodes(address)
+
+ffi(string[])(bytes)
+
+breakpoint(string)
+breakpoint(string,bool)
+
+roll(uint256)
+warp(uint256)
+difficulty(uint256)
+prevrandao(bytes32)
+fee(uint256)
+coinbase(address)
+store(address,bytes32,bytes32)
+load(address,bytes32)(bytes32)
+
+setEnv(string,string)
+envBool(string)(bool)
+envUint(string)(uint256)
+envInt(string)(int256)
+envAddress(string)(address)
+envBytes32(string)(bytes32)
+envString(string)(string)
+envBytes(string)(bytes)
+envBool(string,string)(bool[])
+envUint(string,string)(uint256[])
+envInt(string,string)(int256[])
+envAddress(string,string)(address[])
+envBytes32(string,string)(bytes32[])
+envString(string,string)(string[])
+envBytes(string,string)(bytes[])
+envOr(string,bool)(bool)
+envOr(string,uint256)(uint256)
+envOr(string,int256)(int256)
+envOr(string,address)(address)
+envOr(string,bytes32)(bytes32)
+envOr(string,string)(string)
+envOr(string,bytes)(bytes)
+envOr(string,string,bool[])(bool[])
+envOr(string,string,uint256[])(uint256[])
+envOr(string,string,int256[])(int256[])
+envOr(string,string,address[])(address[])
+envOr(string,string,bytes32[])(bytes32[])
+envOr(string,string,string[])(string[])
+envOr(string,string,bytes[])(bytes[])
+
+addr(uint256)(address)
+sign(uint256,bytes32)(uint8,bytes32,bytes32)
+deriveKey(string,uint32)(uint256)
+deriveKey(string,string,uint32)(uint256)
+rememberKey(uint256)(address)
+
+prank(address)
+prank(address,address)
+startPrank(address)
+startPrank(address,address)
+stopPrank()
+
+deal(address,uint256)
+etch(address,bytes)
+expectRevert()
+expectRevert(bytes)
+expectRevert(bytes4)
+record()
+accesses(address)(bytes32[],bytes32[])
+
+recordLogs()
+getRecordedLogs()(Log[])
+
+expectEmit()
+expectEmit(address)
+expectEmit(bool,bool,bool,bool)
+expectEmit(bool,bool,bool,bool,address)
+
+mockCall(address,bytes,bytes)
+mockCall(address,uint256,bytes,bytes)
+mockCallRevert(address,bytes,bytes)
+mockCallRevert(address,uint256,bytes,bytes)
+clearMockedCalls()
+
+expectCall(address,bytes)
+expectCall(address,bytes,uint64)
+expectCall(address,uint256,bytes)
+expectCall(address,uint256,bytes,uint64)
+expectCall(address,uint256,uint64,bytes)
+expectCall(address,uint256,uint64,bytes,uint64)
+expectCallMinGas(address,uint256,uint64,bytes)
+expectCallMinGas(address,uint256,uint64,bytes,uint64)
+expectSafeMemory(uint64,uint64)
+expectSafeMemoryCall(uint64,uint64)
+
+getCode(string)
+getDeployedCode(string)
+label(address,string)
+getLabel(address)(string)
+assume(bool)
+setNonce(address,uint64)
+getNonce(address)
+chainId(uint256)
+txGasPrice(uint256)
+
+broadcast()
+broadcast(address)
+broadcast(uint256)
+startBroadcast()
+startBroadcast(address)
+startBroadcast(uint256)
+stopBroadcast()
+
+projectRoot()(string)
+readFile(string)(string)
+readFileBinary(string)(bytes)
+writeFile(string,string)
+writeFileBinary(string,bytes)
+openFile(string)
+readLine(string)(string)
+writeLine(string,string)
+closeFile(string)
+removeFile(string)
+createDir(string, bool)
+removeDir(string, bool)
+readDir(string)(DirEntry[])
+readDir(string, uint64)(DirEntry[])
+readDir(string, uint64, bool)(DirEntry[])
+readLink(string)(string)
+fsMetadata(string)(FsMetadata)
+
+toString(bytes)
+toString(address)
+toString(uint256)
+toString(int256)
+toString(bytes32)
+toString(bool)
+parseBytes(string)(bytes)
+parseAddress(string)(address)
+parseUint(string)(uint256)
+parseInt(string)(int256)
+parseBytes32(string)(bytes32)
+parseBool(string)(bool)
+
+snapshot()(uint256)
+revertTo(uint256)(bool)
+createFork(string,uint256)(uint256)
+createFork(string,bytes32)(uint256)
+createFork(string)(uint256)
+createSelectFork(string,uint256)(uint256)
+createSelectFork(string,bytes32)(uint256)
+createSelectFork(string)(uint256)
+selectFork(uint256)
+activeFork()(uint256)
+transact(bytes32)
+transact(uint256,bytes32)
+makePersistent(address)
+makePersistent(address,address)
+makePersistent(address,address,address)
+makePersistent(address[])
+revokePersistent(address)
+revokePersistent(address[])
+isPersistent(address)(bool)
+rollFork(uint256)
+rollFork(bytes32)
+rollFork(uint256,uint256)
+rollFork(uint256,bytes32)
+rpcUrl(string)(string)
+rpcUrls()(string[2][])
+rpcUrlStructs()(Rpc[])
+
+writeJson(string, string)
+writeJson(string, string, string)
+parseJson(string)(bytes)
+parseJson(string, string)(bytes)
+parseJsonUint(string, string)(uint256)
+parseJsonUintArray(string, string)(uint256[])
+parseJsonInt(string, string)(int256)
+parseJsonIntArray(string, string)(int256[])
+parseJsonString(string, string)(string)
+parseJsonStringArray(string, string)(string[])
+parseJsonAddress(string, string)(address)
+parseJsonAddressArray(string, string)(address[])
+parseJsonBool(string, string)(bool)
+parseJsonBoolArray(string, string)(bool[])
+parseJsonBytes(string, string)(bytes)
+parseJsonBytesArray(string, string)(bytes[])
+parseJsonBytes32(string, string)(bytes32)
+parseJsonBytes32Array(string, string)(bytes32[])
+serializeBool(string,string,bool)(string)
+serializeBool(string,string,bool[])(string)
+serializeUint(string,string,uint256)(string)
+serializeUint(string,string,uint256[])(string)
+serializeInt(string,string,int256)(string)
+serializeInt(string,string,int256[])(string)
+serializeAddress(string,string,address)(string)
+serializeAddress(string,string,address[])(string)
+serializeBytes32(string,string,bytes32)(string)
+serializeBytes32(string,string,bytes32[])(string)
+serializeString(string,string,string)(string)
+serializeString(string,string,string[])(string)
+serializeBytes(string,string,bytes)(string)
+serializeBytes(string,string,bytes[])(string)
+
+pauseGasMetering()
+resumeGasMetering()

abi/build.rs

@@ -0,0 +1,34 @@
+use ethers_contract_abigen::MultiAbigen;
+
+/// Includes a JSON ABI as a string literal.
+macro_rules! include_json_abi {
+    ($path:literal) => {{
+        println!(concat!("cargo:rerun-if-changed=", $path));
+        include_str!($path)
+    }};
+}
+
+/// Includes a human-readable ABI file as a string literal by wrapping it in brackets.
+macro_rules! include_hr_abi {
+    ($path:literal) => {{
+        println!(concat!("cargo:rerun-if-changed=", $path));
+        concat!("[\n", include_str!($path), "\n]")
+    }};
+}
+
+fn main() -> eyre::Result<()> {
+    let mut multi = MultiAbigen::new([
+        ("HardhatConsole", include_json_abi!("abi/HardhatConsole.json")),
+        ("Console", include_hr_abi!("abi/Console.sol")),
+        ("HEVM", include_hr_abi!("abi/HEVM.sol")),
+    ])?;
+
+    // Add the ConsoleFmt derive to the HardhatConsole contract
+    multi[0].derives_mut().push(syn::parse_str("foundry_macros::ConsoleFmt")?);
+
+    // Generate and write to the bindings module
+    let bindings = multi.build()?;
+    bindings.write_to_module("src/bindings/", false)?;
+
+    Ok(())
+}