@bananapus/core-v6 0.0.16 → 0.0.18

package/docs/src/src/interfaces/IJBRulesets.sol/interface.IJBRulesets.md

@@ -1,165 +0,0 @@
-# IJBRulesets
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBRulesets.sol)
-
-
-## Functions
-### latestRulesetIdOf
-
-
-```solidity
-function latestRulesetIdOf(uint256 projectId) external view returns (uint256);
-```
-
-### currentApprovalStatusForLatestRulesetOf
-
-
-```solidity
-function currentApprovalStatusForLatestRulesetOf(uint256 projectId) external view returns (JBApprovalStatus);
-```
-
-### currentOf
-
-
-```solidity
-function currentOf(uint256 projectId) external view returns (JBRuleset memory ruleset);
-```
-
-### deriveCycleNumberFrom
-
-
-```solidity
-function deriveCycleNumberFrom(
-    uint256 baseRulesetCycleNumber,
-    uint256 baseRulesetStart,
-    uint256 baseRulesetDuration,
-    uint256 start
-)
-    external
-    returns (uint256);
-```
-
-### deriveStartFrom
-
-
-```solidity
-function deriveStartFrom(
-    uint256 baseRulesetStart,
-    uint256 baseRulesetDuration,
-    uint256 mustStartAtOrAfter
-)
-    external
-    view
-    returns (uint256 start);
-```
-
-### deriveWeightFrom
-
-
-```solidity
-function deriveWeightFrom(
-    uint256 projectId,
-    uint256 baseRulesetStart,
-    uint256 baseRulesetDuration,
-    uint256 baseRulesetWeight,
-    uint256 baseRulesetWeightCutPercent,
-    uint256 baseRulesetCacheId,
-    uint256 start
-)
-    external
-    view
-    returns (uint256 weight);
-```
-
-### getRulesetOf
-
-
-```solidity
-function getRulesetOf(uint256 projectId, uint256 rulesetId) external view returns (JBRuleset memory);
-```
-
-### latestQueuedOf
-
-
-```solidity
-function latestQueuedOf(uint256 projectId)
-    external
-    view
-    returns (JBRuleset memory ruleset, JBApprovalStatus approvalStatus);
-```
-
-### allOf
-
-
-```solidity
-function allOf(
-    uint256 projectId,
-    uint256 startingId,
-    uint256 size
-)
-    external
-    view
-    returns (JBRuleset[] memory rulesets);
-```
-
-### upcomingOf
-
-
-```solidity
-function upcomingOf(uint256 projectId) external view returns (JBRuleset memory ruleset);
-```
-
-### queueFor
-
-
-```solidity
-function queueFor(
-    uint256 projectId,
-    uint256 duration,
-    uint256 weight,
-    uint256 weightCutPercent,
-    IJBRulesetApprovalHook approvalHook,
-    uint256 metadata,
-    uint256 mustStartAtOrAfter
-)
-    external
-    returns (JBRuleset memory ruleset);
-```
-
-### updateRulesetWeightCache
-
-
-```solidity
-function updateRulesetWeightCache(uint256 projectId) external;
-```
-
-## Events
-### RulesetInitialized
-
-```solidity
-event RulesetInitialized(
-    uint256 indexed rulesetId, uint256 indexed projectId, uint256 indexed basedOnId, address caller
-);
-```
-
-### RulesetQueued
-
-```solidity
-event RulesetQueued(
-    uint256 indexed rulesetId,
-    uint256 indexed projectId,
-    uint256 duration,
-    uint256 weight,
-    uint256 weightCutPercent,
-    IJBRulesetApprovalHook approvalHook,
-    uint256 metadata,
-    uint256 mustStartAtOrAfter,
-    address caller
-);
-```
-
-### WeightCacheUpdated
-
-```solidity
-event WeightCacheUpdated(uint256 projectId, uint112 weight, uint256 weightCutMultiple, address caller);
-```
-

package/docs/src/src/interfaces/IJBSplitHook.sol/interface.IJBSplitHook.md

@@ -1,31 +0,0 @@
-# IJBSplitHook
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBSplitHook.sol)
-
-**Inherits:**
-IERC165
-
-Allows processing a single split with custom logic.
-
-*The split hook's address should be set as the `hook` in the relevant split.*
-
-
-## Functions
-### processSplitWith
-
-If a split has a split hook, payment terminals and controllers call this function while processing the
-split.
-
-*Critical business logic should be protected by appropriate access control. The tokens and/or native tokens
-are optimistically transferred to the split hook when this function is called.*
-
-
-```solidity
-function processSplitWith(JBSplitHookContext calldata context) external payable;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`context`|`JBSplitHookContext`|The context passed by the terminal/controller to the split hook as a `JBSplitHookContext` struct:|
-
-

package/docs/src/src/interfaces/IJBSplits.sol/interface.IJBSplits.md

@@ -1,35 +0,0 @@
-# IJBSplits
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBSplits.sol)
-
-
-## Functions
-### FALLBACK_RULESET_ID
-
-
-```solidity
-function FALLBACK_RULESET_ID() external view returns (uint256);
-```
-
-### splitsOf
-
-
-```solidity
-function splitsOf(uint256 projectId, uint256 rulesetId, uint256 groupId) external view returns (JBSplit[] memory);
-```
-
-### setSplitGroupsOf
-
-
-```solidity
-function setSplitGroupsOf(uint256 projectId, uint256 rulesetId, JBSplitGroup[] memory splitGroups) external;
-```
-
-## Events
-### SetSplit
-
-```solidity
-event SetSplit(
-    uint256 indexed projectId, uint256 indexed rulesetId, uint256 indexed groupId, JBSplit split, address caller
-);
-```
-

package/docs/src/src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md

@@ -1,141 +0,0 @@
-# IJBTerminal
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBTerminal.sol)
-
-**Inherits:**
-IERC165
-
-A terminal that accepts payments and can be migrated.
-
-
-## Functions
-### accountingContextForTokenOf
-
-
-```solidity
-function accountingContextForTokenOf(
-    uint256 projectId,
-    address token
-)
-    external
-    view
-    returns (JBAccountingContext memory);
-```
-
-### accountingContextsOf
-
-
-```solidity
-function accountingContextsOf(uint256 projectId) external view returns (JBAccountingContext[] memory);
-```
-
-### currentSurplusOf
-
-
-```solidity
-function currentSurplusOf(
-    uint256 projectId,
-    JBAccountingContext[] memory accountingContexts,
-    uint256 decimals,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-
-### addAccountingContextsFor
-
-
-```solidity
-function addAccountingContextsFor(uint256 projectId, JBAccountingContext[] calldata accountingContexts) external;
-```
-
-### addToBalanceOf
-
-
-```solidity
-function addToBalanceOf(
-    uint256 projectId,
-    address token,
-    uint256 amount,
-    bool shouldReturnHeldFees,
-    string calldata memo,
-    bytes calldata metadata
-)
-    external
-    payable;
-```
-
-### migrateBalanceOf
-
-
-```solidity
-function migrateBalanceOf(uint256 projectId, address token, IJBTerminal to) external returns (uint256 balance);
-```
-
-### pay
-
-
-```solidity
-function pay(
-    uint256 projectId,
-    address token,
-    uint256 amount,
-    address beneficiary,
-    uint256 minReturnedTokens,
-    string calldata memo,
-    bytes calldata metadata
-)
-    external
-    payable
-    returns (uint256 beneficiaryTokenCount);
-```
-
-## Events
-### AddToBalance
-
-```solidity
-event AddToBalance(
-    uint256 indexed projectId, uint256 amount, uint256 returnedFees, string memo, bytes metadata, address caller
-);
-```
-
-### HookAfterRecordPay
-
-```solidity
-event HookAfterRecordPay(
-    IJBPayHook indexed hook, JBAfterPayRecordedContext context, uint256 specificationAmount, address caller
-);
-```
-
-### MigrateTerminal
-
-```solidity
-event MigrateTerminal(
-    uint256 indexed projectId, address indexed token, IJBTerminal indexed to, uint256 amount, address caller
-);
-```
-
-### Pay
-
-```solidity
-event Pay(
-    uint256 indexed rulesetId,
-    uint256 indexed rulesetCycleNumber,
-    uint256 indexed projectId,
-    address payer,
-    address beneficiary,
-    uint256 amount,
-    uint256 newlyIssuedTokenCount,
-    string memo,
-    bytes metadata,
-    address caller
-);
-```
-
-### SetAccountingContext
-
-```solidity
-event SetAccountingContext(uint256 indexed projectId, JBAccountingContext context, address caller);
-```
-

package/docs/src/src/interfaces/IJBTerminalStore.sol/interface.IJBTerminalStore.md

@@ -1,198 +0,0 @@
-# IJBTerminalStore
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBTerminalStore.sol)
-
-
-## Functions
-### DIRECTORY
-
-
-```solidity
-function DIRECTORY() external view returns (IJBDirectory);
-```
-
-### PRICES
-
-
-```solidity
-function PRICES() external view returns (IJBPrices);
-```
-
-### RULESETS
-
-
-```solidity
-function RULESETS() external view returns (IJBRulesets);
-```
-
-### balanceOf
-
-
-```solidity
-function balanceOf(address terminal, uint256 projectId, address token) external view returns (uint256);
-```
-
-### usedPayoutLimitOf
-
-
-```solidity
-function usedPayoutLimitOf(
-    address terminal,
-    uint256 projectId,
-    address token,
-    uint256 rulesetCycleNumber,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-
-### usedSurplusAllowanceOf
-
-
-```solidity
-function usedSurplusAllowanceOf(
-    address terminal,
-    uint256 projectId,
-    address token,
-    uint256 rulesetId,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-
-### currentReclaimableSurplusOf
-
-
-```solidity
-function currentReclaimableSurplusOf(
-    uint256 projectId,
-    uint256 tokenCount,
-    uint256 totalSupply,
-    uint256 surplus
-)
-    external
-    view
-    returns (uint256);
-```
-
-### currentReclaimableSurplusOf
-
-
-```solidity
-function currentReclaimableSurplusOf(
-    uint256 projectId,
-    uint256 cashOutCount,
-    IJBTerminal[] calldata terminals,
-    JBAccountingContext[] calldata accountingContexts,
-    uint256 decimals,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-
-### currentSurplusOf
-
-
-```solidity
-function currentSurplusOf(
-    address terminal,
-    uint256 projectId,
-    JBAccountingContext[] calldata accountingContexts,
-    uint256 decimals,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-
-### currentTotalSurplusOf
-
-
-```solidity
-function currentTotalSurplusOf(uint256 projectId, uint256 decimals, uint256 currency) external view returns (uint256);
-```
-
-### recordAddedBalanceFor
-
-
-```solidity
-function recordAddedBalanceFor(uint256 projectId, address token, uint256 amount) external;
-```
-
-### recordPaymentFrom
-
-
-```solidity
-function recordPaymentFrom(
-    address payer,
-    JBTokenAmount memory amount,
-    uint256 projectId,
-    address beneficiary,
-    bytes calldata metadata
-)
-    external
-    returns (JBRuleset memory ruleset, uint256 tokenCount, JBPayHookSpecification[] memory hookSpecifications);
-```
-
-### recordPayoutFor
-
-
-```solidity
-function recordPayoutFor(
-    uint256 projectId,
-    JBAccountingContext calldata accountingContext,
-    uint256 amount,
-    uint256 currency
-)
-    external
-    returns (JBRuleset memory ruleset, uint256 amountPaidOut);
-```
-
-### recordCashOutFor
-
-
-```solidity
-function recordCashOutFor(
-    address holder,
-    uint256 projectId,
-    uint256 cashOutCount,
-    JBAccountingContext calldata accountingContext,
-    JBAccountingContext[] calldata balanceAccountingContexts,
-    bytes calldata metadata
-)
-    external
-    returns (
-        JBRuleset memory ruleset,
-        uint256 reclaimAmount,
-        uint256 cashOutTaxRate,
-        JBCashOutHookSpecification[] memory hookSpecifications
-    );
-```
-
-### recordTerminalMigration
-
-
-```solidity
-function recordTerminalMigration(uint256 projectId, address token) external returns (uint256 balance);
-```
-
-### recordUsedAllowanceOf
-
-
-```solidity
-function recordUsedAllowanceOf(
-    uint256 projectId,
-    JBAccountingContext calldata accountingContext,
-    uint256 amount,
-    uint256 currency
-)
-    external
-    returns (JBRuleset memory ruleset, uint256 usedAmount);
-```
-

package/docs/src/src/interfaces/IJBToken.sol/interface.IJBToken.md

@@ -1,54 +0,0 @@
-# IJBToken
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBToken.sol)
-
-
-## Functions
-### balanceOf
-
-
-```solidity
-function balanceOf(address account) external view returns (uint256);
-```
-
-### canBeAddedTo
-
-
-```solidity
-function canBeAddedTo(uint256 projectId) external view returns (bool);
-```
-
-### decimals
-
-
-```solidity
-function decimals() external view returns (uint8);
-```
-
-### totalSupply
-
-
-```solidity
-function totalSupply() external view returns (uint256);
-```
-
-### initialize
-
-
-```solidity
-function initialize(string memory name, string memory symbol, address owner) external;
-```
-
-### burn
-
-
-```solidity
-function burn(address account, uint256 amount) external;
-```
-
-### mint
-
-
-```solidity
-function mint(address account, uint256 amount) external;
-```
-

package/docs/src/src/interfaces/IJBTokenUriResolver.sol/interface.IJBTokenUriResolver.md

@@ -1,12 +0,0 @@
-# IJBTokenUriResolver
-[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/interfaces/IJBTokenUriResolver.sol)
-
-
-## Functions
-### getUri
-
-
-```solidity
-function getUri(uint256 projectId) external view returns (string memory tokenUri);
-```
-