add snapshots to CI with tolerance (#401)

.env

@@ -0,0 +1 @@
+FOUNDRY_FUZZ_SEED=0x4444

.github/workflows/lint.yml

@@ -20,5 +20,5 @@ jobs:
         with:
           version: nightly
 
-      - name: Compile
+      - name: Lint
         run: forge fmt --check

.github/workflows/tests.yml

@@ -28,7 +28,15 @@ jobs:
         with:
           version: nightly
 
+      - name: Build
+        run: forge build
+
       - name: Run tests
         run: forge test -vvv
         env:
           FOUNDRY_PROFILE: ci
+
+      - name: Run forge snapshots
+        run: forge snapshot --check --tolerance 5
+        env:
+          FOUNDRY_FUZZ_SEED: "0x4444"

CONTRIBUTING.md

@@ -50,7 +50,7 @@ All contributions must follow the below standards. Maintainers will close out PR
 
 ## Tests
 
-`forge snapshot`to update the forge gas snapshots
+`forge snapshot`to update the forge gas snapshots. Note these must use a static fuzz seed, so please `source .env`, use `FOUNDRY_FUZZ_SEED=0x4444`, or use `just snapshots` when running forge snapshots.
 
 `forge test` to run forge tests
 

foundry.toml

@@ -6,7 +6,11 @@ ffi = true
 fs_permissions = [{ access = "read-write", path = ".forge-snapshots/"}, { access = "read", path = "./out"}]
 evm_version = 'paris'
 
-[profile.ci]
-fuzz_runs = 100000
+[profile.default.fuzz]
+runs = 100
+seed = "0x4444"
+
+[profile.ci.fuzz]
+runs = 1000
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

justfile

@@ -9,7 +9,7 @@ build-forge: install-forge
     forge build
 
 snapshots-forge: install-forge test-forge
-    forge snapshot
+    FOUNDRY_FUZZ_SEED=0x4444 forge snapshot
 
 install-forge:
     forge install