@croptop/core-v6 0.0.48 → 0.0.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croptop/core-v6",
-  "version": "0.0.48",
+  "version": "0.0.49",
   "license": "MIT",
   "repository": {
     "type": "git",

package/script/ConfigureFeeProject.s.sol

@@ -61,50 +61,29 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
     /// @notice tracks the deployment of the router terminal.
     RouterTerminalDeployment routerTerminal;
 
-    // @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.
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint256 FEE_PROJECT_ID;
-
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint32 PREMINT_CHAIN_ID = 1;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    string NAME = "Croptop Publishing Network";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    string SYMBOL = "CPN";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    string PROJECT_URI = "ipfs://QmUAFevoMn1iqSEQR8LogQYRxm39TNxQTPYnuLuq5BmfEi";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint32 NATIVE_CURRENCY = uint32(uint160(JBConstants.NATIVE_TOKEN));
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint32 ETH_CURRENCY = JBCurrencyIds.ETH;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint8 DECIMALS = 18;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint256 DECIMAL_MULTIPLIER = 10 ** DECIMALS;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 SUCKER_SALT = "_CPN_SUCKERV6__";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 ERC20_SALT = "_CPN_ERC20_SALTV6__";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 HOOK_SALT = "_CPN_HOOK_SALTV6__";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    address OPERATOR;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    address TRUSTED_FORWARDER;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint48 CPN_START_TIME = 1_740_089_444;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint104 CPN_MAINNET_AUTO_ISSUANCE_ = 250_003_875_000_000_000_000_000;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint104 CPN_OP_AUTO_ISSUANCE_ = 844_894_881_600_000_000_000;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint104 CPN_BASE_AUTO_ISSUANCE_ = 844_894_881_600_000_000_000;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint104 CPN_ARB_AUTO_ISSUANCE_ = 3_844_000_000_000_000_000;
+    /// @notice The fee project ID configured by the Croptop publisher.
+    uint256 private feeProjectId;
+    uint32 private constant _PREMINT_CHAIN_ID = 1;
+    string private constant _NAME = "Croptop Publishing Network";
+    string private constant _SYMBOL = "CPN";
+    string private constant _PROJECT_URI = "ipfs://QmUAFevoMn1iqSEQR8LogQYRxm39TNxQTPYnuLuq5BmfEi";
+    uint32 private constant _NATIVE_CURRENCY = uint32(uint160(JBConstants.NATIVE_TOKEN));
+    uint32 private constant _ETH_CURRENCY = JBCurrencyIds.ETH;
+    uint8 private constant _DECIMALS = 18;
+    uint256 private constant _DECIMAL_MULTIPLIER = 10 ** _DECIMALS;
+    bytes32 private constant _SUCKER_SALT = "_CPN_SUCKERV6__";
+    bytes32 private constant _ERC20_SALT = "_CPN_ERC20_SALTV6__";
+    bytes32 private constant _HOOK_SALT = "_CPN_HOOK_SALTV6__";
+    address private operator;
+    address private trustedForwarder;
+    uint48 private constant _CPN_START_TIME = 1_740_089_444;
+    uint104 private constant _CPN_MAINNET_AUTO_ISSUANCE = 250_003_875_000_000_000_000_000;
+    uint104 private constant _CPN_OP_AUTO_ISSUANCE = 844_894_881_600_000_000_000;
+    uint104 private constant _CPN_BASE_AUTO_ISSUANCE = 844_894_881_600_000_000_000;
+    uint104 private constant _CPN_ARB_AUTO_ISSUANCE = 3_844_000_000_000_000_000;
 
     function configureSphinx() public override {
-        // TODO: Update to contain croptop devs.
+        // Safe owners and threshold are resolved by the Sphinx project config.
         sphinxConfig.projectName = "croptop-core-v6";
         sphinxConfig.mainnets = ["ethereum", "optimism", "base", "arbitrum"];
         sphinxConfig.testnets = ["ethereum_sepolia", "optimism_sepolia", "base_sepolia", "arbitrum_sepolia"];
@@ -142,11 +121,11 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         require(revnet.basic_deployer.DIRECTORY() == croptop.publisher.DIRECTORY());
 
         // Set the operator address to be the multisig.
-        OPERATOR = safeAddress();
-        TRUSTED_FORWARDER = core.controller.trustedForwarder();
+        operator = safeAddress();
+        trustedForwarder = core.controller.trustedForwarder();
 
         // Get the fee project id from the croptop deployment.
-        FEE_PROJECT_ID = croptop.publisher.FEE_PROJECT_ID();
+        feeProjectId = croptop.publisher.FEE_PROJECT_ID();
 
         // Check if there should be a new fee project created.
         // Perform the deployment transactions.
@@ -159,7 +138,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
 
         // Accept the chain's native currency through the multi terminal.
         accountingContextsToAccept[0] =
-            JBAccountingContext({token: JBConstants.NATIVE_TOKEN, decimals: DECIMALS, currency: NATIVE_CURRENCY});
+            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);
@@ -171,16 +150,16 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         });
 
         REVAutoIssuance[] memory issuanceConfs = new REVAutoIssuance[](4);
-        issuanceConfs[0] = REVAutoIssuance({chainId: 1, count: CPN_MAINNET_AUTO_ISSUANCE_, beneficiary: OPERATOR});
-        issuanceConfs[1] = REVAutoIssuance({chainId: 10, count: CPN_OP_AUTO_ISSUANCE_, beneficiary: OPERATOR});
-        issuanceConfs[2] = REVAutoIssuance({chainId: 8453, count: CPN_BASE_AUTO_ISSUANCE_, beneficiary: OPERATOR});
-        issuanceConfs[3] = REVAutoIssuance({chainId: 42_161, count: CPN_ARB_AUTO_ISSUANCE_, beneficiary: OPERATOR});
+        issuanceConfs[0] = REVAutoIssuance({chainId: 1, count: _CPN_MAINNET_AUTO_ISSUANCE, beneficiary: operator});
+        issuanceConfs[1] = REVAutoIssuance({chainId: 10, count: _CPN_OP_AUTO_ISSUANCE, beneficiary: operator});
+        issuanceConfs[2] = REVAutoIssuance({chainId: 8453, count: _CPN_BASE_AUTO_ISSUANCE, beneficiary: operator});
+        issuanceConfs[3] = 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),
+            beneficiary: payable(operator),
             preferAddToBalance: false,
             lockedUntil: 0,
             hook: IJBSplitHook(address(0))
@@ -189,12 +168,12 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         // The project's revnet stage configurations.
         REVStageConfig[] memory stageConfigurations = new REVStageConfig[](3);
         stageConfigurations[0] = REVStageConfig({
-            startsAtOrAfter: CPN_START_TIME,
+            startsAtOrAfter: _CPN_START_TIME,
             autoIssuances: issuanceConfs,
             splitPercent: 3800, // 38%
             splits: splits,
             // forge-lint: disable-next-line(unsafe-typecast)
-            initialIssuance: uint112(10_000 * DECIMAL_MULTIPLIER),
+            initialIssuance: uint112(10_000 * _DECIMAL_MULTIPLIER),
             issuanceCutFrequency: 120 days,
             issuanceCutPercent: 380_000_000, // 38%
             cashOutTaxRate: 1000, // 0.1
@@ -227,9 +206,9 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
 
         // The project's revnet configuration
         REVConfig memory revnetConfiguration = REVConfig({
-            description: REVDescription({name: NAME, ticker: SYMBOL, uri: PROJECT_URI, salt: ERC20_SALT}),
-            baseCurrency: ETH_CURRENCY,
-            operator: OPERATOR,
+            description: REVDescription({name: _NAME, ticker: _SYMBOL, uri: _PROJECT_URI, salt: _ERC20_SALT}),
+            baseCurrency: _ETH_CURRENCY,
+            operator: operator,
             scopeCashOutsToLocalBalances: false,
             stageConfigurations: stageConfigurations
         });
@@ -276,14 +255,14 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
             }
             // Specify all sucker deployments.
             suckerDeploymentConfiguration =
-                REVSuckerDeploymentConfig({deployerConfigurations: suckerDeployerConfigurations, salt: SUCKER_SALT});
+                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)),
+            minimumPrice: uint104(10 ** (_DECIMALS - 5)),
             minimumTotalSupply: 10_000,
             maximumTotalSupply: 999_999_999,
             maximumSplitPercent: 0,
@@ -291,7 +270,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         });
         allowedPosts[1] = REVCroptopAllowedPost({
             category: 1,
-            minimumPrice: uint104(10 ** (DECIMALS - 3)),
+            minimumPrice: uint104(10 ** (_DECIMALS - 3)),
             minimumTotalSupply: 10_000,
             maximumTotalSupply: 999_999_999,
             maximumSplitPercent: 0,
@@ -299,7 +278,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         });
         allowedPosts[2] = REVCroptopAllowedPost({
             category: 2,
-            minimumPrice: uint104(10 ** (DECIMALS - 1)),
+            minimumPrice: uint104(10 ** (_DECIMALS - 1)),
             minimumTotalSupply: 100,
             maximumTotalSupply: 999_999_999,
             maximumSplitPercent: 0,
@@ -307,7 +286,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         });
         allowedPosts[3] = REVCroptopAllowedPost({
             category: 3,
-            minimumPrice: uint104(10 ** DECIMALS),
+            minimumPrice: uint104(10 ** _DECIMALS),
             minimumTotalSupply: 10,
             maximumTotalSupply: 999_999_999,
             maximumSplitPercent: 0,
@@ -315,7 +294,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         });
         allowedPosts[4] = REVCroptopAllowedPost({
             category: 4,
-            minimumPrice: uint104(10 ** (DECIMALS + 2)),
+            minimumPrice: uint104(10 ** (_DECIMALS + 2)),
             minimumTotalSupply: 10,
             maximumTotalSupply: 999_999_999,
             maximumSplitPercent: 0,
@@ -328,13 +307,13 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
             suckerDeploymentConfiguration: suckerDeploymentConfiguration,
             hookConfiguration: REVDeploy721TiersHookConfig({
                 baseline721HookConfiguration: REVBaseline721HookConfig({
-                    name: NAME,
-                    symbol: SYMBOL,
+                    name: _NAME,
+                    symbol: _SYMBOL,
                     baseUri: "ipfs://",
                     tokenUriResolver: IJB721TokenUriResolver(address(0)),
                     contractUri: "",
                     tiersConfig: JB721InitTiersConfig({
-                        tiers: new JB721TierConfig[](0), currency: ETH_CURRENCY, decimals: DECIMALS
+                        tiers: new JB721TierConfig[](0), currency: _ETH_CURRENCY, decimals: _DECIMALS
                     }),
                     flags: REV721TiersHookFlags({
                         noNewTiersWithReserves: false,
@@ -343,7 +322,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
                         preventOverspending: false
                     })
                 }),
-                salt: HOOK_SALT,
+                salt: _HOOK_SALT,
                 preventOperatorAdjustingTiers: false,
                 preventOperatorUpdatingMetadata: false,
                 preventOperatorMinting: false,
@@ -357,14 +336,14 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
         FeeProjectConfig memory feeProjectConfig = getCroptopRevnetConfig();
 
         // Only deploy if the project hasn't already been configured (restart-safe).
-        if (address(core.directory.controllerOf(FEE_PROJECT_ID)) == address(0)) {
+        if (address(core.directory.controllerOf(feeProjectId)) == address(0)) {
             // Approve the basic deployer to configure the project and transfer it.
-            core.projects.approve({to: address(revnet.basic_deployer), tokenId: FEE_PROJECT_ID});
+            core.projects.approve({to: address(revnet.basic_deployer), tokenId: feeProjectId});
 
             // Deploy the NANA fee project.
             revnet.basic_deployer
                 .deployFor({
-                    revnetId: FEE_PROJECT_ID,
+                    revnetId: feeProjectId,
                     configuration: feeProjectConfig.configuration,
                     terminalConfigurations: feeProjectConfig.terminalConfigurations,
                     suckerDeploymentConfiguration: feeProjectConfig.suckerDeploymentConfiguration,

package/script/Deploy.s.sol

@@ -20,20 +20,14 @@ contract DeployScript is Script, Sphinx {
     /// @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.
-    // forge-lint: disable-next-line(mixed-case-variable)
-    uint256 FEE_PROJECT_ID = 0;
+    /// @notice Set this to a non-zero value to reuse an existing fee project. Leaving it as 0 deploys a new one.
+    uint256 private feeProjectId = 0;
 
     /// @notice the salts that are used to deploy the contracts.
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 PUBLISHER_SALT = "_PUBLISHER_SALTV6_";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 DEPLOYER_SALT = "_DEPLOYER_SALTV6_";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    bytes32 PROJECT_OWNER_SALT = "_PROJECT_OWNER_SALTV6_";
-    // forge-lint: disable-next-line(mixed-case-variable)
-    address TRUSTED_FORWARDER;
+    bytes32 private constant _PUBLISHER_SALT = "_PUBLISHER_SALTV6_";
+    bytes32 private constant _DEPLOYER_SALT = "_DEPLOYER_SALTV6_";
+    bytes32 private constant _PROJECT_OWNER_SALT = "_PROJECT_OWNER_SALTV6_";
+    address private trustedForwarder;
 
     function configureSphinx() public override {
         sphinxConfig.projectName = "croptop-core-v6";
@@ -57,7 +51,7 @@ contract DeployScript is Script, Sphinx {
         );
 
         // We use the same trusted forwarder as the core deployment.
-        TRUSTED_FORWARDER = core.controller.trustedForwarder();
+        trustedForwarder = core.controller.trustedForwarder();
 
         // Perform the deployment transactions.
         deploy();
@@ -67,24 +61,24 @@ contract DeployScript is Script, Sphinx {
         // Canonical Croptop deployments must bind fees to an explicit fee project. Autodiscovering the first
         // matching publisher by scanning project IDs is unsafe because a preexisting publisher can pin fees to
         // the wrong project forever.
-        require(FEE_PROJECT_ID != 0, "explicit fee project id required");
+        require(feeProjectId != 0, "explicit fee project id required");
 
         CTPublisher publisher;
         {
             // Perform the check for the publisher.
             (address _publisher, bool _publisherIsDeployed) = _isDeployed({
-                salt: PUBLISHER_SALT,
+                salt: _PUBLISHER_SALT,
                 creationCode: type(CTPublisher).creationCode,
-                arguments: abi.encode(core.directory, core.permissions, FEE_PROJECT_ID, TRUSTED_FORWARDER)
+                arguments: abi.encode(core.directory, core.permissions, feeProjectId, trustedForwarder)
             });
 
             // Deploy it if it has not been deployed yet.
             publisher = !_publisherIsDeployed
-                ? new CTPublisher{salt: PUBLISHER_SALT}({
+                ? new CTPublisher{salt: _PUBLISHER_SALT}({
                     directory: core.directory,
                     permissions: core.permissions,
-                    feeProjectId: FEE_PROJECT_ID,
-                    trustedForwarder: TRUSTED_FORWARDER
+                    feeProjectId: feeProjectId,
+                    trustedForwarder: trustedForwarder
                 })
                 : CTPublisher(_publisher);
         }
@@ -93,22 +87,22 @@ contract DeployScript is Script, Sphinx {
         {
             // Perform the check for the publisher.
             (address _deployer, bool _deployerIsDeployed) = _isDeployed({
-                salt: DEPLOYER_SALT,
+                salt: _DEPLOYER_SALT,
                 creationCode: type(CTDeployer).creationCode,
                 arguments: abi.encode(
-                    core.permissions, core.projects, hook.hook_deployer, publisher, suckers.registry, TRUSTED_FORWARDER
+                    core.permissions, core.projects, hook.hook_deployer, publisher, suckers.registry, trustedForwarder
                 )
             });
 
             // Deploy it if it has not been deployed yet.
             deployer = !_deployerIsDeployed
-                ? new CTDeployer{salt: DEPLOYER_SALT}({
+                ? new CTDeployer{salt: _DEPLOYER_SALT}({
                     permissions: core.permissions,
                     projects: core.projects,
                     deployer: hook.hook_deployer,
                     publisher: publisher,
                     suckerRegistry: suckers.registry,
-                    trustedForwarder: TRUSTED_FORWARDER
+                    trustedForwarder: trustedForwarder
                 })
                 : CTDeployer(_deployer);
         }
@@ -117,14 +111,14 @@ contract DeployScript is Script, Sphinx {
         {
             // Perform the check for the publisher.
             (address _owner, bool _ownerIsDeployed) = _isDeployed({
-                salt: PROJECT_OWNER_SALT,
+                salt: _PROJECT_OWNER_SALT,
                 creationCode: type(CTProjectOwner).creationCode,
                 arguments: abi.encode(core.permissions, core.projects, publisher)
             });
 
             // Deploy it if it has not been deployed yet.
             owner = !_ownerIsDeployed
-                ? new CTProjectOwner{salt: PROJECT_OWNER_SALT}({
+                ? new CTProjectOwner{salt: _PROJECT_OWNER_SALT}({
                     permissions: core.permissions, projects: core.projects, publisher: publisher
                 })
                 : CTProjectOwner(_owner);

package/script/helpers/CroptopDeploymentLib.sol

@@ -13,8 +13,7 @@ import {CTProjectOwner} from "../../src/CTProjectOwner.sol";
 struct CroptopDeployment {
     CTPublisher publisher;
     CTDeployer deployer;
-    // forge-lint: disable-next-line(mixed-case-variable)
-    CTProjectOwner project_owner;
+    CTProjectOwner projectOwner;
 }
 
 library CroptopDeploymentLib {
@@ -24,17 +23,16 @@ library CroptopDeploymentLib {
     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.
+        // Match the current chain ID to the Sphinx network name used in deployment artifacts.
         uint256 chainId = block.chainid;
 
-        // Deploy to get the constants.
-        // TODO: get constants without deploy.
+        // `SphinxConstants` exposes Sphinx's supported chain ID to network name mapping.
         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);
+                return getDeployment({path: path, networkName: networks[_i].name});
             }
         }
 
@@ -43,8 +41,7 @@ library CroptopDeploymentLib {
 
     function getDeployment(
         string memory path,
-        // forge-lint: disable-next-line(mixed-case-variable)
-        string memory network_name
+        string memory networkName
     )
         internal
         view
@@ -52,17 +49,17 @@ library CroptopDeploymentLib {
     {
         deployment.publisher = CTPublisher(
             _getDeploymentAddress({
-                path: path, project_name: "croptop-core-v6", network_name: network_name, contractName: "CTPublisher"
+                path: path, projectName: "croptop-core-v6", networkName: networkName, contractName: "CTPublisher"
             })
         );
         deployment.deployer = CTDeployer(
             _getDeploymentAddress({
-                path: path, project_name: "croptop-core-v6", network_name: network_name, contractName: "CTDeployer"
+                path: path, projectName: "croptop-core-v6", networkName: networkName, contractName: "CTDeployer"
             })
         );
-        deployment.project_owner = CTProjectOwner(
+        deployment.projectOwner = CTProjectOwner(
             _getDeploymentAddress({
-                path: path, project_name: "croptop-core-v6", network_name: network_name, contractName: "CTProjectOwner"
+                path: path, projectName: "croptop-core-v6", networkName: networkName, contractName: "CTProjectOwner"
             })
         );
     }
@@ -74,10 +71,8 @@ library CroptopDeploymentLib {
     /// @return The address of the contract.
     function _getDeploymentAddress(
         string memory path,
-        // forge-lint: disable-next-line(mixed-case-variable)
-        string memory project_name,
-        // forge-lint: disable-next-line(mixed-case-variable)
-        string memory network_name,
+        string memory projectName,
+        string memory networkName,
         string memory contractName
     )
         internal
@@ -86,7 +81,7 @@ library CroptopDeploymentLib {
     {
         string memory deploymentJson =
         // forge-lint: disable-next-line(unsafe-cheatcode)
-        vm.readFile(string.concat(path, project_name, "/", network_name, "/", contractName, ".json"));
+        vm.readFile(string.concat(path, projectName, "/", networkName, "/", contractName, ".json"));
         return stdJson.readAddress({json: deploymentJson, key: ".address"});
     }
 }

package/src/CTPublisher.sol

@@ -31,8 +31,8 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
-    error CTPublisher_DuplicatePost(bytes32 encodedIPFSUri);
-    error CTPublisher_EmptyEncodedIPFSUri(uint256 postIndex);
+    error CTPublisher_DuplicatePost(bytes32 encodedIpfsUri);
+    error CTPublisher_EmptyEncodedIpfsUri(uint256 postIndex);
     error CTPublisher_InsufficientEthSent(uint256 expected, uint256 sent);
     error CTPublisher_MaxTotalSupplyLessThanMin(uint256 min, uint256 max);
     error CTPublisher_NotInAllowList(address addr, address[] allowedAddresses);
@@ -71,8 +71,8 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
 
     /// @notice The ID of the tier that an IPFS metadata has been saved to.
     /// @custom:param hook The hook for which the tier ID applies.
-    /// @custom:param encodedIPFSUri The IPFS URI.
-    mapping(address hook => mapping(bytes32 encodedIPFSUri => uint256)) public override tierIdForEncodedIPFSUriOf;
+    /// @custom:param encodedIpfsUri The IPFS URI.
+    mapping(address hook => mapping(bytes32 encodedIpfsUri => uint256)) public override tierIdForEncodedIpfsUriOf;
 
     //*********************************************************************//
     // --------------------- internal stored properties ------------------ //
@@ -337,27 +337,27 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     /// In that case, the store's tierOf call will return a tier with default/empty values. Callers should check
     /// the returned tier's initialSupply or other fields to confirm the tier still exists.
     /// @param hook The hook from which to get tiers.
-    /// @param encodedIPFSUris The URIs to get tiers of.
+    /// @param encodedIpfsUris The URIs to get tiers of.
     /// @return tiers The tiers that correspond to the provided encoded IPFS URIs. If there's no tier yet, an empty tier
     /// is returned.
     function tiersFor(
         address hook,
-        bytes32[] memory encodedIPFSUris
+        bytes32[] memory encodedIpfsUris
     )
         external
         view
         override
         returns (JB721Tier[] memory tiers)
     {
-        uint256 numberOfEncodedIPFSUris = encodedIPFSUris.length;
+        uint256 numberOfEncodedIpfsUris = encodedIpfsUris.length;
 
         // Initialize the tier array being returned.
-        tiers = new JB721Tier[](numberOfEncodedIPFSUris);
+        tiers = new JB721Tier[](numberOfEncodedIpfsUris);
 
         // Get the tier for each provided encoded IPFS URI.
-        for (uint256 i; i < numberOfEncodedIPFSUris;) {
+        for (uint256 i; i < numberOfEncodedIpfsUris;) {
             // Check if there's a tier ID stored for the encoded IPFS URI.
-            uint256 tierId = tierIdForEncodedIPFSUriOf[hook][encodedIPFSUris[i]];
+            uint256 tierId = tierIdForEncodedIpfsUriOf[hook][encodedIpfsUris[i]];
 
             // If there's a tier ID stored, resolve it.
             if (tierId != 0) {
@@ -457,16 +457,16 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
             // Get the current post being iterated on.
             CTPost memory post = posts[i];
 
-            // Make sure the post includes an encodedIPFSUri.
+            // Make sure the post includes an encodedIpfsUri.
             // forge-lint: disable-next-line(unsafe-typecast)
-            if (post.encodedIPFSUri == bytes32("")) {
-                revert CTPublisher_EmptyEncodedIPFSUri({postIndex: i});
+            if (post.encodedIpfsUri == bytes32("")) {
+                revert CTPublisher_EmptyEncodedIpfsUri({postIndex: i});
             }
 
-            // Check for duplicate encodedIPFSUri within the same batch to prevent fee evasion.
+            // Check for duplicate encodedIpfsUri within the same batch to prevent fee evasion.
             for (uint256 j; j < i;) {
-                if (posts[j].encodedIPFSUri == post.encodedIPFSUri) {
-                    revert CTPublisher_DuplicatePost({encodedIPFSUri: post.encodedIPFSUri});
+                if (posts[j].encodedIpfsUri == post.encodedIpfsUri) {
+                    revert CTPublisher_DuplicatePost({encodedIpfsUri: post.encodedIpfsUri});
                 }
                 unchecked {
                     ++j;
@@ -475,8 +475,8 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
 
             // Scoped section to prevent stack too deep.
             {
-                // Check if there's an ID of a tier already minted for this encodedIPFSUri.
-                uint256 tierId = tierIdForEncodedIPFSUriOf[address(hook)][post.encodedIPFSUri];
+                // Check if there's an ID of a tier already minted for this encodedIpfsUri.
+                uint256 tierId = tierIdForEncodedIpfsUriOf[address(hook)][post.encodedIpfsUri];
 
                 if (tierId != 0) {
                     // Validate the cached tier still exists and its URI still matches.
@@ -485,9 +485,11 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
                     // mapping and fall through to create a new tier.
                     JB721Tier memory cachedTier =
                         store.tierOf({hook: address(hook), id: tierId, includeResolvedUri: false});
-                    if (store.isTierRemoved(address(hook), tierId) || cachedTier.encodedIPFSUri != post.encodedIPFSUri)
-                    {
-                        delete tierIdForEncodedIPFSUriOf[address(hook)][post.encodedIPFSUri];
+                    if (
+                        store.isTierRemoved({hook: address(hook), tierId: tierId})
+                            || cachedTier.encodedIPFSUri != post.encodedIpfsUri
+                    ) {
+                        delete tierIdForEncodedIpfsUriOf[address(hook)][post.encodedIpfsUri];
                     } else {
                         tierIdsToMint[i] = tierId;
 
@@ -557,7 +559,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
                     votingUnits: 0,
                     reserveFrequency: 0,
                     reserveBeneficiary: address(0),
-                    encodedIPFSUri: post.encodedIPFSUri,
+                    encodedIPFSUri: post.encodedIpfsUri,
                     category: post.category,
                     discountPercent: 0,
                     flags: JB721TierConfigFlags({
@@ -576,8 +578,8 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
                 // Set the ID of the tier to mint.
                 tierIdsToMint[i] = startingTierId + numberOfTiersBeingAdded++;
 
-                // Save the encodedIPFSUri as minted.
-                tierIdForEncodedIPFSUriOf[address(hook)][post.encodedIPFSUri] = tierIdsToMint[i];
+                // Save the encodedIpfsUri as minted.
+                tierIdForEncodedIpfsUriOf[address(hook)][post.encodedIpfsUri] = tierIdsToMint[i];
 
                 // For new tiers, use the post's price for totalPrice accumulation.
                 totalPrice += post.price;

package/src/interfaces/ICTPublisher.sol

@@ -71,17 +71,17 @@ interface ICTPublisher {
 
     /// @notice The tier ID that an IPFS metadata URI has been saved to for a given hook.
     /// @param hook The hook for which the tier ID applies.
-    /// @param encodedIPFSUri The encoded IPFS URI to look up.
+    /// @param encodedIpfsUri The encoded IPFS URI to look up.
     /// @return The tier ID, or 0 if the URI has not been published.
     // forge-lint: disable-next-line(mixed-case-function)
-    function tierIdForEncodedIPFSUriOf(address hook, bytes32 encodedIPFSUri) external view returns (uint256);
+    function tierIdForEncodedIpfsUriOf(address hook, bytes32 encodedIpfsUri) external view returns (uint256);
 
     /// @notice Get the tiers for the provided encoded IPFS URIs.
     /// @param hook The hook from which to get tiers.
-    /// @param encodedIPFSUris The URIs to get tiers of.
+    /// @param encodedIpfsUris The URIs to get tiers of.
     /// @return tiers The tiers that correspond to the provided encoded IPFS URIs. Empty tiers are returned for URIs
     /// without a tier.
-    function tiersFor(address hook, bytes32[] memory encodedIPFSUris) external view returns (JB721Tier[] memory tiers);
+    function tiersFor(address hook, bytes32[] memory encodedIpfsUris) external view returns (JB721Tier[] memory tiers);
 
     /// @notice Configure the allowed criteria for publishing new NFTs to a hook.
     /// @param allowedPosts An array of criteria for allowed posts.

package/src/structs/CTPost.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 import {JBSplit} from "@bananapus/core-v6/src/structs/JBSplit.sol";
 
 /// @notice A post to be published.
-/// @custom:member encodedIPFSUri The encoded IPFS URI of the post to publish.
+/// @custom:member encodedIpfsUri The encoded IPFS URI of the post to publish.
 /// @custom:member totalSupply The number of NFTs that should be made available, including the 1 that will be minted
 /// alongside this transaction.
 /// @custom:member price The price to pay for buying the post.
@@ -13,7 +13,7 @@ import {JBSplit} from "@bananapus/core-v6/src/structs/JBSplit.sol";
 /// JBConstants.SPLITS_TOTAL_PERCENT).
 /// @custom:member splits The splits to route funds to when this tier is minted.
 struct CTPost {
-    bytes32 encodedIPFSUri;
+    bytes32 encodedIpfsUri;
     uint32 totalSupply;
     uint104 price;
     uint24 category;