@bananapus/core-v6 0.0.17 → 0.0.19

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 (107) hide show
  1. package/CHANGE_LOG.md +53 -13
  2. package/SKILLS.md +6 -0
  3. package/USER_JOURNEYS.md +4 -0
  4. package/package.json +1 -1
  5. package/src/JBTerminalStore.sol +357 -171
  6. package/src/interfaces/IJBTerminalStore.sol +70 -0
  7. package/test/fork/TestSequencerPriceFeedFork.sol +168 -0
  8. package/test/units/static/JBTerminalStore/TestCurrentReclaimableSurplusOf.sol +215 -0
  9. package/test/units/static/JBTerminalStore/TestPreviewCashOutFrom.sol +383 -0
  10. package/test/units/static/JBTerminalStore/TestPreviewPayFrom.sol +415 -0
  11. package/docs/book.css +0 -13
  12. package/docs/book.toml +0 -12
  13. package/docs/solidity.min.js +0 -74
  14. package/docs/src/README.md +0 -703
  15. package/docs/src/SUMMARY.md +0 -94
  16. package/docs/src/src/JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md +0 -83
  17. package/docs/src/src/JBChainlinkV3SequencerPriceFeed.sol/contract.JBChainlinkV3SequencerPriceFeed.md +0 -88
  18. package/docs/src/src/JBController.sol/contract.JBController.md +0 -1121
  19. package/docs/src/src/JBDeadline.sol/contract.JBDeadline.md +0 -84
  20. package/docs/src/src/JBDirectory.sol/contract.JBDirectory.md +0 -294
  21. package/docs/src/src/JBERC20.sol/contract.JBERC20.md +0 -190
  22. package/docs/src/src/JBFeelessAddresses.sol/contract.JBFeelessAddresses.md +0 -80
  23. package/docs/src/src/JBFundAccessLimits.sol/contract.JBFundAccessLimits.md +0 -253
  24. package/docs/src/src/JBMultiTerminal.sol/contract.JBMultiTerminal.md +0 -1472
  25. package/docs/src/src/JBPermissions.sol/contract.JBPermissions.md +0 -199
  26. package/docs/src/src/JBPrices.sol/contract.JBPrices.md +0 -154
  27. package/docs/src/src/JBProjects.sol/contract.JBProjects.md +0 -131
  28. package/docs/src/src/JBRulesets.sol/contract.JBRulesets.md +0 -677
  29. package/docs/src/src/JBSplits.sol/contract.JBSplits.md +0 -237
  30. package/docs/src/src/JBTerminalStore.sol/contract.JBTerminalStore.md +0 -591
  31. package/docs/src/src/JBTokens.sol/contract.JBTokens.md +0 -353
  32. package/docs/src/src/README.md +0 -25
  33. package/docs/src/src/abstract/JBControlled.sol/abstract.JBControlled.md +0 -64
  34. package/docs/src/src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md +0 -84
  35. package/docs/src/src/abstract/README.md +0 -5
  36. package/docs/src/src/enums/JBApprovalStatus.sol/enum.JBApprovalStatus.md +0 -17
  37. package/docs/src/src/enums/README.md +0 -4
  38. package/docs/src/src/interfaces/IJBCashOutHook.sol/interface.IJBCashOutHook.md +0 -29
  39. package/docs/src/src/interfaces/IJBCashOutTerminal.sol/interface.IJBCashOutTerminal.md +0 -57
  40. package/docs/src/src/interfaces/IJBControlled.sol/interface.IJBControlled.md +0 -12
  41. package/docs/src/src/interfaces/IJBController.sol/interface.IJBController.md +0 -334
  42. package/docs/src/src/interfaces/IJBDirectory.sol/interface.IJBDirectory.md +0 -108
  43. package/docs/src/src/interfaces/IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md +0 -19
  44. package/docs/src/src/interfaces/IJBFeeTerminal.sol/interface.IJBFeeTerminal.md +0 -91
  45. package/docs/src/src/interfaces/IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md +0 -26
  46. package/docs/src/src/interfaces/IJBFundAccessLimits.sol/interface.IJBFundAccessLimits.md +0 -88
  47. package/docs/src/src/interfaces/IJBMigratable.sol/interface.IJBMigratable.md +0 -29
  48. package/docs/src/src/interfaces/IJBMultiTerminal.sol/interface.IJBMultiTerminal.md +0 -50
  49. package/docs/src/src/interfaces/IJBPayHook.sol/interface.IJBPayHook.md +0 -28
  50. package/docs/src/src/interfaces/IJBPayoutTerminal.sol/interface.IJBPayoutTerminal.md +0 -105
  51. package/docs/src/src/interfaces/IJBPermissioned.sol/interface.IJBPermissioned.md +0 -12
  52. package/docs/src/src/interfaces/IJBPermissions.sol/interface.IJBPermissions.md +0 -74
  53. package/docs/src/src/interfaces/IJBPermitTerminal.sol/interface.IJBPermitTerminal.md +0 -15
  54. package/docs/src/src/interfaces/IJBPriceFeed.sol/interface.IJBPriceFeed.md +0 -12
  55. package/docs/src/src/interfaces/IJBPrices.sol/interface.IJBPrices.md +0 -74
  56. package/docs/src/src/interfaces/IJBProjectUriRegistry.sol/interface.IJBProjectUriRegistry.md +0 -19
  57. package/docs/src/src/interfaces/IJBProjects.sol/interface.IJBProjects.md +0 -49
  58. package/docs/src/src/interfaces/IJBRulesetApprovalHook.sol/interface.IJBRulesetApprovalHook.md +0 -35
  59. package/docs/src/src/interfaces/IJBRulesetDataHook.sol/interface.IJBRulesetDataHook.md +0 -97
  60. package/docs/src/src/interfaces/IJBRulesets.sol/interface.IJBRulesets.md +0 -165
  61. package/docs/src/src/interfaces/IJBSplitHook.sol/interface.IJBSplitHook.md +0 -31
  62. package/docs/src/src/interfaces/IJBSplits.sol/interface.IJBSplits.md +0 -35
  63. package/docs/src/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md +0 -141
  64. package/docs/src/src/interfaces/IJBTerminalStore.sol/interface.IJBTerminalStore.md +0 -198
  65. package/docs/src/src/interfaces/IJBToken.sol/interface.IJBToken.md +0 -54
  66. package/docs/src/src/interfaces/IJBTokenUriResolver.sol/interface.IJBTokenUriResolver.md +0 -12
  67. package/docs/src/src/interfaces/IJBTokens.sol/interface.IJBTokens.md +0 -151
  68. package/docs/src/src/interfaces/README.md +0 -33
  69. package/docs/src/src/libraries/JBCashOuts.sol/library.JBCashOuts.md +0 -40
  70. package/docs/src/src/libraries/JBConstants.sol/library.JBConstants.md +0 -52
  71. package/docs/src/src/libraries/JBCurrencyIds.sol/library.JBCurrencyIds.md +0 -19
  72. package/docs/src/src/libraries/JBFees.sol/library.JBFees.md +0 -52
  73. package/docs/src/src/libraries/JBFixedPointNumber.sol/library.JBFixedPointNumber.md +0 -12
  74. package/docs/src/src/libraries/JBMetadataResolver.sol/library.JBMetadataResolver.md +0 -242
  75. package/docs/src/src/libraries/JBRulesetMetadataResolver.sol/library.JBRulesetMetadataResolver.md +0 -180
  76. package/docs/src/src/libraries/JBSplitGroupIds.sol/library.JBSplitGroupIds.md +0 -14
  77. package/docs/src/src/libraries/JBSurplus.sol/library.JBSurplus.md +0 -44
  78. package/docs/src/src/libraries/README.md +0 -12
  79. package/docs/src/src/periphery/JBDeadline1Day.sol/contract.JBDeadline1Day.md +0 -15
  80. package/docs/src/src/periphery/JBDeadline3Days.sol/contract.JBDeadline3Days.md +0 -15
  81. package/docs/src/src/periphery/JBDeadline3Hours.sol/contract.JBDeadline3Hours.md +0 -15
  82. package/docs/src/src/periphery/JBDeadline7Days.sol/contract.JBDeadline7Days.md +0 -15
  83. package/docs/src/src/periphery/JBMatchingPriceFeed.sol/contract.JBMatchingPriceFeed.md +0 -22
  84. package/docs/src/src/periphery/README.md +0 -8
  85. package/docs/src/src/structs/JBAccountingContext.sol/struct.JBAccountingContext.md +0 -20
  86. package/docs/src/src/structs/JBAfterCashOutRecordedContext.sol/struct.JBAfterCashOutRecordedContext.md +0 -43
  87. package/docs/src/src/structs/JBAfterPayRecordedContext.sol/struct.JBAfterPayRecordedContext.md +0 -42
  88. package/docs/src/src/structs/JBBeforeCashOutRecordedContext.sol/struct.JBBeforeCashOutRecordedContext.md +0 -45
  89. package/docs/src/src/structs/JBBeforePayRecordedContext.sol/struct.JBBeforePayRecordedContext.md +0 -41
  90. package/docs/src/src/structs/JBCashOutHookSpecification.sol/struct.JBCashOutHookSpecification.md +0 -22
  91. package/docs/src/src/structs/JBCurrencyAmount.sol/struct.JBCurrencyAmount.md +0 -17
  92. package/docs/src/src/structs/JBFee.sol/struct.JBFee.md +0 -20
  93. package/docs/src/src/structs/JBFundAccessLimitGroup.sol/struct.JBFundAccessLimitGroup.md +0 -39
  94. package/docs/src/src/structs/JBPayHookSpecification.sol/struct.JBPayHookSpecification.md +0 -22
  95. package/docs/src/src/structs/JBPermissionsData.sol/struct.JBPermissionsData.md +0 -21
  96. package/docs/src/src/structs/JBRuleset.sol/struct.JBRuleset.md +0 -55
  97. package/docs/src/src/structs/JBRulesetConfig.sol/struct.JBRulesetConfig.md +0 -51
  98. package/docs/src/src/structs/JBRulesetMetadata.sol/struct.JBRulesetMetadata.md +0 -79
  99. package/docs/src/src/structs/JBRulesetWeightCache.sol/struct.JBRulesetWeightCache.md +0 -16
  100. package/docs/src/src/structs/JBRulesetWithMetadata.sol/struct.JBRulesetWithMetadata.md +0 -16
  101. package/docs/src/src/structs/JBSingleAllowance.sol/struct.JBSingleAllowance.md +0 -26
  102. package/docs/src/src/structs/JBSplit.sol/struct.JBSplit.md +0 -49
  103. package/docs/src/src/structs/JBSplitGroup.sol/struct.JBSplitGroup.md +0 -17
  104. package/docs/src/src/structs/JBSplitHookContext.sol/struct.JBSplitHookContext.md +0 -29
  105. package/docs/src/src/structs/JBTerminalConfig.sol/struct.JBTerminalConfig.md +0 -16
  106. package/docs/src/src/structs/JBTokenAmount.sol/struct.JBTokenAmount.md +0 -23
  107. package/docs/src/src/structs/README.md +0 -25
@@ -0,0 +1,415 @@
1
+ // SPDX-License-Identifier: MIT
2
+ pragma solidity 0.8.26;
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 TestPreviewPayFrom_Local is JBTerminalStoreSetup {
22
+ using JBRulesetMetadataResolver for JBRuleset;
23
+
24
+ uint64 _projectId = 1;
25
+ uint256 _defaultValue = 1e18;
26
+ uint8 _defaultDecimals = 18;
27
+
28
+ // Mocks
29
+ IJBToken _token = IJBToken(makeAddr("token"));
30
+ IJBRulesetDataHook _dataHook = IJBRulesetDataHook(makeAddr("dataHook"));
31
+ IJBPayHook _payHook = IJBPayHook(makeAddr("payHook"));
32
+ address _terminal = makeAddr("terminal");
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
+ JBTokenAmount memory _tokenAmount = JBTokenAmount({
45
+ token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
46
+ });
47
+
48
+ JBRuleset memory _returnedRuleset = JBRuleset({
49
+ cycleNumber: 0,
50
+ id: uint48(block.timestamp),
51
+ basedOnId: 0,
52
+ start: uint48(block.timestamp),
53
+ duration: uint32(block.timestamp + 1000),
54
+ weight: 1e18,
55
+ weightCutPercent: 0,
56
+ approvalHook: IJBRulesetApprovalHook(address(0)),
57
+ metadata: 0
58
+ });
59
+
60
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
61
+
62
+ vm.expectRevert(abi.encodeWithSelector(JBTerminalStore.JBTerminalStore_RulesetNotFound.selector, _projectId));
63
+ _store.previewPayFrom({
64
+ terminal: _terminal,
65
+ payer: address(this),
66
+ amount: _tokenAmount,
67
+ projectId: _projectId,
68
+ beneficiary: address(this),
69
+ metadata: ""
70
+ });
71
+ }
72
+
73
+ function test_WhenCurrentRulesetPausePayEqTrue() external {
74
+ // it will revert RULESET_PAYMENT_PAUSED
75
+
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
+ JBRuleset memory _returnedRuleset = JBRuleset({
105
+ cycleNumber: uint48(block.timestamp),
106
+ id: uint48(block.timestamp),
107
+ basedOnId: 0,
108
+ start: uint48(block.timestamp),
109
+ duration: uint32(block.timestamp + 1000),
110
+ weight: 1e18,
111
+ weightCutPercent: 0,
112
+ approvalHook: IJBRulesetApprovalHook(address(0)),
113
+ metadata: _packedMetadata
114
+ });
115
+
116
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
117
+
118
+ vm.expectRevert(JBTerminalStore.JBTerminalStore_RulesetPaymentPaused.selector);
119
+ _store.previewPayFrom({
120
+ terminal: _terminal,
121
+ payer: address(this),
122
+ amount: _tokenAmount,
123
+ projectId: _projectId,
124
+ beneficiary: address(this),
125
+ metadata: ""
126
+ });
127
+ }
128
+
129
+ function test_MatchesRecordPaymentFrom_NoDataHook() external {
130
+ // it returns the same tokenCount as recordPaymentFrom for a simple payment without a data hook
131
+
132
+ JBTokenAmount memory _tokenAmount = JBTokenAmount({
133
+ token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
134
+ });
135
+
136
+ JBRulesetMetadata memory _metadata = JBRulesetMetadata({
137
+ reservedPercent: 0,
138
+ cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
139
+ baseCurrency: uint32(uint160(address(_token))),
140
+ pausePay: false,
141
+ pauseCreditTransfers: false,
142
+ allowOwnerMinting: false,
143
+ allowSetCustomToken: false,
144
+ allowTerminalMigration: false,
145
+ allowSetTerminals: false,
146
+ ownerMustSendPayouts: false,
147
+ allowSetController: false,
148
+ allowAddAccountingContext: true,
149
+ allowAddPriceFeed: false,
150
+ holdFees: false,
151
+ useTotalSurplusForCashOuts: false,
152
+ useDataHookForPay: false,
153
+ useDataHookForCashOut: false,
154
+ dataHook: address(0),
155
+ metadata: 0
156
+ });
157
+
158
+ uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
159
+
160
+ JBRuleset memory _returnedRuleset = JBRuleset({
161
+ cycleNumber: uint48(block.timestamp),
162
+ id: uint48(block.timestamp),
163
+ basedOnId: 0,
164
+ start: uint48(block.timestamp),
165
+ duration: uint32(block.timestamp + 1000),
166
+ weight: 1e18,
167
+ weightCutPercent: 0,
168
+ approvalHook: IJBRulesetApprovalHook(address(0)),
169
+ metadata: _packedMetadata
170
+ });
171
+
172
+ // Mock for preview call
173
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
174
+
175
+ (, uint256 previewTokenCount, JBPayHookSpecification[] memory previewSpecs) = _store.previewPayFrom({
176
+ terminal: address(this),
177
+ payer: address(this),
178
+ amount: _tokenAmount,
179
+ projectId: _projectId,
180
+ beneficiary: address(this),
181
+ metadata: ""
182
+ });
183
+
184
+ // Mock for record call
185
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
186
+
187
+ (, uint256 recordTokenCount, JBPayHookSpecification[] memory recordSpecs) = _store.recordPaymentFrom({
188
+ payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
189
+ });
190
+
191
+ assertEq(previewTokenCount, recordTokenCount);
192
+ assertEq(previewSpecs.length, recordSpecs.length);
193
+ }
194
+
195
+ function test_MatchesRecordPaymentFrom_WithDataHook() external {
196
+ // it returns the same tokenCount and hook specs as recordPaymentFrom with a data hook
197
+
198
+ JBTokenAmount memory _tokenAmount = JBTokenAmount({
199
+ token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
200
+ });
201
+
202
+ JBRulesetMetadata memory _metadata = JBRulesetMetadata({
203
+ reservedPercent: 0,
204
+ cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
205
+ baseCurrency: uint32(uint160(address(_token))),
206
+ pausePay: false,
207
+ pauseCreditTransfers: false,
208
+ allowOwnerMinting: false,
209
+ allowSetCustomToken: false,
210
+ allowTerminalMigration: false,
211
+ allowSetTerminals: false,
212
+ ownerMustSendPayouts: false,
213
+ allowSetController: false,
214
+ allowAddAccountingContext: true,
215
+ allowAddPriceFeed: false,
216
+ holdFees: false,
217
+ useTotalSurplusForCashOuts: false,
218
+ useDataHookForPay: true,
219
+ useDataHookForCashOut: false,
220
+ dataHook: address(_dataHook),
221
+ metadata: 0
222
+ });
223
+
224
+ uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
225
+
226
+ JBRuleset memory _returnedRuleset = JBRuleset({
227
+ cycleNumber: uint48(block.timestamp),
228
+ id: uint48(block.timestamp),
229
+ basedOnId: 0,
230
+ start: uint48(block.timestamp),
231
+ duration: uint32(block.timestamp + 1000),
232
+ weight: 1e18,
233
+ weightCutPercent: 0,
234
+ approvalHook: IJBRulesetApprovalHook(address(0)),
235
+ metadata: _packedMetadata
236
+ });
237
+
238
+ JBPayHookSpecification[] memory _spec = new JBPayHookSpecification[](1);
239
+ _spec[0] = JBPayHookSpecification({hook: _payHook, amount: _defaultValue / 2, metadata: ""});
240
+
241
+ // The data hook context will use the terminal address passed to preview / msg.sender for record.
242
+ // Since we call both from address(this), they match.
243
+ JBBeforePayRecordedContext memory _context = JBBeforePayRecordedContext({
244
+ terminal: address(this),
245
+ payer: address(this),
246
+ amount: _tokenAmount,
247
+ projectId: _projectId,
248
+ rulesetId: uint48(block.timestamp),
249
+ beneficiary: address(this),
250
+ weight: _returnedRuleset.weight,
251
+ reservedPercent: _returnedRuleset.reservedPercent(),
252
+ metadata: ""
253
+ });
254
+
255
+ // Mock for preview call
256
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
257
+ mockExpect(
258
+ address(_dataHook),
259
+ abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
260
+ abi.encode(1e18 / 2, _spec)
261
+ );
262
+
263
+ (, uint256 previewTokenCount, JBPayHookSpecification[] memory previewSpecs) = _store.previewPayFrom({
264
+ terminal: address(this),
265
+ payer: address(this),
266
+ amount: _tokenAmount,
267
+ projectId: _projectId,
268
+ beneficiary: address(this),
269
+ metadata: ""
270
+ });
271
+
272
+ // Mock for record call
273
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
274
+ mockExpect(
275
+ address(_dataHook),
276
+ abi.encodeCall(IJBRulesetDataHook.beforePayRecordedWith, (_context)),
277
+ abi.encode(1e18 / 2, _spec)
278
+ );
279
+
280
+ (, uint256 recordTokenCount, JBPayHookSpecification[] memory recordSpecs) = _store.recordPaymentFrom({
281
+ payer: address(this), amount: _tokenAmount, projectId: _projectId, beneficiary: address(this), metadata: ""
282
+ });
283
+
284
+ assertEq(previewTokenCount, recordTokenCount);
285
+ assertEq(previewSpecs.length, recordSpecs.length);
286
+ assertEq(previewSpecs[0].amount, recordSpecs[0].amount);
287
+ }
288
+
289
+ function test_DoesNotModifyState() external {
290
+ // it does not change balanceOf
291
+
292
+ JBTokenAmount memory _tokenAmount = JBTokenAmount({
293
+ token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
294
+ });
295
+
296
+ JBRulesetMetadata memory _metadata = JBRulesetMetadata({
297
+ reservedPercent: 0,
298
+ cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
299
+ baseCurrency: uint32(uint160(address(_token))),
300
+ pausePay: false,
301
+ pauseCreditTransfers: false,
302
+ allowOwnerMinting: false,
303
+ allowSetCustomToken: false,
304
+ allowTerminalMigration: false,
305
+ allowSetTerminals: false,
306
+ ownerMustSendPayouts: false,
307
+ allowSetController: false,
308
+ allowAddAccountingContext: true,
309
+ allowAddPriceFeed: false,
310
+ holdFees: false,
311
+ useTotalSurplusForCashOuts: false,
312
+ useDataHookForPay: false,
313
+ useDataHookForCashOut: false,
314
+ dataHook: address(0),
315
+ metadata: 0
316
+ });
317
+
318
+ uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
319
+
320
+ JBRuleset memory _returnedRuleset = JBRuleset({
321
+ cycleNumber: uint48(block.timestamp),
322
+ id: uint48(block.timestamp),
323
+ basedOnId: 0,
324
+ start: uint48(block.timestamp),
325
+ duration: uint32(block.timestamp + 1000),
326
+ weight: 1e18,
327
+ weightCutPercent: 0,
328
+ approvalHook: IJBRulesetApprovalHook(address(0)),
329
+ metadata: _packedMetadata
330
+ });
331
+
332
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
333
+
334
+ uint256 balanceBefore = _store.balanceOf(_terminal, _projectId, address(_token));
335
+
336
+ _store.previewPayFrom({
337
+ terminal: _terminal,
338
+ payer: address(this),
339
+ amount: _tokenAmount,
340
+ projectId: _projectId,
341
+ beneficiary: address(this),
342
+ metadata: ""
343
+ });
344
+
345
+ uint256 balanceAfter = _store.balanceOf(_terminal, _projectId, address(_token));
346
+
347
+ assertEq(balanceBefore, balanceAfter);
348
+ }
349
+
350
+ function test_WithDifferentBaseCurrency() external {
351
+ // it returns the correct tokenCount when baseCurrency differs from payment currency
352
+
353
+ JBTokenAmount memory _tokenAmount = JBTokenAmount({
354
+ token: address(_token), value: _defaultValue, decimals: _defaultDecimals, currency: _currency
355
+ });
356
+
357
+ JBRulesetMetadata memory _metadata = JBRulesetMetadata({
358
+ reservedPercent: 0,
359
+ cashOutTaxRate: JBConstants.MAX_CASH_OUT_TAX_RATE,
360
+ baseCurrency: _nativeCurrency,
361
+ pausePay: false,
362
+ pauseCreditTransfers: false,
363
+ allowOwnerMinting: false,
364
+ allowSetCustomToken: false,
365
+ allowTerminalMigration: false,
366
+ allowSetTerminals: false,
367
+ ownerMustSendPayouts: false,
368
+ allowSetController: false,
369
+ allowAddAccountingContext: true,
370
+ allowAddPriceFeed: false,
371
+ holdFees: false,
372
+ useTotalSurplusForCashOuts: false,
373
+ useDataHookForPay: false,
374
+ useDataHookForCashOut: false,
375
+ dataHook: address(0),
376
+ metadata: 0
377
+ });
378
+
379
+ uint256 _packedMetadata = JBRulesetMetadataResolver.packRulesetMetadata(_metadata);
380
+
381
+ JBRuleset memory _returnedRuleset = JBRuleset({
382
+ cycleNumber: uint48(block.timestamp),
383
+ id: uint48(block.timestamp),
384
+ basedOnId: 0,
385
+ start: uint48(block.timestamp),
386
+ duration: uint32(block.timestamp + 1000),
387
+ weight: 1e18,
388
+ weightCutPercent: 0,
389
+ approvalHook: IJBRulesetApprovalHook(address(0)),
390
+ metadata: _packedMetadata
391
+ });
392
+
393
+ mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.currentOf, (_projectId)), abi.encode(_returnedRuleset));
394
+
395
+ // mock call to JBPrices pricePerUnitOf
396
+ mockExpect(
397
+ address(prices),
398
+ abi.encodeCall(IJBPrices.pricePerUnitOf, (_projectId, _currency, _nativeCurrency, 18)),
399
+ abi.encode(2e18)
400
+ );
401
+
402
+ uint256 expectedCount = mulDiv(_defaultValue, 1e18, 2e18);
403
+
404
+ (, uint256 tokenCount,) = _store.previewPayFrom({
405
+ terminal: _terminal,
406
+ payer: address(this),
407
+ amount: _tokenAmount,
408
+ projectId: _projectId,
409
+ beneficiary: address(this),
410
+ metadata: ""
411
+ });
412
+
413
+ assertEq(tokenCount, expectedCount);
414
+ }
415
+ }
package/docs/book.css DELETED
@@ -1,13 +0,0 @@
1
- table {
2
- margin: 0 auto;
3
- border-collapse: collapse;
4
- width: 100%;
5
- }
6
-
7
- table td:first-child {
8
- width: 15%;
9
- }
10
-
11
- table td:nth-child(2) {
12
- width: 25%;
13
- }
package/docs/book.toml DELETED
@@ -1,12 +0,0 @@
1
- [book]
2
- src = "src"
3
- title = ""
4
-
5
- [output.html]
6
- no-section-label = true
7
- additional-js = ["solidity.min.js"]
8
- additional-css = ["book.css"]
9
- git-repository-url = "https://github.com/Bananapus/nana-core"
10
-
11
- [output.html.fold]
12
- enable = true
@@ -1,74 +0,0 @@
1
- hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
2
- }catch(e){return!1}}
3
- var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
4
- ;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
5
- begin:a,relevance:0},n={
6
- keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
7
- built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
8
- literal:"true false"},i={className:"string",
9
- begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
10
- begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
11
- return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
12
- return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
13
- SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
14
- var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
15
- begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
16
- begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
17
- contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
18
- className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
19
- contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
20
- className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
21
- contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
22
- solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
23
- HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
24
- ;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
25
- ;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
26
- ;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
27
- ;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
28
- keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
29
- literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
30
- built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
31
- },O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
32
- },C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
33
- excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
34
- contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
35
- begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
36
- built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
37
- },relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
38
- lexemes:C,keywords:p}),w={className:"built_in",
39
- begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
40
- begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
41
- excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
42
- contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
43
- contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
44
- excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
45
- relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
46
- keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
47
- keywords:p,lexemes:C,
48
- contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
49
- className:"function",lexemes:C,
50
- beginKeywords:"function modifier event constructor fallback receive error",
51
- end:/[{;]/,excludeEnd:!0,
52
- contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
53
- },x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
54
- className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
55
- excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
56
- },y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
57
- beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
58
- contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
59
- beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
60
- contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
61
- beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
62
- contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
63
- beginKeywords:"pragma",end:";",lexemes:C,keywords:{
64
- keyword:"pragma solidity experimental abicoder",
65
- built_in:"ABIEncoderV2 SMTChecker v1 v2"},
66
- contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
67
- className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
68
- beginKeywords:"assembly",end:/\b\B/,
69
- contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
70
- end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
71
- end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
72
-
73
- // Ugly hack to reload HLJS
74
- hljs.initHighlightingOnLoad();