@bananapus/721-hook-v6 0.0.1

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

@@ -0,0 +1,16 @@
+# JB721TiersMintReservesConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721TiersMintReservesConfig.sol)
+
+**Notes:**
+- member: tierId The ID of the tier to mint from.
+
+- member: count The number of NFTs to mint from that tier.
+
+
+```solidity
+struct JB721TiersMintReservesConfig {
+    uint32 tierId;
+    uint16 count;
+}
+```
+

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

@@ -0,0 +1,20 @@
+# JB721TiersRulesetMetadata
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721TiersRulesetMetadata.sol)
+
+`JB721TiersHook` options which are packed and stored in the corresponding `JBRulesetMetadata.metadata` on a
+per-ruleset basis.
+
+**Notes:**
+- member: pauseTransfers A boolean indicating whether NFT transfers are paused during this ruleset.
+
+- member: pauseMintPendingReserves A boolean indicating whether pending/outstanding NFT reserves can be minted
+during this ruleset.
+
+
+```solidity
+struct JB721TiersRulesetMetadata {
+    bool pauseTransfers;
+    bool pauseMintPendingReserves;
+}
+```
+

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

@@ -0,0 +1,16 @@
+# JB721TiersSetDiscountPercentConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JB721TiersSetDiscountPercentConfig.sol)
+
+**Notes:**
+- member: tierId The ID of the tier to set the discount percent for.
+
+- member: discountPercent The discount percent to set for the tier.
+
+
+```solidity
+struct JB721TiersSetDiscountPercentConfig {
+    uint32 tierId;
+    uint16 discountPercent;
+}
+```
+

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

@@ -0,0 +1,19 @@
+# JBBitmapWord
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBBitmapWord.sol)
+
+*A "word" is a 256-bit integer that stores the status of 256 bits (true/false values). Each row of the
+`JBBitmap` matrix is a "word".*
+
+**Notes:**
+- member: The information stored at the index.
+
+- member: The index.
+
+
+```solidity
+struct JBBitmapWord {
+    uint256 currentWord;
+    uint256 currentDepth;
+}
+```
+

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

@@ -0,0 +1,34 @@
+# JBDeploy721TiersHookConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBDeploy721TiersHookConfig.sol)
+
+**Notes:**
+- member: name The NFT collection's name.
+
+- member: symbol The NFT collection's symbol.
+
+- member: baseUri The URI to use as a base for full NFT URIs.
+
+- member: tokenUriResolver The contract responsible for resolving the URI for each NFT.
+
+- member: contractUri The URI where this contract's metadata can be found.
+
+- member: tiersConfig The NFT tiers and pricing config to launch the hook with.
+
+- member: reserveBeneficiary The default reserved beneficiary for all tiers.
+
+- member: flags A set of boolean options to configure the hook with.
+
+
+```solidity
+struct JBDeploy721TiersHookConfig {
+    string name;
+    string symbol;
+    string baseUri;
+    IJB721TokenUriResolver tokenUriResolver;
+    string contractUri;
+    JB721InitTiersConfig tiersConfig;
+    address reserveBeneficiary;
+    JB721TiersHookFlags flags;
+}
+```
+

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

@@ -0,0 +1,23 @@
+# JBLaunchProjectConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBLaunchProjectConfig.sol)
+
+**Notes:**
+- member: projectUri Metadata URI to associate with the project. This can be updated any time by the owner of
+the project.
+
+- member: rulesetConfigurations The ruleset configurations to queue.
+
+- member: terminalConfigurations The terminal configurations to add for the project.
+
+- member: memo A memo to pass along to the emitted event.
+
+
+```solidity
+struct JBLaunchProjectConfig {
+    string projectUri;
+    JBPayDataHookRulesetConfig[] rulesetConfigurations;
+    JBTerminalConfig[] terminalConfigurations;
+    string memo;
+}
+```
+

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

@@ -0,0 +1,22 @@
+# JBLaunchRulesetsConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBLaunchRulesetsConfig.sol)
+
+**Notes:**
+- member: projectId The ID of the project to launch rulesets for.
+
+- member: rulesetConfigurations The ruleset configurations to queue.
+
+- member: terminalConfigurations The terminal configurations to add for the project.
+
+- member: memo A memo to pass along to the emitted event.
+
+
+```solidity
+struct JBLaunchRulesetsConfig {
+    uint56 projectId;
+    JBPayDataHookRulesetConfig[] rulesetConfigurations;
+    JBTerminalConfig[] terminalConfigurations;
+    string memo;
+}
+```
+

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

@@ -0,0 +1,51 @@
+# JBPayDataHookRulesetConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBPayDataHookRulesetConfig.sol)
+
+**Notes:**
+- member: mustStartAtOrAfter The earliest time the ruleset can start.
+
+- member: duration The number of seconds the ruleset lasts for, after which a new ruleset will start. A
+duration of 0 means that the ruleset will stay active until the project owner explicitly issues a reconfiguration,
+at which point a new ruleset will immediately start with the updated properties. If the duration is greater than 0,
+a project owner cannot make changes to a ruleset's parameters while it is active – any proposed changes will apply
+to the subsequent ruleset. If no changes are proposed, a ruleset rolls over to another one with the same properties
+but new `start` timestamp and a decayed `weight`.
+
+- member: weight A fixed point number with 18 decimals that contracts can use to base arbitrary calculations
+on. For example, payment terminals can use this to determine how many tokens should be minted when a payment is
+received.
+
+- member: weightCutPercent A percent by how much the `weight` of the subsequent ruleset should be reduced, if
+the
+project owner hasn't queued the subsequent ruleset with an explicit `weight`. If it's 0, each ruleset will have
+equal weight. If the number is 90%, the next ruleset will have a 10% smaller weight. This weight is out of
+`JBConstants.MAX_WEIGHT_CUT_PERCENT`.
+
+- member: approvalHook An address of a contract that says whether a proposed ruleset should be accepted or
+rejected. It
+can be used to create rules around how a project owner can change ruleset parameters over time.
+
+- member: metadata Metadata specifying the controller-specific parameters that a ruleset can have. These
+properties cannot change until the next ruleset starts.
+
+- member: splitGroups An array of splits to use for any number of groups while the ruleset is active.
+
+- member: fundAccessLimitGroups An array of structs which dictate the amount of funds a project can access from
+its balance in each payment terminal while the ruleset is active. Amounts are fixed point numbers using the same
+number of decimals as the corresponding terminal. The `payoutLimit` and `surplusAllowance` parameters must fit in
+a `uint232`.
+
+
+```solidity
+struct JBPayDataHookRulesetConfig {
+    uint48 mustStartAtOrAfter;
+    uint32 duration;
+    uint112 weight;
+    uint32 weightCutPercent;
+    IJBRulesetApprovalHook approvalHook;
+    JBPayDataHookRulesetMetadata metadata;
+    JBSplitGroup[] splitGroups;
+    JBFundAccessLimitGroup[] fundAccessLimitGroups;
+}
+```
+

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

@@ -0,0 +1,66 @@
+# JBPayDataHookRulesetMetadata
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBPayDataHookRulesetMetadata.sol)
+
+**Notes:**
+- member: reservedPercent The reserved percent of the ruleset. This number is a percentage calculated out of
+`JBConstants.MAX_RESERVED_PERCENT`.
+
+- member: cashOutTaxRate The cash out tax rate of the ruleset. This number is a percentage calculated out of
+`JBConstants.MAX_CASH_OUT_TAX_RATE`.
+
+- member: baseCurrency The currency on which to base the ruleset's weight.
+
+- member: pausePay A flag indicating if the pay functionality should be paused during the ruleset.
+
+- member: pauseCreditTransfers A flag indicating if the project token transfer functionality should be paused
+during the funding cycle.
+
+- member: allowOwnerMinting A flag indicating if the project owner or an operator with the `MINT_TOKENS`
+permission from the owner should be allowed to mint project tokens on demand during this ruleset.
+
+- member: allowTerminalMigration A flag indicating if migrating terminals should be allowed during this
+ruleset.
+
+- member: allowSetTerminals A flag indicating if a project's terminals can be added or removed.
+
+- member: allowSetController A flag indicating if a project's controller can be changed.
+
+- member: allowAddAccountingContext A flag indicating if a project can add new accounting contexts for its
+terminals to use.
+
+- member: allowAddPriceFeed A flag indicating if a project can add new price feeds to calculate exchange rates
+between its tokens.
+
+- member: holdFees A flag indicating if fees should be held during this ruleset.
+
+- member: useTotalSurplusForCashOut A flag indicating if cash outs should use the project's balance held
+in all terminals instead of the project's local terminal balance from which the cash out is being fulfilled.
+
+- member: useDataHookForCashOuts A flag indicating if the data hook should be used for cash out transactions
+during
+this ruleset.
+
+- member: metadata Metadata of the metadata, up to uint8 in size.
+
+
+```solidity
+struct JBPayDataHookRulesetMetadata {
+    uint16 reservedPercent;
+    uint16 cashOutTaxRate;
+    uint32 baseCurrency;
+    bool pausePay;
+    bool pauseCreditTransfers;
+    bool allowOwnerMinting;
+    bool allowTerminalMigration;
+    bool allowSetTerminals;
+    bool allowSetController;
+    bool allowAddAccountingContext;
+    bool allowAddPriceFeed;
+    bool ownerMustSendPayouts;
+    bool holdFees;
+    bool useTotalSurplusForCashOuts;
+    bool useDataHookForCashOut;
+    uint16 metadata;
+}
+```
+

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

@@ -0,0 +1,21 @@
+# JBQueueRulesetsConfig
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBQueueRulesetsConfig.sol)
+
+**Notes:**
+- member: projectId The ID of the project to launch rulesets for.
+
+- member: rulesetConfigurations The ruleset configurations to queue.
+
+- member: terminalConfigurations The terminal configurations to add for the project.
+
+- member: memo A memo to pass along to the emitted event.
+
+
+```solidity
+struct JBQueueRulesetsConfig {
+    uint56 projectId;
+    JBPayDataHookRulesetConfig[] rulesetConfigurations;
+    string memo;
+}
+```
+

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

@@ -0,0 +1,42 @@
+# JBStored721Tier
+[Git Source](https://github.com/Bananapus/nana-721-hook/blob/e813fb5b7d17cd3d18023137d70a7b2f3911ad99/src/structs/JBStored721Tier.sol)
+
+**Notes:**
+- member: price The price to buy an NFT in this tier, in terms of the currency in its `JBInitTiersConfig`.
+
+- member: remainingSupply The remaining number of NFTs which can be minted from this tier.
+
+- member: initialSupply The total number of NFTs which can be minted from this tier.
+
+- member: votingUnits The number of votes that each NFT in this tier gets.
+
+- member: category The category that NFTs in this tier belongs to. Used to group NFT tiers.
+
+- member: discountPercent The discount that should be applied to the tier.
+
+- member: reserveFrequency The frequency at which an extra NFT is minted for the `reserveBeneficiary` from this
+tier. With a `reserveFrequency` of 5, an extra NFT will be minted for the `reserveBeneficiary` for every 5 NFTs
+purchased.
+
+- member: allowOwnerMint A boolean indicating whether the contract's owner can mint NFTs from this tier
+on-demand.
+
+- member: transfersPausable A boolean indicating whether transfers for NFTs in tier can be paused.
+
+- member: useVotingUnits A boolean indicating whether the `votingUnits` should be used to calculate voting
+power. If `useVotingUnits` is false, voting power is based on the tier's price.
+
+
+```solidity
+struct JBStored721Tier {
+    uint104 price;
+    uint32 remainingSupply;
+    uint32 initialSupply;
+    uint32 votingUnits;
+    uint24 category;
+    uint8 discountPercent;
+    uint16 reserveFrequency;
+    uint8 packedBools;
+}
+```
+

package/docs/src/src/structs/README.md

@@ -0,0 +1,18 @@
+
+
+# Contents
+- [JB721InitTiersConfig](JB721InitTiersConfig.sol/struct.JB721InitTiersConfig.md)
+- [JB721Tier](JB721Tier.sol/struct.JB721Tier.md)
+- [JB721TierConfig](JB721TierConfig.sol/struct.JB721TierConfig.md)
+- [JB721TiersHookFlags](JB721TiersHookFlags.sol/struct.JB721TiersHookFlags.md)
+- [JB721TiersMintReservesConfig](JB721TiersMintReservesConfig.sol/struct.JB721TiersMintReservesConfig.md)
+- [JB721TiersRulesetMetadata](JB721TiersRulesetMetadata.sol/struct.JB721TiersRulesetMetadata.md)
+- [JB721TiersSetDiscountPercentConfig](JB721TiersSetDiscountPercentConfig.sol/struct.JB721TiersSetDiscountPercentConfig.md)
+- [JBBitmapWord](JBBitmapWord.sol/struct.JBBitmapWord.md)
+- [JBDeploy721TiersHookConfig](JBDeploy721TiersHookConfig.sol/struct.JBDeploy721TiersHookConfig.md)
+- [JBLaunchProjectConfig](JBLaunchProjectConfig.sol/struct.JBLaunchProjectConfig.md)
+- [JBLaunchRulesetsConfig](JBLaunchRulesetsConfig.sol/struct.JBLaunchRulesetsConfig.md)
+- [JBPayDataHookRulesetConfig](JBPayDataHookRulesetConfig.sol/struct.JBPayDataHookRulesetConfig.md)
+- [JBPayDataHookRulesetMetadata](JBPayDataHookRulesetMetadata.sol/struct.JBPayDataHookRulesetMetadata.md)
+- [JBQueueRulesetsConfig](JBQueueRulesetsConfig.sol/struct.JBQueueRulesetsConfig.md)
+- [JBStored721Tier](JBStored721Tier.sol/struct.JBStored721Tier.md)

package/foundry.lock

@@ -0,0 +1,11 @@
+{
+  "lib/forge-std": {
+    "rev": "77876f8a5b44b770a935621bb331660c90ac928e"
+  },
+  "lib/sphinx": {
+    "branch": {
+      "name": "v0.23.0",
+      "rev": "5fb24a825f46bd6ae0b5359fe0da1d2346126b09"
+    }
+  }
+}

package/foundry.toml

@@ -0,0 +1,22 @@
+[profile.default]
+solc = '0.8.23'
+evm_version = 'paris'
+optimizer_runs = 800
+libs = ["node_modules", "lib"]
+fs_permissions = [{ access = "read-write", path = "./"}]
+
+[profile.ci_sizes]
+optimizer_runs = 200
+
+[fuzz]
+runs = 4096
+
+[invariant]
+runs = 1024
+depth = 100
+fail_on_revert = false
+
+[fmt]
+number_underscore = "thousands"
+multiline_func_header = "all"
+wrap_comments = true

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@bananapus/721-hook-v6",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Bananapus/nana-721-hook-v6"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "test": "forge test",
+    "coverage": "forge coverage --report lcov --report summary",
+    "deploy:mainnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks mainnets",
+    "deploy:testnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks testnets",
+    "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'nana-721-hook-v6'"
+  },
+  "dependencies": {
+    "@bananapus/address-registry-v6": "^0.0.1",
+    "@bananapus/core-v6": "^0.0.1",
+    "@bananapus/ownable-v6": "^0.0.1",
+    "@bananapus/permission-ids-v6": "^0.0.1",
+    "@openzeppelin/contracts": "5.2.0",
+    "@prb/math": "^4.1.0",
+    "solady": "^0.1.8"
+  },
+  "devDependencies": {
+    "@sphinx-labs/plugins": "^0.33.2"
+  }
+}

package/remappings.txt

@@ -0,0 +1 @@
+@sphinx-labs/contracts/=node_modules/@sphinx-labs/contracts/contracts/foundry

package/script/Deploy.s.sol

@@ -0,0 +1,140 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.23;
+
+import "@bananapus/core-v6/script/helpers/CoreDeploymentLib.sol";
+import "@bananapus/address-registry-v6/script/helpers/AddressRegistryDeploymentLib.sol";
+
+import {Sphinx} from "@sphinx-labs/contracts/SphinxPlugin.sol";
+import {Script} from "forge-std/Script.sol";
+
+import {JB721TiersHookDeployer} from "../src/JB721TiersHookDeployer.sol";
+import {JB721TiersHookProjectDeployer} from "../src/JB721TiersHookProjectDeployer.sol";
+import {JB721TiersHookStore} from "../src/JB721TiersHookStore.sol";
+import {JB721TiersHook} from "../src/JB721TiersHook.sol";
+
+contract DeployScript is Script, Sphinx {
+    /// @notice tracks the deployment of the core contracts for the chain we are deploying to.
+    CoreDeployment core;
+    /// @notice tracks the deployment of the address registry for the chain we are deploying to.
+    AddressRegistryDeployment registry;
+
+    /// @notice The address that is allowed to forward calls to the terminal and controller on a users behalf.
+    address private TRUSTED_FORWARDER;
+
+    /// @notice the salts that are used to deploy the contracts.
+    bytes32 HOOK_SALT = "JB721TiersHookV6_";
+    bytes32 HOOK_DEPLOYER_SALT = "JB721TiersHookDeployerV6_";
+    bytes32 HOOK_STORE_SALT = "JB721TiersHookStoreV6_";
+    bytes32 PROJECT_DEPLOYER_SALT = "JB721TiersHookProjectDeployerV6";
+
+    function configureSphinx() public override {
+        sphinxConfig.projectName = "nana-721-hook-v6";
+        sphinxConfig.mainnets = ["ethereum", "optimism", "base", "arbitrum"];
+        sphinxConfig.testnets = ["ethereum_sepolia", "optimism_sepolia", "base_sepolia", "arbitrum_sepolia"];
+    }
+
+    function run() public {
+        // Get the deployment addresses for the nana CORE for this chain.
+        // We want to do this outside of the `sphinx` modifier.
+        core = CoreDeploymentLib.getDeployment(
+            vm.envOr("NANA_CORE_DEPLOYMENT_PATH", string("node_modules/@bananapus/core-v6/deployments/"))
+        );
+
+        // We use the same trusted forwarder as the core deployment.
+        TRUSTED_FORWARDER = core.permissions.trustedForwarder();
+
+        registry = AddressRegistryDeploymentLib.getDeployment(
+            vm.envOr(
+                "NANA_ADDRESS_REGISTRY_DEPLOYMENT_PATH",
+                string("node_modules/@bananapus/address-registry-v6/deployments/")
+            )
+        );
+        // Perform the deployment transactions.
+        deploy();
+    }
+
+    /// @notice each contract here will be deployed it if needs to be (re)deployed.
+    /// It will deploy if the contracts bytecode changes or if any constructor arguments change.
+    /// Since all the contract dependencies are passed in using the constructor args,
+    // this makes it so that if any dependency contract (address) changes the contract will be redeployed.
+    function deploy() public sphinx {
+        JB721TiersHookStore store;
+        {
+            // Perform the check for the store.
+            (address _store, bool _storeIsDeployed) =
+                _isDeployed(HOOK_STORE_SALT, type(JB721TiersHookStore).creationCode, "");
+
+            // Deploy it if it has not been deployed yet.
+            store = !_storeIsDeployed ? new JB721TiersHookStore{salt: HOOK_STORE_SALT}() : JB721TiersHookStore(_store);
+        }
+
+        JB721TiersHook hook;
+        {
+            // Perform the check for the registry.
+            (address _hook, bool _hookIsDeployed) = _isDeployed(
+                HOOK_SALT,
+                type(JB721TiersHook).creationCode,
+                abi.encode(core.directory, core.permissions, core.rulesets, store, TRUSTED_FORWARDER)
+            );
+
+            // Deploy it if it has not been deployed yet.
+            hook = !_hookIsDeployed
+                ? new JB721TiersHook{salt: HOOK_SALT}(
+                    core.directory, core.permissions, core.rulesets, store, TRUSTED_FORWARDER
+                )
+                : JB721TiersHook(_hook);
+        }
+
+        JB721TiersHookDeployer hookDeployer;
+        {
+            // Perform the check for the registry.
+            (address _hookDeployer, bool _hookDeployerIsDeployed) = _isDeployed(
+                HOOK_DEPLOYER_SALT,
+                type(JB721TiersHookDeployer).creationCode,
+                abi.encode(hook, store, registry.registry, TRUSTED_FORWARDER)
+            );
+
+            hookDeployer = !_hookDeployerIsDeployed
+                ? new JB721TiersHookDeployer{salt: HOOK_DEPLOYER_SALT}(
+                    hook, store, registry.registry, TRUSTED_FORWARDER
+                )
+                : JB721TiersHookDeployer(_hookDeployer);
+        }
+
+        JB721TiersHookProjectDeployer projectDeployer;
+        {
+            // Perform the check for the registry.
+            (address _projectDeployer, bool _projectDeployerIsdeployed) = _isDeployed(
+                PROJECT_DEPLOYER_SALT,
+                type(JB721TiersHookProjectDeployer).creationCode,
+                abi.encode(core.directory, core.permissions, hookDeployer, TRUSTED_FORWARDER)
+            );
+
+            projectDeployer = !_projectDeployerIsdeployed
+                ? new JB721TiersHookProjectDeployer{salt: PROJECT_DEPLOYER_SALT}(
+                    core.directory, core.permissions, hookDeployer, TRUSTED_FORWARDER
+                )
+                : JB721TiersHookProjectDeployer(_projectDeployer);
+        }
+    }
+
+    function _isDeployed(
+        bytes32 salt,
+        bytes memory creationCode,
+        bytes memory arguments
+    )
+        internal
+        view
+        returns (address, bool)
+    {
+        address _deployedTo = vm.computeCreate2Address({
+            salt: salt,
+            initCodeHash: keccak256(abi.encodePacked(creationCode, arguments)),
+            // Arachnid/deterministic-deployment-proxy address.
+            deployer: address(0x4e59b44847b379578588920cA78FbF26c0B4956C)
+        });
+
+        // Return if code is already present at this address.
+        return (_deployedTo, address(_deployedTo).code.length != 0);
+    }
+}

package/script/helpers/Hook721DeploymentLib.sol

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.23;
+
+import {stdJson} from "forge-std/Script.sol";
+import {Vm} from "forge-std/Vm.sol";
+
+import {SphinxConstants, NetworkInfo} from "@sphinx-labs/contracts/SphinxConstants.sol";
+
+import {IJB721TiersHookDeployer} from "../../src/interfaces/IJB721TiersHookDeployer.sol";
+import {IJB721TiersHookProjectDeployer} from "../../src/interfaces/IJB721TiersHookProjectDeployer.sol";
+import {IJB721TiersHookStore} from "../../src/interfaces/IJB721TiersHookStore.sol";
+
+struct Hook721Deployment {
+    IJB721TiersHookDeployer hook_deployer;
+    IJB721TiersHookProjectDeployer project_deployer;
+    IJB721TiersHookStore store;
+}
+
+library Hook721DeploymentLib {
+    // Cheat code address, 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D.
+    address internal constant VM_ADDRESS = address(uint160(uint256(keccak256("hevm cheat code"))));
+    Vm internal constant vm = Vm(VM_ADDRESS);
+
+    function getDeployment(string memory path) internal returns (Hook721Deployment memory deployment) {
+        // get chainId for which we need to get the deployment.
+        uint256 chainId = block.chainid;
+
+        // Deploy to get the constants.
+        // TODO: get constants without deploy.
+        SphinxConstants sphinxConstants = new SphinxConstants();
+        NetworkInfo[] memory networks = sphinxConstants.getNetworkInfoArray();
+
+        for (uint256 _i; _i < networks.length; _i++) {
+            if (networks[_i].chainId == chainId) {
+                return getDeployment(path, networks[_i].name);
+            }
+        }
+
+        revert("ChainID is not (currently) supported by Sphinx.");
+    }
+
+    function getDeployment(
+        string memory path,
+        string memory network_name
+    )
+        internal
+        view
+        returns (Hook721Deployment memory deployment)
+    {
+        deployment.hook_deployer = IJB721TiersHookDeployer(
+            _getDeploymentAddress(path, "nana-721-hook-v6", network_name, "JB721TiersHookDeployer")
+        );
+
+        deployment.project_deployer = IJB721TiersHookProjectDeployer(
+            _getDeploymentAddress(path, "nana-721-hook-v6", network_name, "JB721TiersHookProjectDeployer")
+        );
+
+        deployment.store =
+            IJB721TiersHookStore(_getDeploymentAddress(path, "nana-721-hook-v6", network_name, "JB721TiersHookStore"));
+    }
+
+    /// @notice Get the address of a contract that was deployed by the Deploy script.
+    /// @dev Reverts if the contract was not found.
+    /// @param path The path to the deployment file.
+    /// @param contractName The name of the contract to get the address of.
+    /// @return The address of the contract.
+    function _getDeploymentAddress(
+        string memory path,
+        string memory project_name,
+        string memory network_name,
+        string memory contractName
+    )
+        internal
+        view
+        returns (address)
+    {
+        string memory deploymentJson =
+            vm.readFile(string.concat(path, project_name, "/", network_name, "/", contractName, ".json"));
+        return stdJson.readAddress(deploymentJson, ".address");
+    }
+}

package/slither-ci.config.json

@@ -0,0 +1,10 @@
+{
+  "detectors_to_exclude": "timestamp,uninitialized-local,naming-convention,solc-version,shadowing-local",
+  "exclude_informational": true,
+  "exclude_low": false,
+  "exclude_medium": false,
+  "exclude_high": false,
+  "disable_color": false,
+  "filter_paths": "(mocks/|test/|node_modules/|lib/)",
+  "legacy_ast": false
+}