@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,317 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity >=0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+
6
+ contract TestCashOutHooks_Local is TestBaseWorkflow {
7
+ using JBRulesetMetadataResolver for JBRuleset;
8
+
9
+ uint112 private constant _WEIGHT = 1000 * 10 ** 18;
10
+ address private constant _DATA_HOOK = address(bytes20(keccak256("datahook")));
11
+
12
+ IJBController private _controller;
13
+ IJBMultiTerminal private _terminal;
14
+ IJBTokens private _tokens;
15
+ address private _projectOwner;
16
+ address private _beneficiary;
17
+
18
+ uint64 _projectId;
19
+
20
+ function setUp() public override {
21
+ super.setUp();
22
+
23
+ vm.label(_DATA_HOOK, "Data Hook");
24
+
25
+ _controller = jbController();
26
+ _projectOwner = multisig();
27
+ _beneficiary = beneficiary();
28
+ _terminal = jbMultiTerminal();
29
+ _tokens = jbTokens();
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: true,
38
+ allowSetCustomToken: true,
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: false,
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
+ // Create a first project to collect fees.
73
+ _controller.launchProjectFor({
74
+ owner: _projectOwner,
75
+ projectUri: "myIPFSHash",
76
+ rulesetConfigurations: _rulesetConfig,
77
+ terminalConfigurations: _terminalConfigurations,
78
+ memo: ""
79
+ });
80
+
81
+ _projectId = uint64(
82
+ _controller.launchProjectFor({
83
+ owner: _projectOwner,
84
+ projectUri: "myIPFSHash",
85
+ rulesetConfigurations: _rulesetConfig,
86
+ terminalConfigurations: _terminalConfigurations,
87
+ memo: ""
88
+ })
89
+ );
90
+
91
+ // Issue the project's tokens.
92
+ vm.prank(_projectOwner);
93
+ IJBToken _token = _controller.deployERC20For(_projectId, "TestName", "TestSymbol", bytes32(0));
94
+
95
+ // Make sure the project's new project token is set.
96
+ assertEq(address(_tokens.tokenOf(_projectId)), address(_token));
97
+ }
98
+
99
+ function testCashOutHookWithNoFees() public {
100
+ // Reference and bound pay amount.
101
+ uint256 _nativePayAmount = 10 ether;
102
+ uint256 _halfPaid = 5 ether;
103
+
104
+ // Cash out hook address.
105
+ address _cashOutHook = makeAddr("SOFA");
106
+ vm.label(_cashOutHook, "Cash Out Delegate");
107
+
108
+ // Keep a reference to the current ruleset.
109
+ (JBRuleset memory _ruleset,) = _controller.currentRulesetOf(_projectId);
110
+
111
+ vm.deal(address(this), _nativePayAmount);
112
+ uint256 _beneficiaryTokensReceived = _terminal.pay{value: _nativePayAmount}({
113
+ projectId: _projectId,
114
+ amount: _nativePayAmount,
115
+ token: JBConstants.NATIVE_TOKEN,
116
+ beneficiary: address(this),
117
+ minReturnedTokens: 0,
118
+ memo: "Forge Test",
119
+ metadata: ""
120
+ });
121
+
122
+ // Make sure the beneficiary has a balance of project tokens.
123
+ uint256 _beneficiaryTokenBalance =
124
+ UD60x18unwrap(UD60x18mul(UD60x18wrap(_nativePayAmount), UD60x18wrap(_WEIGHT)));
125
+ assertEq(_tokens.totalBalanceOf(address(this), _projectId), _beneficiaryTokenBalance);
126
+ assertEq(_beneficiaryTokensReceived, _beneficiaryTokenBalance);
127
+
128
+ // Make sure the native token balance in terminal is up to date.
129
+ uint256 _nativeTerminalBalance = _nativePayAmount;
130
+ assertEq(
131
+ jbTerminalStore().balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN),
132
+ _nativeTerminalBalance
133
+ );
134
+
135
+ // Reference cash out hook specifications.
136
+ JBCashOutHookSpecification[] memory _specifications = new JBCashOutHookSpecification[](1);
137
+
138
+ _specifications[0] =
139
+ JBCashOutHookSpecification({hook: IJBCashOutHook(_cashOutHook), amount: _halfPaid, metadata: ""});
140
+
141
+ vm.startPrank(multisig());
142
+ // Set the hook as feeless.
143
+ _terminal.FEELESS_ADDRESSES().setFeelessAddress(_cashOutHook, true);
144
+ vm.stopPrank();
145
+
146
+ // Cash out context.
147
+ JBAfterCashOutRecordedContext memory _cashOutContext = JBAfterCashOutRecordedContext({
148
+ holder: address(this),
149
+ projectId: _projectId,
150
+ rulesetId: _ruleset.id,
151
+ cashOutCount: _beneficiaryTokenBalance / 2,
152
+ reclaimedAmount: JBTokenAmount(
153
+ JBConstants.NATIVE_TOKEN,
154
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
155
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
156
+ _halfPaid
157
+ ),
158
+ forwardedAmount: JBTokenAmount(
159
+ JBConstants.NATIVE_TOKEN,
160
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
161
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
162
+ _halfPaid
163
+ ),
164
+ cashOutTaxRate: 0,
165
+ beneficiary: payable(address(this)),
166
+ hookMetadata: "",
167
+ cashOutMetadata: ""
168
+ });
169
+
170
+ // Mock the hook.
171
+ vm.mockCall(
172
+ _cashOutHook,
173
+ abi.encodeWithSelector(IJBCashOutHook.afterCashOutRecordedWith.selector),
174
+ abi.encode(_cashOutContext)
175
+ );
176
+
177
+ // Assert that the hook gets called with the expected value.
178
+ vm.expectCall(
179
+ _cashOutHook,
180
+ _halfPaid,
181
+ abi.encodeWithSelector(IJBCashOutHook.afterCashOutRecordedWith.selector, _cashOutContext)
182
+ );
183
+
184
+ vm.mockCall(
185
+ _DATA_HOOK,
186
+ abi.encodeWithSelector(IJBRulesetDataHook.beforeCashOutRecordedWith.selector),
187
+ abi.encode(
188
+ _ruleset.cashOutTaxRate(), _beneficiaryTokenBalance / 2, _beneficiaryTokenBalance, _specifications
189
+ )
190
+ );
191
+
192
+ _terminal.cashOutTokensOf({
193
+ holder: address(this),
194
+ projectId: _projectId,
195
+ cashOutCount: _beneficiaryTokenBalance / 2,
196
+ tokenToReclaim: JBConstants.NATIVE_TOKEN,
197
+ minTokensReclaimed: 0,
198
+ beneficiary: payable(address(this)),
199
+ metadata: new bytes(0)
200
+ });
201
+ }
202
+
203
+ function testCashOutHookWithFeesAndCustomInfo() public {
204
+ // Reference and bound pay amount.
205
+ uint256 _nativePayAmount = 10 ether;
206
+ uint256 _halfPaid = 5 ether;
207
+
208
+ // Cash out hook address.
209
+ address _cashOutHook = makeAddr("SOFA");
210
+ vm.label(_cashOutHook, "Cash Out Delegate");
211
+
212
+ // Keep a reference to the current ruleset.
213
+ (JBRuleset memory _ruleset,) = _controller.currentRulesetOf(_projectId);
214
+
215
+ vm.deal(address(this), _nativePayAmount);
216
+ uint256 _beneficiaryTokensReceived = _terminal.pay{value: _nativePayAmount}({
217
+ projectId: _projectId,
218
+ amount: _nativePayAmount,
219
+ token: JBConstants.NATIVE_TOKEN,
220
+ beneficiary: address(this),
221
+ minReturnedTokens: 0,
222
+ memo: "Forge Test",
223
+ metadata: ""
224
+ });
225
+
226
+ // Make sure the beneficiary has a balance of project tokens.
227
+ uint256 _beneficiaryTokenBalance =
228
+ UD60x18unwrap(UD60x18mul(UD60x18wrap(_nativePayAmount), UD60x18wrap(_WEIGHT)));
229
+ assertEq(_tokens.totalBalanceOf(address(this), _projectId), _beneficiaryTokenBalance);
230
+ assertEq(_beneficiaryTokensReceived, _beneficiaryTokenBalance);
231
+
232
+ // Make sure the native token balance in terminal is up to date.
233
+ uint256 _nativeTerminalBalance = _nativePayAmount;
234
+ assertEq(
235
+ jbTerminalStore().balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN),
236
+ _nativeTerminalBalance
237
+ );
238
+
239
+ // Reference cash out hook specifications.
240
+ JBCashOutHookSpecification[] memory _specifications = new JBCashOutHookSpecification[](1);
241
+
242
+ _specifications[0] =
243
+ JBCashOutHookSpecification({hook: IJBCashOutHook(_cashOutHook), amount: _halfPaid, metadata: ""});
244
+
245
+ uint256 _customCashOutTaxRate = JBConstants.MAX_CASH_OUT_TAX_RATE / 2;
246
+ uint256 _customCashOutCount = 1 * 10 ** 18;
247
+ uint256 _customTotalSupply = 5 * 10 ** 18;
248
+
249
+ uint256 _forwardedAmount = _halfPaid - (_halfPaid * _terminal.FEE() / JBConstants.MAX_FEE);
250
+
251
+ uint256 _beneficiaryAmount = mulDiv(
252
+ mulDiv(_nativePayAmount, _customCashOutCount, _customTotalSupply),
253
+ (JBConstants.MAX_CASH_OUT_TAX_RATE - _customCashOutTaxRate)
254
+ + mulDiv(_customCashOutCount, _customCashOutTaxRate, _customTotalSupply),
255
+ JBConstants.MAX_CASH_OUT_TAX_RATE
256
+ );
257
+
258
+ _beneficiaryAmount -= mulDiv(_beneficiaryAmount, _terminal.FEE(), JBConstants.MAX_FEE);
259
+
260
+ // Cash out context.
261
+ JBAfterCashOutRecordedContext memory _cashOutContext = JBAfterCashOutRecordedContext({
262
+ holder: address(this),
263
+ projectId: _projectId,
264
+ rulesetId: _ruleset.id,
265
+ cashOutCount: _beneficiaryTokenBalance / 2,
266
+ reclaimedAmount: JBTokenAmount(
267
+ JBConstants.NATIVE_TOKEN,
268
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
269
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
270
+ _beneficiaryAmount
271
+ ),
272
+ forwardedAmount: JBTokenAmount(
273
+ JBConstants.NATIVE_TOKEN,
274
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).decimals,
275
+ _terminal.accountingContextForTokenOf(_projectId, JBConstants.NATIVE_TOKEN).currency,
276
+ _forwardedAmount
277
+ ),
278
+ cashOutTaxRate: uint16(_customCashOutTaxRate),
279
+ beneficiary: payable(address(this)),
280
+ hookMetadata: "",
281
+ cashOutMetadata: ""
282
+ });
283
+
284
+ // Mock the hook.
285
+ vm.mockCall(
286
+ _cashOutHook,
287
+ abi.encodeWithSelector(IJBCashOutHook.afterCashOutRecordedWith.selector),
288
+ abi.encode(_cashOutContext)
289
+ );
290
+
291
+ // Assert that the hook gets called with the expected value.
292
+ vm.expectCall(
293
+ _cashOutHook,
294
+ _forwardedAmount,
295
+ abi.encodeWithSelector(IJBCashOutHook.afterCashOutRecordedWith.selector, _cashOutContext)
296
+ );
297
+
298
+ vm.mockCall(
299
+ _DATA_HOOK,
300
+ abi.encodeWithSelector(IJBRulesetDataHook.beforeCashOutRecordedWith.selector),
301
+ abi.encode(_customCashOutTaxRate, _customCashOutCount, _customTotalSupply, _specifications)
302
+ );
303
+
304
+ _terminal.cashOutTokensOf({
305
+ holder: address(this),
306
+ projectId: _projectId,
307
+ cashOutCount: _beneficiaryTokenBalance / 2,
308
+ tokenToReclaim: JBConstants.NATIVE_TOKEN,
309
+ minTokensReclaimed: 0,
310
+ beneficiary: payable(address(this)),
311
+ metadata: new bytes(0)
312
+ });
313
+ }
314
+
315
+ receive() external payable {}
316
+ fallback() external payable {}
317
+ }
@@ -0,0 +1,229 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity ^0.8.6;
3
+
4
+ import /* {*} from */ "./helpers/TestBaseWorkflow.sol";
5
+ import {JBCashOuts} from "../src/libraries/JBCashOuts.sol";
6
+
7
+ /// @notice Edge case tests for cross-ruleset cash outs and pending reserves inflation (H-4).
8
+ /// Demonstrates that pending reserved tokens inflate totalSupply in cash-out calculations,
9
+ /// systematically undervaluing cash-outs until reserves are distributed.
10
+ contract TestCashOutTimingEdge_Local is TestBaseWorkflow {
11
+ IJBController private _controller;
12
+ IJBMultiTerminal private _terminal;
13
+ JBTokens private _tokens;
14
+ JBTerminalStore private _store;
15
+ uint256 private _projectId;
16
+ address private _projectOwner;
17
+ address private _payer;
18
+
19
+ uint112 private constant WEIGHT = 1000 * 10 ** 18;
20
+ uint112 private constant PAY_AMOUNT = 10 ether;
21
+
22
+ function setUp() public override {
23
+ super.setUp();
24
+
25
+ _projectOwner = multisig();
26
+ _payer = beneficiary();
27
+ _controller = jbController();
28
+ _terminal = jbMultiTerminal();
29
+ _tokens = jbTokens();
30
+ _store = jbTerminalStore();
31
+
32
+ // Ruleset: 50% reserved, 50% cash-out tax, no duration (persists forever).
33
+ JBRulesetMetadata memory metadata = JBRulesetMetadata({
34
+ reservedPercent: 5000, // 50%
35
+ cashOutTaxRate: 5000, // 50%
36
+ baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
37
+ pausePay: false,
38
+ pauseCreditTransfers: false,
39
+ allowOwnerMinting: true,
40
+ allowSetCustomToken: false,
41
+ allowTerminalMigration: false,
42
+ allowSetTerminals: false,
43
+ ownerMustSendPayouts: false,
44
+ allowSetController: false,
45
+ allowAddAccountingContext: true,
46
+ allowAddPriceFeed: false,
47
+ holdFees: false,
48
+ useTotalSurplusForCashOuts: false,
49
+ useDataHookForPay: false,
50
+ useDataHookForCashOut: false,
51
+ dataHook: address(0),
52
+ metadata: 0
53
+ });
54
+
55
+ JBRulesetConfig[] memory rulesetConfig = new JBRulesetConfig[](1);
56
+ rulesetConfig[0].mustStartAtOrAfter = 0;
57
+ rulesetConfig[0].duration = 0;
58
+ rulesetConfig[0].weight = WEIGHT;
59
+ rulesetConfig[0].weightCutPercent = 0;
60
+ rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
61
+ rulesetConfig[0].metadata = metadata;
62
+ rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
63
+ rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
64
+
65
+ JBTerminalConfig[] memory terminalConfigs = new JBTerminalConfig[](1);
66
+ JBAccountingContext[] memory tokensToAccept = new JBAccountingContext[](1);
67
+ tokensToAccept[0] = JBAccountingContext({
68
+ token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
69
+ });
70
+ terminalConfigs[0] = JBTerminalConfig({terminal: _terminal, accountingContextsToAccept: tokensToAccept});
71
+
72
+ // Fee project (#1).
73
+ _controller.launchProjectFor({
74
+ owner: address(420),
75
+ projectUri: "fee",
76
+ rulesetConfigurations: rulesetConfig,
77
+ terminalConfigurations: terminalConfigs,
78
+ memo: ""
79
+ });
80
+
81
+ // Test project (#2).
82
+ _projectId = _controller.launchProjectFor({
83
+ owner: _projectOwner,
84
+ projectUri: "test",
85
+ rulesetConfigurations: rulesetConfig,
86
+ terminalConfigurations: terminalConfigs,
87
+ memo: ""
88
+ });
89
+
90
+ // Deploy ERC20 for the project.
91
+ vm.prank(_projectOwner);
92
+ _controller.deployERC20For(_projectId, "Test", "TST", bytes32(0));
93
+ }
94
+
95
+ /// @notice H-4 CONFIRMATION: Pending reserves inflate totalSupply, reducing cash-out value.
96
+ /// When reserves exist but haven't been distributed, totalTokenSupplyWithReservedTokensOf
97
+ /// includes them in the denominator, making each token worth less.
98
+ function test_pendingReserves_inflateSupply_reduceCashOut() external {
99
+ // Pay the project.
100
+ _terminal.pay{value: PAY_AMOUNT}({
101
+ projectId: _projectId,
102
+ amount: PAY_AMOUNT,
103
+ token: JBConstants.NATIVE_TOKEN,
104
+ beneficiary: _payer,
105
+ minReturnedTokens: 0,
106
+ memo: "",
107
+ metadata: new bytes(0)
108
+ });
109
+
110
+ // Check payer's token balance. With 50% reserved, payer gets 50% of tokens.
111
+ uint256 payerTokens = _tokens.totalBalanceOf(_payer, _projectId);
112
+ assertGt(payerTokens, 0, "Payer should have tokens");
113
+
114
+ // Check pending reserves.
115
+ uint256 pendingReserves = _controller.pendingReservedTokenBalanceOf(_projectId);
116
+ assertGt(pendingReserves, 0, "Should have pending reserves");
117
+
118
+ // Total supply WITH pending reserves (used in cash-out calculation).
119
+ uint256 totalWithReserves = _controller.totalTokenSupplyWithReservedTokensOf(_projectId);
120
+ // Total supply WITHOUT pending reserves (actual circulating).
121
+ uint256 circulatingSupply = _tokens.totalSupplyOf(_projectId);
122
+
123
+ assertGt(totalWithReserves, circulatingSupply, "Total with reserves should exceed circulating");
124
+ assertEq(totalWithReserves, circulatingSupply + pendingReserves, "Total = circulating + pending reserves");
125
+
126
+ // Compute cash-out value with inflated supply (what the system does).
127
+ uint256 surplus = _store.balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN);
128
+ uint256 reclaimWithInflation = JBCashOuts.cashOutFrom({
129
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: totalWithReserves, cashOutTaxRate: 5000
130
+ });
131
+
132
+ // Compute what the cash-out WOULD be without pending reserves (hypothetical).
133
+ uint256 reclaimWithoutInflation = JBCashOuts.cashOutFrom({
134
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: circulatingSupply, cashOutTaxRate: 5000
135
+ });
136
+
137
+ // H-4 CONFIRMED: Cash-out with pending reserves is LESS than without.
138
+ assertLt(reclaimWithInflation, reclaimWithoutInflation, "H-4: Pending reserves reduce cash-out value");
139
+
140
+ // Quantify the impact.
141
+ uint256 lostValue = reclaimWithoutInflation - reclaimWithInflation;
142
+ assertGt(lostValue, 0, "Lost value should be non-zero");
143
+ }
144
+
145
+ /// @notice Distribute reserves first, then cash out — value should be higher.
146
+ function test_distributeReserves_thenCashOut_higherReclaim() external {
147
+ // Pay the project.
148
+ _terminal.pay{value: PAY_AMOUNT}({
149
+ projectId: _projectId,
150
+ amount: PAY_AMOUNT,
151
+ token: JBConstants.NATIVE_TOKEN,
152
+ beneficiary: _payer,
153
+ minReturnedTokens: 0,
154
+ memo: "",
155
+ metadata: new bytes(0)
156
+ });
157
+
158
+ uint256 payerTokens = _tokens.totalBalanceOf(_payer, _projectId);
159
+
160
+ // Snapshot cash-out value BEFORE distributing reserves.
161
+ uint256 surplus = _store.balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN);
162
+ uint256 totalBefore = _controller.totalTokenSupplyWithReservedTokensOf(_projectId);
163
+ uint256 reclaimBefore = JBCashOuts.cashOutFrom({
164
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: totalBefore, cashOutTaxRate: 5000
165
+ });
166
+
167
+ // Distribute reserves. This mints pending tokens and zeroes pending balance.
168
+ _controller.sendReservedTokensToSplitsOf(_projectId);
169
+
170
+ // After distribution, pending reserves should be 0.
171
+ assertEq(
172
+ _controller.pendingReservedTokenBalanceOf(_projectId), 0, "Pending reserves should be 0 after distribution"
173
+ );
174
+
175
+ // Total supply should be the same (pending tokens are now real tokens).
176
+ uint256 totalAfter = _controller.totalTokenSupplyWithReservedTokensOf(_projectId);
177
+ assertEq(totalAfter, totalBefore, "Total supply unchanged after distribution");
178
+
179
+ // Cash-out value should be the same since total didn't change.
180
+ // The fix for H-4 would be: don't include pending reserves in totalSupply.
181
+ uint256 reclaimAfter = JBCashOuts.cashOutFrom({
182
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: totalAfter, cashOutTaxRate: 5000
183
+ });
184
+
185
+ assertEq(reclaimAfter, reclaimBefore, "Reclaim unchanged after distributing (same totalSupply)");
186
+ }
187
+
188
+ /// @notice Quantify exact impact: with 50% reserved, cash-out gets ~44% less value
189
+ /// than it would if pending reserves were excluded from totalSupply.
190
+ function test_pendingReserves_quantifyImpact() external {
191
+ _terminal.pay{value: PAY_AMOUNT}({
192
+ projectId: _projectId,
193
+ amount: PAY_AMOUNT,
194
+ token: JBConstants.NATIVE_TOKEN,
195
+ beneficiary: _payer,
196
+ minReturnedTokens: 0,
197
+ memo: "",
198
+ metadata: new bytes(0)
199
+ });
200
+
201
+ uint256 payerTokens = _tokens.totalBalanceOf(_payer, _projectId);
202
+ uint256 surplus = _store.balanceOf(address(_terminal), _projectId, JBConstants.NATIVE_TOKEN);
203
+ uint256 totalWithReserves = _controller.totalTokenSupplyWithReservedTokensOf(_projectId);
204
+ uint256 circulatingOnly = _tokens.totalSupplyOf(_projectId);
205
+
206
+ uint256 reclaimActual = JBCashOuts.cashOutFrom({
207
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: totalWithReserves, cashOutTaxRate: 5000
208
+ });
209
+
210
+ uint256 reclaimFair = JBCashOuts.cashOutFrom({
211
+ surplus: surplus, cashOutCount: payerTokens, totalSupply: circulatingOnly, cashOutTaxRate: 5000
212
+ });
213
+
214
+ // With 50% reserved:
215
+ // - circulatingOnly = payerTokens (payer gets all non-reserved tokens)
216
+ // - totalWithReserves = 2 * payerTokens
217
+ // At 50% tax and cashOutCount == circulatingOnly:
218
+ // reclaimFair = surplus (full amount, since cashOutCount >= totalSupply)
219
+ // reclaimActual = surplus * (payerTokens / 2*payerTokens) * ((5000 + 5000*0.5) / 10000)
220
+ // = surplus * 0.5 * 0.75 = surplus * 0.375
221
+
222
+ // The impact is significant — actual is only 37.5% of surplus vs 100%.
223
+ assertGt(reclaimFair, reclaimActual, "Fair reclaim significantly higher than actual");
224
+
225
+ // Log the percentage lost.
226
+ uint256 percentLost = ((reclaimFair - reclaimActual) * 10_000) / reclaimFair;
227
+ assertGt(percentLost, 5000, "More than 50% value lost due to pending reserves");
228
+ }
229
+ }