Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove SETTLE_TAKE_PAIR command #371

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Remove SETTLE_TAKE_PAIR command #371

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1b3323
Remove SETTLE_TAKE_PAIR command
hensha256 Oct 17, 2024
ae99834
merge main
hensha256 Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .forge-snapshots/Payments_swap_settleFromCaller_takeAllToMsgSender.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
129854
129945
2 changes: 1 addition & 1 deletion .forge-snapshots/Payments_swap_settleFromCaller_takeAllToSpecifiedAddress.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
131905
131859
2 changes: 1 addition & 1 deletion .forge-snapshots/Payments_swap_settleWithBalance_takeAllToMsgSender.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
124110
124064
2 changes: 1 addition & 1 deletion .forge-snapshots/Payments_swap_settleWithBalance_takeAllToSpecifiedAddress.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
124252
124206
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_Bytecode.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7148
7038
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn1Hop_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
115722
117315
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn1Hop_nativeOut.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
116043
117636
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn1Hop_oneForZero.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
124861
126454
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn1Hop_zeroForOne.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
130584
132177
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn2Hops.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
185439
186997
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn2Hops_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
170577
172135
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn3Hops.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
240297
241867
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactIn3Hops_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
225435
227005
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactInputSingle.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
129854
131412
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactInputSingle_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
114992
116550
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactInputSingle_nativeOut.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
115282
116840
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut1Hop_nativeIn_sweepETH.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
121985
123578
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut1Hop_nativeOut.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
117107
118700
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut1Hop_oneForZero.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
125925
127518
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut1Hop_zeroForOne.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
129870
131463
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut2Hops.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
183787
185345
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut2Hops_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
175902
177460
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut3Hops.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
237735
239305
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut3Hops_nativeIn.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
229850
231420
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOut3Hops_nativeOut.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
217090
218660
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOutputSingle.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
129140
130698
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOutputSingle_nativeIn_sweepETH.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
121255
122813
2 changes: 1 addition & 1 deletion .forge-snapshots/V4Router_ExactOutputSingle_nativeOut.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
116452
118010
7 changes: 1 addition & 6 deletions src/V4Router.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,7 @@ abstract contract V4Router is IV4Router, BaseActionsRouter, DeltaResolver {
return;
}
} else {
if (action == Actions.SETTLE_TAKE_PAIR) {
(Currency settleCurrency, Currency takeCurrency) = params.decodeCurrencyPair();
_settle(settleCurrency, msgSender(), _getFullDebt(settleCurrency));
_take(takeCurrency, msgSender(), _getFullCredit(takeCurrency));
return;
} else if (action == Actions.SETTLE_ALL) {
if (action == Actions.SETTLE_ALL) {
(Currency currency, uint256 maxAmount) = params.decodeCurrencyAndUint256();
uint256 amount = _getFullDebt(currency);
if (amount > maxAmount) revert V4TooMuchRequested(maxAmount, amount);
Expand Down
1 change: 0 additions & 1 deletion src/libraries/Actions.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ library Actions {
uint256 constant TAKE_PORTION = 0x14;
uint256 constant TAKE_PAIR = 0x15;

uint256 constant SETTLE_TAKE_PAIR = 0x16;
uint256 constant CLOSE_CURRENCY = 0x17;
uint256 constant CLEAR_OR_TAKE = 0x18;
uint256 constant SWEEP = 0x19;
Comment on lines 32 to 34
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the subsequent actions be shifted up to replace it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given we do a big renumbering in #384 i feel like it makes sense to do that there as we're merging that now too

Expand Down
3 changes: 2 additions & 1 deletion test/router/Payments.gas.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, 0, bytes(""));

plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));

bytes memory data = plan.encode();
router.executeActions(data);
Expand Down
35 changes: 4 additions & 31 deletions test/router/Payments.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,6 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
plan = Planner.init();
}

function test_settleTakePair() public {
uint256 amountIn = 1 ether;
uint256 expectedAmountOut = 992054607780215625;
IV4Router.ExactInputSingleParams memory params =
IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, 0, bytes(""));

plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));

uint256 inputBalanceBefore = key0.currency0.balanceOfSelf();
uint256 outputBalanceBefore = key0.currency1.balanceOfSelf();
// router is empty before
assertEq(currency0.balanceOf(address(router)), 0);
assertEq(currency1.balanceOf(address(router)), 0);

bytes memory data = plan.encode();
router.executeActions(data);

uint256 inputBalanceAfter = key0.currency0.balanceOfSelf();
uint256 outputBalanceAfter = key0.currency1.balanceOfSelf();

// router is empty
assertEq(currency0.balanceOf(address(router)), 0);
assertEq(currency1.balanceOf(address(router)), 0);
// caller's balance changed by input and output amounts
assertEq(inputBalanceBefore - inputBalanceAfter, amountIn);
assertEq(outputBalanceAfter - outputBalanceBefore, expectedAmountOut);
}

function test_exactIn_settleAll_revertsSlippage() public {
uint256 amountIn = 1 ether;
IV4Router.ExactInputSingleParams memory params =
Expand Down Expand Up @@ -172,9 +143,10 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, 0, bytes(""));

plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
// take 15 bips to Bob
plan = plan.add(Actions.TAKE_PORTION, abi.encode(key0.currency1, bob, 15));
plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));

uint256 inputBalanceBefore = key0.currency0.balanceOfSelf();
uint256 outputBalanceBefore = key0.currency1.balanceOfSelf();
Expand Down Expand Up @@ -208,9 +180,10 @@ contract PaymentsTests is RoutingTestHelpers, GasSnapshot {
IV4Router.ExactInputSingleParams(key0, true, uint128(amountIn), 0, 0, bytes(""));

plan = plan.add(Actions.SWAP_EXACT_IN_SINGLE, abi.encode(params));
plan = plan.add(Actions.SETTLE, abi.encode(key0.currency0, amountIn, true));
// bips is larger than maximum bips
plan = plan.add(Actions.TAKE_PORTION, abi.encode(key0.currency1, bob, BipsLibrary.BPS_DENOMINATOR + 1));
plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(key0.currency0, key0.currency1));
plan = plan.add(Actions.TAKE_ALL, abi.encode(key0.currency1, 0));

bytes memory data = plan.encode();

Expand Down
4 changes: 3 additions & 1 deletion test/shared/Planner.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,9 @@ library Planner {
returns (bytes memory)
{
if (takeRecipient == ActionConstants.MSG_SENDER) {
plan = plan.add(Actions.SETTLE_TAKE_PAIR, abi.encode(inputCurrency, outputCurrency));
// blindly settling and taking all, without slippage checks, isnt recommended in prod
plan = plan.add(Actions.SETTLE_ALL, abi.encode(inputCurrency, type(uint256).max));
plan = plan.add(Actions.TAKE_ALL, abi.encode(outputCurrency, 0));
} else {
plan = plan.add(Actions.SETTLE, abi.encode(inputCurrency, ActionConstants.OPEN_DELTA, true));
plan = plan.add(Actions.TAKE, abi.encode(outputCurrency, takeRecipient, ActionConstants.OPEN_DELTA));
Expand Down
Loading