-
Notifications
You must be signed in to change notification settings - Fork 12
/
Claimer.t.sol
479 lines (427 loc) · 16.3 KB
/
Claimer.t.sol
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
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.19;
import "forge-std/Test.sol";
import {
Claimer,
MinFeeGeMax,
VrgdaClaimFeeBelowMin,
PrizePoolZeroAddress,
FeeRecipientZeroAddress,
TimeToReachMaxFeeZero
} from "../src/Claimer.sol";
import { UD2x18, ud2x18 } from "prb-math/UD2x18.sol";
import { SD59x18 } from "prb-math/SD59x18.sol";
import { PrizePool, AlreadyClaimed } from "pt-v5-prize-pool/PrizePool.sol";
import { IClaimable } from "pt-v5-claimable-interface/interfaces/IClaimable.sol";
import { LinearVRGDALib } from "../src/libraries/LinearVRGDALib.sol";
// Custom Errors
error ClaimArraySizeMismatch(uint256 winnersLength, uint256 prizeIndicesLength);
contract ClaimerTest is Test {
event ClaimError(
IClaimable indexed vault,
uint8 indexed tier,
address indexed winner,
uint32 prizeIndex,
bytes reason
);
uint256 public constant MINIMUM_FEE = 0.0001e18;
uint256 public constant MAXIMUM_FEE = 1000e18;
uint256 public constant TIME_TO_REACH_MAX = 86400;
uint256 public constant ESTIMATED_PRIZES = 1000;
uint256 public constant SMALLEST_PRIZE_SIZE = 1e18;
uint256 public constant CANARY_PRIZE_SIZE = 0.4e18;
uint256 public constant UNSOLD_100_SECONDS_IN_FEE = 100254032882995;
uint256 public constant SOLD_ONE_100_SECONDS_IN_FEE = 98651081754209;
uint64 public constant MAX_FEE_PERCENTAGE_OF_PRIZE = 0.5e18;
Claimer public claimer;
PrizePool public prizePool = PrizePool(makeAddr("prizePool"));
IClaimable public vault = IClaimable(makeAddr("vault"));
SD59x18 public decayConstant;
uint256 public ahead1_fee; // = 0.000090909090909090e18;
address winner1 = 0x690B9A9E9aa1C9dB991C7721a92d351Db4FaC990;
address winner2 = 0x4008Ed96594b645f057c9998a2924545fAbB6545;
address winner3 = 0x796486EBd82E427901511d130Ece93b94f06a980;
address winner4 = 0x2ed6c4B5dA6378c7897AC67Ba9e43102Feb694EE;
address winner5 = 0x9ebC8E61f87A301fF25a606d7C06150f856F24E2;
address winner6 = 0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5;
function setUp() public {
vm.warp(TIME_TO_REACH_MAX * 100);
vm.etch(address(prizePool), "prizePool");
vm.etch(address(vault), "fakecode");
claimer = new Claimer(
prizePool,
MINIMUM_FEE,
MAXIMUM_FEE,
TIME_TO_REACH_MAX,
ud2x18(MAX_FEE_PERCENTAGE_OF_PRIZE)
);
decayConstant = LinearVRGDALib.getDecayConstant(
LinearVRGDALib.getMaximumPriceDeltaScale(MINIMUM_FEE, MAXIMUM_FEE, TIME_TO_REACH_MAX)
);
ahead1_fee = LinearVRGDALib.getVRGDAPrice(
MINIMUM_FEE,
0,
1,
LinearVRGDALib.getPerTimeUnit(ESTIMATED_PRIZES, TIME_TO_REACH_MAX),
decayConstant
);
mockIsCanaryTier(0, false);
mockIsCanaryTier(1, false);
mockIsCanaryTier(2, true);
mockIsCanaryTier(3, true);
}
function testConstructor() public {
assertEq(address(claimer.prizePool()), address(prizePool));
assertEq(claimer.minimumFee(), MINIMUM_FEE);
assertEq(claimer.decayConstant().unwrap(), decayConstant.unwrap());
}
function testConstructor_TimeToReachMaxFeeZero() public {
vm.expectRevert(abi.encodeWithSelector(TimeToReachMaxFeeZero.selector));
new Claimer(
prizePool, // zero address
MINIMUM_FEE,
MAXIMUM_FEE,
0,
ud2x18(MAX_FEE_PERCENTAGE_OF_PRIZE)
);
}
function testConstructor_PrizePoolZeroAddress() public {
vm.expectRevert(abi.encodeWithSelector(PrizePoolZeroAddress.selector));
new Claimer(
PrizePool(address(0)), // zero address
MINIMUM_FEE,
MAXIMUM_FEE,
TIME_TO_REACH_MAX,
ud2x18(MAX_FEE_PERCENTAGE_OF_PRIZE)
);
}
function testConstructor_MinFeeGeMax() public {
vm.expectRevert(abi.encodeWithSelector(MinFeeGeMax.selector, 1e18, 0.5e18));
new Claimer(prizePool, 1e18, 0.5e18, TIME_TO_REACH_MAX, ud2x18(MAX_FEE_PERCENTAGE_OF_PRIZE));
}
function testClaimPrizes_ClaimError() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
vm.mockCallRevert(
address(vault),
abi.encodeCall(vault.claimPrize, (winner1, 1, 0, 100254032882995, address(this))),
"errrooooor"
);
vm.expectEmit(true, true, true, true);
emit ClaimError(vault, 1, winner1, 0, "errrooooor");
claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
}
function testClaimPrizes_FeeRecipientZeroAddress() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(0), 100);
vm.expectRevert(abi.encodeWithSelector(FeeRecipientZeroAddress.selector));
claimer.claimPrizes(vault, 1, winners, prizeIndices, address(0), 1); // zero address with non-zero min fee
}
function testClaimPrizes_single() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
uint256 totalFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
assertEq(totalFees, UNSOLD_100_SECONDS_IN_FEE, "Total fees");
}
function testClaimPrizes_singleNoFeeSavesGas() public {
// With fee
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
uint256 gasBeforeFeeClaim = gasleft();
uint256 totalFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
uint256 feeClaimGasUsed = gasBeforeFeeClaim - gasleft();
assertEq(totalFees, UNSOLD_100_SECONDS_IN_FEE, "Total fees");
// Without fee
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(0), address(0), 0);
uint256 gasBeforeNoFeeClaim = gasleft();
uint256 totalNoFeeFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(0), 0);
uint256 noFeeClaimGasUsed = gasBeforeNoFeeClaim - gasleft();
assertEq(totalNoFeeFees, 0, "Total fees");
// Check gas
// console2.log("no fee claim gas savings: ", feeClaimGasUsed - noFeeClaimGasUsed);
assertGt(feeClaimGasUsed, noFeeClaimGasUsed, "Fee / No Fee Gas Difference");
}
function testClaimPrizes_multiple() public {
address[] memory winners = newWinners(winner1, winner2);
uint32[][] memory prizeIndices = newPrizeIndices(2, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(
1,
winner1,
0,
(uint96(UNSOLD_100_SECONDS_IN_FEE) + uint96(SOLD_ONE_100_SECONDS_IN_FEE)) / 2,
address(this),
100
);
mockClaimPrize(
1,
winner2,
0,
(uint96(UNSOLD_100_SECONDS_IN_FEE) + uint96(SOLD_ONE_100_SECONDS_IN_FEE)) / 2,
address(this),
100
);
uint256 totalFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
assertEq(totalFees, UNSOLD_100_SECONDS_IN_FEE + SOLD_ONE_100_SECONDS_IN_FEE, "Total fees");
}
function testClaimPrizes_VrgdaClaimFeeBelowMin() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
vm.expectRevert(
abi.encodeWithSelector(VrgdaClaimFeeBelowMin.selector, 100e18, UNSOLD_100_SECONDS_IN_FEE)
);
assertEq(claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 100e18), 0);
}
function testClaimPrizes_alreadyClaimedError() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
vm.mockCallRevert(
address(vault),
abi.encodeWithSelector(
vault.claimPrize.selector,
winner1,
1,
0,
uint96(UNSOLD_100_SECONDS_IN_FEE),
address(this)
),
abi.encodeWithSelector(AlreadyClaimed.selector, address(vault), winner1, 1, 0)
);
vm.expectEmit(true, true, true, true);
emit ClaimError(vault, 1, winner1, 0, abi.encodeWithSelector(AlreadyClaimed.selector, address(vault), winner1, 1, 0));
claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
}
function testClaimPrizes_maxFee() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -1, 0);
mockLastClosedDrawAwardedAt(-80000); // much time has passed, meaning the fee is large
mockClaimPrize(1, winner1, 0, uint96(0.5e18), address(this), 100);
uint256 totalFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
assertEq(totalFees, 0.5e18, "Total fees");
}
function testClaimPrizes_veryLongElapsedTime() public {
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -1, 0);
mockLastClosedDrawAwardedAt(-1_000_000); // a long time has passed, meaning the fee should be capped (and there should be no EXP_OVERFLOW!)
mockClaimPrize(1, winner1, 0, uint96(0.5e18), address(this), 100);
uint256 totalFees = claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
assertEq(totalFees, 0.5e18, "Total fees");
}
function testClaimPrizes_arrayMismatchGt() public {
// prize indices gt winners
address[] memory winners = newWinners(winner1);
uint32[][] memory prizeIndices = newPrizeIndices(2, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
vm.expectRevert(abi.encodeWithSelector(ClaimArraySizeMismatch.selector, 1, 2));
claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
}
function testClaimPrizes_arrayMismatchLt() public {
// prize indices lt winners
address[] memory winners = newWinners(winner1, winner2);
uint32[][] memory prizeIndices = newPrizeIndices(1, 1);
mockPrizePool(1, -100, 0);
mockClaimPrize(1, winner1, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
mockClaimPrize(1, winner2, 0, uint96(UNSOLD_100_SECONDS_IN_FEE), address(this), 100);
vm.expectRevert(abi.encodeWithSelector(ClaimArraySizeMismatch.selector, 2, 1));
claimer.claimPrizes(vault, 1, winners, prizeIndices, address(this), 0);
}
function testComputeTotalFees_zero() public {
mockPrizePool(1, -100, 0);
assertEq(claimer.computeTotalFees(1, 0), 0);
}
function testComputeTotalFees_one() public {
mockPrizePool(1, -100, 0);
assertEq(claimer.computeTotalFees(1, 1), UNSOLD_100_SECONDS_IN_FEE);
}
function testComputeTotalFees_two() public {
mockPrizePool(1, -100, 0);
assertEq(
claimer.computeTotalFees(1, 2),
UNSOLD_100_SECONDS_IN_FEE + SOLD_ONE_100_SECONDS_IN_FEE
);
}
function testComputeTotalFeesAlreadyClaimed_zero() public {
mockPrizePool(1, -100, 0);
assertEq(claimer.computeTotalFees(1, 0, 10), 0);
}
function testComputeTotalFeesAlreadyClaimed_one() public {
mockPrizePool(1, -100, 0);
assertEq(claimer.computeTotalFees(1, 1, 10), 85330020869909);
}
function testComputeTotalFeesAlreadyClaimed_two() public {
mockPrizePool(1, -100, 0);
assertEq(claimer.computeTotalFees(1, 2, 10), 169295709060728);
}
function testComputeTotalFees_canary() public {
mockIsCanaryTier(1, true);
mockGetTierPrizeSize(1, 100e18);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.claimCount.selector),
abi.encode(0)
);
assertEq(claimer.computeTotalFees(1, 1), 100e18);
}
function testComputeMaxFee_normalPrizes() public {
mockGetTierPrizeSize(0, 10e18);
mockGetTierPrizeSize(1, SMALLEST_PRIZE_SIZE);
assertEq(claimer.computeMaxFee(0), 5e18);
assertEq(claimer.computeMaxFee(1), 0.5e18);
}
function testComputeMaxFee_canaryPrizes() public {
mockGetTierPrizeSize(2, 0.5e18);
mockGetTierPrizeSize(3, 1e18);
assertEq(claimer.computeMaxFee(2), 0.5e18); // full size
assertEq(claimer.computeMaxFee(3), 1e18); // full size
}
function testComputeFeePerClaim_minFee() public {
uint startTime = block.timestamp;
uint prizeCount = 10;
vm.mockCall(
address(prizePool),
abi.encodeWithSignature("estimatedPrizeCount()"),
abi.encode(prizeCount)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.lastAwardedDrawAwardedAt.selector),
abi.encode(startTime)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.claimCount.selector),
abi.encode(0)
);
mockIsCanaryTier(0, false);
mockGetTierPrizeSize(0, 100e18);
uint firstSaleTime = TIME_TO_REACH_MAX / prizeCount;
vm.warp(startTime + firstSaleTime);
assertApproxEqAbs(claimer.computeFeePerClaim(0, 1), MINIMUM_FEE, 4);
}
function testComputeFeePerClaim_maxFee() public {
uint startTime = block.timestamp;
uint prizeCount = 10;
vm.mockCall(
address(prizePool),
abi.encodeWithSignature("estimatedPrizeCount()"),
abi.encode(prizeCount)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.lastAwardedDrawAwardedAt.selector),
abi.encode(startTime)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.claimCount.selector),
abi.encode(0)
);
mockIsCanaryTier(0, false);
mockGetTierPrizeSize(0, MAXIMUM_FEE*2);
uint firstSaleTime = TIME_TO_REACH_MAX / prizeCount;
vm.warp(startTime + firstSaleTime + TIME_TO_REACH_MAX + 1);
assertApproxEqAbs(claimer.computeFeePerClaim(0, 1), MAXIMUM_FEE, 4);
}
function mockPrizePool(uint256 drawId, int256 drawEndedRelativeToNow, uint256 claimCount) public {
uint numberOfTiers = 3;
vm.mockCall(
address(prizePool),
abi.encodeWithSignature("getLastClosedDrawId()"),
abi.encodePacked(drawId)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSignature("estimatedPrizeCount()"),
abi.encodePacked(ESTIMATED_PRIZES)
);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.drawPeriodSeconds.selector),
abi.encodePacked(TIME_TO_REACH_MAX)
);
mockGetTierPrizeSize(1, SMALLEST_PRIZE_SIZE);
mockLastClosedDrawAwardedAt(drawEndedRelativeToNow);
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.claimCount.selector),
abi.encodePacked(claimCount)
);
}
function mockLastClosedDrawAwardedAt(int256 drawEndedRelativeToNow) public {
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.lastAwardedDrawAwardedAt.selector),
abi.encodePacked(int256(block.timestamp) + drawEndedRelativeToNow)
);
}
function newWinners(address _winner) public view returns (address[] memory) {
address[] memory winners = new address[](1);
winners[0] = _winner;
return winners;
}
function newWinners(address _winner1, address _winner2) public view returns (address[] memory) {
address[] memory winners = new address[](2);
winners[0] = _winner1;
winners[1] = _winner2;
return winners;
}
function newPrizeIndices(
uint32 addressCount,
uint32 prizeCount
) public view returns (uint32[][] memory) {
uint32[][] memory prizeIndices = new uint32[][](addressCount);
for (uint256 i = 0; i < addressCount; i++) {
prizeIndices[i] = new uint32[](prizeCount);
}
return prizeIndices;
}
function mockClaimPrize(
uint8 _tier,
address _winner,
uint32 _prizeIndex,
uint96 _fee,
address _feeRecipient,
uint256 _result
) public {
vm.mockCall(
address(vault),
abi.encodeWithSelector(
vault.claimPrize.selector,
_winner,
_tier,
_prizeIndex,
_fee,
_feeRecipient
),
abi.encodePacked(_result)
);
}
function mockIsCanaryTier(uint8 _tier, bool isCanary) internal {
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.isCanaryTier.selector, _tier),
abi.encode(isCanary)
);
}
function mockGetTierPrizeSize(uint8 _tier, uint256 prizeSize) internal {
vm.mockCall(
address(prizePool),
abi.encodeWithSelector(prizePool.getTierPrizeSize.selector, _tier),
abi.encode(prizeSize)
);
}
}