feat: Updatable Proposals & Signature-based Sponsorship (Governor v3.0.0)

.env.example

@@ -0,0 +1,21 @@
+# Network alias used by package.json deploy commands.
+# Examples: sepolia, base_sepolia, optimism_sepolia, mainnet, base, optimism
+NETWORK=sepolia
+
+# Deployer private key
+PRIVATE_KEY=
+
+# Human-readable deployment salt label.
+# Deterministic deploy scripts hash this with keccak256(bytes(DEPLOY_SALT)).
+DEPLOY_SALT=buildeross@v3.0.0
+
+# RPC URLs
+MAINNET_RPC_URL=
+SEPOLIA_RPC_URL=
+OPTIMISM_RPC_URL=
+OPTIMISM_SEPOLIA_RPC_URL=
+BASE_RPC_URL=
+BASE_SEPOLIA_RPC_URL=
+
+# Explorer API keys
+ETHERSCAN_API_KEY=

.github/workflows/storage.yml

@@ -1,22 +1,30 @@
 name: Check Contract Storage Layout
 on: [pull_request]
 
+permissions:
+  contents: read
+
 jobs:
   inspect-storage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
+
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6
         with:
-          node-version: "16.13.2"
-      - run: npm install
+          node-version: "22.22.1"
+          cache: "yarn"
+
+      - run: yarn install --frozen-lockfile
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+        uses: foundry-rs/foundry-toolchain@b00af27efadbc7b4ca8b82abbd903b17cc874d2a # v1
         with:
-          version: nightly
-  
+          version: v1.5.1
+
       - name: "Inspect Storage Layout"
         continue-on-error: false
         id: storage-inspect-check

.github/workflows/test.yml

@@ -1,19 +1,28 @@
 name: Run Tests
 on: [push]
+
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Test
     runs-on: ubuntu-latest
     environment: Test
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           submodules: recursive
-      - uses: actions/setup-node@v2
+
+      - uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6
         with:
-          node-version: "16"
-      - run: npm install
-      - uses: onbjerg/foundry-toolchain@v1
+          node-version: "22.22.1"
+          cache: "yarn"
+
+      - run: yarn install --frozen-lockfile
+
+      - uses: foundry-rs/foundry-toolchain@b00af27efadbc7b4ca8b82abbd903b17cc874d2a # v1
         with:
-          version: nightly
-      - run: ETH_RPC_MAINNET=${{secrets.ETH_RPC_MAINNET}} npm run test
+          version: v1.5.1
+
+      - run: yarn test:unit

.gitignore

@@ -5,6 +5,7 @@ out
 dist
 .env
 .env.*
+!.env.example
 .DS_Store
 .vscode/
 broadcast/

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "lib/forge-std"]
-	path = lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/create3-factory"]
+	path = lib/create3-factory
+	url = https://github.com/BuilderOSS/create3-factory.git

.prettierignore

@@ -0,0 +1,15 @@
+# Exclude Solidity files - formatted with forge fmt
+*.sol
+
+# Artifacts and build outputs
+dist/
+out/
+cache/
+artifacts/
+node_modules/
+
+# Git
+.git/
+
+# External dependencies
+lib/

.prettierrc

@@ -1,14 +1,4 @@
 {
   "tabWidth": 2,
-  "printWidth": 100,
-  "overrides": [
-    {
-      "files": "*.sol",
-      "options": {
-        "printWidth": 150,
-        "tabWidth": 4,
-        "bracketSpacing": true
-      }
-    }
-  ]
+  "printWidth": 100
 }

.solhint.json

@@ -1,6 +1,29 @@
 {
-  "plugins": ["prettier"],
+  "extends": "solhint:recommended",
   "rules": {
-    "prettier/prettier": "error"
-  }
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "immutable-vars-naming": "off",
+    "var-name-mixedcase": "off",
+    "const-name-snakecase": "off",
+    "interface-starts-with-i": "off",
+    "function-max-lines": ["warn", 80],
+    "no-empty-blocks": "off",
+    "no-inline-assembly": "off",
+    "avoid-low-level-calls": "off",
+    "import-path-check": "off",
+    "no-global-import": "off",
+    "quotes": "off",
+    "func-name-mixedcase": "off",
+    "no-console": "off",
+    "state-visibility": "off",
+    "one-contract-per-file": "off",
+    "no-unused-import": "off",
+    "compiler-version": "off",
+    "gas-indexed-events": "off",
+    "gas-increment-by-one": "off",
+    "gas-strict-inequalities": "off",
+    "gas-calldata-parameters": "off",
+    "gas-small-strings": "off"
+  },
+  "excludedFiles": ["src/lib/**/*.sol"]
 }

.storage-layout

@@ -88,6 +88,16 @@
 | hasVoted                             | mapping(bytes32 => mapping(address => bool))        | 11   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
 |--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
 | delayedGovernanceExpirationTimestamp | uint256                                             | 12   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
+|--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
+| _proposalUpdatablePeriod             | uint48                                              | 13   | 0      | 6     | src/governance/governor/Governor.sol:Governor |
+|--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
+| proposeSigNonces                     | mapping(address => uint256)                         | 14   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
+|--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
+| proposalSigners                      | mapping(bytes32 => address[])                       | 15   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
+|--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
+| proposalUpdatePeriodEnds             | mapping(bytes32 => uint32)                          | 16   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
+|--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------|
+| proposalIdReplacedBy                 | mapping(bytes32 => bytes32)                         | 17   | 0      | 32    | src/governance/governor/Governor.sol:Governor |
 ╰--------------------------------------+-----------------------------------------------------+------+--------+-------+-----------------------------------------------╯