feat: gas benchmark setup

.forge-snapshots/LightAccount_Runtime_AccountCreation.snap

@@ -0,0 +1 @@
+143836

.forge-snapshots/SimpleAccount_Runtime_AccountCreation.snap

@@ -0,0 +1 @@
+174143

.github/workflows/format.yml

@@ -0,0 +1,25 @@
+name: Format
+
+on: [pull_request, workflow_dispatch]
+
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
+# Runs linter, tests, and inspection checker in parallel
+jobs:
+  lint:
+    name: Check Format and Run Linters
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: ./.github/workflows/setup-ci
+
+      - name: "Check formatting"
+        run: pnpm fmt:check
+
+      - name: "Lint the contracts"
+        run: "pnpm lint"

.github/workflows/gas.yml

@@ -0,0 +1,22 @@
+name: Gas
+
+on: [pull_request, workflow_dispatch]
+
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
+# Runs linter, tests, and inspection checker in parallel
+jobs:
+  lint:
+    name: Check gas snapshot values
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: ./.github/workflows/setup-ci
+
+      - name: "Check gas snapshot"
+        run: pnpm gas:check

.github/workflows/test.yml

@@ -8,22 +8,6 @@ concurrency:
 
 # Runs linter, tests, and inspection checker in parallel
 jobs:
-  lint:
-    name: Run Linters
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - uses: ./.github/workflows/setup-ci
-
-      - name: "Check formatting"
-        run: forge fmt --check
-
-      - name: "Lint the contracts"
-        run: "pnpm lint"
-
   test-optimized-test-deep:
     name: Run Forge Tests (optimized-test-deep)
     runs-on: ubuntu-latest

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/forge-gas-snapshot"]
+	path = lib/forge-gas-snapshot
+	url = https://github.com/marktoda/forge-gas-snapshot

config/solhint-gas.json

@@ -0,0 +1,21 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "func-name-mixedcase": "off",
+    "immutable-vars-naming": ["error"],
+    "no-unused-import": ["error"],
+    "compiler-version": ["error", ">=0.8.20"],
+    "custom-errors": "off",
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "max-line-length": "off",
+    "no-console": "off",
+    "max-states-count": ["warn", 30],
+    "modifier-name-mixedcase": ["error"],
+    "private-vars-leading-underscore": ["error"],
+    "no-inline-assembly": "off",
+    "avoid-low-level-calls": "off",
+    "one-contract-per-file": "off",
+    "no-empty-blocks": "off",
+    "reason-string": ["warn", { "maxLength": 64 }]
+  }
+}

foundry.toml

@@ -12,8 +12,12 @@ bytecode_hash = "none"
 auto_detect_remappings = false
 fs_permissions = [
   { access = "read", path = "./out-optimized" },
+  { access = "read-write", path = "./.forge-snapshots" },
   { access = "read", path = "./test/bin" },
 ]
+remappings = [
+  'forge-std/=lib/forge-std/src/'
+]
 
 [fuzz]
 runs = 500
@@ -49,6 +53,18 @@ runs = 100000
 runs = 5000
 depth = 32
 
+[profile.gas]
+via_ir = true
+test = 'gas'
+optimizer_runs = 10000
+out = 'out-optimized'
+ffi = true
+isolate = true
+# forge-gas-snapshot uses a different remapping for forge-std, so we also need to do this within the gas profile.
+remappings = [
+  'forge-std/=lib/forge-std/',
+]
+
 [fmt]
 line_length = 115
 wrap_comments = true

gas/lightaccount-v2/ILightAccountFactory.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: UNLICENSED
+// !! THIS FILE WAS AUTOGENERATED BY abi-to-sol v0.8.0. SEE SOURCE BELOW. !!
+pragma solidity ^0.8.20;
+
+interface ILightAccountFactory {
+    error AddressEmptyCode(address target);
+    error AddressInsufficientBalance(address account);
+    error FailedInnerCall();
+    error InvalidAction();
+    error InvalidEntryPoint(address entryPoint);
+    error OwnableInvalidOwner(address owner);
+    error OwnableUnauthorizedAccount(address account);
+    error SafeERC20FailedOperation(address token);
+    error TransferFailed();
+    error ZeroAddressNotAllowed();
+
+    event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
+    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
+
+    function ACCOUNT_IMPLEMENTATION() external view returns (address);
+
+    function ENTRY_POINT() external view returns (address);
+
+    function acceptOwnership() external;
+
+    function addStake(uint32 unstakeDelay, uint256 amount) external payable;
+
+    function createAccount(address owner, uint256 salt) external returns (address account);
+
+    function getAddress(address owner, uint256 salt) external view returns (address);
+
+    function owner() external view returns (address);
+
+    function pendingOwner() external view returns (address);
+
+    function renounceOwnership() external view;
+
+    function transferOwnership(address newOwner) external;
+
+    function unlockStake() external;
+
+    function withdraw(address to, address token, uint256 amount) external;
+
+    function withdrawStake(address to) external;
+
+    receive() external payable;
+}
+
+// THIS FILE WAS AUTOGENERATED FROM THE FOLLOWING ABI JSON:
+/*
+[{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"contract
+IEntryPoint","name":"entryPoint","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"AddressInsufficientBalance","type":"error"},{"inputs":[],"name":"FailedInnerCall","type":"error"},{"inputs":[],"name":"InvalidAction","type":"error"},{"inputs":[{"internalType":"address","name":"entryPoint","type":"address"}],"name":"InvalidEntryPoint","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[],"name":"TransferFailed","type":"error"},{"inputs":[],"name":"ZeroAddressNotAllowed","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferStarted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"inputs":[],"name":"ACCOUNT_IMPLEMENTATION","outputs":[{"internalType":"contract
+LightAccount","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ENTRY_POINT","outputs":[{"internalType":"contract
+IEntryPoint","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"acceptOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint32","name":"unstakeDelay","type":"uint32"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"addStake","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"createAccount","outputs":[{"internalType":"contract
+LightAccount","name":"account","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"getAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingOwner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unlockStake","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address
+payable","name":"to","type":"address"},{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address
+payable","name":"to","type":"address"}],"name":"withdrawStake","outputs":[],"stateMutability":"nonpayable","type":"function"},{"stateMutability":"payable","type":"receive"}]*/

gas/simpleaccount/ISimpleAccountFactory.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: UNLICENSED
+// !! THIS FILE WAS AUTOGENERATED BY abi-to-sol v0.8.0. SEE SOURCE BELOW. !!
+pragma solidity ^0.8.20;
+
+interface ISimpleAccountFactory {
+    function accountImplementation() external view returns (address);
+
+    function createAccount(address owner, uint256 salt) external returns (address ret);
+
+    function getAddress(address owner, uint256 salt) external view returns (address);
+}
+
+// THIS FILE WAS AUTOGENERATED FROM THE FOLLOWING ABI JSON:
+/*
+[{"inputs":[{"internalType":"contract
+IEntryPoint","name":"_entryPoint","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"accountImplementation","outputs":[{"internalType":"contract
+SimpleAccount","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"createAccount","outputs":[{"internalType":"contract
+SimpleAccount","name":"ret","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"salt","type":"uint256"}],"name":"getAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]*/

package.json

@@ -12,9 +12,14 @@
     "solhint": "^3.6.2"
   },
   "scripts": {
-    "lint": "pnpm lint:src && pnpm lint:test && pnpm lint:script",
-    "lint:src": "solhint --max-warnings 0 -c .solhint-src.json './src/**/*.sol'",
-    "lint:test": "solhint --max-warnings 0 -c .solhint-test.json './test/**/*.sol'",
-    "lint:script": "solhint --max-warnings 0 -c .solhint-script.json './script/**/*.sol'"
+    "fmt": "forge fmt && FOUNDRY_PROFILE=gas forge fmt",
+    "fmt:check": "forge fmt --check && FOUNDRY_PROFILE=gas forge fmt --check",
+    "gas": "FOUNDRY_PROFILE=gas forge test -vv",
+    "gas:check": "FOUNDRY_PROFILE=gas FORGE_SNAPSHOT_CHECK=true forge test -vv",
+    "lint": "pnpm lint:src && pnpm lint:test && pnpm lint:gas && pnpm lint:script",
+    "lint:src": "solhint --max-warnings 0 -c ./config/solhint-src.json './src/**/*.sol'",
+    "lint:test": "solhint --max-warnings 0 -c ./config/solhint-test.json './test/**/*.sol'",
+    "lint:gas": "solhint --max-warnings 0 -c ./config/solhint-gas.json './gas/**/*.sol'",
+    "lint:script": "solhint --max-warnings 0 -c ./config/solhint-script.json './script/**/*.sol'"
   }
 }

remappings.txt

@@ -1,9 +1,9 @@
 ds-test/=lib/forge-std/lib/ds-test/src/
-forge-std/=lib/forge-std/src/
 modular-account-libs/=node_modules/modular-account-libs/src/
 @eth-infinitism/account-abstraction/=node_modules/account-abstraction/contracts/
 account-abstraction/=node_modules/account-abstraction/contracts/
 @openzeppelin/=lib/openzeppelin-contracts/
 @alchemy/light-account/=lib/light-account/
 solady=node_modules/solady/src/
-@erc-6900/reference-implementation/=node_modules/reference-implementation/src/
+@erc-6900/reference-implementation/=node_modules/reference-implementation/src/
+forge-gas-snapshot/=lib/forge-gas-snapshot/src/