@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,438 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity 0.8.23;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ /**
7
+ * @notice Test the `JBDelegateMetadata` library and helper contract.
8
+ *
9
+ * @dev These are a mixed collection of unit and integration tests.
10
+ */
11
+ contract JBDelegateMetadataLib_Test_Local is Test {
12
+ MetadataResolverHelper parser;
13
+
14
+ /**
15
+ * @notice Deploy the helper contract.
16
+ *
17
+ * @dev Helper inherits the lib and add `createMetadata`.
18
+ */
19
+ function setUp() external {
20
+ parser = new MetadataResolverHelper();
21
+ }
22
+
23
+ /**
24
+ * @notice Test the parsing of arbitrary metadata.
25
+ */
26
+ function test_parse() external view {
27
+ bytes4 _id1 = bytes4(0x11111111);
28
+ bytes4 _id2 = bytes4(0x33333333);
29
+
30
+ uint256 _data1 = 69_696_969;
31
+ bytes memory _data2 = new bytes(50);
32
+
33
+ bytes memory _metadata = abi.encodePacked(
34
+ // -- offset 0 --
35
+ bytes32(uint256(type(uint256).max)), // First 32B reserved
36
+ // -- offset 1 --
37
+ _id1, // First id
38
+ uint8(2), // First data offset == 2
39
+ _id2, // Second id == _id
40
+ uint8(3), // Second data offset == 3
41
+ bytes22(0), // Rest of the word is 0-padded
42
+ // -- offset 2 --
43
+ _data1, // First data
44
+ // -- offset 3 --
45
+ _data2 // Second data
46
+ );
47
+
48
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(_id2, _metadata);
49
+ assertEq(_dataParsed, _data2);
50
+ assertTrue(_found);
51
+
52
+ (_found, _dataParsed) = parser.getDataFor(_id1, _metadata);
53
+ assertEq(abi.decode(_dataParsed, (uint256)), _data1);
54
+ assertTrue(_found);
55
+ }
56
+
57
+ /**
58
+ * @notice Test creating and parsing bytes only metadata.
59
+ */
60
+ function test_createAndParse_bytes() external view {
61
+ bytes4[] memory _ids = new bytes4[](10);
62
+ bytes[] memory _datas = new bytes[](10);
63
+
64
+ for (uint256 _i; _i < _ids.length; _i++) {
65
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
66
+ _datas[_i] = abi.encode(
67
+ bytes1(uint8(_i + 1)), uint32(69), bytes2(uint16(_i + 69)), bytes32(uint256(type(uint256).max))
68
+ );
69
+ }
70
+
71
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
72
+
73
+ for (uint256 _i; _i < _ids.length; _i++) {
74
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(_ids[_i], _metadata);
75
+ (bytes1 _a, uint32 _deadBeef, bytes2 _c, bytes32 _d) =
76
+ abi.decode(_dataParsed, (bytes1, uint32, bytes2, bytes32));
77
+
78
+ assertTrue(_found);
79
+
80
+ assertEq(uint8(_a), _i + 1);
81
+ assertEq(uint256(_deadBeef), uint32(69));
82
+ assertEq(uint16(_c), _i + 69);
83
+ assertEq(_d, bytes32(uint256(type(uint256).max)));
84
+ }
85
+ }
86
+
87
+ /**
88
+ * @notice Test creating and parsing `uint`-only metadata.
89
+ */
90
+ function test_createAndParse_uint(uint256 _numberOfIds) external {
91
+ // Maximum 219 hooks with 1 word data (offset overflow if more).
92
+ _numberOfIds = bound(_numberOfIds, 1, 220);
93
+
94
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
95
+ bytes[] memory _datas = new bytes[](_numberOfIds);
96
+
97
+ for (uint256 _i; _i < _ids.length; _i++) {
98
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
99
+ _datas[_i] = abi.encode(type(uint256).max - _i);
100
+ }
101
+
102
+ if (_numberOfIds == 220) vm.expectRevert(JBMetadataResolver.JBMetadataResolver_MetadataTooLong.selector);
103
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
104
+ if (_numberOfIds < 220) {
105
+ for (uint256 _i; _i < _ids.length; _i++) {
106
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(_ids[_i], _metadata);
107
+ uint256 _data = abi.decode(_dataParsed, (uint256));
108
+
109
+ assertTrue(_found);
110
+ assertEq(_data, type(uint256).max - _i);
111
+ }
112
+ }
113
+ }
114
+
115
+ /**
116
+ * @notice Test creating and parsing metadata of varying length.
117
+ */
118
+ function test_createAndParse_mixed(uint256 _numberOfIds) external view {
119
+ _numberOfIds = bound(_numberOfIds, 1, 15);
120
+
121
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
122
+ bytes[] memory _datas = new bytes[](_numberOfIds);
123
+
124
+ for (uint256 _i; _i < _ids.length; _i++) {
125
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
126
+ _datas[_i] = abi.encode(69 << _i * 20);
127
+ }
128
+
129
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
130
+
131
+ for (uint256 _i; _i < _ids.length; _i++) {
132
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(_ids[_i], _metadata);
133
+ uint256 _data = abi.decode(_dataParsed, (uint256));
134
+
135
+ assertTrue(_found);
136
+ assertEq(_data, 69 << _i * 20);
137
+ }
138
+ }
139
+
140
+ /**
141
+ * @notice Test if `createMetadata` reverts when the offset would overflow.
142
+ */
143
+ function test_createRevertIfOffsetTooBig(uint256 _numberOfIds) external {
144
+ // Max 1000 for evm memory limit
145
+ _numberOfIds = bound(_numberOfIds, 221, 1000);
146
+
147
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
148
+ bytes[] memory _datas = new bytes[](_numberOfIds);
149
+
150
+ for (uint256 _i; _i < _ids.length; _i++) {
151
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
152
+ _datas[_i] = abi.encode(type(uint256).max - _i);
153
+ }
154
+
155
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_MetadataTooLong.selector);
156
+ parser.createMetadata(_ids, _datas);
157
+ }
158
+
159
+ /**
160
+ * @notice Test adding `uint` to an `uint` metadata.
161
+ */
162
+ function test_addToMetadata_uint(uint256 _numberOfIds) external view {
163
+ _numberOfIds = bound(_numberOfIds, 1, 219);
164
+
165
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
166
+ bytes[] memory _datas = new bytes[](_numberOfIds);
167
+
168
+ for (uint256 _i; _i < _ids.length; _i++) {
169
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
170
+ _datas[_i] = abi.encode(type(uint256).max - _i);
171
+ }
172
+
173
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
174
+
175
+ bytes memory _modifiedMetadata =
176
+ parser.addDataToMetadata(_metadata, bytes4(uint32(type(uint32).max)), abi.encode(123_456));
177
+
178
+ // Check
179
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _modifiedMetadata);
180
+ uint256 _data = abi.decode(_dataParsed, (uint256));
181
+
182
+ assertTrue(_found);
183
+ assertEq(_data, 123_456);
184
+
185
+ for (uint256 _i; _i < _ids.length; _i++) {
186
+ (_found, _dataParsed) = parser.getDataFor(_ids[_i], _modifiedMetadata);
187
+ _data = abi.decode(_dataParsed, (uint256));
188
+
189
+ assertTrue(_found);
190
+ assertEq(_data, type(uint256).max - _i);
191
+ }
192
+ }
193
+
194
+ /**
195
+ * @notice Test adding `bytes` to a `bytes` metadata.
196
+ */
197
+ function test_addToMetadata_bytes() public view {
198
+ bytes4[] memory _ids = new bytes4[](2);
199
+ bytes[] memory _datas = new bytes[](2);
200
+
201
+ for (uint256 _i; _i < _ids.length; _i++) {
202
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
203
+ _datas[_i] = abi.encode(
204
+ bytes1(uint8(_i + 1)), uint32(69), bytes2(uint16(_i + 69)), bytes32(uint256(type(uint256).max))
205
+ );
206
+ }
207
+
208
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
209
+
210
+ bytes memory _modifiedMetadata = parser.addDataToMetadata(
211
+ _metadata,
212
+ bytes4(uint32(type(uint32).max)),
213
+ abi.encode(bytes32(uint256(type(uint256).max)), bytes32(hex"123456"))
214
+ );
215
+
216
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _modifiedMetadata);
217
+ (bytes32 _a, bytes32 _b) = abi.decode(_dataParsed, (bytes32, bytes32));
218
+
219
+ assertTrue(_found);
220
+ assertEq(bytes32(uint256(type(uint256).max)), _a);
221
+ assertEq(bytes32(hex"123456"), _b);
222
+
223
+ for (uint256 _i; _i < _ids.length; _i++) {
224
+ (_found, _dataParsed) = parser.getDataFor(_ids[_i], _modifiedMetadata);
225
+
226
+ (bytes1 _c, uint32 _d, bytes2 _e, bytes32 _f) = abi.decode(_dataParsed, (bytes1, uint32, bytes2, bytes32));
227
+
228
+ assertTrue(_found);
229
+ assertEq(uint8(_c), _i + 1);
230
+ assertEq(_d, uint32(69));
231
+ assertEq(uint16(_e), _i + 69);
232
+ assertEq(_f, bytes32(uint256(type(uint256).max)));
233
+ }
234
+ }
235
+
236
+ /**
237
+ * @notice Test adding `bytes` to an `uint` metadata.
238
+ */
239
+ function test_addToMetadata_mixed(uint256 _numberOfIds) external view {
240
+ _numberOfIds = bound(_numberOfIds, 1, 100);
241
+
242
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
243
+ bytes[] memory _datas = new bytes[](_numberOfIds);
244
+
245
+ for (uint256 _i; _i < _ids.length; _i++) {
246
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
247
+ _datas[_i] = abi.encode(_i * 4);
248
+ }
249
+
250
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
251
+
252
+ bytes memory _modifiedMetadata = parser.addDataToMetadata(
253
+ _metadata, bytes4(uint32(type(uint32).max)), abi.encode(uint32(69), bytes32(uint256(type(uint256).max)))
254
+ );
255
+
256
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _modifiedMetadata);
257
+ (uint32 _a, bytes32 _b) = abi.decode(_dataParsed, (uint32, bytes32));
258
+
259
+ assertTrue(_found);
260
+ assertEq(_a, uint32(69));
261
+ assertEq(_b, bytes32(uint256(type(uint256).max)));
262
+
263
+ for (uint256 _i; _i < _ids.length; _i++) {
264
+ (_found, _dataParsed) = parser.getDataFor(_ids[_i], _modifiedMetadata);
265
+ uint256 _data = abi.decode(_dataParsed, (uint256));
266
+
267
+ assertTrue(_found);
268
+ assertEq(_data, _i * 4);
269
+ }
270
+ }
271
+
272
+ /**
273
+ * @notice Test adding `bytes32` and `uint` to an empty metadata.
274
+ */
275
+ function test_addToMetadata_emptyInitialMetadata() external view {
276
+ bytes memory _metadata;
277
+
278
+ bytes memory _modifiedMetadata = parser.addDataToMetadata(
279
+ _metadata, bytes4(uint32(type(uint32).max)), abi.encode(uint32(69), bytes32(uint256(type(uint256).max)))
280
+ );
281
+
282
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _modifiedMetadata);
283
+ (uint32 _a, bytes32 _b) = abi.decode(_dataParsed, (uint32, bytes32));
284
+
285
+ assertTrue(_found);
286
+ assertEq(_a, uint32(69));
287
+ assertEq(_b, bytes32(uint256(type(uint256).max)));
288
+ }
289
+
290
+ /**
291
+ * @notice Test adding `bytes32` and `uint` to a metadata which contains something in the first bytes32
292
+ */
293
+ function test_addToMetadata_preexistingMetadata(uint256 _reserved) external view {
294
+ bytes memory _metadata = abi.encode(_reserved);
295
+
296
+ bytes memory _modifiedMetadata = parser.addDataToMetadata(
297
+ _metadata, bytes4(uint32(type(uint32).max)), abi.encode(uint32(69), bytes32(uint256(type(uint256).max)))
298
+ );
299
+
300
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _modifiedMetadata);
301
+ (uint32 _a, bytes32 _b) = abi.decode(_dataParsed, (uint32, bytes32));
302
+
303
+ assertTrue(_found);
304
+ assertEq(_a, uint32(69));
305
+ assertEq(_b, bytes32(uint256(type(uint256).max)));
306
+
307
+ assertEq(uint256(bytes32(_modifiedMetadata)), _reserved);
308
+ }
309
+
310
+ function test_addToMetadata_invalidExistingTable_reverts() public {
311
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_MetadataTooShort.selector);
312
+
313
+ // Preexisting metadata: 32B + 4B
314
+ parser.addDataToMetadata(
315
+ abi.encodePacked(bytes32(uint256(type(uint256).max)), bytes4(uint32(type(uint32).max))),
316
+ bytes4(uint32(type(uint32).max)),
317
+ bytes("12345678901234567890123456789012345678901234567890123456789012345678901234567890")
318
+ );
319
+ }
320
+
321
+ function test_addToMetadata_shortDataToAdd_reverts() public {
322
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_DataNotPadded.selector);
323
+
324
+ // Preexisting metadata: 32B + 4B
325
+ parser.addDataToMetadata(
326
+ abi.encodePacked(bytes32(uint256(type(uint256).max)), bytes8(uint64(type(uint64).max))),
327
+ bytes4(uint32(type(uint32).max)),
328
+ bytes("1234")
329
+ );
330
+ }
331
+
332
+ /**
333
+ * @notice Test behaviour if the ID is not found in the lookup table.
334
+ */
335
+ function test_idNotFound(uint256 _numberOfIds) public view {
336
+ _numberOfIds = bound(_numberOfIds, 1, 100);
337
+
338
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
339
+ bytes[] memory _datas = new bytes[](_numberOfIds);
340
+
341
+ for (uint256 _i; _i < _ids.length; _i++) {
342
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
343
+ _datas[_i] = abi.encode(_i * 4);
344
+ }
345
+
346
+ bytes memory _metadata = parser.createMetadata(_ids, _datas);
347
+
348
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _metadata);
349
+
350
+ assertFalse(_found);
351
+ assertEq(_dataParsed, "");
352
+ }
353
+
354
+ /**
355
+ * @notice Test behaviour if the metadata is empty or less than one ID long.
356
+ */
357
+ function test_emptyMetadata(uint256 _length) public view {
358
+ _length = bound(_length, 0, 37);
359
+
360
+ bytes memory _metadata;
361
+
362
+ // Fill with hex `F`.
363
+ _metadata = abi.encodePacked(bytes32(uint256(type(uint256).max)), bytes32(uint256(type(uint256).max)));
364
+
365
+ // Downsize to the length.
366
+ assembly {
367
+ mstore(_metadata, _length)
368
+ }
369
+
370
+ (bool _found, bytes memory _dataParsed) = parser.getDataFor(bytes4(uint32(type(uint32).max)), _metadata);
371
+
372
+ assertFalse(_found);
373
+ assertEq(_dataParsed, "");
374
+ }
375
+
376
+ function test_differentSizeIdAndMetadataArray_reverts(uint256 _numberOfIds, uint256 _numberOfMetadatas) public {
377
+ _numberOfIds = bound(_numberOfIds, 1, 100);
378
+ _numberOfMetadatas = bound(_numberOfMetadatas, 1, 100);
379
+
380
+ vm.assume(_numberOfIds != _numberOfMetadatas);
381
+
382
+ bytes4[] memory _ids = new bytes4[](_numberOfIds);
383
+ bytes[] memory _datas = new bytes[](_numberOfMetadatas);
384
+
385
+ for (uint256 _i; _i < _ids.length; _i++) {
386
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
387
+ }
388
+
389
+ for (uint256 _i; _i < _datas.length; _i++) {
390
+ _datas[_i] = abi.encode(_i * 4);
391
+ }
392
+
393
+ // Below should revert.
394
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_LengthMismatch.selector);
395
+ parser.createMetadata(_ids, _datas);
396
+ }
397
+
398
+ /**
399
+ * @notice Test creating and parsing metadata of incorrect length.
400
+ */
401
+ function test_create__unpadded() external {
402
+ bytes4[] memory _ids = new bytes4[](1);
403
+ bytes[] memory _datas = new bytes[](1);
404
+
405
+ uint8 something = uint8(1);
406
+ bytes memory shortData = abi.encodePacked(something);
407
+
408
+ _ids[0] = bytes4(uint32(1));
409
+ _datas[0] = shortData;
410
+
411
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_DataNotPadded.selector);
412
+ parser.createMetadata(_ids, _datas);
413
+ }
414
+
415
+ /**
416
+ * @notice Test creating and parsing bytes only metadata.
417
+ */
418
+ function test_create_incorrect_data_length() external {
419
+ bytes4[] memory _ids = new bytes4[](10);
420
+ bytes[] memory _datas = new bytes[](10);
421
+
422
+ for (uint256 _i; _i < _ids.length; _i++) {
423
+ _ids[_i] = bytes4(uint32(_i + 1 * 1000));
424
+
425
+ _datas[_i] = abi.encodePacked(
426
+ bytes1(uint8(_i + 1)), uint32(69), bytes2(uint16(_i + 69)), bytes32(uint256(type(uint256).max))
427
+ );
428
+ }
429
+
430
+ // Ensure data length is not multiple of word size and is gt word size.
431
+ assertGt(_datas[0].length, 32);
432
+ assertGt(_datas[0].length % 32, 0);
433
+
434
+ // New revert to help integrators.
435
+ vm.expectRevert(JBMetadataResolver.JBMetadataResolver_DataNotPadded.selector);
436
+ parser.createMetadata(_ids, _datas);
437
+ }
438
+ }
@@ -0,0 +1,249 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ /// @notice Confirms M-16: held fees are stranded when a terminal migrates.
7
+ /// The migration calls addToBalanceOf with shouldReturnHeldFees: false,
8
+ /// leaving held fees in the old terminal with no balance to process them.
9
+ contract TestMigrationHeldFees_Local is TestBaseWorkflow {
10
+ IJBController private _controller;
11
+ JBMultiTerminal private _terminal;
12
+ JBMultiTerminal private _terminal2;
13
+ JBTokens private _tokens;
14
+ JBTerminalStore private _store;
15
+ uint256 private _projectId;
16
+ address private _projectOwner;
17
+
18
+ uint112 private constant WEIGHT = 1000 * 10 ** 18;
19
+ uint112 private constant PAY_AMOUNT = 10 ether;
20
+
21
+ function setUp() public override {
22
+ super.setUp();
23
+
24
+ _projectOwner = multisig();
25
+ _controller = jbController();
26
+ _terminal = jbMultiTerminal();
27
+ _terminal2 = jbMultiTerminal2();
28
+ _tokens = jbTokens();
29
+ _store = jbTerminalStore();
30
+
31
+ // Ruleset with holdFees=true and allowTerminalMigration=true.
32
+ JBRulesetMetadata memory metadata = JBRulesetMetadata({
33
+ reservedPercent: 0,
34
+ cashOutTaxRate: 0,
35
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
36
+ pausePay: false,
37
+ pauseCreditTransfers: false,
38
+ allowOwnerMinting: false,
39
+ allowSetCustomToken: false,
40
+ allowTerminalMigration: true,
41
+ allowSetTerminals: true,
42
+ ownerMustSendPayouts: false,
43
+ allowSetController: false,
44
+ allowAddAccountingContext: true,
45
+ allowAddPriceFeed: false,
46
+ holdFees: true, // Fees are held, not processed immediately.
47
+ useTotalSurplusForCashOuts: false,
48
+ useDataHookForPay: false,
49
+ useDataHookForCashOut: false,
50
+ dataHook: address(0),
51
+ metadata: 0
52
+ });
53
+
54
+ JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
55
+ rulesetConfig[0].mustStartAtOrAfter = 0;
56
+ rulesetConfig[0].duration = 0;
57
+ rulesetConfig[0].weight = WEIGHT;
58
+ rulesetConfig[0].weightCutPercent = 0;
59
+ rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
60
+ rulesetConfig[0].metadata = metadata;
61
+ rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
62
+
63
+ // Set up payout limit so fees are taken on payouts.
64
+ JBCurrencyAmount[] memory payoutLimits = new JBCurrencyAmount[](1);
65
+ payoutLimits[0] =
66
+ JBCurrencyAmount({amount: uint224(PAY_AMOUNT), currency: uint32(uint160(JBConstants.NATIVE_TOKEN))});
67
+ JBFundAccessLimitGroup[] memory limitGroups = new JBFundAccessLimitGroup[](1);
68
+ limitGroups[0] = JBFundAccessLimitGroup({
69
+ terminal: address(_terminal),
70
+ token: JBConstants.NATIVE_TOKEN,
71
+ payoutLimits: payoutLimits,
72
+ surplusAllowances: new JBCurrencyAmount[](0)
73
+ });
74
+ rulesetConfig[0].fundAccessLimitGroups = limitGroups;
75
+
76
+ // Terminal configs — both terminals accept native token.
77
+ JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
78
+ tokensToAccept[0] = JBAccountingContext({
79
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
80
+ });
81
+
82
+ JBTerminalConfig[] memory terminalConfigs = new JBTerminalConfig[](2);
83
+ terminalConfigs[0] =
84
+ JBTerminalConfig({terminal: IJBTerminal(address(_terminal)), accountingContextsToAccept: tokensToAccept});
85
+ terminalConfigs[1] =
86
+ JBTerminalConfig({terminal: IJBTerminal(address(_terminal2)), accountingContextsToAccept: tokensToAccept});
87
+
88
+ // Fee project (#1).
89
+ JBTerminalConfig[] memory feeTerminalConfigs = new JBTerminalConfig[](1);
90
+ feeTerminalConfigs[0] =
91
+ JBTerminalConfig({terminal: IJBTerminal(address(_terminal)), accountingContextsToAccept: tokensToAccept});
92
+
93
+ JBRulesetConfig[] memory feeRulesetConfig = new JBRulesetConfig[](1);
94
+ feeRulesetConfig[0].mustStartAtOrAfter = 0;
95
+ feeRulesetConfig[0].duration = 0;
96
+ feeRulesetConfig[0].weight = WEIGHT;
97
+ feeRulesetConfig[0].metadata = metadata;
98
+ feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
99
+ feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
100
+
101
+ _controller.launchProjectFor({
102
+ owner: address(420),
103
+ projectUri: "fee",
104
+ rulesetConfigurations: feeRulesetConfig,
105
+ terminalConfigurations: feeTerminalConfigs,
106
+ memo: ""
107
+ });
108
+
109
+ // Test project (#2).
110
+ _projectId = _controller.launchProjectFor({
111
+ owner: _projectOwner,
112
+ projectUri: "test",
113
+ rulesetConfigurations: rulesetConfig,
114
+ terminalConfigurations: terminalConfigs,
115
+ memo: ""
116
+ });
117
+ }
118
+
119
+ /// @notice M-16 CONFIRMED: Pay → distribute payouts (holds fees) → migrate → fees stranded.
120
+ function test_migration_heldFeesStranded() external {
121
+ // Step 1: Pay the project.
122
+ _terminal.pay{value: PAY_AMOUNT}({
123
+ projectId: _projectId,
124
+ amount: PAY_AMOUNT,
125
+ token: JBConstants.NATIVE_TOKEN,
126
+ beneficiary: _projectOwner,
127
+ minReturnedTokens: 0,
128
+ memo: "",
129
+ metadata: new bytes(0)
130
+ });
131
+
132
+ // Step 2: Distribute payouts — fees will be held (holdFees=true).
133
+ vm.prank(_projectOwner);
134
+ _terminal.sendPayoutsOf({
135
+ projectId: _projectId,
136
+ token: JBConstants.NATIVE_TOKEN,
137
+ amount: PAY_AMOUNT,
138
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
139
+ minTokensPaidOut: 0
140
+ });
141
+
142
+ // Verify held fees exist.
143
+ JBFee[] memory heldFees = _terminal.heldFeesOf(_projectId, JBConstants.NATIVE_TOKEN, 100);
144
+ assertGt(heldFees.length, 0, "Should have held fees after payout");
145
+
146
+ // Step 3: Migrate balance to terminal2.
147
+ uint256 balanceBefore = _store.balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN);
148
+
149
+ vm.prank(_projectOwner);
150
+ uint256 migrated =
151
+ _terminal.migrateBalanceOf(_projectId, JBConstants.NATIVE_TOKEN, IJBTerminal(address(_terminal2)));
152
+
153
+ // Step 4: Verify old terminal has no balance but still has held fees.
154
+ uint256 balanceAfter = _store.balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN);
155
+ assertEq(balanceAfter, 0, "Old terminal should have 0 balance after migration");
156
+
157
+ // Held fees still exist in old terminal.
158
+ JBFee[] memory feesAfterMigration = _terminal.heldFeesOf(_projectId, JBConstants.NATIVE_TOKEN, 100);
159
+ assertEq(feesAfterMigration.length, heldFees.length, "M-16: Held fees remain in old terminal");
160
+ }
161
+
162
+ /// @notice Process held fees FIRST, then migrate — correct approach.
163
+ function test_migration_feeProcessingBeforeMigration() external {
164
+ // Pay.
165
+ _terminal.pay{value: PAY_AMOUNT}({
166
+ projectId: _projectId,
167
+ amount: PAY_AMOUNT,
168
+ token: JBConstants.NATIVE_TOKEN,
169
+ beneficiary: _projectOwner,
170
+ minReturnedTokens: 0,
171
+ memo: "",
172
+ metadata: new bytes(0)
173
+ });
174
+
175
+ // Distribute payouts (holds fees).
176
+ vm.prank(_projectOwner);
177
+ _terminal.sendPayoutsOf({
178
+ projectId: _projectId,
179
+ token: JBConstants.NATIVE_TOKEN,
180
+ amount: PAY_AMOUNT,
181
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
182
+ minTokensPaidOut: 0
183
+ });
184
+
185
+ // Fast-forward past fee holding period (28 days).
186
+ vm.warp(block.timestamp + 28 days + 1);
187
+
188
+ // Process held fees before migration.
189
+ uint256 feeProjectBalanceBefore = _store.balanceOf(address(_terminal), 1, JBConstants.NATIVE_TOKEN);
190
+ _terminal.processHeldFeesOf(_projectId, JBConstants.NATIVE_TOKEN, 100);
191
+ uint256 feeProjectBalanceAfter = _store.balanceOf(address(_terminal), 1, JBConstants.NATIVE_TOKEN);
192
+
193
+ // Fee project should have received fees.
194
+ assertGt(feeProjectBalanceAfter, feeProjectBalanceBefore, "Fee project should receive fees");
195
+
196
+ // Now held fees should be cleared.
197
+ JBFee[] memory feesAfter = _terminal.heldFeesOf(_projectId, JBConstants.NATIVE_TOKEN, 100);
198
+ assertEq(feesAfter.length, 0, "Held fees should be cleared after processing");
199
+
200
+ // Now migrate safely.
201
+ vm.prank(_projectOwner);
202
+ _terminal.migrateBalanceOf(_projectId, JBConstants.NATIVE_TOKEN, IJBTerminal(address(_terminal2)));
203
+ }
204
+
205
+ /// @notice After migration, processHeldFeesOf on old terminal processes nothing (no balance).
206
+ function test_migration_heldFeesUnclaimable() external {
207
+ // Pay and distribute.
208
+ _terminal.pay{value: PAY_AMOUNT}({
209
+ projectId: _projectId,
210
+ amount: PAY_AMOUNT,
211
+ token: JBConstants.NATIVE_TOKEN,
212
+ beneficiary: _projectOwner,
213
+ minReturnedTokens: 0,
214
+ memo: "",
215
+ metadata: new bytes(0)
216
+ });
217
+
218
+ vm.prank(_projectOwner);
219
+ _terminal.sendPayoutsOf({
220
+ projectId: _projectId,
221
+ token: JBConstants.NATIVE_TOKEN,
222
+ amount: PAY_AMOUNT,
223
+ currency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
224
+ minTokensPaidOut: 0
225
+ });
226
+
227
+ // Migrate.
228
+ vm.prank(_projectOwner);
229
+ _terminal.migrateBalanceOf(_projectId, JBConstants.NATIVE_TOKEN, IJBTerminal(address(_terminal2)));
230
+
231
+ // Warp past holding period.
232
+ vm.warp(block.timestamp + 28 days + 1);
233
+
234
+ // Fee project balance before attempting to process.
235
+ uint256 feeBalanceBefore = _store.balanceOf(address(_terminal), 1, JBConstants.NATIVE_TOKEN);
236
+
237
+ // Try to process held fees — the fees still exist but the old terminal has no ETH.
238
+ // The _processFee try-catch will catch the revert and credit the fee amount back to the project.
239
+ _terminal.processHeldFeesOf(_projectId, JBConstants.NATIVE_TOKEN, 100);
240
+
241
+ // Fee project should NOT have received fees (old terminal had no ETH to transfer).
242
+ uint256 feeBalanceAfter = _store.balanceOf(address(_terminal), 1, JBConstants.NATIVE_TOKEN);
243
+
244
+ // The fee processing attempted but the terminal has no actual ETH.
245
+ // The _recordAddedBalanceFor in the catch block inflates the store balance
246
+ // without actual funds — this is a phantom balance.
247
+ // This documents the M-16 issue: either fees are lost OR phantom balances are created.
248
+ }
249
+ }