@bananapus/721-hook-v6 0.0.1

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

@@ -0,0 +1,265 @@
+# IJB721TiersHookStore
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721TiersHookStore.sol)
+
+
+## Functions
+### balanceOf
+
+
+```solidity
+function balanceOf(address hook, address owner) external view returns (uint256);
+```
+
+### cashOutWeightOf
+
+
+```solidity
+function cashOutWeightOf(address hook, uint256[] calldata tokenIds) external view returns (uint256 weight);
+```
+
+### defaultReserveBeneficiaryOf
+
+
+```solidity
+function defaultReserveBeneficiaryOf(address hook) external view returns (address);
+```
+
+### encodedIPFSUriOf
+
+
+```solidity
+function encodedIPFSUriOf(address hook, uint256 tierId) external view returns (bytes32);
+```
+
+### encodedTierIPFSUriOf
+
+
+```solidity
+function encodedTierIPFSUriOf(address hook, uint256 tokenId) external view returns (bytes32);
+```
+
+### flagsOf
+
+
+```solidity
+function flagsOf(address hook) external view returns (JB721TiersHookFlags memory);
+```
+
+### isTierRemoved
+
+
+```solidity
+function isTierRemoved(address hook, uint256 tierId) external view returns (bool);
+```
+
+### maxTierIdOf
+
+
+```solidity
+function maxTierIdOf(address hook) external view returns (uint256);
+```
+
+### numberOfBurnedFor
+
+
+```solidity
+function numberOfBurnedFor(address hook, uint256 tierId) external view returns (uint256);
+```
+
+### numberOfPendingReservesFor
+
+
+```solidity
+function numberOfPendingReservesFor(address hook, uint256 tierId) external view returns (uint256);
+```
+
+### numberOfReservesMintedFor
+
+
+```solidity
+function numberOfReservesMintedFor(address hook, uint256 tierId) external view returns (uint256);
+```
+
+### reserveBeneficiaryOf
+
+
+```solidity
+function reserveBeneficiaryOf(address hook, uint256 tierId) external view returns (address);
+```
+
+### tierBalanceOf
+
+
+```solidity
+function tierBalanceOf(address hook, address owner, uint256 tier) external view returns (uint256);
+```
+
+### tierIdOfToken
+
+
+```solidity
+function tierIdOfToken(uint256 tokenId) external pure returns (uint256);
+```
+
+### tierOf
+
+
+```solidity
+function tierOf(address hook, uint256 id, bool includeResolvedUri) external view returns (JB721Tier memory tier);
+```
+
+### tierOfTokenId
+
+
+```solidity
+function tierOfTokenId(
+    address hook,
+    uint256 tokenId,
+    bool includeResolvedUri
+)
+    external
+    view
+    returns (JB721Tier memory tier);
+```
+
+### tiersOf
+
+
+```solidity
+function tiersOf(
+    address hook,
+    uint256[] calldata categories,
+    bool includeResolvedUri,
+    uint256 startingSortIndex,
+    uint256 size
+)
+    external
+    view
+    returns (JB721Tier[] memory tiers);
+```
+
+### tierVotingUnitsOf
+
+
+```solidity
+function tierVotingUnitsOf(address hook, address account, uint256 tierId) external view returns (uint256 units);
+```
+
+### tokenUriResolverOf
+
+
+```solidity
+function tokenUriResolverOf(address hook) external view returns (IJB721TokenUriResolver);
+```
+
+### totalCashOutWeight
+
+
+```solidity
+function totalCashOutWeight(address hook) external view returns (uint256 weight);
+```
+
+### totalSupplyOf
+
+
+```solidity
+function totalSupplyOf(address hook) external view returns (uint256);
+```
+
+### votingUnitsOf
+
+
+```solidity
+function votingUnitsOf(address hook, address account) external view returns (uint256 units);
+```
+
+### cleanTiers
+
+
+```solidity
+function cleanTiers(address hook) external;
+```
+
+### recordAddTiers
+
+
+```solidity
+function recordAddTiers(JB721TierConfig[] calldata tierData) external returns (uint256[] memory tierIds);
+```
+
+### recordBurn
+
+
+```solidity
+function recordBurn(uint256[] calldata tokenIds) external;
+```
+
+### recordFlags
+
+
+```solidity
+function recordFlags(JB721TiersHookFlags calldata flag) external;
+```
+
+### recordMint
+
+
+```solidity
+function recordMint(
+    uint256 amount,
+    uint16[] calldata tierIds,
+    bool isOwnerMint
+)
+    external
+    returns (uint256[] memory tokenIds, uint256 leftoverAmount);
+```
+
+### recordMintReservesFor
+
+
+```solidity
+function recordMintReservesFor(uint256 tierId, uint256 count) external returns (uint256[] memory tokenIds);
+```
+
+### recordRemoveTierIds
+
+
+```solidity
+function recordRemoveTierIds(uint256[] calldata tierIds) external;
+```
+
+### recordSetEncodedIPFSUriOf
+
+
+```solidity
+function recordSetEncodedIPFSUriOf(uint256 tierId, bytes32 encodedIPFSUri) external;
+```
+
+### recordSetDiscountPercentOf
+
+
+```solidity
+function recordSetDiscountPercentOf(uint256 tierId, uint256 discountPercent) external;
+```
+
+### recordSetTokenUriResolver
+
+
+```solidity
+function recordSetTokenUriResolver(IJB721TokenUriResolver resolver) external;
+```
+
+### recordTransferForTier
+
+
+```solidity
+function recordTransferForTier(uint256 tierId, address from, address to) external;
+```
+
+## Events
+### CleanTiers
+
+```solidity
+event CleanTiers(address indexed hook, address caller);
+```
+

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

@@ -0,0 +1,12 @@
+# IJB721TokenUriResolver
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721TokenUriResolver.sol)
+
+
+## Functions
+### tokenUriOf
+
+
+```solidity
+function tokenUriOf(address nft, uint256 tokenId) external view returns (string memory tokenUri);
+```
+

package/docs/src/src/interfaces/README.md

@@ -0,0 +1,9 @@
+
+
+# Contents
+- [IJB721Hook](IJB721Hook.sol/interface.IJB721Hook.md)
+- [IJB721TiersHook](IJB721TiersHook.sol/interface.IJB721TiersHook.md)
+- [IJB721TiersHookDeployer](IJB721TiersHookDeployer.sol/interface.IJB721TiersHookDeployer.md)
+- [IJB721TiersHookProjectDeployer](IJB721TiersHookProjectDeployer.sol/interface.IJB721TiersHookProjectDeployer.md)
+- [IJB721TiersHookStore](IJB721TiersHookStore.sol/interface.IJB721TiersHookStore.md)
+- [IJB721TokenUriResolver](IJB721TokenUriResolver.sol/interface.IJB721TokenUriResolver.md)

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

@@ -0,0 +1,14 @@
+# JB721Constants
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/libraries/JB721Constants.sol)
+
+Global constants used across 721 hook contracts.
+
+
+## State Variables
+### MAX_DISCOUNT_PERCENT
+
+```solidity
+uint16 public constant MAX_DISCOUNT_PERCENT = 200;
+```
+
+

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

@@ -0,0 +1,68 @@
+# JB721TiersRulesetMetadataResolver
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/libraries/JB721TiersRulesetMetadataResolver.sol)
+
+Utility library to parse and store ruleset metadata associated for the tiered 721 hook.
+
+*This library parses the `metadata` member of the `JBRulesetMetadata` struct.*
+
+
+## Functions
+### transfersPaused
+
+
+```solidity
+function transfersPaused(uint256 data) internal pure returns (bool);
+```
+
+### mintPendingReservesPaused
+
+
+```solidity
+function mintPendingReservesPaused(uint256 data) internal pure returns (bool);
+```
+
+### pack721TiersRulesetMetadata
+
+Pack the ruleset metadata for the 721 hook into a single `uint256`.
+
+
+```solidity
+function pack721TiersRulesetMetadata(JB721TiersRulesetMetadata memory metadata)
+    internal
+    pure
+    returns (uint256 packed);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`metadata`|`JB721TiersRulesetMetadata`|The metadata to validate and pack.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`packed`|`uint256`|A `uint256` containing the packed metadata for the 721 hook.|
+
+
+### expandMetadata
+
+Expand packed ruleset metadata for the 721 hook.
+
+
+```solidity
+function expandMetadata(uint16 packedMetadata) internal pure returns (JB721TiersRulesetMetadata memory metadata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`packedMetadata`|`uint16`|The packed metadata to expand.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`metadata`|`JB721TiersRulesetMetadata`|The metadata as a `JB721TiersRulesetMetadata` struct.|
+
+

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

@@ -0,0 +1,82 @@
+# JBBitmap
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/libraries/JBBitmap.sol)
+
+Utilities to manage a bool bitmap. Used for storing inactive tiers.
+
+
+## Functions
+### readId
+
+Initialize a `JBBitmapWord` struct based on a mapping storage pointer and an index.
+
+
+```solidity
+function readId(mapping(uint256 => uint256) storage self, uint256 index) internal view returns (JBBitmapWord memory);
+```
+
+### isTierIdRemoved
+
+Get the status of the specified bit within the `JBBitmapWord` struct.
+
+*The `index` is the index that the bit would have if the bitmap were reshaped to a 1*n matrix.*
+
+
+```solidity
+function isTierIdRemoved(JBBitmapWord memory self, uint256 index) internal pure returns (bool);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|The boolean value at the specified index, which indicates whether the corresponding tier has been removed.|
+
+
+### isTierIdRemoved
+
+Get the status of the specified bit within the `JBBitmapWord` struct.
+
+*The `index` is the index that the bit would have if the bitmap were reshaped to a 1*n matrix.*
+
+
+```solidity
+function isTierIdRemoved(mapping(uint256 => uint256) storage self, uint256 index) internal view returns (bool);
+```
+
+### removeTier
+
+Set the bit at the given index to true, indicating that the corresponding tier has been removed.
+
+*This is a one-way operation.*
+
+
+```solidity
+function removeTier(mapping(uint256 => uint256) storage self, uint256 index) internal;
+```
+
+### refreshBitmapNeeded
+
+Check if the specified index is at a different depth than than the current depth of the `JBBitmapWord`
+struct.
+
+*If the depth is different, the bitmap's current depth needs to be updated.*
+
+
+```solidity
+function refreshBitmapNeeded(JBBitmapWord memory self, uint256 index) internal pure returns (bool);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|Whether the bitmap needs to be refreshed.|
+
+
+### _retrieveDepth
+
+Return the line number (depth) of a given index within the bitmap matrix.
+
+
+```solidity
+function _retrieveDepth(uint256 index) internal pure returns (uint256);
+```
+

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

@@ -0,0 +1,61 @@
+# JBIpfsDecoder
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/libraries/JBIpfsDecoder.sol)
+
+Utilities to decode an IPFS hash.
+
+*This is fairly gas intensive due to multiple nested loops. Onchain IPFS hash decoding is not advised –
+storing them as a string *might* be more efficient for that use-case.*
+
+
+## State Variables
+### ALPHABET
+Just a kind reminder to our readers.
+
+*Used in `base58ToString`*
+
+
+```solidity
+bytes internal constant ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+```
+
+
+## Functions
+### decode
+
+
+```solidity
+function decode(string memory baseUri, bytes32 hexString) internal pure returns (string memory);
+```
+
+### _toBase58
+
+Convert a hex string to base58
+
+Written by Martin Ludfall - Licence: MIT
+
+
+```solidity
+function _toBase58(bytes memory source) private pure returns (string memory);
+```
+
+### _truncate
+
+
+```solidity
+function _truncate(uint8[] memory array, uint8 length) private pure returns (uint8[] memory);
+```
+
+### _reverse
+
+
+```solidity
+function _reverse(uint8[] memory input) private pure returns (uint8[] memory);
+```
+
+### _toAlphabet
+
+
+```solidity
+function _toAlphabet(uint8[] memory indices) private pure returns (bytes memory);
+```
+

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

@@ -0,0 +1,7 @@
+
+
+# Contents
+- [JB721Constants](JB721Constants.sol/library.JB721Constants.md)
+- [JB721TiersRulesetMetadataResolver](JB721TiersRulesetMetadataResolver.sol/library.JB721TiersRulesetMetadataResolver.md)
+- [JBBitmap](JBBitmap.sol/library.JBBitmap.md)
+- [JBIpfsDecoder](JBIpfsDecoder.sol/library.JBIpfsDecoder.md)

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

@@ -0,0 +1,27 @@
+# JB721InitTiersConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721InitTiersConfig.sol)
+
+Config to initialize a `JB721TiersHook` with tiers and price data.
+
+*The `tiers` must be sorted by price (from least to greatest).*
+
+**Notes:**
+- member: tiers The tiers to initialize the hook with.
+
+- member: currency The currency that the tier prices are denoted in. See `JBPrices`.
+
+- member: decimals The number of decimals in the fixed point tier prices.
+
+- member: prices A contract that exposes price feeds that can be used to calculate prices in different
+currencies. To only accept payments in `currency`, set `prices` to the zero address. See `JBPrices`.
+
+
+```solidity
+struct JB721InitTiersConfig {
+    JB721TierConfig[] tiers;
+    uint32 currency;
+    uint8 decimals;
+    IJBPrices prices;
+}
+```
+

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

@@ -0,0 +1,59 @@
+# JB721Tier
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721Tier.sol)
+
+**Notes:**
+- member: id The tier's ID.
+
+- member: price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+
+- member: remainingSupply The remaining number of NFTs which can be minted from this tier.
+
+- member: initialSupply The total number of NFTs which can be minted from this tier.
+
+- member: votingUnits The number of votes that each NFT in this tier gets.
+
+- member: reserveFrequency The frequency at which an extra NFT is minted for the `reserveBeneficiary` from this
+tier. With a `reserveFrequency` of 5, an extra NFT will be minted for the `reserveBeneficiary` for every 5 NFTs
+purchased.
+
+- member: reserveBeneficiary The address which receives any reserve NFTs from this tier.
+
+- member: encodedIPFSUri The IPFS URI to use for each NFT in this tier.
+
+- member: category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+
+- member: discountPercent The discount that should be applied to the tier.
+
+- member: allowOwnerMint A boolean indicating whether the contract's owner can mint NFTs from this tier
+on-demand.
+
+- member: cannotBeRemoved A boolean indicating whether attempts to remove this tier will revert.
+
+- member: cannotIncreaseDiscountPercent If the tier cannot have its discount increased.
+
+- member: transfersPausable A boolean indicating whether transfers for NFTs in tier can be paused.
+
+- member: resolvedUri A resolved token URI for NFTs in this tier. Only available if the NFT this tier belongs
+to has a resolver.
+
+
+```solidity
+struct JB721Tier {
+    uint32 id;
+    uint104 price;
+    uint32 remainingSupply;
+    uint32 initialSupply;
+    uint104 votingUnits;
+    uint16 reserveFrequency;
+    address reserveBeneficiary;
+    bytes32 encodedIPFSUri;
+    uint24 category;
+    uint8 discountPercent;
+    bool allowOwnerMint;
+    bool transfersPausable;
+    bool cannotBeRemoved;
+    bool cannotIncreaseDiscountPercent;
+    string resolvedUri;
+}
+```
+

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

@@ -0,0 +1,60 @@
+# JB721TierConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721TierConfig.sol)
+
+Config for a single NFT tier within a `JB721TiersHook`.
+
+**Notes:**
+- member: price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+
+- member: initialSupply The total number of NFTs which can be minted from this tier.
+
+- member: votingUnits The number of votes that each NFT in this tier gets if `useVotingUnits` is true.
+
+- member: reserveFrequency The frequency at which an extra NFT is minted for the `reserveBeneficiary` from this
+tier. With a `reserveFrequency` of 5, an extra NFT will be minted for the `reserveBeneficiary` for every 5 NFTs
+purchased.
+
+- member: reserveBeneficiary The address which receives any reserve NFTs from this tier. Overrides the default
+reserve beneficiary if one is set.
+
+- member: encodedIPFSUri The IPFS URI to use for each NFT in this tier.
+
+- member: category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+
+- member: discountPercent The discount that should be applied to the tier.
+
+- member: allowOwnerMint A boolean indicating whether the contract's owner can mint NFTs from this tier
+on-demand.
+
+- member: useReserveBeneficiaryAsDefault A boolean indicating whether this tier's `reserveBeneficiary` should
+be stored as the default beneficiary for all tiers.
+
+- member: transfersPausable A boolean indicating whether transfers for NFTs in tier can be paused.
+
+- member: useVotingUnits A boolean indicating whether the `votingUnits` should be used to calculate voting
+power. If `useVotingUnits` is false, voting power is based on the tier's price.
+
+- member: cannotBeRemoved If the tier cannot be removed once added.
+
+- member: cannotIncreaseDiscount If the tier cannot have its discount increased.
+
+
+```solidity
+struct JB721TierConfig {
+    uint104 price;
+    uint32 initialSupply;
+    uint32 votingUnits;
+    uint16 reserveFrequency;
+    address reserveBeneficiary;
+    bytes32 encodedIPFSUri;
+    uint24 category;
+    uint8 discountPercent;
+    bool allowOwnerMint;
+    bool useReserveBeneficiaryAsDefault;
+    bool transfersPausable;
+    bool useVotingUnits;
+    bool cannotBeRemoved;
+    bool cannotIncreaseDiscountPercent;
+}
+```
+

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

@@ -0,0 +1,26 @@
+# JB721TiersHookFlags
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721TiersHookFlags.sol)
+
+**Notes:**
+- member: noNewTiersWithReserves A boolean indicating whether attempts to add new tiers with a non-zero
+`reserveFrequency` will revert.
+
+- member: noNewTiersWithVotes A boolean indicating whether attempts to add new tiers with non-zero
+`votingUnits` will revert.
+
+- member: noNewTiersWithOwnerMinting A boolean indicating whether attempts to add new tiers with
+`allowOwnerMint` set to true will revert.
+
+- member: preventOverspending A boolean indicating whether payments attempting to spend more than the price of
+the NFTs being minted will revert.
+
+
+```solidity
+struct JB721TiersHookFlags {
+    bool noNewTiersWithReserves;
+    bool noNewTiersWithVotes;
+    bool noNewTiersWithOwnerMinting;
+    bool preventOverspending;
+}
+```
+