@bananapus/core-v6 0.0.1

package/docs/src/src/libraries/JBRulesetMetadataResolver.sol/library.JBRulesetMetadataResolver.md

@@ -0,0 +1,180 @@
+# JBRulesetMetadataResolver
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBRulesetMetadataResolver.sol)
+
+
+## Functions
+### reservedPercent
+
+
+```solidity
+function reservedPercent(JBRuleset memory ruleset) internal pure returns (uint16);
+```
+
+### cashOutTaxRate
+
+
+```solidity
+function cashOutTaxRate(JBRuleset memory ruleset) internal pure returns (uint16);
+```
+
+### baseCurrency
+
+
+```solidity
+function baseCurrency(JBRuleset memory ruleset) internal pure returns (uint32);
+```
+
+### pausePay
+
+
+```solidity
+function pausePay(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### pauseCreditTransfers
+
+
+```solidity
+function pauseCreditTransfers(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowOwnerMinting
+
+
+```solidity
+function allowOwnerMinting(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowSetCustomToken
+
+
+```solidity
+function allowSetCustomToken(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowTerminalMigration
+
+
+```solidity
+function allowTerminalMigration(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowSetTerminals
+
+
+```solidity
+function allowSetTerminals(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowSetController
+
+
+```solidity
+function allowSetController(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowAddAccountingContext
+
+
+```solidity
+function allowAddAccountingContext(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### allowAddPriceFeed
+
+
+```solidity
+function allowAddPriceFeed(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### ownerMustSendPayouts
+
+
+```solidity
+function ownerMustSendPayouts(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### holdFees
+
+
+```solidity
+function holdFees(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### useTotalSurplusForCashOuts
+
+
+```solidity
+function useTotalSurplusForCashOuts(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### useDataHookForPay
+
+
+```solidity
+function useDataHookForPay(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### useDataHookForCashOut
+
+
+```solidity
+function useDataHookForCashOut(JBRuleset memory ruleset) internal pure returns (bool);
+```
+
+### dataHook
+
+
+```solidity
+function dataHook(JBRuleset memory ruleset) internal pure returns (address);
+```
+
+### metadata
+
+
+```solidity
+function metadata(JBRuleset memory ruleset) internal pure returns (uint16);
+```
+
+### packRulesetMetadata
+
+Pack the funding cycle metadata.
+
+
+```solidity
+function packRulesetMetadata(JBRulesetMetadata memory rulesetMetadata) internal pure returns (uint256 packed);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`rulesetMetadata`|`JBRulesetMetadata`|The ruleset metadata to validate and pack.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`packed`|`uint256`|The packed uint256 of all metadata params. The first 8 bits specify the version.|
+
+
+### expandMetadata
+
+Expand the funding cycle metadata.
+
+
+```solidity
+function expandMetadata(JBRuleset memory ruleset) internal pure returns (JBRulesetMetadata memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`ruleset`|`JBRuleset`|The funding cycle having its metadata expanded.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`JBRulesetMetadata`|rulesetMetadata The ruleset's metadata object.|
+
+

package/docs/src/src/libraries/JBSplitGroupIds.sol/library.JBSplitGroupIds.md

@@ -0,0 +1,14 @@
+# JBSplitGroupIds
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBSplitGroupIds.sol)
+
+Group IDs that categorize splits.
+
+
+## State Variables
+### RESERVED_TOKENS
+
+```solidity
+uint256 public constant RESERVED_TOKENS = 1;
+```
+
+

package/docs/src/src/libraries/JBSurplus.sol/library.JBSurplus.md

@@ -0,0 +1,44 @@
+# JBSurplus
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/libraries/JBSurplus.sol)
+
+Surplus calculations.
+
+
+## Functions
+### currentSurplusOf
+
+Gets the total current surplus amount across all of a project's terminals.
+
+*This amount changes as the value of the balances changes in relation to the currency being used to measure
+the project's payout limits.*
+
+
+```solidity
+function currentSurplusOf(
+    uint256 projectId,
+    IJBTerminal[] memory terminals,
+    JBAccountingContext[] memory accountingContexts,
+    uint256 decimals,
+    uint256 currency
+)
+    internal
+    view
+    returns (uint256 surplus);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project to get the total surplus for.|
+|`terminals`|`IJBTerminal[]`|The terminals to look for surplus within.|
+|`accountingContexts`|`JBAccountingContext[]`|The accounting contexts to use to calculate the surplus.|
+|`decimals`|`uint256`|The number of decimals that the fixed point surplus result should include.|
+|`currency`|`uint256`|The currency that the surplus result should be in terms of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`surplus`|`uint256`|The total surplus of a project's funds in terms of `currency`, as a fixed point number with the specified number of decimals.|
+
+

package/docs/src/src/libraries/README.md

@@ -0,0 +1,12 @@
+
+
+# Contents
+- [JBCashOuts](JBCashOuts.sol/library.JBCashOuts.md)
+- [JBConstants](JBConstants.sol/library.JBConstants.md)
+- [JBCurrencyIds](JBCurrencyIds.sol/library.JBCurrencyIds.md)
+- [JBFees](JBFees.sol/library.JBFees.md)
+- [JBFixedPointNumber](JBFixedPointNumber.sol/library.JBFixedPointNumber.md)
+- [JBMetadataResolver](JBMetadataResolver.sol/library.JBMetadataResolver.md)
+- [JBRulesetMetadataResolver](JBRulesetMetadataResolver.sol/library.JBRulesetMetadataResolver.md)
+- [JBSplitGroupIds](JBSplitGroupIds.sol/library.JBSplitGroupIds.md)
+- [JBSurplus](JBSurplus.sol/library.JBSurplus.md)

package/docs/src/src/periphery/JBDeadline1Day.sol/contract.JBDeadline1Day.md

@@ -0,0 +1,15 @@
+# JBDeadline1Day
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/periphery/JBDeadline1Day.sol)
+
+**Inherits:**
+[JBDeadline](/src/JBDeadline.sol/contract.JBDeadline.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() JBDeadline(1 days);
+```
+

package/docs/src/src/periphery/JBDeadline3Days.sol/contract.JBDeadline3Days.md

@@ -0,0 +1,15 @@
+# JBDeadline3Days
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/periphery/JBDeadline3Days.sol)
+
+**Inherits:**
+[JBDeadline](/src/JBDeadline.sol/contract.JBDeadline.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() JBDeadline(3 days);
+```
+

package/docs/src/src/periphery/JBDeadline3Hours.sol/contract.JBDeadline3Hours.md

@@ -0,0 +1,15 @@
+# JBDeadline3Hours
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/periphery/JBDeadline3Hours.sol)
+
+**Inherits:**
+[JBDeadline](/src/JBDeadline.sol/contract.JBDeadline.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() JBDeadline(3 hours);
+```
+

package/docs/src/src/periphery/JBDeadline7Days.sol/contract.JBDeadline7Days.md

@@ -0,0 +1,15 @@
+# JBDeadline7Days
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/periphery/JBDeadline7Days.sol)
+
+**Inherits:**
+[JBDeadline](/src/JBDeadline.sol/contract.JBDeadline.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() JBDeadline(7 days);
+```
+

package/docs/src/src/periphery/JBMatchingPriceFeed.sol/contract.JBMatchingPriceFeed.md

@@ -0,0 +1,22 @@
+# JBMatchingPriceFeed
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/periphery/JBMatchingPriceFeed.sol)
+
+**Inherits:**
+[IJBPriceFeed](/src/interfaces/IJBPriceFeed.sol/interface.IJBPriceFeed.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### currentUnitPrice
+
+
+```solidity
+function currentUnitPrice(uint256 decimals) public view virtual override returns (uint256);
+```
+

package/docs/src/src/periphery/README.md

@@ -0,0 +1,8 @@
+
+
+# Contents
+- [JBDeadline1Day](JBDeadline1Day.sol/contract.JBDeadline1Day.md)
+- [JBDeadline3Days](JBDeadline3Days.sol/contract.JBDeadline3Days.md)
+- [JBDeadline3Hours](JBDeadline3Hours.sol/contract.JBDeadline3Hours.md)
+- [JBDeadline7Days](JBDeadline7Days.sol/contract.JBDeadline7Days.md)
+- [JBMatchingPriceFeed](JBMatchingPriceFeed.sol/contract.JBMatchingPriceFeed.md)

package/docs/src/src/structs/JBAccountingContext.sol/struct.JBAccountingContext.md

@@ -0,0 +1,20 @@
+# JBAccountingContext
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBAccountingContext.sol)
+
+**Notes:**
+- member: token The address of the token that accounting is being done with.
+
+- member: decimals The number of decimals expected in that token's fixed point accounting.
+
+- member: currency The currency that the token is priced in terms of. By convention, this is
+`uint32(uint160(tokenAddress))` for tokens, or a constant ID from e.g. `JBCurrencyIds` for other currencies.
+
+
+```solidity
+struct JBAccountingContext {
+    address token;
+    uint8 decimals;
+    uint32 currency;
+}
+```
+

package/docs/src/src/structs/JBAfterCashOutRecordedContext.sol/struct.JBAfterCashOutRecordedContext.md

@@ -0,0 +1,43 @@
+# JBAfterCashOutRecordedContext
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBAfterCashOutRecordedContext.sol)
+
+**Notes:**
+- member: holder The holder of the tokens being cashed out.
+
+- member: projectId The ID of the project being cashed out from.
+
+- member: rulesetId The ID of the ruleset the cash out is being made during.
+
+- member: cashOutCount The number of project tokens being cashed out.
+
+- member: cashOutTaxRate The current ruleset's cash out tax rate.
+
+- member: reclaimedAmount The token amount being reclaimed from the project's terminal balance. Includes the
+token being
+reclaimed, the value, the number of decimals included, and the currency of the amount.
+
+- member: forwardedAmount The token amount being forwarded to the cash out hook. Includes the token
+being forwarded, the value, the number of decimals included, and the currency of the amount.
+
+- member: beneficiary The address the reclaimed amount will be sent to.
+
+- member: hookMetadata Extra data specified by the data hook, which is sent to the cash out hook.
+
+- member: cashOutMetadata Extra data specified by the account cashing out, which is sent to the cash out hook.
+
+
+```solidity
+struct JBAfterCashOutRecordedContext {
+    address holder;
+    uint256 projectId;
+    uint256 rulesetId;
+    uint256 cashOutCount;
+    JBTokenAmount reclaimedAmount;
+    JBTokenAmount forwardedAmount;
+    uint256 cashOutTaxRate;
+    address payable beneficiary;
+    bytes hookMetadata;
+    bytes cashOutMetadata;
+}
+```
+

package/docs/src/src/structs/JBAfterPayRecordedContext.sol/struct.JBAfterPayRecordedContext.md

@@ -0,0 +1,42 @@
+# JBAfterPayRecordedContext
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBAfterPayRecordedContext.sol)
+
+**Notes:**
+- member: payer The address the payment originated from.
+
+- member: projectId The ID of the project being paid.
+
+- member: rulesetId The ID of the ruleset the payment is being made during.
+
+- member: amount The payment's token amount. Includes the token being paid, the value, the number of decimals
+included, and the currency of the amount.
+
+- member: forwardedAmount The token amount being forwarded to the pay hook. Includes the token
+being paid, the value, the number of decimals included, and the currency of the amount.
+
+- member: weight The current ruleset's weight (used to determine how many tokens should be minted).
+
+- member: newlyIssuedTokenCount The number of project tokens minted for the beneficiary.
+
+- member: beneficiary The address which receives any tokens this payment yields.
+
+- member: hookMetadata Extra data specified by the data hook, which is sent to the pay hook.
+
+- member: payerMetadata Extra data specified by the payer, which is sent to the pay hook.
+
+
+```solidity
+struct JBAfterPayRecordedContext {
+    address payer;
+    uint256 projectId;
+    uint256 rulesetId;
+    JBTokenAmount amount;
+    JBTokenAmount forwardedAmount;
+    uint256 weight;
+    uint256 newlyIssuedTokenCount;
+    address beneficiary;
+    bytes hookMetadata;
+    bytes payerMetadata;
+}
+```
+

package/docs/src/src/structs/JBBeforeCashOutRecordedContext.sol/struct.JBBeforeCashOutRecordedContext.md

@@ -0,0 +1,45 @@
+# JBBeforeCashOutRecordedContext
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBBeforeCashOutRecordedContext.sol)
+
+Context sent from the terminal to the ruleset's data hook upon cash out.
+
+**Notes:**
+- member: terminal The terminal that is facilitating the cash out.
+
+- member: holder The holder of the tokens being cashed out.
+
+- member: projectId The ID of the project whose tokens are being cashed out.
+
+- member: rulesetId The ID of the ruleset the cash out is being made during.
+
+- member: cashOutCount The number of tokens being cashed out, as a fixed point number with 18 decimals.
+
+- member: totalSupply The total token supply being used for the calculation, as a fixed point number with 18
+decimals.
+
+- member: surplus The surplus amount used for the calculation, as a fixed point number with 18 decimals.
+Includes the token of the surplus, the surplus value, the number of decimals
+included, and the currency of the surplus.
+
+- member: useTotalSurplus If surplus across all of a project's terminals is being used when making cash outs.
+
+- member: cashOutTaxRate The cash out tax rate of the ruleset the cash out is being made during.
+
+- member: metadata Extra data provided by the casher.
+
+
+```solidity
+struct JBBeforeCashOutRecordedContext {
+    address terminal;
+    address holder;
+    uint256 projectId;
+    uint256 rulesetId;
+    uint256 cashOutCount;
+    uint256 totalSupply;
+    JBTokenAmount surplus;
+    bool useTotalSurplus;
+    uint256 cashOutTaxRate;
+    bytes metadata;
+}
+```
+

package/docs/src/src/structs/JBBeforePayRecordedContext.sol/struct.JBBeforePayRecordedContext.md

@@ -0,0 +1,41 @@
+# JBBeforePayRecordedContext
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBBeforePayRecordedContext.sol)
+
+Context sent from the terminal to the ruleset's data hook upon payment.
+
+**Notes:**
+- member: terminal The terminal that is facilitating the payment.
+
+- member: payer The address that the payment originated from.
+
+- member: amount The payment's token amount, including the token being paid, the value, the number of decimals
+included, and the currency of the amount.
+
+- member: projectId The ID of the project being paid.
+
+- member: rulesetId The ID of the ruleset the payment is being made during.
+
+- member: beneficiary The specified address that should be the beneficiary of anything that this payment
+yields.
+
+- member: weight The weight of the ruleset during which the payment is being made.
+
+- member: reservedPercent The reserved percent of the ruleset the payment is being made during.
+
+- member: metadata Extra data specified by the payer.
+
+
+```solidity
+struct JBBeforePayRecordedContext {
+    address terminal;
+    address payer;
+    JBTokenAmount amount;
+    uint256 projectId;
+    uint256 rulesetId;
+    address beneficiary;
+    uint256 weight;
+    uint256 reservedPercent;
+    bytes metadata;
+}
+```
+

package/docs/src/src/structs/JBCashOutHookSpecification.sol/struct.JBCashOutHookSpecification.md

@@ -0,0 +1,22 @@
+# JBCashOutHookSpecification
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBCashOutHookSpecification.sol)
+
+A cash out hook specification sent from the ruleset's data hook back to the terminal. This specification is
+fulfilled by the terminal.
+
+**Notes:**
+- member: hook The cash out hook to use when fulfilling this specification.
+
+- member: amount The amount to send to the hook.
+
+- member: metadata Metadata to pass to the hook.
+
+
+```solidity
+struct JBCashOutHookSpecification {
+    IJBCashOutHook hook;
+    uint256 amount;
+    bytes metadata;
+}
+```
+

package/docs/src/src/structs/JBCurrencyAmount.sol/struct.JBCurrencyAmount.md

@@ -0,0 +1,17 @@
+# JBCurrencyAmount
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBCurrencyAmount.sol)
+
+**Notes:**
+- member: amount The amount of the currency.
+
+- member: currency The currency. By convention, this is `uint32(uint160(tokenAddress))` for tokens, or a
+constant ID from e.g. `JBCurrencyIds` for other currencies.
+
+
+```solidity
+struct JBCurrencyAmount {
+    uint224 amount;
+    uint32 currency;
+}
+```
+

package/docs/src/src/structs/JBFee.sol/struct.JBFee.md

@@ -0,0 +1,20 @@
+# JBFee
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBFee.sol)
+
+**Notes:**
+- member: amount The total amount the fee was taken from, as a fixed point number with the same number of
+decimals as the terminal in which this struct was created.
+
+- member: beneficiary The address that will receive the tokens that are minted as a result of the fee payment.
+
+- member: unlockTimestamp The timestamp at which the fee is unlocked and can be processed.
+
+
+```solidity
+struct JBFee {
+    uint256 amount;
+    address beneficiary;
+    uint48 unlockTimestamp;
+}
+```
+

package/docs/src/src/structs/JBFundAccessLimitGroup.sol/struct.JBFundAccessLimitGroup.md

@@ -0,0 +1,39 @@
+# JBFundAccessLimitGroup
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBFundAccessLimitGroup.sol)
+
+*Payout limit example: if the `amount` is 5, the `currency` is 1 (USD), and the terminal's token is ETH, then
+the project can pay out 5 USD worth of ETH during a ruleset.*
+
+*Surplus allowance example: if the `amount` is 5, the `currency` is 1 (USD), and the terminal's token is ETH,
+then the project can pay out 5 USD worth of ETH from its surplus during a ruleset. A project's surplus is its
+balance minus its current combined payout limit.*
+
+*If a project has multiple payout limits or surplus allowances, they are all available. They can all be used
+during a single ruleset.*
+
+*The payout limits' and surplus allowances' fixed point amounts have the same number of decimals as the
+terminal.*
+
+**Notes:**
+- member: terminal The terminal that the payout limits and surplus allowances apply to.
+
+- member: token The token that the payout limits and surplus allowances apply to within the `terminal`.
+
+- member: payoutLimits An array of payout limits. The payout limits cumulatively dictate the maximum value of
+`token`s a project can pay out from its balance in a terminal during a ruleset. Each payout limit can have a unique
+currency and amount.
+
+- member: surplusAllowances An array of surplus allowances. The surplus allowances cumulatively dictates the
+maximum value of `token`s a project can pay out from its surplus (balance less payouts) in a terminal during a
+ruleset. Each surplus allowance can have a unique currency and amount.
+
+
+```solidity
+struct JBFundAccessLimitGroup {
+    address terminal;
+    address token;
+    JBCurrencyAmount[] payoutLimits;
+    JBCurrencyAmount[] surplusAllowances;
+}
+```
+

package/docs/src/src/structs/JBPayHookSpecification.sol/struct.JBPayHookSpecification.md

@@ -0,0 +1,22 @@
+# JBPayHookSpecification
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/structs/JBPayHookSpecification.sol)
+
+A pay hook specification sent from the ruleset's data hook back to the terminal. This specification is
+fulfilled by the terminal.
+
+**Notes:**
+- member: hook The pay hook to use when fulfilling this specification.
+
+- member: amount The amount to send to the hook.
+
+- member: metadata Metadata to pass the hook.
+
+
+```solidity
+struct JBPayHookSpecification {
+    IJBPayHook hook;
+    uint256 amount;
+    bytes metadata;
+}
+```
+