@bananapus/core-v6 0.0.1

package/docs/src/SUMMARY.md

@@ -0,0 +1,94 @@
+# Summary
+- [Home](README.md)
+# src
+  - [❱ abstract](src/abstract/README.md)
+    - [JBControlled](src/abstract/JBControlled.sol/abstract.JBControlled.md)
+    - [JBPermissioned](src/abstract/JBPermissioned.sol/abstract.JBPermissioned.md)
+  - [❱ enums](src/enums/README.md)
+    - [JBApprovalStatus](src/enums/JBApprovalStatus.sol/enum.JBApprovalStatus.md)
+  - [❱ interfaces](src/interfaces/README.md)
+    - [IJBCashOutHook](src/interfaces/IJBCashOutHook.sol/interface.IJBCashOutHook.md)
+    - [IJBCashOutTerminal](src/interfaces/IJBCashOutTerminal.sol/interface.IJBCashOutTerminal.md)
+    - [IJBControlled](src/interfaces/IJBControlled.sol/interface.IJBControlled.md)
+    - [IJBController](src/interfaces/IJBController.sol/interface.IJBController.md)
+    - [IJBDirectory](src/interfaces/IJBDirectory.sol/interface.IJBDirectory.md)
+    - [IJBDirectoryAccessControl](src/interfaces/IJBDirectoryAccessControl.sol/interface.IJBDirectoryAccessControl.md)
+    - [IJBFeeTerminal](src/interfaces/IJBFeeTerminal.sol/interface.IJBFeeTerminal.md)
+    - [IJBFeelessAddresses](src/interfaces/IJBFeelessAddresses.sol/interface.IJBFeelessAddresses.md)
+    - [IJBFundAccessLimits](src/interfaces/IJBFundAccessLimits.sol/interface.IJBFundAccessLimits.md)
+    - [IJBMigratable](src/interfaces/IJBMigratable.sol/interface.IJBMigratable.md)
+    - [IJBMultiTerminal](src/interfaces/IJBMultiTerminal.sol/interface.IJBMultiTerminal.md)
+    - [IJBPayHook](src/interfaces/IJBPayHook.sol/interface.IJBPayHook.md)
+    - [IJBPayoutTerminal](src/interfaces/IJBPayoutTerminal.sol/interface.IJBPayoutTerminal.md)
+    - [IJBPermissioned](src/interfaces/IJBPermissioned.sol/interface.IJBPermissioned.md)
+    - [IJBPermissions](src/interfaces/IJBPermissions.sol/interface.IJBPermissions.md)
+    - [IJBPermitTerminal](src/interfaces/IJBPermitTerminal.sol/interface.IJBPermitTerminal.md)
+    - [IJBPriceFeed](src/interfaces/IJBPriceFeed.sol/interface.IJBPriceFeed.md)
+    - [IJBPrices](src/interfaces/IJBPrices.sol/interface.IJBPrices.md)
+    - [IJBProjectUriRegistry](src/interfaces/IJBProjectUriRegistry.sol/interface.IJBProjectUriRegistry.md)
+    - [IJBProjects](src/interfaces/IJBProjects.sol/interface.IJBProjects.md)
+    - [IJBRulesetApprovalHook](src/interfaces/IJBRulesetApprovalHook.sol/interface.IJBRulesetApprovalHook.md)
+    - [IJBRulesetDataHook](src/interfaces/IJBRulesetDataHook.sol/interface.IJBRulesetDataHook.md)
+    - [IJBRulesets](src/interfaces/IJBRulesets.sol/interface.IJBRulesets.md)
+    - [IJBSplitHook](src/interfaces/IJBSplitHook.sol/interface.IJBSplitHook.md)
+    - [IJBSplits](src/interfaces/IJBSplits.sol/interface.IJBSplits.md)
+    - [IJBTerminal](src/interfaces/IJBTerminal.sol/interface.IJBTerminal.md)
+    - [IJBTerminalStore](src/interfaces/IJBTerminalStore.sol/interface.IJBTerminalStore.md)
+    - [IJBToken](src/interfaces/IJBToken.sol/interface.IJBToken.md)
+    - [IJBTokenUriResolver](src/interfaces/IJBTokenUriResolver.sol/interface.IJBTokenUriResolver.md)
+    - [IJBTokens](src/interfaces/IJBTokens.sol/interface.IJBTokens.md)
+  - [❱ libraries](src/libraries/README.md)
+    - [JBCashOuts](src/libraries/JBCashOuts.sol/library.JBCashOuts.md)
+    - [JBConstants](src/libraries/JBConstants.sol/library.JBConstants.md)
+    - [JBCurrencyIds](src/libraries/JBCurrencyIds.sol/library.JBCurrencyIds.md)
+    - [JBFees](src/libraries/JBFees.sol/library.JBFees.md)
+    - [JBFixedPointNumber](src/libraries/JBFixedPointNumber.sol/library.JBFixedPointNumber.md)
+    - [JBMetadataResolver](src/libraries/JBMetadataResolver.sol/library.JBMetadataResolver.md)
+    - [JBRulesetMetadataResolver](src/libraries/JBRulesetMetadataResolver.sol/library.JBRulesetMetadataResolver.md)
+    - [JBSplitGroupIds](src/libraries/JBSplitGroupIds.sol/library.JBSplitGroupIds.md)
+    - [JBSurplus](src/libraries/JBSurplus.sol/library.JBSurplus.md)
+  - [❱ periphery](src/periphery/README.md)
+    - [JBDeadline1Day](src/periphery/JBDeadline1Day.sol/contract.JBDeadline1Day.md)
+    - [JBDeadline3Days](src/periphery/JBDeadline3Days.sol/contract.JBDeadline3Days.md)
+    - [JBDeadline3Hours](src/periphery/JBDeadline3Hours.sol/contract.JBDeadline3Hours.md)
+    - [JBDeadline7Days](src/periphery/JBDeadline7Days.sol/contract.JBDeadline7Days.md)
+    - [JBMatchingPriceFeed](src/periphery/JBMatchingPriceFeed.sol/contract.JBMatchingPriceFeed.md)
+  - [❱ structs](src/structs/README.md)
+    - [JBAccountingContext](src/structs/JBAccountingContext.sol/struct.JBAccountingContext.md)
+    - [JBAfterCashOutRecordedContext](src/structs/JBAfterCashOutRecordedContext.sol/struct.JBAfterCashOutRecordedContext.md)
+    - [JBAfterPayRecordedContext](src/structs/JBAfterPayRecordedContext.sol/struct.JBAfterPayRecordedContext.md)
+    - [JBBeforeCashOutRecordedContext](src/structs/JBBeforeCashOutRecordedContext.sol/struct.JBBeforeCashOutRecordedContext.md)
+    - [JBBeforePayRecordedContext](src/structs/JBBeforePayRecordedContext.sol/struct.JBBeforePayRecordedContext.md)
+    - [JBCashOutHookSpecification](src/structs/JBCashOutHookSpecification.sol/struct.JBCashOutHookSpecification.md)
+    - [JBCurrencyAmount](src/structs/JBCurrencyAmount.sol/struct.JBCurrencyAmount.md)
+    - [JBFee](src/structs/JBFee.sol/struct.JBFee.md)
+    - [JBFundAccessLimitGroup](src/structs/JBFundAccessLimitGroup.sol/struct.JBFundAccessLimitGroup.md)
+    - [JBPayHookSpecification](src/structs/JBPayHookSpecification.sol/struct.JBPayHookSpecification.md)
+    - [JBPermissionsData](src/structs/JBPermissionsData.sol/struct.JBPermissionsData.md)
+    - [JBRuleset](src/structs/JBRuleset.sol/struct.JBRuleset.md)
+    - [JBRulesetConfig](src/structs/JBRulesetConfig.sol/struct.JBRulesetConfig.md)
+    - [JBRulesetMetadata](src/structs/JBRulesetMetadata.sol/struct.JBRulesetMetadata.md)
+    - [JBRulesetWeightCache](src/structs/JBRulesetWeightCache.sol/struct.JBRulesetWeightCache.md)
+    - [JBRulesetWithMetadata](src/structs/JBRulesetWithMetadata.sol/struct.JBRulesetWithMetadata.md)
+    - [JBSingleAllowance](src/structs/JBSingleAllowance.sol/struct.JBSingleAllowance.md)
+    - [JBSplit](src/structs/JBSplit.sol/struct.JBSplit.md)
+    - [JBSplitGroup](src/structs/JBSplitGroup.sol/struct.JBSplitGroup.md)
+    - [JBSplitHookContext](src/structs/JBSplitHookContext.sol/struct.JBSplitHookContext.md)
+    - [JBTerminalConfig](src/structs/JBTerminalConfig.sol/struct.JBTerminalConfig.md)
+    - [JBTokenAmount](src/structs/JBTokenAmount.sol/struct.JBTokenAmount.md)
+  - [JBChainlinkV3PriceFeed](src/JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md)
+  - [JBChainlinkV3SequencerPriceFeed](src/JBChainlinkV3SequencerPriceFeed.sol/contract.JBChainlinkV3SequencerPriceFeed.md)
+  - [JBController](src/JBController.sol/contract.JBController.md)
+  - [JBDeadline](src/JBDeadline.sol/contract.JBDeadline.md)
+  - [JBDirectory](src/JBDirectory.sol/contract.JBDirectory.md)
+  - [JBERC20](src/JBERC20.sol/contract.JBERC20.md)
+  - [JBFeelessAddresses](src/JBFeelessAddresses.sol/contract.JBFeelessAddresses.md)
+  - [JBFundAccessLimits](src/JBFundAccessLimits.sol/contract.JBFundAccessLimits.md)
+  - [JBMultiTerminal](src/JBMultiTerminal.sol/contract.JBMultiTerminal.md)
+  - [JBPermissions](src/JBPermissions.sol/contract.JBPermissions.md)
+  - [JBPrices](src/JBPrices.sol/contract.JBPrices.md)
+  - [JBProjects](src/JBProjects.sol/contract.JBProjects.md)
+  - [JBRulesets](src/JBRulesets.sol/contract.JBRulesets.md)
+  - [JBSplits](src/JBSplits.sol/contract.JBSplits.md)
+  - [JBTerminalStore](src/JBTerminalStore.sol/contract.JBTerminalStore.md)
+  - [JBTokens](src/JBTokens.sol/contract.JBTokens.md)

package/docs/src/src/JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md

@@ -0,0 +1,83 @@
+# JBChainlinkV3PriceFeed
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBChainlinkV3PriceFeed.sol)
+
+**Inherits:**
+[IJBPriceFeed](/src/interfaces/IJBPriceFeed.sol/interface.IJBPriceFeed.md)
+
+An `IJBPriceFeed` implementation that reports prices from a Chainlink `AggregatorV3Interface`.
+
+
+## State Variables
+### FEED
+The Chainlink feed that prices are reported from.
+
+
+```solidity
+AggregatorV3Interface public immutable FEED;
+```
+
+
+### THRESHOLD
+How many seconds old a Chainlink price update is allowed to be before considered "stale".
+
+
+```solidity
+uint256 public immutable THRESHOLD;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(AggregatorV3Interface feed, uint256 threshold);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`feed`|`AggregatorV3Interface`|The Chainlink feed to report prices from.|
+|`threshold`|`uint256`|How many seconds old a price update may be.|
+
+
+### currentUnitPrice
+
+Gets the current price (per 1 unit) from the feed.
+
+
+```solidity
+function currentUnitPrice(uint256 decimals) public view virtual override returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`decimals`|`uint256`|The number of decimals the return value should use.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The current unit price from the feed, as a fixed point number with the specified number of decimals.|
+
+
+## Errors
+### JBChainlinkV3PriceFeed_IncompleteRound
+
+```solidity
+error JBChainlinkV3PriceFeed_IncompleteRound();
+```
+
+### JBChainlinkV3PriceFeed_NegativePrice
+
+```solidity
+error JBChainlinkV3PriceFeed_NegativePrice(int256 price);
+```
+
+### JBChainlinkV3PriceFeed_StalePrice
+
+```solidity
+error JBChainlinkV3PriceFeed_StalePrice(uint256 timestamp, uint256 threshold, uint256 updatedAt);
+```
+

package/docs/src/src/JBChainlinkV3SequencerPriceFeed.sol/contract.JBChainlinkV3SequencerPriceFeed.md

@@ -0,0 +1,88 @@
+# JBChainlinkV3SequencerPriceFeed
+[Git Source](https://github.com/Bananapus/nana-core/blob/2998dca2fbd2658e2c8791d6dc8348147d69e28e/src/JBChainlinkV3SequencerPriceFeed.sol)
+
+**Inherits:**
+[JBChainlinkV3PriceFeed](/src/JBChainlinkV3PriceFeed.sol/contract.JBChainlinkV3PriceFeed.md)
+
+An `IJBPriceFeed` implementation that reports prices from a Chainlink `AggregatorV3Interface` from
+optimistic sequencers.
+
+
+## State Variables
+### GRACE_PERIOD_TIME
+How long the sequencer must be re-active in order to return a price.
+
+
+```solidity
+uint256 public immutable GRACE_PERIOD_TIME;
+```
+
+
+### SEQUENCER_FEED
+The Chainlink sequencer feed that prices are reported from.
+
+
+```solidity
+AggregatorV2V3Interface public immutable SEQUENCER_FEED;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(
+    AggregatorV3Interface feed,
+    uint256 gracePeriod,
+    AggregatorV2V3Interface sequencerFeed,
+    uint256 threshold
+)
+    JBChainlinkV3PriceFeed(feed, threshold);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`feed`|`AggregatorV3Interface`|The Chainlink feed to report prices from.|
+|`gracePeriod`|`uint256`|How long the sequencer should have been re-active before returning prices.|
+|`sequencerFeed`|`AggregatorV2V3Interface`|The Chainlink feed to report sequencer status.|
+|`threshold`|`uint256`|How many blocks old a price update may be.|
+
+
+### currentUnitPrice
+
+Gets the current price (per 1 unit) from the feed.
+
+
+```solidity
+function currentUnitPrice(uint256 decimals) public view override returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`decimals`|`uint256`|The number of decimals the return value should use.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The current unit price from the feed, as a fixed point number with the specified number of decimals.|
+
+
+## Errors
+### JBChainlinkV3SequencerPriceFeed_SequencerDownOrRestarting
+
+```solidity
+error JBChainlinkV3SequencerPriceFeed_SequencerDownOrRestarting(
+    uint256 timestamp, uint256 gradePeriodTime, uint256 startedAt
+);
+```
+
+### JBChainlinkV3SequencerPriceFeed_InvalidRound
+
+```solidity
+error JBChainlinkV3SequencerPriceFeed_InvalidRound();
+```
+