feat: make finalized response ids public

defi-wonderland · Dec 12, 2023 · d747ca7 · d747ca7
1 parent 75af5a4
commit d747ca7
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 33 deletions.
diff --git a/solidity/contracts/Oracle.sol b/solidity/contracts/Oracle.sol
@@ -25,6 +25,9 @@ contract Oracle is IOracle {
   /// @inheritdoc IOracle
   mapping(uint256 _requestNumber => bytes32 _id) public nonceToRequestId;
 
+  /// @inheritdoc IOracle
+  mapping(bytes32 _requestId => bytes32 _finalizedResponseId) public finalizedResponseId;
+
   /**
    * @notice The list of the response ids for each request
    */
@@ -40,11 +43,6 @@ contract Oracle is IOracle {
    */
   mapping(bytes32 _requestId => bytes _allowedModules) internal _allowedModules;
 
-  /**
-   * @notice The finalized response for each request
-   */
-  mapping(bytes32 _requestId => bytes32 _finalizedResponseId) internal _finalizedResponses;
-
   /// @inheritdoc IOracle
   uint256 public totalRequestCount;
 
@@ -260,11 +258,6 @@ contract Oracle is IOracle {
     _isParticipant = _matchBytes(bytes32(uint256(uint160(_user))), _participants[_requestId], 20);
   }
 
-  /// @inheritdoc IOracle
-  function getFinalizedResponseId(bytes32 _requestId) external view returns (bytes32 _finalizedResponseId) {
-    _finalizedResponseId = _finalizedResponses[_requestId];
-  }
-
   /// @inheritdoc IOracle
   function getResponseIds(bytes32 _requestId) public view returns (bytes32[] memory _ids) {
     bytes memory _responses = _responseIds[_requestId];
@@ -367,7 +360,7 @@ contract Oracle is IOracle {
       revert Oracle_InvalidFinalizedResponse();
     }
 
-    _finalizedResponses[_requestId] = _responseId;
+    finalizedResponseId[_requestId] = _responseId;
   }
 
   /**

diff --git a/solidity/interfaces/IModule.sol b/solidity/interfaces/IModule.sol
@@ -41,7 +41,7 @@ interface IModule {
 
   /*///////////////////////////////////////////////////////////////
                               VARIABLES
-   //////////////////////////////////////////////////////////////*/
+  //////////////////////////////////////////////////////////////*/
 
   /**
    * @notice Returns the address of the oracle

diff --git a/solidity/interfaces/IOracle.sol b/solidity/interfaces/IOracle.sol
@@ -256,6 +256,14 @@ interface IOracle {
    */
   function nonceToRequestId(uint256 _nonce) external view returns (bytes32 _requestId);
 
+  /**
+   * @notice Returns the finalized response ID for a given request
+   *
+   * @param _requestId The id of the request
+   * @return _finalizedResponseId The id of the finalized response
+   */
+  function finalizedResponseId(bytes32 _requestId) external view returns (bytes32 _finalizedResponseId);
+
   /**
    * @notice The number of the block at which a request, response, or a dispute was created
    *
@@ -384,14 +392,6 @@ interface IOracle {
    */
   function isParticipant(bytes32 _requestId, address _user) external view returns (bool _isParticipant);
 
-  /**
-   * @notice Returns the finalized response ID for a given request
-   *
-   * @param _requestId The id of the request
-   * @return _finalizedResponseId The id of the finalized response
-   */
-  function getFinalizedResponseId(bytes32 _requestId) external view returns (bytes32 _finalizedResponseId);
-
   /**
    * @notice Returns the ids of the responses for a given request
    *

diff --git a/solidity/test/integration/Finalization.t.sol b/solidity/test/integration/Finalization.t.sol
@@ -53,7 +53,7 @@ contract Integration_Finalization is IntegrationBase {
     vm.prank(_finalizer);
     oracle.finalize(mockRequest, mockResponse);
 
-    bytes32 _responseId = oracle.getFinalizedResponseId(_requestId);
+    bytes32 _responseId = oracle.finalizedResponseId(_requestId);
     // Check: is request finalized?
     assertEq(_responseId, _getId(mockResponse));
   }

diff --git a/solidity/test/unit/Oracle.t.sol b/solidity/test/unit/Oracle.t.sol
@@ -30,7 +30,7 @@ contract MockOracle is Oracle {
   }
 
   function mock_setFinalizedResponseId(bytes32 _requestId, bytes32 _finalizedResponseId) external {
-    _finalizedResponses[_requestId] = _finalizedResponseId;
+    finalizedResponseId[_requestId] = _finalizedResponseId;
   }
 
   function mock_setFinalizedAt(bytes32 _requestId, uint128 _finalizedAt) external {
@@ -730,17 +730,6 @@ contract Oracle_Unit_IsParticipant is BaseTest {
   }
 }
 
-contract Oracle_Unit_GetFinalizedResponseId is BaseTest {
-  /**
-   * @notice Test if the finalized response id is returned correctly
-   */
-  function test_getFinalizedResponseId(bytes32 _requestId, bytes32 _finalizedResponseId) public {
-    assertEq(oracle.getFinalizedResponseId(_requestId), bytes32(0));
-    oracle.mock_setFinalizedResponseId(_requestId, _finalizedResponseId);
-    assertEq(oracle.getFinalizedResponseId(_requestId), _finalizedResponseId);
-  }
-}
-
 contract Oracle_Unit_Finalize is BaseTest {
   modifier withoutResponse() {
     mockResponse.requestId = bytes32(0);