@rev-net/core-v6 0.0.1

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 (92) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +65 -0
  3. package/REVNET_SECURITY_CHECKLIST.md +164 -0
  4. package/SECURITY.md +68 -0
  5. package/SKILLS.md +166 -0
  6. package/deployments/revnet-core-v5/arbitrum/REVDeployer.json +2821 -0
  7. package/deployments/revnet-core-v5/arbitrum/REVLoans.json +2260 -0
  8. package/deployments/revnet-core-v5/arbitrum_sepolia/REVDeployer.json +2821 -0
  9. package/deployments/revnet-core-v5/arbitrum_sepolia/REVLoans.json +2260 -0
  10. package/deployments/revnet-core-v5/base/REVDeployer.json +2825 -0
  11. package/deployments/revnet-core-v5/base/REVLoans.json +2264 -0
  12. package/deployments/revnet-core-v5/base_sepolia/REVDeployer.json +2825 -0
  13. package/deployments/revnet-core-v5/base_sepolia/REVLoans.json +2264 -0
  14. package/deployments/revnet-core-v5/ethereum/REVDeployer.json +2825 -0
  15. package/deployments/revnet-core-v5/ethereum/REVLoans.json +2264 -0
  16. package/deployments/revnet-core-v5/optimism/REVDeployer.json +2821 -0
  17. package/deployments/revnet-core-v5/optimism/REVLoans.json +2260 -0
  18. package/deployments/revnet-core-v5/optimism_sepolia/REVDeployer.json +2825 -0
  19. package/deployments/revnet-core-v5/optimism_sepolia/REVLoans.json +2264 -0
  20. package/deployments/revnet-core-v5/sepolia/REVDeployer.json +2825 -0
  21. package/deployments/revnet-core-v5/sepolia/REVLoans.json +2264 -0
  22. package/docs/book.css +13 -0
  23. package/docs/book.toml +13 -0
  24. package/docs/solidity.min.js +74 -0
  25. package/docs/src/README.md +88 -0
  26. package/docs/src/SUMMARY.md +20 -0
  27. package/docs/src/src/README.md +7 -0
  28. package/docs/src/src/REVDeployer.sol/contract.REVDeployer.md +968 -0
  29. package/docs/src/src/REVLoans.sol/contract.REVLoans.md +1047 -0
  30. package/docs/src/src/interfaces/IREVDeployer.sol/interface.IREVDeployer.md +243 -0
  31. package/docs/src/src/interfaces/IREVLoans.sol/interface.IREVLoans.md +296 -0
  32. package/docs/src/src/interfaces/README.md +5 -0
  33. package/docs/src/src/structs/README.md +14 -0
  34. package/docs/src/src/structs/REVAutoIssuance.sol/struct.REVAutoIssuance.md +19 -0
  35. package/docs/src/src/structs/REVBuybackHookConfig.sol/struct.REVBuybackHookConfig.md +19 -0
  36. package/docs/src/src/structs/REVBuybackPoolConfig.sol/struct.REVBuybackPoolConfig.md +21 -0
  37. package/docs/src/src/structs/REVConfig.sol/struct.REVConfig.md +35 -0
  38. package/docs/src/src/structs/REVCroptopAllowedPost.sol/struct.REVCroptopAllowedPost.md +28 -0
  39. package/docs/src/src/structs/REVDeploy721TiersHookConfig.sol/struct.REVDeploy721TiersHookConfig.md +34 -0
  40. package/docs/src/src/structs/REVDescription.sol/struct.REVDescription.md +23 -0
  41. package/docs/src/src/structs/REVLoan.sol/struct.REVLoan.md +28 -0
  42. package/docs/src/src/structs/REVLoanSource.sol/struct.REVLoanSource.md +16 -0
  43. package/docs/src/src/structs/REVStageConfig.sol/struct.REVStageConfig.md +44 -0
  44. package/docs/src/src/structs/REVSuckerDeploymentConfig.sol/struct.REVSuckerDeploymentConfig.md +16 -0
  45. package/foundry.lock +11 -0
  46. package/foundry.toml +23 -0
  47. package/package.json +31 -0
  48. package/remappings.txt +1 -0
  49. package/script/Deploy.s.sol +350 -0
  50. package/script/helpers/RevnetCoreDeploymentLib.sol +72 -0
  51. package/slither-ci.config.json +10 -0
  52. package/sphinx.lock +507 -0
  53. package/src/REVDeployer.sol +1257 -0
  54. package/src/REVLoans.sol +1333 -0
  55. package/src/interfaces/IREVDeployer.sol +198 -0
  56. package/src/interfaces/IREVLoans.sol +241 -0
  57. package/src/structs/REVAutoIssuance.sol +11 -0
  58. package/src/structs/REVConfig.sol +17 -0
  59. package/src/structs/REVCroptopAllowedPost.sol +20 -0
  60. package/src/structs/REVDeploy721TiersHookConfig.sol +25 -0
  61. package/src/structs/REVDescription.sol +14 -0
  62. package/src/structs/REVLoan.sol +19 -0
  63. package/src/structs/REVLoanSource.sol +11 -0
  64. package/src/structs/REVStageConfig.sol +34 -0
  65. package/src/structs/REVSuckerDeploymentConfig.sol +11 -0
  66. package/test/REV.integrations.t.sol +420 -0
  67. package/test/REVAutoIssuanceFuzz.t.sol +276 -0
  68. package/test/REVDeployerAuditRegressions.t.sol +328 -0
  69. package/test/REVInvincibility.t.sol +1275 -0
  70. package/test/REVInvincibilityHandler.sol +357 -0
  71. package/test/REVLifecycle.t.sol +364 -0
  72. package/test/REVLoans.invariants.t.sol +642 -0
  73. package/test/REVLoansAttacks.t.sol +739 -0
  74. package/test/REVLoansAuditRegressions.t.sol +314 -0
  75. package/test/REVLoansFeeRecovery.t.sol +704 -0
  76. package/test/REVLoansSourced.t.sol +1732 -0
  77. package/test/REVLoansUnSourced.t.sol +331 -0
  78. package/test/TestPR09_ConversionDocumentation.t.sol +304 -0
  79. package/test/TestPR10_LiquidationBehavior.t.sol +340 -0
  80. package/test/TestPR11_LowFindings.t.sol +571 -0
  81. package/test/TestPR12_FlashLoanSurplus.t.sol +305 -0
  82. package/test/TestPR13_CrossSourceReallocation.t.sol +302 -0
  83. package/test/TestPR15_CashOutCallerValidation.t.sol +320 -0
  84. package/test/TestPR16_ZeroRepayment.t.sol +297 -0
  85. package/test/TestPR21_Uint112Overflow.t.sol +251 -0
  86. package/test/TestPR22_HookArrayOOB.t.sol +221 -0
  87. package/test/TestPR26_BurnHeldTokens.t.sol +331 -0
  88. package/test/TestPR27_CEIPattern.t.sol +448 -0
  89. package/test/TestPR29_SwapTerminalPermission.t.sol +206 -0
  90. package/test/TestPR32_MixedFixes.t.sol +529 -0
  91. package/test/helpers/MaliciousContracts.sol +233 -0
  92. package/test/mock/MockBuybackDataHook.sol +61 -0
@@ -0,0 +1,251 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity 0.8.23;
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
+
11
+ import "@bananapus/core-v6/script/helpers/CoreDeploymentLib.sol";
12
+ import "@bananapus/721-hook-v6/script/helpers/Hook721DeploymentLib.sol";
13
+ import "@bananapus/suckers-v6/script/helpers/SuckerDeploymentLib.sol";
14
+ import "@croptop/core-v6/script/helpers/CroptopDeploymentLib.sol";
15
+ import "@bananapus/swap-terminal-v6/script/helpers/SwapTerminalDeploymentLib.sol";
16
+ import {JBConstants} from "@bananapus/core-v6/src/libraries/JBConstants.sol";
17
+ import {JBAccountingContext} from "@bananapus/core-v6/src/structs/JBAccountingContext.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
+
34
+ /// @title TestPR21_Uint112Overflow
35
+ /// @notice Tests for PR #21 — C-1 uint112 truncation fix in REVLoans._adjust()
36
+ contract TestPR21_Uint112Overflow is TestBaseWorkflow, JBTest {
37
+ bytes32 REV_DEPLOYER_SALT = "REVDeployer";
38
+ bytes32 ERC20_SALT = "REV_TOKEN";
39
+
40
+ REVDeployer REV_DEPLOYER;
41
+ JB721TiersHook EXAMPLE_HOOK;
42
+ IJB721TiersHookDeployer HOOK_DEPLOYER;
43
+ IJB721TiersHookStore HOOK_STORE;
44
+ IJBAddressRegistry ADDRESS_REGISTRY;
45
+ IREVLoans LOANS_CONTRACT;
46
+ MockERC20 TOKEN;
47
+ IJBSuckerRegistry SUCKER_REGISTRY;
48
+ CTPublisher PUBLISHER;
49
+ MockBuybackDataHook MOCK_BUYBACK;
50
+
51
+ uint256 FEE_PROJECT_ID;
52
+ uint256 REVNET_ID;
53
+
54
+ address USER = makeAddr("user");
55
+ address private constant TRUSTED_FORWARDER = 0xB2b5841DBeF766d4b521221732F9B618fCf34A87;
56
+
57
+ function setUp() public override {
58
+ super.setUp();
59
+
60
+ FEE_PROJECT_ID = jbProjects().createFor(multisig());
61
+
62
+ SUCKER_REGISTRY = new JBSuckerRegistry(jbDirectory(), jbPermissions(), multisig(), address(0));
63
+ HOOK_STORE = new JB721TiersHookStore();
64
+ EXAMPLE_HOOK = new JB721TiersHook(jbDirectory(), jbPermissions(), jbRulesets(), HOOK_STORE, multisig());
65
+ ADDRESS_REGISTRY = new JBAddressRegistry();
66
+ HOOK_DEPLOYER = new JB721TiersHookDeployer(EXAMPLE_HOOK, HOOK_STORE, ADDRESS_REGISTRY, multisig());
67
+ PUBLISHER = new CTPublisher(jbDirectory(), jbPermissions(), FEE_PROJECT_ID, multisig());
68
+ MOCK_BUYBACK = new MockBuybackDataHook();
69
+ TOKEN = new MockERC20("1/2 ETH", "1/2");
70
+
71
+ MockPriceFeed priceFeed = new MockPriceFeed(1e21, 6);
72
+ vm.prank(multisig());
73
+ jbPrices()
74
+ .addPriceFeedFor(0, uint32(uint160(address(TOKEN))), uint32(uint160(JBConstants.NATIVE_TOKEN)), priceFeed);
75
+
76
+ LOANS_CONTRACT = new REVLoans({
77
+ controller: jbController(),
78
+ projects: jbProjects(),
79
+ revId: FEE_PROJECT_ID,
80
+ owner: address(this),
81
+ permit2: permit2(),
82
+ trustedForwarder: TRUSTED_FORWARDER
83
+ });
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
+
96
+ // Deploy fee project
97
+ vm.prank(multisig());
98
+ jbProjects().approve(address(REV_DEPLOYER), FEE_PROJECT_ID);
99
+
100
+ _deployFeeProject();
101
+ _deployRevnet();
102
+
103
+ vm.deal(USER, 1000e18);
104
+ }
105
+
106
+ function _deployFeeProject() internal {
107
+ JBAccountingContext[] memory acc = new JBAccountingContext[](2);
108
+ acc[0] = JBAccountingContext({
109
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
110
+ });
111
+ acc[1] = JBAccountingContext({token: address(TOKEN), decimals: 6, currency: uint32(uint160(address(TOKEN)))});
112
+ JBTerminalConfig[] memory tc = new JBTerminalConfig[](1);
113
+ tc[0] = JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: acc});
114
+
115
+ REVStageConfig[] memory stages = new REVStageConfig[](1);
116
+ JBSplit[] memory splits = new JBSplit[](1);
117
+ splits[0].beneficiary = payable(multisig());
118
+ splits[0].percent = 10_000;
119
+ REVAutoIssuance[] memory ai = new REVAutoIssuance[](1);
120
+ ai[0] = REVAutoIssuance({chainId: uint32(block.chainid), count: uint104(70_000e18), beneficiary: multisig()});
121
+ stages[0] = REVStageConfig({
122
+ startsAtOrAfter: uint40(block.timestamp),
123
+ autoIssuances: ai,
124
+ splitPercent: 2000,
125
+ splits: splits,
126
+ initialIssuance: uint112(1000e18),
127
+ issuanceCutFrequency: 90 days,
128
+ issuanceCutPercent: JBConstants.MAX_WEIGHT_CUT_PERCENT / 2,
129
+ cashOutTaxRate: 6000,
130
+ extraMetadata: 0
131
+ });
132
+
133
+ REVConfig memory cfg = REVConfig({
134
+ description: REVDescription("Revnet", "$REV", "ipfs://test", ERC20_SALT),
135
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
136
+ splitOperator: multisig(),
137
+ stageConfigurations: stages
138
+ });
139
+ vm.prank(multisig());
140
+ REV_DEPLOYER.deployFor({
141
+ revnetId: FEE_PROJECT_ID,
142
+ configuration: cfg,
143
+ terminalConfigurations: tc,
144
+ suckerDeploymentConfiguration: REVSuckerDeploymentConfig({
145
+ deployerConfigurations: new JBSuckerDeployerConfig[](0), salt: keccak256("FEE")
146
+ })
147
+ });
148
+ }
149
+
150
+ function _deployRevnet() internal {
151
+ JBAccountingContext[] memory acc = new JBAccountingContext[](2);
152
+ acc[0] = JBAccountingContext({
153
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
154
+ });
155
+ acc[1] = JBAccountingContext({token: address(TOKEN), decimals: 6, currency: uint32(uint160(address(TOKEN)))});
156
+ JBTerminalConfig[] memory tc = new JBTerminalConfig[](1);
157
+ tc[0] = JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: acc});
158
+
159
+ REVStageConfig[] memory stages = new REVStageConfig[](1);
160
+ JBSplit[] memory splits = new JBSplit[](1);
161
+ splits[0].beneficiary = payable(multisig());
162
+ splits[0].percent = 10_000;
163
+ REVAutoIssuance[] memory ai = new REVAutoIssuance[](1);
164
+ ai[0] = REVAutoIssuance({chainId: uint32(block.chainid), count: uint104(70_000e18), beneficiary: multisig()});
165
+ stages[0] = REVStageConfig({
166
+ startsAtOrAfter: uint40(block.timestamp),
167
+ autoIssuances: ai,
168
+ splitPercent: 2000,
169
+ splits: splits,
170
+ initialIssuance: uint112(1000e18),
171
+ issuanceCutFrequency: 90 days,
172
+ issuanceCutPercent: JBConstants.MAX_WEIGHT_CUT_PERCENT / 2,
173
+ cashOutTaxRate: 6000,
174
+ extraMetadata: 0
175
+ });
176
+
177
+ REVLoanSource[] memory ls = new REVLoanSource[](1);
178
+ ls[0] = REVLoanSource({token: JBConstants.NATIVE_TOKEN, terminal: jbMultiTerminal()});
179
+
180
+ REVConfig memory cfg = REVConfig({
181
+ description: REVDescription("NANA", "$NANA", "ipfs://test2", "NANA_TOKEN"),
182
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
183
+ splitOperator: multisig(),
184
+ stageConfigurations: stages
185
+ });
186
+ REVNET_ID = REV_DEPLOYER.deployFor({
187
+ revnetId: 0,
188
+ configuration: cfg,
189
+ terminalConfigurations: tc,
190
+ suckerDeploymentConfiguration: REVSuckerDeploymentConfig({
191
+ deployerConfigurations: new JBSuckerDeployerConfig[](0), salt: keccak256("NANA")
192
+ })
193
+ });
194
+ }
195
+
196
+ function _setupLoan(
197
+ address user,
198
+ uint256 ethAmount,
199
+ uint256 prepaidFee
200
+ )
201
+ internal
202
+ returns (uint256 loanId, uint256 tokenCount, uint256 borrowAmount)
203
+ {
204
+ vm.prank(user);
205
+ tokenCount =
206
+ jbMultiTerminal().pay{value: ethAmount}(REVNET_ID, JBConstants.NATIVE_TOKEN, ethAmount, user, 0, "", "");
207
+
208
+ borrowAmount =
209
+ LOANS_CONTRACT.borrowableAmountFrom(REVNET_ID, tokenCount, 18, uint32(uint160(JBConstants.NATIVE_TOKEN)));
210
+ if (borrowAmount == 0) return (0, tokenCount, 0);
211
+
212
+ mockExpect(
213
+ address(jbPermissions()),
214
+ abi.encodeCall(IJBPermissions.hasPermission, (address(LOANS_CONTRACT), user, REVNET_ID, 11, true, true)),
215
+ abi.encode(true)
216
+ );
217
+
218
+ REVLoanSource memory source = REVLoanSource({token: JBConstants.NATIVE_TOKEN, terminal: jbMultiTerminal()});
219
+ vm.prank(user);
220
+ (loanId,) = LOANS_CONTRACT.borrowFrom(REVNET_ID, source, 0, tokenCount, payable(user), prepaidFee);
221
+ }
222
+
223
+ /// @notice Verify loan creation with a reasonable borrow amount succeeds.
224
+ function test_borrowNormalAmount_succeeds() public {
225
+ (uint256 loanId, uint256 tokenCount, uint256 borrowAmount) = _setupLoan(USER, 10e18, 25);
226
+ assertTrue(borrowAmount > 0, "Should have nonzero borrow amount");
227
+ assertTrue(loanId > 0, "Should have created a loan");
228
+
229
+ REVLoan memory loan = LOANS_CONTRACT.loanOf(loanId);
230
+ assertEq(loan.amount, borrowAmount, "Loan amount should match borrowed amount");
231
+ assertEq(loan.collateral, tokenCount, "Loan collateral should match token count");
232
+ }
233
+
234
+ /// @notice Verify that uint112.max exactly does NOT revert (boundary test).
235
+ function test_boundaryValue_exactlyUint112Max() public {
236
+ // uint112.max is the boundary — the check is `>`, not `>=`
237
+ // So exactly uint112.max should NOT revert
238
+ uint256 maxVal = type(uint112).max;
239
+ uint112 casted = uint112(maxVal);
240
+ assertEq(uint256(casted), maxVal, "Casting uint112.max should not truncate");
241
+ }
242
+
243
+ /// @notice Verify the overflow check exists: values > uint112.max are rejected.
244
+ /// @dev We verify this by checking the error selector exists on the contract.
245
+ function test_overflowRevert_errorExists() public view {
246
+ // The fix adds REVLoans_OverflowAlert error. Verify the error exists
247
+ // by encoding it. If this compiles, the error exists.
248
+ bytes4 selector = REVLoans.REVLoans_OverflowAlert.selector;
249
+ assertTrue(selector != bytes4(0), "OverflowAlert error should exist");
250
+ }
251
+ }
@@ -0,0 +1,221 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity 0.8.23;
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/swap-terminal-v6/script/helpers/SwapTerminalDeploymentLib.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 {REVLoans} from "../src/REVLoans.sol";
18
+ import {REVStageConfig, REVAutoIssuance} from "../src/structs/REVStageConfig.sol";
19
+ import {REVLoanSource} from "../src/structs/REVLoanSource.sol";
20
+ import {REVDescription} from "../src/structs/REVDescription.sol";
21
+ import {IREVLoans} from "./../src/interfaces/IREVLoans.sol";
22
+ import {JBSuckerDeployerConfig} from "@bananapus/suckers-v6/src/structs/JBSuckerDeployerConfig.sol";
23
+ import {JBSuckerRegistry} from "@bananapus/suckers-v6/src/JBSuckerRegistry.sol";
24
+ import {JB721TiersHookDeployer} from "@bananapus/721-hook-v6/src/JB721TiersHookDeployer.sol";
25
+ import {JB721TiersHook} from "@bananapus/721-hook-v6/src/JB721TiersHook.sol";
26
+ import {JB721TiersHookStore} from "@bananapus/721-hook-v6/src/JB721TiersHookStore.sol";
27
+ import {JBAddressRegistry} from "@bananapus/address-registry-v6/src/JBAddressRegistry.sol";
28
+ import {IJBAddressRegistry} from "@bananapus/address-registry-v6/src/interfaces/IJBAddressRegistry.sol";
29
+ import {JBBeforePayRecordedContext} from "@bananapus/core-v6/src/structs/JBBeforePayRecordedContext.sol";
30
+ import {JBPayHookSpecification} from "@bananapus/core-v6/src/structs/JBPayHookSpecification.sol";
31
+ import {JBTokenAmount} from "@bananapus/core-v6/src/structs/JBTokenAmount.sol";
32
+ import {JBRuleset} from "@bananapus/core-v6/src/structs/JBRuleset.sol";
33
+
34
+ /// @notice Tests for PR #22: fix/c2-hook-array-oob
35
+ /// Verifies that the fix for the C-2 hook array out-of-bounds bug works correctly.
36
+ /// The bug: `hookSpecifications[1] = buybackHookSpecifications[0]` would revert with OOB
37
+ /// when there is no tiered 721 hook (array size is 1, not 2).
38
+ /// The fix: `hookSpecifications[usesTiered721Hook ? 1 : 0] = buybackHookSpecifications[0]`.
39
+ contract TestPR22_HookArrayOOB 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
+ IREVLoans LOANS_CONTRACT;
48
+ IJBSuckerRegistry SUCKER_REGISTRY;
49
+ CTPublisher PUBLISHER;
50
+ MockBuybackDataHook MOCK_BUYBACK;
51
+
52
+ uint256 FEE_PROJECT_ID;
53
+
54
+ address private constant TRUSTED_FORWARDER = 0xB2b5841DBeF766d4b521221732F9B618fCf34A87;
55
+ address USER = makeAddr("user");
56
+
57
+ function setUp() public override {
58
+ super.setUp();
59
+ FEE_PROJECT_ID = jbProjects().createFor(multisig());
60
+ SUCKER_REGISTRY = new JBSuckerRegistry(jbDirectory(), jbPermissions(), multisig(), address(0));
61
+ HOOK_STORE = new JB721TiersHookStore();
62
+ EXAMPLE_HOOK = new JB721TiersHook(jbDirectory(), jbPermissions(), jbRulesets(), HOOK_STORE, multisig());
63
+ ADDRESS_REGISTRY = new JBAddressRegistry();
64
+ HOOK_DEPLOYER = new JB721TiersHookDeployer(EXAMPLE_HOOK, HOOK_STORE, ADDRESS_REGISTRY, multisig());
65
+ PUBLISHER = new CTPublisher(jbDirectory(), jbPermissions(), FEE_PROJECT_ID, multisig());
66
+ MOCK_BUYBACK = new MockBuybackDataHook();
67
+ LOANS_CONTRACT = new REVLoans({
68
+ controller: jbController(),
69
+ projects: jbProjects(),
70
+ revId: FEE_PROJECT_ID,
71
+ owner: address(this),
72
+ permit2: permit2(),
73
+ trustedForwarder: TRUSTED_FORWARDER
74
+ });
75
+ REV_DEPLOYER = new REVDeployer{salt: REV_DEPLOYER_SALT}(
76
+ jbController(),
77
+ SUCKER_REGISTRY,
78
+ FEE_PROJECT_ID,
79
+ HOOK_DEPLOYER,
80
+ PUBLISHER,
81
+ IJBRulesetDataHook(address(MOCK_BUYBACK)),
82
+ address(LOANS_CONTRACT),
83
+ TRUSTED_FORWARDER
84
+ );
85
+ vm.prank(multisig());
86
+ jbProjects().approve(address(REV_DEPLOYER), FEE_PROJECT_ID);
87
+ }
88
+
89
+ /// @notice Helper to build a minimal revnet config with no hooks.
90
+ function _buildMinimalConfig()
91
+ internal
92
+ view
93
+ returns (REVConfig memory cfg, JBTerminalConfig[] memory tc, REVSuckerDeploymentConfig memory sdc)
94
+ {
95
+ JBAccountingContext[] memory acc = new JBAccountingContext[](1);
96
+ acc[0] = JBAccountingContext({
97
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
98
+ });
99
+ tc = new JBTerminalConfig[](1);
100
+ tc[0] = JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: acc});
101
+
102
+ REVStageConfig[] memory stages = new REVStageConfig[](1);
103
+ JBSplit[] memory splits = new JBSplit[](1);
104
+ splits[0].beneficiary = payable(multisig());
105
+ splits[0].percent = 10_000;
106
+ stages[0] = REVStageConfig({
107
+ startsAtOrAfter: uint40(block.timestamp),
108
+ autoIssuances: new REVAutoIssuance[](0),
109
+ splitPercent: 0,
110
+ splits: splits,
111
+ initialIssuance: uint112(1000e18),
112
+ issuanceCutFrequency: 0,
113
+ issuanceCutPercent: 0,
114
+ cashOutTaxRate: 5000,
115
+ extraMetadata: 0
116
+ });
117
+
118
+ cfg = REVConfig({
119
+ description: REVDescription("Test", "TST", "ipfs://test", "TEST_SALT"),
120
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
121
+ splitOperator: multisig(),
122
+ stageConfigurations: stages
123
+ });
124
+
125
+ sdc = REVSuckerDeploymentConfig({
126
+ deployerConfigurations: new JBSuckerDeployerConfig[](0), salt: keccak256(abi.encodePacked("TEST"))
127
+ });
128
+ }
129
+
130
+ /// @notice Helper to deploy the fee project first and then deploy a test revnet.
131
+ function _deployFeeAndRevnet() internal returns (uint256 revnetId) {
132
+ (REVConfig memory feeCfg, JBTerminalConfig[] memory feeTc, REVSuckerDeploymentConfig memory feeSdc) =
133
+ _buildMinimalConfig();
134
+
135
+ // Deploy the fee project
136
+ vm.prank(multisig());
137
+ REV_DEPLOYER.deployFor({
138
+ revnetId: FEE_PROJECT_ID,
139
+ configuration: feeCfg,
140
+ terminalConfigurations: feeTc,
141
+ suckerDeploymentConfiguration: feeSdc
142
+ });
143
+
144
+ // Deploy a new test revnet (revnetId: 0 = create new)
145
+ (REVConfig memory cfg, JBTerminalConfig[] memory tc, REVSuckerDeploymentConfig memory sdc) =
146
+ _buildMinimalConfig();
147
+ // Use a different salt so the ERC20 deploy doesn't clash
148
+ cfg.description = REVDescription("Test2", "TS2", "ipfs://test2", "TEST_SALT_2");
149
+
150
+ revnetId = REV_DEPLOYER.deployFor({
151
+ revnetId: 0, configuration: cfg, terminalConfigurations: tc, suckerDeploymentConfiguration: sdc
152
+ });
153
+ }
154
+
155
+ /// @notice Test that paying a revnet with no hooks (no 721, no buyback) works fine.
156
+ /// This exercises beforePayRecordedWith where both usesTiered721Hook and usesBuybackHook are false.
157
+ function test_payRevnet_noHooks_works() public {
158
+ uint256 revnetId = _deployFeeAndRevnet();
159
+
160
+ // Pay into the revnet
161
+ vm.deal(USER, 1 ether);
162
+ vm.prank(USER);
163
+ jbMultiTerminal().pay{value: 1 ether}({
164
+ projectId: revnetId,
165
+ token: JBConstants.NATIVE_TOKEN,
166
+ amount: 1 ether,
167
+ beneficiary: USER,
168
+ minReturnedTokens: 0,
169
+ memo: "test payment",
170
+ metadata: ""
171
+ });
172
+
173
+ // Verify tokens were minted
174
+ uint256 balance = jbTokens().totalBalanceOf(USER, revnetId);
175
+ assertGt(balance, 0, "Should have received tokens from payment");
176
+ }
177
+
178
+ /// @notice Test the array index logic directly: `usesTiered721Hook ? 1 : 0` gives index 0 for buyback-only.
179
+ function test_arrayIndexLogic_unitTest() public pure {
180
+ // When no tiered 721 hook is present, the buyback hook should be at index 0
181
+ bool usesTiered721Hook = false;
182
+ uint256 buybackIndex = usesTiered721Hook ? 1 : 0;
183
+ assertEq(buybackIndex, 0, "Buyback hook index should be 0 when no 721 hook");
184
+
185
+ // When tiered 721 hook IS present, the buyback hook should be at index 1
186
+ usesTiered721Hook = true;
187
+ buybackIndex = usesTiered721Hook ? 1 : 0;
188
+ assertEq(buybackIndex, 1, "Buyback hook index should be 1 when 721 hook present");
189
+ }
190
+
191
+ /// @notice Test that beforePayRecordedWith returns correct hook specification counts.
192
+ /// When no hooks are configured, should return empty array.
193
+ function test_beforePayRecordedWith_noHooks_returnsEmptySpecs() public {
194
+ uint256 revnetId = _deployFeeAndRevnet();
195
+
196
+ // Build a mock context for beforePayRecordedWith
197
+ JBBeforePayRecordedContext memory context = JBBeforePayRecordedContext({
198
+ terminal: address(jbMultiTerminal()),
199
+ payer: USER,
200
+ amount: JBTokenAmount({
201
+ token: JBConstants.NATIVE_TOKEN,
202
+ value: 1 ether,
203
+ decimals: 18,
204
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
205
+ }),
206
+ projectId: revnetId,
207
+ rulesetId: 0,
208
+ beneficiary: USER,
209
+ weight: 1000e18,
210
+ reservedPercent: 0,
211
+ metadata: ""
212
+ });
213
+
214
+ (uint256 weight, JBPayHookSpecification[] memory specs) = REV_DEPLOYER.beforePayRecordedWith(context);
215
+
216
+ // With the global buyback hook but no 721 hook, weight should be the context weight
217
+ // and specs should contain exactly the buyback hook specification.
218
+ assertEq(weight, context.weight, "Weight should be the default context weight");
219
+ assertEq(specs.length, 1, "Should have exactly the buyback hook specification");
220
+ }
221
+ }