@bananapus/721-hook-v6 0.0.1

package/.gas-snapshot

@@ -0,0 +1,152 @@
+NFTHookAttacks:test_adjustTiers_noPermission_reverts() (gas: 355534)
+NFTHookAttacks:test_cannotIncreaseDiscountPercent_enforcement() (gas: 371175)
+NFTHookAttacks:test_cashOutWeight_afterTierRemoval() (gas: 9879224)
+NFTHookAttacks:test_duplicateTierIdsInMetadata_mintsMultiple() (gas: 9844592)
+NFTHookAttacks:test_invalidTierIdInMetadata_reverts() (gas: 401784)
+NFTHookAttacks:test_maxDiscountPercent_effectivePrice() (gas: 362841)
+NFTHookAttacks:test_maxSupplyTier_noOverflow() (gas: 357301)
+NFTHookAttacks:test_reserveDrain_highFrequency() (gas: 10193674)
+NFTHookAttacks:test_supplyExhaustion_noOvermint() (gas: 9847419)
+NFTHookAttacks:test_zeroPriceTier_mintBehavior() (gas: 9846210)
+TestJB721TiersRulesetMetadataResolver:testFuzz_mintPendingReservesPaused_bitIsolation(uint256) (runs: 256, μ: 488, ~: 488)
+TestJB721TiersRulesetMetadataResolver:testFuzz_packExpandRoundTrip(bool,bool) (runs: 256, μ: 1090, ~: 1091)
+TestJB721TiersRulesetMetadataResolver:testFuzz_pack_onlyUsesLow2Bits(bool,bool) (runs: 256, μ: 733, ~: 734)
+TestJB721TiersRulesetMetadataResolver:testFuzz_transfersPaused_bitIsolation(uint256) (runs: 256, μ: 459, ~: 459)
+TestJB721TiersRulesetMetadataResolver:test_expandMetadata_one() (gas: 453)
+TestJB721TiersRulesetMetadataResolver:test_expandMetadata_three() (gas: 475)
+TestJB721TiersRulesetMetadataResolver:test_expandMetadata_two() (gas: 485)
+TestJB721TiersRulesetMetadataResolver:test_expandMetadata_zero() (gas: 455)
+TestJB721TiersRulesetMetadataResolver:test_mintPendingReservesPaused() (gas: 457)
+TestJB721TiersRulesetMetadataResolver:test_packExpandRoundTrip_allCombinations() (gas: 2977)
+TestJB721TiersRulesetMetadataResolver:test_pack_allFalse() (gas: 514)
+TestJB721TiersRulesetMetadataResolver:test_pack_bothTrue() (gas: 477)
+TestJB721TiersRulesetMetadataResolver:test_pack_pauseMintPendingReservesOnly() (gas: 505)
+TestJB721TiersRulesetMetadataResolver:test_pack_pauseTransfersOnly() (gas: 486)
+TestJB721TiersRulesetMetadataResolver:test_transfersPaused() (gas: 434)
+TestJBBitmap:testFuzz_readId_depthMatchesIndex(uint16) (runs: 256, μ: 2886, ~: 2886)
+TestJBBitmap:testFuzz_refreshBitmapNeeded_consistency(uint16,uint16) (runs: 256, μ: 3127, ~: 3127)
+TestJBBitmap:testFuzz_removeTier_isolatedBit(uint16,uint16) (runs: 256, μ: 28176, ~: 28755)
+TestJBBitmap:testFuzz_removeTier_multipleBits(uint8,uint8,uint8) (runs: 256, μ: 28174, ~: 28174)
+TestJBBitmap:testFuzz_removeTier_roundTrip(uint16) (runs: 256, μ: 23824, ~: 23824)
+TestJBBitmap:test_isTierIdRemoved_memoryStruct() (gas: 23394)
+TestJBBitmap:test_isTierIdRemoved_wrongDepthReturnsWrong() (gas: 25144)
+TestJBBitmap:test_readId_depthCalculation() (gas: 7636)
+TestJBBitmap:test_readId_initiallyZero() (gas: 2859)
+TestJBBitmap:test_refreshBitmapNeeded_differentDepth() (gas: 2965)
+TestJBBitmap:test_refreshBitmapNeeded_sameDepth() (gas: 3052)
+TestJBBitmap:test_removeTier_acrossWords() (gas: 70159)
+TestJBBitmap:test_removeTier_doesNotAffectOtherBits() (gas: 24281)
+TestJBBitmap:test_removeTier_idempotent() (gas: 23479)
+TestJBBitmap:test_removeTier_multipleBitsInSameWord() (gas: 25337)
+TestJBBitmap:test_removeTier_setsbit() (gas: 23638)
+TestJBIpfsDecoder:testFuzz_decode_alwaysProduces46Chars(bytes32) (runs: 256, μ: 359415, ~: 359415)
+TestJBIpfsDecoder:testFuzz_decode_alwaysStartsWithQm(bytes32) (runs: 256, μ: 359671, ~: 359671)
+TestJBIpfsDecoder:testFuzz_decode_onlyBase58Chars(bytes32) (runs: 256, μ: 647995, ~: 649242)
+TestJBIpfsDecoder:testFuzz_decode_prependsBaseUri(bytes32,uint8) (runs: 256, μ: 369117, ~: 362596)
+TestJBIpfsDecoder:test_decode_deterministic() (gas: 718939)
+TestJBIpfsDecoder:test_decode_differentHashesDifferentOutput() (gas: 718729)
+TestJBIpfsDecoder:test_decode_emptyBaseUri() (gas: 359299)
+TestJBIpfsDecoder:test_decode_onlyBase58Chars() (gas: 626479)
+TestJBIpfsDecoder:test_decode_outputLength() (gas: 359327)
+TestJBIpfsDecoder:test_decode_outputStartsWithQm() (gas: 359626)
+TestJBIpfsDecoder:test_decode_prependsBaseUri() (gas: 361561)
+TestTieredHookStoreInvariant:invariant_maxTierIdMonotonic() (runs: 256, calls: 128000, reverts: 0)
+TestTieredHookStoreInvariant:invariant_reserveMintBounds() (runs: 256, calls: 128000, reverts: 0)
+TestTieredHookStoreInvariant:invariant_supplyConservation() (runs: 256, calls: 128000, reverts: 0)
+Test_Getters_Constructor_Unit:test_balanceOf_returnsCompleteBalance(uint256,address) (runs: 256, μ: 11423292, ~: 11326514)
+Test_Getters_Constructor_Unit:test_bools_doesPackingAndUnpackingWork(bool,bool,bool,bool,bool) (runs: 256, μ: 3439343, ~: 3439343)
+Test_Getters_Constructor_Unit:test_cashOutWeightOf_returnsCorrectWeightAsCumSumOfPrices(uint256,uint256,uint256) (runs: 256, μ: 11195261, ~: 10992258)
+Test_Getters_Constructor_Unit:test_constructor_deployIfInitialSuppliesNotEmpty(uint256) (runs: 256, μ: 10167481, ~: 10200751)
+Test_Getters_Constructor_Unit:test_constructor_revertDeploymentIfOneEmptyInitialSupply(uint256,uint256) (runs: 256, μ: 487693, ~: 400030)
+Test_Getters_Constructor_Unit:test_firstOwnerOf_shouldReturnCurrentOwnerIfFirstOwner(uint256,address) (runs: 256, μ: 10587416, ~: 10587416)
+Test_Getters_Constructor_Unit:test_firstOwnerOf_shouldReturnFirstOwnerIfOwnerChanged(address,address) (runs: 256, μ: 10485438, ~: 10485438)
+Test_Getters_Constructor_Unit:test_firstOwnerOf_shouldReturnZeroAddressIfNotMinted(uint256) (runs: 256, μ: 10566284, ~: 10566284)
+Test_Getters_Constructor_Unit:test_numberOfPendingReservesFor_returnsPendingReserves() (gas: 10915529)
+Test_Getters_Constructor_Unit:test_pricingContext_packingFunctionsAsExpected(uint32,uint8,address,bytes32) (runs: 256, μ: 991314, ~: 991314)
+Test_Getters_Constructor_Unit:test_setEncodedIPFSUriOf_returnsCorrectEncodedURI() (gas: 10971375)
+Test_Getters_Constructor_Unit:test_tierOfTokenId_returnsCorrectTierNumber(uint16,uint16) (runs: 256, μ: 29544, ~: 29544)
+Test_Getters_Constructor_Unit:test_tierOf_returnsAGivenTier(uint256,uint16) (runs: 256, μ: 11097249, ~: 11056900)
+Test_Getters_Constructor_Unit:test_tiersOf_returnsAllTiers(uint256) (runs: 256, μ: 11333900, ~: 11133203)
+Test_Getters_Constructor_Unit:test_tiersOf_returnsAllTiersExcludingRemovedOnes(uint256,uint256,uint256) (runs: 256, μ: 11587343, ~: 11564906)
+Test_Getters_Constructor_Unit:test_tiersOf_returnsAllTiersWithResolver(uint256) (runs: 256, μ: 11605638, ~: 11393755)
+Test_Getters_Constructor_Unit:test_tokenURI_returnsCorrectUriWithResolver(uint256) (runs: 256, μ: 10641767, ~: 10641767)
+Test_Getters_Constructor_Unit:test_tokenURI_returnsCorrectUriWithoutResolver() (gas: 14291263)
+Test_Getters_Constructor_Unit:test_totalCashOutWeight_returnsCorrectTotalWeightAsCumSumOfPrices(uint256) (runs: 256, μ: 11051332, ~: 10917296)
+Test_Getters_Constructor_Unit:test_totalSupplyOf_returnsTotalSupply(uint256) (runs: 256, μ: 11036700, ~: 10904015)
+Test_Getters_Constructor_Unit:test_votingUnitsOf_returnsVotingUnitsCorrectly(uint256,uint256,uint256) (runs: 256, μ: 11413665, ~: 11289995)
+Test_ProjectDeployer_Unit:test_launchProjectFor_shouldLaunchProject(uint256,bytes32) (runs: 256, μ: 1007027, ~: 1006740)
+Test_TiersHook_E2E:testCashOutAll(bytes32) (runs: 256, μ: 2638007, ~: 2638007)
+Test_TiersHook_E2E:testCashOutToken(uint256,bytes32) (runs: 256, μ: 2384922, ~: 2389496)
+Test_TiersHook_E2E:testFuzzMintWithDiscountOnPayIfOneTierIsPassed(uint256,uint256) (runs: 257, μ: 1265656, ~: 1308144)
+Test_TiersHook_E2E:testLaunchProjectAndAddHookToRegistry(bytes32) (runs: 256, μ: 4570480, ~: 4570480)
+Test_TiersHook_E2E:testMintOnPayIfMultipleTiersArePassed(bytes32) (runs: 256, μ: 2444650, ~: 2444650)
+Test_TiersHook_E2E:testMintOnPayIfOneTierIsPassed(uint256,bytes32) (runs: 256, μ: 2049940, ~: 2050860)
+Test_TiersHook_E2E:testMintReservedNft(uint256,bytes32) (runs: 256, μ: 2140927, ~: 2141363)
+Test_TiersHook_E2E:testNoMintOnPayWhenNotIncludingMetadata(uint256,bytes32) (runs: 256, μ: 1868459, ~: 1868581)
+Test_TiersHook_E2E:testNoMintOnPayWhenNotIncludingTierIds(uint256,bytes32) (runs: 256, μ: 1874747, ~: 1874869)
+Test_adjustTier_Unit:test_adjustTiers_addAndRemoveTiers() (gas: 1343154)
+Test_adjustTier_Unit:test_adjustTiers_addNewTiers(uint256,uint256,uint256) (runs: 256, μ: 2340387, ~: 2352813)
+Test_adjustTier_Unit:test_adjustTiers_addNewTiersWithNonSequentialCategories(uint256,uint256,uint256) (runs: 256, μ: 2581968, ~: 2563953)
+Test_adjustTier_Unit:test_adjustTiers_addNewTiers_fetchSpecificTier(uint256,uint256,uint256) (runs: 256, μ: 1660417, ~: 1683246)
+Test_adjustTier_Unit:test_adjustTiers_removeTiers(uint256,uint256,uint256) (runs: 256, μ: 10170249, ~: 10150499)
+Test_adjustTier_Unit:test_adjustTiers_removeTiersMultipleTimes(uint256,uint256,uint256) (runs: 256, μ: 2285592, ~: 2265940)
+Test_adjustTier_Unit:test_adjustTiers_revertIfAddingWithReserveFrequency(uint256,uint256) (runs: 256, μ: 10169685, ~: 10166640)
+Test_adjustTier_Unit:test_adjustTiers_revertIfAddingWithVotingPower(uint256,uint256) (runs: 256, μ: 10168360, ~: 10165321)
+Test_adjustTier_Unit:test_adjustTiers_revertIfCannotRemoveTier() (gas: 394356)
+Test_adjustTier_Unit:test_adjustTiers_revertIfEmptyQuantity(uint256,uint256) (runs: 256, μ: 10169424, ~: 10166381)
+Test_adjustTier_Unit:test_adjustTiers_revertIfInvalidCategorySortOrder(uint256,uint256) (runs: 256, μ: 10897255, ~: 10925524)
+Test_adjustTier_Unit:test_adjustTiers_revertIfMoreVotingUnitsNotAllowedUsingVotingUnits(uint256,uint256) (runs: 256, μ: 10778370, ~: 10808162)
+Test_adjustTier_Unit:test_adjustTiers_revertIfMoreVotingUnitsNotAllowedWithPriceChange(uint256,uint256) (runs: 256, μ: 10141122, ~: 10138435)
+Test_adjustTier_Unit:test_adjustTiers_withDifferentCategories(uint256,uint256,uint256) (runs: 256, μ: 2609853, ~: 2601407)
+Test_adjustTier_Unit:test_adjustTiers_withDifferentCategoriesAndFetchedTogether(uint256,uint256,uint256) (runs: 256, μ: 2651662, ~: 2655539)
+Test_adjustTier_Unit:test_adjustTiers_withSameCategoryMultipleTimes(uint256,uint256,uint256) (runs: 256, μ: 3211356, ~: 3174714)
+Test_adjustTier_Unit:test_adjustTiers_withZeroCategory(uint256,uint256,uint256) (runs: 256, μ: 2019794, ~: 1998614)
+Test_adjustTier_Unit:test_cleanTiers_removeInactiveTiers(uint256,uint256,uint256) (runs: 256, μ: 10396186, ~: 10378896)
+Test_adjustTier_Unit:test_setDiscountPercentOf_revertIfCannotIncreaseDiscount() (gas: 338824)
+Test_adjustTier_Unit:test_setDiscountPercentsOf_revertIfCannotIncreaseDiscounts() (gas: 395153)
+Test_adjustTier_Unit:test_tiersOf_emptyArrayIfNoInitializedTiers(uint256) (runs: 256, μ: 217659, ~: 217659)
+Test_adjustTier_Unit:test_tiersOf_recentlyAddedTiersFetchedFirstWhenSorted(uint256,uint256,uint256) (runs: 256, μ: 2200972, ~: 2196814)
+Test_adjustTier_Unit:test_tiersOf_recentlyAddedTiersFetchedFirstWhenSortedAfterTiersCleaned(uint256,uint256,uint256) (runs: 256, μ: 3616874, ~: 3631859)
+Test_afterPayRecorded_Unit:test_afterCashOutRecordedWith_cashOutEvenIfTransfersPausedInRuleset() (gas: 1385297)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_doNotMintIfNotUsingCorrectToken(address) (runs: 257, μ: 85884, ~: 85884)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_doNotMintWithSomeoneElsesCredits() (gas: 514975)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_doesNotRevertOnAmountBelowPriceIfNoMetadata() (gas: 65557)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintAndReserveCorrectAmounts(uint256,uint256,uint256) (runs: 256, μ: 14417219, ~: 14622413)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintCorrectTier() (gas: 344650)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintCorrectTierWithAnotherCurrency() (gas: 1574686)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintCorrectTiersWhenPartiallyUsingPayCredits() (gas: 553961)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintNoneIfNonePassed(uint8) (runs: 256, μ: 126870, ~: 130887)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintTierAndTrackLeftover() (gas: 190328)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_mintWithExistingCreditsWhenMoreExistingCreditsThanNewCredits() (gas: 439389)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfAllowanceRunsOutInSpecifiedTier() (gas: 9359196)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfAmountTooLow() (gas: 150759)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfCallerIsNotATerminalOfProjectId(address) (runs: 256, μ: 25585, ~: 25585)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfTierDoesNotExist(uint256) (runs: 256, μ: 177275, ~: 177754)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfTierRemoved() (gas: 170846)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfUnexpectedLeftover() (gas: 64790)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertIfUnexpectedLeftoverAndOverspendingPrevented(bool) (runs: 256, μ: 65853, ~: 53252)
+Test_afterPayRecorded_Unit:test_afterPayRecorded_revertsOnAmountBelowPriceIfNoMetadataAndOverspendingIsPrevented() (gas: 1325309)
+Test_afterPayRecorded_Unit:test_transferFrom_pauseFlagOverridesRuleset() (gas: 1603935)
+Test_afterPayRecorded_Unit:test_transferFrom_revertTransferIfPausedInRuleset() (gas: 1568089)
+Test_cashOut_Unit:test_afterCashOutRecordedWith_burnCashOutNft(uint256) (runs: 256, μ: 13781545, ~: 13639188)
+Test_cashOut_Unit:test_afterCashOutRecordedWith_revertIfCallerIsNotATerminalOfTheProject() (gas: 27783)
+Test_cashOut_Unit:test_afterCashOutRecordedWith_revertIfNotCorrectProjectId(uint8) (runs: 256, μ: 28421, ~: 28421)
+Test_cashOut_Unit:test_afterCashOutRecordedWith_revertIfWrongHolder(address,uint8) (runs: 256, μ: 9677720, ~: 9677720)
+Test_cashOut_Unit:test_beforeCashOutContext_returnsCorrectAmount() (gas: 10828929)
+Test_cashOut_Unit:test_beforeCashOutContext_returnsPartOfOverflowOwnedIfCashOutTaxRateIsMaximum() (gas: 10830525)
+Test_cashOut_Unit:test_beforeCashOutContext_returnsZeroAmountIfReserveFrequencyIsZero() (gas: 10812126)
+Test_cashOut_Unit:test_beforeCashOutContext_revertIfNonZeroTokenCount(uint256) (runs: 256, μ: 19456, ~: 19456)
+Test_mintFor_mintReservesFor_Unit:test_mintFor_mintArrayOfTiers() (gas: 10129100)
+Test_mintFor_mintReservesFor_Unit:test_mintFor_revertIfManualMintNotAllowed() (gas: 10585321)
+Test_mintFor_mintReservesFor_Unit:test_mintPendingReservesFor_mintMultipleReservedTokens() (gas: 9977856)
+Test_mintFor_mintReservesFor_Unit:test_mintPendingReservesFor_mintOddReservedTokens() (gas: 10344857)
+Test_mintFor_mintReservesFor_Unit:test_mintPendingReservesFor_mintsCorrectly() (gas: 9984341)
+Test_mintFor_mintReservesFor_Unit:test_mintPendingReservesFor_revertIfNotEnoughPendingReserves() (gas: 11010767)
+Test_mintFor_mintReservesFor_Unit:test_mintPendingReservesFor_revertIfReservedMintingIsPausedInRuleset() (gas: 9954862)
+Test_mintFor_mintReservesFor_Unit:test_numberOfPendingReservesFor_noReservesIfNoBeneficiarySet() (gas: 10812175)
+TierLifecycleInvariant_Local:invariant_721_1_perTierSupplyAccounting() (runs: 256, calls: 128000, reverts: 0)
+TierLifecycleInvariant_Local:invariant_721_2_totalCashOutWeightConsistency() (runs: 256, calls: 128000, reverts: 0)
+TierLifecycleInvariant_Local:invariant_721_3_payCreditsNonNegative() (runs: 256, calls: 128000, reverts: 0)
+TierLifecycleInvariant_Local:invariant_721_4_reserveMintsBounded() (runs: 256, calls: 128000, reverts: 0)
+TierLifecycleInvariant_Local:invariant_721_5_removedTiersExcluded() (runs: 256, calls: 128000, reverts: 0)
+TierLifecycleInvariant_Local:invariant_721_6_cashOutWeightBoundedByPrice() (runs: 256, calls: 128000, reverts: 0)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bananapus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,253 @@
+# Bananapus NFT Hook
+
+`nana-721-hook` is:
+
+1. A pay hook for Juicebox projects to sell tiered NFTs (ERC-721s) with different prices and artwork.
+2. (Optionally) a redeem hook which allows holders to burn their NFTs to reclaim funds from the project, in proportion to the NFT's price.
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#usage">Usage</a></li>
+  <ul>
+    <li><a href="#install">Install</a></li>
+    <li><a href="#develop">Develop</a></li>
+    <li><a href="#scripts">Scripts</a></li>
+    <li><a href="#deployments">Deployments</a></li>
+    <ul>
+      <li><a href="#with-sphinx">With Sphinx</a></li>
+      <li><a href="#without-sphinx">Without Sphinx</a></li>
+      </ul>
+    <li><a href="#tips">Tips</a></li>
+    </ul>
+    <li><a href="#repository-layout">Repository Layout</a></li>
+    <li><a href="#architecture">Architecture</a></li>
+  <ul>
+    <li><a href="#contracts">Contracts</a></li>
+    </ul>
+    <li><a href="#description">Description</a></li>
+  <ul>
+    <li><a href="#hooks">Hooks</a></li>
+    <li><a href="#mechanism">Mechanism</a></li>
+    <li><a href="#setup">Setup</a></li>
+    </ul>
+  </ul>
+  </ol>
+</details>
+
+_If you're having trouble understanding this contract, take a look at the [core protocol contracts](https://github.com/Bananapus/nana-core) and the [documentation](https://docs.juicebox.money/) first. If you have questions, reach out on [Discord](https://discord.com/invite/ErQYmth4dS)._
+
+## Usage
+
+### Install
+
+How to install `nana-721-hook` in another project.
+
+For projects using `npm` to manage dependencies (recommended):
+
+```bash
+npm install @bananapus/721-hook
+```
+
+For projects using `forge` to manage dependencies (not recommended):
+
+```bash
+forge install Bananapus/nana-721-hook
+```
+
+If you're using `forge` to manage dependencies, add `@bananapus/721-hook/=lib/nana-721-hook/` to `remappings.txt`. You'll also need to install `nana-721-hook`'s dependencies and add similar remappings for them.
+
+### Develop
+
+`nana-721-hook` uses [npm](https://www.npmjs.com/) (version >=20.0.0) for package management and the [Foundry](https://github.com/foundry-rs/foundry) development toolchain for builds, tests, and deployments. To get set up, [install Node.js](https://nodejs.org/en/download) and install [Foundry](https://github.com/foundry-rs/foundry):
+
+```bash
+curl -L https://foundry.paradigm.xyz | sh
+```
+
+You can download and install dependencies with:
+
+```bash
+npm ci && forge install
+```
+
+If you run into trouble with `forge install`, try using `git submodule update --init --recursive` to ensure that nested submodules have been properly initialized.
+
+Some useful commands:
+
+| Command               | Description                                         |
+| --------------------- | --------------------------------------------------- |
+| `forge build`         | Compile the contracts and write artifacts to `out`. |
+| `forge fmt`           | Lint.                                               |
+| `forge test`          | Run the tests.                                      |
+| `forge build --sizes` | Get contract sizes.                                 |
+| `forge coverage`      | Generate a test coverage report.                    |
+| `foundryup`           | Update foundry. Run this periodically.              |
+| `forge clean`         | Remove the build artifacts and cache directories.   |
+
+To learn more, visit the [Foundry Book](https://book.getfoundry.sh/) docs.
+
+### Scripts
+
+For convenience, several utility commands are available in `package.json`.
+
+| Command             | Description                                             |
+| ------------------- | ------------------------------------------------------- |
+| `npm test`          | Run local tests.                                        |
+| `npm run coverage`  | Generate an LCOV test coverage report.                  |
+| `npm run artifacts` | Fetch Sphinx artifacts and write them to `deployments/` |
+
+### Deployments
+
+#### With Sphinx
+
+`nana-721-hook` manages deployments with [Sphinx](https://www.sphinx.dev). To run the deployment scripts, install the npm `devDependencies` with:
+
+```bash
+`npm ci --also=dev`
+```
+
+You'll also need to set up a `.env` file based on `.example.env`. Then run one of the following commands:
+
+| Command                   | Description                  |
+| ------------------------- | ---------------------------- |
+| `npm run deploy:mainnets` | Propose mainnet deployments. |
+| `npm run deploy:testnets` | Propose testnet deployments. |
+
+Your teammates can review and approve the proposed deployments in the Sphinx UI. Once approved, the deployments will be executed.
+
+#### Without Sphinx
+
+You can use the Sphinx CLI to run the deployment scripts without paying for Sphinx. First, install the npm `devDependencies` with:
+
+```bash
+`npm ci --also=dev`
+```
+
+You can deploy the contracts like so:
+
+```bash
+PRIVATE_KEY="0x123..." RPC_ETHEREUM_SEPOLIA="https://rpc.ankr.com/eth_sepolia" npx sphinx deploy script/Deploy.s.sol --network ethereum_sepolia
+```
+
+This example deploys `nana-721-hook` to the Sepolia testnet using the specified private key. You can configure new networks in `foundry.toml`.
+
+### Tips
+
+To view test coverage, run `npm run coverage` to generate an LCOV test report. You can use an extension like [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) to view coverage in your editor.
+
+If you're using Nomic Foundation's [Solidity](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity) extension in VSCode, you may run into LSP errors because the extension cannot find dependencies outside of `lib`. You can often fix this by running:
+
+```bash
+forge remappings >> remappings.txt
+```
+
+This makes the extension aware of default remappings.
+
+## Repository Layout
+
+The root directory contains this README, an MIT license, and config files. The important source directories are:
+
+```
+nana-721-hook/
+├── script/
+│   ├── Deploy.s.sol - Deploys core contracts - the hook store, deployer, and project deployer.
+│   ├── LaunchProjectFor.s.sol - (DEPRECATED) Deploys a project with a 721 tiers hook.
+│   └── helpers/
+│       └── Hook721DeploymentLib.sol - Internal helpers for deployment scripts.
+├── src/ - Contract source code. Top level contains implementation contracts.
+│   ├── JB721TiersHook.sol - The core tiered NFT pay/redeem hook.
+│   ├── JB721TiersHookDeployer.sol - Deploys an NFT hook for a project.
+│   ├── JB721TiersHookProjectDeployer.sol - Deploys a project with a tiered NFT hook.
+│   ├── JB721TiersHookStore.sol - Stores and manages data for tiered NFT hooks.
+│   ├── abstract/
+│   │   ├── ERC721.sol - Abstract ERC-721 implementation.
+│   │   └── JB721Hook.sol - Abstract NFT hook implementation.
+│   ├── interfaces/ - Contract interfaces.
+│   ├── libraries/ - Libraries.
+│   └── structs/ - Structs.
+└── test/ - Forge tests and testing utilities.
+    ├── E2E/
+    │   └── Pay_Mint_Redeem_E2E.t.sol - End-to-end test for minting and redeeming NFTs.
+    ├── unit/ - Unit tests for various components..
+    └── utils/ - Miscellaneous testing utilities.
+```
+
+Other directories:
+
+```
+nana-721-hook/
+├── .github/
+│   └── workflows/ - CI/CD workflows.
+└── deployments/ - Sphinx deployment logs.
+```
+
+## Architecture
+
+```mermaid
+graph TD;
+    A[JB721TiersHookProjectDeployer] -->|Launches & queues rulesets for| B[Juicebox projects]
+    D[JB721TiersHookDeployer] -->|Adds NFT hooks to| B
+    A -->|Deploys| C[JB721TiersHook]
+    D -->|Deploys| C
+    B -->|Calls upon pay/redeem| C
+    C -->|Stores data in| E[JB721TiersHookStore]
+    B -->|Uses| F[Pay/redeem terminal]
+    C -->|Mints NFTs upon payment through| F
+    C -->|Burns NFTs to reclaim funds through| F
+```
+
+### Contracts
+
+| Contract                                                                                                                          | Description                                                                                             |
+| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| [`JB721TiersHook.sol`](https://github.com/Bananapus/nana-721-hook/blob/main/src/JB721TiersHook.sol)                               | The core tiered NFT pay/redeem hook implementation.                                                     |
+| [`JB721TiersHookDeployer.sol`](https://github.com/Bananapus/nana-721-hook/blob/main/src/JB721TiersHookDeployer.sol)               | Exposes a `deployHookFor(…)` function which allows deploys an NFT hook for a project.                   |
+| [`JB721TiersHookProjectDeployer.sol`](https://github.com/Bananapus/nana-721-hook/blob/main/src/JB721TiersHookProjectDeployer.sol) | Exposes a `launchProjectFor(…)` function which deploys a project with a tiered NFT hook already set up. |
+| [`JB721TiersHookStore.sol`](https://github.com/Bananapus/nana-721-hook/blob/main/src/JB721TiersHookStore.sol)                     | Stores and manages data for tiered NFT hooks.                                                           |
+
+## Description
+
+### Hooks
+
+This contract is a _data hook_, a _pay hook_, and a _redeem hook_. Data hooks receive information about a payment or a redemption, and put together a payload for the pay/redeem hook to execute.
+
+Juicebox projects can specify a data hook in their `JBRulesetMetadata`. When someone attempts to pay or redeem from the project, the project's terminal records the payment in the terminal store, passing information about the payment/redemption to the data hook in the process. The data hook responds with a list of payloads – each payload specifies the address of a pay/redeem hook, as well as some custom data and an amount of funds to send to that pay/redeem hook.
+
+Each pay/redeem hook can then execute custom behavior based on the custom data (and funds) they receive.
+
+### Mechanism
+
+A project using a 721 tiers hook can specify any number of NFT tiers.
+
+- NFT tiers can be removed by the project owner as long as they are not locked.
+- NFT tiers can be added by the project owner as long as they respect the hook's `flags`. The flags specify if newly added tiers can have votes (voting units), if new tiers can have non-zero reserve frequencies, if new tiers can allow on-demand minting by the project's owner, and if the tier can be removed.
+
+Each tier has the following optional properties:
+
+- A price.
+- A supply (the maximum number of NFTs which can be minted from the tier).
+- A token URI (artwork and metadata), which can be overridden by a URI resolver. The URI resolver can return unique values for each NFT in the tier.
+- A category, so tiers can be organized and accessed for different purposes.
+- A reserve frequency (optional). With a reserve frequency of 5, an extra NFT will be minted to a pre-specified beneficiary address for every 5 NFTs purchased and minted from the tier.
+- A number of votes each NFT should represent on-chain (optional).
+- A flag to specify whether the NFTs in the tier can always be transferred, or if transfers can be paused depending on the project's ruleset.
+- A flag to specify whether the contract's owner can mint NFTs from the tier on-demand.
+- A set of flags which restrict tiers added in the future (the votes/reserved frequency/on-demand minting/can be removed flags noted above).
+
+Additional notes:
+
+- A payer can specify any number of tiers to mint as long as the total price does not exceed the amount being paid. If tiers aren't specified, their payment mints the most expensive tier possible, unless they specify that the hook should not mint any NFTs.
+- If the payment and a tier's price are specified in different currencies, the `JBPrices` contract is used to normalize the values.
+- If some of a payment does not go towards purchasing an NFT, those extra funds will be stored as "NFT credits" which can be used for future purchases. Optionally, the hook can disallow credits and reject payments with leftover funds.
+- If enabled by the project owner, holders can burn their NFTs to reclaim funds from the project. These redemptions are proportional to the NFTs price, relative to the combined price of all the NFTs.
+- NFT redemptions can be enabled by setting `useDataHookForRedeem` to `true` in the project's `JBRulesetMetadata`. If NFT redemptions are enabled, project token redemptions are disabled.
+- The hook's deployer can choose if the NFTs should support on-chain voting (as `ERC721Votes`). This increases the gas fees to interact with the NFTs, and should be disabled if not needed.
+
+### Setup
+
+To use a 721 tiers hook, a Juicebox project should be created by a `JB721TiersHookProjectDeployer` instead of a `JBController`. The deployer will create a `JB721TiersHook` (through an associated `JB721TiersHookDeployer`) and add it to the project's first ruleset. New rulesets can be queued with `JB721TiersHookProjectDeployer.queueRulesetsOf(…)` if the project's owner gives the project deployer the permission [`JBPermissions.QUEUE_RULESETS`](https://github.com/Bananapus/nana-permission-ids/blob/master/src/JBPermissionIds.sol) (ID `2`) in [`JBPermissions`](https://github.com/Bananapus/nana-core/blob/main/src/JBPermissions.sol).
+
+It's also possible to add a 721 tiers hook to an existing project by calling `JB721TiersHookDeployer.deployHookFor(…)` and adding the hook to the project's ruleset – specifically, the project must set their [`JBRulesetMetadata.dataHook`](https://github.com/Bananapus/nana-core/blob/main/src/structs/JBRulesetMetadata.sol) to the newly deployed hook, and enable `JBRulesetMetadata.useDataHookForPay` and/or `JBRulesetMetadata.useDataHookForRedeem` depending on the functionality they'd like to enable.
+
+All `JB721TiersHook`s store their data in the `JB721TiersHookStore` contract.

package/SKILLS.md

@@ -0,0 +1,140 @@
+# nana-721-hook-v5
+
+## Purpose
+
+Tiered ERC-721 NFT hook for Juicebox V6 that mints NFTs when a project is paid and optionally allows NFT holders to burn them to reclaim project funds proportional to tier price.
+
+## Contracts
+
+| Contract | Role |
+|----------|------|
+| `JB721TiersHook` | Core hook: processes payments (mints NFTs), processes cash outs (burns NFTs), manages tiers, reserves, credits, metadata, and discount percents. Deployed as minimal clones. |
+| `JB721TiersHookStore` | Shared singleton storage for all hook instances. Stores tiers (`JBStored721Tier`), balances, reserves, bitmaps for removed tiers, flags, and token URI resolvers. |
+| `JB721TiersHookDeployer` | Factory: clones `JB721TiersHook` via `LibClone.clone` / `cloneDeterministic`, initializes, registers in address registry. |
+| `JB721TiersHookProjectDeployer` | Convenience deployer: creates a Juicebox project + hook in one transaction. Wires the hook as the data hook with `useDataHookForPay: true`. |
+| `JB721Hook` (abstract) | Base: implements `IJBRulesetDataHook` + `IJBPayHook` + `IJBCashOutHook`. Validates caller is a project terminal. |
+| `ERC721` (abstract) | Clone-compatible ERC-721 with `_initialize(name, symbol)` instead of constructor args. |
+
+## Key Functions
+
+| Function | Contract | What it does |
+|----------|----------|--------------|
+| `initialize(projectId, name, symbol, baseUri, tokenUriResolver, contractUri, tiersConfig, flags)` | `JB721TiersHook` | One-time setup for a cloned hook instance. Stores pricing context (currency, decimals, prices contract packed into uint256), records tiers and flags in the store. |
+| `afterPayRecordedWith(context)` | `JB721Hook` | Called by terminal after payment. Validates caller is a project terminal, delegates to `_processPayment`. |
+| `_processPayment(context)` | `JB721TiersHook` | Normalizes payment value via pricing context, decodes payer metadata for tier IDs to mint, calls `_mintAll`, manages pay credits for overspending. |
+| `afterCashOutRecordedWith(context)` | `JB721Hook` | Called by terminal during cash out. Decodes token IDs from metadata, validates ownership, burns NFTs, calls `_didBurn`. |
+| `beforePayRecordedWith(context)` | `JB721Hook` | Data hook: returns original weight and sets this contract as the pay hook (amount=0). |
+| `beforeCashOutRecordedWith(context)` | `JB721Hook` | Data hook: calculates `cashOutCount` (weight of NFTs being cashed out) and `totalSupply` (total weight of all NFTs). Rejects if fungible tokens are also being cashed out. |
+| `adjustTiers(tiersToAdd, tierIdsToRemove)` | `JB721TiersHook` | Owner-only. Adds/removes tiers via the store. Requires `ADJUST_721_TIERS` permission. |
+| `mintFor(tierIds, beneficiary)` | `JB721TiersHook` | Owner-only manual mint. Requires `MINT_721` permission. Passes `amount: type(uint256).max` and `isOwnerMint: true` to force the mint. |
+| `mintPendingReservesFor(tierId, count)` | `JB721TiersHook` | Public. Mints pending reserve NFTs for a tier to the tier's `reserveBeneficiary`. Checks ruleset metadata for `mintPendingReservesPaused`. |
+| `setMetadata(baseUri, contractUri, tokenUriResolver, encodedIPFSTUriTierId, encodedIPFSUri)` | `JB721TiersHook` | Owner-only. Updates base URI, contract URI, token URI resolver, or per-tier encoded IPFS URI. Requires `SET_721_METADATA` permission. |
+| `setDiscountPercentOf(tierId, discountPercent)` | `JB721TiersHook` | Owner-only. Sets discount percent for a tier. Requires `SET_721_DISCOUNT_PERCENT` permission. |
+| `deployHookFor(projectId, config, salt)` | `JB721TiersHookDeployer` | Clones the hook implementation, initializes it, transfers ownership to caller, registers in address registry. |
+| `launchProjectFor(owner, deployConfig, launchConfig, controller, salt)` | `JB721TiersHookProjectDeployer` | Creates project via controller, deploys hook, wires hook as data hook with `useDataHookForPay: true`, transfers hook ownership to project. |
+| `recordMint(amount, tierIds, isOwnerMint)` | `JB721TiersHookStore` | Records minting: validates supply, checks tier prices against amount (unless owner mint), generates token IDs (tierId * 1_000_000_000 + mintCount), tracks reserves. |
+| `recordAddTiers(tiers)` | `JB721TiersHookStore` | Adds new tiers sorted by category. Validates against hook flags (no new reserves/votes/owner-minting if flagged). |
+| `recordRemoveTierIds(tierIds)` | `JB721TiersHookStore` | Marks tiers as removed in the bitmap. Validates tier is not locked (`cannotBeRemoved`). |
+
+## Integration Points
+
+| Dependency | Import | Used For |
+|------------|--------|----------|
+| `@bananapus/core-v6` | `IJBDirectory`, `IJBRulesets`, `IJBPrices`, `IJBController`, `IJBTerminal`, `JBRuleset`, `JBRulesetMetadata`, `JBAfterPayRecordedContext`, `JBBeforeCashOutRecordedContext`, etc. | Terminal validation, ruleset metadata, pricing, payment/cash-out contexts |
+| `@bananapus/ownable-v6` | `JBOwnable` | Project-based ownership for the hook (ownership can be transferred to a project NFT) |
+| `@bananapus/permission-ids-v6` | `JBPermissionIds` | Permission IDs: `ADJUST_721_TIERS`, `MINT_721`, `SET_721_METADATA`, `SET_721_DISCOUNT_PERCENT`, `QUEUE_RULESETS`, `SET_TERMINALS` |
+| `@bananapus/address-registry-v6` | `IJBAddressRegistry` | Registering deployed hook clones |
+| `@openzeppelin/contracts` | `ERC2771Context`, `IERC165`, `IERC2981`, `IERC721` | Meta-transactions (trusted forwarder), interface detection, royalty standard |
+| `@prb/math` | `mulDiv` | Safe fixed-point multiplication/division for price normalization |
+| `solady` | `LibClone` | Minimal proxy (clone) deployment for hooks |
+
+## Key Types
+
+| Struct/Enum | Key Fields | Used In |
+|-------------|------------|---------|
+| `JB721TierConfig` | `uint104 price`, `uint32 initialSupply`, `uint32 votingUnits`, `uint16 reserveFrequency`, `address reserveBeneficiary`, `bytes32 encodedIPFSUri`, `uint24 category`, `uint8 discountPercent`, `bool allowOwnerMint`, `bool transfersPausable`, `bool cannotBeRemoved`, `bool cannotIncreaseDiscountPercent` | `adjustTiers`, `initialize`, `recordAddTiers` |
+| `JB721Tier` | Same as config plus `uint32 id`, `uint32 remainingSupply`, `string resolvedUri` | Return type from `tierOf`, `tiersOf`, `tierOfTokenId` |
+| `JBStored721Tier` | `uint104 price`, `uint32 remainingSupply`, `uint32 initialSupply`, `uint32 votingUnits`, `uint24 category`, `uint8 discountPercent`, `uint16 reserveFrequency`, `uint8 packedBools` | Internal storage in `JB721TiersHookStore` |
+| `JB721InitTiersConfig` | `JB721TierConfig[] tiers`, `uint32 currency`, `uint8 decimals`, `IJBPrices prices` | `initialize` — defines tiers and pricing context |
+| `JBDeploy721TiersHookConfig` | `string name`, `string symbol`, `string baseUri`, `IJB721TokenUriResolver tokenUriResolver`, `string contractUri`, `JB721InitTiersConfig tiersConfig`, `address reserveBeneficiary`, `JB721TiersHookFlags flags` | `deployHookFor`, `launchProjectFor` |
+| `JB721TiersHookFlags` | `bool noNewTiersWithReserves`, `bool noNewTiersWithVotes`, `bool noNewTiersWithOwnerMinting`, `bool preventOverspending` | `initialize`, `recordFlags` |
+| `JB721TiersRulesetMetadata` | `bool pauseTransfers`, `bool pauseMintPendingReserves` | Packed into `JBRulesetMetadata.metadata` per-ruleset |
+| `JBPayDataHookRulesetConfig` | `uint48 mustStartAtOrAfter`, `uint32 duration`, `uint112 weight`, `uint32 weightCutPercent`, `IJBRulesetApprovalHook approvalHook`, `JBPayDataHookRulesetMetadata metadata`, `JBSplitGroup[] splitGroups`, `JBFundAccessLimitGroup[] fundAccessLimitGroups` | `JB721TiersHookProjectDeployer` — wraps core ruleset config with `useDataHookForPay: true` hardcoded |
+| `JBPayDataHookRulesetMetadata` | Same as `JBRulesetMetadata` minus `allowSetCustomToken` (hardcoded false) and `useDataHookForPay` (hardcoded true) and `dataHook` (set to deployed hook) | `launchProjectFor`, `launchRulesetsFor`, `queueRulesetsOf` |
+| `JB721TiersMintReservesConfig` | `uint32 tierId`, `uint16 count` | `mintPendingReservesFor` batch variant |
+| `JB721TiersSetDiscountPercentConfig` | `uint32 tierId`, `uint16 discountPercent` | `setDiscountPercentsOf` batch variant |
+| `JBBitmapWord` | `uint256 currentWord`, `uint256 currentDepth` | Internal tier removal tracking in store |
+
+## Gotchas
+
+- `JB721TiersHook` is deployed as a **minimal clone** (not a full deployment). The constructor sets immutables (`RULESETS`, `STORE`, `DIRECTORY`, `METADATA_ID_TARGET`), and `initialize()` sets per-instance state. Calling `initialize()` twice reverts with `JB721TiersHook_AlreadyInitialized`.
+- **Pricing context is bit-packed** into a single `uint256`: currency (bits 0-31), decimals (bits 32-39), prices contract address (bits 40-199). Read it via `pricingContext()`.
+- **Token IDs encode tier ID**: `tokenId = tierId * 1_000_000_000 + mintNumber`. Use `STORE.tierIdOfToken(tokenId)` to extract the tier ID.
+- **Pay credits**: If a payer overpays (amount > total tier prices), the excess is stored as `payCreditsOf[beneficiary]` and can be applied to future mints. This only works when `preventOverspending` flag is `false`. Credits are only combined with payment when `payer == beneficiary`.
+- **Cash outs reject fungible tokens**: `beforeCashOutRecordedWith` reverts with `JB721Hook_UnexpectedTokenCashedOut` if `context.cashOutCount > 0`. NFT cash outs and fungible token cash outs are mutually exclusive.
+- **Reserve minting is permissionless** but governed by ruleset metadata. Anyone can call `mintPendingReservesFor` as long as `mintPendingReservesPaused` is not set in the current ruleset's metadata.
+- `setMetadata` uses `address(this)` as the sentinel for "no change" on `tokenUriResolver` (not `address(0)`). Passing `address(0)` will clear the resolver.
+- `JBPayDataHookRulesetConfig` hardcodes `allowSetCustomToken: false` and `useDataHookForPay: true` when wiring rulesets through the project deployer.
+- The `_update` override in `JB721TiersHook` checks `tier.transfersPausable` and consults the current ruleset's metadata for `transfersPaused`. Transfers to `address(0)` (burns) are never blocked.
+- `JB721TiersHookStore` is a **shared singleton** -- all hook instances on the same chain use the same store, keyed by `address(hook)`.
+- The `ERC721` abstract uses `_initialize(name, symbol)` instead of a constructor, making it clone-compatible. The standard `_owners` mapping is `internal` (not `private`).
+
+## Example Integration
+
+```solidity
+import {IJB721TiersHookProjectDeployer} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHookProjectDeployer.sol";
+import {JBDeploy721TiersHookConfig} from "@bananapus/721-hook-v6/src/structs/JBDeploy721TiersHookConfig.sol";
+import {JB721TierConfig} from "@bananapus/721-hook-v6/src/structs/JB721TierConfig.sol";
+import {JB721InitTiersConfig} from "@bananapus/721-hook-v6/src/structs/JB721InitTiersConfig.sol";
+import {JB721TiersHookFlags} from "@bananapus/721-hook-v6/src/structs/JB721TiersHookFlags.sol";
+import {JBLaunchProjectConfig} from "@bananapus/721-hook-v6/src/structs/JBLaunchProjectConfig.sol";
+import {JBPayDataHookRulesetConfig} from "@bananapus/721-hook-v6/src/structs/JBPayDataHookRulesetConfig.sol";
+import {IJBController} from "@bananapus/core-v6/src/interfaces/IJBController.sol";
+
+// Build a single tier: 0.1 ETH, supply of 100, with IPFS artwork.
+JB721TierConfig[] memory tiers = new JB721TierConfig[](1);
+tiers[0] = JB721TierConfig({
+    price: 0.1 ether,
+    initialSupply: 100,
+    votingUnits: 0,
+    reserveFrequency: 0,
+    reserveBeneficiary: address(0),
+    encodedIPFSUri: 0x7D5A99F603F231D53A4F39D1521F98D2E8BB279CF29BEBFD0687DC98458E7F89, // example CID
+    category: 1,
+    discountPercent: 0,
+    allowOwnerMint: false,
+    useReserveBeneficiaryAsDefault: false,
+    transfersPausable: false,
+    useVotingUnits: false,
+    cannotBeRemoved: false,
+    cannotIncreaseDiscountPercent: false
+});
+
+// Deploy a project with the 721 hook attached.
+(uint256 projectId, IJB721TiersHook hook) = projectDeployer.launchProjectFor({
+    owner: msg.sender,
+    deployTiersHookConfig: JBDeploy721TiersHookConfig({
+        name: "My NFT Collection",
+        symbol: "MNFT",
+        baseUri: "ipfs://",
+        tokenUriResolver: IJB721TokenUriResolver(address(0)),
+        contractUri: "",
+        tiersConfig: JB721InitTiersConfig({
+            tiers: tiers,
+            currency: 1,        // ETH
+            decimals: 18,
+            prices: IJBPrices(address(0))  // no cross-currency pricing
+        }),
+        reserveBeneficiary: address(0),
+        flags: JB721TiersHookFlags({
+            noNewTiersWithReserves: false,
+            noNewTiersWithVotes: false,
+            noNewTiersWithOwnerMinting: false,
+            preventOverspending: false
+        })
+    }),
+    launchProjectConfig: launchConfig,  // JBLaunchProjectConfig with rulesets, terminals, etc.
+    controller: IJBController(controllerAddress),
+    salt: bytes32(0)
+});
+```

package/docs/book.css

@@ -0,0 +1,13 @@
+table {
+    margin: 0 auto;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table td:first-child {
+    width: 15%;
+}
+  
+table td:nth-child(2) {
+    width: 25%;
+}

package/docs/book.toml

@@ -0,0 +1,12 @@
+[book]
+src = "src"
+title = ""
+
+[output.html]
+no-section-label = true
+additional-js = ["solidity.min.js"]
+additional-css = ["book.css"]
+git-repository-url = "https://github.com/Bananapus/nana-721-hook-v6"
+
+[output.html.fold]
+enable = true