@bananapus/core-v6 0.0.36 → 0.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (286) hide show
  1. package/foundry.lock +1 -7
  2. package/foundry.toml +1 -1
  3. package/package.json +19 -7
  4. package/src/JBController.sol +26 -5
  5. package/src/JBMultiTerminal.sol +85 -47
  6. package/src/JBTerminalStore.sol +6 -6
  7. package/src/interfaces/IJBController.sol +4 -1
  8. package/src/libraries/JBFees.sol +47 -9
  9. package/src/libraries/JBPayoutSplitGroupLib.sol +2 -2
  10. package/src/periphery/JBMatchingPriceFeed.sol +1 -1
  11. package/test/mock/MockMaliciousBeneficiary.sol +15 -15
  12. package/ADMINISTRATION.md +0 -103
  13. package/ARCHITECTURE.md +0 -133
  14. package/AUDIT_INSTRUCTIONS.md +0 -139
  15. package/RISKS.md +0 -215
  16. package/SKILLS.md +0 -55
  17. package/STYLE_GUIDE.md +0 -610
  18. package/USER_JOURNEYS.md +0 -215
  19. package/script/Deploy.s.sol +0 -124
  20. package/script/DeployPeriphery.s.sol +0 -354
  21. package/slither-ci.config.json +0 -10
  22. package/test/AuditFixes.t.sol +0 -808
  23. package/test/ComprehensiveInvariant.t.sol +0 -306
  24. package/test/CoreExploitTests.t.sol +0 -2741
  25. package/test/EconomicSimulation.t.sol +0 -348
  26. package/test/EntryPointPermutations.t.sol +0 -684
  27. package/test/FlashLoanAttacks.t.sol +0 -797
  28. package/test/PermissionEscalation.t.sol +0 -711
  29. package/test/PermissionsInvariant.t.sol +0 -403
  30. package/test/RulesetTransitions.t.sol +0 -713
  31. package/test/SplitLoopTests.t.sol +0 -752
  32. package/test/TestAccessToFunds.sol +0 -2683
  33. package/test/TestAuditResponseDesignProofs.sol +0 -434
  34. package/test/TestCashOut.sol +0 -198
  35. package/test/TestCashOutCountFor.sol +0 -271
  36. package/test/TestCashOutHooks.sol +0 -351
  37. package/test/TestCashOutTimingEdge.sol +0 -241
  38. package/test/TestDataHookFuzzing.sol +0 -524
  39. package/test/TestDurationUnderflow.sol +0 -233
  40. package/test/TestFeeFreeCashOutBypass.sol +0 -949
  41. package/test/TestFeeProcessingFailure.sol +0 -218
  42. package/test/TestFees.sol +0 -619
  43. package/test/TestForwardedTokenConsumption.sol +0 -425
  44. package/test/TestInterfaceSupport.sol +0 -81
  45. package/test/TestJBERC20Inheritance.sol +0 -103
  46. package/test/TestL2SequencerPriceFeed.sol +0 -292
  47. package/test/TestLaunchProject.sol +0 -188
  48. package/test/TestMetaTx.sol +0 -217
  49. package/test/TestMetadataOffsetOverflow.sol +0 -179
  50. package/test/TestMetadataParserLib.sol +0 -471
  51. package/test/TestMigrationHeldFees.sol +0 -255
  52. package/test/TestMintTokensOf.sol +0 -185
  53. package/test/TestMultiTerminalSurplus.sol +0 -348
  54. package/test/TestMultiTokenSurplus.sol +0 -202
  55. package/test/TestMultipleAccessLimits.sol +0 -664
  56. package/test/TestPayBurnRedeemFlow.sol +0 -195
  57. package/test/TestPayHooks.sol +0 -209
  58. package/test/TestPermissions.sol +0 -324
  59. package/test/TestPermissionsEdge.sol +0 -290
  60. package/test/TestPermit2DataHook.t.sol +0 -360
  61. package/test/TestPermit2Terminal.sol +0 -372
  62. package/test/TestRulesetQueueing.sol +0 -1025
  63. package/test/TestRulesetQueuingStress.sol +0 -806
  64. package/test/TestRulesetWeightCaching.sol +0 -178
  65. package/test/TestSplits.sol +0 -391
  66. package/test/TestTerminalMigration.sol +0 -274
  67. package/test/TestTerminalPreviewParity.sol +0 -208
  68. package/test/TestTokenFlow.sol +0 -191
  69. package/test/TestWeightCacheStaleAfterRejection.sol +0 -303
  70. package/test/WeirdTokenTests.t.sol +0 -817
  71. package/test/audit/CashOutReenterPay.t.sol +0 -501
  72. package/test/audit/CodexHeldFeeRounding.t.sol +0 -159
  73. package/test/audit/CrossTerminalSurplusSpoof.t.sol +0 -140
  74. package/test/audit/CycledSurplusAllowanceReset.t.sol +0 -184
  75. package/test/audit/FeeFreeSurplusLifecycle.t.sol +0 -399
  76. package/test/audit/FeeFreeSurplusStale.t.sol +0 -248
  77. package/test/audit/USDTVoidReturnCompat.t.sol +0 -525
  78. package/test/fork/TestChainlinkPriceFeedFork.sol +0 -254
  79. package/test/fork/TestSequencerPriceFeedFork.sol +0 -168
  80. package/test/fork/TestTerminalPreviewParityFork.sol +0 -108
  81. package/test/formal/BondingCurveProperties.t.sol +0 -420
  82. package/test/formal/FeeProperties.t.sol +0 -252
  83. package/test/invariants/Phase3DeepInvariant.t.sol +0 -412
  84. package/test/invariants/RulesetsInvariant.t.sol +0 -125
  85. package/test/invariants/TerminalStoreInvariant.t.sol +0 -227
  86. package/test/invariants/TokensInvariant.t.sol +0 -195
  87. package/test/invariants/handlers/ComprehensiveHandler.sol +0 -303
  88. package/test/invariants/handlers/EconomicHandler.sol +0 -377
  89. package/test/invariants/handlers/Phase3Handler.sol +0 -443
  90. package/test/invariants/handlers/RulesetsHandler.sol +0 -115
  91. package/test/invariants/handlers/TerminalStoreHandler.sol +0 -151
  92. package/test/invariants/handlers/TokensHandler.sol +0 -126
  93. package/test/regression/HoldFeesCashOutReserved.t.sol +0 -415
  94. package/test/regression/WeightCacheBoundary.t.sol +0 -291
  95. package/test/trees/JBController/burnTokensOf.tree +0 -9
  96. package/test/trees/JBController/claimTokensFor.tree +0 -5
  97. package/test/trees/JBController/deployERC20For.tree +0 -5
  98. package/test/trees/JBController/getRulesetOf.tree +0 -5
  99. package/test/trees/JBController/launchProjectFor.tree +0 -12
  100. package/test/trees/JBController/launchRulesetsFor.tree +0 -8
  101. package/test/trees/JBController/migrateController.tree +0 -12
  102. package/test/trees/JBController/mintTokensOf.tree +0 -12
  103. package/test/trees/JBController/payReservedTokenToTerminal.tree +0 -8
  104. package/test/trees/JBController/receiveMigrationFrom.tree +0 -4
  105. package/test/trees/JBController/sendReservedTokensToSplitsOf.tree +0 -12
  106. package/test/trees/JBController/setMetadataOf.tree +0 -5
  107. package/test/trees/JBController/setSplitGroupsOf.tree +0 -5
  108. package/test/trees/JBController/setTokenFor.tree +0 -5
  109. package/test/trees/JBController/transferCreditsFrom.tree +0 -8
  110. package/test/trees/JBDirectory/primaryTerminalOf.tree +0 -8
  111. package/test/trees/JBDirectory/setControllerOf.tree +0 -11
  112. package/test/trees/JBDirectory/setPrimaryTerminalOf.tree +0 -15
  113. package/test/trees/JBDirectory/setTerminalsOf.tree +0 -11
  114. package/test/trees/JBERC20/initialize.tree +0 -7
  115. package/test/trees/JBERC20/name.tree +0 -5
  116. package/test/trees/JBERC20/nonces.tree +0 -5
  117. package/test/trees/JBERC20/symbol.tree +0 -5
  118. package/test/trees/JBFeelessAddresses/setFeelessAddress.tree +0 -5
  119. package/test/trees/JBFeelessAddresses/supportsInterface.tree +0 -5
  120. package/test/trees/JBFundAccessLimits/payoutLimitOf.tree +0 -5
  121. package/test/trees/JBFundAccessLimits/payoutLimitsOf.tree +0 -8
  122. package/test/trees/JBFundAccessLimits/setFundAccessLimitsFor.tree +0 -18
  123. package/test/trees/JBFundAccessLimits/surplusAllowanceOf.tree +0 -5
  124. package/test/trees/JBFundAccessLimits/surplusAllowancesOf.tree +0 -8
  125. package/test/trees/JBMetadataResolver/getDataFor.tree +0 -8
  126. package/test/trees/JBMultiTerminal/accountingContextsOf.tree +0 -5
  127. package/test/trees/JBMultiTerminal/addAccountingContextsFor.tree +0 -10
  128. package/test/trees/JBMultiTerminal/addToBalanceOf.tree +0 -23
  129. package/test/trees/JBMultiTerminal/cashOutTokensOf.tree +0 -23
  130. package/test/trees/JBMultiTerminal/executePayout.tree +0 -32
  131. package/test/trees/JBMultiTerminal/executeProcessFee.tree +0 -14
  132. package/test/trees/JBMultiTerminal/migrateBalanceOf.tree +0 -12
  133. package/test/trees/JBMultiTerminal/pay.tree +0 -23
  134. package/test/trees/JBMultiTerminal/processHeldFeesOf.tree +0 -8
  135. package/test/trees/JBMultiTerminal/sendPayoutsOf.tree +0 -34
  136. package/test/trees/JBMultiTerminal/useAllowanceOf.tree +0 -16
  137. package/test/trees/JBPermissions/hasPermission.tree +0 -8
  138. package/test/trees/JBPermissions/hasPermissions.tree +0 -8
  139. package/test/trees/JBPermissions/setPermissionsFor.tree +0 -5
  140. package/test/trees/JBPrices/addPriceFeedFor.tree +0 -14
  141. package/test/trees/JBPrices/pricePerUnitOf.tree +0 -11
  142. package/test/trees/JBProjects/createFor.tree +0 -11
  143. package/test/trees/JBProjects/setTokenUriResolver.tree +0 -5
  144. package/test/trees/JBProjects/supportsInterface.tree +0 -9
  145. package/test/trees/JBProjects/tokenURI.tree +0 -5
  146. package/test/trees/JBRulesets/currentApprovalStatusForLatestRulesetOf.tree +0 -8
  147. package/test/trees/JBRulesets/currentOf.tree +0 -12
  148. package/test/trees/JBRulesets/getRulesetOf.tree +0 -5
  149. package/test/trees/JBRulesets/latestQueuedRulesetOf.tree +0 -10
  150. package/test/trees/JBRulesets/rulesetsOf.tree +0 -11
  151. package/test/trees/JBRulesets/upcomingRulesetOf.tree +0 -20
  152. package/test/trees/JBRulesets/updateRulesetWeightCache.tree +0 -5
  153. package/test/trees/JBSplits/setSplitGroupsOf.tree +0 -17
  154. package/test/trees/JBSplits/splitsOf.tree +0 -5
  155. package/test/trees/JBTerminalStore/currentReclaimableSurplusOf.tree +0 -16
  156. package/test/trees/JBTerminalStore/currentSurplusOf.tree +0 -25
  157. package/test/trees/JBTerminalStore/currentTotalSurplusOf.tree +0 -5
  158. package/test/trees/JBTerminalStore/recordCashOutsFor.tree +0 -16
  159. package/test/trees/JBTerminalStore/recordPaymentFrom.tree +0 -14
  160. package/test/trees/JBTerminalStore/recordPayoutFor.tree +0 -10
  161. package/test/trees/JBTerminalStore/recordTerminalMigration.tree +0 -5
  162. package/test/trees/JBTerminalStore/recordUsedAllowanceOf.tree +0 -10
  163. package/test/trees/JBTokens/burnFrom.tree +0 -10
  164. package/test/trees/JBTokens/claimTokensFor.tree +0 -10
  165. package/test/trees/JBTokens/deployERC20For.tree +0 -12
  166. package/test/trees/JBTokens/mintFor.tree +0 -10
  167. package/test/trees/JBTokens/setTokenFor.tree +0 -11
  168. package/test/trees/JBTokens/totalBalanceOf.tree +0 -5
  169. package/test/trees/JBTokens/totalSupplyOf.tree +0 -5
  170. package/test/trees/JBTokens/transferCreditsFrom.tree +0 -8
  171. package/test/trees/mintTokensOf.tree +0 -12
  172. package/test/units/static/JBChainlinkV3PriceFeed/TestPriceFeed.sol +0 -223
  173. package/test/units/static/JBController/JBControllerSetup.sol +0 -50
  174. package/test/units/static/JBController/TestBurnTokensOf.sol +0 -114
  175. package/test/units/static/JBController/TestClaimTokensFor.sol +0 -63
  176. package/test/units/static/JBController/TestDeployErc20For.sol +0 -86
  177. package/test/units/static/JBController/TestLaunchProjectFor.sol +0 -302
  178. package/test/units/static/JBController/TestLaunchRulesetsFor.sol +0 -342
  179. package/test/units/static/JBController/TestMigrateController.sol +0 -157
  180. package/test/units/static/JBController/TestMintTokensOfUnits.sol +0 -111
  181. package/test/units/static/JBController/TestOmnichainRulesetOperator.sol +0 -324
  182. package/test/units/static/JBController/TestPayReservedTokenToTerminal.sol +0 -74
  183. package/test/units/static/JBController/TestPreviewMintOf.sol +0 -117
  184. package/test/units/static/JBController/TestReceiveMigrationFrom.sol +0 -99
  185. package/test/units/static/JBController/TestRulesetViews.sol +0 -225
  186. package/test/units/static/JBController/TestSendReservedTokensToSplitsOf.sol +0 -615
  187. package/test/units/static/JBController/TestSetSplitGroupsOf.sol +0 -68
  188. package/test/units/static/JBController/TestSetTokenFor.sol +0 -239
  189. package/test/units/static/JBController/TestSetUriOf.sol +0 -57
  190. package/test/units/static/JBController/TestTransferCreditsFrom.sol +0 -169
  191. package/test/units/static/JBDeadline/TestDeadlineFuzz.sol +0 -211
  192. package/test/units/static/JBDirectory/JBDirectorySetup.sol +0 -26
  193. package/test/units/static/JBDirectory/TestPrimaryTerminalOf.sol +0 -126
  194. package/test/units/static/JBDirectory/TestSetControllerOf.sol +0 -183
  195. package/test/units/static/JBDirectory/TestSetControllerOfMigrationOrder.sol +0 -104
  196. package/test/units/static/JBDirectory/TestSetPrimaryTerminalOf.sol +0 -179
  197. package/test/units/static/JBDirectory/TestSetTerminalsOf.sol +0 -137
  198. package/test/units/static/JBERC20/JBERC20Setup.sol +0 -34
  199. package/test/units/static/JBERC20/SigUtils.sol +0 -36
  200. package/test/units/static/JBERC20/TestInitialize.sol +0 -60
  201. package/test/units/static/JBERC20/TestName.sol +0 -30
  202. package/test/units/static/JBERC20/TestNonces.sol +0 -62
  203. package/test/units/static/JBERC20/TestSymbol.sol +0 -31
  204. package/test/units/static/JBFeelessAdresses/JBFeelessSetup.sol +0 -22
  205. package/test/units/static/JBFeelessAdresses/TestInterfaces.sol +0 -30
  206. package/test/units/static/JBFeelessAdresses/TestSetFeelessAddress.sol +0 -35
  207. package/test/units/static/JBFees/TestFeesFuzz.sol +0 -79
  208. package/test/units/static/JBFixedPointNumber/TestAdjustDecimals.sol +0 -16
  209. package/test/units/static/JBFixedPointNumber/TestAdjustDecimalsFuzz.sol +0 -71
  210. package/test/units/static/JBFundAccessLimits/JBFundAccessSetup.sol +0 -24
  211. package/test/units/static/JBFundAccessLimits/TestFundAccessLimitsEdge.sol +0 -163
  212. package/test/units/static/JBFundAccessLimits/TestPayoutLimitOf.sol +0 -59
  213. package/test/units/static/JBFundAccessLimits/TestPayoutLimitsOf.sol +0 -101
  214. package/test/units/static/JBFundAccessLimits/TestSetFundAccessLimitsFor.sol +0 -189
  215. package/test/units/static/JBFundAccessLimits/TestSurplusAllowanceOf.sol +0 -64
  216. package/test/units/static/JBFundAccessLimits/TestSurplusAllowancesOf.sol +0 -102
  217. package/test/units/static/JBMetadataResolver/TestGetDataFor.sol +0 -90
  218. package/test/units/static/JBMetadataResolver/TestMetadataResolverEdgeCases.sol +0 -247
  219. package/test/units/static/JBMetadataResolver/TestMetadataResolverFuzz.sol +0 -229
  220. package/test/units/static/JBMultiTerminal/JBMultiTerminalSetup.sol +0 -50
  221. package/test/units/static/JBMultiTerminal/TestAccountingContextsOf.sol +0 -72
  222. package/test/units/static/JBMultiTerminal/TestAddAccountingContextsFor.sol +0 -289
  223. package/test/units/static/JBMultiTerminal/TestAddToBalanceOf.sol +0 -474
  224. package/test/units/static/JBMultiTerminal/TestCashOutTokensOf.sol +0 -624
  225. package/test/units/static/JBMultiTerminal/TestExecutePayout.sol +0 -578
  226. package/test/units/static/JBMultiTerminal/TestExecuteProcessFee.sol +0 -202
  227. package/test/units/static/JBMultiTerminal/TestMigrateBalanceOf.sol +0 -222
  228. package/test/units/static/JBMultiTerminal/TestPay.sol +0 -604
  229. package/test/units/static/JBMultiTerminal/TestPreviewCashOutFrom.sol +0 -117
  230. package/test/units/static/JBMultiTerminal/TestPreviewPayFor.sol +0 -114
  231. package/test/units/static/JBMultiTerminal/TestProcessHeldFeesOf.sol +0 -228
  232. package/test/units/static/JBMultiTerminal/TestSelfPayRevert.sol +0 -55
  233. package/test/units/static/JBMultiTerminal/TestSendPayoutsOf.sol +0 -257
  234. package/test/units/static/JBMultiTerminal/TestUseAllowanceOf.sol +0 -611
  235. package/test/units/static/JBPermissions/JBPermissionsSetup.sol +0 -20
  236. package/test/units/static/JBPermissions/TestHasPermission.sol +0 -50
  237. package/test/units/static/JBPermissions/TestHasPermissions.sol +0 -93
  238. package/test/units/static/JBPermissions/TestSetPermissionsFor.sol +0 -64
  239. package/test/units/static/JBPrices/JBPricesSetup.sol +0 -32
  240. package/test/units/static/JBPrices/TestAddPriceFeedFor.sol +0 -107
  241. package/test/units/static/JBPrices/TestPricePerUnitOf.sol +0 -132
  242. package/test/units/static/JBPrices/TestPrices.sol +0 -265
  243. package/test/units/static/JBProjects/JBProjectsSetup.sol +0 -22
  244. package/test/units/static/JBProjects/TestCreateFor.sol +0 -71
  245. package/test/units/static/JBProjects/TestInitialProject.sol +0 -21
  246. package/test/units/static/JBProjects/TestInterfaces.sol +0 -26
  247. package/test/units/static/JBProjects/TestSetResolver.sol +0 -37
  248. package/test/units/static/JBProjects/TestTokenUri.sol +0 -40
  249. package/test/units/static/JBRulesetMetadataResolver/TestSetCashOutTaxRateTo.sol +0 -108
  250. package/test/units/static/JBRulesets/JBRulesetsSetup.sol +0 -24
  251. package/test/units/static/JBRulesets/TestCurrentApprovalStatusForLatestRulesetOf.sol +0 -265
  252. package/test/units/static/JBRulesets/TestCurrentOf.sol +0 -242
  253. package/test/units/static/JBRulesets/TestGetRulesetOf.sol +0 -100
  254. package/test/units/static/JBRulesets/TestLatestQueuedRulesetOf.sol +0 -260
  255. package/test/units/static/JBRulesets/TestRulesets.sol +0 -632
  256. package/test/units/static/JBRulesets/TestRulesetsOf.sol +0 -37
  257. package/test/units/static/JBRulesets/TestUpcomingRulesetOf.sol +0 -522
  258. package/test/units/static/JBRulesets/TestUpdateRulesetWeightCache.sol +0 -96
  259. package/test/units/static/JBSplits/JBSplitsSetup.sol +0 -26
  260. package/test/units/static/JBSplits/TestSelfManagedSplitGroups.sol +0 -552
  261. package/test/units/static/JBSplits/TestSetSplitGroupsOf.sol +0 -377
  262. package/test/units/static/JBSplits/TestSplitsLockedEdge.sol +0 -267
  263. package/test/units/static/JBSplits/TestSplitsOf.sol +0 -24
  264. package/test/units/static/JBSplits/TestSplitsPacking.sol +0 -36
  265. package/test/units/static/JBSurplus/TestSurplusFuzz.sol +0 -160
  266. package/test/units/static/JBTerminalStore/JBTerminalStoreSetup.sol +0 -45
  267. package/test/units/static/JBTerminalStore/TestCurrentReclaimableSurplusOf.sol +0 -536
  268. package/test/units/static/JBTerminalStore/TestCurrentSurplusOf.sol +0 -463
  269. package/test/units/static/JBTerminalStore/TestCurrentTotalSurplusOf.sol +0 -135
  270. package/test/units/static/JBTerminalStore/TestPreviewCashOutFrom.sol +0 -476
  271. package/test/units/static/JBTerminalStore/TestPreviewPayFrom.sol +0 -494
  272. package/test/units/static/JBTerminalStore/TestRecordCashOutsFor.sol +0 -652
  273. package/test/units/static/JBTerminalStore/TestRecordPaymentFrom.sol +0 -744
  274. package/test/units/static/JBTerminalStore/TestRecordPayoutFor.sol +0 -289
  275. package/test/units/static/JBTerminalStore/TestRecordTerminalMigration.sol +0 -138
  276. package/test/units/static/JBTerminalStore/TestRecordUsedAllowanceOf.sol +0 -415
  277. package/test/units/static/JBTerminalStore/TestUint224Overflow.sol +0 -219
  278. package/test/units/static/JBTokens/JBTokensSetup.sol +0 -32
  279. package/test/units/static/JBTokens/TestBurnFrom.sol +0 -107
  280. package/test/units/static/JBTokens/TestClaimTokensFor.sol +0 -110
  281. package/test/units/static/JBTokens/TestDeployERC20ForUnits.sol +0 -92
  282. package/test/units/static/JBTokens/TestMintFor.sol +0 -100
  283. package/test/units/static/JBTokens/TestSetTokenFor.sol +0 -98
  284. package/test/units/static/JBTokens/TestTotalBalanceOf.sol +0 -65
  285. package/test/units/static/JBTokens/TestTotalSupplyOf.sol +0 -56
  286. package/test/units/static/JBTokens/TestTransferCreditsFrom.sol +0 -56
@@ -1,744 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity 0.8.28;
3
-
4
- import {JBTerminalStore} from "../../../../src/JBTerminalStore.sol";
5
- import {IJBPayHook} from "../../../../src/interfaces/IJBPayHook.sol";
6
- import {IJBPrices} from "../../../../src/interfaces/IJBPrices.sol";
7
- import {IJBRulesetApprovalHook} from "../../../../src/interfaces/IJBRulesetApprovalHook.sol";
8
- import {IJBRulesetDataHook} from "../../../../src/interfaces/IJBRulesetDataHook.sol";
9
- import {IJBRulesets} from "../../../../src/interfaces/IJBRulesets.sol";
10
- import {IJBToken} from "../../../../src/interfaces/IJBToken.sol";
11
- import {JBConstants} from "../../../../src/libraries/JBConstants.sol";
12
- import {JBRulesetMetadataResolver} from "../../../../src/libraries/JBRulesetMetadataResolver.sol";
13
- import {JBBeforePayRecordedContext} from "../../../../src/structs/JBBeforePayRecordedContext.sol";
14
- import {JBPayHookSpecification} from "../../../../src/structs/JBPayHookSpecification.sol";
15
- import {JBRuleset} from "../../../../src/structs/JBRuleset.sol";
16
- import {JBRulesetMetadata} from "../../../../src/structs/JBRulesetMetadata.sol";
17
- import {JBTokenAmount} from "../../../../src/structs/JBTokenAmount.sol";
18
- import {mulDiv} from "@prb/math/src/Common.sol";
19
- import {JBTerminalStoreSetup} from "./JBTerminalStoreSetup.sol";
20
-
21
- contract TestRecordPaymentFrom_Local is JBTerminalStoreSetup {
22
- // A library that parses the packed ruleset metadata into a friendlier format.
23
- using JBRulesetMetadataResolver for JBRuleset;
24
-
25
- uint64 _projectId = 1;
26
- uint256 _defaultValue = 1e18;
27
- uint8 _defaultDecimals = 18;
28
-
29
- // Mocks
30
- IJBToken _token = IJBToken(makeAddr("token"));
31
- IJBRulesetDataHook _dataHook = IJBRulesetDataHook(makeAddr("dataHook"));
32
- IJBPayHook _payHook = IJBPayHook(makeAddr("payHook"));
33
-
34
- uint32 _currency = uint32(uint160(address(_token)));
35
- uint32 _nativeCurrency = uint32(uint160(JBConstants.NATIVE_TOKEN));
36
-
37
- function setUp() public {
38
- super.terminalStoreSetup();
39
- }
40
-
41
- function test_WhenCurrentRulesetCycleNumberIsZero() external {
42
- // it will revert INVALID_RULESET
43
-
44
- // call params
45
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
46
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
47
- });
48
-
49
- // JBRulesets return calldata
50
- JBRuleset memory _returnedRuleset = JBRuleset({
51
- cycleNumber: 0,
52
- id: uint48(block.timestamp),
53
- basedOnId: 0,
54
- start: uint48(block.timestamp),
55
- duration: uint32(block.timestamp + 1000),
56
- weight: 1e18,
57
- weightCutPercent: 0,
58
- approvalHook: IJBRulesetApprovalHook(address(0)),
59
- metadata: 0
60
- });
61
-
62
- bytes memory _currentOfCall = abi.encodeCall(IJBRulesets.currentOf, (_projectId));
63
- bytes memory _currentOfReturn = abi.encode(_returnedRuleset);
64
- mockExpect(address(rulesets), _currentOfCall, _currentOfReturn);
65
-
66
- vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_RulesetNotFound.selector, _projectId));
67
- _store.recordPaymentFrom({
68
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
69
- });
70
- }
71
-
72
- function test_WhenCurrentRulesetPausePayEqTrue() external {
73
- // it will revert RULESET_PAYMENT_PAUSED
74
-
75
- // call params
76
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
77
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
78
- });
79
-
80
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
81
- reservedPercent: 0,
82
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
83
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
84
- pausePay: true,
85
- pauseCreditTransfers: false,
86
- allowOwnerMinting: false,
87
- allowSetCustomToken: false,
88
- allowTerminalMigration: false,
89
- allowSetTerminals: false,
90
- ownerMustSendPayouts: false,
91
- allowSetController: false,
92
- allowAddAccountingContext: true,
93
- allowAddPriceFeed: false,
94
- holdFees: false,
95
- useTotalSurplusForCashOuts: false,
96
- useDataHookForPay: false,
97
- useDataHookForCashOut: false,
98
- dataHook: address(0),
99
- metadata: 0
100
- });
101
-
102
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
103
-
104
- // JBRulesets return calldata
105
- JBRuleset memory _returnedRuleset = JBRuleset({
106
- cycleNumber: uint48(block.timestamp),
107
- id: uint48(block.timestamp),
108
- basedOnId: 0,
109
- start: uint48(block.timestamp),
110
- duration: uint32(block.timestamp + 1000),
111
- weight: 1e18,
112
- weightCutPercent: 0,
113
- approvalHook: IJBRulesetApprovalHook(address(0)),
114
- metadata: _packedMetadata
115
- });
116
-
117
- bytes memory _currentOfCall = abi.encodeCall(IJBRulesets.currentOf, (_projectId));
118
- bytes memory _currentOfReturn = abi.encode(_returnedRuleset);
119
- mockExpect(address(rulesets), _currentOfCall, _currentOfReturn);
120
-
121
- vm.expectRevert(JBTerminalStore.JBTerminalStore_RulesetPaymentPaused.selector);
122
- _store.recordPaymentFrom({
123
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
124
- });
125
- }
126
-
127
- modifier whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress() {
128
- _;
129
- }
130
-
131
- function test_GivenTheHookReturnsANonZeroSpecifiedAmount()
132
- external
133
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
134
- {
135
- // it will decrement the amount being added to the local balance
136
-
137
- // call params
138
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
139
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
140
- });
141
-
142
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
143
- reservedPercent: 0,
144
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
145
- baseCurrency: uint32(uint160(address(_token))),
146
- pausePay: false,
147
- pauseCreditTransfers: false,
148
- allowOwnerMinting: false,
149
- allowSetCustomToken: false,
150
- allowTerminalMigration: false,
151
- allowSetTerminals: false,
152
- ownerMustSendPayouts: false,
153
- allowSetController: false,
154
- allowAddAccountingContext: true,
155
- allowAddPriceFeed: false,
156
- holdFees: false,
157
- useTotalSurplusForCashOuts: false,
158
- useDataHookForPay: true,
159
- useDataHookForCashOut: false,
160
- dataHook: address(_dataHook),
161
- metadata: 0
162
- });
163
-
164
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
165
-
166
- // JBRulesets return calldata
167
- JBRuleset memory _returnedRuleset = JBRuleset({
168
- cycleNumber: uint48(block.timestamp),
169
- id: uint48(block.timestamp),
170
- basedOnId: 0,
171
- start: uint48(block.timestamp),
172
- duration: uint32(block.timestamp + 1000),
173
- weight: 1e18,
174
- weightCutPercent: 0,
175
- approvalHook: IJBRulesetApprovalHook(address(0)),
176
- metadata: _packedMetadata
177
- });
178
-
179
- // mock call to JBRulesets currentOf
180
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
181
-
182
- // params for data hook beforePayRecordedWith
183
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
184
- terminal: address(this),
185
- payer: address(this),
186
- amount: _tokenAmount,
187
- projectId: _projectId,
188
- rulesetId: uint48(block.timestamp),
189
- beneficiary: address(this),
190
- weight: _returnedRuleset.weight,
191
- reservedPercent: _returnedRuleset.reservedPercent(),
192
- metadata: ""
193
- });
194
-
195
- // return data
196
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
197
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue / 2, metadata: ""});
198
-
199
- // mock call to the configured JBRulesetDataHook beforePayRecordedWith
200
- bytes memory _beforePayCall = abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context));
201
- bytes memory _beforePayReturn = abi.encode(1e18 / 2, _spec);
202
- mockExpect(address(_dataHook), _beforePayCall, _beforePayReturn);
203
-
204
- (, uint256 tokenCount,) = _store.recordPaymentFrom({
205
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
206
- });
207
-
208
- assertEq(tokenCount, 1e18 / 2);
209
- }
210
-
211
- function test_GivenTheHookReturnsInvalidSpecifiedAmount()
212
- external
213
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
214
- {
215
- // it will revert INVALID_AMOUNT_TO_SEND_HOOK
216
-
217
- // call params
218
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
219
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
220
- });
221
-
222
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
223
- reservedPercent: 0,
224
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
225
- baseCurrency: uint32(uint160(address(_token))),
226
- pausePay: false,
227
- pauseCreditTransfers: false,
228
- allowOwnerMinting: false,
229
- allowSetCustomToken: false,
230
- allowTerminalMigration: false,
231
- allowSetTerminals: false,
232
- ownerMustSendPayouts: false,
233
- allowSetController: false,
234
- allowAddAccountingContext: true,
235
- allowAddPriceFeed: false,
236
- holdFees: false,
237
- useTotalSurplusForCashOuts: false,
238
- useDataHookForPay: true,
239
- useDataHookForCashOut: false,
240
- dataHook: address(_dataHook),
241
- metadata: 0
242
- });
243
-
244
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
245
-
246
- // JBRulesets return calldata
247
- JBRuleset memory _returnedRuleset = JBRuleset({
248
- cycleNumber: uint48(block.timestamp),
249
- id: uint48(block.timestamp),
250
- basedOnId: 0,
251
- start: uint48(block.timestamp),
252
- duration: uint32(block.timestamp + 1000),
253
- weight: 1e18,
254
- weightCutPercent: 0,
255
- approvalHook: IJBRulesetApprovalHook(address(0)),
256
- metadata: _packedMetadata
257
- });
258
-
259
- // mock call to JBRulesets currentOf
260
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
261
-
262
- // params for data hook beforePayRecordedWith
263
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
264
- terminal: address(this),
265
- payer: address(this),
266
- amount: _tokenAmount,
267
- projectId: _projectId,
268
- rulesetId: uint48(block.timestamp),
269
- beneficiary: address(this),
270
- weight: _returnedRuleset.weight,
271
- reservedPercent: _returnedRuleset.reservedPercent(),
272
- metadata: ""
273
- });
274
-
275
- // return data
276
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
277
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue * 2, metadata: ""});
278
-
279
- // mock call to the configured JBRulesetDataHook beforePayRecordedWith
280
- bytes memory _beforePayCall = abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context));
281
- bytes memory _beforePayReturn = abi.encode(1e18 / 2, _spec);
282
- mockExpect(address(_dataHook), _beforePayCall, _beforePayReturn);
283
-
284
- vm.expectRevert(
285
- abi.encodeWithSelector(
286
- JBTerminalStore.JBTerminalStore_InvalidAmountToForwardHook.selector,
287
- _defaultValue * 2,
288
- _tokenAmount.value
289
- )
290
- );
291
- _store.recordPaymentFrom({
292
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
293
- });
294
- }
295
-
296
- function test_GivenTheHookReturnsANoopSpecWithAmount()
297
- external
298
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
299
- {
300
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
301
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
302
- });
303
-
304
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
305
- reservedPercent: 0,
306
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
307
- baseCurrency: uint32(uint160(address(_token))),
308
- pausePay: false,
309
- pauseCreditTransfers: false,
310
- allowOwnerMinting: false,
311
- allowSetCustomToken: false,
312
- allowTerminalMigration: false,
313
- allowSetTerminals: false,
314
- ownerMustSendPayouts: false,
315
- allowSetController: false,
316
- allowAddAccountingContext: true,
317
- allowAddPriceFeed: false,
318
- holdFees: false,
319
- useTotalSurplusForCashOuts: false,
320
- useDataHookForPay: true,
321
- useDataHookForCashOut: false,
322
- dataHook: address(_dataHook),
323
- metadata: 0
324
- });
325
-
326
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
327
-
328
- JBRuleset memory _returnedRuleset = JBRuleset({
329
- cycleNumber: uint48(block.timestamp),
330
- id: uint48(block.timestamp),
331
- basedOnId: 0,
332
- start: uint48(block.timestamp),
333
- duration: uint32(block.timestamp + 1000),
334
- weight: 1e18,
335
- weightCutPercent: 0,
336
- approvalHook: IJBRulesetApprovalHook(address(0)),
337
- metadata: _packedMetadata
338
- });
339
-
340
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
341
-
342
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
343
- terminal: address(this),
344
- payer: address(this),
345
- amount: _tokenAmount,
346
- projectId: _projectId,
347
- rulesetId: uint48(block.timestamp),
348
- beneficiary: address(this),
349
- weight: _returnedRuleset.weight,
350
- reservedPercent: _returnedRuleset.reservedPercent(),
351
- metadata: ""
352
- });
353
-
354
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
355
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: true, amount: 1, metadata: ""});
356
-
357
- mockExpect(
358
- address(_dataHook),
359
- abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
360
- abi.encode(1e18 / 2, _spec)
361
- );
362
-
363
- vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_NoopHookSpecHasAmount.selector, 1));
364
- _store.recordPaymentFrom({
365
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
366
- });
367
- }
368
-
369
- function test_GivenALaterHookReturnsANoopSpecWithAmount()
370
- external
371
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
372
- {
373
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
374
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
375
- });
376
-
377
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
378
- reservedPercent: 0,
379
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
380
- baseCurrency: uint32(uint160(address(_token))),
381
- pausePay: false,
382
- pauseCreditTransfers: false,
383
- allowOwnerMinting: false,
384
- allowSetCustomToken: false,
385
- allowTerminalMigration: false,
386
- allowSetTerminals: false,
387
- ownerMustSendPayouts: false,
388
- allowSetController: false,
389
- allowAddAccountingContext: true,
390
- allowAddPriceFeed: false,
391
- holdFees: false,
392
- useTotalSurplusForCashOuts: false,
393
- useDataHookForPay: true,
394
- useDataHookForCashOut: false,
395
- dataHook: address(_dataHook),
396
- metadata: 0
397
- });
398
-
399
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
400
-
401
- JBRuleset memory _returnedRuleset = JBRuleset({
402
- cycleNumber: uint48(block.timestamp),
403
- id: uint48(block.timestamp),
404
- basedOnId: 0,
405
- start: uint48(block.timestamp),
406
- duration: uint32(block.timestamp + 1000),
407
- weight: 1e18,
408
- weightCutPercent: 0,
409
- approvalHook: IJBRulesetApprovalHook(address(0)),
410
- metadata: _packedMetadata
411
- });
412
-
413
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
414
-
415
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
416
- terminal: address(this),
417
- payer: address(this),
418
- amount: _tokenAmount,
419
- projectId: _projectId,
420
- rulesetId: uint48(block.timestamp),
421
- beneficiary: address(this),
422
- weight: _returnedRuleset.weight,
423
- reservedPercent: _returnedRuleset.reservedPercent(),
424
- metadata: ""
425
- });
426
-
427
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](2);
428
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: 0, metadata: ""});
429
- _spec[1] = JBPayHookSpecification({hook: _payHook, noop: true, amount: 1, metadata: ""});
430
-
431
- mockExpect(
432
- address(_dataHook),
433
- abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
434
- abi.encode(1e18 / 2, _spec)
435
- );
436
-
437
- vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_NoopHookSpecHasAmount.selector, 1));
438
- _store.recordPaymentFrom({
439
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
440
- });
441
- }
442
-
443
- function test_GivenTheHookReturnsANoopSpecWithAmountThatExceedsPayment()
444
- external
445
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
446
- {
447
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
448
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
449
- });
450
-
451
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
452
- reservedPercent: 0,
453
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
454
- baseCurrency: uint32(uint160(address(_token))),
455
- pausePay: false,
456
- pauseCreditTransfers: false,
457
- allowOwnerMinting: false,
458
- allowSetCustomToken: false,
459
- allowTerminalMigration: false,
460
- allowSetTerminals: false,
461
- ownerMustSendPayouts: false,
462
- allowSetController: false,
463
- allowAddAccountingContext: true,
464
- allowAddPriceFeed: false,
465
- holdFees: false,
466
- useTotalSurplusForCashOuts: false,
467
- useDataHookForPay: true,
468
- useDataHookForCashOut: false,
469
- dataHook: address(_dataHook),
470
- metadata: 0
471
- });
472
-
473
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
474
-
475
- JBRuleset memory _returnedRuleset = JBRuleset({
476
- cycleNumber: uint48(block.timestamp),
477
- id: uint48(block.timestamp),
478
- basedOnId: 0,
479
- start: uint48(block.timestamp),
480
- duration: uint32(block.timestamp + 1000),
481
- weight: 1e18,
482
- weightCutPercent: 0,
483
- approvalHook: IJBRulesetApprovalHook(address(0)),
484
- metadata: _packedMetadata
485
- });
486
-
487
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
488
-
489
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
490
- terminal: address(this),
491
- payer: address(this),
492
- amount: _tokenAmount,
493
- projectId: _projectId,
494
- rulesetId: uint48(block.timestamp),
495
- beneficiary: address(this),
496
- weight: _returnedRuleset.weight,
497
- reservedPercent: _returnedRuleset.reservedPercent(),
498
- metadata: ""
499
- });
500
-
501
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
502
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: true, amount: _defaultValue * 2, metadata: ""});
503
-
504
- mockExpect(
505
- address(_dataHook),
506
- abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
507
- abi.encode(1e18 / 2, _spec)
508
- );
509
-
510
- vm.expectRevert(
511
- abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_NoopHookSpecHasAmount.selector, _defaultValue * 2)
512
- );
513
- _store.recordPaymentFrom({
514
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
515
- });
516
- }
517
-
518
- function test_GivenWeightReturnedByTheHookIsZero()
519
- external
520
- whenCurrentRulesetUseDataHookForPayEqTrueAndTheHookDneqZeroAddress
521
- {
522
- // it will return zero as the tokenCount
523
-
524
- // call params
525
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
526
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
527
- });
528
-
529
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
530
- reservedPercent: 0,
531
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
532
- baseCurrency: uint32(uint160(address(_token))),
533
- pausePay: false,
534
- pauseCreditTransfers: false,
535
- allowOwnerMinting: false,
536
- allowSetCustomToken: false,
537
- allowTerminalMigration: false,
538
- allowSetTerminals: false,
539
- ownerMustSendPayouts: false,
540
- allowSetController: false,
541
- allowAddAccountingContext: true,
542
- allowAddPriceFeed: false,
543
- holdFees: false,
544
- useTotalSurplusForCashOuts: false,
545
- useDataHookForPay: true,
546
- useDataHookForCashOut: false,
547
- dataHook: address(_dataHook),
548
- metadata: 0
549
- });
550
-
551
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
552
-
553
- // JBRulesets return calldata
554
- JBRuleset memory _returnedRuleset = JBRuleset({
555
- cycleNumber: uint48(block.timestamp),
556
- id: uint48(block.timestamp),
557
- basedOnId: 0,
558
- start: uint48(block.timestamp),
559
- duration: uint32(block.timestamp + 1000),
560
- weight: 1e18,
561
- weightCutPercent: 0,
562
- approvalHook: IJBRulesetApprovalHook(address(0)),
563
- metadata: _packedMetadata
564
- });
565
-
566
- // mock call to JBRulesets currentOf
567
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
568
-
569
- // params for data hook beforePayRecordedWith
570
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
571
- terminal: address(this),
572
- payer: address(this),
573
- amount: _tokenAmount,
574
- projectId: _projectId,
575
- rulesetId: uint48(block.timestamp),
576
- beneficiary: address(this),
577
- weight: _returnedRuleset.weight,
578
- reservedPercent: _returnedRuleset.reservedPercent(),
579
- metadata: ""
580
- });
581
-
582
- // return data
583
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
584
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue / 2, metadata: ""});
585
-
586
- // mock call to the configured JBRulesetDataHook beforePayRecordedWith
587
- bytes memory _beforePayCall = abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context));
588
- bytes memory _beforePayReturn = abi.encode(0, _spec);
589
- mockExpect(address(_dataHook), _beforePayCall, _beforePayReturn);
590
-
591
- (, uint256 tokenCount,) = _store.recordPaymentFrom({
592
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
593
- });
594
-
595
- assertEq(tokenCount, 0);
596
- }
597
-
598
- function test_WhenAHookIsNotConfigured() external {
599
- // it will derive weight from the ruleset
600
-
601
- // call params
602
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
603
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
604
- });
605
-
606
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
607
- reservedPercent: 0,
608
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
609
- baseCurrency: uint32(uint160(address(_token))),
610
- pausePay: false,
611
- pauseCreditTransfers: false,
612
- allowOwnerMinting: false,
613
- allowSetCustomToken: false,
614
- allowTerminalMigration: false,
615
- allowSetTerminals: false,
616
- ownerMustSendPayouts: false,
617
- allowSetController: false,
618
- allowAddAccountingContext: true,
619
- allowAddPriceFeed: false,
620
- holdFees: false,
621
- useTotalSurplusForCashOuts: false,
622
- useDataHookForPay: true,
623
- useDataHookForCashOut: false,
624
- // hook not configured
625
- dataHook: address(0),
626
- metadata: 0
627
- });
628
-
629
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
630
-
631
- // JBRulesets return calldata
632
- JBRuleset memory _returnedRuleset = JBRuleset({
633
- cycleNumber: uint48(block.timestamp),
634
- id: uint48(block.timestamp),
635
- basedOnId: 0,
636
- start: uint48(block.timestamp),
637
- duration: uint32(block.timestamp + 1000),
638
- weight: 1e18,
639
- weightCutPercent: 0,
640
- approvalHook: IJBRulesetApprovalHook(address(0)),
641
- metadata: _packedMetadata
642
- });
643
-
644
- // mock call to JBRulesets currentOf
645
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
646
-
647
- // return data
648
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
649
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue / 2, metadata: ""});
650
-
651
- (, uint256 tokenCount,) = _store.recordPaymentFrom({
652
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
653
- });
654
-
655
- assertEq(tokenCount, 1e18);
656
- }
657
-
658
- function test_WhenTheTerminalShouldBaseItsWeightOnACurrencyOtherThanTheRulesetBaseCurrency() external {
659
- // it will return an adjusted weightRatio
660
-
661
- // call params
662
- JBTokenAmount memory _tokenAmount = JBTokenAmount({
663
- token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
664
- });
665
-
666
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
667
- reservedPercent: 0,
668
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
669
- baseCurrency: _nativeCurrency,
670
- pausePay: false,
671
- pauseCreditTransfers: false,
672
- allowOwnerMinting: false,
673
- allowSetCustomToken: false,
674
- allowTerminalMigration: false,
675
- allowSetTerminals: false,
676
- ownerMustSendPayouts: false,
677
- allowSetController: false,
678
- allowAddAccountingContext: true,
679
- allowAddPriceFeed: false,
680
- holdFees: false,
681
- useTotalSurplusForCashOuts: false,
682
- useDataHookForPay: true,
683
- useDataHookForCashOut: false,
684
- dataHook: address(_dataHook),
685
- metadata: 0
686
- });
687
-
688
- uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
689
-
690
- // JBRulesets return calldata
691
- JBRuleset memory _returnedRuleset = JBRuleset({
692
- cycleNumber: uint48(block.timestamp),
693
- id: uint48(block.timestamp),
694
- basedOnId: 0,
695
- start: uint48(block.timestamp),
696
- duration: uint32(block.timestamp + 1000),
697
- weight: 1e18,
698
- weightCutPercent: 0,
699
- approvalHook: IJBRulesetApprovalHook(address(0)),
700
- metadata: _packedMetadata
701
- });
702
-
703
- // mock call to JBRulesets currentOf
704
- mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
705
-
706
- // params for data hook beforePayRecordedWith
707
- JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
708
- terminal: address(this),
709
- payer: address(this),
710
- amount: _tokenAmount,
711
- projectId: _projectId,
712
- rulesetId: uint48(block.timestamp),
713
- beneficiary: address(this),
714
- weight: _returnedRuleset.weight,
715
- reservedPercent: _returnedRuleset.reservedPercent(),
716
- metadata: ""
717
- });
718
-
719
- // return data
720
- JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
721
- _spec[0] = JBPayHookSpecification({hook: _payHook, noop: false, amount: _defaultValue / 2, metadata: ""});
722
-
723
- // mock call to the configured JBRulesetDataHook beforePayRecordedWith
724
- mockExpect(
725
- address(_dataHook),
726
- abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
727
- abi.encode(1e18 / 2, _spec)
728
- );
729
-
730
- // mock call to JBPrices pricePerUnitOf
731
- bytes memory _pricePerCall =
732
- abi.encodeCall(IJBPrices.pricePerUnitOf, (_projectId, _currency, _nativeCurrency, 18));
733
- bytes memory _pricePerReturn = abi.encode(2e18);
734
- mockExpect(address(prices), _pricePerCall, _pricePerReturn);
735
-
736
- uint256 expectedCount = mulDiv(_defaultValue, 1e18 / 2, 2e18);
737
-
738
- (, uint256 tokenCount,) = _store.recordPaymentFrom({
739
- payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
740
- });
741
-
742
- assertEq(tokenCount, expectedCount);
743
- }
744
- }