feat: gas reports and snapshots

l1-contracts/README.md

@@ -12,7 +12,8 @@ Alternatively you can use docker instead, it will handle installations and run t
 
 The `src` folder contain contracts that is to be used by the local developer testnet. It is grouped into 3 categories:
 
-- `core` contains the required contracts, the bare minimum
+- `core` contains the required contracts, the bare minimum.
+- `governance` contains the contracts for the governance system.
 - `mock` contains stubs, for now an always true verifier.
 - `periphery` stuff that is nice to have, convenience contracts and functions belong in here.
 
@@ -31,6 +32,16 @@ We use `forge fmt` to format. But follow a few general guidelines beyond the sta
   - Do `function transfer(address _to, uint256 _amount);`
 - use `_` prefix for `internal` and `private` functions.
 
+## Gas snapshots and CI
+
+CI will run `forge snapshot --check`. This means that as you develop, you should run `./bootstrap.sh snapshot --diff` to make sure you understand the gas cost of your changes.
+
+Note: the only reason `forge snapshot` is wrapped in the bootstrap script is to standardize the output, or any future filtering.
+
+When your PR is ready for review, run `./bootstrap.sh snapshot` to update the snapshot, then `./bootstrap.sh test` to make sure you're good.
+
+You can also run `./bootstrap.sh gas_report` to get a gas report for the current state.
+
 ## Contracts:
 
 The contracts are in a very early stage, and don't worry about gas costs right now. Instead they prioritize development velocity.

l1-contracts/bootstrap.sh

@@ -53,7 +53,7 @@ function build {
 function test_cmds {
   echo "$hash cd l1-contracts && solhint --config ./.solhint.json \"src/**/*.sol\""
   echo "$hash cd l1-contracts && forge fmt --check"
-  echo "$hash cd l1-contracts && forge test --no-match-contract UniswapPortalTest"
+  echo "$hash cd l1-contracts && ./bootstrap.sh snapshot --check --tolerance 1"
 }
 
 function test {
@@ -100,6 +100,16 @@ function inspect {
     done
 }
 
+function gas_report {
+  echo_header "l1-contracts gas report"
+  FORGE_GAS_REPORT=true forge test --no-match-contract "(FeeRollupTest)|(MinimalFeeModelTest)" --no-match-test "(testInvalidBlobHash)|(testInvalidBlobProof)"
+}
+
+function snapshot {
+  echo_header "l1-contracts gas snapshot"
+  forge snapshot --desc "$@"
+}
+
 # First argument is a branch name (e.g. master, or the latest version e.g. 1.2.3) to push to the head of.
 # Second argument is the tag name (e.g. v1.2.3, or commit-<hash>).
 # Third argument is the semver for package.json (e.g. 1.2.3 or 1.2.3-commit.<hash>)
@@ -195,6 +205,13 @@ case "$cmd" in
   "inspect")
     inspect
     ;;
+  "gas_report")
+    gas_report
+    ;;
+  "snapshot")
+    shift
+    snapshot "$@"
+    ;;
   test_cmds|release)
     $cmd
     ;;

l1-contracts/test/MultiProof.t.sol

@@ -20,7 +20,6 @@ import {
 import {Rollup} from "@aztec/core/Rollup.sol";
 import {Strings} from "@oz/utils/Strings.sol";
 import {Errors} from "@aztec/core/libraries/Errors.sol";
-
 import {RollupBase, IInstance} from "./base/RollupBase.sol";
 
 // solhint-disable comprehensive-interface
@@ -90,6 +89,11 @@ contract MultiProofTest is RollupBase {
         )
       )
     );
+    // skip blob check if forge gas report is true
+    // https://github.com/foundry-rs/foundry/issues/10074
+    if (vm.envOr("FORGE_GAS_REPORT", false)) {
+      skipBlobCheck(address(rollup));
+    }
 
     registry.upgrade(address(rollup));
 

l1-contracts/test/Rollup.t.sol

@@ -106,6 +106,11 @@ contract RollupTest is RollupBase {
         )
       )
     );
+    // skip blob check if forge gas report is true
+    // https://github.com/foundry-rs/foundry/issues/10074
+    if (vm.envOr("FORGE_GAS_REPORT", false)) {
+      skipBlobCheck(address(rollup));
+    }
     inbox = Inbox(address(rollup.getInbox()));
     outbox = Outbox(address(rollup.getOutbox()));
     registry.upgrade(address(rollup));

l1-contracts/test/base/RollupBase.sol

@@ -204,7 +204,11 @@ contract RollupBase is DecoderBase {
         blobHash := mload(add(blobInputs, 0x21))
       }
       blobHashes[0] = blobHash;
-      vm.blobhashes(blobHashes);
+      // don't add blob hashes if forge gas report is true
+      // https://github.com/foundry-rs/foundry/issues/10074
+      if (!vm.envOr("FORGE_GAS_REPORT", false)) {
+        vm.blobhashes(blobHashes);
+      }
     }
 
     ProposeArgs memory args = ProposeArgs({