@bananapus/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 (436) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +112 -0
  3. package/SKILLS.md +151 -0
  4. package/docs/book.css +13 -0
  5. package/docs/book.toml +12 -0
  6. package/docs/solidity.min.js +74 -0
  7. package/docs/src/README.md +703 -0
  8. package/docs/src/SUMMARY.md +94 -0
  9. package/docs/src/src/JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md +83 -0
  10. package/docs/src/src/JBChainlinkV3SequencerPriceFeed.sol/contract.JBChainlinkV3SequencerPriceFeed.md +88 -0
  11. package/docs/src/src/JBController.sol/contract.JBController.md +1121 -0
  12. package/docs/src/src/JBDeadline.sol/contract.JBDeadline.md +84 -0
  13. package/docs/src/src/JBDirectory.sol/contract.JBDirectory.md +294 -0
  14. package/docs/src/src/JBERC20.sol/contract.JBERC20.md +190 -0
  15. package/docs/src/src/JBFeelessAddresses.sol/contract.JBFeelessAddresses.md +80 -0
  16. package/docs/src/src/JBFundAccessLimits.sol/contract.JBFundAccessLimits.md +253 -0
  17. package/docs/src/src/JBMultiTerminal.sol/contract.JBMultiTerminal.md +1472 -0
  18. package/docs/src/src/JBPermissions.sol/contract.JBPermissions.md +199 -0
  19. package/docs/src/src/JBPrices.sol/contract.JBPrices.md +154 -0
  20. package/docs/src/src/JBProjects.sol/contract.JBProjects.md +131 -0
  21. package/docs/src/src/JBRulesets.sol/contract.JBRulesets.md +677 -0
  22. package/docs/src/src/JBSplits.sol/contract.JBSplits.md +237 -0
  23. package/docs/src/src/JBTerminalStore.sol/contract.JBTerminalStore.md +591 -0
  24. package/docs/src/src/JBTokens.sol/contract.JBTokens.md +353 -0
  25. package/docs/src/src/README.md +25 -0
  26. package/docs/src/src/abstract/JBControlled.sol/abstract.JBControlled.md +64 -0
  27. package/docs/src/src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md +84 -0
  28. package/docs/src/src/abstract/README.md +5 -0
  29. package/docs/src/src/enums/JBApprovalStatus.sol/enum.JBApprovalStatus.md +17 -0
  30. package/docs/src/src/enums/README.md +4 -0
  31. package/docs/src/src/interfaces/IJBCashOutHook.sol/interface.IJBCashOutHook.md +29 -0
  32. package/docs/src/src/interfaces/IJBCashOutTerminal.sol/interface.IJBCashOutTerminal.md +57 -0
  33. package/docs/src/src/interfaces/IJBControlled.sol/interface.IJBControlled.md +12 -0
  34. package/docs/src/src/interfaces/IJBController.sol/interface.IJBController.md +334 -0
  35. package/docs/src/src/interfaces/IJBDirectory.sol/interface.IJBDirectory.md +108 -0
  36. package/docs/src/src/interfaces/IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md +19 -0
  37. package/docs/src/src/interfaces/IJBFeeTerminal.sol/interface.IJBFeeTerminal.md +91 -0
  38. package/docs/src/src/interfaces/IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md +26 -0
  39. package/docs/src/src/interfaces/IJBFundAccessLimits.sol/interface.IJBFundAccessLimits.md +88 -0
  40. package/docs/src/src/interfaces/IJBMigratable.sol/interface.IJBMigratable.md +29 -0
  41. package/docs/src/src/interfaces/IJBMultiTerminal.sol/interface.IJBMultiTerminal.md +50 -0
  42. package/docs/src/src/interfaces/IJBPayHook.sol/interface.IJBPayHook.md +28 -0
  43. package/docs/src/src/interfaces/IJBPayoutTerminal.sol/interface.IJBPayoutTerminal.md +105 -0
  44. package/docs/src/src/interfaces/IJBPermissioned.sol/interface.IJBPermissioned.md +12 -0
  45. package/docs/src/src/interfaces/IJBPermissions.sol/interface.IJBPermissions.md +74 -0
  46. package/docs/src/src/interfaces/IJBPermitTerminal.sol/interface.IJBPermitTerminal.md +15 -0
  47. package/docs/src/src/interfaces/IJBPriceFeed.sol/interface.IJBPriceFeed.md +12 -0
  48. package/docs/src/src/interfaces/IJBPrices.sol/interface.IJBPrices.md +74 -0
  49. package/docs/src/src/interfaces/IJBProjectUriRegistry.sol/interface.IJBProjectUriRegistry.md +19 -0
  50. package/docs/src/src/interfaces/IJBProjects.sol/interface.IJBProjects.md +49 -0
  51. package/docs/src/src/interfaces/IJBRulesetApprovalHook.sol/interface.IJBRulesetApprovalHook.md +35 -0
  52. package/docs/src/src/interfaces/IJBRulesetDataHook.sol/interface.IJBRulesetDataHook.md +97 -0
  53. package/docs/src/src/interfaces/IJBRulesets.sol/interface.IJBRulesets.md +165 -0
  54. package/docs/src/src/interfaces/IJBSplitHook.sol/interface.IJBSplitHook.md +31 -0
  55. package/docs/src/src/interfaces/IJBSplits.sol/interface.IJBSplits.md +35 -0
  56. package/docs/src/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md +141 -0
  57. package/docs/src/src/interfaces/IJBTerminalStore.sol/interface.IJBTerminalStore.md +198 -0
  58. package/docs/src/src/interfaces/IJBToken.sol/interface.IJBToken.md +54 -0
  59. package/docs/src/src/interfaces/IJBTokenUriResolver.sol/interface.IJBTokenUriResolver.md +12 -0
  60. package/docs/src/src/interfaces/IJBTokens.sol/interface.IJBTokens.md +151 -0
  61. package/docs/src/src/interfaces/README.md +33 -0
  62. package/docs/src/src/libraries/JBCashOuts.sol/library.JBCashOuts.md +40 -0
  63. package/docs/src/src/libraries/JBConstants.sol/library.JBConstants.md +52 -0
  64. package/docs/src/src/libraries/JBCurrencyIds.sol/library.JBCurrencyIds.md +19 -0
  65. package/docs/src/src/libraries/JBFees.sol/library.JBFees.md +52 -0
  66. package/docs/src/src/libraries/JBFixedPointNumber.sol/library.JBFixedPointNumber.md +12 -0
  67. package/docs/src/src/libraries/JBMetadataResolver.sol/library.JBMetadataResolver.md +242 -0
  68. package/docs/src/src/libraries/JBRulesetMetadataResolver.sol/library.JBRulesetMetadataResolver.md +180 -0
  69. package/docs/src/src/libraries/JBSplitGroupIds.sol/library.JBSplitGroupIds.md +14 -0
  70. package/docs/src/src/libraries/JBSurplus.sol/library.JBSurplus.md +44 -0
  71. package/docs/src/src/libraries/README.md +12 -0
  72. package/docs/src/src/periphery/JBDeadline1Day.sol/contract.JBDeadline1Day.md +15 -0
  73. package/docs/src/src/periphery/JBDeadline3Days.sol/contract.JBDeadline3Days.md +15 -0
  74. package/docs/src/src/periphery/JBDeadline3Hours.sol/contract.JBDeadline3Hours.md +15 -0
  75. package/docs/src/src/periphery/JBDeadline7Days.sol/contract.JBDeadline7Days.md +15 -0
  76. package/docs/src/src/periphery/JBMatchingPriceFeed.sol/contract.JBMatchingPriceFeed.md +22 -0
  77. package/docs/src/src/periphery/README.md +8 -0
  78. package/docs/src/src/structs/JBAccountingContext.sol/struct.JBAccountingContext.md +20 -0
  79. package/docs/src/src/structs/JBAfterCashOutRecordedContext.sol/struct.JBAfterCashOutRecordedContext.md +43 -0
  80. package/docs/src/src/structs/JBAfterPayRecordedContext.sol/struct.JBAfterPayRecordedContext.md +42 -0
  81. package/docs/src/src/structs/JBBeforeCashOutRecordedContext.sol/struct.JBBeforeCashOutRecordedContext.md +45 -0
  82. package/docs/src/src/structs/JBBeforePayRecordedContext.sol/struct.JBBeforePayRecordedContext.md +41 -0
  83. package/docs/src/src/structs/JBCashOutHookSpecification.sol/struct.JBCashOutHookSpecification.md +22 -0
  84. package/docs/src/src/structs/JBCurrencyAmount.sol/struct.JBCurrencyAmount.md +17 -0
  85. package/docs/src/src/structs/JBFee.sol/struct.JBFee.md +20 -0
  86. package/docs/src/src/structs/JBFundAccessLimitGroup.sol/struct.JBFundAccessLimitGroup.md +39 -0
  87. package/docs/src/src/structs/JBPayHookSpecification.sol/struct.JBPayHookSpecification.md +22 -0
  88. package/docs/src/src/structs/JBPermissionsData.sol/struct.JBPermissionsData.md +21 -0
  89. package/docs/src/src/structs/JBRuleset.sol/struct.JBRuleset.md +55 -0
  90. package/docs/src/src/structs/JBRulesetConfig.sol/struct.JBRulesetConfig.md +51 -0
  91. package/docs/src/src/structs/JBRulesetMetadata.sol/struct.JBRulesetMetadata.md +79 -0
  92. package/docs/src/src/structs/JBRulesetWeightCache.sol/struct.JBRulesetWeightCache.md +16 -0
  93. package/docs/src/src/structs/JBRulesetWithMetadata.sol/struct.JBRulesetWithMetadata.md +16 -0
  94. package/docs/src/src/structs/JBSingleAllowance.sol/struct.JBSingleAllowance.md +26 -0
  95. package/docs/src/src/structs/JBSplit.sol/struct.JBSplit.md +49 -0
  96. package/docs/src/src/structs/JBSplitGroup.sol/struct.JBSplitGroup.md +17 -0
  97. package/docs/src/src/structs/JBSplitHookContext.sol/struct.JBSplitHookContext.md +29 -0
  98. package/docs/src/src/structs/JBTerminalConfig.sol/struct.JBTerminalConfig.md +16 -0
  99. package/docs/src/src/structs/JBTokenAmount.sol/struct.JBTokenAmount.md +23 -0
  100. package/docs/src/src/structs/README.md +25 -0
  101. package/foundry.lock +11 -0
  102. package/foundry.toml +41 -0
  103. package/package.json +38 -0
  104. package/remappings.txt +1 -0
  105. package/script/Deploy.s.sol +111 -0
  106. package/script/DeployPeriphery.s.sol +287 -0
  107. package/script/helpers/CoreDeploymentLib.sol +121 -0
  108. package/slither-ci.config.json +10 -0
  109. package/sphinx.lock +507 -0
  110. package/src/JBChainlinkV3PriceFeed.sol +77 -0
  111. package/src/JBChainlinkV3SequencerPriceFeed.sol +75 -0
  112. package/src/JBController.sol +1186 -0
  113. package/src/JBDeadline.sol +73 -0
  114. package/src/JBDirectory.sol +343 -0
  115. package/src/JBERC20.sol +131 -0
  116. package/src/JBFeelessAddresses.sol +54 -0
  117. package/src/JBFundAccessLimits.sol +308 -0
  118. package/src/JBMultiTerminal.sol +2024 -0
  119. package/src/JBPermissions.sol +252 -0
  120. package/src/JBPrices.sol +227 -0
  121. package/src/JBProjects.sol +126 -0
  122. package/src/JBRulesets.sol +1093 -0
  123. package/src/JBSplits.sol +324 -0
  124. package/src/JBTerminalStore.sol +908 -0
  125. package/src/JBTokens.sol +376 -0
  126. package/src/abstract/JBControlled.sol +48 -0
  127. package/src/abstract/JBPermissioned.sol +77 -0
  128. package/src/enums/JBApprovalStatus.sol +12 -0
  129. package/src/interfaces/IJBCashOutHook.sol +15 -0
  130. package/src/interfaces/IJBCashOutTerminal.sol +51 -0
  131. package/src/interfaces/IJBControlled.sol +10 -0
  132. package/src/interfaces/IJBController.sol +280 -0
  133. package/src/interfaces/IJBDirectory.sol +69 -0
  134. package/src/interfaces/IJBDirectoryAccessControl.sol +15 -0
  135. package/src/interfaces/IJBFeeTerminal.sol +61 -0
  136. package/src/interfaces/IJBFeelessAddresses.sol +17 -0
  137. package/src/interfaces/IJBFundAccessLimits.sol +94 -0
  138. package/src/interfaces/IJBMigratable.sol +24 -0
  139. package/src/interfaces/IJBMultiTerminal.sol +36 -0
  140. package/src/interfaces/IJBPayHook.sol +14 -0
  141. package/src/interfaces/IJBPayoutTerminal.sol +92 -0
  142. package/src/interfaces/IJBPermissioned.sol +10 -0
  143. package/src/interfaces/IJBPermissions.sol +71 -0
  144. package/src/interfaces/IJBPermitTerminal.sol +14 -0
  145. package/src/interfaces/IJBPriceFeed.sol +10 -0
  146. package/src/interfaces/IJBPrices.sol +65 -0
  147. package/src/interfaces/IJBProjectUriRegistry.sol +15 -0
  148. package/src/interfaces/IJBProjects.sol +27 -0
  149. package/src/interfaces/IJBRulesetApprovalHook.sol +21 -0
  150. package/src/interfaces/IJBRulesetDataHook.sol +56 -0
  151. package/src/interfaces/IJBRulesets.sol +151 -0
  152. package/src/interfaces/IJBSplitHook.sol +16 -0
  153. package/src/interfaces/IJBSplits.sol +28 -0
  154. package/src/interfaces/IJBTerminal.sol +120 -0
  155. package/src/interfaces/IJBTerminalStore.sol +225 -0
  156. package/src/interfaces/IJBToken.sol +39 -0
  157. package/src/interfaces/IJBTokenUriResolver.sol +10 -0
  158. package/src/interfaces/IJBTokens.sol +113 -0
  159. package/src/libraries/JBCashOuts.sol +120 -0
  160. package/src/libraries/JBConstants.sol +14 -0
  161. package/src/libraries/JBCurrencyIds.sol +7 -0
  162. package/src/libraries/JBFees.sol +28 -0
  163. package/src/libraries/JBFixedPointNumber.sol +12 -0
  164. package/src/libraries/JBMetadataResolver.sol +306 -0
  165. package/src/libraries/JBRulesetMetadataResolver.sol +160 -0
  166. package/src/libraries/JBSplitGroupIds.sol +7 -0
  167. package/src/libraries/JBSurplus.sol +40 -0
  168. package/src/periphery/JBDeadline1Day.sol +8 -0
  169. package/src/periphery/JBDeadline3Days.sol +8 -0
  170. package/src/periphery/JBDeadline3Hours.sol +8 -0
  171. package/src/periphery/JBDeadline7Days.sol +8 -0
  172. package/src/periphery/JBMatchingPriceFeed.sol +13 -0
  173. package/src/structs/JBAccountingContext.sol +12 -0
  174. package/src/structs/JBAfterCashOutRecordedContext.sol +30 -0
  175. package/src/structs/JBAfterPayRecordedContext.sol +29 -0
  176. package/src/structs/JBBeforeCashOutRecordedContext.sol +31 -0
  177. package/src/structs/JBBeforePayRecordedContext.sol +28 -0
  178. package/src/structs/JBCashOutHookSpecification.sol +15 -0
  179. package/src/structs/JBCurrencyAmount.sol +10 -0
  180. package/src/structs/JBFee.sol +12 -0
  181. package/src/structs/JBFundAccessLimitGroup.sol +28 -0
  182. package/src/structs/JBPayHookSpecification.sol +15 -0
  183. package/src/structs/JBPermissionsData.sol +13 -0
  184. package/src/structs/JBRuleset.sol +42 -0
  185. package/src/structs/JBRulesetConfig.sol +43 -0
  186. package/src/structs/JBRulesetMetadata.sol +56 -0
  187. package/src/structs/JBRulesetWeightCache.sol +9 -0
  188. package/src/structs/JBRulesetWithMetadata.sol +12 -0
  189. package/src/structs/JBSingleAllowance.sol +16 -0
  190. package/src/structs/JBSplit.sol +37 -0
  191. package/src/structs/JBSplitGroup.sol +12 -0
  192. package/src/structs/JBSplitHookContext.sol +20 -0
  193. package/src/structs/JBTerminalConfig.sol +12 -0
  194. package/src/structs/JBTokenAmount.sol +14 -0
  195. package/test/AuditExploits.t.sol +2710 -0
  196. package/test/ComprehensiveInvariant.t.sol +298 -0
  197. package/test/EconomicSimulation.t.sol +340 -0
  198. package/test/EntryPointPermutations.t.sol +671 -0
  199. package/test/FlashLoanAttacks.t.sol +792 -0
  200. package/test/PermissionEscalation.t.sol +679 -0
  201. package/test/RulesetTransitions.t.sol +699 -0
  202. package/test/SplitLoopTests.t.sol +731 -0
  203. package/test/TestAccessToFunds.sol +2644 -0
  204. package/test/TestCashOut.sol +185 -0
  205. package/test/TestCashOutCountFor.sol +272 -0
  206. package/test/TestCashOutHooks.sol +317 -0
  207. package/test/TestCashOutTimingEdge.sol +229 -0
  208. package/test/TestDurationUnderflow.sol +220 -0
  209. package/test/TestFeeProcessingFailure.sol +208 -0
  210. package/test/TestFees.sol +604 -0
  211. package/test/TestInterfaceSupport.sol +62 -0
  212. package/test/TestJBERC20Inheritance.sol +91 -0
  213. package/test/TestLaunchProject.sol +176 -0
  214. package/test/TestMetaTx.sol +203 -0
  215. package/test/TestMetadataParserLib.sol +438 -0
  216. package/test/TestMigrationHeldFees.sol +249 -0
  217. package/test/TestMintTokensOf.sol +172 -0
  218. package/test/TestMultiTokenSurplus.sol +206 -0
  219. package/test/TestMultipleAccessLimits.sol +642 -0
  220. package/test/TestPayBurnRedeemFlow.sol +180 -0
  221. package/test/TestPayHooks.sol +190 -0
  222. package/test/TestPermissions.sol +305 -0
  223. package/test/TestPermissionsEdge.sol +286 -0
  224. package/test/TestPermit2Terminal.sol +339 -0
  225. package/test/TestRulesetQueueing.sol +1001 -0
  226. package/test/TestRulesetQueuingStress.sol +778 -0
  227. package/test/TestRulesetWeightCaching.sol +177 -0
  228. package/test/TestSplits.sol +369 -0
  229. package/test/TestTerminalMigration.sol +167 -0
  230. package/test/TestTokenFlow.sol +174 -0
  231. package/test/WeirdTokenTests.t.sol +764 -0
  232. package/test/formal/BondingCurveProperties.t.sol +411 -0
  233. package/test/formal/FeeProperties.t.sol +246 -0
  234. package/test/helpers/JBTest.sol +129 -0
  235. package/test/helpers/MetadataResolverHelper.sol +116 -0
  236. package/test/helpers/TestBaseWorkflow.sol +317 -0
  237. package/test/invariants/Phase3DeepInvariant.t.sol +404 -0
  238. package/test/invariants/RulesetsInvariant.t.sol +115 -0
  239. package/test/invariants/TerminalStoreInvariant.t.sol +220 -0
  240. package/test/invariants/TokensInvariant.t.sol +184 -0
  241. package/test/invariants/handlers/ComprehensiveHandler.sol +285 -0
  242. package/test/invariants/handlers/EconomicHandler.sol +347 -0
  243. package/test/invariants/handlers/Phase3Handler.sol +414 -0
  244. package/test/invariants/handlers/RulesetsHandler.sol +111 -0
  245. package/test/invariants/handlers/TerminalStoreHandler.sol +146 -0
  246. package/test/invariants/handlers/TokensHandler.sol +127 -0
  247. package/test/mock/ERC2771ForwarderMock.sol +37 -0
  248. package/test/mock/MockERC20.sol +18 -0
  249. package/test/mock/MockMaliciousBeneficiary.sol +67 -0
  250. package/test/mock/MockMaliciousSplitHook.sol +42 -0
  251. package/test/mock/MockPriceFeed.sol +20 -0
  252. package/test/trees/JBController/burnTokensOf.tree +9 -0
  253. package/test/trees/JBController/claimTokensFor.tree +5 -0
  254. package/test/trees/JBController/deployERC20For.tree +5 -0
  255. package/test/trees/JBController/getRulesetOf.tree +5 -0
  256. package/test/trees/JBController/launchProjectFor.tree +12 -0
  257. package/test/trees/JBController/launchRulesetsFor.tree +8 -0
  258. package/test/trees/JBController/migrateController.tree +12 -0
  259. package/test/trees/JBController/mintTokensOf.tree +12 -0
  260. package/test/trees/JBController/payReservedTokenToTerminal.tree +8 -0
  261. package/test/trees/JBController/receiveMigrationFrom.tree +4 -0
  262. package/test/trees/JBController/sendReservedTokensToSplitsOf.tree +12 -0
  263. package/test/trees/JBController/setMetadataOf.tree +5 -0
  264. package/test/trees/JBController/setSplitGroupsOf.tree +5 -0
  265. package/test/trees/JBController/setTokenFor.tree +5 -0
  266. package/test/trees/JBController/transferCreditsFrom.tree +8 -0
  267. package/test/trees/JBDirectory/primaryTerminalOf.tree +8 -0
  268. package/test/trees/JBDirectory/setControllerOf.tree +11 -0
  269. package/test/trees/JBDirectory/setPrimaryTerminalOf.tree +15 -0
  270. package/test/trees/JBDirectory/setTerminalsOf.tree +11 -0
  271. package/test/trees/JBERC20/initialize.tree +7 -0
  272. package/test/trees/JBERC20/name.tree +5 -0
  273. package/test/trees/JBERC20/nonces.tree +5 -0
  274. package/test/trees/JBERC20/symbol.tree +5 -0
  275. package/test/trees/JBFeelessAddresses/setFeelessAddress.tree +5 -0
  276. package/test/trees/JBFeelessAddresses/supportsInterface.tree +5 -0
  277. package/test/trees/JBFundAccessLimits/payoutLimitOf.tree +5 -0
  278. package/test/trees/JBFundAccessLimits/payoutLimitsOf.tree +8 -0
  279. package/test/trees/JBFundAccessLimits/setFundAccessLimitsFor.tree +18 -0
  280. package/test/trees/JBFundAccessLimits/surplusAllowanceOf.tree +5 -0
  281. package/test/trees/JBFundAccessLimits/surplusAllowancesOf.tree +8 -0
  282. package/test/trees/JBMetadataResolver/getDataFor.tree +8 -0
  283. package/test/trees/JBMultiTerminal/accountingContextsOf.tree +5 -0
  284. package/test/trees/JBMultiTerminal/addAccountingContextsFor.tree +10 -0
  285. package/test/trees/JBMultiTerminal/addToBalanceOf.tree +23 -0
  286. package/test/trees/JBMultiTerminal/cashOutTokensOf.tree +23 -0
  287. package/test/trees/JBMultiTerminal/executePayout.tree +32 -0
  288. package/test/trees/JBMultiTerminal/executeProcessFee.tree +14 -0
  289. package/test/trees/JBMultiTerminal/migrateBalanceOf.tree +12 -0
  290. package/test/trees/JBMultiTerminal/pay.tree +23 -0
  291. package/test/trees/JBMultiTerminal/processHeldFeesOf.tree +8 -0
  292. package/test/trees/JBMultiTerminal/sendPayoutsOf.tree +34 -0
  293. package/test/trees/JBMultiTerminal/useAllowanceOf.tree +16 -0
  294. package/test/trees/JBPermissions/hasPermission.tree +8 -0
  295. package/test/trees/JBPermissions/hasPermissions.tree +8 -0
  296. package/test/trees/JBPermissions/setPermissionsFor.tree +5 -0
  297. package/test/trees/JBPrices/addPriceFeedFor.tree +14 -0
  298. package/test/trees/JBPrices/pricePerUnitOf.tree +11 -0
  299. package/test/trees/JBProjects/createFor.tree +11 -0
  300. package/test/trees/JBProjects/setTokenUriResolver.tree +5 -0
  301. package/test/trees/JBProjects/supportsInterface.tree +9 -0
  302. package/test/trees/JBProjects/tokenURI.tree +5 -0
  303. package/test/trees/JBRulesets/currentApprovalStatusForLatestRulesetOf.tree +8 -0
  304. package/test/trees/JBRulesets/currentOf.tree +12 -0
  305. package/test/trees/JBRulesets/getRulesetOf.tree +5 -0
  306. package/test/trees/JBRulesets/latestQueuedRulesetOf.tree +10 -0
  307. package/test/trees/JBRulesets/rulesetsOf.tree +11 -0
  308. package/test/trees/JBRulesets/upcomingRulesetOf.tree +20 -0
  309. package/test/trees/JBRulesets/updateRulesetWeightCache.tree +5 -0
  310. package/test/trees/JBSplits/setSplitGroupsOf.tree +17 -0
  311. package/test/trees/JBSplits/splitsOf.tree +5 -0
  312. package/test/trees/JBTerminalStore/currentReclaimableSurplusOf.tree +16 -0
  313. package/test/trees/JBTerminalStore/currentSurplusOf.tree +25 -0
  314. package/test/trees/JBTerminalStore/currentTotalSurplusOf.tree +5 -0
  315. package/test/trees/JBTerminalStore/recordCashOutsFor.tree +16 -0
  316. package/test/trees/JBTerminalStore/recordPaymentFrom.tree +14 -0
  317. package/test/trees/JBTerminalStore/recordPayoutFor.tree +10 -0
  318. package/test/trees/JBTerminalStore/recordTerminalMigration.tree +5 -0
  319. package/test/trees/JBTerminalStore/recordUsedAllowanceOf.tree +10 -0
  320. package/test/trees/JBTokens/burnFrom.tree +10 -0
  321. package/test/trees/JBTokens/claimTokensFor.tree +10 -0
  322. package/test/trees/JBTokens/deployERC20For.tree +12 -0
  323. package/test/trees/JBTokens/mintFor.tree +10 -0
  324. package/test/trees/JBTokens/setTokenFor.tree +11 -0
  325. package/test/trees/JBTokens/totalBalanceOf.tree +5 -0
  326. package/test/trees/JBTokens/totalSupplyOf.tree +5 -0
  327. package/test/trees/JBTokens/transferCreditsFrom.tree +8 -0
  328. package/test/trees/mintTokensOf.tree +12 -0
  329. package/test/units/static/JBChainlinkV3PriceFeed/TestPriceFeed.sol +220 -0
  330. package/test/units/static/JBController/JBControllerSetup.sol +40 -0
  331. package/test/units/static/JBController/TestBurnTokensOf.sol +107 -0
  332. package/test/units/static/JBController/TestClaimTokensFor.sol +60 -0
  333. package/test/units/static/JBController/TestDeployErc20For.sol +80 -0
  334. package/test/units/static/JBController/TestLaunchProjectFor.sol +282 -0
  335. package/test/units/static/JBController/TestLaunchRulesetsFor.sol +322 -0
  336. package/test/units/static/JBController/TestMigrateController.sol +148 -0
  337. package/test/units/static/JBController/TestMintTokensOfUnits.sol +102 -0
  338. package/test/units/static/JBController/TestPayReservedTokenToTerminal.sol +71 -0
  339. package/test/units/static/JBController/TestReceiveMigrationFrom.sol +95 -0
  340. package/test/units/static/JBController/TestRulesetViews.sol +219 -0
  341. package/test/units/static/JBController/TestSendReservedTokensToSplitsOf.sol +595 -0
  342. package/test/units/static/JBController/TestSetSplitGroupsOf.sol +63 -0
  343. package/test/units/static/JBController/TestSetTokenFor.sol +227 -0
  344. package/test/units/static/JBController/TestSetUriOf.sol +53 -0
  345. package/test/units/static/JBController/TestTransferCreditsFrom.sol +159 -0
  346. package/test/units/static/JBDeadline/TestDeadlineFuzz.sol +194 -0
  347. package/test/units/static/JBDirectory/JBDirectorySetup.sol +22 -0
  348. package/test/units/static/JBDirectory/TestPrimaryTerminalOf.sol +122 -0
  349. package/test/units/static/JBDirectory/TestSetControllerOf.sol +173 -0
  350. package/test/units/static/JBDirectory/TestSetControllerOfMigrationOrder.sol +98 -0
  351. package/test/units/static/JBDirectory/TestSetPrimaryTerminalOf.sol +169 -0
  352. package/test/units/static/JBDirectory/TestSetTerminalsOf.sol +128 -0
  353. package/test/units/static/JBERC20/JBERC20Setup.sol +20 -0
  354. package/test/units/static/JBERC20/SigUtils.sol +34 -0
  355. package/test/units/static/JBERC20/TestInitialize.sol +54 -0
  356. package/test/units/static/JBERC20/TestName.sol +30 -0
  357. package/test/units/static/JBERC20/TestNonces.sol +59 -0
  358. package/test/units/static/JBERC20/TestSymbol.sol +31 -0
  359. package/test/units/static/JBFeelessAdresses/JBFeelessSetup.sol +20 -0
  360. package/test/units/static/JBFeelessAdresses/TestInterfaces.sol +29 -0
  361. package/test/units/static/JBFeelessAdresses/TestSetFeelessAddress.sol +35 -0
  362. package/test/units/static/JBFees/TestFeesFuzz.sol +78 -0
  363. package/test/units/static/JBFixedPointNumber/TestAdjustDecimals.sol +16 -0
  364. package/test/units/static/JBFixedPointNumber/TestAdjustDecimalsFuzz.sol +71 -0
  365. package/test/units/static/JBFundAccessLimits/JBFundAccessSetup.sol +21 -0
  366. package/test/units/static/JBFundAccessLimits/TestFundAccessLimitsEdge.sol +159 -0
  367. package/test/units/static/JBFundAccessLimits/TestPayoutLimitOf.sol +56 -0
  368. package/test/units/static/JBFundAccessLimits/TestPayoutLimitsOf.sol +94 -0
  369. package/test/units/static/JBFundAccessLimits/TestSetFundAccessLimitsFor.sol +182 -0
  370. package/test/units/static/JBFundAccessLimits/TestSurplusAllowanceOf.sol +61 -0
  371. package/test/units/static/JBFundAccessLimits/TestSurplusAllowancesOf.sol +96 -0
  372. package/test/units/static/JBMetadataResolver/TestGetDataFor.sol +89 -0
  373. package/test/units/static/JBMetadataResolver/TestMetadataResolverFuzz.sol +227 -0
  374. package/test/units/static/JBMetadataResolver/TestMetadataResolverM20M21.sol +245 -0
  375. package/test/units/static/JBMultiTerminal/JBMultiTerminalSetup.sol +39 -0
  376. package/test/units/static/JBMultiTerminal/TestAccountingContextsOf.sol +65 -0
  377. package/test/units/static/JBMultiTerminal/TestAddAccountingContextsFor.sol +313 -0
  378. package/test/units/static/JBMultiTerminal/TestAddToBalanceOf.sol +432 -0
  379. package/test/units/static/JBMultiTerminal/TestCashOutTokensOf.sol +478 -0
  380. package/test/units/static/JBMultiTerminal/TestExecutePayout.sol +577 -0
  381. package/test/units/static/JBMultiTerminal/TestExecuteProcessFee.sol +176 -0
  382. package/test/units/static/JBMultiTerminal/TestMigrateBalanceOf.sol +190 -0
  383. package/test/units/static/JBMultiTerminal/TestPay.sol +514 -0
  384. package/test/units/static/JBMultiTerminal/TestProcessHeldFeesOf.sol +29 -0
  385. package/test/units/static/JBMultiTerminal/TestSendPayoutsOf.sol +243 -0
  386. package/test/units/static/JBMultiTerminal/TestUseAllowanceOf.sol +310 -0
  387. package/test/units/static/JBPermissions/JBPermissionsSetup.sol +18 -0
  388. package/test/units/static/JBPermissions/TestHasPermission.sol +50 -0
  389. package/test/units/static/JBPermissions/TestHasPermissions.sol +93 -0
  390. package/test/units/static/JBPermissions/TestSetPermissionsFor.sol +62 -0
  391. package/test/units/static/JBPrices/JBPricesSetup.sol +26 -0
  392. package/test/units/static/JBPrices/TestAddPriceFeedFor.sol +102 -0
  393. package/test/units/static/JBPrices/TestPricePerUnitOf.sol +129 -0
  394. package/test/units/static/JBPrices/TestPrices.sol +262 -0
  395. package/test/units/static/JBProjects/JBProjectsSetup.sol +20 -0
  396. package/test/units/static/JBProjects/TestCreateFor.sol +69 -0
  397. package/test/units/static/JBProjects/TestInitialProject.sol +19 -0
  398. package/test/units/static/JBProjects/TestInterfaces.sol +27 -0
  399. package/test/units/static/JBProjects/TestSetResolver.sol +36 -0
  400. package/test/units/static/JBProjects/TestTokenUri.sol +38 -0
  401. package/test/units/static/JBRulesetMetadataResolver/TestSetCashOutTaxRateTo.sol +99 -0
  402. package/test/units/static/JBRulesets/JBRulesetsSetup.sol +21 -0
  403. package/test/units/static/JBRulesets/TestCurrentApprovalStatusForLatestRulesetOf.sol +257 -0
  404. package/test/units/static/JBRulesets/TestCurrentOf.sol +231 -0
  405. package/test/units/static/JBRulesets/TestGetRulesetOf.sol +94 -0
  406. package/test/units/static/JBRulesets/TestLatestQueuedRulesetOf.sol +252 -0
  407. package/test/units/static/JBRulesets/TestRulesets.sol +617 -0
  408. package/test/units/static/JBRulesets/TestRulesetsOf.sol +37 -0
  409. package/test/units/static/JBRulesets/TestUpcomingRulesetOf.sol +526 -0
  410. package/test/units/static/JBRulesets/TestUpdateRulesetWeightCache.sol +91 -0
  411. package/test/units/static/JBSplits/JBSplitsSetup.sol +23 -0
  412. package/test/units/static/JBSplits/TestSelfManagedSplitGroups.sol +502 -0
  413. package/test/units/static/JBSplits/TestSetSplitGroupsOf.sol +370 -0
  414. package/test/units/static/JBSplits/TestSplitsLockedEdge.sol +262 -0
  415. package/test/units/static/JBSplits/TestSplitsOf.sol +24 -0
  416. package/test/units/static/JBSplits/TestSplitsPacking.sol +33 -0
  417. package/test/units/static/JBSurplus/TestSurplusFuzz.sol +125 -0
  418. package/test/units/static/JBTerminalStore/JBTerminalStoreSetup.sol +23 -0
  419. package/test/units/static/JBTerminalStore/TestCurrentReclaimableSurplusOf.sol +434 -0
  420. package/test/units/static/JBTerminalStore/TestCurrentSurplusOf.sol +428 -0
  421. package/test/units/static/JBTerminalStore/TestCurrentTotalSurplusOf.sol +65 -0
  422. package/test/units/static/JBTerminalStore/TestRecordCashOutsFor.sol +479 -0
  423. package/test/units/static/JBTerminalStore/TestRecordPaymentFrom.sol +508 -0
  424. package/test/units/static/JBTerminalStore/TestRecordPayoutFor.sol +257 -0
  425. package/test/units/static/JBTerminalStore/TestRecordTerminalMigration.sol +131 -0
  426. package/test/units/static/JBTerminalStore/TestRecordUsedAllowanceOf.sol +390 -0
  427. package/test/units/static/JBTerminalStore/TestUint224Overflow.sol +187 -0
  428. package/test/units/static/JBTokens/JBTokensSetup.sol +23 -0
  429. package/test/units/static/JBTokens/TestBurnFrom.sol +104 -0
  430. package/test/units/static/JBTokens/TestClaimTokensFor.sol +107 -0
  431. package/test/units/static/JBTokens/TestDeployERC20ForUnits.sol +89 -0
  432. package/test/units/static/JBTokens/TestMintFor.sol +97 -0
  433. package/test/units/static/JBTokens/TestSetTokenFor.sol +95 -0
  434. package/test/units/static/JBTokens/TestTotalBalanceOf.sol +65 -0
  435. package/test/units/static/JBTokens/TestTotalSupplyOf.sol +56 -0
  436. package/test/units/static/JBTokens/TestTransferCreditsFrom.sol +54 -0
@@ -0,0 +1,220 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import "forge-std/StdInvariant.sol";
5
+ import /* {*} from */ "../helpers/TestBaseWorkflow.sol";
6
+ import {TerminalStoreHandler} from "./handlers/TerminalStoreHandler.sol";
7
+ import {JBAccountingContext} from "../../src/structs/JBAccountingContext.sol";
8
+
9
+ /// @notice Invariant tests for JBTerminalStore fund conservation.
10
+ /// @dev Verifies that funds cannot be created or destroyed through normal terminal operations.
11
+ contract TerminalStoreInvariant_Local is StdInvariant, TestBaseWorkflow {
12
+ using JBRulesetMetadataResolver for JBRuleset;
13
+
14
+ TerminalStoreHandler public handler;
15
+
16
+ uint256 public projectId;
17
+ address public projectOwner;
18
+
19
+ function setUp() public override {
20
+ super.setUp();
21
+ projectOwner = multisig();
22
+
23
+ // Launch fee collector project (#1)
24
+ JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
25
+ feeRulesetConfig[0].mustStartAtOrAfter = 0;
26
+ feeRulesetConfig[0].duration = 0;
27
+ feeRulesetConfig[0].weight = 1000e18;
28
+ feeRulesetConfig[0].weightCutPercent = 0;
29
+ feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
30
+ feeRulesetConfig[0].metadata = JBRulesetMetadata({
31
+ reservedPercent: 0,
32
+ cashOutTaxRate: 0,
33
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
34
+ pausePay: false,
35
+ pauseCreditTransfers: false,
36
+ allowOwnerMinting: false,
37
+ allowSetCustomToken: false,
38
+ allowTerminalMigration: false,
39
+ allowSetTerminals: false,
40
+ ownerMustSendPayouts: false,
41
+ allowSetController: false,
42
+ allowAddAccountingContext: true,
43
+ allowAddPriceFeed: false,
44
+ holdFees: false,
45
+ useTotalSurplusForCashOuts: false,
46
+ useDataHookForPay: false,
47
+ useDataHookForCashOut: false,
48
+ dataHook: address(0),
49
+ metadata: 0
50
+ });
51
+ feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
52
+ feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
53
+
54
+ JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](1);
55
+ JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
56
+ tokensToAccept[0] = JBAccountingContext({
57
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
58
+ });
59
+ terminalConfigurations[0] =
60
+ JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: tokensToAccept});
61
+
62
+ jbController()
63
+ .launchProjectFor({
64
+ owner: address(420),
65
+ projectUri: "feeCollector",
66
+ rulesetConfigurations: feeRulesetConfig,
67
+ terminalConfigurations: terminalConfigurations,
68
+ memo: ""
69
+ });
70
+
71
+ // Launch the test project (#2) with 50% cash out tax, no payout limit, no reserved rate
72
+ JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
73
+ rulesetConfig[0].mustStartAtOrAfter = 0;
74
+ rulesetConfig[0].duration = 0;
75
+ rulesetConfig[0].weight = 1000e18;
76
+ rulesetConfig[0].weightCutPercent = 0;
77
+ rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
78
+ rulesetConfig[0].metadata = JBRulesetMetadata({
79
+ reservedPercent: 0,
80
+ cashOutTaxRate: 5000, // 50% tax
81
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
82
+ pausePay: false,
83
+ pauseCreditTransfers: false,
84
+ allowOwnerMinting: true,
85
+ allowSetCustomToken: true,
86
+ allowTerminalMigration: false,
87
+ allowSetTerminals: false,
88
+ ownerMustSendPayouts: false,
89
+ allowSetController: false,
90
+ allowAddAccountingContext: true,
91
+ allowAddPriceFeed: false,
92
+ holdFees: false,
93
+ useTotalSurplusForCashOuts: false,
94
+ useDataHookForPay: false,
95
+ useDataHookForCashOut: false,
96
+ dataHook: address(0),
97
+ metadata: 0
98
+ });
99
+ rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
100
+ rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
101
+
102
+ projectId = jbController()
103
+ .launchProjectFor({
104
+ owner: projectOwner,
105
+ projectUri: "testProject",
106
+ rulesetConfigurations: rulesetConfig,
107
+ terminalConfigurations: terminalConfigurations,
108
+ memo: ""
109
+ });
110
+
111
+ // Deploy ERC20 so tokens can be tracked
112
+ vm.prank(projectOwner);
113
+ jbController().deployERC20For(projectId, "TestToken", "TT", bytes32(0));
114
+
115
+ // Deploy handler
116
+ handler = new TerminalStoreHandler(
117
+ jbMultiTerminal(), jbTerminalStore(), jbController(), jbTokens(), projectId, projectOwner
118
+ );
119
+
120
+ // Register handler as target
121
+ bytes4[] memory selectors = new bytes4[](4);
122
+ selectors[0] = TerminalStoreHandler.payProject.selector;
123
+ selectors[1] = TerminalStoreHandler.cashOutTokens.selector;
124
+ selectors[2] = TerminalStoreHandler.sendPayouts.selector;
125
+ selectors[3] = TerminalStoreHandler.addToBalance.selector;
126
+
127
+ targetContract(address(handler));
128
+ targetSelector(FuzzSelector({addr: address(handler), selectors: selectors}));
129
+ }
130
+
131
+ /// @notice INV-TS-1: Terminal ETH balance >= sum of recorded balances for this project.
132
+ /// @dev The terminal's actual ETH balance should always be >= what the store records,
133
+ /// because fees from other projects also accumulate in the terminal.
134
+ function invariant_TS1_terminalBalanceCoversRecordedBalance() public view {
135
+ uint256 recordedBalance =
136
+ jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
137
+ uint256 actualBalance = address(jbMultiTerminal()).balance;
138
+
139
+ assertGe(actualBalance, recordedBalance, "INV-TS-1: Terminal ETH balance must be >= recorded project balance");
140
+ }
141
+
142
+ /// @notice INV-TS-2: Reclaimable surplus <= current surplus, always.
143
+ function invariant_TS2_reclaimableSurplusLeqSurplus() public view {
144
+ uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
145
+ if (totalSupply == 0) return; // Skip when no tokens exist
146
+
147
+ JBAccountingContext[] memory contexts = new JBAccountingContext[](1);
148
+ contexts[0] = JBAccountingContext({
149
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
150
+ });
151
+
152
+ uint256 surplus = jbTerminalStore()
153
+ .currentSurplusOf({
154
+ terminal: address(jbMultiTerminal()),
155
+ projectId: projectId,
156
+ accountingContexts: contexts,
157
+ decimals: 18,
158
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
159
+ });
160
+
161
+ // Check reclaimable for half the supply
162
+ uint256 halfSupply = totalSupply / 2;
163
+ if (halfSupply == 0) return;
164
+
165
+ uint256 reclaimable = jbTerminalStore()
166
+ .currentReclaimableSurplusOf({
167
+ projectId: projectId, cashOutCount: halfSupply, totalSupply: totalSupply, surplus: surplus
168
+ });
169
+
170
+ assertLe(reclaimable, surplus, "INV-TS-2: Reclaimable surplus must not exceed current surplus");
171
+ }
172
+
173
+ /// @notice INV-TS-3: Fee project (project #1) balance in the terminal increases monotonically.
174
+ /// @dev We can only check that it's >= 0; true monotonicity requires tracking across calls,
175
+ /// which the handler ghost variables assist with.
176
+ function invariant_TS3_feeProjectBalanceNonNegative() public view {
177
+ uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
178
+
179
+ // Fee project balance should be non-negative (always true for uint, but conceptually
180
+ // this checks that the fee project accumulates fees from cashouts).
181
+ assertGe(feeProjectBalance, 0, "INV-TS-3: Fee project balance should be non-negative");
182
+ }
183
+
184
+ /// @notice INV-TS-4: Total actual ETH in terminal = recorded balance of all projects.
185
+ /// @dev The terminal's ETH balance should equal the sum of all project balances recorded in the store.
186
+ function invariant_TS4_terminalBalanceConservation() public view {
187
+ uint256 projectBalance =
188
+ jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
189
+ uint256 feeProjectBalance = jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN);
190
+ uint256 actualBalance = address(jbMultiTerminal()).balance;
191
+
192
+ // The terminal's actual balance should equal the sum of all recorded project balances.
193
+ // There should be no "unaccounted" ETH sitting in the terminal.
194
+ assertEq(
195
+ actualBalance,
196
+ projectBalance + feeProjectBalance,
197
+ "INV-TS-4: Terminal ETH balance must equal sum of all recorded project balances"
198
+ );
199
+ }
200
+
201
+ /// @notice INV-TS-5: Ghost variable conservation check.
202
+ /// @dev totalPaidIn + totalAddedToBalance >= totalCashedOut + totalPaidOut + remaining balance.
203
+ /// Fees complicate exact equality, so we use >= for the funds-in side.
204
+ function invariant_TS5_ghostVariableConservation() public view {
205
+ uint256 totalIn = handler.ghost_totalPaidIn() + handler.ghost_totalAddedToBalance();
206
+ uint256 totalOut = handler.ghost_totalCashedOut() + handler.ghost_totalPaidOut();
207
+
208
+ uint256 projectBalance =
209
+ jbTerminalStore().balanceOf(address(jbMultiTerminal()), projectId, JBConstants.NATIVE_TOKEN);
210
+
211
+ // Everything that went in must be >= everything that went out + what remains.
212
+ // Strict equality breaks because fees redistribute between projects.
213
+ assertGe(
214
+ totalIn,
215
+ totalOut + projectBalance
216
+ - jbTerminalStore().balanceOf(address(jbMultiTerminal()), 1, JBConstants.NATIVE_TOKEN),
217
+ "INV-TS-5: Ghost conservation - funds in >= funds out + project balance (adjusted for fees)"
218
+ );
219
+ }
220
+ }
@@ -0,0 +1,184 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import "forge-std/StdInvariant.sol";
5
+ import /* {*} from */ "../helpers/TestBaseWorkflow.sol";
6
+ import {TokensHandler} from "./handlers/TokensHandler.sol";
7
+
8
+ /// @notice Invariant tests for JBTokens supply and balance consistency.
9
+ /// @dev Verifies that the dual-balance system (credits + ERC20) maintains exact accounting.
10
+ contract TokensInvariant_Local is StdInvariant, TestBaseWorkflow {
11
+ using JBRulesetMetadataResolver for JBRuleset;
12
+
13
+ TokensHandler public handler;
14
+
15
+ uint256 public projectId;
16
+ address public projectOwner;
17
+
18
+ function setUp() public override {
19
+ super.setUp();
20
+ projectOwner = multisig();
21
+
22
+ // Launch fee collector project (#1)
23
+ JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
24
+ feeRulesetConfig[0].mustStartAtOrAfter = 0;
25
+ feeRulesetConfig[0].duration = 0;
26
+ feeRulesetConfig[0].weight = 1000e18;
27
+ feeRulesetConfig[0].weightCutPercent = 0;
28
+ feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
29
+ feeRulesetConfig[0].metadata = JBRulesetMetadata({
30
+ reservedPercent: 0,
31
+ cashOutTaxRate: 0,
32
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
33
+ pausePay: false,
34
+ pauseCreditTransfers: false,
35
+ allowOwnerMinting: false,
36
+ allowSetCustomToken: false,
37
+ allowTerminalMigration: false,
38
+ allowSetTerminals: false,
39
+ ownerMustSendPayouts: false,
40
+ allowSetController: false,
41
+ allowAddAccountingContext: true,
42
+ allowAddPriceFeed: false,
43
+ holdFees: false,
44
+ useTotalSurplusForCashOuts: false,
45
+ useDataHookForPay: false,
46
+ useDataHookForCashOut: false,
47
+ dataHook: address(0),
48
+ metadata: 0
49
+ });
50
+ feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
51
+ feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
52
+
53
+ JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](1);
54
+ JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
55
+ tokensToAccept[0] = JBAccountingContext({
56
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
57
+ });
58
+ terminalConfigurations[0] =
59
+ JBTerminalConfig({terminal: jbMultiTerminal(), accountingContextsToAccept: tokensToAccept});
60
+
61
+ jbController()
62
+ .launchProjectFor({
63
+ owner: address(420),
64
+ projectUri: "feeCollector",
65
+ rulesetConfigurations: feeRulesetConfig,
66
+ terminalConfigurations: terminalConfigurations,
67
+ memo: ""
68
+ });
69
+
70
+ // Launch the test project with credits (no ERC20 initially, then deploy)
71
+ JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
72
+ rulesetConfig[0].mustStartAtOrAfter = 0;
73
+ rulesetConfig[0].duration = 0;
74
+ rulesetConfig[0].weight = 1000e18;
75
+ rulesetConfig[0].weightCutPercent = 0;
76
+ rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
77
+ rulesetConfig[0].metadata = JBRulesetMetadata({
78
+ reservedPercent: 0,
79
+ cashOutTaxRate: 5000,
80
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
81
+ pausePay: false,
82
+ pauseCreditTransfers: false,
83
+ allowOwnerMinting: true,
84
+ allowSetCustomToken: true,
85
+ allowTerminalMigration: false,
86
+ allowSetTerminals: false,
87
+ ownerMustSendPayouts: false,
88
+ allowSetController: false,
89
+ allowAddAccountingContext: true,
90
+ allowAddPriceFeed: false,
91
+ holdFees: false,
92
+ useTotalSurplusForCashOuts: false,
93
+ useDataHookForPay: false,
94
+ useDataHookForCashOut: false,
95
+ dataHook: address(0),
96
+ metadata: 0
97
+ });
98
+ rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
99
+ rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
100
+
101
+ projectId = jbController()
102
+ .launchProjectFor({
103
+ owner: projectOwner,
104
+ projectUri: "testProject",
105
+ rulesetConfigurations: rulesetConfig,
106
+ terminalConfigurations: terminalConfigurations,
107
+ memo: ""
108
+ });
109
+
110
+ // Deploy ERC20 so claiming works
111
+ vm.prank(projectOwner);
112
+ jbController().deployERC20For(projectId, "TestToken", "TT", bytes32(0));
113
+
114
+ // Deploy handler
115
+ handler = new TokensHandler(jbMultiTerminal(), jbController(), jbTokens(), projectId, projectOwner);
116
+
117
+ // Register handler
118
+ bytes4[] memory selectors = new bytes4[](4);
119
+ selectors[0] = TokensHandler.mintTokens.selector;
120
+ selectors[1] = TokensHandler.burnTokens.selector;
121
+ selectors[2] = TokensHandler.claimCredits.selector;
122
+ selectors[3] = TokensHandler.transferCredits.selector;
123
+
124
+ targetContract(address(handler));
125
+ targetSelector(FuzzSelector({addr: address(handler), selectors: selectors}));
126
+ }
127
+
128
+ /// @notice INV-TK-1: totalSupplyOf == totalCreditSupplyOf + token.totalSupply()
129
+ function invariant_TK1_totalSupplyDecomposition() public view {
130
+ uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
131
+ uint256 creditSupply = jbTokens().totalCreditSupplyOf(projectId);
132
+ IJBToken token = jbTokens().tokenOf(projectId);
133
+ uint256 erc20Supply = address(token) != address(0) ? token.totalSupply() : 0;
134
+
135
+ assertEq(totalSupply, creditSupply + erc20Supply, "INV-TK-1: totalSupply must equal creditSupply + erc20Supply");
136
+ }
137
+
138
+ /// @notice INV-TK-2: For each holder, totalBalanceOf == creditBalanceOf + token.balanceOf
139
+ function invariant_TK2_perHolderBalanceConsistency() public view {
140
+ uint256 holderCount = handler.holderCount();
141
+ IJBToken token = jbTokens().tokenOf(projectId);
142
+
143
+ for (uint256 i = 0; i < holderCount; i++) {
144
+ address holder = handler.holderAt(i);
145
+ uint256 totalBalance = jbTokens().totalBalanceOf(holder, projectId);
146
+ uint256 creditBalance = jbTokens().creditBalanceOf(holder, projectId);
147
+ uint256 erc20Balance = address(token) != address(0) ? token.balanceOf(holder) : 0;
148
+
149
+ assertEq(
150
+ totalBalance,
151
+ creditBalance + erc20Balance,
152
+ "INV-TK-2: Per-holder totalBalance must equal credits + ERC20"
153
+ );
154
+ }
155
+ }
156
+
157
+ /// @notice INV-TK-3: Sum of all holder totalBalanceOf == totalSupplyOf
158
+ function invariant_TK3_sumOfBalancesEqualsTotalSupply() public view {
159
+ uint256 holderCount = handler.holderCount();
160
+ uint256 sumOfBalances;
161
+
162
+ for (uint256 i = 0; i < holderCount; i++) {
163
+ address holder = handler.holderAt(i);
164
+ sumOfBalances += jbTokens().totalBalanceOf(holder, projectId);
165
+ }
166
+
167
+ uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
168
+
169
+ // Sum of tracked holder balances should be <= totalSupply.
170
+ // It may be < totalSupply if there are holders we haven't tracked (e.g., fee project).
171
+ assertLe(sumOfBalances, totalSupply, "INV-TK-3: Sum of tracked holder balances must not exceed totalSupply");
172
+ }
173
+
174
+ /// @notice INV-TK-4: Claiming does not change totalSupplyOf.
175
+ /// @dev This is implicitly tested via TK-1: if claiming changed totalSupply,
176
+ /// the creditSupply + erc20Supply decomposition would break.
177
+ /// We add an explicit check that supply is always non-negative (trivially true for uint).
178
+ function invariant_TK4_supplyNeverNegative() public view {
179
+ uint256 totalSupply = jbTokens().totalSupplyOf(projectId);
180
+ uint256 creditSupply = jbTokens().totalCreditSupplyOf(projectId);
181
+
182
+ assertGe(totalSupply, creditSupply, "INV-TK-4: totalSupply must be >= creditSupply");
183
+ }
184
+ }
@@ -0,0 +1,285 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import "forge-std/Test.sol";
5
+ import {JBConstants} from "../../../src/libraries/JBConstants.sol";
6
+ import {IJBMultiTerminal} from "../../../src/interfaces/IJBMultiTerminal.sol";
7
+ import {IJBTerminalStore} from "../../../src/interfaces/IJBTerminalStore.sol";
8
+ import {IJBController} from "../../../src/interfaces/IJBController.sol";
9
+ import {IJBTokens} from "../../../src/interfaces/IJBTokens.sol";
10
+
11
+ /// @notice Comprehensive handler for JBTerminalStore invariant testing.
12
+ /// @dev Extends the basic handler with 10 operations including reserves, allowance, burns, claims, time, and fees.
13
+ contract ComprehensiveHandler is Test {
14
+ IJBMultiTerminal public terminal;
15
+ IJBTerminalStore public store;
16
+ IJBController public controller;
17
+ IJBTokens public tokens;
18
+
19
+ uint256 public projectId;
20
+ address public projectOwner;
21
+
22
+ // Ghost variables for fund tracking
23
+ uint256 public ghost_totalPaidIn;
24
+ uint256 public ghost_totalCashedOut;
25
+ uint256 public ghost_totalPaidOut;
26
+ uint256 public ghost_totalAddedToBalance;
27
+ uint256 public ghost_totalAllowanceUsed;
28
+ uint256 public ghost_feeProjectBalanceLast;
29
+ uint256 public ghost_feeProjectBalanceDecreased; // should always be 0
30
+
31
+ // Track actors
32
+ address[] public actors;
33
+ mapping(address => bool) public isActor;
34
+ uint256 public constant NUM_ACTORS = 5;
35
+
36
+ // Operation counters for debugging
37
+ uint256 public callCount_pay;
38
+ uint256 public callCount_cashOut;
39
+ uint256 public callCount_sendPayouts;
40
+ uint256 public callCount_addToBalance;
41
+ uint256 public callCount_sendReservedTokens;
42
+ uint256 public callCount_useAllowance;
43
+ uint256 public callCount_burnTokens;
44
+ uint256 public callCount_claimCredits;
45
+ uint256 public callCount_advanceTime;
46
+ uint256 public callCount_processHeldFees;
47
+
48
+ constructor(
49
+ IJBMultiTerminal _terminal,
50
+ IJBTerminalStore _store,
51
+ IJBController _controller,
52
+ IJBTokens _tokens,
53
+ uint256 _projectId,
54
+ address _projectOwner
55
+ ) {
56
+ terminal = _terminal;
57
+ store = _store;
58
+ controller = _controller;
59
+ tokens = _tokens;
60
+ projectId = _projectId;
61
+ projectOwner = _projectOwner;
62
+
63
+ // Create actor addresses
64
+ for (uint256 i = 0; i < NUM_ACTORS; i++) {
65
+ address actor = address(uint160(0x2000 + i));
66
+ actors.push(actor);
67
+ isActor[actor] = true;
68
+ }
69
+
70
+ // Initialize fee project balance tracking
71
+ ghost_feeProjectBalanceLast = store.balanceOf(address(terminal), 1, JBConstants.NATIVE_TOKEN);
72
+ }
73
+
74
+ /// @notice Selects an actor based on a seed.
75
+ function _getActor(uint256 seed) internal view returns (address) {
76
+ return actors[seed % actors.length];
77
+ }
78
+
79
+ /// @notice Track fee project balance monotonicity.
80
+ function _trackFeeProjectBalance() internal {
81
+ uint256 currentFeeBalance = store.balanceOf(address(terminal), 1, JBConstants.NATIVE_TOKEN);
82
+ if (currentFeeBalance < ghost_feeProjectBalanceLast) {
83
+ ghost_feeProjectBalanceDecreased++;
84
+ }
85
+ ghost_feeProjectBalanceLast = currentFeeBalance;
86
+ }
87
+
88
+ // ─── Operation 1: Pay
89
+ // ─────────────────────────────────────────────
90
+
91
+ function payProject(uint256 actorSeed, uint256 amount) public {
92
+ amount = bound(amount, 0.01 ether, 100 ether);
93
+ address actor = _getActor(actorSeed);
94
+
95
+ vm.deal(actor, amount);
96
+ vm.prank(actor);
97
+ terminal.pay{value: amount}({
98
+ projectId: projectId,
99
+ token: JBConstants.NATIVE_TOKEN,
100
+ amount: amount,
101
+ beneficiary: actor,
102
+ minReturnedTokens: 0,
103
+ memo: "",
104
+ metadata: new bytes(0)
105
+ });
106
+
107
+ ghost_totalPaidIn += amount;
108
+ callCount_pay++;
109
+ _trackFeeProjectBalance();
110
+ }
111
+
112
+ // ─── Operation 2: Cash Out
113
+ // ────────────────────────────────────────
114
+
115
+ function cashOutTokens(uint256 actorSeed, uint256 cashOutPercent) public {
116
+ address actor = _getActor(actorSeed);
117
+ uint256 tokenBalance = tokens.totalBalanceOf(actor, projectId);
118
+ if (tokenBalance == 0) return;
119
+
120
+ cashOutPercent = bound(cashOutPercent, 1, 100);
121
+ uint256 cashOutCount = (tokenBalance * cashOutPercent) / 100;
122
+ if (cashOutCount == 0) return;
123
+
124
+ vm.prank(actor);
125
+ uint256 reclaimAmount = terminal.cashOutTokensOf({
126
+ holder: actor,
127
+ projectId: projectId,
128
+ cashOutCount: cashOutCount,
129
+ tokenToReclaim: JBConstants.NATIVE_TOKEN,
130
+ minTokensReclaimed: 0,
131
+ beneficiary: payable(actor),
132
+ metadata: new bytes(0)
133
+ });
134
+
135
+ ghost_totalCashedOut += reclaimAmount;
136
+ callCount_cashOut++;
137
+ _trackFeeProjectBalance();
138
+ }
139
+
140
+ // ─── Operation 3: Send Payouts
141
+ // ────────────────────────────────────
142
+
143
+ function sendPayouts(uint256 amount) public {
144
+ uint256 balance = store.balanceOf(address(terminal), projectId, JBConstants.NATIVE_TOKEN);
145
+ if (balance == 0) return;
146
+
147
+ amount = bound(amount, 1, balance);
148
+
149
+ vm.prank(projectOwner);
150
+ try terminal.sendPayoutsOf({
151
+ projectId: projectId,
152
+ token: JBConstants.NATIVE_TOKEN,
153
+ amount: amount,
154
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
155
+ minTokensPaidOut: 0
156
+ }) returns (
157
+ uint256 amountPaidOut
158
+ ) {
159
+ ghost_totalPaidOut += amountPaidOut;
160
+ } catch {}
161
+
162
+ callCount_sendPayouts++;
163
+ _trackFeeProjectBalance();
164
+ }
165
+
166
+ // ─── Operation 4: Add to Balance
167
+ // ──────────────────────────────────
168
+
169
+ function addToBalance(uint256 amount) public {
170
+ amount = bound(amount, 0.01 ether, 50 ether);
171
+
172
+ vm.deal(address(this), amount);
173
+ terminal.addToBalanceOf{value: amount}({
174
+ projectId: projectId,
175
+ token: JBConstants.NATIVE_TOKEN,
176
+ amount: amount,
177
+ shouldReturnHeldFees: false,
178
+ memo: "",
179
+ metadata: new bytes(0)
180
+ });
181
+
182
+ ghost_totalAddedToBalance += amount;
183
+ callCount_addToBalance++;
184
+ _trackFeeProjectBalance();
185
+ }
186
+
187
+ // ─── Operation 5: Send Reserved Tokens
188
+ // ────────────────────────────
189
+
190
+ function sendReservedTokens() public {
191
+ try controller.sendReservedTokensToSplitsOf(projectId) {} catch {}
192
+ callCount_sendReservedTokens++;
193
+ _trackFeeProjectBalance();
194
+ }
195
+
196
+ // ─── Operation 6: Use Allowance
197
+ // ───────────────────────────────────
198
+
199
+ function useAllowance(uint256 amount) public {
200
+ uint256 balance = store.balanceOf(address(terminal), projectId, JBConstants.NATIVE_TOKEN);
201
+ if (balance == 0) return;
202
+
203
+ amount = bound(amount, 0.001 ether, 3 ether);
204
+
205
+ vm.prank(projectOwner);
206
+ try terminal.useAllowanceOf({
207
+ projectId: projectId,
208
+ token: JBConstants.NATIVE_TOKEN,
209
+ amount: amount,
210
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
211
+ minTokensPaidOut: 0,
212
+ beneficiary: payable(projectOwner),
213
+ feeBeneficiary: payable(projectOwner),
214
+ memo: "allowance"
215
+ }) returns (
216
+ uint256 netAmountPaidOut
217
+ ) {
218
+ ghost_totalAllowanceUsed += netAmountPaidOut;
219
+ } catch {}
220
+
221
+ callCount_useAllowance++;
222
+ _trackFeeProjectBalance();
223
+ }
224
+
225
+ // ─── Operation 7: Burn Tokens
226
+ // ─────────────────────────────────────
227
+
228
+ function burnTokens(uint256 actorSeed, uint256 burnPercent) public {
229
+ address actor = _getActor(actorSeed);
230
+ uint256 tokenBalance = tokens.totalBalanceOf(actor, projectId);
231
+ if (tokenBalance == 0) return;
232
+
233
+ burnPercent = bound(burnPercent, 1, 100);
234
+ uint256 burnCount = (tokenBalance * burnPercent) / 100;
235
+ if (burnCount == 0) return;
236
+
237
+ vm.prank(actor);
238
+ try controller.burnTokensOf({holder: actor, projectId: projectId, tokenCount: burnCount, memo: "burn"}) {}
239
+ catch {}
240
+
241
+ callCount_burnTokens++;
242
+ }
243
+
244
+ // ─── Operation 8: Claim Credits as ERC20
245
+ // ──────────────────────────
246
+
247
+ function claimCredits(uint256 actorSeed, uint256 claimPercent) public {
248
+ address actor = _getActor(actorSeed);
249
+ uint256 creditBalance = tokens.creditBalanceOf(actor, projectId);
250
+ if (creditBalance == 0) return;
251
+
252
+ claimPercent = bound(claimPercent, 1, 100);
253
+ uint256 claimCount = (creditBalance * claimPercent) / 100;
254
+ if (claimCount == 0) return;
255
+
256
+ vm.prank(actor);
257
+ try controller.claimTokensFor({
258
+ holder: actor, projectId: projectId, tokenCount: claimCount, beneficiary: actor
259
+ }) {}
260
+ catch {}
261
+
262
+ callCount_claimCredits++;
263
+ }
264
+
265
+ // ─── Operation 9: Advance Time
266
+ // ────────────────────────────────────
267
+
268
+ function advanceTime(uint256 timeSeed) public {
269
+ uint256 timeJump = bound(timeSeed, 1 hours, 90 days);
270
+ vm.warp(block.timestamp + timeJump);
271
+ callCount_advanceTime++;
272
+ }
273
+
274
+ // ─── Operation 10: Process Held Fees
275
+ // ──────────────────────────────
276
+
277
+ function processHeldFees(uint256 count) public {
278
+ count = bound(count, 1, 10);
279
+ try terminal.processHeldFeesOf(projectId, JBConstants.NATIVE_TOKEN, count) {} catch {}
280
+ callCount_processHeldFees++;
281
+ _trackFeeProjectBalance();
282
+ }
283
+
284
+ receive() external payable {}
285
+ }