@bananapus/721-hook-v6 0.0.1

package/docs/src/src/abstract/JB721Hook.sol/abstract.JB721Hook.md

@@ -0,0 +1,309 @@
+# JB721Hook
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/abstract/JB721Hook.sol)
+
+**Inherits:**
+[ERC721](/src/abstract/ERC721.sol/abstract.ERC721.md), [IJB721Hook](/src/interfaces/IJB721Hook.sol/interface.IJB721Hook.md)
+
+When a project which uses this hook is paid, this hook may mint NFTs to the payer, depending on this hook's
+setup, the amount paid, and information specified by the payer. The project's owner can enable NFT cash outs.
+through this hook, allowing the NFT holders to burn their NFTs to reclaim funds from the project (in proportion to
+the NFT's price).
+
+
+## State Variables
+### DIRECTORY
+The directory of terminals and controllers for projects.
+
+
+```solidity
+IJBDirectory public immutable override DIRECTORY;
+```
+
+
+### METADATA_ID_TARGET
+The ID used when parsing metadata.
+
+
+```solidity
+address public immutable override METADATA_ID_TARGET;
+```
+
+
+### PROJECT_ID
+The ID of the project that this contract is associated with.
+
+
+```solidity
+uint256 public override PROJECT_ID;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(IJBDirectory directory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`directory`|`IJBDirectory`|A directory of terminals and controllers for projects.|
+
+
+### beforePayRecordedWith
+
+The data calculated before a payment is recorded in the terminal store. This data is provided to the
+terminal's `pay(...)` transaction.
+
+*Sets this contract as the pay hook. Part of `IJBRulesetDataHook`.*
+
+
+```solidity
+function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
+    public
+    view
+    virtual
+    override
+    returns (uint256 weight, JBPayHookSpecification[] memory hookSpecifications);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBBeforePayRecordedContext`|The payment context passed to this contract by the `pay(...)` function.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`weight`|`uint256`|The new `weight` to use, overriding the ruleset's `weight`.|
+|`hookSpecifications`|`JBPayHookSpecification[]`|The amount and data to send to pay hooks (this contract) instead of adding to the terminal's balance.|
+
+
+### beforeCashOutRecordedWith
+
+The data calculated before a cash out is recorded in the terminal store. This data is provided to the
+terminal's `cashOutTokensOf(...)` transaction.
+
+*Sets this contract as the cash out hook. Part of `IJBRulesetDataHook`.*
+
+*This function is used for NFT cash outs, and will only be called if the project's ruleset has
+`useDataHookForCashOut` set to `true`.*
+
+
+```solidity
+function beforeCashOutRecordedWith(JBBeforeCashOutRecordedContext calldata context)
+    public
+    view
+    virtual
+    override
+    returns (
+        uint256 cashOutTaxRate,
+        uint256 cashOutCount,
+        uint256 totalSupply,
+        JBCashOutHookSpecification[] memory hookSpecifications
+    );
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBBeforeCashOutRecordedContext`|The cash out context passed to this contract by the `cashOutTokensOf(...)` function.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`cashOutTaxRate`|`uint256`|The cash out tax rate influencing the reclaim amount.|
+|`cashOutCount`|`uint256`|The amount of tokens that should be considered cashed out.|
+|`totalSupply`|`uint256`|The total amount of tokens that are considered to be existing.|
+|`hookSpecifications`|`JBCashOutHookSpecification[]`|The amount and data to send to cash out hooks (this contract) instead of returning to the beneficiary.|
+
+
+### hasMintPermissionFor
+
+Required by the IJBRulesetDataHook interfaces. Return false to not leak any permissions.
+
+
+```solidity
+function hasMintPermissionFor(uint256, address) external pure returns (bool);
+```
+
+### cashOutWeightOf
+
+Returns the cumulative cash out weight of the specified token IDs relative to the
+`totalCashOutWeight`.
+
+
+```solidity
+function cashOutWeightOf(
+    uint256[] memory tokenIds,
+    JBBeforeCashOutRecordedContext calldata context
+)
+    public
+    view
+    virtual
+    returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`tokenIds`|`uint256[]`|The NFT token IDs to calculate the cumulative cash out weight of.|
+|`context`|`JBBeforeCashOutRecordedContext`|The cash out context passed to this contract by the `cashOutTokensOf(...)` function.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The cumulative cash out weight of the specified token IDs.|
+
+
+### supportsInterface
+
+Indicates if this contract adheres to the specified interface.
+
+*See [IERC165-supportsInterface](/src/JB721TiersHook.sol/contract.JB721TiersHook.md#supportsinterface).*
+
+
+```solidity
+function supportsInterface(bytes4 _interfaceId) public view virtual override(ERC721, IERC165) returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_interfaceId`|`bytes4`|The ID of the interface to check for adherence to.|
+
+
+### totalCashOutWeight
+
+Calculates the cumulative cash out weight of all NFT token IDs.
+
+
+```solidity
+function totalCashOutWeight(JBBeforeCashOutRecordedContext calldata context) public view virtual returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBBeforeCashOutRecordedContext`|The cash out context passed to this contract by the `cashOutTokensOf(...)` function.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The total cumulative cash out weight of all NFT token IDs.|
+
+
+### _initialize
+
+Initializes the contract by associating it with a project and adding ERC721 details.
+
+
+```solidity
+function _initialize(uint256 projectId, string memory name, string memory symbol) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`projectId`|`uint256`|The ID of the project that this contract is associated with.|
+|`name`|`string`|The name of the NFT collection.|
+|`symbol`|`string`|The symbol representing the NFT collection.|
+
+
+### afterPayRecordedWith
+
+Mints one or more NFTs to the `context.benficiary` upon payment if conditions are met. Part of
+`IJBPayHook`.
+
+*Reverts if the calling contract is not one of the project's terminals.*
+
+
+```solidity
+function afterPayRecordedWith(JBAfterPayRecordedContext calldata context) external payable virtual override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBAfterPayRecordedContext`|The payment context passed in by the terminal.|
+
+
+### afterCashOutRecordedWith
+
+Burns the specified NFTs upon token holder cash out, reclaiming funds from the project's balance for
+`context.beneficiary`. Part of `IJBCashOutHook`.
+
+*Reverts if the calling contract is not one of the project's terminals.*
+
+
+```solidity
+function afterCashOutRecordedWith(JBAfterCashOutRecordedContext calldata context) external payable virtual override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBAfterCashOutRecordedContext`|The cash out context passed in by the terminal.|
+
+
+### _didBurn
+
+Executes after NFTs have been burned via cash out.
+
+
+```solidity
+function _didBurn(uint256[] memory tokenIds) internal virtual;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`tokenIds`|`uint256[]`|The token IDs of the NFTs that were burned.|
+
+
+### _processPayment
+
+Process a received payment.
+
+
+```solidity
+function _processPayment(JBAfterPayRecordedContext calldata context) internal virtual;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`context`|`JBAfterPayRecordedContext`|The payment context passed in by the terminal.|
+
+
+## Errors
+### JB721Hook_InvalidPay
+
+```solidity
+error JB721Hook_InvalidPay();
+```
+
+### JB721Hook_InvalidCashOut
+
+```solidity
+error JB721Hook_InvalidCashOut();
+```
+
+### JB721Hook_UnauthorizedToken
+
+```solidity
+error JB721Hook_UnauthorizedToken(uint256 tokenId, address holder);
+```
+
+### JB721Hook_UnexpectedTokenCashedOut
+
+```solidity
+error JB721Hook_UnexpectedTokenCashedOut();
+```
+

package/docs/src/src/abstract/README.md

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [ERC721](ERC721.sol/abstract.ERC721.md)
+- [JB721Hook](JB721Hook.sol/abstract.JB721Hook.md)

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

@@ -0,0 +1,29 @@
+# IJB721Hook
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721Hook.sol)
+
+**Inherits:**
+IJBRulesetDataHook, IJBPayHook, IJBCashOutHook
+
+
+## Functions
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### METADATA_ID_TARGET
+
+
+```solidity
+function METADATA_ID_TARGET() external view returns (address);
+```
+
+### PROJECT_ID
+
+
+```solidity
+function PROJECT_ID() external view returns (uint256);
+```
+

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

@@ -0,0 +1,203 @@
+# IJB721TiersHook
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721TiersHook.sol)
+
+**Inherits:**
+[IJB721Hook](/src/interfaces/IJB721Hook.sol/interface.IJB721Hook.md)
+
+
+## Functions
+### RULESETS
+
+
+```solidity
+function RULESETS() external view returns (IJBRulesets);
+```
+
+### STORE
+
+
+```solidity
+function STORE() external view returns (IJB721TiersHookStore);
+```
+
+### baseURI
+
+
+```solidity
+function baseURI() external view returns (string memory);
+```
+
+### contractURI
+
+
+```solidity
+function contractURI() external view returns (string memory);
+```
+
+### firstOwnerOf
+
+
+```solidity
+function firstOwnerOf(uint256 tokenId) external view returns (address);
+```
+
+### payCreditsOf
+
+
+```solidity
+function payCreditsOf(address addr) external view returns (uint256);
+```
+
+### pricingContext
+
+
+```solidity
+function pricingContext() external view returns (uint256, uint256, IJBPrices);
+```
+
+### adjustTiers
+
+
+```solidity
+function adjustTiers(JB721TierConfig[] calldata tierDataToAdd, uint256[] calldata tierIdsToRemove) external;
+```
+
+### initialize
+
+
+```solidity
+function initialize(
+    uint256 projectId,
+    string memory name,
+    string memory symbol,
+    string memory baseUri,
+    IJB721TokenUriResolver tokenUriResolver,
+    string memory contractUri,
+    JB721InitTiersConfig memory tiersConfig,
+    JB721TiersHookFlags memory flags
+)
+    external;
+```
+
+### setDiscountPercentOf
+
+
+```solidity
+function setDiscountPercentOf(uint256 tierId, uint256 discountPercent) external;
+```
+
+### setDiscountPercentsOf
+
+
+```solidity
+function setDiscountPercentsOf(JB721TiersSetDiscountPercentConfig[] calldata configs) external;
+```
+
+### mintFor
+
+
+```solidity
+function mintFor(uint16[] calldata tierIds, address beneficiary) external returns (uint256[] memory tokenIds);
+```
+
+### mintPendingReservesFor
+
+
+```solidity
+function mintPendingReservesFor(JB721TiersMintReservesConfig[] calldata reserveMintConfigs) external;
+```
+
+### mintPendingReservesFor
+
+
+```solidity
+function mintPendingReservesFor(uint256 tierId, uint256 count) external;
+```
+
+### setMetadata
+
+
+```solidity
+function setMetadata(
+    string calldata baseUri,
+    string calldata contractMetadataUri,
+    IJB721TokenUriResolver tokenUriResolver,
+    uint256 encodedIPFSUriTierId,
+    bytes32 encodedIPFSUri
+)
+    external;
+```
+
+## Events
+### AddPayCredits
+
+```solidity
+event AddPayCredits(uint256 indexed amount, uint256 indexed newTotalCredits, address indexed account, address caller);
+```
+
+### AddTier
+
+```solidity
+event AddTier(uint256 indexed tierId, JB721TierConfig tier, address caller);
+```
+
+### Mint
+
+```solidity
+event Mint(
+    uint256 indexed tokenId,
+    uint256 indexed tierId,
+    address indexed beneficiary,
+    uint256 totalAmountPaid,
+    address caller
+);
+```
+
+### MintReservedNft
+
+```solidity
+event MintReservedNft(uint256 indexed tokenId, uint256 indexed tierId, address indexed beneficiary, address caller);
+```
+
+### RemoveTier
+
+```solidity
+event RemoveTier(uint256 indexed tierId, address caller);
+```
+
+### SetBaseUri
+
+```solidity
+event SetBaseUri(string indexed baseUri, address caller);
+```
+
+### SetContractUri
+
+```solidity
+event SetContractUri(string indexed uri, address caller);
+```
+
+### SetDiscountPercent
+
+```solidity
+event SetDiscountPercent(uint256 indexed tierId, uint256 discountPercent, address caller);
+```
+
+### SetEncodedIPFSUri
+
+```solidity
+event SetEncodedIPFSUri(uint256 indexed tierId, bytes32 encodedUri, address caller);
+```
+
+### SetTokenUriResolver
+
+```solidity
+event SetTokenUriResolver(IJB721TokenUriResolver indexed resolver, address caller);
+```
+
+### UsePayCredits
+
+```solidity
+event UsePayCredits(uint256 indexed amount, uint256 indexed newTotalCredits, address indexed account, address caller);
+```
+

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

@@ -0,0 +1,25 @@
+# IJB721TiersHookDeployer
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721TiersHookDeployer.sol)
+
+
+## Functions
+### deployHookFor
+
+
+```solidity
+function deployHookFor(
+    uint256 projectId,
+    JBDeploy721TiersHookConfig memory deployTiersHookConfig,
+    bytes32 salt
+)
+    external
+    returns (IJB721TiersHook hook);
+```
+
+## Events
+### HookDeployed
+
+```solidity
+event HookDeployed(uint256 indexed projectId, IJB721TiersHook hook, address caller);
+```
+

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

@@ -0,0 +1,64 @@
+# IJB721TiersHookProjectDeployer
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/interfaces/IJB721TiersHookProjectDeployer.sol)
+
+
+## Functions
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### HOOK_DEPLOYER
+
+
+```solidity
+function HOOK_DEPLOYER() external view returns (IJB721TiersHookDeployer);
+```
+
+### launchProjectFor
+
+
+```solidity
+function launchProjectFor(
+    address owner,
+    JBDeploy721TiersHookConfig memory deployTiersHookConfig,
+    JBLaunchProjectConfig memory launchProjectConfig,
+    IJBController controller,
+    bytes32 salt
+)
+    external
+    returns (uint256 projectId, IJB721TiersHook hook);
+```
+
+### launchRulesetsFor
+
+
+```solidity
+function launchRulesetsFor(
+    uint256 projectId,
+    JBDeploy721TiersHookConfig memory deployTiersHookConfig,
+    JBLaunchRulesetsConfig memory launchRulesetsConfig,
+    IJBController controller,
+    bytes32 salt
+)
+    external
+    returns (uint256 rulesetId, IJB721TiersHook hook);
+```
+
+### queueRulesetsOf
+
+
+```solidity
+function queueRulesetsOf(
+    uint256 projectId,
+    JBDeploy721TiersHookConfig memory deployTiersHookConfig,
+    JBQueueRulesetsConfig memory queueRulesetsConfig,
+    IJBController controller,
+    bytes32 salt
+)
+    external
+    returns (uint256 rulesetId, IJB721TiersHook hook);
+```
+