From b58d7238416024f95ad038ea935d3a7baf4fa5c4 Mon Sep 17 00:00:00 2001 From: moebius <0xmoebius@tutanota.com> Date: Fri, 8 Dec 2023 12:00:52 -0300 Subject: [PATCH 01/12] test: increase some modules test coverage to 100 --- .../dispute/CircuitResolverModule.t.sol | 65 ++++++++++++++++++- .../request/ContractCallRequestModule.t.sol | 26 ++++++++ .../resolution/ERC20ResolutionModule.t.sol | 11 ++++ .../PrivateERC20ResolutionModule.t.sol | 15 +++++ 4 files changed, 115 insertions(+), 2 deletions(-) diff --git a/solidity/test/unit/modules/dispute/CircuitResolverModule.t.sol b/solidity/test/unit/modules/dispute/CircuitResolverModule.t.sol index a7b77377..6310118f 100644 --- a/solidity/test/unit/modules/dispute/CircuitResolverModule.t.sol +++ b/solidity/test/unit/modules/dispute/CircuitResolverModule.t.sol @@ -254,7 +254,7 @@ contract CircuitResolverModule_Unit_DisputeResponse is BaseTest { } contract CircuitResolverModule_Unit_OnDisputeStatusChange is BaseTest { - function test_emitsEvent( + function test_emitsEvent_lostDispute( IAccountingExtension _accountingExtension, IERC20 _randomToken, uint256 _bondSize, @@ -277,7 +277,7 @@ contract CircuitResolverModule_Unit_OnDisputeStatusChange is BaseTest { mockResponse.requestId = _requestId; mockResponse.response = _encodedCorrectResponse; - mockResponse.proposer = mockDispute.disputer; + mockResponse.proposer = makeAddr('proposer'); // Mock and expect the call to the oracle, finalizing the request _mockAndExpect(address(oracle), abi.encodeCall(IOracle.finalize, (mockRequest, mockResponse)), abi.encode()); @@ -295,4 +295,65 @@ contract CircuitResolverModule_Unit_OnDisputeStatusChange is BaseTest { vm.prank(address(oracle)); circuitResolverModule.onDisputeStatusChange(_disputeId, mockRequest, mockResponse, mockDispute); } + + function test_emitsEvent_wonDispute( + IAccountingExtension _accountingExtension, + IERC20 _randomToken, + uint256 _bondSize, + bytes memory _callData + ) public { + mockRequest.disputeModuleData = abi.encode( + ICircuitResolverModule.RequestParameters({ + callData: _callData, + verifier: address(mockVerifier), + accountingExtension: _accountingExtension, + bondToken: _randomToken, + bondSize: _bondSize + }) + ); + + bytes32 _requestId = _getId(mockRequest); + bytes memory _encodedCorrectResponse = abi.encode(true); + + circuitResolverModule.forTest_setCorrectResponse(_requestId, _encodedCorrectResponse); + + mockResponse.requestId = _requestId; + mockResponse.response = abi.encode(false); + mockResponse.proposer = makeAddr('proposer'); + + // Populate the mock dispute with the correct values + mockDispute.responseId = _getId(mockResponse); + mockDispute.requestId = _requestId; + bytes32 _disputeId = _getId(mockDispute); + IOracle.DisputeStatus _status = IOracle.DisputeStatus.Won; + + // Mock and expect the call to the accounting extension, paying the disputer + _mockAndExpect( + address(_accountingExtension), + abi.encodeCall( + IAccountingExtension.pay, (_requestId, makeAddr('proposer'), mockDispute.disputer, _randomToken, _bondSize) + ), + abi.encode() + ); + + IOracle.Response memory _newResponse = + IOracle.Response({requestId: _requestId, response: _encodedCorrectResponse, proposer: mockDispute.disputer}); + + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(circuitResolverModule)); + emit DisputeStatusChanged(_disputeId, mockDispute, _status); + + // Mock and expect the call to the oracle, proposing the correct response + _mockAndExpect( + address(oracle), + abi.encodeCall(IOracle.proposeResponse, (mockRequest, _newResponse)), + abi.encode(_getId(_newResponse)) + ); + + // Mock and expect the call to the accounting extension, paying the disputer + _mockAndExpect(address(oracle), abi.encodeCall(IOracle.finalize, (mockRequest, _newResponse)), abi.encode()); + + vm.prank(address(oracle)); + circuitResolverModule.onDisputeStatusChange(_disputeId, mockRequest, mockResponse, mockDispute); + } } diff --git a/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol b/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol index fa3e3ebe..1e45d71b 100644 --- a/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol +++ b/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol @@ -88,6 +88,32 @@ contract ContractCallRequestModule_Unit_ModuleData is BaseTest { } } +contract ContractCallRequestModule_Unit_CreateRequest is BaseTest { + function test_createRequest( + address _requester, + IContractCallRequestModule.RequestParameters memory _params + ) public assumeFuzzable(_requester) { + mockRequest.requestModuleData = abi.encode(_params); + mockRequest.requester = _requester; + + // Mock and expect the bond to be placed + _mockAndExpect( + address(_params.accountingExtension), + abi.encodeWithSignature( + 'bond(address,bytes32,address,uint256)', + _requester, + _getId(mockRequest), + _params.paymentToken, + _params.paymentAmount + ), + abi.encode() + ); + + vm.prank(address(oracle)); + contractCallRequestModule.createRequest(_getId(mockRequest), mockRequest.requestModuleData, _requester); + } +} + contract ContractCallRequestModule_Unit_FinalizeRequest is BaseTest { /** * @notice Test that finalizeRequest calls: diff --git a/solidity/test/unit/modules/resolution/ERC20ResolutionModule.t.sol b/solidity/test/unit/modules/resolution/ERC20ResolutionModule.t.sol index 86c1fa9e..efad0e86 100644 --- a/solidity/test/unit/modules/resolution/ERC20ResolutionModule.t.sol +++ b/solidity/test/unit/modules/resolution/ERC20ResolutionModule.t.sol @@ -292,6 +292,17 @@ contract ERC20ResolutionModule_Unit_ResolveDispute is BaseTest { // Warp to resolving phase vm.warp(150_000); + // Mock and expect IOracle.disputeStatus to be called + _mockAndExpect( + address(oracle), abi.encodeCall(IOracle.disputeStatus, (_disputeId)), abi.encode(IOracle.DisputeStatus.Won) + ); + + // Check: does it revert if the dispute status is != Escalated? + vm.expectRevert(IERC20ResolutionModule.ERC20ResolutionModule_AlreadyResolved.selector); + vm.prank(address(oracle)); + module.resolveDispute(_disputeId, mockRequest, mockResponse, mockDispute); + + // Mock and expect IOracle.disputeStatus to be called _mockAndExpect( address(oracle), abi.encodeCall(IOracle.disputeStatus, (_disputeId)), abi.encode(IOracle.DisputeStatus.Escalated) ); diff --git a/solidity/test/unit/modules/resolution/PrivateERC20ResolutionModule.t.sol b/solidity/test/unit/modules/resolution/PrivateERC20ResolutionModule.t.sol index edb927bb..129ce78f 100644 --- a/solidity/test/unit/modules/resolution/PrivateERC20ResolutionModule.t.sol +++ b/solidity/test/unit/modules/resolution/PrivateERC20ResolutionModule.t.sol @@ -500,6 +500,16 @@ contract PrivateERC20ResolutionModule_Unit_ResolveDispute is BaseTest { // Warp to resolving phase vm.warp(190_000); + // Mock and expect IOracle.disputeStatus to be called + _mockAndExpect( + address(oracle), abi.encodeCall(IOracle.disputeStatus, (_disputeId)), abi.encode(IOracle.DisputeStatus.Won) + ); + + // Check: does it revert if the dispute status is != None? + vm.expectRevert(IPrivateERC20ResolutionModule.PrivateERC20ResolutionModule_AlreadyResolved.selector); + vm.prank(address(oracle)); + module.resolveDispute(_disputeId, mockRequest, mockResponse, mockDispute); + // Mock and expect token transfers (should happen always) for (uint256 _i = 1; _i <= _votersAmount;) { _mockAndExpect(address(token), abi.encodeCall(IERC20.transfer, (vm.addr(_i), 100)), abi.encode()); @@ -519,6 +529,11 @@ contract PrivateERC20ResolutionModule_Unit_ResolveDispute is BaseTest { abi.encode() ); + // Mock and expect IOracle.disputeStatus to be called + _mockAndExpect( + address(oracle), abi.encodeCall(IOracle.disputeStatus, (_disputeId)), abi.encode(IOracle.DisputeStatus.None) + ); + // Check: is the event emitted? vm.expectEmit(true, true, true, true); emit DisputeResolved(_requestId, _disputeId, _newStatus); From db3a18a6c98c7bbbff938de85c0290ee319919f8 Mon Sep 17 00:00:00 2001 From: moebius <0xmoebius@tutanota.com> Date: Mon, 11 Dec 2023 08:19:28 -0300 Subject: [PATCH 02/12] test: push changes to remote for review --- .../modules/resolution/BondEscalationResolutionModule.t.sol | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol index 777530ee..baf9f54e 100644 --- a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol +++ b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol @@ -664,7 +664,7 @@ contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { // // Set all data // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timestamp); + // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timesftamp); // // Mock and expect IBondEscalationAccounting.pledge to be called // _mockAndExpect( From a1c00d147f31b01ec06f5d962b5d3d3ae8feb457 Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:45:54 +0400 Subject: [PATCH 03/12] test: fuzzing issue --- .../test/unit/modules/request/ContractCallRequestModule.t.sol | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol b/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol index 1e45d71b..b41eddd6 100644 --- a/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol +++ b/solidity/test/unit/modules/request/ContractCallRequestModule.t.sol @@ -92,7 +92,7 @@ contract ContractCallRequestModule_Unit_CreateRequest is BaseTest { function test_createRequest( address _requester, IContractCallRequestModule.RequestParameters memory _params - ) public assumeFuzzable(_requester) { + ) public assumeFuzzable(_requester) assumeFuzzable(address(_params.accountingExtension)) { mockRequest.requestModuleData = abi.encode(_params); mockRequest.requester = _requester; From dca8de505b60ba239bc363253332288a89d79c6e Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:46:35 +0400 Subject: [PATCH 04/12] test: uncomment an assertion --- .../test/unit/modules/dispute/BondEscalationModule.t.sol | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/solidity/test/unit/modules/dispute/BondEscalationModule.t.sol b/solidity/test/unit/modules/dispute/BondEscalationModule.t.sol index 6fc20612..48f45b69 100644 --- a/solidity/test/unit/modules/dispute/BondEscalationModule.t.sol +++ b/solidity/test/unit/modules/dispute/BondEscalationModule.t.sol @@ -698,9 +698,8 @@ contract BondEscalationModule_Unit_OnDisputeStatusChange is BaseTest { ); // Check: is the event emitted? - // TODO: fix event emission in module - // vm.expectEmit(true, true, true, true, address(bondEscalationModule)); - // emit DisputeStatusChanged(_disputeId, mockDispute, IOracle.DisputeStatus.Won); + vm.expectEmit(true, true, true, true, address(bondEscalationModule)); + emit DisputeStatusChanged(_disputeId, mockDispute, IOracle.DisputeStatus.Won); vm.prank(address(oracle)); bondEscalationModule.onDisputeStatusChange(_disputeId, mockRequest, mockResponse, mockDispute); From a345956b262c3f6932091f1e4bd8a1b7a00d73c9 Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Mon, 11 Dec 2023 17:48:04 +0400 Subject: [PATCH 05/12] test: uncomment and refactor `pledgeForDispute` tests --- .../BondEscalationResolutionModule.t.sol | 296 ++++++++++-------- 1 file changed, 161 insertions(+), 135 deletions(-) diff --git a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol index baf9f54e..2373ca7c 100644 --- a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol +++ b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol @@ -112,7 +112,7 @@ contract BaseTest is Test, Helpers { /** * @notice Deploy the target and mock oracle+accounting extension */ - function setUp() public { + function setUp() public virtual { oracle = IOracle(makeAddr('Oracle')); vm.etch(address(oracle), hex'069420'); @@ -219,6 +219,40 @@ contract BondEscalationResolutionModule_Unit_StartResolution is BaseTest { } contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { + uint256 _percentageDiff = 20; + uint256 _timeUntilDeadline = 1001; + + // block.timestamp < _inequalityData.time + _timeToBreakInequality + uint256 _timeToBreakInequality = 5000; + uint128 _startTime; + + bytes32 _disputeId; + bytes32 _requestId; + + function setUp() public override { + super.setUp(); + + // Start at a later time to be able to travel back + vm.warp(block.timestamp + _timeToBreakInequality + 1); + + // block.timestamp < _startTime + _timeUntilDeadline + _startTime = uint128(block.timestamp - 1000); + + mockRequest.resolutionModuleData = abi.encode( + IBondEscalationResolutionModule.RequestParameters({ + accountingExtension: accounting, + bondToken: token, + percentageDiff: _percentageDiff, + pledgeThreshold: 1, + timeUntilDeadline: _timeUntilDeadline, + timeToBreakInequality: _timeToBreakInequality + }) + ); + + _disputeId = _getId(mockDispute); + _requestId = mockDispute.requestId; + } + function test_reverts( uint256 _pledgeAmount, IBondEscalationResolutionModule.RequestParameters memory _params @@ -226,9 +260,9 @@ contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { /////////////////////////////////////////////////////// BondEscalationResolutionModule_NotEscalated mockRequest.resolutionModuleData = abi.encode(_params); - bytes32 _requestId = _getId(mockRequest); + _requestId = _getId(mockRequest); mockDispute.requestId = _requestId; - bytes32 _disputeId = _getId(mockDispute); + _disputeId = _getId(mockDispute); // Mock escalation with start time 0 module.forTest_setEscalation(_disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, 0, 0, 0); @@ -303,10 +337,6 @@ contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { vm.assume(_pledgeAmount < type(uint256).max - 1000); IBondEscalationResolutionModule.Resolution _resolution = IBondEscalationResolutionModule.Resolution.Unresolved; - // block.timestamp < _startTime + _timeUntilDeadline - uint128 _startTime = uint128(block.timestamp - 1000); - _params.timeUntilDeadline = 1001; - // _pledgeThreshold > _updatedTotalVotes; uint256 _pledgesFor = 1000; uint256 _pledgesAgainst = 1000; @@ -314,19 +344,18 @@ contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { // block.timestamp < _inequalityData.time + _timeToBreakInequality _params.timeToBreakInequality = 5000; + _params.timeUntilDeadline = 1001; mockRequest.resolutionModuleData = abi.encode(_params); - bytes32 _requestId = _getId(mockRequest); + _requestId = _getId(mockRequest); mockDispute.requestId = _requestId; - bytes32 _disputeId = _getId(mockDispute); - - // assuming the threshold has not passed, this is the only valid state - IBondEscalationResolutionModule.InequalityStatus _inequalityStatus = - IBondEscalationResolutionModule.InequalityStatus.Equalized; + _disputeId = _getId(mockDispute); - // set all data + // Set all data module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timestamp); + module.forTest_setInequalityData( + _disputeId, IBondEscalationResolutionModule.InequalityStatus.Equalized, block.timestamp + ); // Mock and expect IBondEscalationAccounting.pledge to be called _mockAndExpect( @@ -355,147 +384,144 @@ contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); } - // TODO: Break this test into several smaller functions - // function test_percentageDifferences(bytes32 _requestId, bytes32 _disputeId, uint256 _pledgeAmount, IOracle.Request calldata _request) public { - // ////////////////////////////////////////////////////////////////////// - // // START TEST _forPercentageDifference >= _scaledPercentageDiffAsInt - // ////////////////////////////////////////////////////////////////////// - - // _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); - // IBondEscalationResolutionModule.Resolution _resolution = IBondEscalationResolutionModule.Resolution.Unresolved; - - // // block.timestamp < _startTime + _timeUntilDeadline - // uint128 _startTime = uint128(block.timestamp - 1000); - // uint256 _timeUntilDeadline = 1001; - - // // I'm setting the values so that the percentage diff is 20% in favor of pledgesFor. - // // In this case, _pledgeAmount will be the entirety of pledgesFor, as if it were the first pledge. - // // Therefore, _pledgeAmount must be 60% of total votes, _pledgesAgainst then should be 40% - // // 40 = 60 * 2 / 3 -> thats why I'm multiplying by 200 and dividing by 300 - // uint256 _pledgesFor = 0; - // uint256 _pledgesAgainst = _pledgeAmount * 200 / 300; - // uint256 _percentageDiff = 20; - - // // block.timestamp < _inequalityData.time + _timeToBreakInequality - // uint256 _timeToBreakInequality = 5000; - - // IBondEscalationResolutionModule.InequalityStatus _inequalityStatus = - // IBondEscalationResolutionModule.InequalityStatus.Equalized; - - // // Set all data - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timestamp); - - // // Mock and expect IBondEscalationAccounting.pledge to be called - // _mockAndExpect( - // address(accounting), - // abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerFor, _requestId, _disputeId, token, _pledgeAmount)), - // abi.encode() - // ); - - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); - - // vm.startPrank(pledgerFor); - // module.pledgeForDispute(_request, mockDispute, _pledgeAmount); - - // (,, uint256 _realPledgesFor,) = module.escalations(_disputeId); - // (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); - - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); - // // Check: is the pledge for dispute amount updated? - // assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize)); - // // Check: is the timer properly updated to current timestamp? - // assertEq(uint256(_timer), block.timestamp); + /** + * @notice Testing _forPercentageDifference >= _scaledPercentageDiffAsInt + */ + function test_changesStatusIfForSideIsWinning(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); - // //////////////////////////////////////////////////////////////////// - // // END TEST _forPercentageDifference >= _scaledPercentageDiffAsInt - // //////////////////////////////////////////////////////////////////// + // I'm setting the values so that the percentage diff is 20% in favor of pledgesFor. + // In this case, _pledgeAmount will be the entirety of pledgesFor, as if it were the first pledge. + // Therefore, _pledgeAmount must be 60% of total votes, _pledgesAgainst then should be 40% + // 40 = 60 * 2 / 3 -> thats why I'm multiplying by 200 and dividing by 300 + uint256 _pledgesFor = 0; + uint256 _pledgesAgainst = _pledgeAmount * 200 / 300; - // //----------------------------------------------------------------------// + // Set all data + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); + module.forTest_setInequalityData( + _disputeId, IBondEscalationResolutionModule.InequalityStatus.Equalized, block.timestamp + ); - // ////////////////////////////////////////////////////////////////////////// - // // START TEST _againstPercentageDifference >= _scaledPercentageDiffAsInt - // ///////////////////////////////////////////////////////////////////////// + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerFor, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); - // // Resetting status changed by previous test - // _inequalityStatus = IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize; - // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timestamp); - // module.forTest_setPledgesFor(_disputeId, pledgerFor, 0); + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); - // // Making the against percentage 60% of the total as percentageDiff is 20% - // // Note: I'm using 301 to account for rounding down errors. I'm also setting some _pledgesFor - // // to avoid the case when pledges are at 0 and someone just pledges 1 token - // // which is not realistic due to the pledgeThreshold forbidding the lines tested here - // // to be reached. - // _pledgesFor = 100_000; - // _pledgesAgainst = (_pledgeAmount + _pledgesFor) * 301 / 200; + vm.startPrank(pledgerFor); + module.pledgeForDispute(mockRequest, mockDispute, _pledgeAmount); - // // Resetting the pledges values - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); + (,, uint256 _realPledgesFor,) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); + // Check: is the pledge amount added to the total? + assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); + // Check: is the pledge for dispute amount updated? + assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize)); + // Check: is the timer properly updated to current timestamp? + assertEq(uint256(_timer), block.timestamp); + } - // module.pledgeForDispute(_request, mockDispute, _pledgeAmount); + /** + * @notice Testing _againstPercentageDifference >= _scaledPercentageDiffAsInt + */ + function test_changesStatusIfAgainstSideIsWinning(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); + + // Making the against percentage 60% of the total as percentageDiff is 20% + // Note: I'm using 301 to account for rounding down errors. I'm also setting some _pledgesFor + // to avoid the case when pledges are at 0 and someone just pledges 1 token + // which is not realistic due to the pledgeThreshold forbidding the lines tested here + // to be reached. + uint256 _pledgesFor = 100_000; + uint256 _pledgesAgainst = (_pledgeAmount + _pledgesFor) * 301 / 200; + + // Set the data + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); + module.forTest_setInequalityData( + _disputeId, IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize, block.timestamp + ); - // (,, _realPledgesFor,) = module.escalations(_disputeId); - // (_status, _timer) = module.inequalityData(_disputeId); + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerFor, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); - // // Check: is the pledges for amount updated? - // assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize)); + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); - // //////////////////////////////////////////////////////////////////// - // // END TEST _forPercentageDifference >= _scaledPercentageDiffAsInt - // //////////////////////////////////////////////////////////////////// + vm.prank(pledgerFor); + module.pledgeForDispute(mockRequest, mockDispute, _pledgeAmount); - // //----------------------------------------------------------------------// + (,, uint256 _realPledgesFor,) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); - // ////////////////////////////////////////////////////////////////////////// - // // START TEST _status == forTurnToEqualize && both diffs < percentageDiff - // ///////////////////////////////////////////////////////////////////////// + // Check: is the pledge amount added to the total? + assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); + // Check: is the pledges for amount updated? + assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize)); + // Check: is the timer properly updated to current timestamp? + assertEq(uint256(_timer), block.timestamp); + } - // // Resetting status changed by previous test - // module.forTest_setPledgesFor(_disputeId, pledgerFor, 0); + /** + * @notice Testing _status == forTurnToEqualize && both diffs < percentageDiff + */ + function test_changesStatusIfSidesAreEqual(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); - // // Making both the same so the percentage diff is not reached - // _pledgesFor = 100_000; - // _pledgesAgainst = (_pledgeAmount + _pledgesFor); + // Making both the same so the percentage diff is not reached + uint256 _pledgesFor = 100_000; + uint256 _pledgesAgainst = (_pledgeAmount + _pledgesFor); - // // Resetting the pledges values - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); + // Resetting the pledges values + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerFor, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); - // module.pledgeForDispute(_request, mockDispute, _pledgeAmount); + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedForDispute(pledgerFor, _requestId, _disputeId, _pledgeAmount); - // (,, _realPledgesFor,) = module.escalations(_disputeId); - // (_status, _timer) = module.inequalityData(_disputeId); + vm.prank(pledgerFor); + module.pledgeForDispute(mockRequest, mockDispute, _pledgeAmount); - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); - // // Check: is the pledges for amount updated? - // assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); - // // Check: is the timer reset? - // assertEq(_timer, 0); + (,, uint256 _realPledgesFor,) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); - // ////////////////////////////////////////////////////////////////////////// - // // END TEST _status == forTurnToEqualize && both diffs < percentageDiff - // ///////////////////////////////////////////////////////////////////////// - // } + // Check: is the pledge amount added to the total? + assertEq(_realPledgesFor, _pledgesFor + _pledgeAmount); + // Check: is the pledges for amount updated? + assertEq(module.pledgesForDispute(_disputeId, pledgerFor), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); + // Check: is the timer reset? + assertEq(_timer, 0); + } } contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { From 512e3d0a1a2164c873af70461a868aada09a3064 Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Mon, 11 Dec 2023 18:37:01 +0400 Subject: [PATCH 06/12] test: uncomment and refactor `pledgeAgainstDispute` tests --- .../BondEscalationResolutionModule.t.sol | 323 ++++++++++-------- 1 file changed, 177 insertions(+), 146 deletions(-) diff --git a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol index 2373ca7c..1552f038 100644 --- a/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol +++ b/solidity/test/unit/modules/resolution/BondEscalationResolutionModule.t.sol @@ -525,6 +525,40 @@ contract BondEscalationResolutionModule_Unit_PledgeForDispute is BaseTest { } contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { + uint256 _percentageDiff = 20; + uint256 _timeUntilDeadline = 1001; + + // block.timestamp < _inequalityData.time + _timeToBreakInequality + uint256 _timeToBreakInequality = 5000; + uint128 _startTime; + + bytes32 _disputeId; + bytes32 _requestId; + + function setUp() public override { + super.setUp(); + + // Start at a later time to be able to travel back + vm.warp(block.timestamp + _timeToBreakInequality + 1); + + // block.timestamp < _startTime + _timeUntilDeadline + _startTime = uint128(block.timestamp - 1000); + + mockRequest.resolutionModuleData = abi.encode( + IBondEscalationResolutionModule.RequestParameters({ + accountingExtension: accounting, + bondToken: token, + percentageDiff: _percentageDiff, + pledgeThreshold: 1, + timeUntilDeadline: _timeUntilDeadline, + timeToBreakInequality: _timeToBreakInequality + }) + ); + + _disputeId = _getId(mockDispute); + _requestId = mockDispute.requestId; + } + function test_reverts( uint256 _pledgeAmount, IBondEscalationResolutionModule.RequestParameters memory _params @@ -532,9 +566,9 @@ contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { /////////////////////////////////////////////////////// BondEscalationResolutionModule_NotEscalated mockRequest.resolutionModuleData = abi.encode(_params); - bytes32 _requestId = _getId(mockRequest); + _requestId = _getId(mockRequest); mockDispute.requestId = _requestId; - bytes32 _disputeId = _getId(mockDispute); + _disputeId = _getId(mockDispute); // Set mock escalation with no pledges and start time 0 module.forTest_setEscalation(_disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, 0, 0, 0); @@ -610,7 +644,7 @@ contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { IBondEscalationResolutionModule.Resolution _resolution = IBondEscalationResolutionModule.Resolution.Unresolved; // block.timestamp < _startTime + _timeUntilDeadline - uint128 _startTime = uint128(block.timestamp - 1000); + _startTime = uint128(block.timestamp - 1000); _params.timeUntilDeadline = 1001; // _pledgeThreshold > _updatedTotalVotes; @@ -622,9 +656,9 @@ contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { _params.timeToBreakInequality = 5000; mockRequest.resolutionModuleData = abi.encode(_params); - bytes32 _requestId = _getId(mockRequest); + _requestId = _getId(mockRequest); mockDispute.requestId = _requestId; - bytes32 _disputeId = _getId(mockDispute); + _disputeId = _getId(mockDispute); // Assuming the threshold has not passed, this is the only valid state IBondEscalationResolutionModule.InequalityStatus _inequalityStatus = @@ -661,147 +695,144 @@ contract BondEscalationResolutionModule_Unit_PledgeAgainstDispute is BaseTest { assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); } - // TODO: Break this test into several smaller functions - // function test_percentageDifferences(bytes32 _requestId, bytes32 _disputeId, uint256 _pledgeAmount, IOracle.Request calldata _request) public { - // _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); - // IBondEscalationResolutionModule.Resolution _resolution = IBondEscalationResolutionModule.Resolution.Unresolved; - - // ////////////////////////////////////////////////////////////////////////// - // // START TEST _againstPercentageDifference >= _scaledPercentageDiffAsInt - // ///////////////////////////////////////////////////////////////////////// - - // // block.timestamp < _startTime + _timeUntilDeadline - // uint128 _startTime = uint128(block.timestamp - 1000); - // uint256 _timeUntilDeadline = 1001; - - // // I'm setting the values so that the percentage diff is 20% in favor of pledgesAgainst. - // // In this case, _pledgeAmount will be the entirety of pledgesAgainst, as if it were the first pledge. - // // Therefore, _pledgeAmount must be 60% of total votes, _pledgesFor then should be 40% - // // 40 = 60 * 2 / 3 -> thats why I'm multiplying by 200 and dividing by 300 - // uint256 _pledgesAgainst = 0; - // uint256 _pledgesFor = _pledgeAmount * 200 / 300; - // uint256 _percentageDiff = 20; - - // // block.timestamp < _inequalityData.time + _timeToBreakInequality - // uint256 _timeToBreakInequality = 5000; - - // IBondEscalationResolutionModule.InequalityStatus _inequalityStatus = - // IBondEscalationResolutionModule.InequalityStatus.Equalized; - - // // Set all data - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timesftamp); - - // // Mock and expect IBondEscalationAccounting.pledge to be called - // _mockAndExpect( - // address(accounting), - // abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerAgainst, _requestId, _disputeId, token, _pledgeAmount)), - // abi.encode() - // ); - - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); - - // vm.startPrank(pledgerAgainst); - // module.pledgeAgainstDispute(_request, mockDispute, _pledgeAmount); - - // (,,, uint256 _realPledgesAgainst) = module.escalations(_disputeId); - // (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); - - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); - // // Check: is the pledges against amount updated? - // assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize)); - // // Check: is the timer properly updated? - // assertEq(uint256(_timer), block.timestamp); - - // /////////////////////////////////////////////////////////////////////// - // // END TEST _againstPercentageDifference >= _scaledPercentageDiffAsInt - // /////////////////////////////////////////////////////////////////////// - - // //----------------------------------------------------------------------// - - // ////////////////////////////////////////////////////////////////////////// - // // START TEST _forPercentageDifference >= _scaledPercentageDiffAsInt - // ///////////////////////////////////////////////////////////////////////// - - // // Resetting status changed by previous test - // _inequalityStatus = IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize; - // module.forTest_setInequalityData(_disputeId, _inequalityStatus, block.timestamp); - // module.forTest_setPledgesAgainst(_disputeId, pledgerAgainst, 0); - - // // Making the for percentage 60% of the total as percentageDiff is 20% - // // Note: I'm using 301 to account for rounding down errors. I'm also setting some _pledgesAgainst - // // to avoid the case when pledges are at 0 and someone just pledges 1 token - // // which is not realistic due to the pledgeThreshold forbidding the lines tested here - // // to be reached. - // _pledgesAgainst = 100_000; - // _pledgesFor = (_pledgeAmount + _pledgesAgainst) * 301 / 200; - - // // Resetting the pledges values - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); - - // module.pledgeAgainstDispute(_request, mockDispute, _pledgeAmount); - - // (,,, _realPledgesAgainst) = module.escalations(_disputeId); - // (_status, _timer) = module.inequalityData(_disputeId); - - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); - // // Check: is the pledges against amount updated? - // assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize)); - - // //////////////////////////////////////////////////////////////////// - // // END TEST _forPercentageDifference >= _scaledPercentageDiffAsInt - // //////////////////////////////////////////////////////////////////// - - // //----------------------------------------------------------------------// - - // ////////////////////////////////////////////////////////////////////////// - // // START TEST _status == forTurnToEqualize && both diffs < percentageDiff - // ///////////////////////////////////////////////////////////////////////// - - // // Resetting status changed by previous test - // module.forTest_setPledgesAgainst(_disputeId, pledgerAgainst, 0); - - // // Making both the same so the percentage diff is not reached - // _pledgesAgainst = 100_000; - // _pledgesFor = (_pledgeAmount + _pledgesAgainst); - - // // Resetting the pledges values - // module.forTest_setEscalation(_disputeId, _resolution, _startTime, _pledgesFor, _pledgesAgainst); - - // // Check: is the event emitted? - // vm.expectEmit(true, true, true, true, address(module)); - // emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); - - // module.pledgeAgainstDispute(_request, mockDispute, _pledgeAmount); - - // (,,, _realPledgesAgainst) = module.escalations(_disputeId); - // (_status, _timer) = module.inequalityData(_disputeId); - - // // Check: is the pledge amount added to the total? - // assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); - // // Check: is the pledges against amount updated? - // assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); - // // Check: is the status properly updated? - // assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); - // // Check: is the timer properly reset? - // assertEq(_timer, 0); - - // ////////////////////////////////////////////////////////////////////////// - // // END TEST _status == forTurnToEqualize && both diffs < percentageDiff - // ///////////////////////////////////////////////////////////////////////// - // } + /** + * @notice Testing _againstPercentageDifference >= _scaledPercentageDiffAsInt + */ + function test_changesStatusIfAgainstSideIsWinning(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); + + // I'm setting the values so that the percentage diff is 20% in favor of pledgesAgainst. + // In this case, _pledgeAmount will be the entirety of pledgesAgainst, as if it were the first pledge. + // Therefore, _pledgeAmount must be 60% of total votes, _pledgesFor then should be 40% + // 40 = 60 * 2 / 3 -> thats why I'm multiplying by 200 and dividing by 300 + uint256 _pledgesAgainst = 0; + uint256 _pledgesFor = _pledgeAmount * 200 / 300; + + // Set all data + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); + module.forTest_setInequalityData( + _disputeId, IBondEscalationResolutionModule.InequalityStatus.Equalized, block.timestamp + ); + + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerAgainst, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); + + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); + + vm.startPrank(pledgerAgainst); + module.pledgeAgainstDispute(mockRequest, mockDispute, _pledgeAmount); + + (,,, uint256 _realPledgesAgainst) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); + + // Check: is the pledge amount added to the total? + assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); + // Check: is the pledges against amount updated? + assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.ForTurnToEqualize)); + // Check: is the timer properly updated? + assertEq(uint256(_timer), block.timestamp); + } + + /** + * @notice Testing _forPercentageDifference >= _scaledPercentageDiffAsInt + */ + function test_changesStatusIfForSideIsWinning(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); + + // Making the against percentage 60% of the total as percentageDiff is 20% + // Note: I'm using 301 to account for rounding down errors. I'm also setting some _pledgesFor + // to avoid the case when pledges are at 0 and someone just pledges 1 token + // which is not realistic due to the pledgeThreshold forbidding the lines tested here + // to be reached. + uint256 _pledgesAgainst = 100_000; + uint256 _pledgesFor = (_pledgeAmount + _pledgesAgainst) * 301 / 200; + + // Set the data + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); + module.forTest_setInequalityData( + _disputeId, IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize, block.timestamp + ); + + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerAgainst, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); + + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); + + vm.prank(pledgerAgainst); + module.pledgeAgainstDispute(mockRequest, mockDispute, _pledgeAmount); + + (,,, uint256 _realPledgesAgainst) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); + + // Check: is the pledge amount added to the total? + assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); + // Check: is the pledges against amount updated? + assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.AgainstTurnToEqualize)); + // // Check: is the timer properly updated? + assertEq(uint256(_timer), block.timestamp); + } + + /** + * @notice Testing _status == forTurnToEqualize && both diffs < percentageDiff + */ + function test_changesStatusIfSidesAreEqual(uint256 _pledgeAmount) public { + _pledgeAmount = bound(_pledgeAmount, 1, type(uint192).max); + + // Making both the same so the percentage diff is not reached + uint256 _pledgesAgainst = 100_000; + uint256 _pledgesFor = (_pledgeAmount + _pledgesAgainst); + + // Resetting the pledges values + module.forTest_setEscalation( + _disputeId, IBondEscalationResolutionModule.Resolution.Unresolved, _startTime, _pledgesFor, _pledgesAgainst + ); + + // Mock and expect IBondEscalationAccounting.pledge to be called + _mockAndExpect( + address(accounting), + abi.encodeCall(IBondEscalationAccounting.pledge, (pledgerAgainst, _requestId, _disputeId, token, _pledgeAmount)), + abi.encode() + ); + + // Check: is the event emitted? + vm.expectEmit(true, true, true, true, address(module)); + emit PledgedAgainstDispute(pledgerAgainst, _requestId, _disputeId, _pledgeAmount); + + vm.prank(pledgerAgainst); + module.pledgeAgainstDispute(mockRequest, mockDispute, _pledgeAmount); + + (,, uint256 _realPledgesAgainst,) = module.escalations(_disputeId); + (IBondEscalationResolutionModule.InequalityStatus _status, uint256 _timer) = module.inequalityData(_disputeId); + + // Check: is the pledge amount added to the total? + assertEq(_realPledgesAgainst, _pledgesAgainst + _pledgeAmount); + // Check: is the pledges against amount updated? + assertEq(module.pledgesAgainstDispute(_disputeId, pledgerAgainst), _pledgeAmount); + // Check: is the status properly updated? + assertEq(uint256(_status), uint256(IBondEscalationResolutionModule.InequalityStatus.Equalized)); + // Check: is the timer properly reset? + assertEq(_timer, 0); + } } contract BondEscalationResolutionModule_Unit_ResolveDispute is BaseTest { From 5e09c11e2f0fc47c2efa54271544a7d3df71484d Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Mon, 11 Dec 2023 18:44:42 +0400 Subject: [PATCH 07/12] refactor: move IWETH interface to testing utils --- docs/src/SUMMARY.md | 2 - solidity/test/integration/IntegrationBase.sol | 2 +- solidity/test/invariant/InvariantsTest.t.sol | 182 ----- solidity/test/invariant/imports/WETH9.sol | 758 ------------------ .../dispute/BondEscalationAccounting.t.sol | 3 - .../utils}/external/IWETH9.sol | 0 6 files changed, 1 insertion(+), 946 deletions(-) delete mode 100644 solidity/test/invariant/InvariantsTest.t.sol delete mode 100644 solidity/test/invariant/imports/WETH9.sol rename solidity/{interfaces => test/utils}/external/IWETH9.sol (100%) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index ab9db97b..93d54b4c 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -71,8 +71,6 @@ - [❱ extensions](solidity/interfaces/extensions/README.md) - [IAccountingExtension](solidity/interfaces/extensions/IAccountingExtension.sol/interface.IAccountingExtension.md) - [IBondEscalationAccounting](solidity/interfaces/extensions/IBondEscalationAccounting.sol/interface.IBondEscalationAccounting.md) - - [❱ external](solidity/interfaces/external/README.md) - - [IWETH9](solidity/interfaces/external/IWETH9.sol/interface.IWETH9.md) - [❱ modules](solidity/interfaces/modules/README.md) - [❱ dispute](solidity/interfaces/modules/dispute/README.md) - [IBondEscalationModule](solidity/interfaces/modules/dispute/IBondEscalationModule.sol/interface.IBondEscalationModule.md) diff --git a/solidity/test/integration/IntegrationBase.sol b/solidity/test/integration/IntegrationBase.sol index 26f713cc..967b523e 100644 --- a/solidity/test/integration/IntegrationBase.sol +++ b/solidity/test/integration/IntegrationBase.sol @@ -19,7 +19,7 @@ import {IResolutionModule} from import {IFinalityModule} from '@defi-wonderland/prophet-core-contracts/solidity/interfaces/modules/finality/IFinalityModule.sol'; -import {IWETH9} from '../../interfaces/external/IWETH9.sol'; +import {IWETH9} from '../utils/external/IWETH9.sol'; import {HttpRequestModule, IHttpRequestModule} from '../../contracts/modules/request/HttpRequestModule.sol'; import {BondedResponseModule, IBondedResponseModule} from '../../contracts/modules/response/BondedResponseModule.sol'; diff --git a/solidity/test/invariant/InvariantsTest.t.sol b/solidity/test/invariant/InvariantsTest.t.sol deleted file mode 100644 index 1b342dd4..00000000 --- a/solidity/test/invariant/InvariantsTest.t.sol +++ /dev/null @@ -1,182 +0,0 @@ -// // SPDX-License-Identifier: AGPL-3.0-only -// pragma solidity ^0.8.19; - -// import 'forge-std/Test.sol'; - -// import {IERC20} from '@openzeppelin/contracts/token/ERC20/IERC20.sol'; -// import {Oracle, IOracle} from '@defi-wonderland/prophet-core-contracts/solidity/contracts/Oracle.sol'; -// import {IFinalityModule} from -// '@defi-wonderland/prophet-core-contracts/solidity/interfaces/modules/finality/IFinalityModule.sol'; - -// import {HttpRequestModule} from '../../contracts/modules/request/HttpRequestModule.sol'; -// import {BondedResponseModule} from '../../contracts/modules/response/BondedResponseModule.sol'; -// import {BondedDisputeModule} from '../../contracts/modules/dispute/BondedDisputeModule.sol'; -// import {BondEscalationResolutionModule} from '../../contracts/modules/resolution/BondEscalationResolutionModule.sol'; -// import {AccountingExtension} from '../../contracts/extensions/AccountingExtension.sol'; -// import {BondEscalationAccounting} from '../../contracts/extensions/BondEscalationAccounting.sol'; - -// import {IWETH9} from '../../interfaces/external/IWETH9.sol'; -// import {WETH9} from './imports/WETH9.sol'; - -// /** -// * @title Invariant tests -// */ -// contract InvariantsTest is Test { -// using stdStorage for StdStorage; - -// Oracle public oracle; -// HandlerProphet public handler; - -// function setUp() public { -// oracle = new Oracle(); -// handler = new HandlerProphet(oracle); - -// targetContract(address(handler)); -// } -// } - -// contract HandlerProphet is Test { -// Oracle public oracle; - -// HttpRequestModule public httpRequestModule; -// BondedResponseModule public bondedResponseModule; -// BondedDisputeModule public bondedDisputeModule; -// BondEscalationResolutionModule public bondEscalationResolutionModule; - -// AccountingExtension public accountingExtension; -// BondEscalationAccounting public bondEscalationAccounting; - -// IWETH9 public weth; - -// bytes32 public requestId; - -// mapping(bytes32 response => bytes32 request) public ghostResponseIdToRequestId; -// bool public responseRequestDiscrepancy; - -// mapping(bytes32 request => bool) public finalized; -// bool public finalizedDiscrepancy; - -// uint256 public ghostNumberOfDispute; -// uint256 public ghostNumberOfResponse; -// uint256 public ghostNumberOfRequest; - -// mapping(uint256 => bytes32) public ghostDisputeToResponseId; - -// constructor(Oracle _oracle) { -// oracle = _oracle; - -// httpRequestModule = new HttpRequestModule(oracle); -// bondedResponseModule = new BondedResponseModule(oracle); -// bondedDisputeModule = new BondedDisputeModule(oracle); -// bondEscalationResolutionModule = new BondEscalationResolutionModule(oracle); - -// weth = IWETH9(address(new WETH9())); -// accountingExtension = new AccountingExtension(oracle); - -// requestId = _createRequest(1 ether, 1 ether); // TODO: fuzz payment amount -// } - -// ///////////////////////////////////////////////////////////////////// -// // Test helpers // -// ///////////////////////////////////////////////////////////////////// - -// function _createRequest(uint256 _payment, uint256 _bondedAmount) internal returns (bytes32 _requestId) { -// bytes memory _httpRequestModuleData = abi.encode('_url', '_method', '_body', accountingExtension, weth, _payment); -// bytes memory _bondedResponseModuleData = -// abi.encode(accountingExtension, weth, _bondedAmount, block.timestamp + 1 days); -// bytes memory _bondedDisputeModuleData = abi.encode(accountingExtension, weth, _bondedAmount); - -// // TODO: fuzz? not too constrained? -// uint256 _percentageDiff = 10; -// uint256 _pledgeThreshold = 100; -// uint256 _timeUntilDeadline = 1 days; -// uint256 _timeToBreakInequality = 1 days; - -// bytes memory _bondEscalationResolutionModuleData = abi.encode( -// accountingExtension, weth, _percentageDiff, _pledgeThreshold, _timeUntilDeadline, _timeToBreakInequality -// ); - -// vm.deal(address(this), _bondedAmount); -// weth.deposit{value: msg.value}(); -// accountingExtension.deposit(IERC20(address(weth)), _bondedAmount); - -// IOracle.NewRequest memory _request = IOracle.NewRequest({ -// requestModuleData: _httpRequestModuleData, -// responseModuleData: _bondedResponseModuleData, -// disputeModuleData: _bondedDisputeModuleData, -// resolutionModuleData: _bondEscalationResolutionModuleData, -// finalityModuleData: '', -// ipfsHash: bytes32(''), -// requestModule: httpRequestModule, -// responseModule: bondedResponseModule, -// disputeModule: bondedDisputeModule, -// resolutionModule: bondEscalationResolutionModule, -// finalityModule: IFinalityModule(address(0)) -// }); - -// return oracle.createRequest(_request); -// } - -// ///////////////////////////////////////////////////////////////////// -// // Original logic handling // -// ///////////////////////////////////////////////////////////////////// - -// function createRequest(IOracle.NewRequest memory _request) public { -// oracle.createRequest(_request); -// ghostNumberOfRequest++; -// } - -// function proposeResponse(bytes calldata _responseData) external { -// bytes32 _responseId = oracle.proposeResponse(msg.sender, requestId, _responseData); -// // This request has already a response which is different? -// if (ghostResponseIdToRequestId[_responseId] != bytes32(0) && ghostResponseIdToRequestId[_responseId] != requestId) { -// responseRequestDiscrepancy = true; -// } - -// ghostResponseIdToRequestId[_responseId] = requestId; - -// ghostNumberOfResponse++; -// } - -// function proposeResponse(address _proposer, bytes calldata _responseData) external { -// bytes32 _responseId = oracle.proposeResponse(_proposer, requestId, _responseData); - -// // This request has already a response which is different? -// if (ghostResponseIdToRequestId[_responseId] != bytes32(0) && ghostResponseIdToRequestId[_responseId] != requestId) { -// responseRequestDiscrepancy = true; -// } - -// ghostResponseIdToRequestId[_responseId] = requestId; - -// ghostNumberOfResponse++; -// } - -// function disputeResponse(bytes32, /* _requestId */ bytes32 _responseId) external { -// oracle.disputeResponse(requestId, _responseId); - -// ghostDisputeToResponseId[ghostNumberOfDispute] = _responseId; -// ghostNumberOfDispute++; -// } - -// function escalateDispute(bytes32 _disputeId) external { -// oracle.escalateDispute(_disputeId); -// } - -// function resolveDispute(bytes32 _disputeId) external { -// oracle.resolveDispute(_disputeId); -// } - -// function updateDisputeStatus(bytes32 _disputeId, IOracle.DisputeStatus _status) external { -// oracle.updateDisputeStatus(_disputeId, _status); -// } - -// function finalize(bytes32 _requestId, bytes32 _finalizedResponseId) external { -// oracle.finalize(requestId, _finalizedResponseId); - -// if (!finalized[_requestId]) { -// finalized[_requestId] = true; -// } else { -// finalizedDiscrepancy = true; -// } -// } -// } diff --git a/solidity/test/invariant/imports/WETH9.sol b/solidity/test/invariant/imports/WETH9.sol deleted file mode 100644 index 7270ea2f..00000000 --- a/solidity/test/invariant/imports/WETH9.sol +++ /dev/null @@ -1,758 +0,0 @@ -/** - * Submitted for verification at Etherscan.io on 2017-12-12 - */ - -// Copyright (C) 2015, 2016, 2017 Dapphub - -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. - -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. - -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -pragma solidity 0.8.19; - -contract WETH9 { - string public name = 'Wrapped Ether'; - string public symbol = 'WETH'; - uint8 public decimals = 18; - - event Approval(address indexed src, address indexed guy, uint256 wad); - event Transfer(address indexed src, address indexed dst, uint256 wad); - event Deposit(address indexed dst, uint256 wad); - event Withdrawal(address indexed src, uint256 wad); - - mapping(address => uint256) public balanceOf; - mapping(address => mapping(address => uint256)) public allowance; - - fallback() external { - deposit(); - } - - function deposit() public payable { - balanceOf[msg.sender] += msg.value; - emit Deposit(msg.sender, msg.value); - } - - function withdraw(uint256 wad) public { - require(balanceOf[msg.sender] >= wad); - balanceOf[msg.sender] -= wad; - payable(msg.sender).transfer(wad); - emit Withdrawal(msg.sender, wad); - } - - function totalSupply() public view returns (uint256) { - return address(this).balance; - } - - function approve(address guy, uint256 wad) public returns (bool) { - allowance[msg.sender][guy] = wad; - emit Approval(msg.sender, guy, wad); - return true; - } - - function transfer(address dst, uint256 wad) public returns (bool) { - return transferFrom(msg.sender, dst, wad); - } - - function transferFrom(address src, address dst, uint256 wad) public returns (bool) { - require(balanceOf[src] >= wad); - - if (src != msg.sender && allowance[src][msg.sender] != type(uint256).max) { - require(allowance[src][msg.sender] >= wad); - allowance[src][msg.sender] -= wad; - } - - balanceOf[src] -= wad; - balanceOf[dst] += wad; - - emit Transfer(src, dst, wad); - - return true; - } -} - -/* - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. - -*/ diff --git a/solidity/test/unit/modules/dispute/BondEscalationAccounting.t.sol b/solidity/test/unit/modules/dispute/BondEscalationAccounting.t.sol index 4228770e..1165e5ce 100644 --- a/solidity/test/unit/modules/dispute/BondEscalationAccounting.t.sol +++ b/solidity/test/unit/modules/dispute/BondEscalationAccounting.t.sol @@ -13,7 +13,6 @@ import { } from '../../../../contracts/extensions/BondEscalationAccounting.sol'; import {IAccountingExtension} from '../../../../interfaces/extensions/IAccountingExtension.sol'; -import {IWETH9} from '../../../../interfaces/external/IWETH9.sol'; import {Strings} from '@openzeppelin/contracts/utils/Strings.sol'; @@ -62,8 +61,6 @@ contract BaseTest is Test, Helpers { ForTest_BondEscalationAccounting public bondEscalationAccounting; // A mock oracle IOracle public oracle; - // Mock WETH - IWETH9 public weth; // A mock token IERC20 public token; // Mock EOA bonder diff --git a/solidity/interfaces/external/IWETH9.sol b/solidity/test/utils/external/IWETH9.sol similarity index 100% rename from solidity/interfaces/external/IWETH9.sol rename to solidity/test/utils/external/IWETH9.sol From eab5725c18c5aab20298c786581e81a9b59ef1eb Mon Sep 17 00:00:00 2001 From: moebius <0xmoebius@tutanota.com> Date: Tue, 12 Dec 2023 14:31:14 -0300 Subject: [PATCH 08/12] test: test coverage for bonded response module --- solidity/test/integration/Finalization.t.sol | 7 ++- .../response/BondedResponseModule.t.sol | 46 +++++++++++++++---- 2 files changed, 41 insertions(+), 12 deletions(-) diff --git a/solidity/test/integration/Finalization.t.sol b/solidity/test/integration/Finalization.t.sol index a70c594a..d30124b9 100644 --- a/solidity/test/integration/Finalization.t.sol +++ b/solidity/test/integration/Finalization.t.sol @@ -152,8 +152,9 @@ contract Integration_Finalization is IntegrationBase { /** * @notice Test to check that finalizing a request with a ongoing dispute with revert. */ + //asdf function test_revertFinalizeInDisputeWindow(uint256 _block) public { - vm.assume(_block < _expectedDeadline + _baseDisputeWindow); + _block = bound(_block, block.number, _expectedDeadline - _baseDisputeWindow - 1); address _callbackTarget = makeAddr('target'); vm.etch(_callbackTarget, hex'069420'); @@ -179,9 +180,7 @@ contract Integration_Finalization is IntegrationBase { vm.roll(_block); vm.prank(_finalizer); - if (_block < _expectedDeadline + _baseDisputeWindow) { - vm.expectRevert(IBondedResponseModule.BondedResponseModule_TooEarlyToFinalize.selector); - } + vm.expectRevert(IBondedResponseModule.BondedResponseModule_TooEarlyToFinalize.selector); oracle.finalize(_request, _response); } /** diff --git a/solidity/test/unit/modules/response/BondedResponseModule.t.sol b/solidity/test/unit/modules/response/BondedResponseModule.t.sol index f402a180..a9465e90 100644 --- a/solidity/test/unit/modules/response/BondedResponseModule.t.sol +++ b/solidity/test/unit/modules/response/BondedResponseModule.t.sol @@ -178,19 +178,31 @@ contract BondedResponseModule_Unit_FinalizeRequest is BaseTest { } function test_revertsBeforeDeadline( - IERC20 _token, - uint256 _bondSize, + uint256 _responseCreationBlock, + uint256 _finalizationBlock, uint256 _deadline, - uint256 _disputeWindow, - address _proposer + uint256 _disputeWindow ) public { - _deadline = bound(_deadline, block.timestamp + 1, type(uint248).max); - _disputeWindow = bound(_disputeWindow, 61, 365 days); + // Amount of blocks to wait before finalizing a response + _disputeWindow = bound(_disputeWindow, 10, 90_000); + // Last block in which a response can be proposed + _deadline = bound(_deadline, 100_000, type(uint128).max); + // Block in which the response was proposed + _responseCreationBlock = bound(_responseCreationBlock, _deadline - _disputeWindow + 1, _deadline - 1); + // Block in which the request will be tried to be finalized + _finalizationBlock = bound(_finalizationBlock, _deadline, _responseCreationBlock + _disputeWindow - 1); // Check revert if deadline has not passed - mockRequest.responseModuleData = abi.encode(accounting, _token, _bondSize, _deadline, _disputeWindow); + mockRequest.responseModuleData = abi.encode( + IBondedResponseModule.RequestParameters({ + accountingExtension: accounting, + bondToken: IERC20(makeAddr('token')), + bondSize: 999_999, + deadline: _deadline, + disputeWindow: _disputeWindow + }) + ); mockResponse.requestId = _getId(mockRequest); - mockResponse.proposer = _proposer; // Mock and expect IOracle.allowedModule to be called _mockAndExpect( @@ -200,6 +212,24 @@ contract BondedResponseModule_Unit_FinalizeRequest is BaseTest { // Check: does it revert if it's too early to finalize? vm.expectRevert(IBondedResponseModule.BondedResponseModule_TooEarlyToFinalize.selector); + vm.roll(_deadline - 1); + vm.prank(address(oracle)); + bondedResponseModule.finalizeRequest(mockRequest, mockResponse, address(this)); + + // Mock and expect IOracle.allowedModule to be called + _mockAndExpect( + address(oracle), abi.encodeCall(IOracle.allowedModule, (_getId(mockRequest), address(this))), abi.encode(false) + ); + + // Mock and expect IOracle.allowedModule to be called + _mockAndExpect( + address(oracle), abi.encodeCall(IOracle.createdAt, (_getId(mockResponse))), abi.encode(_responseCreationBlock) + ); + + // Check: does it revert if it's too early to finalize? + vm.expectRevert(IBondedResponseModule.BondedResponseModule_TooEarlyToFinalize.selector); + + vm.roll(_finalizationBlock); vm.prank(address(oracle)); bondedResponseModule.finalizeRequest(mockRequest, mockResponse, address(this)); } From 9d49aae5a85090639afa4bc1186955aad3e0ed4b Mon Sep 17 00:00:00 2001 From: moebius <0xmoebius@protonmail.com> Date: Tue, 12 Dec 2023 14:40:20 -0300 Subject: [PATCH 09/12] fix: verify signature From 60a2286c5a6d677ecb1b7d0f1f6910018ec83070 Mon Sep 17 00:00:00 2001 From: moebius <0xmoebius@protonmail.com> Date: Tue, 12 Dec 2023 14:40:30 -0300 Subject: [PATCH 10/12] fix: verify signature From 62210189b7fc669dbdf0bbb7f4246084bbdebc83 Mon Sep 17 00:00:00 2001 From: moebius <132487952+0xmoebius@users.noreply.github.com> Date: Tue, 12 Dec 2023 14:50:47 -0300 Subject: [PATCH 11/12] Update solidity/test/unit/modules/response/BondedResponseModule.t.sol Co-authored-by: Gas <86567384+gas1cent@users.noreply.github.com> --- solidity/test/unit/modules/response/BondedResponseModule.t.sol | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solidity/test/unit/modules/response/BondedResponseModule.t.sol b/solidity/test/unit/modules/response/BondedResponseModule.t.sol index 65890302..c4e1364c 100644 --- a/solidity/test/unit/modules/response/BondedResponseModule.t.sol +++ b/solidity/test/unit/modules/response/BondedResponseModule.t.sol @@ -221,7 +221,7 @@ contract BondedResponseModule_Unit_FinalizeRequest is BaseTest { address(oracle), abi.encodeCall(IOracle.allowedModule, (_getId(mockRequest), address(this))), abi.encode(false) ); - // Mock and expect IOracle.allowedModule to be called + // Mock and expect IOracle.createdAt to be called _mockAndExpect( address(oracle), abi.encodeCall(IOracle.createdAt, (_getId(mockResponse))), abi.encode(_responseCreationBlock) ); From 12542f3573ae4c1d354017c3e0459b5e2dcbabaa Mon Sep 17 00:00:00 2001 From: moebius <132487952+0xmoebius@users.noreply.github.com> Date: Tue, 12 Dec 2023 14:51:10 -0300 Subject: [PATCH 12/12] Update solidity/test/integration/Finalization.t.sol Co-authored-by: Gas <86567384+gas1cent@users.noreply.github.com> --- solidity/test/integration/Finalization.t.sol | 1 - 1 file changed, 1 deletion(-) diff --git a/solidity/test/integration/Finalization.t.sol b/solidity/test/integration/Finalization.t.sol index d30124b9..93acc112 100644 --- a/solidity/test/integration/Finalization.t.sol +++ b/solidity/test/integration/Finalization.t.sol @@ -152,7 +152,6 @@ contract Integration_Finalization is IntegrationBase { /** * @notice Test to check that finalizing a request with a ongoing dispute with revert. */ - //asdf function test_revertFinalizeInDisputeWindow(uint256 _block) public { _block = bound(_block, block.number, _expectedDeadline - _baseDisputeWindow - 1); address _callbackTarget = makeAddr('target');