@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,180 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ // Project can issue token, receive payments in exchange for tokens, burn some of the claimed tokens, and allow holders
7
+ // to cash out the rest of tokens.
8
+ contract TestPayBurnCashOutFlow_Local is TestBaseWorkflow {
9
+ IJBController private _controller;
10
+ IJBMultiTerminal private _terminal;
11
+ JBTokens private _tokens;
12
+ uint112 private _weight;
13
+ JBRulesetMetadata _metadata;
14
+ uint256 private _projectId;
15
+ address private _projectOwner;
16
+ address private _beneficiary;
17
+
18
+ function setUp() public override {
19
+ super.setUp();
20
+
21
+ _projectOwner = multisig();
22
+ _beneficiary = beneficiary();
23
+ _controller = jbController();
24
+ _terminal = jbMultiTerminal();
25
+ _tokens = jbTokens();
26
+ _weight = 1000 * 10 ** 18;
27
+ _metadata = JBRulesetMetadata({
28
+ reservedPercent: 0,
29
+ cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
30
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
31
+ pausePay: false,
32
+ pauseCreditTransfers: false,
33
+ allowOwnerMinting: false,
34
+ allowSetCustomToken: true,
35
+ allowTerminalMigration: false,
36
+ allowSetTerminals: false,
37
+ ownerMustSendPayouts: false,
38
+ allowSetController: false,
39
+ allowAddAccountingContext: true,
40
+ allowAddPriceFeed: false,
41
+ holdFees: false,
42
+ useTotalSurplusForCashOuts: false,
43
+ useDataHookForPay: false,
44
+ useDataHookForCashOut: false,
45
+ dataHook: address(0),
46
+ metadata: 0
47
+ });
48
+
49
+ IJBTerminal[] memory _terminals = new IJBTerminal[](1);
50
+ _terminals[0] = (_terminal);
51
+
52
+ // Package up ruleset configuration.
53
+ JBRulesetConfig[] memory _rulesetConfig = new JBRulesetConfig[](1);
54
+ _rulesetConfig[0].mustStartAtOrAfter = 0;
55
+ _rulesetConfig[0].duration = 0;
56
+ _rulesetConfig[0].weight = _weight;
57
+ _rulesetConfig[0].weightCutPercent = 0;
58
+ _rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
59
+ _rulesetConfig[0].metadata = _metadata;
60
+ _rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
61
+ _rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
62
+
63
+ // Package up terminal configuration.
64
+ JBTerminalConfig[] memory _terminalConfigurations = new JBTerminalConfig[](1);
65
+ JBAccountingContext[] memory _tokensToAccept = new JBAccountingContext[](1);
66
+ _tokensToAccept[0] = JBAccountingContext({
67
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
68
+ });
69
+ _terminalConfigurations[0] =
70
+ JBTerminalConfig({terminal: _terminal, accountingContextsToAccept: _tokensToAccept});
71
+
72
+ // Dummy project that will receive fees.
73
+ _controller.launchProjectFor({
74
+ owner: _projectOwner,
75
+ projectUri: "myIPFSHash",
76
+ rulesetConfigurations: _rulesetConfig,
77
+ terminalConfigurations: _terminalConfigurations,
78
+ memo: ""
79
+ });
80
+
81
+ _projectId = _controller.launchProjectFor({
82
+ owner: _projectOwner,
83
+ projectUri: "myIPFSHash",
84
+ rulesetConfigurations: _rulesetConfig,
85
+ terminalConfigurations: _terminalConfigurations,
86
+ memo: ""
87
+ });
88
+ }
89
+
90
+ function testFuzzPayBurnCashOutFlow(
91
+ uint112 _nativePayAmount,
92
+ uint256 _burnTokenAmount,
93
+ uint256 _cashOutAmount
94
+ )
95
+ external
96
+ {
97
+ // Issue an ERC-20 token for project.
98
+ vm.prank(_projectOwner);
99
+ _controller.deployERC20For(_projectId, "TestName", "TestSymbol", bytes32(0));
100
+
101
+ address someRandomUser = vm.addr(1);
102
+ vm.prank(someRandomUser);
103
+ vm.deal(someRandomUser, _nativePayAmount);
104
+ // Make a payment.
105
+ _terminal.pay{value: _nativePayAmount}({
106
+ projectId: _projectId,
107
+ amount: _nativePayAmount,
108
+ token: JBConstants.NATIVE_TOKEN, // Unused.
109
+ beneficiary: _beneficiary,
110
+ minReturnedTokens: 0,
111
+ memo: "Take my money!",
112
+ metadata: new bytes(0)
113
+ });
114
+
115
+ // Make sure the beneficiary has a balance of project tokens.
116
+ uint256 _beneficiaryTokenBalance =
117
+ UD60x18unwrap(UD60x18mul(UD60x18wrap(_nativePayAmount), UD60x18wrap(_weight)));
118
+ assertEq(_tokens.totalBalanceOf(_beneficiary, _projectId), _beneficiaryTokenBalance);
119
+
120
+ // Make sure the native token balance in terminal is up to date.
121
+ uint256 _terminalBalance = _nativePayAmount;
122
+ assertEq(
123
+ jbTerminalStore().balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN), _terminalBalance
124
+ );
125
+
126
+ // Burn tokens from beneficiary.
127
+ if (_burnTokenAmount == 0) {
128
+ vm.expectRevert(JBController.JBController_ZeroTokensToBurn.selector);
129
+ } else if (_burnTokenAmount > _beneficiaryTokenBalance) {
130
+ vm.expectRevert(
131
+ abi.encodeWithSelector(
132
+ JBTokens.JBTokens_InsufficientTokensToBurn.selector, _burnTokenAmount, _beneficiaryTokenBalance
133
+ )
134
+ );
135
+ } else {
136
+ _beneficiaryTokenBalance -= _burnTokenAmount;
137
+ }
138
+
139
+ vm.prank(_beneficiary);
140
+ _controller.burnTokensOf({
141
+ holder: _beneficiary, projectId: _projectId, tokenCount: _burnTokenAmount, memo: "I hate tokens!"
142
+ });
143
+
144
+ // Make sure the beneficiary should has a new balance of project tokens.
145
+ assertEq(_tokens.totalBalanceOf(_beneficiary, _projectId), _beneficiaryTokenBalance);
146
+
147
+ // Cash out tokens.
148
+ if (_cashOutAmount > _beneficiaryTokenBalance) {
149
+ vm.expectRevert(
150
+ abi.encodeWithSelector(
151
+ JBTerminalStore.JBTerminalStore_InsufficientTokens.selector,
152
+ _cashOutAmount,
153
+ _beneficiaryTokenBalance
154
+ )
155
+ );
156
+ } else {
157
+ _beneficiaryTokenBalance -= _cashOutAmount;
158
+ }
159
+
160
+ vm.prank(_beneficiary);
161
+ uint256 _reclaimAmt = _terminal.cashOutTokensOf({
162
+ holder: _beneficiary,
163
+ projectId: _projectId,
164
+ cashOutCount: _cashOutAmount,
165
+ tokenToReclaim: JBConstants.NATIVE_TOKEN, // Unused.
166
+ minTokensReclaimed: 0,
167
+ beneficiary: payable(_beneficiary),
168
+ metadata: new bytes(0)
169
+ });
170
+
171
+ // Make sure the beneficiary has a new balance of project tokens.
172
+ assertEq(_tokens.totalBalanceOf(_beneficiary, _projectId), _beneficiaryTokenBalance);
173
+
174
+ // Make sure the native token balance in terminal is up to date.
175
+ assertEq(
176
+ jbTerminalStore().balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN),
177
+ _terminalBalance - _reclaimAmt
178
+ );
179
+ }
180
+ }
@@ -0,0 +1,190 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity >=0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ contract TestPayHooks_Local is TestBaseWorkflow {
7
+ uint8 private constant _WEIGHT_DECIMALS = 18;
8
+ uint8 private constant _NATIVE_TOKEN_DECIMALS = 18;
9
+ uint112 private constant _WEIGHT = uint112(1000 * 10 ** _WEIGHT_DECIMALS);
10
+ uint256 private constant _DATA_HOOK_WEIGHT = 2000 * 10 ** _WEIGHT_DECIMALS;
11
+ address private constant _DATA_HOOK = address(bytes20(keccak256("datahook")));
12
+ bytes private constant _PAYER_METADATA = bytes("Some payer metadata");
13
+
14
+ IJBController private _controller;
15
+ IJBTerminal private _terminal;
16
+ address private _projectOwner;
17
+ address private _beneficiary;
18
+ address private _payer;
19
+
20
+ uint64 _projectId;
21
+
22
+ function setUp() public override {
23
+ super.setUp();
24
+
25
+ _controller = jbController();
26
+ _projectOwner = multisig();
27
+ _beneficiary = beneficiary();
28
+ _payer = address(1_234_567);
29
+ _terminal = jbMultiTerminal();
30
+
31
+ JBRulesetMetadata memory _metadata = JBRulesetMetadata({
32
+ reservedPercent: 0,
33
+ cashOutTaxRate: 0,
34
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
35
+ pausePay: false,
36
+ pauseCreditTransfers: false,
37
+ allowOwnerMinting: false,
38
+ allowSetCustomToken: false,
39
+ allowTerminalMigration: false,
40
+ allowSetTerminals: false,
41
+ ownerMustSendPayouts: false,
42
+ allowSetController: false,
43
+ allowAddAccountingContext: true,
44
+ allowAddPriceFeed: false,
45
+ holdFees: false,
46
+ useTotalSurplusForCashOuts: false,
47
+ useDataHookForPay: true,
48
+ useDataHookForCashOut: true,
49
+ dataHook: _DATA_HOOK,
50
+ metadata: 0
51
+ });
52
+
53
+ // Package up ruleset configuration.
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
+ _rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
63
+
64
+ JBTerminalConfig[] memory _terminalConfigurations = new JBTerminalConfig[](1);
65
+ JBAccountingContext[] memory _tokensToAccept = new JBAccountingContext[](1);
66
+ _tokensToAccept[0] = JBAccountingContext({
67
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
68
+ });
69
+ _terminalConfigurations[0] =
70
+ JBTerminalConfig({terminal: _terminal, accountingContextsToAccept: _tokensToAccept});
71
+
72
+ _projectId = uint64(
73
+ _controller.launchProjectFor({
74
+ owner: _projectOwner,
75
+ projectUri: "myIPFSHash",
76
+ rulesetConfigurations: _rulesetConfig,
77
+ terminalConfigurations: _terminalConfigurations,
78
+ memo: ""
79
+ })
80
+ );
81
+ }
82
+
83
+ function testPayHooks(uint256 _numberOfSpecifications, uint256 _nativePayAmount) public {
84
+ // Bound the number of specifications to a reasonable amount.
85
+ _numberOfSpecifications = bound(_numberOfSpecifications, 1, 20);
86
+ // Make sure the amount of tokens generated fits in a register, and that each specification can get some.
87
+ _nativePayAmount = bound(_nativePayAmount, _numberOfSpecifications, type(uint256).max / _DATA_HOOK_WEIGHT);
88
+
89
+ // epa * weight / epad < max*epad/weight
90
+
91
+ // Keep a reference to the specifications.
92
+ JBPayHookSpecification[] memory _specifications = new JBPayHookSpecification[](_numberOfSpecifications);
93
+
94
+ // Keep a reference to the amounts in the specifications.
95
+ uint256[] memory _payHookAmounts = new uint256[](_numberOfSpecifications);
96
+
97
+ // Keep a reference to the amount that'll be paid and sent to pay hooks.
98
+ uint256 _totalToAllocate = _nativePayAmount;
99
+
100
+ // Spread the paid amount through all specifications, in various chunks, omitting the last entry.
101
+ for (uint256 i; i < _numberOfSpecifications - 1; i++) {
102
+ _payHookAmounts[i] = _totalToAllocate / (_payHookAmounts.length * 2);
103
+ _totalToAllocate -= _payHookAmounts[i];
104
+ }
105
+
106
+ // Send the rest to the last entry.
107
+ _payHookAmounts[_payHookAmounts.length - 1] = _totalToAllocate;
108
+
109
+ // Keep a reference to the current ruleset.
110
+ (JBRuleset memory _ruleset,) = _controller.currentRulesetOf(_projectId);
111
+
112
+ // Iterate through each specification.
113
+ for (uint256 i = 0; i < _numberOfSpecifications; i++) {
114
+ // Make up an address for the hook.
115
+ address _hookAddress = address(bytes20(keccak256(abi.encodePacked("PayHook", i))));
116
+
117
+ // Send along some metadata to the pay hook.
118
+ bytes memory _hookMetadata = bytes("Some data hook metadata");
119
+
120
+ // Package up the specification struct.
121
+ _specifications[i] = JBPayHookSpecification(IJBPayHook(_hookAddress), _payHookAmounts[i], _hookMetadata);
122
+
123
+ // Keep a reference to the data that'll be received by the hook.
124
+ JBAfterPayRecordedContext memory _postRecordPayContext = JBAfterPayRecordedContext({
125
+ payer: _payer,
126
+ projectId: _projectId,
127
+ rulesetId: _ruleset.id,
128
+ amount: JBTokenAmount(
129
+ JBConstants.NATIVE_TOKEN,
130
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
131
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
132
+ _nativePayAmount
133
+ ),
134
+ forwardedAmount: JBTokenAmount(
135
+ JBConstants.NATIVE_TOKEN,
136
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
137
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
138
+ _payHookAmounts[i]
139
+ ),
140
+ weight: _WEIGHT,
141
+ newlyIssuedTokenCount: mulDiv(_nativePayAmount, _DATA_HOOK_WEIGHT, 10 ** _NATIVE_TOKEN_DECIMALS),
142
+ beneficiary: _beneficiary,
143
+ hookMetadata: _hookMetadata,
144
+ payerMetadata: _PAYER_METADATA
145
+ });
146
+
147
+ // Mock the hook.
148
+ vm.mockCall(
149
+ _hookAddress,
150
+ abi.encodeWithSelector(IJBPayHook.afterPayRecordedWith.selector),
151
+ abi.encode(_postRecordPayContext)
152
+ );
153
+
154
+ // Assert that the hook gets called with the expected value.
155
+ vm.expectCall(
156
+ _hookAddress,
157
+ _payHookAmounts[i],
158
+ abi.encodeWithSelector(IJBPayHook.afterPayRecordedWith.selector, _postRecordPayContext)
159
+ );
160
+
161
+ // Expect an event to be emitted for every hook.
162
+ vm.expectEmit(true, true, true, true);
163
+ emit HookAfterRecordPay(IJBPayHook(_hookAddress), _postRecordPayContext, _payHookAmounts[i], _payer);
164
+ }
165
+
166
+ vm.mockCall(
167
+ _DATA_HOOK,
168
+ abi.encodeWithSelector(IJBRulesetDataHook.beforePayRecordedWith.selector),
169
+ abi.encode(_DATA_HOOK_WEIGHT, _specifications)
170
+ );
171
+
172
+ vm.deal(_payer, _nativePayAmount);
173
+ vm.prank(_payer);
174
+
175
+ // Pay the project such that the `_beneficiary` receives project tokens.
176
+ _terminal.pay{value: _nativePayAmount}({
177
+ projectId: _projectId,
178
+ amount: _nativePayAmount,
179
+ token: JBConstants.NATIVE_TOKEN,
180
+ beneficiary: _beneficiary,
181
+ minReturnedTokens: 0,
182
+ memo: "Forge Test",
183
+ metadata: _PAYER_METADATA
184
+ });
185
+ }
186
+
187
+ event HookAfterRecordPay(
188
+ IJBPayHook indexed hook, JBAfterPayRecordedContext context, uint256 specificationAmount, address caller
189
+ );
190
+ }
@@ -0,0 +1,305 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ contract TestPermissions_Local is TestBaseWorkflow, JBTest {
7
+ IJBController private _controller;
8
+ JBRulesetMetadata private _metadata;
9
+ IJBTerminal private _terminal;
10
+ IJBPermissions private _permissions;
11
+
12
+ address private _projectOwner;
13
+ uint64 private _projectZero;
14
+ uint64 private _projectOne;
15
+
16
+ function setUp() public override {
17
+ super.setUp();
18
+
19
+ _projectOwner = multisig();
20
+ _terminal = jbMultiTerminal();
21
+ _controller = jbController();
22
+ _permissions = jbPermissions();
23
+
24
+ _metadata = JBRulesetMetadata({
25
+ reservedPercent: 0,
26
+ cashOutTaxRate: 0,
27
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
28
+ pausePay: false,
29
+ pauseCreditTransfers: false,
30
+ allowOwnerMinting: false,
31
+ allowSetCustomToken: true,
32
+ allowTerminalMigration: false,
33
+ allowSetTerminals: false,
34
+ ownerMustSendPayouts: false,
35
+ allowSetController: false,
36
+ allowAddAccountingContext: true,
37
+ allowAddPriceFeed: false,
38
+ holdFees: false,
39
+ useTotalSurplusForCashOuts: false,
40
+ useDataHookForPay: false,
41
+ useDataHookForCashOut: false,
42
+ dataHook: address(0),
43
+ metadata: 0
44
+ });
45
+
46
+ // Package up ruleset configuration.
47
+ JBRulesetConfig[] memory _rulesetConfig = new JBRulesetConfig[](1);
48
+ _rulesetConfig[0].mustStartAtOrAfter = 0;
49
+ _rulesetConfig[0].duration = 0;
50
+ _rulesetConfig[0].weight = 0;
51
+ _rulesetConfig[0].weightCutPercent = 0;
52
+ _rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
53
+ _rulesetConfig[0].metadata = _metadata;
54
+ _rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
55
+ _rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
56
+
57
+ // Package up terminal configuration.
58
+ JBTerminalConfig[] memory _terminalConfigurations = new JBTerminalConfig[](1);
59
+ JBAccountingContext[] memory _tokensToAccept = new JBAccountingContext[](1);
60
+ _tokensToAccept[0] = JBAccountingContext({
61
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
62
+ });
63
+ _terminalConfigurations[0] =
64
+ JBTerminalConfig({terminal: _terminal, accountingContextsToAccept: _tokensToAccept});
65
+
66
+ _projectZero = uint64(
67
+ _controller.launchProjectFor({
68
+ owner: makeAddr("zeroOwner"),
69
+ projectUri: "myIPFSHash",
70
+ rulesetConfigurations: _rulesetConfig,
71
+ terminalConfigurations: _terminalConfigurations,
72
+ memo: ""
73
+ })
74
+ );
75
+
76
+ _projectOne = uint64(
77
+ _controller.launchProjectFor({
78
+ owner: _projectOwner,
79
+ projectUri: "myIPFSHash",
80
+ rulesetConfigurations: _rulesetConfig,
81
+ terminalConfigurations: _terminalConfigurations,
82
+ memo: ""
83
+ })
84
+ );
85
+ }
86
+
87
+ function test_RevertIf_MostBasicAccess() public {
88
+ // Package up ruleset configuration.
89
+ JBRulesetConfig[] memory _rulesetConfig = new JBRulesetConfig[](1);
90
+ _rulesetConfig[0].mustStartAtOrAfter = 0;
91
+ _rulesetConfig[0].duration = 0;
92
+ _rulesetConfig[0].weight = 0;
93
+ _rulesetConfig[0].weightCutPercent = 0;
94
+ _rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
95
+ _rulesetConfig[0].metadata = _metadata;
96
+ _rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
97
+ _rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
98
+
99
+ vm.prank(makeAddr("zeroOwner"));
100
+ vm.expectRevert(
101
+ abi.encodeWithSelector(
102
+ JBPermissioned.JBPermissioned_Unauthorized.selector,
103
+ _projectOwner,
104
+ makeAddr("zeroOwner"),
105
+ _projectOne,
106
+ JBPermissionIds.QUEUE_RULESETS
107
+ )
108
+ );
109
+ uint256 queued = _controller.queueRulesetsOf(_projectOne, _rulesetConfig, "");
110
+
111
+ assertNotEq(queued, block.timestamp);
112
+ }
113
+
114
+ function test_RevertIf_SetOperators() public {
115
+ // Pack up our permission data.
116
+ JBPermissionsData[] memory permData = new JBPermissionsData[](1);
117
+
118
+ uint8[] memory permIds = new uint8[](256);
119
+
120
+ // Push an index higher than 255.
121
+ for (uint8 i; i < 255; i++) {
122
+ permIds[i] = i;
123
+
124
+ permData[0] = JBPermissionsData({operator: address(0), projectId: _projectOne, permissionIds: permIds});
125
+
126
+ // Set em.
127
+ vm.prank(_projectOwner);
128
+ vm.expectRevert(JBPermissions.JBPermissions_NoZeroPermission.selector);
129
+ _permissions.setPermissionsFor(_projectOwner, permData[0]);
130
+ }
131
+ }
132
+
133
+ function testHasPermissions(
134
+ address _account,
135
+ address _op,
136
+ uint56 _projectId,
137
+ uint8 _checkedId,
138
+ uint8[] memory _set_permissions
139
+ )
140
+ public
141
+ {
142
+ vm.assume(_projectId != 0);
143
+ vm.assume(_set_permissions.length != 0);
144
+ vm.assume(_account != trustedForwarder());
145
+
146
+ uint256[] memory _check_permissions = new uint256[](1);
147
+ _check_permissions[0] = _checkedId;
148
+
149
+ bool hasPerm;
150
+ bool hasZero;
151
+ for (uint256 i; i < _set_permissions.length; i++) {
152
+ // Flag if index is zero, meaning set call should revert later.
153
+ if (_set_permissions[i] == 0) hasZero = true;
154
+
155
+ // Flag if hasPermissions check will be true if the array contains it or has root ID.
156
+ if (_set_permissions[i] == _checkedId) hasPerm = true;
157
+ }
158
+
159
+ // If setting with a zero permission id, will revert.
160
+ if (hasZero) vm.expectRevert(JBPermissions.JBPermissions_NoZeroPermission.selector);
161
+
162
+ // Set the permissions.
163
+ vm.prank(_account);
164
+ _permissions.setPermissionsFor(
165
+ _account, JBPermissionsData({operator: _op, projectId: _projectId, permissionIds: _set_permissions})
166
+ );
167
+
168
+ // Check permissions if the call didn't revert.
169
+ if (!hasZero) {
170
+ // Call has permissions and assert.
171
+ assertEq(_permissions.hasPermissions(_op, _account, _projectId, _check_permissions, false, false), hasPerm);
172
+ }
173
+ }
174
+
175
+ function testBasicAccessSetup() public {
176
+ address zeroOwner = makeAddr("zeroOwner");
177
+ address token = address(usdcToken());
178
+
179
+ // Pack up our permission data.
180
+ JBPermissionsData[] memory permData = new JBPermissionsData[](1);
181
+ uint8[] memory permIds = new uint8[](1);
182
+ permIds[0] = 1;
183
+
184
+ permData[0] = JBPermissionsData({operator: address(this), projectId: _projectZero, permissionIds: permIds});
185
+
186
+ // Set em.
187
+ vm.prank(zeroOwner);
188
+ _permissions.setPermissionsFor(zeroOwner, permData[0]);
189
+
190
+ // Should be true given root check
191
+ bool _check = _permissions.hasPermission(address(this), zeroOwner, _projectZero, 2, true, true);
192
+ assertEq(_check, true);
193
+
194
+ // Will revert attempting to set another projects token
195
+ vm.expectRevert(
196
+ abi.encodeWithSelector(
197
+ JBPermissioned.JBPermissioned_Unauthorized.selector,
198
+ _projectOwner,
199
+ address(this),
200
+ 2,
201
+ JBPermissionIds.SET_TOKEN
202
+ )
203
+ );
204
+ _controller.setTokenFor(2, IJBToken(token));
205
+
206
+ // Will succeed when setting the correct projects token
207
+ mockExpect(token, abi.encodeCall(MockERC20.decimals, ()), abi.encode(18));
208
+ mockExpect(token, abi.encodeCall(IJBToken.canBeAddedTo, (1)), abi.encode(true));
209
+ _controller.setTokenFor(1, IJBToken(token));
210
+ }
211
+
212
+ function testCannotForwardRoot() public {
213
+ address zeroOwner = makeAddr("zeroOwner");
214
+
215
+ // Pack up our permission data.
216
+ JBPermissionsData[] memory permData = new JBPermissionsData[](1);
217
+ uint8[] memory permIds = new uint8[](1);
218
+ permIds[0] = 1;
219
+
220
+ permData[0] = JBPermissionsData({operator: address(this), projectId: _projectZero, permissionIds: permIds});
221
+
222
+ // Set em.
223
+ vm.prank(zeroOwner);
224
+ _permissions.setPermissionsFor(zeroOwner, permData[0]);
225
+
226
+ // Should be true given root check
227
+ bool _check = _permissions.hasPermission(address(this), zeroOwner, _projectZero, 2, true, true);
228
+ assertEq(_check, true);
229
+
230
+ // Pack up our non-root permission data.
231
+ JBPermissionsData[] memory permData2 = new JBPermissionsData[](1);
232
+ uint8[] memory permIds2 = new uint8[](1);
233
+ permIds2[0] = 2;
234
+
235
+ permData2[0] = JBPermissionsData({operator: address(0), projectId: _projectZero, permissionIds: permIds2});
236
+
237
+ // Should be able to forward other permissions
238
+ // Note that this contract is now authorized to do so above- address(this)
239
+
240
+ // in emit
241
+ uint256 packed;
242
+
243
+ vm.expectEmit();
244
+ emit IJBPermissions.OperatorPermissionsSet(
245
+ permData2[0].operator,
246
+ zeroOwner,
247
+ permData2[0].projectId,
248
+ permData2[0].permissionIds,
249
+ packed |= 1 << 2,
250
+ address(this)
251
+ );
252
+ _permissions.setPermissionsFor(zeroOwner, permData2[0]);
253
+
254
+ // Change the permission being set back to root
255
+ permData2[0] = JBPermissionsData({operator: address(0), projectId: _projectZero, permissionIds: permIds});
256
+
257
+ // Shouldn't be able to forward root
258
+ vm.expectRevert(
259
+ abi.encodeWithSelector(
260
+ JBPermissions.JBPermissions_Unauthorized.selector,
261
+ zeroOwner,
262
+ address(this),
263
+ _projectZero,
264
+ JBPermissionIds.ROOT
265
+ )
266
+ );
267
+ _permissions.setPermissionsFor(zeroOwner, permData2[0]);
268
+ }
269
+
270
+ function testWildcardCannotBeSetForWildcardRootOperator() public {
271
+ address zeroOwner = makeAddr("zeroOwner");
272
+
273
+ // Pack up our permission data.
274
+ JBPermissionsData[] memory permData = new JBPermissionsData[](1);
275
+ uint8[] memory permIds = new uint8[](1);
276
+ permIds[0] = 1;
277
+
278
+ uint56 wildcardProjectId = 0;
279
+
280
+ permData[0] = JBPermissionsData({operator: address(this), projectId: wildcardProjectId, permissionIds: permIds});
281
+
282
+ // Set em.
283
+ vm.prank(zeroOwner);
284
+ _permissions.setPermissionsFor(zeroOwner, permData[0]);
285
+
286
+ // Should be true given root check
287
+ bool _check = _permissions.hasPermission(address(this), zeroOwner, _projectZero, 2, true, true);
288
+ assertEq(_check, true);
289
+
290
+ // Pack up our non-root wildcard permission data.
291
+ JBPermissionsData[] memory permData2 = new JBPermissionsData[](1);
292
+ uint8[] memory permIds2 = new uint8[](1);
293
+ permIds2[0] = 2;
294
+
295
+ permData2[0] = JBPermissionsData({operator: address(0), projectId: wildcardProjectId, permissionIds: permIds2});
296
+
297
+ // Shouldn't be able to set permission for wildcard project
298
+ vm.expectRevert(
299
+ abi.encodeWithSelector(
300
+ JBPermissions.JBPermissions_Unauthorized.selector, zeroOwner, address(this), 0, JBPermissionIds.ROOT
301
+ )
302
+ );
303
+ _permissions.setPermissionsFor(zeroOwner, permData2[0]);
304
+ }
305
+ }