@rev-net/core-v6 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/SKILLS.md +1 -1
  2. package/docs/book.toml +1 -1
  3. package/docs/src/README.md +151 -54
  4. package/docs/src/SUMMARY.md +0 -2
  5. package/docs/src/src/REVDeployer.sol/contract.REVDeployer.md +148 -117
  6. package/docs/src/src/REVLoans.sol/contract.REVLoans.md +120 -59
  7. package/docs/src/src/interfaces/IREVDeployer.sol/interface.IREVDeployer.md +296 -14
  8. package/docs/src/src/interfaces/IREVLoans.sol/interface.IREVLoans.md +318 -16
  9. package/docs/src/src/structs/README.md +0 -2
  10. package/docs/src/src/structs/REVAutoIssuance.sol/struct.REVAutoIssuance.md +4 -4
  11. package/docs/src/src/structs/REVConfig.sol/struct.REVConfig.md +5 -17
  12. package/docs/src/src/structs/REVCroptopAllowedPost.sol/struct.REVCroptopAllowedPost.md +10 -6
  13. package/docs/src/src/structs/REVDeploy721TiersHookConfig.sol/struct.REVDeploy721TiersHookConfig.md +7 -7
  14. package/docs/src/src/structs/REVDescription.sol/struct.REVDescription.md +5 -5
  15. package/docs/src/src/structs/REVLoan.sol/struct.REVLoan.md +7 -7
  16. package/docs/src/src/structs/REVLoanSource.sol/struct.REVLoanSource.md +3 -3
  17. package/docs/src/src/structs/REVStageConfig.sol/struct.REVStageConfig.md +10 -10
  18. package/docs/src/src/structs/REVSuckerDeploymentConfig.sol/struct.REVSuckerDeploymentConfig.md +3 -3
  19. package/package.json +6 -6
  20. package/slither-ci.config.json +1 -1
  21. package/src/REVLoans.sol +20 -9
  22. package/src/interfaces/IREVDeployer.sol +0 -2
  23. package/src/interfaces/IREVLoans.sol +10 -4
  24. package/test/TestPR27_CEIPattern.t.sol +2 -2
  25. package/test/TestPR32_MixedFixes.t.sol +1 -1
  26. package/test/regression/TestI20_CumulativeLoanCounter.t.sol +303 -0
  27. package/test/regression/TestL27_LiquidateGapHandling.t.sol +334 -0
@@ -0,0 +1,334 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity 0.8.26;
3
+
4
+ import "forge-std/Test.sol";
5
+ import /* {*} from */ "@bananapus/core-v6/test/helpers/TestBaseWorkflow.sol";
6
+ import /* {*} from "@bananapus/721-hook-v6/src/JB721TiersHookDeployer.sol";
7
+ import /* {*} from */ "./../../src/REVDeployer.sol";
8
+ import "@croptop/core-v6/src/CTPublisher.sol";
9
+ import {MockBuybackDataHook} from "./../mock/MockBuybackDataHook.sol";
10
+ import "@bananapus/core-v6/script/helpers/CoreDeploymentLib.sol";
11
+ import "@bananapus/721-hook-v6/script/helpers/Hook721DeploymentLib.sol";
12
+ import "@bananapus/suckers-v6/script/helpers/SuckerDeploymentLib.sol";
13
+ import "@croptop/core-v6/script/helpers/CroptopDeploymentLib.sol";
14
+ import "@bananapus/router-terminal-v6/script/helpers/RouterTerminalDeploymentLib.sol";
15
+ import {JBConstants} from "@bananapus/core-v6/src/libraries/JBConstants.sol";
16
+ import {JBAccountingContext} from "@bananapus/core-v6/src/structs/JBAccountingContext.sol";
17
+ import {JBSingleAllowance} from "@bananapus/core-v6/src/structs/JBSingleAllowance.sol";
18
+ import {MockPriceFeed} from "@bananapus/core-v6/test/mock/MockPriceFeed.sol";
19
+ import {MockERC20} from "@bananapus/core-v6/test/mock/MockERC20.sol";
20
+ import {REVLoans} from "../../src/REVLoans.sol";
21
+ import {REVLoan} from "../../src/structs/REVLoan.sol";
22
+ import {REVStageConfig, REVAutoIssuance} from "../../src/structs/REVStageConfig.sol";
23
+ import {REVLoanSource} from "../../src/structs/REVLoanSource.sol";
24
+ import {REVDescription} from "../../src/structs/REVDescription.sol";
25
+ import {IREVLoans} from "../../src/interfaces/IREVLoans.sol";
26
+ import {JBSuckerDeployerConfig} from "@bananapus/suckers-v6/src/structs/JBSuckerDeployerConfig.sol";
27
+ import {JBSuckerRegistry} from "@bananapus/suckers-v6/src/JBSuckerRegistry.sol";
28
+ import {JB721TiersHookDeployer} from "@bananapus/721-hook-v6/src/JB721TiersHookDeployer.sol";
29
+ import {JB721TiersHook} from "@bananapus/721-hook-v6/src/JB721TiersHook.sol";
30
+ import {JB721TiersHookStore} from "@bananapus/721-hook-v6/src/JB721TiersHookStore.sol";
31
+ import {JBAddressRegistry} from "@bananapus/address-registry-v6/src/JBAddressRegistry.sol";
32
+ import {IJBAddressRegistry} from "@bananapus/address-registry-v6/src/interfaces/IJBAddressRegistry.sol";
33
+ import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
34
+
35
+ /// @notice Regression test for L-27: liquidateExpiredLoansFrom halts on deleted loan gaps.
36
+ /// @dev Before the fix, the function used `break` when encountering a deleted loan (createdAt == 0),
37
+ /// which stopped the entire iteration. Expired loans after the gap were never liquidated.
38
+ /// After the fix, `continue` is used instead, so the loop skips gaps and keeps processing.
39
+ contract TestL27_LiquidateGapHandling is TestBaseWorkflow, JBTest {
40
+ bytes32 REV_DEPLOYER_SALT = "REVDeployer";
41
+
42
+ REVDeployer REV_DEPLOYER;
43
+ JB721TiersHook EXAMPLE_HOOK;
44
+ IJB721TiersHookDeployer HOOK_DEPLOYER;
45
+ IJB721TiersHookStore HOOK_STORE;
46
+ IJBAddressRegistry ADDRESS_REGISTRY;
47
+ REVLoans LOANS_CONTRACT;
48
+ MockERC20 TOKEN;
49
+ IJBSuckerRegistry SUCKER_REGISTRY;
50
+ CTPublisher PUBLISHER;
51
+ MockBuybackDataHook MOCK_BUYBACK;
52
+
53
+ uint256 FEE_PROJECT_ID;
54
+ uint256 REVNET_ID;
55
+
56
+ address USER1 = makeAddr("user1");
57
+ address USER2 = makeAddr("user2");
58
+ address USER3 = makeAddr("user3");
59
+
60
+ address private constant TRUSTED_FORWARDER = 0xB2b5841DBeF766d4b521221732F9B618fCf34A87;
61
+
62
+ function setUp() public override {
63
+ super.setUp();
64
+ FEE_PROJECT_ID = jbProjects().createFor(multisig());
65
+ SUCKER_REGISTRY = new JBSuckerRegistry(jbDirectory(), jbPermissions(), multisig(), address(0));
66
+ HOOK_STORE = new JB721TiersHookStore();
67
+ EXAMPLE_HOOK = new JB721TiersHook(jbDirectory(), jbPermissions(), jbRulesets(), HOOK_STORE, multisig());
68
+ ADDRESS_REGISTRY = new JBAddressRegistry();
69
+ HOOK_DEPLOYER = new JB721TiersHookDeployer(EXAMPLE_HOOK, HOOK_STORE, ADDRESS_REGISTRY, multisig());
70
+ PUBLISHER = new CTPublisher(jbDirectory(), jbPermissions(), FEE_PROJECT_ID, multisig());
71
+ MOCK_BUYBACK = new MockBuybackDataHook();
72
+ TOKEN = new MockERC20("1/2 ETH", "1/2");
73
+ MockPriceFeed priceFeed = new MockPriceFeed(1e21, 6);
74
+ vm.prank(multisig());
75
+ jbPrices()
76
+ .addPriceFeedFor(0, uint32(uint160(address(TOKEN))), uint32(uint160(JBConstants.NATIVE_TOKEN)), priceFeed);
77
+ LOANS_CONTRACT = new REVLoans({
78
+ controller: jbController(),
79
+ projects: jbProjects(),
80
+ revId: FEE_PROJECT_ID,
81
+ owner: address(this),
82
+ permit2: permit2(),
83
+ trustedForwarder: TRUSTED_FORWARDER
84
+ });
85
+ REV_DEPLOYER = new REVDeployer{salt: REV_DEPLOYER_SALT}(
86
+ jbController(),
87
+ SUCKER_REGISTRY,
88
+ FEE_PROJECT_ID,
89
+ HOOK_DEPLOYER,
90
+ PUBLISHER,
91
+ IJBRulesetDataHook(address(MOCK_BUYBACK)),
92
+ address(LOANS_CONTRACT),
93
+ TRUSTED_FORWARDER
94
+ );
95
+ vm.prank(multisig());
96
+ jbProjects().approve(address(REV_DEPLOYER), FEE_PROJECT_ID);
97
+ _deployFeeProject();
98
+ _deployRevnet();
99
+ vm.deal(USER1, 100e18);
100
+ vm.deal(USER2, 100e18);
101
+ vm.deal(USER3, 100e18);
102
+ }
103
+
104
+ function _deployFeeProject() internal {
105
+ JBAccountingContext[] memory acc = new JBAccountingContext[](2);
106
+ acc[0] = JBAccountingContext({
107
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
108
+ });
109
+ acc[1] = JBAccountingContext({token: address(TOKEN), decimals: 6, currency: uint32(uint160(address(TOKEN)))});
110
+ JBTerminalConfig[] memory tc = new JBTerminalConfig[](1);
111
+ tc[0] = JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: acc});
112
+ REVStageConfig[] memory stages = new REVStageConfig[](1);
113
+ JBSplit[] memory splits = new JBSplit[](1);
114
+ splits[0].beneficiary = payable(multisig());
115
+ splits[0].percent = 10_000;
116
+ REVAutoIssuance[] memory ai = new REVAutoIssuance[](1);
117
+ ai[0] = REVAutoIssuance({chainId: uint32(block.chainid), count: uint104(70_000e18), beneficiary: multisig()});
118
+ stages[0] = REVStageConfig({
119
+ startsAtOrAfter: uint40(block.timestamp),
120
+ autoIssuances: ai,
121
+ splitPercent: 2000,
122
+ splits: splits,
123
+ initialIssuance: uint112(1000e18),
124
+ issuanceCutFrequency: 90 days,
125
+ issuanceCutPercent: JBConstants.MAX_WEIGHT_CUT_PERCENT / 2,
126
+ cashOutTaxRate: 6000,
127
+ extraMetadata: 0
128
+ });
129
+ REVConfig memory cfg = REVConfig({
130
+ description: REVDescription("Revnet", "$REV", "ipfs://test", "REV_TOKEN"),
131
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
132
+ splitOperator: multisig(),
133
+ stageConfigurations: stages
134
+ });
135
+ vm.prank(multisig());
136
+ REV_DEPLOYER.deployFor({
137
+ revnetId: FEE_PROJECT_ID,
138
+ configuration: cfg,
139
+ terminalConfigurations: tc,
140
+ suckerDeploymentConfiguration: REVSuckerDeploymentConfig({
141
+ deployerConfigurations: new JBSuckerDeployerConfig[](0), salt: keccak256("FEE")
142
+ })
143
+ });
144
+ }
145
+
146
+ function _deployRevnet() internal {
147
+ JBAccountingContext[] memory acc = new JBAccountingContext[](2);
148
+ acc[0] = JBAccountingContext({
149
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
150
+ });
151
+ acc[1] = JBAccountingContext({token: address(TOKEN), decimals: 6, currency: uint32(uint160(address(TOKEN)))});
152
+ JBTerminalConfig[] memory tc = new JBTerminalConfig[](1);
153
+ tc[0] = JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: acc});
154
+ REVStageConfig[] memory stages = new REVStageConfig[](1);
155
+ JBSplit[] memory splits = new JBSplit[](1);
156
+ splits[0].beneficiary = payable(multisig());
157
+ splits[0].percent = 10_000;
158
+ REVAutoIssuance[] memory ai = new REVAutoIssuance[](1);
159
+ ai[0] = REVAutoIssuance({chainId: uint32(block.chainid), count: uint104(70_000e18), beneficiary: multisig()});
160
+ stages[0] = REVStageConfig({
161
+ startsAtOrAfter: uint40(block.timestamp),
162
+ autoIssuances: ai,
163
+ splitPercent: 2000,
164
+ splits: splits,
165
+ initialIssuance: uint112(1000e18),
166
+ issuanceCutFrequency: 90 days,
167
+ issuanceCutPercent: JBConstants.MAX_WEIGHT_CUT_PERCENT / 2,
168
+ cashOutTaxRate: 6000,
169
+ extraMetadata: 0
170
+ });
171
+ REVConfig memory cfg = REVConfig({
172
+ description: REVDescription("NANA", "$NANA", "ipfs://test2", "NANA_TOKEN"),
173
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
174
+ splitOperator: multisig(),
175
+ stageConfigurations: stages
176
+ });
177
+ REVNET_ID = REV_DEPLOYER.deployFor({
178
+ revnetId: 0,
179
+ configuration: cfg,
180
+ terminalConfigurations: tc,
181
+ suckerDeploymentConfiguration: REVSuckerDeploymentConfig({
182
+ deployerConfigurations: new JBSuckerDeployerConfig[](0), salt: keccak256("NANA")
183
+ })
184
+ });
185
+ }
186
+
187
+ function _setupLoan(address user, uint256 ethAmount) internal returns (uint256 loanId, uint256 tokenCount) {
188
+ vm.prank(user);
189
+ tokenCount =
190
+ jbMultiTerminal().pay{value: ethAmount}(REVNET_ID, JBConstants.NATIVE_TOKEN, ethAmount, user, 0, "", "");
191
+ uint256 borrowAmount =
192
+ LOANS_CONTRACT.borrowableAmountFrom(REVNET_ID, tokenCount, 18, uint32(uint160(JBConstants.NATIVE_TOKEN)));
193
+ require(borrowAmount > 0, "Borrow amount should be > 0");
194
+ mockExpect(
195
+ address(jbPermissions()),
196
+ abi.encodeCall(IJBPermissions.hasPermission, (address(LOANS_CONTRACT), user, REVNET_ID, 11, true, true)),
197
+ abi.encode(true)
198
+ );
199
+ REVLoanSource memory source = REVLoanSource({token: JBConstants.NATIVE_TOKEN, terminal: jbMultiTerminal()});
200
+ vm.prank(user);
201
+ (loanId,) = LOANS_CONTRACT.borrowFrom(REVNET_ID, source, 0, tokenCount, payable(user), 25);
202
+ }
203
+
204
+ /// @notice Regression test for L-27: liquidation should continue past deleted loan gaps.
205
+ /// @dev Steps:
206
+ /// 1. Create 3 loans (loan numbers 1, 2, 3)
207
+ /// 2. Fully repay loan 2, which deletes it (createdAt == 0), creating a gap
208
+ /// 3. Warp past the liquidation duration
209
+ /// 4. Call liquidateExpiredLoansFrom(revnetId, 1, 3) to try liquidating all 3
210
+ /// 5. Verify that loan 3 (after the gap) IS liquidated
211
+ ///
212
+ /// Before the fix (break): Loan 1 liquidated, loan 2 gap causes break, loan 3 skipped.
213
+ /// After the fix (continue): Loan 1 liquidated, loan 2 gap skipped, loan 3 liquidated.
214
+ function test_L27_liquidationContinuesPastDeletedLoanGaps() public {
215
+ // Step 1: Create 3 loans
216
+ (uint256 loanId1,) = _setupLoan(USER1, 5e18);
217
+ (uint256 loanId2,) = _setupLoan(USER2, 5e18);
218
+ (uint256 loanId3,) = _setupLoan(USER3, 5e18);
219
+
220
+ require(loanId1 != 0 && loanId2 != 0 && loanId3 != 0, "All loans should be created");
221
+
222
+ // Verify all 3 loans exist
223
+ REVLoan memory loan1 = LOANS_CONTRACT.loanOf(loanId1);
224
+ REVLoan memory loan2 = LOANS_CONTRACT.loanOf(loanId2);
225
+ REVLoan memory loan3 = LOANS_CONTRACT.loanOf(loanId3);
226
+ assertTrue(loan1.createdAt > 0, "Loan 1 should exist");
227
+ assertTrue(loan2.createdAt > 0, "Loan 2 should exist");
228
+ assertTrue(loan3.createdAt > 0, "Loan 3 should exist");
229
+
230
+ // Step 2: Fully repay loan 2 to create a gap
231
+ JBSingleAllowance memory allowance;
232
+ vm.prank(USER2);
233
+ LOANS_CONTRACT.repayLoan{value: loan2.amount}(
234
+ loanId2,
235
+ loan2.amount,
236
+ loan2.collateral, // return all collateral to fully close the loan
237
+ payable(USER2),
238
+ allowance
239
+ );
240
+
241
+ // Verify loan 2 is now deleted (createdAt == 0)
242
+ REVLoan memory deletedLoan2 = LOANS_CONTRACT.loanOf(loanId2);
243
+ assertEq(deletedLoan2.createdAt, 0, "Loan 2 should be deleted after full repayment");
244
+
245
+ // Verify loans 1 and 3 still exist
246
+ REVLoan memory stillLoan1 = LOANS_CONTRACT.loanOf(loanId1);
247
+ REVLoan memory stillLoan3 = LOANS_CONTRACT.loanOf(loanId3);
248
+ assertTrue(stillLoan1.createdAt > 0, "Loan 1 should still exist");
249
+ assertTrue(stillLoan3.createdAt > 0, "Loan 3 should still exist");
250
+
251
+ // Record collateral and borrowed amounts before liquidation
252
+ uint256 totalCollateralBefore = LOANS_CONTRACT.totalCollateralOf(REVNET_ID);
253
+ uint256 totalBorrowedBefore =
254
+ LOANS_CONTRACT.totalBorrowedFrom(REVNET_ID, jbMultiTerminal(), JBConstants.NATIVE_TOKEN);
255
+ assertTrue(totalCollateralBefore > 0, "Should have collateral from loans 1 and 3");
256
+ assertTrue(totalBorrowedBefore > 0, "Should have borrowed amount from loans 1 and 3");
257
+
258
+ // Step 3: Warp past the liquidation duration
259
+ vm.warp(block.timestamp + LOANS_CONTRACT.LOAN_LIQUIDATION_DURATION() + 1);
260
+
261
+ // Step 4: Call liquidateExpiredLoansFrom starting from loan 1, iterating over 3 loans
262
+ // Loan numbers are 1, 2, 3 (not the full loanIds which include revnetId prefix)
263
+ LOANS_CONTRACT.liquidateExpiredLoansFrom(REVNET_ID, 1, 3);
264
+
265
+ // Step 5: Verify BOTH loan 1 and loan 3 were liquidated (not just loan 1)
266
+
267
+ // Loan 1 should be liquidated (NFT burned, data deleted)
268
+ REVLoan memory liquidatedLoan1 = LOANS_CONTRACT.loanOf(loanId1);
269
+ assertEq(liquidatedLoan1.createdAt, 0, "Loan 1 should be liquidated (data deleted)");
270
+
271
+ // Loan 3 should ALSO be liquidated -- this is the critical assertion for L-27.
272
+ // Before the fix, this would fail because the `break` at loan 2's gap stopped iteration.
273
+ REVLoan memory liquidatedLoan3 = LOANS_CONTRACT.loanOf(loanId3);
274
+ assertEq(liquidatedLoan3.createdAt, 0, "Loan 3 should be liquidated despite gap at loan 2");
275
+
276
+ // All collateral and borrowed tracking should be zeroed out
277
+ uint256 totalCollateralAfter = LOANS_CONTRACT.totalCollateralOf(REVNET_ID);
278
+ assertEq(totalCollateralAfter, 0, "All collateral tracking should be zero after full liquidation");
279
+
280
+ uint256 totalBorrowedAfter =
281
+ LOANS_CONTRACT.totalBorrowedFrom(REVNET_ID, jbMultiTerminal(), JBConstants.NATIVE_TOKEN);
282
+ assertEq(totalBorrowedAfter, 0, "All borrowed tracking should be zero after full liquidation");
283
+ }
284
+
285
+ /// @notice Verify that liquidation handles multiple consecutive gaps correctly.
286
+ /// @dev Creates 4 loans, repays loans 2 and 3, then liquidates the range.
287
+ /// Loan 1 and 4 should both be liquidated despite the double gap.
288
+ function test_L27_liquidationHandlesMultipleConsecutiveGaps() public {
289
+ // Create 4 loans from the same user (simpler)
290
+ address USER4 = makeAddr("user4");
291
+ vm.deal(USER4, 100e18);
292
+
293
+ (uint256 loanId1,) = _setupLoan(USER1, 3e18);
294
+ (uint256 loanId2,) = _setupLoan(USER2, 3e18);
295
+ (uint256 loanId3,) = _setupLoan(USER3, 3e18);
296
+ (uint256 loanId4,) = _setupLoan(USER4, 3e18);
297
+
298
+ // Fully repay loans 2 and 3 to create consecutive gaps
299
+ REVLoan memory loan2 = LOANS_CONTRACT.loanOf(loanId2);
300
+ REVLoan memory loan3 = LOANS_CONTRACT.loanOf(loanId3);
301
+
302
+ JBSingleAllowance memory allowance;
303
+ vm.prank(USER2);
304
+ LOANS_CONTRACT.repayLoan{value: loan2.amount}(
305
+ loanId2, loan2.amount, loan2.collateral, payable(USER2), allowance
306
+ );
307
+ vm.prank(USER3);
308
+ LOANS_CONTRACT.repayLoan{value: loan3.amount}(
309
+ loanId3, loan3.amount, loan3.collateral, payable(USER3), allowance
310
+ );
311
+
312
+ // Verify the gaps exist
313
+ assertEq(LOANS_CONTRACT.loanOf(loanId2).createdAt, 0, "Loan 2 should be deleted");
314
+ assertEq(LOANS_CONTRACT.loanOf(loanId3).createdAt, 0, "Loan 3 should be deleted");
315
+
316
+ // Warp past liquidation duration
317
+ vm.warp(block.timestamp + LOANS_CONTRACT.LOAN_LIQUIDATION_DURATION() + 1);
318
+
319
+ // Liquidate the range
320
+ LOANS_CONTRACT.liquidateExpiredLoansFrom(REVNET_ID, 1, 4);
321
+
322
+ // Both loan 1 and loan 4 should be liquidated
323
+ assertEq(LOANS_CONTRACT.loanOf(loanId1).createdAt, 0, "Loan 1 should be liquidated");
324
+ assertEq(LOANS_CONTRACT.loanOf(loanId4).createdAt, 0, "Loan 4 should be liquidated despite double gap");
325
+
326
+ // All tracking should be zeroed
327
+ assertEq(LOANS_CONTRACT.totalCollateralOf(REVNET_ID), 0, "All collateral should be zero");
328
+ assertEq(
329
+ LOANS_CONTRACT.totalBorrowedFrom(REVNET_ID, jbMultiTerminal(), JBConstants.NATIVE_TOKEN),
330
+ 0,
331
+ "All borrowed should be zero"
332
+ );
333
+ }
334
+ }