@croptop/core-v6 0.0.1

package/foundry.toml

@@ -0,0 +1,25 @@
+[profile.default]
+solc = '0.8.23'
+evm_version = 'paris'
+optimizer_runs = 100000000
+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
+
+[rpc_endpoints]
+ethereum = "${RPC_ETHEREUM_MAINNET}"
+
+[fmt]
+number_underscore = "thousands"
+multiline_func_header = "all"
+wrap_comments = true

package/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "@croptop/core-v6",
+    "version": "0.0.1",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mejango/croptop-core-v6"
+    },
+    "scripts": {
+        "test": "forge test",
+        "coverage:integration": "forge coverage --match-path \"./src/*.sol\" --report lcov --report summary",
+        "deploy:mainnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks mainnets",
+        "deploy:mainnets:project": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/ConfigureFeeProject.s.sol --networks mainnets",
+        "deploy:testnets": "source ./.env && npx sphinx propose ./script/Deploy.s.sol --networks testnets",
+        "deploy:testnets:project": "source ./.env && export START_TIME=$(date +%s) && npx sphinx propose ./script/ConfigureFeeProject.s.sol --networks testnets",
+        "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'croptop-core-v5'"
+    },
+    "dependencies": {
+        "@bananapus/core-v6": "^0.0.1",
+        "@bananapus/721-hook-v6": "^0.0.1",
+        "@bananapus/permission-ids-v6": "^0.0.1",
+        "@bananapus/ownable-v6": "^0.0.1",
+        "@bananapus/suckers-v6": "^0.0.1",
+        "@bananapus/buyback-hook-v6": "^0.0.1",
+        "@bananapus/swap-terminal-v6": "^0.0.1",
+        "@openzeppelin/contracts": "^5.2.0"
+    },
+    "devDependencies": {
+        "@sphinx-labs/plugins": "^0.33.1"
+    }
+}

package/remappings.txt

@@ -0,0 +1,2 @@
+@sphinx-labs/contracts/=node_modules/@sphinx-labs/contracts/contracts/foundry
+@croptop/core-v5=./

package/script/ConfigureFeeProject.s.sol

@@ -0,0 +1,386 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.23;
+
+import "@bananapus/721-hook-v5/script/helpers/Hook721DeploymentLib.sol";
+import "@bananapus/buyback-hook-v5/script/helpers/BuybackDeploymentLib.sol";
+import "@bananapus/core-v5/script/helpers/CoreDeploymentLib.sol";
+import "@bananapus/suckers-v5/script/helpers/SuckerDeploymentLib.sol";
+import "@bananapus/swap-terminal-v5/script/helpers/SwapTerminalDeploymentLib.sol";
+import "@rev-net/core-v5/script/helpers/RevnetCoreDeploymentLib.sol";
+import "./helpers/CroptopDeploymentLib.sol";
+
+import {Sphinx} from "@sphinx-labs/contracts/SphinxPlugin.sol";
+import {Script} from "forge-std/Script.sol";
+
+import {IJB721TokenUriResolver} from "@bananapus/721-hook-v5/src/interfaces/IJB721TokenUriResolver.sol";
+import {JBDeploy721TiersHookConfig} from "@bananapus/721-hook-v5/src/structs/JBDeploy721TiersHookConfig.sol";
+import {JB721InitTiersConfig} from "@bananapus/721-hook-v5/src/structs/JB721InitTiersConfig.sol";
+import {JB721TierConfig} from "@bananapus/721-hook-v5/src/structs/JB721TierConfig.sol";
+import {JB721TiersHookFlags} from "@bananapus/721-hook-v5/src/structs/JB721TiersHookFlags.sol";
+import {IJBPrices} from "@bananapus/core-v5/src/interfaces/IJBPrices.sol";
+import {IJBSplitHook} from "@bananapus/core-v5/src/interfaces/IJBSplitHook.sol";
+import {IJBTerminal} from "@bananapus/core-v5/src/interfaces/IJBTerminal.sol";
+import {JBAccountingContext} from "@bananapus/core-v5/src/structs/JBAccountingContext.sol";
+import {JBTerminalConfig} from "@bananapus/core-v5/src/structs/JBTerminalConfig.sol";
+import {JBConstants} from "@bananapus/core-v5/src/libraries/JBConstants.sol";
+import {JBSplit} from "@bananapus/core-v5/src/structs/JBSplit.sol";
+import {JBCurrencyIds} from "@bananapus/core-v5/src/libraries/JBCurrencyIds.sol";
+import {JBSuckerDeployerConfig} from "@bananapus/suckers-v5/src/structs/JBSuckerDeployerConfig.sol";
+import {JBTokenMapping} from "@bananapus/suckers-v5/src/structs/JBTokenMapping.sol";
+import {REVAutoIssuance} from "@rev-net/core-v5/src/structs/REVAutoIssuance.sol";
+import {REVBuybackHookConfig} from "@rev-net/core-v5/src/structs/REVBuybackHookConfig.sol";
+import {REVBuybackPoolConfig} from "@rev-net/core-v5/src/structs/REVBuybackPoolConfig.sol";
+import {REVConfig} from "@rev-net/core-v5/src/structs/REVConfig.sol";
+import {REVCroptopAllowedPost} from "@rev-net/core-v5/src/structs/REVCroptopAllowedPost.sol";
+import {REVDeploy721TiersHookConfig} from "@rev-net/core-v5/src/structs/REVDeploy721TiersHookConfig.sol";
+import {REVDescription} from "@rev-net/core-v5/src/structs/REVDescription.sol";
+import {REVLoanSource} from "@rev-net/core-v5/src/structs/REVLoanSource.sol";
+import {REVStageConfig} from "@rev-net/core-v5/src/structs/REVStageConfig.sol";
+import {REVSuckerDeploymentConfig} from "@rev-net/core-v5/src/structs/REVSuckerDeploymentConfig.sol";
+
+struct FeeProjectConfig {
+    REVConfig configuration;
+    JBTerminalConfig[] terminalConfigurations;
+    REVBuybackHookConfig buybackHookConfiguration;
+    REVSuckerDeploymentConfig suckerDeploymentConfiguration;
+    REVDeploy721TiersHookConfig hookConfiguration;
+    REVCroptopAllowedPost[] allowedPosts;
+}
+
+contract ConfigureFeeProjectScript is Script, Sphinx {
+    /// @notice tracks the deployment of the buyback hook.
+    BuybackDeployment buybackHook;
+    /// @notice tracks the deployment of the core contracts for the chain we are deploying to.
+    CoreDeployment core;
+    /// @notice tracks the latest croptop deployment.
+    CroptopDeployment croptop;
+    /// @notice tracks the deployment of the 721 hook contracts for the chain we are deploying to.
+    Hook721Deployment hook;
+    /// @notice tracks the deployment of the revnet contracts for the chain we are deploying to.
+    RevnetCoreDeployment revnet;
+    /// @notice tracks the deployment of the sucker contracts for the chain we are deploying to.
+    SuckerDeployment suckers;
+    /// @notice tracks the deployment of the swap terminal.
+    SwapTerminalDeployment swapTerminal;
+
+    // @notice set this to a non-zero value to re-use an existing projectID. Having it set to 0 will deploy a new
+    // fee_project.
+    uint256 FEE_PROJECT_ID;
+
+    uint32 PREMINT_CHAIN_ID = 1;
+    string NAME = "Croptop Publishing Network";
+    string SYMBOL = "CPN";
+    string PROJECT_URI = "ipfs://QmUAFevoMn1iqSEQR8LogQYRxm39TNxQTPYnuLuq5BmfEi";
+    uint32 NATIVE_CURRENCY = uint32(uint160(JBConstants.NATIVE_TOKEN));
+    uint32 ETH_CURRENCY = JBCurrencyIds.ETH;
+    uint8 DECIMALS = 18;
+    uint256 DECIMAL_MULTIPLIER = 10 ** DECIMALS;
+    bytes32 SUCKER_SALT = "_CPN_SUCKERV6__";
+    bytes32 ERC20_SALT = "_CPN_ERC20_SALTV6__";
+    bytes32 HOOK_SALT = "_CPN_HOOK_SALTV6__";
+    address OPERATOR;
+    address TRUSTED_FORWARDER;
+    uint48 CPN_START_TIME = 1_740_089_444;
+    uint104 CPN_MAINNET_AUTO_ISSUANCE_ = 250_003_875_000_000_000_000_000;
+    uint104 CPN_BASE_AUTO_ISSUANCE_ = 844_894_881_600_000_000_000;
+    uint104 CPN_ARB_AUTO_ISSUANCE_ = 3_844_000_000_000_000_000;
+
+    function configureSphinx() public override {
+        // TODO: Update to contain croptop devs.
+        sphinxConfig.projectName = "croptop-core-v5";
+        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-v5/deployments/"))
+        );
+        // Get the deployment addresses for the croptop contracts for this chain.
+        croptop = CroptopDeploymentLib.getDeployment(vm.envOr("CROPTOP_DEPLOYMENT_PATH", string("deployments/")));
+        // Get the deployment addresses for the 721 hook contracts for this chain.
+        hook = Hook721DeploymentLib.getDeployment(
+            vm.envOr("NANA_721_DEPLOYMENT_PATH", string("node_modules/@bananapus/721-hook-v5/deployments/"))
+        );
+        // Get the deployment addresses for the 721 hook contracts for this chain.
+        revnet = RevnetCoreDeploymentLib.getDeployment(
+            vm.envOr("REVNET_CORE_DEPLOYMENT_PATH", string("node_modules/@rev-net/core-v5/deployments/"))
+        );
+        // Get the deployment addresses for the suckers contracts for this chain.
+        suckers = SuckerDeploymentLib.getDeployment(
+            vm.envOr("NANA_SUCKERS_DEPLOYMENT_PATH", string("node_modules/@bananapus/suckers-v5/deployments/"))
+        );
+        // Get the deployment addresses for the 721 hook contracts for this chain.
+        swapTerminal = SwapTerminalDeploymentLib.getDeployment(
+            vm.envOr(
+                "NANA_SWAP_TERMINAL_DEPLOYMENT_PATH", string("node_modules/@bananapus/swap-terminal-v5/deployments/")
+            )
+        );
+
+        // We do a quick sanity check to make sure revnet and croptop use the same juicebox core contracts.
+        require(revnet.basic_deployer.DIRECTORY() == croptop.publisher.DIRECTORY());
+
+        // Set the operator address to be the multisig.
+        OPERATOR = safeAddress();
+        TRUSTED_FORWARDER = core.controller.trustedForwarder();
+
+        // Get the fee project id from the croptop deployment.
+        FEE_PROJECT_ID = croptop.publisher.FEE_PROJECT_ID();
+
+        // Check if there should be a new fee project created.
+        // Perform the deployment transactions.
+        deploy();
+    }
+
+    function getCroptopRevnetConfig() internal view returns (FeeProjectConfig memory) {
+        // The tokens that the project accepts and stores.
+        JBAccountingContext[] memory accountingContextsToAccept = new JBAccountingContext[](1);
+
+        // Accept the chain's native currency through the multi terminal.
+        accountingContextsToAccept[0] =
+            JBAccountingContext({token: JBConstants.NATIVE_TOKEN, decimals: DECIMALS, currency: NATIVE_CURRENCY});
+
+        // The terminals that the project will accept funds through.
+        JBTerminalConfig[] memory terminalConfigurations = new JBTerminalConfig[](2);
+        terminalConfigurations[0] =
+            JBTerminalConfig({terminal: core.terminal, accountingContextsToAccept: accountingContextsToAccept});
+        terminalConfigurations[1] = JBTerminalConfig({
+            terminal: IJBTerminal(address(swapTerminal.registry)),
+            accountingContextsToAccept: new JBAccountingContext[](0)
+        });
+
+        REVAutoIssuance[] memory issuanceConfs = new REVAutoIssuance[](3);
+        issuanceConfs[0] = REVAutoIssuance({chainId: 1, count: CPN_MAINNET_AUTO_ISSUANCE_, beneficiary: OPERATOR});
+        issuanceConfs[1] = REVAutoIssuance({chainId: 8453, count: CPN_BASE_AUTO_ISSUANCE_, beneficiary: OPERATOR});
+        issuanceConfs[2] = REVAutoIssuance({chainId: 42_161, count: CPN_ARB_AUTO_ISSUANCE_, beneficiary: OPERATOR});
+
+        JBSplit[] memory splits = new JBSplit[](1);
+        splits[0] = JBSplit({
+            percent: JBConstants.SPLITS_TOTAL_PERCENT,
+            projectId: 0,
+            beneficiary: payable(OPERATOR),
+            preferAddToBalance: false,
+            lockedUntil: 0,
+            hook: IJBSplitHook(address(0))
+        });
+
+        // The project's revnet stage configurations.
+        REVStageConfig[] memory stageConfigurations = new REVStageConfig[](3);
+        stageConfigurations[0] = REVStageConfig({
+            startsAtOrAfter: CPN_START_TIME,
+            autoIssuances: issuanceConfs,
+            splitPercent: 3800, // 38%
+            splits: splits,
+            initialIssuance: uint112(10_000 * DECIMAL_MULTIPLIER),
+            issuanceCutFrequency: 120 days,
+            issuanceCutPercent: 380_000_000, // 38%
+            cashOutTaxRate: 1000, // 0.1
+            extraMetadata: 4 // Allow adding suckers.
+        });
+
+        stageConfigurations[1] = REVStageConfig({
+            startsAtOrAfter: uint40(stageConfigurations[0].startsAtOrAfter + 720 days),
+            autoIssuances: new REVAutoIssuance[](0),
+            splitPercent: 3800, // 38%
+            splits: splits,
+            initialIssuance: 1, // inherit from previous cycle.
+            issuanceCutFrequency: 30 days,
+            issuanceCutPercent: 70_000_000, // 7%
+            cashOutTaxRate: 1000, // 0.1
+            extraMetadata: 4 // Allow adding suckers.
+        });
+
+        stageConfigurations[2] = REVStageConfig({
+            startsAtOrAfter: uint40(stageConfigurations[1].startsAtOrAfter + 3800 days),
+            autoIssuances: new REVAutoIssuance[](0),
+            splitPercent: 3800, // 38%
+            splits: splits,
+            initialIssuance: 0, // no more issuance.
+            issuanceCutFrequency: 0,
+            issuanceCutPercent: 0,
+            cashOutTaxRate: 1000, // 0.1
+            extraMetadata: 4 // Allow adding suckers.
+        });
+
+        // The projects loan configuration.
+        REVLoanSource[] memory loanSources = new REVLoanSource[](1);
+        loanSources[0] = REVLoanSource({token: JBConstants.NATIVE_TOKEN, terminal: core.terminal});
+
+        // The project's revnet configuration
+        REVConfig memory revnetConfiguration = REVConfig({
+            description: REVDescription(NAME, SYMBOL, PROJECT_URI, ERC20_SALT),
+            baseCurrency: ETH_CURRENCY,
+            splitOperator: OPERATOR,
+            stageConfigurations: stageConfigurations,
+            loanSources: loanSources,
+            loans: address(revnet.loans)
+        });
+
+        REVBuybackHookConfig memory buybackHookConfiguration;
+        {
+            // The project's buyback hook configuration.
+            REVBuybackPoolConfig[] memory buybackPoolConfigurations = new REVBuybackPoolConfig[](1);
+            buybackPoolConfigurations[0] =
+                REVBuybackPoolConfig({token: JBConstants.NATIVE_TOKEN, fee: 10_000, twapWindow: 2 days});
+            buybackHookConfiguration = REVBuybackHookConfig({
+                dataHook: buybackHook.registry,
+                hookToConfigure: buybackHook.hook,
+                poolConfigurations: buybackPoolConfigurations
+            });
+        }
+
+        // Organize the instructions for how this project will connect to other chains.
+        JBTokenMapping[] memory tokenMappings = new JBTokenMapping[](1);
+        tokenMappings[0] = JBTokenMapping({
+            localToken: JBConstants.NATIVE_TOKEN,
+            remoteToken: JBConstants.NATIVE_TOKEN,
+            minGas: 200_000,
+            minBridgeAmount: 0.01 ether
+        });
+
+        REVSuckerDeploymentConfig memory suckerDeploymentConfiguration;
+
+        {
+            JBSuckerDeployerConfig[] memory suckerDeployerConfigurations;
+            if (block.chainid == 1 || block.chainid == 11_155_111) {
+                suckerDeployerConfigurations = new JBSuckerDeployerConfig[](3);
+                // OP
+                suckerDeployerConfigurations[0] =
+                    JBSuckerDeployerConfig({deployer: suckers.optimismDeployer, mappings: tokenMappings});
+
+                suckerDeployerConfigurations[1] =
+                    JBSuckerDeployerConfig({deployer: suckers.baseDeployer, mappings: tokenMappings});
+
+                suckerDeployerConfigurations[2] =
+                    JBSuckerDeployerConfig({deployer: suckers.arbitrumDeployer, mappings: tokenMappings});
+            } else {
+                suckerDeployerConfigurations = new JBSuckerDeployerConfig[](1);
+                // L2 -> Mainnet
+                suckerDeployerConfigurations[0] = JBSuckerDeployerConfig({
+                    deployer: address(suckers.optimismDeployer) != address(0)
+                        ? suckers.optimismDeployer
+                        : address(suckers.baseDeployer) != address(0) ? suckers.baseDeployer : suckers.arbitrumDeployer,
+                    mappings: tokenMappings
+                });
+
+                if (address(suckerDeployerConfigurations[0].deployer) == address(0)) {
+                    revert("L2 > L1 Sucker is not configured");
+                }
+            }
+            // Specify all sucker deployments.
+            suckerDeploymentConfiguration =
+                REVSuckerDeploymentConfig({deployerConfigurations: suckerDeployerConfigurations, salt: SUCKER_SALT});
+        }
+
+        // The project's allowed croptop posts.
+        REVCroptopAllowedPost[] memory allowedPosts = new REVCroptopAllowedPost[](5);
+        allowedPosts[0] = REVCroptopAllowedPost({
+            category: 0,
+            minimumPrice: uint104(10 ** (DECIMALS - 5)),
+            minimumTotalSupply: 10_000,
+            maximumTotalSupply: 999_999_999,
+            allowedAddresses: new address[](0)
+        });
+        allowedPosts[1] = REVCroptopAllowedPost({
+            category: 1,
+            minimumPrice: uint104(10 ** (DECIMALS - 3)),
+            minimumTotalSupply: 10_000,
+            maximumTotalSupply: 999_999_999,
+            allowedAddresses: new address[](0)
+        });
+        allowedPosts[2] = REVCroptopAllowedPost({
+            category: 2,
+            minimumPrice: uint104(10 ** (DECIMALS - 1)),
+            minimumTotalSupply: 100,
+            maximumTotalSupply: 999_999_999,
+            allowedAddresses: new address[](0)
+        });
+        allowedPosts[3] = REVCroptopAllowedPost({
+            category: 3,
+            minimumPrice: uint104(10 ** DECIMALS),
+            minimumTotalSupply: 10,
+            maximumTotalSupply: 999_999_999,
+            allowedAddresses: new address[](0)
+        });
+        allowedPosts[4] = REVCroptopAllowedPost({
+            category: 4,
+            minimumPrice: uint104(10 ** (DECIMALS + 2)),
+            minimumTotalSupply: 10,
+            maximumTotalSupply: 999_999_999,
+            allowedAddresses: new address[](0)
+        });
+
+        return FeeProjectConfig({
+            configuration: revnetConfiguration,
+            terminalConfigurations: terminalConfigurations,
+            buybackHookConfiguration: buybackHookConfiguration,
+            suckerDeploymentConfiguration: suckerDeploymentConfiguration,
+            hookConfiguration: REVDeploy721TiersHookConfig({
+                baseline721HookConfiguration: JBDeploy721TiersHookConfig({
+                    name: NAME,
+                    symbol: SYMBOL,
+                    baseUri: "ipfs://",
+                    tokenUriResolver: IJB721TokenUriResolver(address(0)),
+                    contractUri: "",
+                    tiersConfig: JB721InitTiersConfig({
+                        tiers: new JB721TierConfig[](0), currency: ETH_CURRENCY, decimals: DECIMALS, prices: core.prices
+                    }),
+                    reserveBeneficiary: address(0),
+                    flags: JB721TiersHookFlags({
+                        noNewTiersWithReserves: false,
+                        noNewTiersWithVotes: true,
+                        noNewTiersWithOwnerMinting: true,
+                        preventOverspending: false
+                    })
+                }),
+                salt: HOOK_SALT,
+                splitOperatorCanAdjustTiers: true,
+                splitOperatorCanUpdateMetadata: false,
+                splitOperatorCanMint: false,
+                splitOperatorCanIncreaseDiscountPercent: false
+            }),
+            allowedPosts: allowedPosts
+        });
+    }
+
+    function deploy() public sphinx {
+        FeeProjectConfig memory feeProjectConfig = getCroptopRevnetConfig();
+
+        // Approve the basic deployer to configure the project and transfer it.
+        core.projects.approve(address(revnet.basic_deployer), FEE_PROJECT_ID);
+
+        // Deploy the NANA fee project.
+        revnet.basic_deployer
+            .deployWith721sFor({
+                revnetId: FEE_PROJECT_ID,
+                configuration: feeProjectConfig.configuration,
+                terminalConfigurations: feeProjectConfig.terminalConfigurations,
+                buybackHookConfiguration: feeProjectConfig.buybackHookConfiguration,
+                suckerDeploymentConfiguration: feeProjectConfig.suckerDeploymentConfiguration,
+                tiered721HookConfiguration: feeProjectConfig.hookConfiguration,
+                allowedPosts: feeProjectConfig.allowedPosts
+            });
+    }
+
+    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/Deploy.s.sol

@@ -0,0 +1,138 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.23;
+
+import "@bananapus/721-hook-v5/script/helpers/Hook721DeploymentLib.sol";
+import "@bananapus/core-v5/script/helpers/CoreDeploymentLib.sol";
+import "@bananapus/suckers-v5/script/helpers/SuckerDeploymentLib.sol";
+
+import {Sphinx} from "@sphinx-labs/contracts/SphinxPlugin.sol";
+import {Script} from "forge-std/Script.sol";
+
+import {CTDeployer} from "./../src/CTDeployer.sol";
+import {CTProjectOwner} from "./../src/CTProjectOwner.sol";
+import {CTPublisher} from "./../src/CTPublisher.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 721 hook contracts for the chain we are deploying to.
+    Hook721Deployment hook;
+    /// @notice tracks the deployment of the sucker contracts for the chain we are deploying to.
+    SuckerDeployment suckers;
+
+    // @notice set this to a non-zero value to re-use an existing projectID. Having it set to 0 will deploy a new
+    // fee_project.
+    uint256 FEE_PROJECT_ID = 0;
+
+    /// @notice the salts that are used to deploy the contracts.
+    bytes32 PUBLISHER_SALT = "_PUBLISHER_SALTV6_";
+    bytes32 DEPLOYER_SALT = "_DEPLOYER_SALTV6_";
+    bytes32 PROJECT_OWNER_SALT = "_PROJECT_OWNER_SALTV6_";
+    address TRUSTED_FORWARDER;
+
+    function configureSphinx() public override {
+        sphinxConfig.projectName = "croptop-core-v5";
+        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-v5/deployments/"))
+        );
+        // Get the deployment addresses for the 721 hook contracts for this chain.
+        hook = Hook721DeploymentLib.getDeployment(
+            vm.envOr("NANA_721_DEPLOYMENT_PATH", string("node_modules/@bananapus/721-hook-v5/deployments/"))
+        );
+        // Get the deployment addresses for the suckers contracts for this chain.
+        suckers = SuckerDeploymentLib.getDeployment(
+            vm.envOr("NANA_SUCKERS_DEPLOYMENT_PATH", string("node_modules/@bananapus/suckers-v5/deployments/"))
+        );
+
+        // We use the same trusted forwarder as the core deployment.
+        TRUSTED_FORWARDER = core.controller.trustedForwarder();
+
+        // Perform the deployment transactions.
+        deploy();
+    }
+
+    function deploy() public sphinx {
+        // If the fee project id is 0, then we want to deploy a new fee project.
+        if (FEE_PROJECT_ID == 0) {
+            FEE_PROJECT_ID = core.projects.createFor(safeAddress());
+        }
+
+        CTPublisher publisher;
+        {
+            // Perform the check for the publisher.
+            (address _publisher, bool _publisherIsDeployed) = _isDeployed(
+                PUBLISHER_SALT,
+                type(CTPublisher).creationCode,
+                abi.encode(core.directory, core.permissions, FEE_PROJECT_ID, TRUSTED_FORWARDER)
+            );
+
+            // Deploy it if it has not been deployed yet.
+            publisher = !_publisherIsDeployed
+                ? new CTPublisher{salt: PUBLISHER_SALT}(
+                    core.directory, core.permissions, FEE_PROJECT_ID, TRUSTED_FORWARDER
+                )
+                : CTPublisher(_publisher);
+        }
+
+        CTDeployer deployer;
+        {
+            // Perform the check for the publisher.
+            (address _deployer, bool _deployerIsDeployed) = _isDeployed(
+                DEPLOYER_SALT,
+                type(CTDeployer).creationCode,
+                abi.encode(
+                    core.permissions, core.projects, hook.hook_deployer, publisher, suckers.registry, TRUSTED_FORWARDER
+                )
+            );
+
+            // Deploy it if it has not been deployed yet.
+            deployer = !_deployerIsDeployed
+                ? new CTDeployer{salt: DEPLOYER_SALT}(
+                    core.permissions, core.projects, hook.hook_deployer, publisher, suckers.registry, TRUSTED_FORWARDER
+                )
+                : CTDeployer(_deployer);
+        }
+
+        CTProjectOwner owner;
+        {
+            // Perform the check for the publisher.
+            (address _owner, bool _ownerIsDeployed) = _isDeployed(
+                PROJECT_OWNER_SALT,
+                type(CTProjectOwner).creationCode,
+                abi.encode(core.permissions, core.projects, publisher)
+            );
+
+            // Deploy it if it has not been deployed yet.
+            owner = !_ownerIsDeployed
+                ? new CTProjectOwner{salt: PROJECT_OWNER_SALT}(core.permissions, core.projects, publisher)
+                : CTProjectOwner(_owner);
+        }
+    }
+
+    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/CroptopDeploymentLib.sol

@@ -0,0 +1,75 @@
+// 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 {CTPublisher} from "../../src/CTPublisher.sol";
+import {CTDeployer} from "../../src/CTDeployer.sol";
+import {CTProjectOwner} from "../../src/CTProjectOwner.sol";
+
+struct CroptopDeployment {
+    CTPublisher publisher;
+    CTDeployer deployer;
+    CTProjectOwner project_owner;
+}
+
+library CroptopDeploymentLib {
+    // 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 (CroptopDeployment 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 (CroptopDeployment memory deployment)
+    {
+        deployment.publisher = CTPublisher(_getDeploymentAddress(path, "croptop-core-v5", network_name, "CTPublisher"));
+        deployment.deployer = CTDeployer(_getDeploymentAddress(path, "croptop-core-v5", network_name, "CTDeployer"));
+        deployment.project_owner =
+            CTProjectOwner(_getDeploymentAddress(path, "croptop-core-v5", network_name, "CTProjectOwner"));
+    }
+
+    /// @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
+}