Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from defi-wonderland/perf/opo-602-arbitrator-m…
…odule perf: optimize `ArbitratorModule`
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,69 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.19; | ||
|
|
||
| // solhint-disable-next-line no-unused-import | ||
| import {Module, IModule} from '@defi-wonderland/prophet-core-contracts/solidity/contracts/Module.sol'; | ||
| import {IOracle} from '@defi-wonderland/prophet-core-contracts/solidity/interfaces/IOracle.sol'; | ||
|
|
||
| import {IArbitratorModule} from '../../../interfaces/modules/resolution/IArbitratorModule.sol'; | ||
| import {IArbitrator} from '../../../interfaces/IArbitrator.sol'; | ||
|
|
||
| contract ArbitratorModule is Module, IArbitratorModule { | ||
| /** | ||
| * @notice The status of all disputes | ||
| */ | ||
| mapping(bytes32 _disputeId => ArbitrationStatus _status) internal _disputeData; | ||
|
|
||
| constructor(IOracle _oracle) Module(_oracle) {} | ||
|
|
||
| /// @inheritdoc IModule | ||
| function moduleName() external pure returns (string memory _moduleName) { | ||
| return 'ArbitratorModule'; | ||
| } | ||
|
|
||
| /// @inheritdoc IArbitratorModule | ||
| function decodeRequestData(bytes calldata _data) public pure returns (RequestParameters memory _params) { | ||
| _params = abi.decode(_data, (RequestParameters)); | ||
| } | ||
|
|
||
| /// @inheritdoc IArbitratorModule | ||
| function getStatus(bytes32 _disputeId) external view returns (ArbitrationStatus _disputeStatus) { | ||
| _disputeStatus = _disputeData[_disputeId]; | ||
| } | ||
|
|
||
| /// @inheritdoc IArbitratorModule | ||
| function startResolution( | ||
| bytes32 _disputeId, | ||
| IOracle.Request calldata _request, | ||
| IOracle.Response calldata _response, | ||
|
Check warning on line 38 in solidity/contracts/modules/resolution/ArbitratorModule.sol
|
||
| IOracle.Dispute calldata _dispute | ||
| ) external onlyOracle { | ||
| RequestParameters memory _params = decodeRequestData(_request.resolutionModuleData); | ||
| if (_params.arbitrator == address(0)) revert ArbitratorModule_InvalidArbitrator(); | ||
|
|
||
| _disputeData[_disputeId] = ArbitrationStatus.Active; | ||
| IArbitrator(_params.arbitrator).resolve(_disputeId); | ||
|
|
||
| emit ResolutionStarted(_dispute.requestId, _disputeId); | ||
| } | ||
|
|
||
| /// @inheritdoc IArbitratorModule | ||
| function resolveDispute( | ||
| bytes32 _disputeId, | ||
| IOracle.Request calldata _request, | ||
| IOracle.Response calldata _response, | ||
| IOracle.Dispute calldata _dispute | ||
| ) external onlyOracle { | ||
| if (ORACLE.disputeStatus(_disputeId) != IOracle.DisputeStatus.Escalated) revert ArbitratorModule_InvalidDisputeId(); | ||
|
|
||
| RequestParameters memory _params = decodeRequestData(_request.resolutionModuleData); | ||
| IOracle.DisputeStatus _status = IArbitrator(_params.arbitrator).getAnswer(_disputeId); | ||
|
|
||
| if (_status <= IOracle.DisputeStatus.Escalated) revert ArbitratorModule_InvalidResolutionStatus(); | ||
| _disputeData[_disputeId] = ArbitrationStatus.Resolved; | ||
|
|
||
| ORACLE.updateDisputeStatus(_request, _response, _dispute, _status); | ||
|
|
||
| emit DisputeResolved(_dispute.requestId, _disputeId, _status); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,108 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.19; | ||
|
|
||
| import {IOracle} from '@defi-wonderland/prophet-core-contracts/solidity/interfaces/IOracle.sol'; | ||
| import {IResolutionModule} from | ||
| '@defi-wonderland/prophet-core-contracts/solidity/interfaces/modules/resolution/IResolutionModule.sol'; | ||
|
|
||
| /* | ||
| * @title ArbitratorModule | ||
| * @notice Module allowing an external arbitrator contract to resolve a dispute. | ||
| */ | ||
| interface IArbitratorModule is IResolutionModule { | ||
|
Check warning on line 12 in solidity/interfaces/modules/resolution/IArbitratorModule.sol
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| ERRORS | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /** | ||
| * @notice Thrown when trying to resolve a dispute that is not escalated | ||
| */ | ||
| error ArbitratorModule_InvalidDisputeId(); | ||
|
|
||
| /** | ||
| * @notice Thrown when the arbitrator address is the address zero | ||
| */ | ||
| error ArbitratorModule_InvalidArbitrator(); | ||
|
|
||
| /** | ||
| * @notice Thrown when the arbitrator returns an invalid resolution status | ||
| */ | ||
| error ArbitratorModule_InvalidResolutionStatus(); | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| STRUCTS | ||
| //////////////////////////////////////////////////////////////*/ | ||
| /** | ||
| * @notice Parameters of the request as stored in the module | ||
| * @param arbitrator The address of the arbitrator | ||
| */ | ||
| struct RequestParameters { | ||
| address arbitrator; | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| ENUMS | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /** | ||
| * @notice Available status of the arbitration process | ||
| */ | ||
| enum ArbitrationStatus { | ||
| Unknown, // The arbitration process has not started (default) | ||
| Active, // The arbitration process is active | ||
| Resolved // The arbitration process is resolved | ||
| } | ||
|
|
||
| /*/////////////////////////////////////////////////////////////// | ||
| LOGIC | ||
| //////////////////////////////////////////////////////////////*/ | ||
|
|
||
| /** | ||
| * @notice Returns the decoded data for a request | ||
| * | ||
| * @param _data The encoded request parameters | ||
| * @return _params The struct containing the parameters for the request | ||
| */ | ||
| function decodeRequestData(bytes calldata _data) external view returns (RequestParameters memory _params); | ||
|
|
||
| /** | ||
| * @notice Returns the current arbitration status of a dispute | ||
| * | ||
| * @param _disputeId The ID of the dispute | ||
| * @return _disputeStatus The `ArbitrationStatus` of the dispute | ||
| */ | ||
| function getStatus(bytes32 _disputeId) external view returns (ArbitrationStatus _disputeStatus); | ||
|
|
||
| /** | ||
| * @notice Starts the arbitration process by calling `resolve` on the arbitrator and flags the dispute as Active | ||
| * | ||
| * @dev Only callable by the Oracle | ||
| * @dev Will revert if the arbitrator address is the address zero | ||
| * @param _disputeId The ID of the dispute | ||
| * @param _request The request | ||
| * @param _response The disputed response | ||
| * @param _dispute The dispute being sent to the resolution | ||
| */ | ||
| function startResolution( | ||
| bytes32 _disputeId, | ||
| IOracle.Request calldata _request, | ||
| IOracle.Response calldata _response, | ||
| IOracle.Dispute calldata _dispute | ||
| ) external; | ||
|
|
||
| /** | ||
| * @notice Resolves the dispute by getting the answer from the arbitrator and updating the dispute status | ||
| * | ||
| * @dev Only callable by the Oracle | ||
| * @param _disputeId The ID of the dispute | ||
| * @param _request The request | ||
| * @param _response The disputed response | ||
| * @param _dispute The dispute that is being resolved | ||
| */ | ||
| function resolveDispute( | ||
| bytes32 _disputeId, | ||
| IOracle.Request calldata _request, | ||
| IOracle.Response calldata _response, | ||
| IOracle.Dispute calldata _dispute | ||
| ) external; | ||
| } | ||
Oops, something went wrong.