-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: migrate GPv2Trade extractOrder tests to Foundry
- Loading branch information
Showing
3 changed files
with
140 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // SPDX-License-Identifier: LGPL-3.0-or-later | ||
| pragma solidity ^0.8; | ||
|
|
||
| import {GPv2Order, IERC20} from "src/contracts/libraries/GPv2Trade.sol"; | ||
| import {GPv2Signing} from "src/contracts/mixins/GPv2Signing.sol"; | ||
|
|
||
| import {Helper} from "./Helper.sol"; | ||
|
|
||
| import {Order as OrderLib} from "test/libraries/Order.sol"; | ||
| import {SettlementEncoder} from "test/libraries/encoders/SettlementEncoder.sol"; | ||
|
|
||
| contract ExtractOrder is Helper { | ||
| using SettlementEncoder for SettlementEncoder.State; | ||
|
|
||
| struct Fuzzed { | ||
| address sellToken; | ||
| address buyToken; | ||
| address receiver; | ||
| uint256 sellAmount; | ||
| uint256 buyAmount; | ||
| uint32 validTo; | ||
| bytes32 appData; | ||
| uint256 feeAmount; | ||
| uint256 executedAmount; | ||
| } | ||
|
|
||
| function sampleOrder() private returns (GPv2Order.Data memory order) { | ||
| order = GPv2Order.Data({ | ||
| sellToken: IERC20(makeAddr("GPv2Trade.ExtractOrder sampleOrder sell token")), | ||
| buyToken: IERC20(makeAddr("GPv2Trade.ExtractOrder sampleOrder buy token")), | ||
| receiver: makeAddr("GPv2Trade.ExtractOrder sampleOrder receiver"), | ||
| sellAmount: 42 ether, | ||
| buyAmount: 13.37 ether, | ||
| validTo: type(uint32).max, | ||
| appData: bytes32(0), | ||
| feeAmount: 1 ether, | ||
| kind: GPv2Order.KIND_SELL, | ||
| partiallyFillable: false, | ||
| sellTokenBalance: GPv2Order.BALANCE_ERC20, | ||
| buyTokenBalance: GPv2Order.BALANCE_ERC20 | ||
| }); | ||
| } | ||
|
|
||
| function assertSameOrder(GPv2Order.Data memory lhs, GPv2Order.Data memory rhs) private pure { | ||
| uint256 assertionCount = 12; | ||
| assertEq(address(lhs.sellToken), address(rhs.sellToken)); | ||
| assertEq(address(lhs.buyToken), address(rhs.buyToken)); | ||
| assertEq(lhs.receiver, rhs.receiver); | ||
| assertEq(lhs.sellAmount, rhs.sellAmount); | ||
| assertEq(lhs.buyAmount, rhs.buyAmount); | ||
| assertEq(lhs.validTo, rhs.validTo); | ||
| assertEq(lhs.appData, rhs.appData); | ||
| assertEq(lhs.feeAmount, rhs.feeAmount); | ||
| assertEq(lhs.kind, rhs.kind); | ||
| assertEq(lhs.partiallyFillable, rhs.partiallyFillable); | ||
| assertEq(lhs.sellTokenBalance, rhs.sellTokenBalance); | ||
| assertEq(lhs.buyTokenBalance, rhs.buyTokenBalance); | ||
| // We want to make sure that if we add new fields to `GPv2Order.Data` we | ||
| // don't forget to add the corresponding assertion. | ||
| // This only works because all fields are _not_ of dynamic length. | ||
| require(abi.encode(lhs).length == assertionCount * 32, "bad test setup when comparing two orders"); | ||
| } | ||
|
|
||
| function testFuzz_should_round_trip_encode_order_data(Fuzzed memory fuzzed) public { | ||
| OrderLib.Flags[] memory flags = OrderLib.ALL_FLAGS(); | ||
|
|
||
| for (uint256 i = 0; i < flags.length; i++) { | ||
| GPv2Order.Data memory order = GPv2Order.Data({ | ||
| sellToken: IERC20(fuzzed.sellToken), | ||
| buyToken: IERC20(fuzzed.buyToken), | ||
| receiver: fuzzed.receiver, | ||
| sellAmount: fuzzed.sellAmount, | ||
| buyAmount: fuzzed.buyAmount, | ||
| validTo: fuzzed.validTo, | ||
| appData: fuzzed.appData, | ||
| feeAmount: fuzzed.feeAmount, | ||
| kind: flags[i].kind, | ||
| partiallyFillable: flags[i].partiallyFillable, | ||
| sellTokenBalance: flags[i].sellTokenBalance, | ||
| buyTokenBalance: flags[i].buyTokenBalance | ||
| }); | ||
|
|
||
| SettlementEncoder.State storage encoder = SettlementEncoder.makeSettlementEncoder(); | ||
| encoder.signEncodeTrade( | ||
| vm, trader, order, domainSeparator, GPv2Signing.Scheme.Eip712, fuzzed.executedAmount | ||
| ); | ||
| GPv2Order.Data memory extractedOrder = executor.extractOrderTest(encoder.tokens(), encoder.trades[0]); | ||
| assertSameOrder(order, extractedOrder); | ||
| } | ||
| } | ||
|
|
||
| function should_revert_for_invalid_token_indices(GPv2Order.Data memory order, IERC20[] memory tokens) internal { | ||
| SettlementEncoder.State storage encoder = SettlementEncoder.makeSettlementEncoder(); | ||
| encoder.signEncodeTrade(vm, trader, order, domainSeparator, GPv2Signing.Scheme.Eip712, 0); | ||
| // TODO: once Foundry supports catching EVM errors, require that this | ||
| // reverts with "array out-of-bounds access". | ||
| // Track support at https://github.com/foundry-rs/foundry/issues/4012 | ||
| vm.expectRevert(); | ||
| executor.extractOrderTest(tokens, encoder.trades[0]); | ||
| } | ||
|
|
||
| function test_should_revert_for_invalid_sell_token_indices() public { | ||
| GPv2Order.Data memory order = sampleOrder(); | ||
| IERC20[] memory tokens = new IERC20[](1); | ||
| tokens[0] = order.buyToken; | ||
| should_revert_for_invalid_token_indices(order, tokens); | ||
| } | ||
|
|
||
| function test_should_revert_for_invalid_buy_token_indices() public { | ||
| GPv2Order.Data memory order = sampleOrder(); | ||
| IERC20[] memory tokens = new IERC20[](1); | ||
| tokens[0] = order.sellToken; | ||
| should_revert_for_invalid_token_indices(order, tokens); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // SPDX-License-Identifier: LGPL-3.0-or-later | ||
| pragma solidity ^0.8; | ||
|
|
||
| import {Test, Vm} from "forge-std/Test.sol"; | ||
|
|
||
| import {SettlementEncoder} from "test/libraries/encoders/SettlementEncoder.sol"; | ||
| import {GPv2TradeTestInterface} from "test/src/GPv2TradeTestInterface.sol"; | ||
|
|
||
| // TODO: move the content of `GPv2TradeTestInterface` here once all tests have been removed. | ||
| // solhint-disable-next-line no-empty-blocks | ||
| contract Harness is GPv2TradeTestInterface {} | ||
|
|
||
| contract Helper is Test { | ||
| Harness internal executor; | ||
| Vm.Wallet internal trader = vm.createWallet("GPv2Trade.Helper trader"); | ||
| bytes32 internal domainSeparator = keccak256("GPv2Trade.Helper domain separator"); | ||
| SettlementEncoder.State internal encoder; | ||
|
|
||
| function setUp() public { | ||
| executor = new Harness(); | ||
| encoder = SettlementEncoder.makeSettlementEncoder(); | ||
| } | ||
| } |