feat(ctb): Consolidate lock files into a single directory

Also standardizes on the usage of the term lock except in the case of gas-snapshot
which is fairly standard in the industry and so is kept to prevent
confusion.

fix(ctb): Update storage-lock file paths
Co-authored-by: clabby <ben@clab.by>

.circleci/config.yml

@@ -382,10 +382,10 @@ jobs:
             pnpm lint:check || echo "export LINT_STATUS=1" >> "$BASH_ENV"
           working_directory: packages/contracts-bedrock
       - run:
-          name: gas snapshot
+          name: gas lock
           command: |
             forge --version
-            pnpm gas-snapshot --check || echo "export GAS_SNAPSHOT_STATUS=1" >> "$BASH_ENV"
+            pnpm gas-lock --check || echo "export GAS_LOCK_STATUS=1" >> "$BASH_ENV"
           environment:
             FOUNDRY_PROFILE: ci
           working_directory: packages/contracts-bedrock
@@ -398,10 +398,10 @@ jobs:
             FOUNDRY_PROFILE: ci
           working_directory: packages/contracts-bedrock
       - run:
-          name: storage snapshot
+          name: storage lock
           command: |
-            pnpm storage-snapshot
-            git diff --exit-code .storage-layout || echo "export STORAGE_SNAPSHOT_STATUS=1" >> "$BASH_ENV"
+            pnpm storage-lock
+            git diff --exit-code locks/storage-lock || echo "export STORAGE_LOCK_STATUS=1" >> "$BASH_ENV"
           working_directory: packages/contracts-bedrock
       - run:
           name: semver lock
@@ -422,16 +422,16 @@ jobs:
               FAILED=1
               echo "Linting failed, see job output for details."
             fi
-            if [[ "$GAS_SNAPSHOT_STATUS" -ne 0 ]]; then
+            if [[ "$GAS_LOCK_STATUS" -ne 0 ]]; then
               FAILED=1
-              echo "Gas snapshot failed, see job output for details."
+              echo "Gas lock failed, see job output for details."
             fi
             if [[ "$DEPLOY_CONFIG_STATUS" -ne 0 ]]; then
               FAILED=1
               echo "Deploy configs invalid, see job output for details."
             fi
-            if [[ "$STORAGE_SNAPSHOT_STATUS" -ne 0 ]]; then
-              echo "Storage snapshot failed, see job output for details."
+            if [[ "$STORAGE_LOCK_STATUS" -ne 0 ]]; then
+              echo "Storage lock failed, see job output for details."
               FAILED=1
             fi
             if [[ "$INVARIANT_DOCS_STATUS" -ne 0 ]]; then

packages/contracts-bedrock/package.json

@@ -20,8 +20,8 @@
     "test": "pnpm build:differential && pnpm build:fuzz && forge test",
     "coverage": "pnpm build:differential && pnpm build:fuzz && forge coverage",
     "coverage:lcov": "pnpm build:differential && pnpm build:fuzz && forge coverage --report lcov",
-    "gas-snapshot": "pnpm build:differential && pnpm build:fuzz && forge snapshot --no-match-test 'testDiff|testFuzz|invariant|generateArtifact'",
-    "storage-snapshot": "./scripts/storage-snapshot.sh",
+    "gas-lock": "pnpm build:differential && pnpm build:fuzz && forge snapshot --snap locks/gas-lock --no-match-test 'testDiff|testFuzz|invariant|generateArtifact'",
+    "storage-lock": "./scripts/storage-lock.sh",
     "semver-lock": "forge script scripts/SemverLock.s.sol",
     "validate-deploy-configs": "./scripts/validate-deploy-configs.sh",
     "validate-spacers": "pnpm build && npx ts-node scripts/validate-spacers.ts",

packages/contracts-bedrock/scripts/storage-snapshot.sh → packages/contracts-bedrock/scripts/storage-lock.sh

@@ -38,15 +38,15 @@ dir=$(dirname "$0")
 
 echo "Creating storage layout diagrams.."
 
-echo "=======================" > $dir/../.storage-layout
-echo "👁👁 STORAGE LAYOUT snapshot 👁👁" >> $dir/../.storage-layout
-echo "=======================" >> $dir/../.storage-layout
+echo "=======================" > $dir/../locks/storage-lock
+echo "👁👁 STORAGE LAYOUT LOCK 👁👁" >> $dir/../locks/storage-lock
+echo "=======================" >> $dir/../locks/storage-lock
 
 for contract in ${contracts[@]}
 do
-  echo -e "\n=======================" >> $dir/../.storage-layout
-  echo "➡ $contract">> $dir/../.storage-layout
-  echo -e "=======================\n" >> $dir/../.storage-layout
-  forge inspect --pretty $contract storage-layout >> $dir/../.storage-layout
+  echo -e "\n=======================" >> $dir/../locks/storage-lock
+  echo "➡ $contract">> $dir/../locks/storage-lock
+  echo -e "=======================\n" >> $dir/../locks/storage-lock
+  forge inspect --pretty $contract storageLayout >> $dir/../locks/storage-lock
 done
-echo "Storage layout snapshot stored at $dir/../.storage-layout"
+echo "Storage layout lock stored at $dir/../locks/storage-lock"