feat: duplicated proposals check (#378)

* feat: add initial interface and logic

* refactor: remove installed governor submodule

* chore: remove xERC20

* feat: add proposal routing full flow

* feat: check voting power and required proposals

* refactor: rename to ProposalValidator

* feat: add EAS validation for certain Proposal Types

* feat: add duplicated proposals validation

* chore: fix attestation schema approved address naming

Co-authored-by: 0xOneTony <[email protected]>
Signed-off-by: Chiin <[email protected]>

* chore: remove management functions

* chore: run pre-pr

* refacto: follow style guide for function parameters and return variables

* docs: add natspec, remove unused errors

* chore: remove management functions from interface

* chore: make voting token immutable

* perf: make governor immutable

* feat: add validator management functions

* chore: add comments for imports in ProposalValidator

* test: add unit tests

* chore: run pre-pr

* fix: semgrep warnings

* chore: rename MaintenanceUpgradeProposals --> MaintenanceUpgrade

* chore(semgrep): add excluded governance files

* chore: fix coding style

* chore: add ImmutableProposalTypeData

* chore: improve errors naming

* docs: improve natspec

Co-authored-by: 0xOneTony <[email protected]>
Signed-off-by: Chiin <[email protected]>

* docs: add technical explanation on attestation validation function

* feat: add _proposalTypeData mapping

* chore: keep private functions consistency

* chore: improve required attestation naming

* chore: run pre-pr

* chore: more descriptive errors

* chore: confusing error name in submitProposal

---------

Signed-off-by: Chiin <[email protected]>
Co-authored-by: 0xOneTony <[email protected]>

Author: 0xChin

packages/contracts-bedrock/interfaces/governance/IProposalValidator.sol

@@ -9,17 +9,15 @@ import {IOptimismGovernor} from "./IOptimismGovernor.sol";
 interface IProposalValidator {
     error ProposalValidator_InsufficientApprovals();
     error ProposalValidator_ProposalAlreadyApproved();
-    error ProposalValidator_ProposalAlreadyInVoting();
+    error ProposalValidator_ProposalAlreadySubmitted();
     error ProposalValidator_InsufficientVotingPower();
     error ProposalValidator_InvalidAttestation();
+    error ProposalValidator_ProposalDoesNotExist();
 
     struct ProposalData {
         address proposer;
-        address[] targets;
-        uint256[] values;
-        bytes[] calldatas;
-        string description;
         ProposalType proposalType;
+        uint8 proposalTypeConfigurator;
         bool inVoting;
         mapping(address => bool) delegateApprovals;
         uint256 remainingApprovalsRequired;
@@ -40,22 +38,23 @@ interface IProposalValidator {
     }
 
     event ProposalSubmitted(
-        uint256 indexed proposalId,
+        bytes32 indexed proposalHash,
         address indexed proposer,
         address[] targets,
         uint256[] values,
         bytes[] calldatas,
         string description,
-        ProposalType proposalType
+        ProposalType proposalType,
+        uint8 proposalTypeConfigurator
     );
 
     event ProposalApproved(
-        uint256 indexed proposalId,
+        bytes32 indexed proposalHash,
         address indexed approver
     );
 
     event ProposalMovedToVote(
-        uint256 indexed proposalId,
+        bytes32 indexed proposalHash,
         address indexed executor
     );
 
@@ -75,12 +74,18 @@ interface IProposalValidator {
         bytes[] memory _calldatas,
         string memory _description,
         ProposalType _proposalType,
+        uint8 _proposalTypeConfigurator,
         bytes32 _attestationUid
-    ) external returns (uint256 proposalId_);
+    ) external returns (bytes32 proposalHash_);
 
-    function approveProposal(uint256 _proposalId) external;
+    function approveProposal(bytes32 _proposalHash) external;
 
-    function moveToVote(uint256 _proposalId) external returns (uint256 governorProposalId_);
+    function moveToVote(
+        address[] memory _targets,
+        uint256[] memory _values,
+        bytes[] memory _calldatas,
+        string memory _description
+    ) external returns (uint256 governorProposalId_);
 
     function setMinimumVotingPower(uint256 _minimumVotingPower) external;
 

packages/contracts-bedrock/snapshots/abi/ProposalValidator.json

@@ -114,9 +114,9 @@
   {
     "inputs": [
       {
-        "internalType": "uint256",
-        "name": "_proposalId",
-        "type": "uint256"
+        "internalType": "bytes32",
+        "name": "_proposalHash",
+        "type": "bytes32"
       }
     ],
     "name": "approveProposal",
@@ -172,9 +172,24 @@
   {
     "inputs": [
       {
-        "internalType": "uint256",
-        "name": "_proposalId",
-        "type": "uint256"
+        "internalType": "address[]",
+        "name": "_targets",
+        "type": "address[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "_values",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "bytes[]",
+        "name": "_calldatas",
+        "type": "bytes[]"
+      },
+      {
+        "internalType": "string",
+        "name": "_description",
+        "type": "string"
       }
     ],
     "name": "moveToVote",
@@ -292,6 +307,11 @@
         "name": "_proposalType",
         "type": "uint8"
       },
+      {
+        "internalType": "uint8",
+        "name": "_proposalTypeConfigurator",
+        "type": "uint8"
+      },
       {
         "internalType": "bytes32",
         "name": "_attestationUid",
@@ -301,9 +321,9 @@
     "name": "submitProposal",
     "outputs": [
       {
-        "internalType": "uint256",
-        "name": "proposalId_",
-        "type": "uint256"
+        "internalType": "bytes32",
+        "name": "proposalHash_",
+        "type": "bytes32"
       }
     ],
     "stateMutability": "nonpayable",
@@ -404,9 +424,9 @@
     "inputs": [
       {
         "indexed": true,
-        "internalType": "uint256",
-        "name": "proposalId",
-        "type": "uint256"
+        "internalType": "bytes32",
+        "name": "proposalHash",
+        "type": "bytes32"
       },
       {
         "indexed": true,
@@ -423,9 +443,9 @@
     "inputs": [
       {
         "indexed": true,
-        "internalType": "uint256",
-        "name": "proposalId",
-        "type": "uint256"
+        "internalType": "bytes32",
+        "name": "proposalHash",
+        "type": "bytes32"
       },
       {
         "indexed": true,
@@ -442,9 +462,9 @@
     "inputs": [
       {
         "indexed": true,
-        "internalType": "uint256",
-        "name": "proposalId",
-        "type": "uint256"
+        "internalType": "bytes32",
+        "name": "proposalHash",
+        "type": "bytes32"
       },
       {
         "indexed": true,
@@ -481,6 +501,12 @@
         "internalType": "enum ProposalValidator.ProposalType",
         "name": "proposalType",
         "type": "uint8"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint8",
+        "name": "proposalTypeConfigurator",
+        "type": "uint8"
       }
     ],
     "name": "ProposalSubmitted",
@@ -521,7 +547,12 @@
   },
   {
     "inputs": [],
-    "name": "ProposalValidator_ProposalAlreadyInVoting",
+    "name": "ProposalValidator_ProposalAlreadySubmitted",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ProposalValidator_ProposalDoesNotExist",
     "type": "error"
   }
 ]

packages/contracts-bedrock/snapshots/storageLayout/ProposalValidator.json

@@ -46,13 +46,6 @@
     "label": "_proposals",
     "offset": 0,
     "slot": "6",
-    "type": "mapping(uint256 => struct ProposalValidator.ProposalData)"
-  },
-  {
-    "bytes": "32",
-    "label": "_proposalCounter",
-    "offset": 0,
-    "slot": "7",
-    "type": "uint256"
+    "type": "mapping(bytes32 => struct ProposalValidator.ProposalData)"
   }
 ]