-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathV3FeeAdapter.t.sol
More file actions
844 lines (652 loc) Β· 29 KB
/
Copy pathV3FeeAdapter.t.sol
File metadata and controls
844 lines (652 loc) Β· 29 KB
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
// SPDX-License-Identifier: AGPL-3.0-only
pragma solidity ^0.8.0;
import {ProtocolFeesTestBase} from "./utils/ProtocolFeesTestBase.sol";
import {IUniswapV3Pool} from "v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import {MockERC20} from "solmate/src/test/utils/mocks/MockERC20.sol";
import {MerkleProof} from "openzeppelin-contracts/contracts/utils/cryptography/MerkleProof.sol";
import {
UniswapV3FactoryDeployer,
IUniswapV3Factory
} from "briefcase/deployers/v3-core/UniswapV3FactoryDeployer.sol";
import {Merkle} from "murky/src/Merkle.sol";
import {V3FeeAdapter, IV3FeeAdapter} from "../src/feeAdapters/V3FeeAdapter.sol";
import {IOwned} from "../src/interfaces/base/IOwned.sol";
contract V3FeeAdapterTest is ProtocolFeesTestBase {
using MerkleProof for bytes32[];
IUniswapV3Factory public factory;
IV3FeeAdapter public feeAdapter;
uint160 public constant SQRT_PRICE_1_1 = 79_228_162_514_264_337_593_543_950_336;
address pool;
address pool1;
Merkle merkle;
uint256 slot = 3;
PoolObject poolObject0;
PoolObject poolObject1;
address feeSetter;
struct ProtocolFees {
uint128 token0;
uint128 token1;
}
struct PoolObject {
address pool;
uint24 fee;
/// token1 | token0
uint8 protocolFee;
}
function setUp() public override {
super.setUp();
factory = UniswapV3FactoryDeployer.deploy();
/// Prank the old owner so we can just use our internal owner.
vm.prank(factory.owner());
factory.setOwner(owner);
vm.startPrank(owner);
feeAdapter = new V3FeeAdapter(address(factory), address(tokenJar));
feeAdapter.setFeeSetter(owner);
factory.setOwner(address(feeAdapter));
vm.stopPrank();
/// Store fee tiers.
feeAdapter.storeFeeTier(500);
feeAdapter.storeFeeTier(3000);
feeAdapter.storeFeeTier(10_000);
feeSetter = feeAdapter.feeSetter();
// Create pool.
pool = factory.createPool(address(mockToken), address(mockToken1), 3000);
pool1 = factory.createPool(address(mockToken), address(mockToken1), 10_000);
IUniswapV3Pool(pool).initialize(SQRT_PRICE_1_1);
IUniswapV3Pool(pool1).initialize(SQRT_PRICE_1_1);
poolObject0 = PoolObject({pool: pool, fee: 3000, protocolFee: 0});
poolObject1 = PoolObject({pool: pool1, fee: 10_000, protocolFee: 0});
// Mint tokens.
mockToken.mint(address(pool), INITIAL_TOKEN_AMOUNT);
mockToken1.mint(address(pool), INITIAL_TOKEN_AMOUNT);
merkle = new Merkle();
}
function test_feeAdapter_isOwner() public view {
assertEq(address(factory.owner()), address(feeAdapter));
}
function test_tokenJar_isSet() public view {
assertEq(feeAdapter.TOKEN_JAR(), address(tokenJar));
}
function test_enableFeeAmount() public {
uint24 newTier = 750;
vm.prank(owner);
feeAdapter.enableFeeAmount(750, 1);
uint24 _tier = feeAdapter.feeTiers(3);
assertEq(_tier, newTier);
}
function test_collect_full_success() public {
uint128 amount0 = 10e18;
uint128 amount1 = 11e18;
address token0 =
address(mockToken) < address(mockToken1) ? address(mockToken) : address(mockToken1);
address token1 =
address(mockToken) < address(mockToken1) ? address(mockToken1) : address(mockToken);
_mockSetProtocolFees(amount0, amount1);
IV3FeeAdapter.CollectParams[] memory collectParams = new IV3FeeAdapter.CollectParams[](1);
collectParams[0] = IV3FeeAdapter.CollectParams({
pool: pool, amount0Requested: amount0, amount1Requested: amount1
});
uint256 balanceBefore = MockERC20(token0).balanceOf(address(tokenJar));
uint256 balanceBefore1 = MockERC20(token1).balanceOf(address(tokenJar));
// Anyone can call collect.
IV3FeeAdapter.Collected[] memory collected = feeAdapter.collect(collectParams);
// Note that 1 wei is left in the pool.
assertEq(collected[0].amount0Collected, amount0 - 1);
assertEq(collected[0].amount1Collected, amount1 - 1);
// ProtocolFees Test Base pre-funds token jar, and poolManager sends more funds to it
assertEq(MockERC20(token0).balanceOf(address(tokenJar)), balanceBefore + amount0 - 1);
assertEq(MockERC20(token1).balanceOf(address(tokenJar)), balanceBefore1 + amount1 - 1);
}
/// Test spoofed storage setting in UniswapV3Pool.
function test_protocolFees_set() public {
(uint128 token0, uint128 token1) = IUniswapV3Pool(pool).protocolFees();
assertEq(token0, 0);
assertEq(token1, 0);
uint128 protocolFee0 = 1e18;
uint128 protocolFee1 = 3e18;
_mockSetProtocolFees(protocolFee0, protocolFee1);
(token0, token1) = IUniswapV3Pool(pool).protocolFees();
assertEq(token0, protocolFee0);
assertEq(token1, protocolFee1);
}
function test_setMerkleRoot_revertsWithInvalidCaller() public {
vm.expectRevert(IV3FeeAdapter.Unauthorized.selector);
feeAdapter.setMerkleRoot(bytes32(0));
}
function test_setMerkleRoot_revertsWithInvalidCaller_fuzz(address caller) public {
vm.assume(caller != owner);
vm.startPrank(caller);
vm.expectRevert(IV3FeeAdapter.Unauthorized.selector);
feeAdapter.setMerkleRoot(bytes32(uint256(40)));
}
function test_setMerkleRoot_success() public {
assertEq(feeAdapter.merkleRoot(), bytes32(uint256(0)));
vm.prank(feeSetter);
feeAdapter.setMerkleRoot(bytes32(uint256(40)));
assertEq(feeAdapter.merkleRoot(), bytes32(uint256(40)));
}
function test_setMerkleRoot_success_fuzz(bytes32 merkleRoot) public {
assertEq(feeAdapter.merkleRoot(), bytes32(uint256(0)));
vm.prank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
assertEq(feeAdapter.merkleRoot(), merkleRoot);
}
function test_setMerkleRoot_revertsWithInvalidProof() public {
vm.prank(feeSetter);
feeAdapter.setMerkleRoot(bytes32(uint256(40)));
vm.expectRevert(IV3FeeAdapter.InvalidProof.selector);
feeAdapter.triggerFeeUpdate(pool, new bytes32[](0));
}
function test_triggerFeeUpdate_withValidMerkleProof() public {
uint8 fee0 = 5;
uint8 fee1 = 10;
poolObject0.protocolFee = fee1 << 4 | fee0;
// Generate leaf nodes.
address dummyPool = poolObject1.pool;
bytes32 targetLeaf = _hashLeaf(poolObject0.pool);
bytes32 dummyLeaf = _hashLeaf(dummyPool);
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = targetLeaf;
leaves[1] = dummyLeaf;
bytes32 merkleRoot = merkle.getRoot(leaves);
// Set the merkle root
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(poolObject0.fee, poolObject0.protocolFee);
vm.stopPrank();
bytes32[] memory proof = merkle.getProof(leaves, 0);
feeAdapter.triggerFeeUpdate(poolObject0.pool, proof);
(,,,,, uint8 poolFees,) = IUniswapV3Pool(poolObject0.pool).slot0();
assertEq(poolFees, poolObject0.protocolFee);
}
function test_triggerFeeUpdate_byPair_withValidMerkleProof() public {
uint8 fee0 = 5;
uint8 fee1 = 10;
poolObject0.protocolFee = fee1 << 4 | fee0;
poolObject1.protocolFee = 4 << 4 | 8;
// Generate leaf nodes.
address dummyPool = poolObject1.pool;
bytes32 targetLeaf = _hashLeaf(poolObject0.pool);
bytes32 dummyLeaf = _hashLeaf(dummyPool);
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = targetLeaf;
leaves[1] = dummyLeaf;
bytes32 merkleRoot = merkle.getRoot(leaves);
// Set the merkle root
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(poolObject0.fee, poolObject0.protocolFee); // 0.30% pool
feeAdapter.setDefaultFeeByFeeTier(poolObject1.fee, poolObject1.protocolFee); // 1.00% pool
vm.stopPrank();
bytes32[] memory proof = merkle.getProof(leaves, 0);
(address _token0, address _token1) = address(mockToken) < address(mockToken1)
? (address(mockToken), address(mockToken1))
: (address(mockToken1), address(mockToken));
feeAdapter.triggerFeeUpdate(_token0, _token1, proof);
(,,,,, uint8 poolFees,) = IUniswapV3Pool(poolObject0.pool).slot0();
assertEq(poolFees, poolObject0.protocolFee);
(,,,,, uint8 protocolFees1,) = IUniswapV3Pool(poolObject1.pool).slot0();
assertEq(protocolFees1, poolObject1.protocolFee);
}
function test_triggerFeeUpdate_withValidMerkleProof_differentPool() public {
uint8 protocolFee2 = 5;
/// Save the protocol fee for poolObject1. Token0 and token1 have the same protocol fee.
poolObject1.protocolFee = protocolFee2 << 4 | protocolFee2;
// Generate leaf nodes.
bytes32 leaf1 = _hashLeaf(poolObject0.pool);
bytes32 leaf2 = _hashLeaf(poolObject1.pool);
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = leaf1;
leaves[1] = leaf2;
bytes32 merkleRoot = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(poolObject1.fee, poolObject1.protocolFee);
vm.stopPrank();
// Generate proof for pool1
bytes32[] memory proof2 = merkle.getProof(leaves, 1);
feeAdapter.triggerFeeUpdate(poolObject1.pool, proof2);
(,,,,, uint8 protocolFees,) = IUniswapV3Pool(poolObject1.pool).slot0();
assertEq(protocolFees, poolObject1.protocolFee);
// Assert that the fee for the other pool is not updated.
(,,,,, uint8 protocolFees0,) = IUniswapV3Pool(poolObject0.pool).slot0();
assertEq(protocolFees0, 0);
}
function test_triggerFeeUpdate_multiPool_success() public {
address pool2 = factory.createPool(address(mockToken), address(mockToken1), uint24(500));
IUniswapV3Pool(pool2).initialize(SQRT_PRICE_1_1);
poolObject0.protocolFee = 10 << 4 | 8;
poolObject1.protocolFee = 9 << 4 | 7;
PoolObject memory poolObject2 = PoolObject({pool: pool2, fee: 500, protocolFee: 8 << 4 | 5});
bytes32[] memory leaves = new bytes32[](3);
leaves[0] = _hashLeaf(poolObject0.pool);
leaves[1] = _hashLeaf(poolObject1.pool);
leaves[2] = _hashLeaf(poolObject2.pool);
bytes32 merkleRoot = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(poolObject0.fee, poolObject0.protocolFee);
feeAdapter.setDefaultFeeByFeeTier(poolObject1.fee, poolObject1.protocolFee);
feeAdapter.setDefaultFeeByFeeTier(poolObject2.fee, poolObject2.protocolFee);
vm.stopPrank();
bytes32[] memory proof0 = merkle.getProof(leaves, 0);
/// Trigger the fee update for pool0.
feeAdapter.triggerFeeUpdate(poolObject0.pool, proof0);
/// Assert that the fee for pool0 is updated, and that the other pools are not updated.
assertEq(_getProtocolFees(poolObject0.pool), poolObject0.protocolFee);
assertEq(_getProtocolFees(poolObject1.pool), 0);
assertEq(_getProtocolFees(poolObject2.pool), 0);
/// Trigger the fee updates for the rest of the pools.
bytes32[] memory proof1 = merkle.getProof(leaves, 1);
bytes32[] memory proof2 = merkle.getProof(leaves, 2);
feeAdapter.triggerFeeUpdate(poolObject1.pool, proof1);
feeAdapter.triggerFeeUpdate(poolObject2.pool, proof2);
/// Assert that the fees for all the pools are updated.
assertEq(_getProtocolFees(poolObject1.pool), poolObject1.protocolFee);
assertEq(_getProtocolFees(poolObject2.pool), poolObject2.protocolFee);
}
function test_triggerFeeUpdate_9000Pool_success_gas() public {
address[] memory pools = new address[](9000);
bytes32[] memory leaves = new bytes32[](9000);
uint24 feeTier = 500;
uint8 protocolFee = 10 << 4 | 9;
for (uint256 i = 0; i < 9000; i++) {
MockERC20 token_i = new MockERC20("Token", "TKN", 18);
address pool_i = factory.createPool(address(token_i), address(mockToken1), feeTier);
IUniswapV3Pool(pool_i).initialize(SQRT_PRICE_1_1);
pools[i] = pool_i;
leaves[i] = _hashLeaf(pool_i);
}
bytes32 merkleRoot = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(feeTier, protocolFee);
vm.stopPrank();
bytes32[] memory proof0 = merkle.getProof(leaves, 0);
bytes32[] memory proof4500 = merkle.getProof(leaves, 4500);
bytes32[] memory proof8999 = merkle.getProof(leaves, 8999);
/// Trigger the fee update for pool at index 0.
feeAdapter.triggerFeeUpdate(pools[0], proof0);
vm.snapshotGasLastCall("triggerFeeUpdate_0");
/// Trigger the fee update for pool at index 4500.
feeAdapter.triggerFeeUpdate(pools[4500], proof4500);
vm.snapshotGasLastCall("triggerFeeUpdate_4500");
/// Trigger the fee update for pool at index 8999.
feeAdapter.triggerFeeUpdate(pools[8999], proof8999);
vm.snapshotGasLastCall("triggerFeeUpdate_8999");
assertEq(_getProtocolFees(pools[0]), protocolFee);
assertEq(_getProtocolFees(pools[4500]), protocolFee);
assertEq(_getProtocolFees(pools[8999]), protocolFee);
/// Not all pools' fees are updated.
assertEq(_getProtocolFees(pools[1]), 0);
}
function test_batchTriggerFeeUpdate_9000Pool_success_gas() public {
address[] memory pools = new address[](9000);
bytes32[] memory leaves = new bytes32[](9000);
IV3FeeAdapter.Pair[] memory pairs = new IV3FeeAdapter.Pair[](9000);
uint24 feeTier = 3000;
uint8 protocolFee = 7 << 4 | 6;
for (uint256 i = 0; i < 9000; i++) {
MockERC20 token_i = new MockERC20("Token", "TKN", 18);
address pool_i = factory.createPool(address(token_i), address(mockToken1), feeTier);
IUniswapV3Pool(pool_i).initialize(SQRT_PRICE_1_1);
pools[i] = pool_i;
leaves[i] = _hashLeaf(pool_i);
pairs[i] = _toPair(address(token_i), address(mockToken1));
}
bool[] memory proofFlags = new bool[](leaves.length - 1);
for (uint256 i = 0; i < leaves.length - 1; i++) {
proofFlags[i] = true;
}
bytes32 root = MerkleProof.processMultiProof(new bytes32[](0), proofFlags, leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(root);
feeAdapter.setDefaultFeeByFeeTier(feeTier, protocolFee);
vm.stopPrank();
/// Batch trigger all fee updates.
feeAdapter.batchTriggerFeeUpdate(pairs, new bytes32[](0), proofFlags);
vm.snapshotGasLastCall("batchTriggerFeeUpdate_allLeaves");
assertEq(_getProtocolFees(pools[0]), protocolFee);
assertEq(_getProtocolFees(pools[8999]), protocolFee);
}
function test_fuzz_triggerFeeUpdate_revertsInvalidProtocolFee(
address invalidToken0,
address invalidToken1
) public {
/// Valid tokens in the merkle tree:
address token0_0 = IUniswapV3Pool(poolObject0.pool).token0();
address token1_0 = IUniswapV3Pool(poolObject0.pool).token1();
address token0_1 = IUniswapV3Pool(poolObject1.pool).token0();
address token1_1 = IUniswapV3Pool(poolObject1.pool).token1();
// Make sure we can create a pool from the two tokens. These are V3 Factory constraints.
vm.assume(invalidToken0 != address(0));
vm.assume(invalidToken1 != address(0));
vm.assume(invalidToken0 != invalidToken1);
/// Make sure that the invalid tokens are not in the merkle tree pairs.
vm.assume(invalidToken0 != token0_0);
vm.assume(invalidToken1 != token1_0);
vm.assume(invalidToken0 != token0_1);
vm.assume(invalidToken1 != token1_1);
// Create a new pool from those tokens.
address invalidPool = factory.createPool(invalidToken0, invalidToken1, 3000);
IUniswapV3Pool(invalidPool).initialize(SQRT_PRICE_1_1);
/// The leaf node is generated from the valid pool's pair.
bytes32 leaf = _hashLeaf(poolObject0.pool);
bytes32 dummyLeaf = _hashLeaf(poolObject1.pool);
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = leaf;
leaves[1] = dummyLeaf;
bytes32 merkleRoot = merkle.getRoot(leaves);
vm.prank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
bytes32[] memory proof = merkle.getProof(leaves, 0);
vm.expectRevert();
feeAdapter.triggerFeeUpdate(invalidPool, proof);
}
function test_fuzz_setFeeSetter(address newFeeSetter) public {
vm.prank(owner);
feeAdapter.setFeeSetter(newFeeSetter);
assertEq(feeAdapter.feeSetter(), newFeeSetter);
}
function test_fuzz_revert_setFeeSetter(address caller, address newFeeSetter) public {
vm.assume(caller != IOwned(address(feeAdapter)).owner());
vm.prank(caller);
vm.expectRevert("UNAUTHORIZED");
feeAdapter.setFeeSetter(newFeeSetter);
}
function test_setFactoryOwner() public {
address newOwner = makeAddr("newOwner");
vm.prank(owner);
feeAdapter.setFactoryOwner(newOwner);
assertEq(factory.owner(), newOwner);
}
function test_setFactoryOwner_reverts(address caller) public {
vm.assume(caller != owner);
vm.prank(caller);
vm.expectRevert("UNAUTHORIZED");
feeAdapter.setFactoryOwner(address(0));
}
function test_fuzz_setDefaultFeeByFeeTier(uint24 feeTier, uint8 defaultFee) public {
vm.startPrank(feeAdapter.feeSetter());
// Check if fee tier is valid
if (factory.feeAmountTickSpacing(feeTier) == 0) {
vm.expectRevert(IV3FeeAdapter.InvalidFeeTier.selector);
feeAdapter.setDefaultFeeByFeeTier(feeTier, defaultFee);
} else {
// Check if fee value is valid
uint8 feeProtocol0 = defaultFee % 16;
uint8 feeProtocol1 = defaultFee >> 4;
bool isValidFeeValue = (feeProtocol0 == 0 || (feeProtocol0 >= 4 && feeProtocol0 <= 10))
&& (feeProtocol1 == 0 || (feeProtocol1 >= 4 && feeProtocol1 <= 10));
if (!isValidFeeValue) {
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.setDefaultFeeByFeeTier(feeTier, defaultFee);
} else {
feeAdapter.setDefaultFeeByFeeTier(feeTier, defaultFee);
assertEq(feeAdapter.defaultFees(feeTier), defaultFee);
}
}
vm.stopPrank();
}
function test_fuzz_revert_setDefaultFeeByFeeTier(address caller, uint24 feeTier, uint8 defaultFee)
public
{
vm.assume(caller != feeAdapter.feeSetter());
vm.prank(caller);
vm.expectRevert(IV3FeeAdapter.Unauthorized.selector);
feeAdapter.setDefaultFeeByFeeTier(feeTier, defaultFee);
}
function test_setDefaultFeeByFeeTier_revertsWithInvalidFeeTier() public {
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeTier.selector);
feeAdapter.setDefaultFeeByFeeTier(11_000, 10);
}
function test_setDefaultFeeByFeeTier_revertsWithInvalidFeeValue_255() public {
// Test with 255 (decomposes to 15, 15 - both invalid)
// This is the exact scenario mentioned in the bug report
uint8 invalidFeeValue = 255;
// Verify it decomposes to (15, 15)
assertEq(invalidFeeValue % 16, 15);
assertEq(invalidFeeValue >> 4, 15);
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.setDefaultFeeByFeeTier(3000, invalidFeeValue);
}
function test_setDefaultFeeByFeeTier_revertsWithInvalidFeeValue_lowerBitsOutOfRange() public {
// Test with lower 4 bits out of range (e.g., 11)
uint8 invalidFee = (5 << 4) | 11; // Upper: 5 (valid), Lower: 11 (invalid)
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.setDefaultFeeByFeeTier(3000, invalidFee);
}
function test_setDefaultFeeByFeeTier_revertsWithInvalidFeeValue_upperBitsOutOfRange() public {
// Test with upper 4 bits out of range (e.g., 12)
uint8 invalidFee = (12 << 4) | 5; // Upper: 12 (invalid), Lower: 5 (valid)
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.setDefaultFeeByFeeTier(3000, invalidFee);
}
function test_setDefaultFeeByFeeTier_revertsWithInvalidFeeValue_bothBitsInvalidRange() public {
// Test with both bits in invalid range [1-3]
uint8 invalidFee = (2 << 4) | 3; // Upper: 2 (invalid), Lower: 3 (invalid)
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.setDefaultFeeByFeeTier(3000, invalidFee);
}
function test_triggerFeeUpdate_skipsUninitializedPool() public {
// Create a new pool but don't initialize it
MockERC20 token2 = new MockERC20("Token2", "TKN2", 18);
address uninitializedPool = factory.createPool(address(token2), address(mockToken1), 3000);
// Note: We don't call IUniswapV3Pool(uninitializedPool).initialize()
uint8 protocolFee = 10 << 4 | 8;
// Create merkle tree with both initialized and uninitialized pools
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = _hashLeaf(poolObject0.pool);
leaves[1] = _hashLeaf(uninitializedPool);
bytes32 merkleRoot = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(merkleRoot);
feeAdapter.setDefaultFeeByFeeTier(3000, protocolFee);
vm.stopPrank();
// Get proof for the uninitialized pool
bytes32[] memory proof = merkle.getProof(leaves, 1);
// This should not revert - the function should silently skip the uninitialized pool
feeAdapter.triggerFeeUpdate(uninitializedPool, proof);
// Verify that the protocol fee was NOT set (pool fee should be 0)
(,,,,, uint8 poolFees,) = IUniswapV3Pool(uninitializedPool).slot0();
assertEq(poolFees, 0);
// Verify that initialized pools still work correctly
bytes32[] memory proof0 = merkle.getProof(leaves, 0);
feeAdapter.triggerFeeUpdate(poolObject0.pool, proof0);
assertEq(_getProtocolFees(poolObject0.pool), protocolFee);
}
function _mockSetProtocolFees(uint128 token0, uint128 token1) internal {
uint256 toSet = uint256(token1) << 128 | uint256(token0);
vm.store(pool, bytes32(slot), bytes32(toSet));
}
function _getProtocolFees(address _pool) internal view returns (uint8 poolFeesPacked) {
(,,,,, uint8 poolFees,) = IUniswapV3Pool(_pool).slot0();
return poolFees;
}
function _hashLeaf(address _pool) internal view returns (bytes32) {
return keccak256(
abi.encode(
keccak256(abi.encode(IUniswapV3Pool(_pool).token0(), IUniswapV3Pool(_pool).token1()))
)
);
}
function _toPair(address tokenA, address tokenB)
internal
pure
returns (IV3FeeAdapter.Pair memory)
{
if (tokenA > tokenB) (tokenA, tokenB) = (tokenB, tokenA);
return IV3FeeAdapter.Pair({token0: tokenA, token1: tokenB});
}
// ==================== Pool Fee Override Tests ====================
function test_overridePoolFee_success() public {
uint8 overrideFee = 7 << 4 | 6; // fee1=7, fee0=6
vm.prank(feeSetter);
vm.expectEmit(true, false, false, true);
emit IV3FeeAdapter.PoolFeeOverrideSet(pool, overrideFee);
feeAdapter.overridePoolFee(pool, overrideFee);
// Verify override is stored
assertEq(feeAdapter.poolFeeOverrides(pool), overrideFee);
// Verify pool fee was updated immediately
assertEq(_getProtocolFees(pool), overrideFee);
}
function test_overridePoolFee_overridesDefaultFee() public {
uint8 defaultFee = 10 << 4 | 10;
uint8 overrideFee = 5 << 4 | 5;
// Set default fee for the fee tier
vm.startPrank(feeSetter);
feeAdapter.setDefaultFeeByFeeTier(3000, defaultFee);
// Set override for specific pool
feeAdapter.overridePoolFee(pool, overrideFee);
vm.stopPrank();
// Verify pool has override fee, not default
assertEq(_getProtocolFees(pool), overrideFee);
// Trigger fee update via merkle proof and verify override is still used
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = _hashLeaf(pool);
leaves[1] = _hashLeaf(pool1);
bytes32 root = merkle.getRoot(leaves);
vm.prank(feeSetter);
feeAdapter.setMerkleRoot(root);
bytes32[] memory proof = merkle.getProof(leaves, 0);
feeAdapter.triggerFeeUpdate(pool, proof);
// Override should still be in effect
assertEq(_getProtocolFees(pool), overrideFee);
}
function test_overridePoolFee_revertsUnauthorized() public {
address unauthorized = makeAddr("unauthorized");
vm.prank(unauthorized);
vm.expectRevert(IV3FeeAdapter.Unauthorized.selector);
feeAdapter.overridePoolFee(pool, 0x55);
}
function test_overridePoolFee_revertsInvalidFeeValue() public {
uint8 invalidFee = 15 << 4 | 15; // Both values > 10
vm.prank(feeSetter);
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.overridePoolFee(pool, invalidFee);
}
function test_overridePoolFee_allowsZeroFee() public {
// Zero fee should be valid (disables protocol fee)
uint8 zeroFee = 0;
uint8 OVERRIDE_TO_ZERO = type(uint8).max; // sentinel value
vm.prank(feeSetter);
feeAdapter.overridePoolFee(pool, zeroFee);
// Stored as sentinel value, but effective fee is 0
assertEq(feeAdapter.poolFeeOverrides(pool), OVERRIDE_TO_ZERO);
assertEq(_getProtocolFees(pool), zeroFee);
}
function test_overridePoolFee_skipsUninitializedPool() public {
// Create uninitialized pool
MockERC20 token2 = new MockERC20("Token2", "TKN2", 18);
address uninitializedPool = factory.createPool(address(token2), address(mockToken1), 3000);
uint8 overrideFee = 6 << 4 | 6;
// Should not revert, just skip setting the fee
vm.prank(feeSetter);
feeAdapter.overridePoolFee(uninitializedPool, overrideFee);
// Override should be stored
assertEq(feeAdapter.poolFeeOverrides(uninitializedPool), overrideFee);
// Pool fee should still be 0 (uninitialized)
(,,,,, uint8 poolFees,) = IUniswapV3Pool(uninitializedPool).slot0();
assertEq(poolFees, 0);
}
function test_removePoolFeeOverride_success() public {
uint8 overrideFee = 7 << 4 | 6;
vm.startPrank(feeSetter);
feeAdapter.overridePoolFee(pool, overrideFee);
// Verify override is set
assertEq(feeAdapter.poolFeeOverrides(pool), overrideFee);
vm.expectEmit(true, false, false, false);
emit IV3FeeAdapter.PoolFeeOverrideRemoved(pool);
feeAdapter.removePoolFeeOverride(pool);
vm.stopPrank();
// Verify override is removed (back to 0 means no override)
assertEq(feeAdapter.poolFeeOverrides(pool), 0);
}
function test_removePoolFeeOverride_revertsUnauthorized() public {
address unauthorized = makeAddr("unauthorized");
vm.prank(unauthorized);
vm.expectRevert(IV3FeeAdapter.Unauthorized.selector);
feeAdapter.removePoolFeeOverride(pool);
}
function test_triggerFeeUpdate_usesDefaultAfterOverrideRemoved() public {
uint8 defaultFee = 10 << 4 | 10;
uint8 overrideFee = 5 << 4 | 5;
// Setup merkle tree
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = _hashLeaf(pool);
leaves[1] = _hashLeaf(pool1);
bytes32 root = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(root);
feeAdapter.setDefaultFeeByFeeTier(3000, defaultFee);
// Set override
feeAdapter.overridePoolFee(pool, overrideFee);
assertEq(_getProtocolFees(pool), overrideFee);
// Remove override
feeAdapter.removePoolFeeOverride(pool);
vm.stopPrank();
// Trigger fee update - should use default now
bytes32[] memory proof = merkle.getProof(leaves, 0);
feeAdapter.triggerFeeUpdate(pool, proof);
assertEq(_getProtocolFees(pool), defaultFee);
}
function test_fuzz_overridePoolFee(uint8 feeValue) public {
uint8 OVERRIDE_TO_ZERO = type(uint8).max;
vm.startPrank(feeSetter);
uint8 feeProtocol0 = feeValue % 16;
uint8 feeProtocol1 = feeValue >> 4;
bool isValidFeeValue = (feeProtocol0 == 0 || (feeProtocol0 >= 4 && feeProtocol0 <= 10))
&& (feeProtocol1 == 0 || (feeProtocol1 >= 4 && feeProtocol1 <= 10));
if (!isValidFeeValue) {
vm.expectRevert(IV3FeeAdapter.InvalidFeeValue.selector);
feeAdapter.overridePoolFee(pool, feeValue);
} else {
feeAdapter.overridePoolFee(pool, feeValue);
// If feeValue is 0, it's stored as sentinel; otherwise stored as-is
uint8 expectedStored = feeValue == 0 ? OVERRIDE_TO_ZERO : feeValue;
assertEq(feeAdapter.poolFeeOverrides(pool), expectedStored);
}
vm.stopPrank();
}
function test_overridePoolFee_canUpdateExistingOverride() public {
uint8 firstOverride = 5 << 4 | 5;
uint8 secondOverride = 8 << 4 | 8;
vm.startPrank(feeSetter);
feeAdapter.overridePoolFee(pool, firstOverride);
assertEq(_getProtocolFees(pool), firstOverride);
feeAdapter.overridePoolFee(pool, secondOverride);
assertEq(_getProtocolFees(pool), secondOverride);
vm.stopPrank();
}
function test_triggerFeeUpdate_byPair_respectsOverride() public {
uint8 defaultFee3000 = 10 << 4 | 10;
uint8 defaultFee10000 = 8 << 4 | 8;
uint8 overrideFee = 5 << 4 | 5;
// Setup merkle tree for the pair
bytes32[] memory leaves = new bytes32[](2);
leaves[0] = _hashLeaf(pool);
leaves[1] = _hashLeaf(pool1);
bytes32 root = merkle.getRoot(leaves);
vm.startPrank(feeSetter);
feeAdapter.setMerkleRoot(root);
feeAdapter.setDefaultFeeByFeeTier(3000, defaultFee3000);
feeAdapter.setDefaultFeeByFeeTier(10_000, defaultFee10000);
// Set override only for pool (3000 fee tier)
feeAdapter.overridePoolFee(pool, overrideFee);
vm.stopPrank();
// Trigger fee update by pair
(address _token0, address _token1) = address(mockToken) < address(mockToken1)
? (address(mockToken), address(mockToken1))
: (address(mockToken1), address(mockToken));
bytes32[] memory proof = merkle.getProof(leaves, 0);
feeAdapter.triggerFeeUpdate(_token0, _token1, proof);
// pool should have override, pool1 should have default
assertEq(_getProtocolFees(pool), overrideFee);
assertEq(_getProtocolFees(pool1), defaultFee10000);
}
}