@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,227 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity ^0.8.6;
3
-
4
- import {StdInvariant} from "forge-std/StdInvariant.sol";
5
- import {TestBaseWorkflow} from "../helpers/TestBaseWorkflow.sol";
6
- import {IJBRulesetApprovalHook} from "../../src/interfaces/IJBRulesetApprovalHook.sol";
7
- import {IJBTerminal} from "../../src/interfaces/IJBTerminal.sol";
8
- import {JBConstants} from "../../src/libraries/JBConstants.sol";
9
- import {JBRulesetMetadataResolver} from "../../src/libraries/JBRulesetMetadataResolver.sol";
10
- import {JBFundAccessLimitGroup} from "../../src/structs/JBFundAccessLimitGroup.sol";
11
- import {JBRuleset} from "../../src/structs/JBRuleset.sol";
12
- import {JBRulesetConfig} from "../../src/structs/JBRulesetConfig.sol";
13
- import {JBRulesetMetadata} from "../../src/structs/JBRulesetMetadata.sol";
14
- import {JBSplitGroup} from "../../src/structs/JBSplitGroup.sol";
15
- import {JBTerminalConfig} from "../../src/structs/JBTerminalConfig.sol";
16
- import {TerminalStoreHandler} from "./handlers/TerminalStoreHandler.sol";
17
- import {JBAccountingContext} from "../../src/structs/JBAccountingContext.sol";
18
-
19
- /// @notice Invariant tests for JBTerminalStore fund conservation.
20
- /// @dev Verifies that funds cannot be created or destroyed through normal terminal operations.
21
- contract TerminalStoreInvariant_Local is StdInvariant, TestBaseWorkflow {
22
- using JBRulesetMetadataResolver for JBRuleset;
23
-
24
- TerminalStoreHandler public handler;
25
-
26
- uint256 public projectId;
27
- address public projectOwner;
28
-
29
- function setUp() public override {
30
- super.setUp();
31
- projectOwner = multisig();
32
-
33
- // Launch fee collector project (#1)
34
- JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
35
- feeRulesetConfig[0].mustStartAtOrAfter = 0;
36
- feeRulesetConfig[0].duration = 0;
37
- feeRulesetConfig[0].weight = 1000e18;
38
- feeRulesetConfig[0].weightCutPercent = 0;
39
- feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
40
- feeRulesetConfig[0].metadata = JBRulesetMetadata({
41
- reservedPercent: 0,
42
- cashOutTaxRate: 0,
43
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
44
- pausePay: false,
45
- pauseCreditTransfers: false,
46
- allowOwnerMinting: false,
47
- allowSetCustomToken: false,
48
- allowTerminalMigration: false,
49
- allowSetTerminals: false,
50
- ownerMustSendPayouts: false,
51
- allowSetController: false,
52
- allowAddAccountingContext: true,
53
- allowAddPriceFeed: false,
54
- holdFees: false,
55
- useTotalSurplusForCashOuts: false,
56
- useDataHookForPay: false,
57
- useDataHookForCashOut: false,
58
- dataHook: address(0),
59
- metadata: 0
60
- });
61
- feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
62
- feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
63
-
64
- JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](1);
65
- JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
66
- tokensToAccept[0] = JBAccountingContext({
67
- token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
68
- });
69
- terminalConfigurations[0] =
70
- JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: tokensToAccept});
71
-
72
- jbController()
73
- .launchProjectFor({
74
- owner: address(420),
75
- projectUri: "feeCollector",
76
- rulesetConfigurations: feeRulesetConfig,
77
- terminalConfigurations: terminalConfigurations,
78
- memo: ""
79
- });
80
-
81
- // Launch the test project (#2) with 50% cash out tax, no payout limit, no reserved rate
82
- JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
83
- rulesetConfig[0].mustStartAtOrAfter = 0;
84
- rulesetConfig[0].duration = 0;
85
- rulesetConfig[0].weight = 1000e18;
86
- rulesetConfig[0].weightCutPercent = 0;
87
- rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
88
- rulesetConfig[0].metadata = JBRulesetMetadata({
89
- reservedPercent: 0,
90
- cashOutTaxRate: 5000, // 50% tax
91
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
92
- pausePay: false,
93
- pauseCreditTransfers: false,
94
- allowOwnerMinting: true,
95
- allowSetCustomToken: true,
96
- allowTerminalMigration: false,
97
- allowSetTerminals: false,
98
- ownerMustSendPayouts: false,
99
- allowSetController: false,
100
- allowAddAccountingContext: true,
101
- allowAddPriceFeed: false,
102
- holdFees: false,
103
- useTotalSurplusForCashOuts: false,
104
- useDataHookForPay: false,
105
- useDataHookForCashOut: false,
106
- dataHook: address(0),
107
- metadata: 0
108
- });
109
- rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
110
- rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
111
-
112
- projectId = jbController()
113
- .launchProjectFor({
114
- owner: projectOwner,
115
- projectUri: "testProject",
116
- rulesetConfigurations: rulesetConfig,
117
- terminalConfigurations: terminalConfigurations,
118
- memo: ""
119
- });
120
-
121
- // Deploy ERC20 so tokens can be tracked
122
- vm.prank(projectOwner);
123
- jbController().deployERC20For(projectId, "TestToken", "TT", bytes32(0));
124
-
125
- // Deploy handler
126
- handler = new TerminalStoreHandler(
127
- jbMultiTerminal(), jbTerminalStore(), jbController(), jbTokens(), projectId, projectOwner
128
- );
129
-
130
- // Register handler as target
131
- bytes4[] memory selectors = new bytes4[](4);
132
- selectors[0] = TerminalStoreHandler.payProject.selector;
133
- selectors[1] = TerminalStoreHandler.cashOutTokens.selector;
134
- selectors[2] = TerminalStoreHandler.sendPayouts.selector;
135
- selectors[3] = TerminalStoreHandler.addToBalance.selector;
136
-
137
- targetContract(address(handler));
138
- targetSelector(FuzzSelector({addr: address(handler), selectors: selectors}));
139
- }
140
-
141
- /// @notice INV-TS-1: Terminal ETH balance >= sum of recorded balances for this project.
142
- /// @dev The terminal's actual ETH balance should always be >= what the store records,
143
- /// because fees from other projects also accumulate in the terminal.
144
- function invariant_TS1_terminalBalanceCoversRecordedBalance() public view {
145
- uint256 recordedBalance =
146
- jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
147
- uint256 actualBalance = address(jbMultiTerminal()).balance;
148
-
149
- assertGe(actualBalance, recordedBalance, "INV-TS-1: Terminal ETH balance must be >= recorded project balance");
150
- }
151
-
152
- /// @notice INV-TS-2: Reclaimable surplus <= current surplus, always.
153
- function invariant_TS2_reclaimableSurplusLeqSurplus() public view {
154
- uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
155
- if (totalSupply == 0) return; // Skip when no tokens exist
156
-
157
- IJBTerminal[] memory _terminals = new IJBTerminal[](1);
158
- _terminals[0] = IJBTerminal(jbMultiTerminal());
159
- uint256 surplus = jbTerminalStore()
160
- .currentSurplusOf({
161
- projectId: projectId,
162
- terminals: _terminals,
163
- tokens: new address[](0),
164
- decimals: 18,
165
- currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
166
- });
167
-
168
- // Check reclaimable for half the supply
169
- uint256 halfSupply = totalSupply / 2;
170
- if (halfSupply == 0) return;
171
-
172
- uint256 reclaimable = jbTerminalStore()
173
- .currentReclaimableSurplusOf({
174
- projectId: projectId, cashOutCount: halfSupply, totalSupply: totalSupply, surplus: surplus
175
- });
176
-
177
- assertLe(reclaimable, surplus, "INV-TS-2: Reclaimable surplus must not exceed current surplus");
178
- }
179
-
180
- /// @notice INV-TS-3: Fee project (project #1) balance in the terminal increases monotonically.
181
- /// @dev We can only check that it's >= 0; true monotonicity requires tracking across calls,
182
- /// which the handler ghost variables assist with.
183
- function invariant_TS3_feeProjectBalanceNonNegative() public view {
184
- uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
185
-
186
- // Fee project balance should be non-negative (always true for uint, but conceptually
187
- // this checks that the fee project accumulates fees from cashouts).
188
- assertGe(feeProjectBalance, 0, "INV-TS-3: Fee project balance should be non-negative");
189
- }
190
-
191
- /// @notice INV-TS-4: Total actual ETH in terminal = recorded balance of all projects.
192
- /// @dev The terminal's ETH balance should equal the sum of all project balances recorded in the store.
193
- function invariant_TS4_terminalBalanceConservation() public view {
194
- uint256 projectBalance =
195
- jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
196
- uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
197
- uint256 actualBalance = address(jbMultiTerminal()).balance;
198
-
199
- // The terminal's actual balance should equal the sum of all recorded project balances.
200
- // There should be no "unaccounted" ETH sitting in the terminal.
201
- assertEq(
202
- actualBalance,
203
- projectBalance + feeProjectBalance,
204
- "INV-TS-4: Terminal ETH balance must equal sum of all recorded project balances"
205
- );
206
- }
207
-
208
- /// @notice INV-TS-5: Ghost variable conservation check.
209
- /// @dev totalPaidIn + totalAddedToBalance >= totalCashedOut + totalPaidOut + remaining balance.
210
- /// Fees complicate exact equality, so we use >= for the funds-in side.
211
- function invariant_TS5_ghostVariableConservation() public view {
212
- uint256 totalIn = handler.ghost_totalPaidIn() + handler.ghost_totalAddedToBalance();
213
- uint256 totalOut = handler.ghost_totalCashedOut() + handler.ghost_totalPaidOut();
214
-
215
- uint256 projectBalance =
216
- jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
217
-
218
- // Everything that went in must be >= everything that went out + what remains.
219
- // Strict equality breaks because fees redistribute between projects.
220
- assertGe(
221
- totalIn,
222
- totalOut + projectBalance
223
- - jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN),
224
- "INV-TS-5: Ghost conservation - funds in >= funds out + project balance (adjusted for fees)"
225
- );
226
- }
227
- }
@@ -1,195 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity ^0.8.6;
3
-
4
- import {StdInvariant} from "forge-std/StdInvariant.sol";
5
- import {TestBaseWorkflow} from "../helpers/TestBaseWorkflow.sol";
6
- import {IJBRulesetApprovalHook} from "../../src/interfaces/IJBRulesetApprovalHook.sol";
7
- import {IJBToken} from "../../src/interfaces/IJBToken.sol";
8
- import {JBConstants} from "../../src/libraries/JBConstants.sol";
9
- import {JBRulesetMetadataResolver} from "../../src/libraries/JBRulesetMetadataResolver.sol";
10
- import {JBAccountingContext} from "../../src/structs/JBAccountingContext.sol";
11
- import {JBFundAccessLimitGroup} from "../../src/structs/JBFundAccessLimitGroup.sol";
12
- import {JBRuleset} from "../../src/structs/JBRuleset.sol";
13
- import {JBRulesetConfig} from "../../src/structs/JBRulesetConfig.sol";
14
- import {JBRulesetMetadata} from "../../src/structs/JBRulesetMetadata.sol";
15
- import {JBSplitGroup} from "../../src/structs/JBSplitGroup.sol";
16
- import {JBTerminalConfig} from "../../src/structs/JBTerminalConfig.sol";
17
- import {TokensHandler} from "./handlers/TokensHandler.sol";
18
-
19
- /// @notice Invariant tests for JBTokens supply and balance consistency.
20
- /// @dev Verifies that the dual-balance system (credits + ERC20) maintains exact accounting.
21
- contract TokensInvariant_Local is StdInvariant, TestBaseWorkflow {
22
- using JBRulesetMetadataResolver for JBRuleset;
23
-
24
- TokensHandler public handler;
25
-
26
- uint256 public projectId;
27
- address public projectOwner;
28
-
29
- function setUp() public override {
30
- super.setUp();
31
- projectOwner = multisig();
32
-
33
- // Launch fee collector project (#1)
34
- JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
35
- feeRulesetConfig[0].mustStartAtOrAfter = 0;
36
- feeRulesetConfig[0].duration = 0;
37
- feeRulesetConfig[0].weight = 1000e18;
38
- feeRulesetConfig[0].weightCutPercent = 0;
39
- feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
40
- feeRulesetConfig[0].metadata = JBRulesetMetadata({
41
- reservedPercent: 0,
42
- cashOutTaxRate: 0,
43
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
44
- pausePay: false,
45
- pauseCreditTransfers: false,
46
- allowOwnerMinting: false,
47
- allowSetCustomToken: false,
48
- allowTerminalMigration: false,
49
- allowSetTerminals: false,
50
- ownerMustSendPayouts: false,
51
- allowSetController: false,
52
- allowAddAccountingContext: true,
53
- allowAddPriceFeed: false,
54
- holdFees: false,
55
- useTotalSurplusForCashOuts: false,
56
- useDataHookForPay: false,
57
- useDataHookForCashOut: false,
58
- dataHook: address(0),
59
- metadata: 0
60
- });
61
- feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
62
- feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
63
-
64
- JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](1);
65
- JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
66
- tokensToAccept[0] = JBAccountingContext({
67
- token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
68
- });
69
- terminalConfigurations[0] =
70
- JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: tokensToAccept});
71
-
72
- jbController()
73
- .launchProjectFor({
74
- owner: address(420),
75
- projectUri: "feeCollector",
76
- rulesetConfigurations: feeRulesetConfig,
77
- terminalConfigurations: terminalConfigurations,
78
- memo: ""
79
- });
80
-
81
- // Launch the test project with credits (no ERC20 initially, then deploy)
82
- JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
83
- rulesetConfig[0].mustStartAtOrAfter = 0;
84
- rulesetConfig[0].duration = 0;
85
- rulesetConfig[0].weight = 1000e18;
86
- rulesetConfig[0].weightCutPercent = 0;
87
- rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
88
- rulesetConfig[0].metadata = JBRulesetMetadata({
89
- reservedPercent: 0,
90
- cashOutTaxRate: 5000,
91
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
92
- pausePay: false,
93
- pauseCreditTransfers: false,
94
- allowOwnerMinting: true,
95
- allowSetCustomToken: true,
96
- allowTerminalMigration: false,
97
- allowSetTerminals: false,
98
- ownerMustSendPayouts: false,
99
- allowSetController: false,
100
- allowAddAccountingContext: true,
101
- allowAddPriceFeed: false,
102
- holdFees: false,
103
- useTotalSurplusForCashOuts: false,
104
- useDataHookForPay: false,
105
- useDataHookForCashOut: false,
106
- dataHook: address(0),
107
- metadata: 0
108
- });
109
- rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
110
- rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
111
-
112
- projectId = jbController()
113
- .launchProjectFor({
114
- owner: projectOwner,
115
- projectUri: "testProject",
116
- rulesetConfigurations: rulesetConfig,
117
- terminalConfigurations: terminalConfigurations,
118
- memo: ""
119
- });
120
-
121
- // Deploy ERC20 so claiming works
122
- vm.prank(projectOwner);
123
- jbController().deployERC20For(projectId, "TestToken", "TT", bytes32(0));
124
-
125
- // Deploy handler
126
- handler = new TokensHandler(jbMultiTerminal(), jbController(), jbTokens(), projectId, projectOwner);
127
-
128
- // Register handler
129
- bytes4[] memory selectors = new bytes4[](4);
130
- selectors[0] = TokensHandler.mintTokens.selector;
131
- selectors[1] = TokensHandler.burnTokens.selector;
132
- selectors[2] = TokensHandler.claimCredits.selector;
133
- selectors[3] = TokensHandler.transferCredits.selector;
134
-
135
- targetContract(address(handler));
136
- targetSelector(FuzzSelector({addr: address(handler), selectors: selectors}));
137
- }
138
-
139
- /// @notice INV-TK-1: totalSupplyOf == totalCreditSupplyOf + token.totalSupply()
140
- function invariant_TK1_totalSupplyDecomposition() public view {
141
- uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
142
- uint256 creditSupply = jbTokens().totalCreditSupplyOf(projectId);
143
- IJBToken token = jbTokens().tokenOf(projectId);
144
- uint256 erc20Supply = address(token) != address(0) ? token.totalSupply() : 0;
145
-
146
- assertEq(totalSupply, creditSupply + erc20Supply, "INV-TK-1: totalSupply must equal creditSupply + erc20Supply");
147
- }
148
-
149
- /// @notice INV-TK-2: For each holder, totalBalanceOf == creditBalanceOf + token.balanceOf
150
- function invariant_TK2_perHolderBalanceConsistency() public view {
151
- uint256 holderCount = handler.holderCount();
152
- IJBToken token = jbTokens().tokenOf(projectId);
153
-
154
- for (uint256 i = 0; i < holderCount; i++) {
155
- address holder = handler.holderAt(i);
156
- uint256 totalBalance = jbTokens().totalBalanceOf(holder, projectId);
157
- uint256 creditBalance = jbTokens().creditBalanceOf(holder, projectId);
158
- uint256 erc20Balance = address(token) != address(0) ? token.balanceOf(holder) : 0;
159
-
160
- assertEq(
161
- totalBalance,
162
- creditBalance + erc20Balance,
163
- "INV-TK-2: Per-holder totalBalance must equal credits + ERC20"
164
- );
165
- }
166
- }
167
-
168
- /// @notice INV-TK-3: Sum of all holder totalBalanceOf == totalSupplyOf
169
- function invariant_TK3_sumOfBalancesEqualsTotalSupply() public view {
170
- uint256 holderCount = handler.holderCount();
171
- uint256 sumOfBalances;
172
-
173
- for (uint256 i = 0; i < holderCount; i++) {
174
- address holder = handler.holderAt(i);
175
- sumOfBalances += jbTokens().totalBalanceOf(holder, projectId);
176
- }
177
-
178
- uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
179
-
180
- // Sum of tracked holder balances should be <= totalSupply.
181
- // It may be < totalSupply if there are holders we haven't tracked (e.g., fee project).
182
- assertLe(sumOfBalances, totalSupply, "INV-TK-3: Sum of tracked holder balances must not exceed totalSupply");
183
- }
184
-
185
- /// @notice INV-TK-4: Claiming does not change totalSupplyOf.
186
- /// @dev This is implicitly tested via TK-1: if claiming changed totalSupply,
187
- /// the creditSupply + erc20Supply decomposition would break.
188
- /// We add an explicit check that supply is always non-negative (trivially true for uint).
189
- function invariant_TK4_supplyNeverNegative() public view {
190
- uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
191
- uint256 creditSupply = jbTokens().totalCreditSupplyOf(projectId);
192
-
193
- assertGe(totalSupply, creditSupply, "INV-TK-4: totalSupply must be >= creditSupply");
194
- }
195
- }