@bananapus/721-hook-v6 0.0.17 → 0.0.18

package/CHANGE_LOG.md

@@ -113,15 +113,27 @@ The ERC721 collection `name` and `symbol` can now be changed after initializatio
 | `_setName(string memory)` | Updates the token collection name |
 | `_setSymbol(string memory)` | Updates the token collection symbol |
 
-### 2.3 `beforePayRecordedWith` Override in `JB721TiersHook`
+### 2.3 `split.hook` Support in Tier Distribution
+
+Tier split payouts now support the `split.hook` field (`IJBSplitHook`). The distribution priority follows the same order as `JBMultiTerminal`: hook > projectId > beneficiary. In v5, tier splits did not exist. In v6, this ensures full parity with core split behavior.
+
+### 2.4 DOS Protection on Split Distribution
+
+All external calls during tier split distribution (split hooks, terminal `pay`/`addToBalanceOf`, and leftover distribution) are wrapped in try-catch. A reverting split recipient or terminal cannot brick payments to the project. On failure, funds are returned to the project balance and a `SplitPayoutReverted` or `AddToBalanceReverted` event is emitted with the revert reason. For ERC-20 split hook failures, tokens are transferred first and the hook callback is best-effort; for ERC-20 terminal failures, the approval is reset to zero.
+
+### 2.5 `splitPercent` Bounds Validation
+
+`JB721TiersHookStore.recordAddTiers` now validates that each tier's `splitPercent` does not exceed `JBConstants.SPLITS_TOTAL_PERCENT`. If it does, it reverts with `JB721TiersHookStore_SplitPercentExceedsBounds(uint256 percent, uint256 limit)`.
+
+### 2.6 `beforePayRecordedWith` Override in `JB721TiersHook`
 
 v6 overrides `beforePayRecordedWith` in `JB721TiersHook` (not just the base `JB721Hook`). The override calculates per-tier split amounts and adjusts the minting weight so the terminal only mints project tokens for the portion of the payment that actually enters the project. It also sets the `JBPayHookSpecification.amount` to the total split amount so the terminal forwards those funds to the hook for distribution.
 
-### 2.4 Pricing Decimals Validation
+### 2.7 Pricing Decimals Validation
 
 `initialize(...)` now reverts with `JB721TiersHook_InvalidPricingDecimals` if `tiersConfig.decimals > 18`.
 
-### 2.5 `allowSetCustomToken` Pass-Through
+### 2.8 `allowSetCustomToken` Pass-Through
 
 The `JBPayDataHookRulesetMetadata` struct gained an `allowSetCustomToken` field. In v5, the project deployer hardcoded this to `false`. In v6, it passes through the value from the config.
 
@@ -133,8 +145,10 @@ The `JBPayDataHookRulesetMetadata` struct gained an `allowSetCustomToken` field.
 
 | Event | Signature | Description |
 |-------|-----------|-------------|
+| `AddToBalanceReverted` | `AddToBalanceReverted(uint256 indexed projectId, address token, uint256 amount, bytes reason)` | Emitted when leftover distribution's `addToBalanceOf` call fails. Funds remain in the hook contract. |
 | `SetName` | `SetName(string indexed name, address caller)` | Emitted when the collection name is changed |
 | `SetSymbol` | `SetSymbol(string indexed symbol, address caller)` | Emitted when the collection symbol is changed |
+| `SplitPayoutReverted` | `SplitPayoutReverted(uint256 indexed projectId, JBSplit split, uint256 amount, bytes reason, address caller)` | Emitted when a split payout reverts during distribution. The failed split's funds route to the project balance. |
 
 ### 3.2 New Event on `IJB721TiersHookStore`
 
@@ -144,7 +158,7 @@ The `JBPayDataHookRulesetMetadata` struct gained an `allowSetCustomToken` field.
 
 ### 3.3 Events Unchanged
 
-All other events (`AddPayCredits`, `AddTier`, `Mint`, `MintReservedNft`, `RemoveTier`, `SetBaseUri`, `SetContractUri`, `SetDiscountPercent`, `SetEncodedIPFSUri`, `SetTokenUriResolver`, `UsePayCredits`, `CleanTiers`, `HookDeployed`) remain identical.
+All other events (`AddPayCredits`, `AddTier`, `Mint`, `MintReservedNft`, `RemoveTier`, `SetBaseUri`, `SetContractUri`, `SetDiscountPercent`, `SetEncodedIPFSUri`, `SetTokenUriResolver`, `UsePayCredits`, `CleanTiers`, `HookDeployed`) remain unchanged.
 
 ---
 
@@ -157,11 +171,17 @@ All other events (`AddPayCredits`, `AddTier`, `Mint`, `MintReservedNft`, `Remove
 | `JB721TiersHook_CurrencyMismatch` | `(uint256 paymentCurrency, uint256 tierCurrency)` | Reserved for currency mismatch detection |
 | `JB721TiersHook_InvalidPricingDecimals` | `(uint256 decimals)` | Reverts when `tiersConfig.decimals > 18` during initialization |
 
-### 4.2 Store Errors with Added `tierId` Parameter
+### 4.2 New Error on `JB721TiersHookStore`
+
+| Error | Signature | Description |
+|-------|-----------|-------------|
+| `JB721TiersHookStore_SplitPercentExceedsBounds` | `(uint256 percent, uint256 limit)` | Reverts when a tier's `splitPercent` exceeds `JBConstants.SPLITS_TOTAL_PERCENT` during `recordAddTiers` |
+
+### 4.3 Store Errors with Added `tierId` Parameter
 
 See Section 1.7 above. Eight store errors gained a `tierId` parameter for improved debuggability.
 
-### 4.3 Errors Unchanged
+### 4.4 Errors Unchanged
 
 All other errors (`JB721Hook_InvalidPay`, `JB721Hook_InvalidCashOut`, `JB721Hook_UnauthorizedToken`, `JB721Hook_UnexpectedTokenCashedOut`, `JB721TiersHook_AlreadyInitialized`, `JB721TiersHook_NoProjectId`, `JB721TiersHook_Overspending`, `JB721TiersHook_MintReserveNftsPaused`, `JB721TiersHook_TierTransfersPaused`) remain unchanged.
 
@@ -240,15 +260,31 @@ In v5, `_packedPricingContext` packed three values: currency (bits 0-31), decima
 
 v5 reverted if `msg.value != 0` in `afterPayRecordedWith`. v6 removes this check because the hook now accepts forwarded native token payments for tier split distribution.
 
-### 6.8 `JB721TiersHookStore.recordAddTiers` — Stores `splitPercent`
+### 6.8 `JB721TiersHookLib._sendPayoutToSplit` — `split.hook` Priority
+
+Split payouts follow the same priority order as `JBMultiTerminal`: if `split.hook` is set, funds are sent to the hook via `processSplitWith`; otherwise if `split.projectId` is set, funds go to the project's primary terminal; otherwise funds go to `split.beneficiary`. For ERC-20 payments to hooks, tokens are transferred first and the hook callback is best-effort (failure does not revert).
+
+### 6.9 `JB721TiersHookLib` — Try-Catch on All External Calls
+
+All external calls during split distribution (split hooks, terminal `pay`, terminal `addToBalanceOf`, and leftover `addToBalanceOf`) are wrapped in try-catch. On failure: native token calls return false (funds stay in the hook), ERC-20 terminal call approvals are reset to zero, and `SplitPayoutReverted` or `AddToBalanceReverted` events are emitted with the revert reason.
+
+### 6.10 `JB721TiersHookLib.calculateSplitAmounts` — Discount Applied Before Splits
+
+Split amounts are calculated on the discount-adjusted (effective) tier price rather than the base price. This ensures the split amount matches the actual price the minter pays when a tier discount is active.
+
+### 6.11 `JB721TiersHookStore.recordAddTiers` — Validates `splitPercent`
+
+`recordAddTiers` now reverts with `JB721TiersHookStore_SplitPercentExceedsBounds` if a tier's `splitPercent` exceeds `JBConstants.SPLITS_TOTAL_PERCENT`.
+
+### 6.12 `JB721TiersHookStore.recordAddTiers` — Stores `splitPercent`
 
 The store now stores `splitPercent` in the `JBStored721Tier` packed struct (replacing the `votingUnits` field in storage). The `votingUnits` value continues to be stored in the `_tierVotingUnitsOf` mapping.
 
-### 6.9 `JB721TiersHookStore.recordAddTiers` — Emits `SetDefaultReserveBeneficiary`
+### 6.13 `JB721TiersHookStore.recordAddTiers` — Emits `SetDefaultReserveBeneficiary`
 
 When a tier config has `useReserveBeneficiaryAsDefault` set and the beneficiary differs from the current default, v6 emits the new `SetDefaultReserveBeneficiary` event.
 
-### 6.10 `JB721TiersHookProjectDeployer` — `allowSetCustomToken` Pass-Through
+### 6.14 `JB721TiersHookProjectDeployer` — `allowSetCustomToken` Pass-Through
 
 In v5, the project deployer hardcoded `allowSetCustomToken: false` when constructing `JBRulesetMetadata`. In v6, it passes through `payDataRulesetConfig.metadata.allowSetCustomToken`.
 
@@ -261,7 +297,7 @@ In v5, the project deployer hardcoded `allowSetCustomToken: false` when construc
 | v5 | v6 | Notes |
 |----|----|-------|
 | `IJB721Hook` | `IJB721Hook` | Unchanged (import path updated) |
-| `IJB721TiersHook` | `IJB721TiersHook` | `pricingContext()` return changed; `setMetadata()` signature changed; added `PRICES()`, `SPLITS()`, `SetName`, `SetSymbol` |
+| `IJB721TiersHook` | `IJB721TiersHook` | `pricingContext()` return changed; `setMetadata()` signature changed; added `PRICES()`, `SPLITS()`, `SetName`, `SetSymbol`, `SplitPayoutReverted`, `AddToBalanceReverted` |
 | `IJB721TiersHookDeployer` | `IJB721TiersHookDeployer` | Unchanged |
 | `IJB721TiersHookProjectDeployer` | `IJB721TiersHookProjectDeployer` | Unchanged |
 | `IJB721TiersHookStore` | `IJB721TiersHookStore` | Added `SetDefaultReserveBeneficiary` event; NatSpec added |
@@ -274,7 +310,7 @@ In v5, the project deployer hardcoded `allowSetCustomToken: false` when construc
 | `JB721TiersHook` | `JB721TiersHook` | Constructor gains `prices` and `splits`; tier splits system; code extracted to library |
 | `JB721TiersHookDeployer` | `JB721TiersHookDeployer` | Unchanged (import paths updated) |
 | `JB721TiersHookProjectDeployer` | `JB721TiersHookProjectDeployer` | `allowSetCustomToken` pass-through |
-| `JB721TiersHookStore` | `JB721TiersHookStore` | `splitPercent` storage; error params added; `SetDefaultReserveBeneficiary` event |
+| `JB721TiersHookStore` | `JB721TiersHookStore` | `splitPercent` storage and validation; error params added; `SplitPercentExceedsBounds` error; `SetDefaultReserveBeneficiary` event |
 | `JB721Hook` (abstract) | `JB721Hook` (abstract) | `cashOutWeightOf`/`totalCashOutWeight` signatures simplified; `msg.value` check removed from `afterPayRecordedWith` |
 | `ERC721` (abstract) | `ERC721` (abstract) | Added `_setName()` and `_setSymbol()` |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/721-hook-v6",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "license": "MIT",
   "repository": {
     "type": "git",

package/docs/book.css

@@ -1,13 +0,0 @@
-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

@@ -1,12 +0,0 @@
-[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

package/docs/solidity.min.js

@@ -1,74 +0,0 @@
-hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
-}catch(e){return!1}}
-var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
-;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
-begin:a,relevance:0},n={
-keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
-built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
-literal:"true false"},i={className:"string",
-begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
-begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
-return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
-return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
-SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
-var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
-begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
-begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
-className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
-contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
-className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
-contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
-solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
-HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
-;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
-;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
-;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
-;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
-keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
-literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
-built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
-},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
-},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
-excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
-begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
-built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
-},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
-lexemes:C,keywords:p}),w={className:"built_in",
-begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
-begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
-excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
-contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
-contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
-excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
-relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
-keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
-keywords:p,lexemes:C,
-contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
-className:"function",lexemes:C,
-beginKeywords:"function modifier event constructor fallback receive error",
-end:/[{;]/,excludeEnd:!0,
-contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
-},x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
-className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
-excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
-},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
-beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
-contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
-beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
-contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
-beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
-contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
-beginKeywords:"pragma",end:";",lexemes:C,keywords:{
-keyword:"pragma solidity experimental abicoder",
-built_in:"ABIEncoderV2 SMTChecker v1 v2"},
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
-className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
-beginKeywords:"assembly",end:/\b\B/,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
-end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
-end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
-
-// Ugly hack to reload HLJS
-hljs.initHighlightingOnLoad();

package/docs/src/README.md

@@ -1,253 +0,0 @@
-# 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/docs/src/SUMMARY.md

@@ -1,38 +0,0 @@
-# Summary
-- [Home](README.md)
-# src
-  - [❱ abstract](src/abstract/README.md)
-    - [ERC721](src/abstract/ERC721.sol/abstract.ERC721.md)
-    - [JB721Hook](src/abstract/JB721Hook.sol/abstract.JB721Hook.md)
-  - [❱ interfaces](src/interfaces/README.md)
-    - [IJB721Hook](src/interfaces/IJB721Hook.sol/interface.IJB721Hook.md)
-    - [IJB721TiersHook](src/interfaces/IJB721TiersHook.sol/interface.IJB721TiersHook.md)
-    - [IJB721TiersHookDeployer](src/interfaces/IJB721TiersHookDeployer.sol/interface.IJB721TiersHookDeployer.md)
-    - [IJB721TiersHookProjectDeployer](src/interfaces/IJB721TiersHookProjectDeployer.sol/interface.IJB721TiersHookProjectDeployer.md)
-    - [IJB721TiersHookStore](src/interfaces/IJB721TiersHookStore.sol/interface.IJB721TiersHookStore.md)
-    - [IJB721TokenUriResolver](src/interfaces/IJB721TokenUriResolver.sol/interface.IJB721TokenUriResolver.md)
-  - [❱ libraries](src/libraries/README.md)
-    - [JB721Constants](src/libraries/JB721Constants.sol/library.JB721Constants.md)
-    - [JB721TiersRulesetMetadataResolver](src/libraries/JB721TiersRulesetMetadataResolver.sol/library.JB721TiersRulesetMetadataResolver.md)
-    - [JBBitmap](src/libraries/JBBitmap.sol/library.JBBitmap.md)
-    - [JBIpfsDecoder](src/libraries/JBIpfsDecoder.sol/library.JBIpfsDecoder.md)
-  - [❱ structs](src/structs/README.md)
-    - [JB721InitTiersConfig](src/structs/JB721InitTiersConfig.sol/struct.JB721InitTiersConfig.md)
-    - [JB721Tier](src/structs/JB721Tier.sol/struct.JB721Tier.md)
-    - [JB721TierConfig](src/structs/JB721TierConfig.sol/struct.JB721TierConfig.md)
-    - [JB721TiersHookFlags](src/structs/JB721TiersHookFlags.sol/struct.JB721TiersHookFlags.md)
-    - [JB721TiersMintReservesConfig](src/structs/JB721TiersMintReservesConfig.sol/struct.JB721TiersMintReservesConfig.md)
-    - [JB721TiersRulesetMetadata](src/structs/JB721TiersRulesetMetadata.sol/struct.JB721TiersRulesetMetadata.md)
-    - [JB721TiersSetDiscountPercentConfig](src/structs/JB721TiersSetDiscountPercentConfig.sol/struct.JB721TiersSetDiscountPercentConfig.md)
-    - [JBBitmapWord](src/structs/JBBitmapWord.sol/struct.JBBitmapWord.md)
-    - [JBDeploy721TiersHookConfig](src/structs/JBDeploy721TiersHookConfig.sol/struct.JBDeploy721TiersHookConfig.md)
-    - [JBLaunchProjectConfig](src/structs/JBLaunchProjectConfig.sol/struct.JBLaunchProjectConfig.md)
-    - [JBLaunchRulesetsConfig](src/structs/JBLaunchRulesetsConfig.sol/struct.JBLaunchRulesetsConfig.md)
-    - [JBPayDataHookRulesetConfig](src/structs/JBPayDataHookRulesetConfig.sol/struct.JBPayDataHookRulesetConfig.md)
-    - [JBPayDataHookRulesetMetadata](src/structs/JBPayDataHookRulesetMetadata.sol/struct.JBPayDataHookRulesetMetadata.md)
-    - [JBQueueRulesetsConfig](src/structs/JBQueueRulesetsConfig.sol/struct.JBQueueRulesetsConfig.md)
-    - [JBStored721Tier](src/structs/JBStored721Tier.sol/struct.JBStored721Tier.md)
-  - [JB721TiersHook](src/JB721TiersHook.sol/contract.JB721TiersHook.md)
-  - [JB721TiersHookDeployer](src/JB721TiersHookDeployer.sol/contract.JB721TiersHookDeployer.md)
-  - [JB721TiersHookProjectDeployer](src/JB721TiersHookProjectDeployer.sol/contract.JB721TiersHookProjectDeployer.md)
-  - [JB721TiersHookStore](src/JB721TiersHookStore.sol/contract.JB721TiersHookStore.md)