feat: automatically generate Vm.sol from cheatcodes.json

[DaniPopes]

More automation good. See foundry-rs/foundry#5998.

Draft until next nightly for better formatting.

Changes

If any of these changes are not wanted I can patch them out individually.

Other

• Only doc and group header (// == GROUP ==) comments are preserved

ABI

• Added:
  • cool(address) (feat: cool cheatcode foundry#5830, fix(vm.cool) Persist storage changes foundry#5852) See feat: automatically generate Vm.sol from cheatcodes.json #487 (comment)
  • deriveKey with string language (feat(evm): support multiple languages for deriveKey cheatcode foundry#4688)
    • deriveKey(string,uint32,string)(uint256)
    • deriveKey(string,string,uint32,string)(uint256)
  • feat(cheatcodes): getBlockNumber and getBlockTimestamp foundry#6630
    • getBlockNumber()(uint256)
    • getBlockTimestamp()(uint256)

Using Solc v0.8.23:

(not up to date, just showing that there are no unwanted changes)

Vm

solc src/Vm.sol --combined-json abi | jq '.contracts["src/Vm.sol:Vm"].abi' > Vm.abi.json

diff --git a/Vm.abi.json b/Vm.abi.json
index 63c2c88..ba8ca65 100644
--- a/Vm.abi.json
+++ b/Vm.abi.json
@@ -268,6 +268,19 @@
     "stateMutability": "pure",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "target",
+        "type": "address"
+      }
+    ],
+    "name": "cool",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -616,6 +629,69 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "mnemonic",
+        "type": "string"
+      },
+      {
+        "internalType": "string",
+        "name": "derivationPath",
+        "type": "string"
+      },
+      {
+        "internalType": "uint32",
+        "name": "index",
+        "type": "uint32"
+      },
+      {
+        "internalType": "string",
+        "name": "language",
+        "type": "string"
+      }
+    ],
+    "name": "deriveKey",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "privateKey",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "mnemonic",
+        "type": "string"
+      },
+      {
+        "internalType": "uint32",
+        "name": "index",
+        "type": "uint32"
+      },
+      {
+        "internalType": "string",
+        "name": "language",
+        "type": "string"
+      }
+    ],
+    "name": "deriveKey",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "privateKey",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {

VmSafe

solc src/Vm.sol --combined-json abi | jq '.contracts["src/Vm.sol:VmSafe"].abi' > VmSafe.abi.json

diff --git a/VmSafe.abi.json b/VmSafe.abi.json
index 4b7f0f5..3764458 100644
--- a/VmSafe.abi.json
+++ b/VmSafe.abi.json
@@ -379,6 +379,69 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "mnemonic",
+        "type": "string"
+      },
+      {
+        "internalType": "string",
+        "name": "derivationPath",
+        "type": "string"
+      },
+      {
+        "internalType": "uint32",
+        "name": "index",
+        "type": "uint32"
+      },
+      {
+        "internalType": "string",
+        "name": "language",
+        "type": "string"
+      }
+    ],
+    "name": "deriveKey",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "privateKey",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "mnemonic",
+        "type": "string"
+      },
+      {
+        "internalType": "uint32",
+        "name": "index",
+        "type": "uint32"
+      },
+      {
+        "internalType": "string",
+        "name": "language",
+        "type": "string"
+      }
+    ],
+    "name": "deriveKey",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "privateKey",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {

[mds1]

Nice, this is great! I haven't reviewed the code yet but a few comments based on the description:

1. The interface ID changed since new cheats were added, but it's possible it also changed due to a mismatch between what forge-std had as Safe vs. what foundry had as Safe. Any thoughts on how we can verify if such a mismatch existed?
2. I intentionally did not add vm.cool because after it was merged I noticed upstream implementation was incorrect, and we haven't yet merged a fix. We should either fix it or remove that cheat, instead of adding it here.
3. The ordering of the AccountAccessKind is a breaking change for users (e.g. assertEq(uint(accessKind), x) now fails). So it may be preferable to change the order upstream instead to preserve the interface
4. I've founding the grouping/comments in Vm.sol nicely self-documenting to avoid having to reference the book during development to find all cheats of a given group, etc. If we preserve this by adding comments for group names / other metadata that would be ideal IMO.

[DaniPopes]

1. Updated description with both ABI diffs
2. bdd9915 and fix(cheatcodes): update cool status, fix AccountAccessKind ordering foundry#6641
3. fix(cheatcodes): update cool status, fix AccountAccessKind ordering foundry#6641
4. ea0b945

[mds1]

1. I think those ABI diffs are outdated since the Vm interface ID remained unchanged, so I'm guessing all the ABI methods in the PR description are actually VmSafe changes (and vm.cool was removed)

Regarding the rest, thanks! Will review this today