@bananapus/core-v6 0.0.36 → 0.0.38

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 (286) hide show
  1. package/foundry.lock +1 -7
  2. package/foundry.toml +1 -1
  3. package/package.json +19 -7
  4. package/src/JBController.sol +26 -5
  5. package/src/JBMultiTerminal.sol +85 -47
  6. package/src/JBTerminalStore.sol +6 -6
  7. package/src/interfaces/IJBController.sol +4 -1
  8. package/src/libraries/JBFees.sol +47 -9
  9. package/src/libraries/JBPayoutSplitGroupLib.sol +2 -2
  10. package/src/periphery/JBMatchingPriceFeed.sol +1 -1
  11. package/test/mock/MockMaliciousBeneficiary.sol +15 -15
  12. package/ADMINISTRATION.md +0 -103
  13. package/ARCHITECTURE.md +0 -133
  14. package/AUDIT_INSTRUCTIONS.md +0 -139
  15. package/RISKS.md +0 -215
  16. package/SKILLS.md +0 -55
  17. package/STYLE_GUIDE.md +0 -610
  18. package/USER_JOURNEYS.md +0 -215
  19. package/script/Deploy.s.sol +0 -124
  20. package/script/DeployPeriphery.s.sol +0 -354
  21. package/slither-ci.config.json +0 -10
  22. package/test/AuditFixes.t.sol +0 -808
  23. package/test/ComprehensiveInvariant.t.sol +0 -306
  24. package/test/CoreExploitTests.t.sol +0 -2741
  25. package/test/EconomicSimulation.t.sol +0 -348
  26. package/test/EntryPointPermutations.t.sol +0 -684
  27. package/test/FlashLoanAttacks.t.sol +0 -797
  28. package/test/PermissionEscalation.t.sol +0 -711
  29. package/test/PermissionsInvariant.t.sol +0 -403
  30. package/test/RulesetTransitions.t.sol +0 -713
  31. package/test/SplitLoopTests.t.sol +0 -752
  32. package/test/TestAccessToFunds.sol +0 -2683
  33. package/test/TestAuditResponseDesignProofs.sol +0 -434
  34. package/test/TestCashOut.sol +0 -198
  35. package/test/TestCashOutCountFor.sol +0 -271
  36. package/test/TestCashOutHooks.sol +0 -351
  37. package/test/TestCashOutTimingEdge.sol +0 -241
  38. package/test/TestDataHookFuzzing.sol +0 -524
  39. package/test/TestDurationUnderflow.sol +0 -233
  40. package/test/TestFeeFreeCashOutBypass.sol +0 -949
  41. package/test/TestFeeProcessingFailure.sol +0 -218
  42. package/test/TestFees.sol +0 -619
  43. package/test/TestForwardedTokenConsumption.sol +0 -425
  44. package/test/TestInterfaceSupport.sol +0 -81
  45. package/test/TestJBERC20Inheritance.sol +0 -103
  46. package/test/TestL2SequencerPriceFeed.sol +0 -292
  47. package/test/TestLaunchProject.sol +0 -188
  48. package/test/TestMetaTx.sol +0 -217
  49. package/test/TestMetadataOffsetOverflow.sol +0 -179
  50. package/test/TestMetadataParserLib.sol +0 -471
  51. package/test/TestMigrationHeldFees.sol +0 -255
  52. package/test/TestMintTokensOf.sol +0 -185
  53. package/test/TestMultiTerminalSurplus.sol +0 -348
  54. package/test/TestMultiTokenSurplus.sol +0 -202
  55. package/test/TestMultipleAccessLimits.sol +0 -664
  56. package/test/TestPayBurnRedeemFlow.sol +0 -195
  57. package/test/TestPayHooks.sol +0 -209
  58. package/test/TestPermissions.sol +0 -324
  59. package/test/TestPermissionsEdge.sol +0 -290
  60. package/test/TestPermit2DataHook.t.sol +0 -360
  61. package/test/TestPermit2Terminal.sol +0 -372
  62. package/test/TestRulesetQueueing.sol +0 -1025
  63. package/test/TestRulesetQueuingStress.sol +0 -806
  64. package/test/TestRulesetWeightCaching.sol +0 -178
  65. package/test/TestSplits.sol +0 -391
  66. package/test/TestTerminalMigration.sol +0 -274
  67. package/test/TestTerminalPreviewParity.sol +0 -208
  68. package/test/TestTokenFlow.sol +0 -191
  69. package/test/TestWeightCacheStaleAfterRejection.sol +0 -303
  70. package/test/WeirdTokenTests.t.sol +0 -817
  71. package/test/audit/CashOutReenterPay.t.sol +0 -501
  72. package/test/audit/CodexHeldFeeRounding.t.sol +0 -159
  73. package/test/audit/CrossTerminalSurplusSpoof.t.sol +0 -140
  74. package/test/audit/CycledSurplusAllowanceReset.t.sol +0 -184
  75. package/test/audit/FeeFreeSurplusLifecycle.t.sol +0 -399
  76. package/test/audit/FeeFreeSurplusStale.t.sol +0 -248
  77. package/test/audit/USDTVoidReturnCompat.t.sol +0 -525
  78. package/test/fork/TestChainlinkPriceFeedFork.sol +0 -254
  79. package/test/fork/TestSequencerPriceFeedFork.sol +0 -168
  80. package/test/fork/TestTerminalPreviewParityFork.sol +0 -108
  81. package/test/formal/BondingCurveProperties.t.sol +0 -420
  82. package/test/formal/FeeProperties.t.sol +0 -252
  83. package/test/invariants/Phase3DeepInvariant.t.sol +0 -412
  84. package/test/invariants/RulesetsInvariant.t.sol +0 -125
  85. package/test/invariants/TerminalStoreInvariant.t.sol +0 -227
  86. package/test/invariants/TokensInvariant.t.sol +0 -195
  87. package/test/invariants/handlers/ComprehensiveHandler.sol +0 -303
  88. package/test/invariants/handlers/EconomicHandler.sol +0 -377
  89. package/test/invariants/handlers/Phase3Handler.sol +0 -443
  90. package/test/invariants/handlers/RulesetsHandler.sol +0 -115
  91. package/test/invariants/handlers/TerminalStoreHandler.sol +0 -151
  92. package/test/invariants/handlers/TokensHandler.sol +0 -126
  93. package/test/regression/HoldFeesCashOutReserved.t.sol +0 -415
  94. package/test/regression/WeightCacheBoundary.t.sol +0 -291
  95. package/test/trees/JBController/burnTokensOf.tree +0 -9
  96. package/test/trees/JBController/claimTokensFor.tree +0 -5
  97. package/test/trees/JBController/deployERC20For.tree +0 -5
  98. package/test/trees/JBController/getRulesetOf.tree +0 -5
  99. package/test/trees/JBController/launchProjectFor.tree +0 -12
  100. package/test/trees/JBController/launchRulesetsFor.tree +0 -8
  101. package/test/trees/JBController/migrateController.tree +0 -12
  102. package/test/trees/JBController/mintTokensOf.tree +0 -12
  103. package/test/trees/JBController/payReservedTokenToTerminal.tree +0 -8
  104. package/test/trees/JBController/receiveMigrationFrom.tree +0 -4
  105. package/test/trees/JBController/sendReservedTokensToSplitsOf.tree +0 -12
  106. package/test/trees/JBController/setMetadataOf.tree +0 -5
  107. package/test/trees/JBController/setSplitGroupsOf.tree +0 -5
  108. package/test/trees/JBController/setTokenFor.tree +0 -5
  109. package/test/trees/JBController/transferCreditsFrom.tree +0 -8
  110. package/test/trees/JBDirectory/primaryTerminalOf.tree +0 -8
  111. package/test/trees/JBDirectory/setControllerOf.tree +0 -11
  112. package/test/trees/JBDirectory/setPrimaryTerminalOf.tree +0 -15
  113. package/test/trees/JBDirectory/setTerminalsOf.tree +0 -11
  114. package/test/trees/JBERC20/initialize.tree +0 -7
  115. package/test/trees/JBERC20/name.tree +0 -5
  116. package/test/trees/JBERC20/nonces.tree +0 -5
  117. package/test/trees/JBERC20/symbol.tree +0 -5
  118. package/test/trees/JBFeelessAddresses/setFeelessAddress.tree +0 -5
  119. package/test/trees/JBFeelessAddresses/supportsInterface.tree +0 -5
  120. package/test/trees/JBFundAccessLimits/payoutLimitOf.tree +0 -5
  121. package/test/trees/JBFundAccessLimits/payoutLimitsOf.tree +0 -8
  122. package/test/trees/JBFundAccessLimits/setFundAccessLimitsFor.tree +0 -18
  123. package/test/trees/JBFundAccessLimits/surplusAllowanceOf.tree +0 -5
  124. package/test/trees/JBFundAccessLimits/surplusAllowancesOf.tree +0 -8
  125. package/test/trees/JBMetadataResolver/getDataFor.tree +0 -8
  126. package/test/trees/JBMultiTerminal/accountingContextsOf.tree +0 -5
  127. package/test/trees/JBMultiTerminal/addAccountingContextsFor.tree +0 -10
  128. package/test/trees/JBMultiTerminal/addToBalanceOf.tree +0 -23
  129. package/test/trees/JBMultiTerminal/cashOutTokensOf.tree +0 -23
  130. package/test/trees/JBMultiTerminal/executePayout.tree +0 -32
  131. package/test/trees/JBMultiTerminal/executeProcessFee.tree +0 -14
  132. package/test/trees/JBMultiTerminal/migrateBalanceOf.tree +0 -12
  133. package/test/trees/JBMultiTerminal/pay.tree +0 -23
  134. package/test/trees/JBMultiTerminal/processHeldFeesOf.tree +0 -8
  135. package/test/trees/JBMultiTerminal/sendPayoutsOf.tree +0 -34
  136. package/test/trees/JBMultiTerminal/useAllowanceOf.tree +0 -16
  137. package/test/trees/JBPermissions/hasPermission.tree +0 -8
  138. package/test/trees/JBPermissions/hasPermissions.tree +0 -8
  139. package/test/trees/JBPermissions/setPermissionsFor.tree +0 -5
  140. package/test/trees/JBPrices/addPriceFeedFor.tree +0 -14
  141. package/test/trees/JBPrices/pricePerUnitOf.tree +0 -11
  142. package/test/trees/JBProjects/createFor.tree +0 -11
  143. package/test/trees/JBProjects/setTokenUriResolver.tree +0 -5
  144. package/test/trees/JBProjects/supportsInterface.tree +0 -9
  145. package/test/trees/JBProjects/tokenURI.tree +0 -5
  146. package/test/trees/JBRulesets/currentApprovalStatusForLatestRulesetOf.tree +0 -8
  147. package/test/trees/JBRulesets/currentOf.tree +0 -12
  148. package/test/trees/JBRulesets/getRulesetOf.tree +0 -5
  149. package/test/trees/JBRulesets/latestQueuedRulesetOf.tree +0 -10
  150. package/test/trees/JBRulesets/rulesetsOf.tree +0 -11
  151. package/test/trees/JBRulesets/upcomingRulesetOf.tree +0 -20
  152. package/test/trees/JBRulesets/updateRulesetWeightCache.tree +0 -5
  153. package/test/trees/JBSplits/setSplitGroupsOf.tree +0 -17
  154. package/test/trees/JBSplits/splitsOf.tree +0 -5
  155. package/test/trees/JBTerminalStore/currentReclaimableSurplusOf.tree +0 -16
  156. package/test/trees/JBTerminalStore/currentSurplusOf.tree +0 -25
  157. package/test/trees/JBTerminalStore/currentTotalSurplusOf.tree +0 -5
  158. package/test/trees/JBTerminalStore/recordCashOutsFor.tree +0 -16
  159. package/test/trees/JBTerminalStore/recordPaymentFrom.tree +0 -14
  160. package/test/trees/JBTerminalStore/recordPayoutFor.tree +0 -10
  161. package/test/trees/JBTerminalStore/recordTerminalMigration.tree +0 -5
  162. package/test/trees/JBTerminalStore/recordUsedAllowanceOf.tree +0 -10
  163. package/test/trees/JBTokens/burnFrom.tree +0 -10
  164. package/test/trees/JBTokens/claimTokensFor.tree +0 -10
  165. package/test/trees/JBTokens/deployERC20For.tree +0 -12
  166. package/test/trees/JBTokens/mintFor.tree +0 -10
  167. package/test/trees/JBTokens/setTokenFor.tree +0 -11
  168. package/test/trees/JBTokens/totalBalanceOf.tree +0 -5
  169. package/test/trees/JBTokens/totalSupplyOf.tree +0 -5
  170. package/test/trees/JBTokens/transferCreditsFrom.tree +0 -8
  171. package/test/trees/mintTokensOf.tree +0 -12
  172. package/test/units/static/JBChainlinkV3PriceFeed/TestPriceFeed.sol +0 -223
  173. package/test/units/static/JBController/JBControllerSetup.sol +0 -50
  174. package/test/units/static/JBController/TestBurnTokensOf.sol +0 -114
  175. package/test/units/static/JBController/TestClaimTokensFor.sol +0 -63
  176. package/test/units/static/JBController/TestDeployErc20For.sol +0 -86
  177. package/test/units/static/JBController/TestLaunchProjectFor.sol +0 -302
  178. package/test/units/static/JBController/TestLaunchRulesetsFor.sol +0 -342
  179. package/test/units/static/JBController/TestMigrateController.sol +0 -157
  180. package/test/units/static/JBController/TestMintTokensOfUnits.sol +0 -111
  181. package/test/units/static/JBController/TestOmnichainRulesetOperator.sol +0 -324
  182. package/test/units/static/JBController/TestPayReservedTokenToTerminal.sol +0 -74
  183. package/test/units/static/JBController/TestPreviewMintOf.sol +0 -117
  184. package/test/units/static/JBController/TestReceiveMigrationFrom.sol +0 -99
  185. package/test/units/static/JBController/TestRulesetViews.sol +0 -225
  186. package/test/units/static/JBController/TestSendReservedTokensToSplitsOf.sol +0 -615
  187. package/test/units/static/JBController/TestSetSplitGroupsOf.sol +0 -68
  188. package/test/units/static/JBController/TestSetTokenFor.sol +0 -239
  189. package/test/units/static/JBController/TestSetUriOf.sol +0 -57
  190. package/test/units/static/JBController/TestTransferCreditsFrom.sol +0 -169
  191. package/test/units/static/JBDeadline/TestDeadlineFuzz.sol +0 -211
  192. package/test/units/static/JBDirectory/JBDirectorySetup.sol +0 -26
  193. package/test/units/static/JBDirectory/TestPrimaryTerminalOf.sol +0 -126
  194. package/test/units/static/JBDirectory/TestSetControllerOf.sol +0 -183
  195. package/test/units/static/JBDirectory/TestSetControllerOfMigrationOrder.sol +0 -104
  196. package/test/units/static/JBDirectory/TestSetPrimaryTerminalOf.sol +0 -179
  197. package/test/units/static/JBDirectory/TestSetTerminalsOf.sol +0 -137
  198. package/test/units/static/JBERC20/JBERC20Setup.sol +0 -34
  199. package/test/units/static/JBERC20/SigUtils.sol +0 -36
  200. package/test/units/static/JBERC20/TestInitialize.sol +0 -60
  201. package/test/units/static/JBERC20/TestName.sol +0 -30
  202. package/test/units/static/JBERC20/TestNonces.sol +0 -62
  203. package/test/units/static/JBERC20/TestSymbol.sol +0 -31
  204. package/test/units/static/JBFeelessAdresses/JBFeelessSetup.sol +0 -22
  205. package/test/units/static/JBFeelessAdresses/TestInterfaces.sol +0 -30
  206. package/test/units/static/JBFeelessAdresses/TestSetFeelessAddress.sol +0 -35
  207. package/test/units/static/JBFees/TestFeesFuzz.sol +0 -79
  208. package/test/units/static/JBFixedPointNumber/TestAdjustDecimals.sol +0 -16
  209. package/test/units/static/JBFixedPointNumber/TestAdjustDecimalsFuzz.sol +0 -71
  210. package/test/units/static/JBFundAccessLimits/JBFundAccessSetup.sol +0 -24
  211. package/test/units/static/JBFundAccessLimits/TestFundAccessLimitsEdge.sol +0 -163
  212. package/test/units/static/JBFundAccessLimits/TestPayoutLimitOf.sol +0 -59
  213. package/test/units/static/JBFundAccessLimits/TestPayoutLimitsOf.sol +0 -101
  214. package/test/units/static/JBFundAccessLimits/TestSetFundAccessLimitsFor.sol +0 -189
  215. package/test/units/static/JBFundAccessLimits/TestSurplusAllowanceOf.sol +0 -64
  216. package/test/units/static/JBFundAccessLimits/TestSurplusAllowancesOf.sol +0 -102
  217. package/test/units/static/JBMetadataResolver/TestGetDataFor.sol +0 -90
  218. package/test/units/static/JBMetadataResolver/TestMetadataResolverEdgeCases.sol +0 -247
  219. package/test/units/static/JBMetadataResolver/TestMetadataResolverFuzz.sol +0 -229
  220. package/test/units/static/JBMultiTerminal/JBMultiTerminalSetup.sol +0 -50
  221. package/test/units/static/JBMultiTerminal/TestAccountingContextsOf.sol +0 -72
  222. package/test/units/static/JBMultiTerminal/TestAddAccountingContextsFor.sol +0 -289
  223. package/test/units/static/JBMultiTerminal/TestAddToBalanceOf.sol +0 -474
  224. package/test/units/static/JBMultiTerminal/TestCashOutTokensOf.sol +0 -624
  225. package/test/units/static/JBMultiTerminal/TestExecutePayout.sol +0 -578
  226. package/test/units/static/JBMultiTerminal/TestExecuteProcessFee.sol +0 -202
  227. package/test/units/static/JBMultiTerminal/TestMigrateBalanceOf.sol +0 -222
  228. package/test/units/static/JBMultiTerminal/TestPay.sol +0 -604
  229. package/test/units/static/JBMultiTerminal/TestPreviewCashOutFrom.sol +0 -117
  230. package/test/units/static/JBMultiTerminal/TestPreviewPayFor.sol +0 -114
  231. package/test/units/static/JBMultiTerminal/TestProcessHeldFeesOf.sol +0 -228
  232. package/test/units/static/JBMultiTerminal/TestSelfPayRevert.sol +0 -55
  233. package/test/units/static/JBMultiTerminal/TestSendPayoutsOf.sol +0 -257
  234. package/test/units/static/JBMultiTerminal/TestUseAllowanceOf.sol +0 -611
  235. package/test/units/static/JBPermissions/JBPermissionsSetup.sol +0 -20
  236. package/test/units/static/JBPermissions/TestHasPermission.sol +0 -50
  237. package/test/units/static/JBPermissions/TestHasPermissions.sol +0 -93
  238. package/test/units/static/JBPermissions/TestSetPermissionsFor.sol +0 -64
  239. package/test/units/static/JBPrices/JBPricesSetup.sol +0 -32
  240. package/test/units/static/JBPrices/TestAddPriceFeedFor.sol +0 -107
  241. package/test/units/static/JBPrices/TestPricePerUnitOf.sol +0 -132
  242. package/test/units/static/JBPrices/TestPrices.sol +0 -265
  243. package/test/units/static/JBProjects/JBProjectsSetup.sol +0 -22
  244. package/test/units/static/JBProjects/TestCreateFor.sol +0 -71
  245. package/test/units/static/JBProjects/TestInitialProject.sol +0 -21
  246. package/test/units/static/JBProjects/TestInterfaces.sol +0 -26
  247. package/test/units/static/JBProjects/TestSetResolver.sol +0 -37
  248. package/test/units/static/JBProjects/TestTokenUri.sol +0 -40
  249. package/test/units/static/JBRulesetMetadataResolver/TestSetCashOutTaxRateTo.sol +0 -108
  250. package/test/units/static/JBRulesets/JBRulesetsSetup.sol +0 -24
  251. package/test/units/static/JBRulesets/TestCurrentApprovalStatusForLatestRulesetOf.sol +0 -265
  252. package/test/units/static/JBRulesets/TestCurrentOf.sol +0 -242
  253. package/test/units/static/JBRulesets/TestGetRulesetOf.sol +0 -100
  254. package/test/units/static/JBRulesets/TestLatestQueuedRulesetOf.sol +0 -260
  255. package/test/units/static/JBRulesets/TestRulesets.sol +0 -632
  256. package/test/units/static/JBRulesets/TestRulesetsOf.sol +0 -37
  257. package/test/units/static/JBRulesets/TestUpcomingRulesetOf.sol +0 -522
  258. package/test/units/static/JBRulesets/TestUpdateRulesetWeightCache.sol +0 -96
  259. package/test/units/static/JBSplits/JBSplitsSetup.sol +0 -26
  260. package/test/units/static/JBSplits/TestSelfManagedSplitGroups.sol +0 -552
  261. package/test/units/static/JBSplits/TestSetSplitGroupsOf.sol +0 -377
  262. package/test/units/static/JBSplits/TestSplitsLockedEdge.sol +0 -267
  263. package/test/units/static/JBSplits/TestSplitsOf.sol +0 -24
  264. package/test/units/static/JBSplits/TestSplitsPacking.sol +0 -36
  265. package/test/units/static/JBSurplus/TestSurplusFuzz.sol +0 -160
  266. package/test/units/static/JBTerminalStore/JBTerminalStoreSetup.sol +0 -45
  267. package/test/units/static/JBTerminalStore/TestCurrentReclaimableSurplusOf.sol +0 -536
  268. package/test/units/static/JBTerminalStore/TestCurrentSurplusOf.sol +0 -463
  269. package/test/units/static/JBTerminalStore/TestCurrentTotalSurplusOf.sol +0 -135
  270. package/test/units/static/JBTerminalStore/TestPreviewCashOutFrom.sol +0 -476
  271. package/test/units/static/JBTerminalStore/TestPreviewPayFrom.sol +0 -494
  272. package/test/units/static/JBTerminalStore/TestRecordCashOutsFor.sol +0 -652
  273. package/test/units/static/JBTerminalStore/TestRecordPaymentFrom.sol +0 -744
  274. package/test/units/static/JBTerminalStore/TestRecordPayoutFor.sol +0 -289
  275. package/test/units/static/JBTerminalStore/TestRecordTerminalMigration.sol +0 -138
  276. package/test/units/static/JBTerminalStore/TestRecordUsedAllowanceOf.sol +0 -415
  277. package/test/units/static/JBTerminalStore/TestUint224Overflow.sol +0 -219
  278. package/test/units/static/JBTokens/JBTokensSetup.sol +0 -32
  279. package/test/units/static/JBTokens/TestBurnFrom.sol +0 -107
  280. package/test/units/static/JBTokens/TestClaimTokensFor.sol +0 -110
  281. package/test/units/static/JBTokens/TestDeployERC20ForUnits.sol +0 -92
  282. package/test/units/static/JBTokens/TestMintFor.sol +0 -100
  283. package/test/units/static/JBTokens/TestSetTokenFor.sol +0 -98
  284. package/test/units/static/JBTokens/TestTotalBalanceOf.sol +0 -65
  285. package/test/units/static/JBTokens/TestTotalSupplyOf.sol +0 -56
  286. package/test/units/static/JBTokens/TestTransferCreditsFrom.sol +0 -56
@@ -1,463 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity 0.8.28;
3
-
4
- import {IJBController} from "../../../../src/interfaces/IJBController.sol";
5
- import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
6
- import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
7
- import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
8
- import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
9
- import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
10
- import {IJBTerminal} from "../../../../src/interfaces/IJBTerminal.sol";
11
- import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
12
- import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
13
- import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
14
- import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
15
- import {JBCurrencyAmount} from "../../../../src/structs/JBCurrencyAmount.sol";
16
- import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
17
- import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
18
- import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
19
-
20
- contract TestCurrentSurplusOf_Local is JBTerminalStoreSetup {
21
- using JBRulesetMetadataResolver for JBRulesetMetadata;
22
-
23
- uint256 _projectId = 1;
24
- uint256 _balance = 1e18;
25
-
26
- // Mocks
27
- IJBTerminal _terminal = IJBTerminal(makeAddr("terminal"));
28
- IJBToken _token = IJBToken(makeAddr("token"));
29
- IJBController _controller = IJBController(makeAddr("controller"));
30
- IJBFundAccessLimits _accessLimits = IJBFundAccessLimits(makeAddr("funds"));
31
-
32
- uint32 _currency = uint32(uint160(address(_token)));
33
- address _nativeAddress = JBConstants.NATIVE_TOKEN;
34
- uint32 _nativeCurrency = uint32(uint160(JBConstants.NATIVE_TOKEN));
35
-
36
- function setUp() public {
37
- super.terminalStoreSetup();
38
- }
39
-
40
- /// @notice Helper to register an accounting context with the store (pranks as the terminal).
41
- function _registerContext(JBAccountingContext memory ctx) internal {
42
- JBAccountingContext[] memory ctxs = new JBAccountingContext[](1);
43
- ctxs[0] = ctx;
44
- vm.prank(address(_terminal));
45
- _store.recordAccountingContextOf(_projectId, ctxs);
46
- }
47
-
48
- /// @notice Helper to call currentSurplusOf with the new multi-terminal signature.
49
- function _currentSurplusOf(uint256 decimals, uint256 currency) internal view returns (uint256) {
50
- IJBTerminal[] memory terminals = new IJBTerminal[](1);
51
- terminals[0] = _terminal;
52
- return _store.currentSurplusOf(_projectId, terminals, new address[](0), decimals, currency);
53
- }
54
-
55
- modifier whenProjectHasBalance() {
56
- // Find the storage slot
57
- bytes32 balanceOfSlot = keccak256(abi.encode(address(_terminal), uint256(0)));
58
- bytes32 projectSlot = keccak256(abi.encode(_projectId, uint256(balanceOfSlot)));
59
- bytes32 slot = keccak256(abi.encode(address(_token), uint256(projectSlot)));
60
-
61
- bytes32 balanceBytes = bytes32(_balance);
62
-
63
- // Set balance
64
- vm.store(address(_store), slot, balanceBytes);
65
-
66
- // Ensure balance is set correctly
67
- uint256 _balanceCallReturn = _store.balanceOf(address(_terminal), _projectId, address(_token));
68
- assertEq(_balanceCallReturn, _balance);
69
- _;
70
- }
71
-
72
- function test_GivenSurplusRequiresDecimalAdjustmentAndAccountingCurrencyMatchesTargetCurrency()
73
- external
74
- whenProjectHasBalance
75
- {
76
- // it will adjust surplus to target decimals without conversion
77
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
78
-
79
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
80
- _registerContext(_contexts[0]);
81
-
82
- // JBRulesets calldata
83
- JBRuleset memory _returnedRuleset = JBRuleset({
84
- cycleNumber: uint48(block.timestamp),
85
- id: uint48(block.timestamp),
86
- basedOnId: 0,
87
- start: uint48(block.timestamp),
88
- duration: uint32(block.timestamp + 1000),
89
- weight: 1e18,
90
- weightCutPercent: 0,
91
- approvalHook: IJBRulesetApprovalHook(address(0)),
92
- metadata: 0
93
- });
94
-
95
- // mock call to JBRulesets currentOf
96
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
97
-
98
- // mock call to JBDirectory controllerOf
99
- mockExpect(
100
- address(directory),
101
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
102
- abi.encode(address(_controller))
103
- );
104
-
105
- // mock call to controller FUND_ACCESS_LIMITS
106
- mockExpect(
107
- address(_controller), abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ()), abi.encode(_accessLimits)
108
- );
109
-
110
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
111
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
112
-
113
- // mock call to fundAccessLimits payoutLimitsOf
114
- bytes memory _payoutLimitsCall = abi.encodeCall(
115
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
116
- );
117
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
118
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
119
-
120
- uint256 currentSurplus = _currentSurplusOf(6, _currency);
121
-
122
- // assert correct calcs
123
- uint256 expectedSurplus = (1e18 - 1e17) / 10 ** (18 - 6);
124
- assertEq(expectedSurplus, currentSurplus);
125
- }
126
-
127
- function test_GivenSurplusRequiresDecimalAdjustmentAndAccountingCurrencyDoesNotMatchTargetCurrency()
128
- external
129
- whenProjectHasBalance
130
- {
131
- // it will convert surplus to target currency with decimal adjustment
132
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
133
-
134
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
135
- _registerContext(_contexts[0]);
136
-
137
- // JBRulesets calldata
138
- JBRuleset memory _returnedRuleset = JBRuleset({
139
- cycleNumber: uint48(block.timestamp),
140
- id: uint48(block.timestamp),
141
- basedOnId: 0,
142
- start: uint48(block.timestamp),
143
- duration: uint32(block.timestamp + 1000),
144
- weight: 1e18,
145
- weightCutPercent: 0,
146
- approvalHook: IJBRulesetApprovalHook(address(0)),
147
- metadata: 0
148
- });
149
-
150
- // mock call to JBRulesets currentOf
151
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
152
-
153
- // mock call to JBDirectory controllerOf
154
- mockExpect(
155
- address(directory),
156
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
157
- abi.encode(address(_controller))
158
- );
159
-
160
- // mock call to controller FUND_ACCESS_LIMITS
161
- bytes memory _accessLimitsCall = abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ());
162
- bytes memory _accessLimitsReturn = abi.encode(_accessLimits);
163
- mockExpect(address(_controller), _accessLimitsCall, _accessLimitsReturn);
164
-
165
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
166
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
167
-
168
- // mock call to fundAccessLimits payoutLimitsOf
169
- bytes memory _payoutLimitsCall = abi.encodeCall(
170
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
171
- );
172
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
173
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
174
-
175
- // mock call to JBPrices pricePerUnitOf
176
- bytes memory _pricePerCall =
177
- abi.encodeCall(IJBPrices.pricePerUnitOf, (_projectId, _currency, _nativeCurrency, 18));
178
- bytes memory _pricePerReturn = abi.encode(uint256(1));
179
- mockExpect(address(prices), _pricePerCall, _pricePerReturn);
180
-
181
- uint256 currentSurplus = _currentSurplusOf(6, _nativeCurrency);
182
-
183
- // assert correct calcs
184
- uint256 expectedSurplus = ((1e18 - 1e17) * 1e18) / 10 ** (18 - 6);
185
- assertEq(expectedSurplus, currentSurplus);
186
- }
187
-
188
- function test_GivenAccountingCurrencyMatchesTargetCurrency() external whenProjectHasBalance {
189
- // it will return standard surplus
190
-
191
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
192
-
193
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
194
- _registerContext(_contexts[0]);
195
-
196
- // JBRulesets calldata
197
- JBRuleset memory _returnedRuleset = JBRuleset({
198
- cycleNumber: uint48(block.timestamp),
199
- id: uint48(block.timestamp),
200
- basedOnId: 0,
201
- start: uint48(block.timestamp),
202
- duration: uint32(block.timestamp + 1000),
203
- weight: 1e18,
204
- weightCutPercent: 0,
205
- approvalHook: IJBRulesetApprovalHook(address(0)),
206
- metadata: 0
207
- });
208
-
209
- // mock call to JBRulesets currentOf
210
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
211
-
212
- // mock call to JBDirectory controllerOf
213
- mockExpect(
214
- address(directory),
215
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
216
- abi.encode(address(_controller))
217
- );
218
-
219
- // mock call to controller FUND_ACCESS_LIMITS
220
- mockExpect(
221
- address(_controller), abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ()), abi.encode(_accessLimits)
222
- );
223
-
224
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
225
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
226
-
227
- // mock call to fundAccessLimits payoutLimitsOf
228
- bytes memory _payoutLimitsCall = abi.encodeCall(
229
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
230
- );
231
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
232
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
233
-
234
- uint256 currentSurplus = _currentSurplusOf(18, _currency);
235
-
236
- // assert correct calcs
237
- uint256 expectedSurplus = 1e18 - 1e17;
238
- assertEq(expectedSurplus, currentSurplus);
239
- }
240
-
241
- function test_GivenAccountingCurrencyDoesNotMatchTargetCurrency() external whenProjectHasBalance {
242
- // it will convert surplus to target currency without decimal adjustment
243
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
244
-
245
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
246
- _registerContext(_contexts[0]);
247
-
248
- // JBRulesets calldata
249
- JBRuleset memory _returnedRuleset = JBRuleset({
250
- cycleNumber: uint48(block.timestamp),
251
- id: uint48(block.timestamp),
252
- basedOnId: 0,
253
- start: uint48(block.timestamp),
254
- duration: uint32(block.timestamp + 1000),
255
- weight: 1e18,
256
- weightCutPercent: 0,
257
- approvalHook: IJBRulesetApprovalHook(address(0)),
258
- metadata: 0
259
- });
260
-
261
- // mock call to JBRulesets currentOf
262
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
263
-
264
- // mock call to JBDirectory controllerOf
265
- mockExpect(
266
- address(directory),
267
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
268
- abi.encode(address(_controller))
269
- );
270
-
271
- // mock call to controller FUND_ACCESS_LIMITS
272
- bytes memory _accessLimitsCall = abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ());
273
- bytes memory _accessLimitsReturn = abi.encode(_accessLimits);
274
- mockExpect(address(_controller), _accessLimitsCall, _accessLimitsReturn);
275
-
276
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
277
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
278
-
279
- // mock call to fundAccessLimits payoutLimitsOf
280
- bytes memory _payoutLimitsCall = abi.encodeCall(
281
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
282
- );
283
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
284
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
285
-
286
- // mock call to JBPrices pricePerUnitOf
287
- bytes memory _pricePerCall =
288
- abi.encodeCall(IJBPrices.pricePerUnitOf, (_projectId, _currency, _nativeCurrency, 18));
289
- bytes memory _pricePerReturn = abi.encode(uint256(1));
290
- mockExpect(address(prices), _pricePerCall, _pricePerReturn);
291
-
292
- uint256 currentSurplus = _currentSurplusOf(18, _nativeCurrency);
293
-
294
- // assert correct calcs
295
- uint256 expectedSurplus = (1e18 - 1e17) * 1e18;
296
- assertEq(expectedSurplus, currentSurplus);
297
- }
298
-
299
- function test_GivenPayoutLimitCurrencyMatchesTargetCurrency() external whenProjectHasBalance {
300
- // it will return standard surplus
301
-
302
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
303
-
304
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
305
- _registerContext(_contexts[0]);
306
-
307
- // JBRulesets calldata
308
- JBRuleset memory _returnedRuleset = JBRuleset({
309
- cycleNumber: uint48(block.timestamp),
310
- id: uint48(block.timestamp),
311
- basedOnId: 0,
312
- start: uint48(block.timestamp),
313
- duration: uint32(block.timestamp + 1000),
314
- weight: 1e18,
315
- weightCutPercent: 0,
316
- approvalHook: IJBRulesetApprovalHook(address(0)),
317
- metadata: 0
318
- });
319
-
320
- // mock call to JBRulesets currentOf
321
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
322
-
323
- // mock call to JBDirectory controllerOf
324
- mockExpect(
325
- address(directory),
326
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
327
- abi.encode(address(_controller))
328
- );
329
-
330
- // mock call to controller FUND_ACCESS_LIMITS
331
- bytes memory _accessLimitsCall = abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ());
332
- bytes memory _accessLimitsReturn = abi.encode(_accessLimits);
333
- mockExpect(address(_controller), _accessLimitsCall, _accessLimitsReturn);
334
-
335
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
336
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
337
-
338
- // mock call to fundAccessLimits payoutLimitsOf
339
- bytes memory _payoutLimitsCall = abi.encodeCall(
340
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
341
- );
342
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
343
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
344
-
345
- uint256 currentSurplus = _currentSurplusOf(18, _currency);
346
-
347
- // assert correct calcs
348
- uint256 expectedSurplus = (1e18 - 1e17);
349
- assertEq(expectedSurplus, currentSurplus);
350
- }
351
-
352
- function test_GivenPayoutLimitCurrencyDoesNotMatchTargetCurrency() external whenProjectHasBalance {
353
- // it will convert payout limit target currency without decimal adjustment
354
-
355
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
356
-
357
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _nativeCurrency});
358
- _registerContext(_contexts[0]);
359
-
360
- // JBRulesets calldata
361
- JBRuleset memory _returnedRuleset = JBRuleset({
362
- cycleNumber: uint48(block.timestamp),
363
- id: uint48(block.timestamp),
364
- basedOnId: 0,
365
- start: uint48(block.timestamp),
366
- duration: uint32(block.timestamp + 1000),
367
- weight: 1e18,
368
- weightCutPercent: 0,
369
- approvalHook: IJBRulesetApprovalHook(address(0)),
370
- metadata: 0
371
- });
372
-
373
- // mock call to JBRulesets currentOf
374
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
375
-
376
- // mock call to JBDirectory controllerOf
377
- mockExpect(
378
- address(directory),
379
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
380
- abi.encode(address(_controller))
381
- );
382
-
383
- // mock call to controller FUND_ACCESS_LIMITS
384
- bytes memory _accessLimitsCall = abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ());
385
- bytes memory _accessLimitsReturn = abi.encode(_accessLimits);
386
- mockExpect(address(_controller), _accessLimitsCall, _accessLimitsReturn);
387
-
388
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
389
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e17, currency: _currency});
390
-
391
- // mock call to fundAccessLimits payoutLimitsOf
392
- bytes memory _payoutLimitsCall = abi.encodeCall(
393
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
394
- );
395
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
396
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
397
-
398
- // mock call to JBPrices pricePerUnitOf
399
- bytes memory _pricePerCall =
400
- abi.encodeCall(IJBPrices.pricePerUnitOf, (_projectId, _currency, _nativeCurrency, 18));
401
- bytes memory _pricePerReturn = abi.encode(uint256(1e18));
402
- mockExpect(address(prices), _pricePerCall, _pricePerReturn);
403
-
404
- uint256 currentSurplus = _currentSurplusOf(18, _nativeCurrency);
405
-
406
- // assert correct calcs
407
- uint256 expectedSurplus = 1e18 - 1e17;
408
- assertEq(expectedSurplus, currentSurplus);
409
- }
410
-
411
- function test_GivenCumulativeBalanceNotGreaterThanCumulativePayoutLimit() external whenProjectHasBalance {
412
- // it will return zero
413
-
414
- JBAccountingContext[] memory _contexts = new JBAccountingContext[](1);
415
-
416
- _contexts[0] = JBAccountingContext({token: address(_token), decimals: 18, currency: _currency});
417
- _registerContext(_contexts[0]);
418
-
419
- // JBRulesets calldata
420
- JBRuleset memory _returnedRuleset = JBRuleset({
421
- cycleNumber: uint48(block.timestamp),
422
- id: uint48(block.timestamp),
423
- basedOnId: 0,
424
- start: uint48(block.timestamp),
425
- duration: uint32(block.timestamp + 1000),
426
- weight: 1e18,
427
- weightCutPercent: 0,
428
- approvalHook: IJBRulesetApprovalHook(address(0)),
429
- metadata: 0
430
- });
431
-
432
- // mock call to JBRulesets currentOf
433
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
434
-
435
- // mock call to JBDirectory controllerOf
436
- mockExpect(
437
- address(directory),
438
- abi.encodeCall(IJBDirectory.controllerOf, (_projectId)),
439
- abi.encode(address(_controller))
440
- );
441
-
442
- // mock call to controller FUND_ACCESS_LIMITS
443
- bytes memory _accessLimitsCall = abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ());
444
- bytes memory _accessLimitsReturn = abi.encode(_accessLimits);
445
- mockExpect(address(_controller), _accessLimitsCall, _accessLimitsReturn);
446
-
447
- JBCurrencyAmount[] memory _payoutLimits = new JBCurrencyAmount[](1);
448
- _payoutLimits[0] = JBCurrencyAmount({amount: 1e19, currency: _currency});
449
-
450
- // mock call to fundAccessLimits payoutLimitsOf
451
- bytes memory _payoutLimitsCall = abi.encodeCall(
452
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal), address(_token))
453
- );
454
- bytes memory _payoutLimitsReturn = abi.encode(_payoutLimits);
455
- mockExpect(address(_accessLimits), _payoutLimitsCall, _payoutLimitsReturn);
456
-
457
- uint256 currentSurplus = _currentSurplusOf(18, _currency);
458
-
459
- // assert correct calcs
460
- uint256 expectedSurplus = 0;
461
- assertEq(expectedSurplus, currentSurplus);
462
- }
463
- }
@@ -1,135 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity 0.8.28;
3
-
4
- import {IJBController} from "../../../../src/interfaces/IJBController.sol";
5
- import {IJBDirectory} from "../../../../src/interfaces/IJBDirectory.sol";
6
- import {IJBFundAccessLimits} from "../../../../src/interfaces/IJBFundAccessLimits.sol";
7
- import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
8
- import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
9
- import {IJBTerminal} from "../../../../src/interfaces/IJBTerminal.sol";
10
- import {JBAccountingContext} from "../../../../src/structs/JBAccountingContext.sol";
11
- import {JBCurrencyAmount} from "../../../../src/structs/JBCurrencyAmount.sol";
12
- import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
13
- import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
14
-
15
- contract TestCurrentTotalSurplusOf_Local is JBTerminalStoreSetup {
16
- uint256 _projectId = 1;
17
- uint256 _decimals = 18;
18
-
19
- // Mocks
20
- IJBTerminal _terminal1 = IJBTerminal(makeAddr("terminal1"));
21
- IJBTerminal _terminal2 = IJBTerminal(makeAddr("terminal2"));
22
- address _token = makeAddr("token");
23
- IJBController _controller = IJBController(makeAddr("controller"));
24
- IJBFundAccessLimits _accessLimits = IJBFundAccessLimits(makeAddr("funds"));
25
-
26
- // forge-lint: disable-next-line(unsafe-typecast)
27
- uint32 _currency = uint32(uint160(_token));
28
-
29
- function setUp() public {
30
- super.terminalStoreSetup();
31
- }
32
-
33
- /// @notice Helper to set balance for a terminal/project/token via vm.store.
34
- function _setBalance(address terminal, uint256 projectId, address token, uint256 balance) internal {
35
- bytes32 balanceOfSlot = keccak256(abi.encode(terminal, uint256(0)));
36
- bytes32 projectSlot = keccak256(abi.encode(projectId, uint256(balanceOfSlot)));
37
- bytes32 slot = keccak256(abi.encode(token, uint256(projectSlot)));
38
- vm.store(address(_store), slot, bytes32(balance));
39
- }
40
-
41
- /// @notice Helper to register an accounting context with the store (pranks as the terminal).
42
- function _registerContext(address terminal, JBAccountingContext memory ctx) internal {
43
- JBAccountingContext[] memory ctxs = new JBAccountingContext[](1);
44
- ctxs[0] = ctx;
45
- vm.prank(terminal);
46
- _store.recordAccountingContextOf(_projectId, ctxs);
47
- }
48
-
49
- function test_WhenTerminalsAreConfiguredInJBDirectory() external {
50
- // it will return the cumulative surplus
51
-
52
- // Set up terminals in directory
53
- IJBTerminal[] memory _terminals = new IJBTerminal[](2);
54
- _terminals[0] = _terminal1;
55
- _terminals[1] = _terminal2;
56
-
57
- mockExpect(address(directory), abi.encodeCall(IJBDirectory.terminalsOf, (_projectId)), abi.encode(_terminals));
58
-
59
- // Set up accounting contexts for each terminal
60
- JBAccountingContext memory ctx = JBAccountingContext({token: _token, decimals: 18, currency: _currency});
61
- _registerContext(address(_terminal1), ctx);
62
- _registerContext(address(_terminal2), ctx);
63
-
64
- // Set balances: terminal1 = 1e18, terminal2 = 2e18
65
- _setBalance(address(_terminal1), _projectId, _token, 1e18);
66
- _setBalance(address(_terminal2), _projectId, _token, 2e18);
67
-
68
- // Mock ruleset
69
- JBRuleset memory _returnedRuleset = JBRuleset({
70
- cycleNumber: uint48(block.timestamp),
71
- id: uint48(block.timestamp),
72
- basedOnId: 0,
73
- start: uint48(block.timestamp),
74
- duration: uint32(block.timestamp + 1000),
75
- weight: 1e18,
76
- weightCutPercent: 0,
77
- approvalHook: IJBRulesetApprovalHook(address(0)),
78
- metadata: 0
79
- });
80
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
81
-
82
- // Mock controller and fund access limits (zero payout limits = all balance is surplus)
83
- mockExpect(address(directory), abi.encodeCall(IJBDirectory.controllerOf, (_projectId)), abi.encode(_controller));
84
- mockExpect(
85
- address(_controller), abi.encodeCall(IJBController.FUND_ACCESS_LIMITS, ()), abi.encode(_accessLimits)
86
- );
87
-
88
- JBCurrencyAmount[] memory _emptyLimits = new JBCurrencyAmount[](0);
89
- // Mock payoutLimitsOf for terminal1
90
- mockExpect(
91
- address(_accessLimits),
92
- abi.encodeCall(
93
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal1), _token)
94
- ),
95
- abi.encode(_emptyLimits)
96
- );
97
- // Mock payoutLimitsOf for terminal2
98
- mockExpect(
99
- address(_accessLimits),
100
- abi.encodeCall(
101
- IJBFundAccessLimits.payoutLimitsOf, (_projectId, block.timestamp, address(_terminal2), _token)
102
- ),
103
- abi.encode(_emptyLimits)
104
- );
105
-
106
- uint256 sum = _store.currentTotalSurplusOf(_projectId, _decimals, _currency);
107
- assertEq(3e18, sum);
108
- }
109
-
110
- function test_WhenTerminalsAreNotConfiguredInJBDirectory() external {
111
- // it will return zero
112
-
113
- IJBTerminal[] memory _terminals = new IJBTerminal[](0);
114
-
115
- // mock call to JBDirectory terminalsOf
116
- mockExpect(address(directory), abi.encodeCall(IJBDirectory.terminalsOf, (_projectId)), abi.encode(_terminals));
117
-
118
- // Mock ruleset (needed by currentSurplusOf)
119
- JBRuleset memory _returnedRuleset = JBRuleset({
120
- cycleNumber: uint48(block.timestamp),
121
- id: uint48(block.timestamp),
122
- basedOnId: 0,
123
- start: uint48(block.timestamp),
124
- duration: uint32(block.timestamp + 1000),
125
- weight: 1e18,
126
- weightCutPercent: 0,
127
- approvalHook: IJBRulesetApprovalHook(address(0)),
128
- metadata: 0
129
- });
130
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
131
-
132
- uint256 sum = _store.currentTotalSurplusOf(_projectId, _decimals, _currency);
133
- assertEq(0, sum);
134
- }
135
- }