tycho-execution 0.302.5

Provides tools for encoding and executing swaps against Tycho router and protocol executors.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
pragma solidity ^0.8.26;

import "@src/Vault.sol";
import {TestUtils} from "./TestUtils.sol";
import {Constants} from "./Constants.sol";

contract VaultExposed is Vault {
    function setDelta(address token, int256 initialDelta) external {
        _setDelta(token, initialDelta);
    }

    function getDelta(address token) external view returns (int256 delta) {
        delta = _getDelta(token);
    }

    function getNonZeroDeltaCount() external view returns (uint256 count) {
        count = _getNonZeroDeltaCount();
    }

    function setNonZeroDeltaCount(uint256 count) external {
        _setNonZeroDeltaCount(count);
    }

    function updateDeltaAccounting(address token, int256 change) external {
        _updateDeltaAccounting(token, change);
    }

    function creditVault(address user, address token, uint256 amount) external {
        _creditVault(user, token, amount);
    }

    function debitVault(address user, address token, uint256 amount) external {
        _debitVault(user, token, amount);
    }

    function finalizeBalances(
        address user,
        address inputToken,
        uint256 inputAmount
    ) external {
        _finalizeBalances(user, inputToken, inputAmount);
    }

    function setUseVault(bool useVault) external {
        assembly {
            tstore(_USE_VAULT_SLOT, useVault)
        }
    }
}

contract VaultTest is Constants, TestUtils {
    VaultExposed public vault;

    function setUp() public {
        uint256 forkBlock = 24218176;
        vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
        vault = new VaultExposed();
    }

    function testDepositERC20() public {
        uint256 amount = 1_000_000_000;
        deal(USDC_ADDR, ALICE, amount);
        vm.startPrank(ALICE);
        IERC20(USDC_ADDR).approve(address(vault), amount);
        vault.deposit(USDC_ADDR, amount);

        assertEq(IERC20(USDC_ADDR).balanceOf(ALICE), 0);
        assertEq(IERC20(USDC_ADDR).balanceOf(address(vault)), amount);
        assertEq(vault.balanceOf(ALICE, uint256(uint160(USDC_ADDR))), amount);
    }

    function testDepositETH() public {
        uint256 amount = 1 ether;
        deal(ALICE, amount);
        uint256 balanceBefore = address(vault).balance;
        vm.startPrank(ALICE);
        vault.deposit{value: amount}(ETH_ADDR, amount);

        assertEq(ALICE.balance, 0);
        assertEq(address(vault).balance - balanceBefore, amount);
        assertEq(vault.balanceOf(ALICE, uint256(uint160(ETH_ADDR))), amount);
    }

    function testWithdrawERC20() public {
        uint256 amount = 1_000_000_000;
        deal(USDC_ADDR, ALICE, amount);
        vm.startPrank(ALICE);
        IERC20(USDC_ADDR).approve(address(vault), amount);
        vault.deposit(USDC_ADDR, amount);

        uint256 amountToWithdraw = amount / 2;
        vault.withdraw(USDC_ADDR, amountToWithdraw);
        assertEq(IERC20(USDC_ADDR).balanceOf(ALICE), amountToWithdraw);
        assertEq(IERC20(USDC_ADDR).balanceOf(address(vault)), amountToWithdraw);
        assertEq(
            vault.balanceOf(ALICE, uint256(uint160(USDC_ADDR))),
            amountToWithdraw
        );
    }

    function testWithdrawETH() public {
        address user = makeAddr("brand-new-user");
        uint256 amount = 1 ether;
        deal(user, amount);
        uint256 balanceBefore = address(vault).balance;
        vm.startPrank(user);
        vault.deposit{value: amount}(ETH_ADDR, amount);

        uint256 amountToWithdraw = amount / 2;
        vault.withdraw(ETH_ADDR, amountToWithdraw);

        assertEq(user.balance, amountToWithdraw);
        assertEq(address(vault).balance - balanceBefore, amountToWithdraw);
        assertEq(
            vault.balanceOf(user, uint256(uint160(ETH_ADDR))), amountToWithdraw
        );
    }

    function testUpdateDeltaIncreasePositiveToPositive() public {
        address token = address(0);
        int256 initialDelta = 100;
        int256 change = 200;
        uint256 nonZeroCountInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroCountInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, 100);
        assertEq(afterChange, 300);
        assertEq(nonZeroCount, 1);
    }

    function testUpdateDeltaIncreaseNegativeToNegative() public {
        address token = address(0);
        int256 initialDelta = -100;
        int256 change = 15;
        uint256 nonZeroDeltaInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroDeltaInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, -100);
        assertEq(afterChange, -85);
        assertEq(nonZeroCount, 1);
    }

    function testUpdateDeltaIncreaseNegativeToPositive() public {
        address token = address(0);
        int256 initialDelta = -100;
        int256 change = 200;
        uint256 nonZeroCountInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroCountInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, -100);
        assertEq(afterChange, 100);
        assertEq(nonZeroCount, 1);
    }

    function testUpdateDeltaDecreasePositiveToPositive() public {
        address token = address(0);
        int256 initialDelta = 300;
        int256 change = -100;
        uint256 nonZeroCountInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroCountInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, 300);
        assertEq(afterChange, 200);
        assertEq(nonZeroCount, 1);
    }

    function testUpdateDeltaPositiveToZero() public {
        address token = address(0);
        int256 initialDelta = 50;
        int256 change = -50;
        uint256 nonZeroCountInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroCountInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, 50);
        assertEq(afterChange, 0);
        assertEq(nonZeroCount, 0);
    }

    function testUpdateDeltaNegativeToZero() public {
        address token = address(0);
        int256 initialDelta = -50;
        int256 change = 50;
        uint256 nonZeroCountInitial = 1;

        vault.setDelta(token, initialDelta);
        vault.setNonZeroDeltaCount(nonZeroCountInitial);

        int256 beforeChange = vault.getDelta(token);

        vault.updateDeltaAccounting(token, change);

        int256 afterChange = vault.getDelta(token);
        uint256 nonZeroCount = vault.getNonZeroDeltaCount();

        assertEq(beforeChange, -50);
        assertEq(afterChange, 0);
        assertEq(nonZeroCount, 0);
    }

    function testCreditVault() public {
        uint256 amount = 1_000_000_000;

        uint256 id = uint256(uint160(USDC_ADDR));

        uint256 balanceBefore = vault.balanceOf(BOB, id);
        vault.creditVault(BOB, USDC_ADDR, amount);

        uint256 balance = vault.balanceOf(BOB, id);

        assertEq(balance, amount);
        assertEq(balance - balanceBefore, amount);
    }

    function testCreditVaultNonEmpty() public {
        uint256 amount = 1_000_000_000;

        uint256 id = uint256(uint160(USDC_ADDR));

        vault.creditVault(BOB, USDC_ADDR, amount);

        uint256 balanceBefore = vault.balanceOf(BOB, id);
        vault.creditVault(BOB, USDC_ADDR, amount);

        uint256 balance = vault.balanceOf(BOB, id);

        assertEq(balance, 2_000_000_000);
        assertEq(balance - balanceBefore, amount);
    }

    function testDebitVault() public {
        uint256 amount = 1_000_000_000;
        uint256 amount_to_debit = 2_000_000;

        uint256 id = uint256(uint160(USDC_ADDR));

        vault.creditVault(BOB, USDC_ADDR, amount);

        uint256 balanceBefore = vault.balanceOf(BOB, id);
        vault.debitVault(BOB, USDC_ADDR, amount_to_debit);

        uint256 balance = vault.balanceOf(BOB, id);

        assertEq(balance, 998_000_000);
        assertEq(balanceBefore - balance, amount_to_debit);
    }

    function testDebitVaultTooHigh() public {
        uint256 amount = 900_000_000;
        uint256 amount_to_debit = 1_000_000_000;

        uint256 id = uint256(uint160(USDC_ADDR));

        vault.creditVault(BOB, USDC_ADDR, amount);

        uint256 balanceBefore = vault.balanceOf(BOB, id);

        vm.expectRevert(
            abi.encodeWithSelector(
                Vault__InsufficientBalance.selector,
                BOB,
                USDC_ADDR,
                amount_to_debit,
                balanceBefore
            )
        );

        vault.debitVault(BOB, USDC_ADDR, amount_to_debit);
    }

    function testFinalizeBalancesNonZeroCountTooHigh() public {
        uint256 inputAmount = 1_000_000;
        uint256 nonZeroCount = 3;

        vault.setNonZeroDeltaCount(nonZeroCount);

        vm.expectRevert(
            abi.encodeWithSelector(
                Vault__UnexpectedNonZeroCount.selector, nonZeroCount
            )
        );

        vault.finalizeBalances(BOB, USDC_ADDR, inputAmount);
    }

    function testFinalizeBalancesNonZeroCountZero() public {
        uint256 inputAmount = 1_000_000;
        uint256 nonZeroCount = 0;

        vault.setNonZeroDeltaCount(nonZeroCount);
        vault.creditVault(BOB, USDC_ADDR, 3_000_000);

        uint256 balanceStart = vault.balanceOf(BOB, uint256(uint160(USDC_ADDR)));

        vault.finalizeBalances(BOB, USDC_ADDR, inputAmount);

        uint256 balanceEnd = vault.balanceOf(BOB, uint256(uint160(USDC_ADDR)));

        assertEq(balanceStart, balanceEnd);
    }

    function testFinalizeBalancesInputAmountDoesNotMatchDelta() public {
        uint256 inputAmount = 1_000_000;
        int256 inputDelta = -2_000_000;
        uint256 nonZeroCount = 1;

        vault.setUseVault(true);
        vault.setNonZeroDeltaCount(nonZeroCount);
        vault.setDelta(USDC_ADDR, inputDelta);
        vault.creditVault(BOB, USDC_ADDR, 3_000_000);

        vm.expectRevert(
            abi.encodeWithSelector(
                Vault__UnexpectedInputDelta.selector, inputDelta
            )
        );

        vault.finalizeBalances(BOB, USDC_ADDR, inputAmount);
    }

    function testFinalizeBalancesZeroDeltaReverts() public {
        vault.setUseVault(true);
        vault.setNonZeroDeltaCount(1);
        vault.setDelta(USDC_ADDR, 0);

        vm.expectRevert(
            abi.encodeWithSelector(
                Vault__UnexpectedInputDelta.selector, int256(0)
            )
        );

        vault.finalizeBalances(BOB, USDC_ADDR, 0);
    }

    function testFinalizeBalancesSuccess() public {
        uint256 inputAmount = 2_000_000;
        int256 inputDelta = -2_000_000;
        uint256 nonZeroCount = 1;

        vault.setUseVault(true);
        vault.setNonZeroDeltaCount(nonZeroCount);
        vault.setDelta(USDC_ADDR, inputDelta);
        vault.creditVault(BOB, USDC_ADDR, 3_000_000);
        uint256 balanceStart = vault.balanceOf(BOB, uint256(uint160(USDC_ADDR)));

        vault.finalizeBalances(BOB, USDC_ADDR, inputAmount);

        uint256 balanceEnd = vault.balanceOf(BOB, uint256(uint160(USDC_ADDR)));

        assertEq(balanceStart - balanceEnd, inputAmount);
        assertEq(balanceEnd, 1_000_000);
    }

    function testDepositFeeOnTransferToken() public {
        // TWIF charges 6% on every transfer
        address TWIF = 0x2Dd636C514Bb4705c756D161585Ff9ec665f18A2;

        uint256 amount = 1_000_000;
        uint256 expectedReceived = amount - (amount * 6) / 100;

        deal(TWIF, ALICE, amount);
        vm.startPrank(ALICE);
        IERC20(TWIF).approve(address(vault), amount);
        vault.deposit(TWIF, amount);
        vm.stopPrank();

        // Vault credits only the actual received amount
        assertEq(
            vault.balanceOf(ALICE, uint256(uint160(TWIF))), expectedReceived
        );
        // Router holds exactly the credited amount
        assertEq(IERC20(TWIF).balanceOf(address(vault)), expectedReceived);
    }
}