@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,360 +0,0 @@
1
- // SPDX-License-Identifier: MIT
2
- pragma solidity >=0.8.6;
3
-
4
- import {TestBaseWorkflow} from "./helpers/TestBaseWorkflow.sol";
5
- import {MetadataResolverHelper} from "./helpers/MetadataResolverHelper.sol";
6
- import {IJBController} from "../src/interfaces/IJBController.sol";
7
- import {IJBPrices} from "../src/interfaces/IJBPrices.sol";
8
- import {IJBRulesetApprovalHook} from "../src/interfaces/IJBRulesetApprovalHook.sol";
9
- import {IJBRulesetDataHook} from "../src/interfaces/IJBRulesetDataHook.sol";
10
- import {IJBTerminal} from "../src/interfaces/IJBTerminal.sol";
11
- import {IJBTokens} from "../src/interfaces/IJBTokens.sol";
12
- import {JBConstants} from "../src/libraries/JBConstants.sol";
13
- import {JBAccountingContext} from "../src/structs/JBAccountingContext.sol";
14
- import {JBFundAccessLimitGroup} from "../src/structs/JBFundAccessLimitGroup.sol";
15
- import {JBPayHookSpecification} from "../src/structs/JBPayHookSpecification.sol";
16
- import {JBRulesetConfig} from "../src/structs/JBRulesetConfig.sol";
17
- import {JBRulesetMetadata} from "../src/structs/JBRulesetMetadata.sol";
18
- import {JBSingleAllowance} from "../src/structs/JBSingleAllowance.sol";
19
- import {JBSplitGroup} from "../src/structs/JBSplitGroup.sol";
20
- import {JBTerminalConfig} from "../src/structs/JBTerminalConfig.sol";
21
- import {IAllowanceTransfer, IPermit2} from "@uniswap/permit2/src/interfaces/IPermit2.sol";
22
- import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
23
- import {MockPriceFeed} from "./mock/MockPriceFeed.sol";
24
- import {mulDiv} from "@prb/math/src/Common.sol";
25
-
26
- /// @notice Tests combining Permit2 ERC-20 transfers with data hook weight overrides.
27
- contract TestPermit2DataHook_Local is TestBaseWorkflow {
28
- uint112 private constant _WEIGHT = uint112(1000 * 10 ** 18);
29
- address private constant _DATA_HOOK = address(bytes20(keccak256("permit2datahook")));
30
-
31
- IJBController private _controller;
32
- IJBTerminal private _terminal;
33
- IJBPrices private _prices;
34
- IJBTokens private _tokens;
35
- IERC20 private _usdc;
36
- IPermit2 private _permit2;
37
- MetadataResolverHelper private _helper;
38
- address private _projectOwner;
39
-
40
- uint256 _projectId;
41
-
42
- // Permit2 params.
43
- // forge-lint: disable-next-line(mixed-case-variable)
44
- bytes32 DOMAIN_SEPARATOR;
45
- address from;
46
- uint256 fromPrivateKey;
47
-
48
- // Price.
49
- uint256 _nativePricePerUsd = 0.0005 * 10 ** 18; // 1/2000
50
-
51
- function setUp() public override {
52
- super.setUp();
53
-
54
- vm.label(_DATA_HOOK, "Data Hook");
55
-
56
- _controller = jbController();
57
- _projectOwner = multisig();
58
- _terminal = jbMultiTerminal();
59
- _prices = jbPrices();
60
- _tokens = jbTokens();
61
- _helper = metadataHelper();
62
- _usdc = usdcToken();
63
- _permit2 = permit2();
64
-
65
- fromPrivateKey = 0x12341234;
66
- from = vm.addr(fromPrivateKey);
67
- DOMAIN_SEPARATOR = permit2().DOMAIN_SEPARATOR();
68
-
69
- // First project: fee collector with data hook disabled.
70
- JBRulesetMetadata memory _feeMetadata = JBRulesetMetadata({
71
- reservedPercent: 0,
72
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
73
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
74
- pausePay: false,
75
- pauseCreditTransfers: false,
76
- allowOwnerMinting: true,
77
- allowSetCustomToken: true,
78
- allowTerminalMigration: false,
79
- allowSetTerminals: false,
80
- ownerMustSendPayouts: false,
81
- allowSetController: false,
82
- allowAddAccountingContext: true,
83
- allowAddPriceFeed: true,
84
- holdFees: false,
85
- useTotalSurplusForCashOuts: false,
86
- useDataHookForPay: false,
87
- useDataHookForCashOut: false,
88
- dataHook: address(0),
89
- metadata: 0
90
- });
91
-
92
- JBRulesetConfig[] memory _feeRulesetConfig = new JBRulesetConfig[](1);
93
- _feeRulesetConfig[0].mustStartAtOrAfter = 0;
94
- _feeRulesetConfig[0].duration = 0;
95
- _feeRulesetConfig[0].weight = _WEIGHT;
96
- _feeRulesetConfig[0].weightCutPercent = 0;
97
- _feeRulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
98
- _feeRulesetConfig[0].metadata = _feeMetadata;
99
- _feeRulesetConfig[0].splitGroups = new JBSplitGroup[](0);
100
- _feeRulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
101
-
102
- JBTerminalConfig[] memory _terminalConfigurations = new JBTerminalConfig[](1);
103
- JBAccountingContext[] memory _tokensToAccept = new JBAccountingContext[](2);
104
- _tokensToAccept[0] = JBAccountingContext({
105
- token: JBConstants.NATIVE_TOKEN, decimals: 18, currency: uint32(uint160(JBConstants.NATIVE_TOKEN))
106
- });
107
- _tokensToAccept[1] = JBAccountingContext({
108
- token: address(usdcToken()), decimals: 6, currency: uint32(uint160(address(usdcToken())))
109
- });
110
- _terminalConfigurations[0] =
111
- JBTerminalConfig({terminal: _terminal, accountingContextsToAccept: _tokensToAccept});
112
-
113
- // Create fee project (project ID 1).
114
- _controller.launchProjectFor({
115
- owner: _projectOwner,
116
- projectUri: "feeProject",
117
- rulesetConfigurations: _feeRulesetConfig,
118
- terminalConfigurations: _terminalConfigurations,
119
- memo: ""
120
- });
121
-
122
- // Second project: data hook enabled for pay, uses USDC via Permit2.
123
- JBRulesetMetadata memory _metadata = JBRulesetMetadata({
124
- reservedPercent: 0,
125
- cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
126
- baseCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
127
- pausePay: false,
128
- pauseCreditTransfers: false,
129
- allowOwnerMinting: true,
130
- allowSetCustomToken: true,
131
- allowTerminalMigration: false,
132
- allowSetTerminals: false,
133
- ownerMustSendPayouts: false,
134
- allowSetController: false,
135
- allowAddAccountingContext: true,
136
- allowAddPriceFeed: true,
137
- holdFees: false,
138
- useTotalSurplusForCashOuts: false,
139
- useDataHookForPay: true,
140
- useDataHookForCashOut: false,
141
- dataHook: _DATA_HOOK,
142
- metadata: 0
143
- });
144
-
145
- JBRulesetConfig[] memory _rulesetConfig = new JBRulesetConfig[](1);
146
- _rulesetConfig[0].mustStartAtOrAfter = 0;
147
- _rulesetConfig[0].duration = 0;
148
- _rulesetConfig[0].weight = _WEIGHT;
149
- _rulesetConfig[0].weightCutPercent = 0;
150
- _rulesetConfig[0].approvalHook = IJBRulesetApprovalHook(address(0));
151
- _rulesetConfig[0].metadata = _metadata;
152
- _rulesetConfig[0].splitGroups = new JBSplitGroup[](0);
153
- _rulesetConfig[0].fundAccessLimitGroups = new JBFundAccessLimitGroup[](0);
154
-
155
- _projectId = _controller.launchProjectFor({
156
- owner: _projectOwner,
157
- projectUri: "permit2DataHookProject",
158
- rulesetConfigurations: _rulesetConfig,
159
- terminalConfigurations: _terminalConfigurations,
160
- memo: ""
161
- });
162
-
163
- vm.startPrank(_projectOwner);
164
- MockPriceFeed _priceFeedNativeUsd = new MockPriceFeed(_nativePricePerUsd, 18);
165
- vm.label(address(_priceFeedNativeUsd), "Mock Price Feed Native-USD");
166
-
167
- _controller.addPriceFeedFor({
168
- projectId: _projectId,
169
- pricingCurrency: uint32(uint160(JBConstants.NATIVE_TOKEN)),
170
- unitCurrency: uint32(uint160(address(usdcToken()))),
171
- feed: _priceFeedNativeUsd
172
- });
173
-
174
- vm.stopPrank();
175
- }
176
-
177
- /// @notice Builds Permit2 metadata for the given coin amount and nonce.
178
- function _buildPermit2Metadata(uint256 coins, uint48 nonce) internal view returns (bytes memory packedData) {
179
- uint256 deadline = block.timestamp + 1 days;
180
- // forge-lint: disable-next-line(unsafe-typecast)
181
- uint48 expiration = uint48(block.timestamp + 1 days);
182
-
183
- IAllowanceTransfer.PermitDetails memory details = IAllowanceTransfer.PermitDetails({
184
- token: address(_usdc),
185
- // forge-lint: disable-next-line(unsafe-typecast)
186
- amount: uint160(coins),
187
- expiration: expiration,
188
- nonce: nonce
189
- });
190
-
191
- IAllowanceTransfer.PermitSingle memory permitSingle =
192
- IAllowanceTransfer.PermitSingle({details: details, spender: address(_terminal), sigDeadline: deadline});
193
-
194
- bytes memory sig = getPermitSignature(permitSingle, fromPrivateKey, DOMAIN_SEPARATOR);
195
-
196
- JBSingleAllowance memory permitData = JBSingleAllowance({
197
- sigDeadline: deadline,
198
- // forge-lint: disable-next-line(unsafe-typecast)
199
- amount: uint160(coins),
200
- expiration: expiration,
201
- nonce: nonce,
202
- signature: sig
203
- });
204
-
205
- bytes4[] memory ids = new bytes4[](1);
206
- bytes[] memory datas = new bytes[](1);
207
- datas[0] = abi.encode(permitData);
208
- ids[0] = _helper.getId("permit2", address(_terminal));
209
-
210
- packedData = _helper.createMetadata(ids, datas);
211
- }
212
-
213
- /// @notice Pay via Permit2 with a data hook that returns the original weight -- tokens should match normal
214
- /// issuance.
215
- function test_permit2_withDataHook_paySucceeds() public {
216
- uint256 _coins = 1_000_000; // 1 USDC (6 decimals)
217
-
218
- // Data hook returns the original weight and empty hook specifications.
219
- JBPayHookSpecification[] memory _emptySpecs = new JBPayHookSpecification[](0);
220
- vm.mockCall(
221
- _DATA_HOOK,
222
- abi.encodeWithSelector(IJBRulesetDataHook.beforePayRecordedWith.selector),
223
- abi.encode(uint256(_WEIGHT), _emptySpecs)
224
- );
225
-
226
- // Build Permit2 metadata.
227
- bytes memory _packedData = _buildPermit2Metadata(_coins, 0);
228
-
229
- // Setup: give coins and approve permit2 contract.
230
- deal(address(_usdc), from, _coins);
231
- vm.prank(from);
232
- IERC20(address(_usdc)).approve(address(permit2()), _coins);
233
-
234
- // Pay using Permit2 with data hook.
235
- vm.prank(from);
236
- uint256 _minted = _terminal.pay({
237
- projectId: _projectId,
238
- amount: _coins,
239
- token: address(_usdc),
240
- beneficiary: from,
241
- minReturnedTokens: 0,
242
- memo: "Permit2 + data hook",
243
- metadata: _packedData
244
- });
245
-
246
- // Check: tokens were transferred.
247
- assertEq(_usdc.balanceOf(address(_terminal)), _coins, "terminal should hold the USDC");
248
-
249
- // Check: payer receives project tokens.
250
- assertEq(_tokens.totalBalanceOf(from, _projectId), _minted, "payer should have minted tokens");
251
-
252
- // Check: minted amount matches expected calculation.
253
- // The baseCurrency is NATIVE_TOKEN (ETH), so USDC amounts get converted via price feed.
254
- // 1 USDC = 0.0005 ETH (from _nativePricePerUsd). So 1e6 USDC = 0.0005e18 = 5e14 ETH.
255
- // Token count = ethEquivalent * weight / 10^18
256
- // ethEquivalent = _coins * 10^12 (6->18 decimals) * _nativePricePerUsd / 10^18
257
- uint256 adjustedAmount = _coins * 10 ** 12; // adjust from 6 to 18 decimals
258
- uint256 ethEquivalent = mulDiv(adjustedAmount, _nativePricePerUsd, 10 ** 18);
259
- uint256 expectedTokens = mulDiv(ethEquivalent, _WEIGHT, 10 ** 18);
260
- assertEq(_minted, expectedTokens, "minted tokens should match weight calculation");
261
- }
262
-
263
- /// @notice Pay via Permit2 with a data hook that modifies the weight (2x) -- tokens should reflect the modified
264
- /// weight.
265
- function test_permit2_withDataHook_hookModifiesWeight() public {
266
- uint256 _coins = 500_000; // 0.5 USDC (6 decimals)
267
-
268
- // Data hook returns 2x the original weight.
269
- uint256 _modifiedWeight = uint256(_WEIGHT) * 2;
270
- JBPayHookSpecification[] memory _emptySpecs = new JBPayHookSpecification[](0);
271
- vm.mockCall(
272
- _DATA_HOOK,
273
- abi.encodeWithSelector(IJBRulesetDataHook.beforePayRecordedWith.selector),
274
- abi.encode(_modifiedWeight, _emptySpecs)
275
- );
276
-
277
- // Build Permit2 metadata.
278
- bytes memory _packedData = _buildPermit2Metadata(_coins, 0);
279
-
280
- // Setup: give coins and approve permit2 contract.
281
- deal(address(_usdc), from, _coins);
282
- vm.prank(from);
283
- IERC20(address(_usdc)).approve(address(permit2()), _coins);
284
-
285
- // Pay using Permit2 with data hook.
286
- vm.prank(from);
287
- uint256 _minted = _terminal.pay({
288
- projectId: _projectId,
289
- amount: _coins,
290
- token: address(_usdc),
291
- beneficiary: from,
292
- minReturnedTokens: 0,
293
- memo: "Permit2 + modified weight",
294
- metadata: _packedData
295
- });
296
-
297
- // Check: correct ERC-20 amount transferred via Permit2.
298
- assertEq(_usdc.balanceOf(address(_terminal)), _coins, "terminal should hold the USDC");
299
-
300
- // Check: tokens minted matches the MODIFIED weight (2x), not the original.
301
- // USDC amounts are converted to ETH via price feed before token calculation.
302
- // 500_000 USDC (0.5 USDC) = 0.00025 ETH = 2.5e14 at 18 decimals.
303
- // Token count = ethEquivalent * modifiedWeight / 10^18
304
- uint256 adjustedAmount = _coins * 10 ** 12; // adjust from 6 to 18 decimals
305
- uint256 ethEquivalent = mulDiv(adjustedAmount, _nativePricePerUsd, 10 ** 18);
306
- uint256 expectedTokens = mulDiv(ethEquivalent, _modifiedWeight, 10 ** 18);
307
- assertEq(_minted, expectedTokens, "minted tokens should match 2x modified weight");
308
-
309
- // Check: payer balance matches.
310
- assertEq(_tokens.totalBalanceOf(from, _projectId), _minted, "payer should have all minted tokens");
311
- }
312
-
313
- /// Permit2 signature helpers.
314
- /// (required because `permit2/test/utils/PermitSignature.sol` imports `draft-EIP712.sol` which is no longer a
315
- /// draft.)
316
-
317
- bytes32 public constant _PERMIT_DETAILS_TYPEHASH =
318
- keccak256("PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)");
319
-
320
- bytes32 public constant _PERMIT_SINGLE_TYPEHASH = keccak256(
321
- "PermitSingle(PermitDetails details,address spender,uint256 sigDeadline)PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)"
322
- );
323
-
324
- function getPermitSignatureRaw(
325
- IAllowanceTransfer.PermitSingle memory permitSingle,
326
- uint256 privateKey,
327
- bytes32 domainSeparator
328
- )
329
- internal
330
- pure
331
- returns (uint8 v, bytes32 r, bytes32 s)
332
- {
333
- bytes32 permitHash = keccak256(abi.encode(_PERMIT_DETAILS_TYPEHASH, permitSingle.details));
334
-
335
- bytes32 msgHash = keccak256(
336
- abi.encodePacked(
337
- "\x19\x01",
338
- domainSeparator,
339
- keccak256(
340
- abi.encode(_PERMIT_SINGLE_TYPEHASH, permitHash, permitSingle.spender, permitSingle.sigDeadline)
341
- )
342
- )
343
- );
344
-
345
- (v, r, s) = vm.sign(privateKey, msgHash);
346
- }
347
-
348
- function getPermitSignature(
349
- IAllowanceTransfer.PermitSingle memory permitSingle,
350
- uint256 privateKey,
351
- bytes32 domainSeparator
352
- )
353
- internal
354
- pure
355
- returns (bytes memory sig)
356
- {
357
- (uint8 v, bytes32 r, bytes32 s) = getPermitSignatureRaw(permitSingle, privateKey, domainSeparator);
358
- return bytes.concat(r, s, bytes1(v));
359
- }
360
- }