fix(og): N-03 - Swap misleading variable names (#4492)

Signed-off-by: Reinis Martinsons <reinis@umaproject.org>

packages/core/contracts/optimistic-governor/implementation/OptimisticGovernor.sol

@@ -90,8 +90,8 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
         uint256 requestTime;
     }
 
-    mapping(bytes32 => bytes32) public proposalHashes; // Maps proposal hashes to assertionIds.
-    mapping(bytes32 => bytes32) public assertionIds; // Maps assertionIds to proposal hashes.
+    mapping(bytes32 => bytes32) public assertionIds; // Maps proposal hashes to assertionIds.
+    mapping(bytes32 => bytes32) public proposalHashes; // Maps assertionIds to proposal hashes.
 
     /**
      * @notice Construct Optimistic Governor module.
@@ -254,7 +254,7 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
         bytes memory claim = _constructClaim(proposalHash, explanation);
 
         // Check that the proposal is not already mapped to an assertionId, i.e., is not a duplicate.
-        require(proposalHashes[proposalHash] == bytes32(0), "Duplicate proposals not allowed");
+        require(assertionIds[proposalHash] == bytes32(0), "Duplicate proposals not allowed");
 
         // Get the bond from the proposer and approve the required bond to be used by the Optimistic Oracle V3.
         // This will fail if the proposer has not granted the Optimistic Governor contract an allowance
@@ -278,8 +278,8 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
             );
 
         // Maps the proposal hash to the returned assertionId and vice versa.
-        proposalHashes[proposalHash] = assertionId;
-        assertionIds[assertionId] = proposalHash;
+        assertionIds[proposalHash] = assertionId;
+        proposalHashes[assertionId] = proposalHash;
 
         emit TransactionsProposed(
             proposer,
@@ -304,14 +304,14 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
         // This will reject the transaction if the proposal hash generated from the inputs does not match the stored
         // proposal hash. This is possible when a) the transactions have not been proposed, b) transactions have already
         // been executed, c) the proposal was disputed or d) the proposal was deleted after Optimistic Oracle V3 upgrade.
-        require(proposalHashes[proposalHash] != bytes32(0), "Proposal hash does not exist");
+        require(assertionIds[proposalHash] != bytes32(0), "Proposal hash does not exist");
 
         // Get the original proposal assertionId.
-        bytes32 assertionId = proposalHashes[proposalHash];
+        bytes32 assertionId = assertionIds[proposalHash];
 
         // Remove proposal hash and assertionId so transactions can not be executed again.
-        delete proposalHashes[proposalHash];
-        delete assertionIds[assertionId];
+        delete assertionIds[proposalHash];
+        delete proposalHashes[assertionId];
 
         // There is no need to check the assertion result as this point can be reached only for non-disputed assertions.
         // This will revert if the assertion has not been settled and can not currently be settled.
@@ -340,15 +340,15 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
      */
     function deleteProposalOnUpgrade(bytes32 proposalHash) public nonReentrant {
         require(proposalHash != bytes32(0), "Invalid proposal hash");
-        bytes32 assertionId = proposalHashes[proposalHash];
+        bytes32 assertionId = assertionIds[proposalHash];
         require(assertionId != bytes32(0), "Proposal hash does not exist");
 
         // Detect Optimistic Oracle V3 upgrade by checking if it has the matching assertionId.
         require(optimisticOracleV3.getAssertion(assertionId).asserter == address(0), "OOv3 upgrade not detected");
 
         // Remove proposal hash and assertionId so that transactions can be re-proposed if needed.
-        delete proposalHashes[proposalHash];
-        delete assertionIds[assertionId];
+        delete assertionIds[proposalHash];
+        delete proposalHashes[assertionId];
 
         emit ProposalDeleted(proposalHash, assertionId);
     }
@@ -358,7 +358,7 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
      * @param assertionId the identifier of the disputed assertion.
      */
     function assertionDisputedCallback(bytes32 assertionId) external {
-        bytes32 proposalHash = assertionIds[assertionId];
+        bytes32 proposalHash = proposalHashes[assertionId];
 
         // Callback should only be called by the Optimistic Oracle V3. Address would not match in case of contract
         // upgrade, thus try deleting the proposal through deleteProposalOnUpgrade function that should revert if
@@ -369,8 +369,8 @@ contract OptimisticGovernor is OptimisticOracleV3CallbackRecipientInterface, Mod
             require(proposalHash != bytes32(0), "Invalid proposal hash");
 
             // Delete the disputed proposal and associated assertionId.
-            delete proposalHashes[proposalHash];
-            delete assertionIds[assertionId];
+            delete assertionIds[proposalHash];
+            delete proposalHashes[assertionId];
 
             emit ProposalDeleted(proposalHash, assertionId);
         } else deleteProposalOnUpgrade(proposalHash);

packages/core/test/hardhat/optimistic-governor/OptimisticGovernor.js

@@ -218,7 +218,7 @@ describe("OptimisticGovernor", () => {
     const proposalTime = parseInt(await optimisticOracleModule.methods.getCurrentTime().call());
     const endingTime = proposalTime + liveness;
 
-    const assertionId = await optimisticOracleModule.methods.proposalHashes(proposalHash).call();
+    const assertionId = await optimisticOracleModule.methods.assertionIds(proposalHash).call();
     const claim = utf8ToHex(
       "proposalHash:" + proposalHash.slice(2) + ',explanation:"' + hexToUtf8(explanation) + '",rules:"' + rules + '"'
     );
@@ -323,7 +323,7 @@ describe("OptimisticGovernor", () => {
     const proposalTime = parseInt(await optimisticOracleModule.methods.getCurrentTime().call());
     const endingTime = proposalTime + liveness;
 
-    const assertionId = await optimisticOracleModule.methods.proposalHashes(proposalHash).call();
+    const assertionId = await optimisticOracleModule.methods.assertionIds(proposalHash).call();
 
     await assertEventEmitted(
       receipt,
@@ -496,7 +496,7 @@ describe("OptimisticGovernor", () => {
     );
 
     // Disputed proposal hash is deleted automatically from callback.
-    const disputedProposalHash = await optimisticOracleModule.methods.proposalHashes(proposalHash).call();
+    const disputedProposalHash = await optimisticOracleModule.methods.assertionIds(proposalHash).call();
     assert.equal(disputedProposalHash, 0);
   });
 
@@ -545,7 +545,7 @@ describe("OptimisticGovernor", () => {
     await optimisticOracleV3.methods.disputeAssertion(assertionId, disputer).send({ from: disputer });
 
     // Disputed proposal hash is deleted automatically from callback.
-    const disputedProposalHashTimestamp = await optimisticOracleModule.methods.proposalHashes(proposalHash).call();
+    const disputedProposalHashTimestamp = await optimisticOracleModule.methods.assertionIds(proposalHash).call();
     assert.equal(disputedProposalHashTimestamp, 0);
 
     // Duplicate proposal can be made after original proposal is deleted. This is useful in case the disputer was wrong.