-
Notifications
You must be signed in to change notification settings - Fork 54
/
TestAllowance.sol
263 lines (225 loc) · 7.41 KB
/
TestAllowance.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
// SPDX-License-Identifier: MIT
pragma solidity 0.8.6;
import './helpers/TestBaseWorkflow.sol';
contract TestAllowance is TestBaseWorkflow {
JBController controller;
JBProjectMetadata _projectMetadata;
JBFundingCycleData _data;
JBFundingCycleMetadata _metadata;
JBGroupedSplits[] _groupedSplits;
JBFundAccessConstraints[] _fundAccessConstraints;
IJBPaymentTerminal[] _terminals;
JBTokenStore _tokenStore;
address _projectOwner;
address _beneficiary;
uint256 WEIGHT = 1000 * 10**18;
function setUp() public override {
super.setUp();
_projectOwner = multisig();
_beneficiary = beneficiary();
_tokenStore = jbTokenStore();
controller = jbController();
_projectMetadata = JBProjectMetadata({content: 'myIPFSHash', domain: 1});
_data = JBFundingCycleData({
duration: 14,
weight: WEIGHT,
discountRate: 450000000,
ballot: IJBFundingCycleBallot(address(0))
});
_metadata = JBFundingCycleMetadata({
global: JBGlobalFundingCycleMetadata({allowSetTerminals: false, allowSetController: false}),
reservedRate: 5000, //50%
redemptionRate: 5000, //50%
ballotRedemptionRate: 0,
pausePay: false,
pauseDistributions: false,
pauseRedeem: false,
pauseBurn: false,
allowMinting: false,
allowChangeToken: false,
allowTerminalMigration: false,
allowControllerMigration: false,
holdFees: false,
useTotalOverflowForRedemptions: false,
useDataSourceForPay: false,
useDataSourceForRedeem: false,
dataSource: address(0)
});
_terminals.push(jbETHPaymentTerminal());
}
function testAllowance() public {
JBETHPaymentTerminal terminal = jbETHPaymentTerminal();
_fundAccessConstraints.push(
JBFundAccessConstraints({
terminal: terminal,
token: jbLibraries().ETHToken(),
distributionLimit: 10 ether,
overflowAllowance: 5 ether,
distributionLimitCurrency: jbLibraries().ETH(),
overflowAllowanceCurrency: jbLibraries().ETH()
})
);
uint256 projectId = controller.launchProjectFor(
_projectOwner,
_projectMetadata,
_data,
_metadata,
block.timestamp,
_groupedSplits,
_fundAccessConstraints,
_terminals,
''
);
terminal.pay{value: 20 ether}(
projectId,
20 ether,
address(0),
_beneficiary,
0,
false,
'Forge test',
new bytes(0)
); // funding target met and 10 ETH are now in the overflow
// verify: beneficiary should have a balance of JBTokens (divided by 2 -> reserved rate = 50%)
uint256 _userTokenBalance = PRBMath.mulDiv(20 ether, (WEIGHT / 10**18), 2);
assertEq(_tokenStore.balanceOf(_beneficiary, projectId), _userTokenBalance);
// verify: ETH balance in terminal should be up to date
assertEq(jbPaymentTerminalStore().balanceOf(terminal, projectId), 20 ether);
// Discretionary use of overflow allowance by project owner (allowance = 5ETH)
evm.prank(_projectOwner); // Prank only next call
terminal.useAllowanceOf(
projectId,
5 ether,
1, // Currency
address(0), //token (unused)
0, // Min wei out
payable(_beneficiary), // Beneficiary
'MEMO'
);
assertEq(
(_beneficiary).balance,
PRBMath.mulDiv(5 ether, jbLibraries().MAX_FEE(), jbLibraries().MAX_FEE() + terminal.fee())
);
// Distribute the funding target ETH -> splits[] is empty -> everything in left-over, to project owner
evm.prank(_projectOwner);
terminal.distributePayoutsOf(
projectId,
10 ether,
1, // Currency
address(0), //token (unused)
0, // Min wei out
'Foundry payment' // Memo
);
assertEq(
_projectOwner.balance,
(10 ether * jbLibraries().MAX_FEE()) / (terminal.fee() + jbLibraries().MAX_FEE())
);
// redeem eth from the overflow by the token holder:
uint256 senderBalance = _tokenStore.balanceOf(_beneficiary, projectId);
evm.prank(_beneficiary);
terminal.redeemTokensOf(
_beneficiary,
projectId,
senderBalance,
address(0), //token (unused)
0,
payable(_beneficiary),
'gimme my money back',
new bytes(0)
);
// verify: beneficiary should have a balance of 0 JBTokens
assertEq(_tokenStore.balanceOf(_beneficiary, projectId), 0);
}
function testFuzzAllowance(
uint232 ALLOWANCE,
uint232 TARGET,
uint96 BALANCE
) public {
evm.assume(jbToken().totalSupply() >= BALANCE);
unchecked {
// Check for overflow
evm.assume(ALLOWANCE + TARGET >= ALLOWANCE && ALLOWANCE + TARGET >= TARGET);
}
uint256 CURRENCY = jbLibraries().ETH(); // Avoid testing revert on this call...
JBETHPaymentTerminal terminal = jbETHPaymentTerminal();
_fundAccessConstraints.push(
JBFundAccessConstraints({
terminal: terminal,
token: jbLibraries().ETHToken(),
distributionLimit: TARGET,
distributionLimitCurrency: CURRENCY,
overflowAllowance: ALLOWANCE,
overflowAllowanceCurrency: CURRENCY
})
);
uint256 projectId = controller.launchProjectFor(
_projectOwner,
_projectMetadata,
_data,
_metadata,
block.timestamp,
_groupedSplits,
_fundAccessConstraints,
_terminals,
''
);
terminal.pay{value: BALANCE}(
projectId,
BALANCE,
address(0),
_beneficiary,
0,
false,
'Forge test',
new bytes(0)
);
// verify: beneficiary should have a balance of JBTokens (divided by 2 -> reserved rate = 50%)
uint256 _userTokenBalance = PRBMath.mulDiv(BALANCE, (WEIGHT / 10**18), 2);
if (BALANCE != 0) assertEq(_tokenStore.balanceOf(_beneficiary, projectId), _userTokenBalance);
// verify: ETH balance in terminal should be up to date
assertEq(jbPaymentTerminalStore().balanceOf(terminal, projectId), BALANCE);
evm.startPrank(_projectOwner);
bool willRevert;
if (ALLOWANCE == 0) {
evm.expectRevert(abi.encodeWithSignature('INADEQUATE_CONTROLLER_ALLOWANCE()'));
willRevert = true;
} else if (TARGET >= BALANCE || ALLOWANCE > (BALANCE - TARGET)) {
// Too much to withdraw or no overflow ?
evm.expectRevert(abi.encodeWithSignature('INADEQUATE_PAYMENT_TERMINAL_STORE_BALANCE()'));
willRevert = true;
}
terminal.useAllowanceOf(
projectId,
ALLOWANCE,
CURRENCY, // Currency
address(0), //token (unused)
0, // Min wei out
payable(_beneficiary), // Beneficiary
'MEMO'
);
if (
!willRevert && BALANCE != 0 // if allowance ==0 or not enough overflow (target>=balance, allowance > overflow) // there is something to transfer
)
assertEq(
(_beneficiary).balance,
PRBMath.mulDiv(ALLOWANCE, jbLibraries().MAX_FEE(), jbLibraries().MAX_FEE() + terminal.fee())
);
if (TARGET > BALANCE)
evm.expectRevert(abi.encodeWithSignature('INADEQUATE_PAYMENT_TERMINAL_STORE_BALANCE()'));
if (TARGET == 0)
evm.expectRevert(abi.encodeWithSignature('DISTRIBUTION_AMOUNT_LIMIT_REACHED()'));
terminal.distributePayoutsOf(
projectId,
TARGET,
1, // Currency
address(0), //token (unused)
0, // Min wei out
'Foundry payment' // Memo
);
if (TARGET <= BALANCE && TARGET != 0)
assertEq(
_projectOwner.balance,
(TARGET * jbLibraries().MAX_FEE()) / (terminal.fee() + jbLibraries().MAX_FEE())
);
}
}