@croptop/core-v6 0.0.58 → 0.0.60

package/README.md

@@ -61,7 +61,7 @@ Many Croptop bugs are really deployment-shape bugs or posting-policy bugs, not g
 - Croptop publishing policy is separate from ordinary 721 tier issuance
 - fee routing is part of the publish path and its fallback behavior matters
 - `CTProjectOwner` intentionally changes the ownership model and should be reviewed as part of the trust model
-- duplicate-content, stale-tier, and fee-evasion edge cases are runtime behavior, not just UI concerns
+- duplicate-content, stale-tier, and fee-evasion edge cases are runtime behavior, not only UI concerns
 
 ## Where State Lives
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@croptop/core-v6",
-  "version": "0.0.58",
+  "version": "0.0.60",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mejango/croptop-core-v6"
+    "url": "git+https://github.com/mejango/croptop-core-v6.git"
   },
   "files": [
     "foundry.toml",
@@ -26,17 +26,17 @@
     "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'croptop-core-v6'"
   },
   "dependencies": {
-    "@bananapus/721-hook-v6": "^0.0.55",
-    "@bananapus/core-v6": "^0.0.64",
-    "@bananapus/ownable-v6": "^0.0.28",
+    "@bananapus/721-hook-v6": "^0.0.59",
+    "@bananapus/core-v6": "^0.0.72",
+    "@bananapus/ownable-v6": "^0.0.32",
     "@bananapus/permission-ids-v6": "^0.0.27",
-    "@bananapus/router-terminal-v6": "^0.0.49",
-    "@bananapus/suckers-v6": "^0.0.52",
+    "@bananapus/router-terminal-v6": "^0.0.55",
+    "@bananapus/suckers-v6": "^0.0.60",
     "@openzeppelin/contracts": "5.6.1",
-    "@rev-net/core-v6": "^0.0.67"
+    "@rev-net/core-v6": "^0.0.75"
   },
   "devDependencies": {
-    "@bananapus/address-registry-v6": "^0.0.26",
+    "@bananapus/address-registry-v6": "^0.0.29",
     "@sphinx-labs/plugins": "0.33.3"
   }
 }

package/references/runtime.md

@@ -17,7 +17,7 @@
 
 - Posting criteria: category rules are the policy surface that protects the project from bad content or bad economics.
 - Fee routing: fee-project assumptions and fee exemptions are operationally important.
-- Tier reuse and duplicate content: content identity is part of runtime behavior, not just metadata.
+- Tier reuse and duplicate content: content identity is part of runtime behavior, not only metadata.
 - Burn-lock ownership: once ownership moves into the lock helper, reversibility expectations change drastically.
 
 ## Tests To Trust First

package/script/ConfigureFeeProject.s.sol

@@ -116,17 +116,17 @@ library RevnetCoreDeploymentLib {
 }
 
 contract ConfigureFeeProjectScript is Script, Sphinx {
-    /// @notice tracks the deployment of the core contracts for the chain we are deploying to.
+    /// @notice Tracks the core deployment for the current chain.
     CoreDeployment core;
-    /// @notice tracks the latest croptop deployment.
+    /// @notice Tracks the latest Croptop deployment.
     CroptopDeployment croptop;
-    /// @notice tracks the deployment of the 721 hook contracts for the chain we are deploying to.
+    /// @notice Tracks the 721 hook deployment for the current chain.
     Hook721Deployment hook;
-    /// @notice tracks the deployment of the revnet contracts for the chain we are deploying to.
+    /// @notice Tracks the Revnet deployment for the current chain.
     RevnetCoreDeployment revnet;
-    /// @notice tracks the deployment of the sucker contracts for the chain we are deploying to.
+    /// @notice Tracks the sucker deployment for the current chain.
     SuckerDeployment suckers;
-    /// @notice tracks the deployment of the router terminal.
+    /// @notice Tracks the router terminal deployment for the current chain.
     RouterTerminalDeployment routerTerminal;
 
     /// @notice The fee project ID configured by the Croptop publisher.
@@ -158,18 +158,18 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
     }
 
     function run() public {
-        // Get the deployment addresses for the nana CORE for this chain.
+        // Get the core deployment addresses 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/"))
         );
-        // Get the deployment addresses for the croptop contracts for this chain.
+        // Get the Croptop deployment addresses 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-v6/deployments/"))
         );
-        // Get the deployment addresses for the revnet contracts for this chain.
+        // Get the Revnet deployment addresses for this chain.
         revnet = RevnetCoreDeploymentLib.getDeployment(
             vm.envOr("REVNET_CORE_DEPLOYMENT_PATH", string("node_modules/@rev-net/core-v6/deployments/"))
         );
@@ -185,18 +185,17 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
             )
         );
 
-        // We do a quick sanity check to make sure revnet and croptop use the same juicebox core contracts.
+        // Make sure Revnet and Croptop use the same Juicebox directory.
         require(revnet.basicDeployer.DIRECTORY() == croptop.publisher.DIRECTORY());
 
         // Set the operator address to be the multisig.
         operator = safeAddress();
         trustedForwarder = core.controller.trustedForwarder();
 
-        // Get the fee project id from the croptop deployment.
+        // Get the fee project ID from the Croptop deployment.
         feeProjectId = croptop.publisher.FEE_PROJECT_ID();
 
-        // Check if there should be a new fee project created.
-        // Perform the deployment transactions.
+        // Perform the fee-project deployment if the project is not already configured.
         deploy();
     }
 
@@ -326,7 +325,7 @@ contract ConfigureFeeProjectScript is Script, Sphinx {
                 REVSuckerDeploymentConfig({deployerConfigurations: suckerDeployerConfigurations, salt: _SUCKER_SALT});
         }
 
-        // The project's allowed croptop posts.
+        // The project's allowed Croptop posts.
         REVCroptopAllowedPost[] memory allowedPosts = new REVCroptopAllowedPost[](5);
         allowedPosts[0] = REVCroptopAllowedPost({
             category: 0,

package/script/Deploy.s.sol

@@ -13,17 +13,17 @@ import {CTPublisher} from "./../src/CTPublisher.sol";
 import {CoreDeployment, CoreDeploymentLib} from "./helpers/CoreDeploymentLib.sol";
 
 contract DeployScript is Script, Sphinx {
-    /// @notice tracks the deployment of the core contracts for the chain we are deploying to.
+    /// @notice Tracks the core deployment for the current chain.
     CoreDeployment core;
-    /// @notice tracks the deployment of the 721 hook contracts for the chain we are deploying to.
+    /// @notice Tracks the 721 hook deployment for the current chain.
     Hook721Deployment hook;
-    /// @notice tracks the deployment of the sucker contracts for the chain we are deploying to.
+    /// @notice Tracks the sucker deployment for the current chain.
     SuckerDeployment suckers;
 
     /// @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.
+    /// @notice CREATE2 salts used to deploy the Croptop contracts.
     bytes32 private constant _PUBLISHER_SALT = "_PUBLISHER_SALTV6_";
     bytes32 private constant _DEPLOYER_SALT = "_DEPLOYER_SALTV6_";
     bytes32 private constant _PROJECT_OWNER_SALT = "_PROJECT_OWNER_SALTV6_";
@@ -36,7 +36,7 @@ contract DeployScript is Script, Sphinx {
     }
 
     function run() public {
-        // Get the deployment addresses for the nana CORE for this chain.
+        // Get the core deployment addresses 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/"))
@@ -65,7 +65,7 @@ contract DeployScript is Script, Sphinx {
 
         CTPublisher publisher;
         {
-            // Perform the check for the publisher.
+            // Check whether the publisher is already deployed.
             (address _publisher, bool _publisherIsDeployed) = _isDeployed({
                 salt: _PUBLISHER_SALT,
                 creationCode: type(CTPublisher).creationCode,
@@ -85,7 +85,7 @@ contract DeployScript is Script, Sphinx {
 
         CTDeployer deployer;
         {
-            // Perform the check for the publisher.
+            // Check whether the deployer is already deployed.
             (address _deployer, bool _deployerIsDeployed) = _isDeployed({
                 salt: _DEPLOYER_SALT,
                 creationCode: type(CTDeployer).creationCode,
@@ -109,7 +109,7 @@ contract DeployScript is Script, Sphinx {
 
         CTProjectOwner owner;
         {
-            // Perform the check for the publisher.
+            // Check whether the project-owner sink is already deployed.
             (address _owner, bool _ownerIsDeployed) = _isDeployed({
                 salt: _PROJECT_OWNER_SALT,
                 creationCode: type(CTProjectOwner).creationCode,

package/src/CTDeployer.sol

@@ -46,6 +46,7 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
+    /// @notice Thrown when a caller is not the Juicebox project owner for the hook being claimed.
     error CTDeployer_NotOwnerOfProject(uint256 projectId, address hook, address caller);
     //*********************************************************************//
     // ---------------------------- events -------------------------------- //
@@ -92,7 +93,7 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     /// @param permissions The permissions contract.
     /// @param projects The projects contract.
     /// @param deployer The deployer to launch Croptop projects from.
-    /// @param publisher The croptop publisher.
+    /// @param publisher The Croptop publisher.
     /// @param suckerRegistry The sucker registry.
     /// @param trustedForwarder The trusted forwarder.
     constructor(
@@ -298,8 +299,8 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     }
 
     /// @notice Deploy new suckers for an existing project.
-    /// @dev Only the juicebox's owner or a `DEPLOY_SUCKERS` operator can deploy new suckers. Supplying an explicit
-    /// non-default peer also requires `SET_SUCKER_PEER`, matching the registry's direct-call rule.
+    /// @dev Only the Juicebox project owner or a `DEPLOY_SUCKERS` operator can deploy new suckers. Supplying an
+    /// explicit non-default peer also requires `SET_SUCKER_PEER`, matching the registry's direct-call rule.
     /// @param projectId The ID of the project to deploy suckers for.
     /// @param suckerDeploymentConfiguration The suckers to set up for the project.
     function deploySuckersFor(
@@ -365,7 +366,7 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
             return (0, context.cashOutCount, context.totalSupply, context.surplus.value, hookSpecifications);
         }
 
-        // If the ruleset has a data hook, forward the call to the datahook.
+        // If the ruleset has a data hook, forward the call to the data hook.
         IJBRulesetDataHook hook = dataHookOf[context.projectId];
         if (address(hook) == address(0)) {
             return (
@@ -428,9 +429,9 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
         tokenId;
         operator;
 
-        // Make sure the 721 received is the JBProjects contract.
+        // Only accept project NFTs from JBProjects.
         if (msg.sender != address(PROJECTS)) revert();
-        // Make sure the 721 is being received as a mint.
+        // Only accept freshly minted project NFTs.
         if (from != address(0)) revert();
         return IERC721Receiver.onERC721Received.selector;
     }
@@ -451,7 +452,7 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     // --------------------- internal transactions ----------------------- //
     //*********************************************************************//
 
-    /// @notice Configure croptop posting.
+    /// @notice Configure Croptop posting criteria for a newly deployed hook.
     /// @param hook The hook that will be posted to.
     /// @param allowedPosts The type of posts that should be allowed.
     function _configurePostingCriteriaFor(address hook, CTDeployerAllowedPost[] memory allowedPosts) internal {

package/src/CTProjectOwner.sol

@@ -24,7 +24,7 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     /// @notice The contract where operator permissions are stored.
     IJBPermissions public immutable override PERMISSIONS;
 
-    /// @notice The contract from which project are minted.
+    /// @notice The contract from which projects are minted.
     IJBProjects public immutable override PROJECTS;
 
     /// @notice The Croptop publisher contract that manages post allowances and content rules.
@@ -35,7 +35,7 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     //*********************************************************************//
 
     /// @param permissions The contract where operator permissions are stored.
-    /// @param projects The contract from which project are minted.
+    /// @param projects The contract from which projects are minted.
     /// @param publisher The Croptop publisher.
     constructor(IJBPermissions permissions, IJBProjects projects, ICTPublisher publisher) {
         PERMISSIONS = permissions;
@@ -47,8 +47,8 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
 
-    /// @notice Give the croptop publisher permission to post to the project on this contract's behalf.
-    /// @dev Make sure to first configure certain posts before sending this contract ownership.
+    /// @notice Give the Croptop publisher permission to post to the project on this contract's behalf.
+    /// @dev Configure posting criteria before transferring ownership here; this contract has no transfer-out function.
     function onERC721Received(
         address operator,
         address from,
@@ -63,14 +63,14 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
         from;
         operator;
 
-        // Make sure the 721 received is the JBProjects contract.
+        // Only accept project NFTs from JBProjects.
         if (msg.sender != address(PROJECTS)) revert();
 
-        // Set the correct permission.
+        // Grant Croptop permission to add tiers for this locked project.
         uint8[] memory permissionIds = new uint8[](1);
         permissionIds[0] = JBPermissionIds.ADJUST_721_TIERS;
 
-        // Give the croptop contract permission to post on this contract's behalf.
+        // Give the Croptop publisher permission to post on this contract's behalf.
         PERMISSIONS.setPermissionsFor({
             account: address(this),
             permissionsData: JBPermissionsData({

package/src/CTPublisher.sol

@@ -86,7 +86,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
 
     /// @notice Packed values that determine the allowance of posts.
     /// @custom:param hook The hook for which this allowance applies.
-    /// @custom:param category The category for which the allowance applies
+    /// @custom:param category The category for which the allowance applies.
     mapping(address hook => mapping(uint256 category => uint256)) internal _packedAllowanceFor;
 
     //*********************************************************************//
@@ -114,8 +114,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
 
-    /// @notice Lets collection owners define the rules for what can be posted in each category — minimum price,
-    /// supply
+    /// @notice Lets collection owners define the rules for what can be posted in each category: minimum price, supply
     /// bounds, maximum split percent, and an optional allowlist of addresses. Each call replaces the existing criteria
     /// for the specified categories.
     /// @param allowedPosts An array of criteria for allowed posts.
@@ -181,16 +180,13 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
 
     /// @notice Publish one or more NFT posts to a project's 721 hook and mint a first copy of each. For each new post,
     /// a tier is created on the hook. A 5% fee (1/FEE_DIVISOR) is taken from the total tier prices and routed to the
-    /// fee
-    /// project; the remainder is paid into the project's terminal, minting NFTs for the beneficiary.
+    /// fee project; the remainder is paid into the project's terminal, minting NFTs for the beneficiary.
     /// @dev Reverts if any post violates the category's configured allowance (price, supply, split, allowlist).
     /// @param hook The hook to mint from.
     /// @param posts An array of posts that should be published as NFTs to the specified project.
     /// @param nftBeneficiary The beneficiary of the NFT mints.
     /// @param feeBeneficiary The beneficiary of the fee project's token.
-    /// @param additionalPayMetadata Metadata bytes that should be included in the pay function's metadata. This
-    /// prepends the
-    /// payload needed for NFT creation.
+    /// @param additionalPayMetadata Metadata bytes to include in the payment after Croptop prepends NFT mint metadata.
     function mintFrom(
         IJB721TiersHook hook,
         CTPost[] calldata posts,
@@ -256,16 +252,14 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
                 if (exists) revert CTPublisher_DuplicatePayMetadata(payId);
             }
 
-            // Create the metadata for the payment to specify the tier IDs that should be minted. We create manually the
-            // original metadata, following
-            // the specifications from the JBMetadataResolver library.
+            // Add Croptop's pay metadata entry while preserving caller-provided metadata.
             mintMetadata = JBMetadataResolver.addToMetadata({
                 originalMetadata: additionalPayMetadata,
                 idToAdd: JBMetadataResolver.getId({purpose: "pay", target: metadataIdTarget}),
                 dataToAdd: abi.encode(true, tierIdsToMint)
             });
 
-            // Store the referal id in the first 32 bytes of the metadata (push to stack for immutable in assembly)
+            // Store the referral project ID in the first 32 bytes of the metadata.
             uint256 feeProjectId = FEE_PROJECT_ID;
 
             assembly {
@@ -597,7 +591,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
         }
 
         // The 721 store requires new tiers sorted by ascending category. This insertion sort normalizes caller input
-        // so multi-category publishes do not revert just because posts were supplied in mint order instead of category
+        // so multi-category publishes do not revert when posts are supplied in mint order instead of category
         // order. It is intentionally stable: equal-category posts stay in caller order because the loop only moves
         // prior tiers with a strictly greater category.
         for (uint256 i = 1; i < numberOfTiersBeingAdded;) {
@@ -654,10 +648,10 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     /// @param addrs The candidate address.
     /// @param addresses An array of allowed addresses.
     function _isAllowed(address addrs, address[] memory addresses) internal pure returns (bool) {
-        // Keep a reference to the number of address to check against.
+        // Keep a reference to the number of addresses to check against.
         uint256 numberOfAddresses = addresses.length;
 
-        // Check if the address is included
+        // Check whether the address is included.
         for (uint256 i; i < numberOfAddresses;) {
             if (addrs == addresses[i]) return true;
             unchecked {
@@ -677,13 +671,13 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
         return super._contextSuffixLength();
     }
 
-    /// @notice Returns the calldata, prefered to use over `msg.data`
-    /// @return calldata the `msg.data` of this call
+    /// @notice Returns the calldata; preferred over `msg.data`.
+    /// @return calldata the `msg.data` of this call.
     function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) {
         return ERC2771Context._msgData();
     }
 
-    /// @notice Returns the sender, prefered to use over `msg.sender`
+    /// @notice Returns the sender; preferred over `msg.sender`.
     /// @return sender the sender address of this call.
     function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) {
         return ERC2771Context._msgSender();

package/src/interfaces/ICTProjectOwner.sol

@@ -7,7 +7,7 @@ import {ICTPublisher} from "./ICTPublisher.sol";
 
 /// @notice A contract that can receive a Juicebox project NFT (via `safeTransferFrom`) and automatically grants the
 /// Croptop publisher permission to manage the project's 721 tiers. Once the project is transferred to this contract,
-/// its ownership is effectively burned while still allowing croptop posts.
+/// its ownership is effectively burned while still allowing Croptop posts.
 interface ICTProjectOwner {
     /// @notice The contract where operator permissions are stored.
     /// @return The permissions contract.

package/src/structs/CTAllowedPost.sol

@@ -6,8 +6,8 @@ pragma solidity ^0.8.0;
 /// @custom:member category A category that should allow posts.
 /// @custom:member minimumPrice The minimum price that a post to the specified category should cost.
 /// @custom:member minimumTotalSupply The minimum total supply of NFTs that can be made available when minting.
-/// @custom:member maxTotalSupply The max total supply of NFTs that can be made available when minting. Leave as 0 for
-/// max.
+/// @custom:member maximumTotalSupply The maximum total supply of NFTs that can be made available when minting. 0 means
+/// unlimited.
 /// @custom:member maximumSplitPercent The maximum split percent (out of JBConstants.SPLITS_TOTAL_PERCENT) that a
 /// poster can set. 0 means splits are not allowed.
 /// @custom:member allowedAddresses A list of addresses that are allowed to post on the category through Croptop.

package/src/structs/CTDeployerAllowedPost.sol

@@ -5,8 +5,8 @@ pragma solidity ^0.8.0;
 /// @custom:member category A category that should allow posts.
 /// @custom:member minimumPrice The minimum price that a post to the specified category should cost.
 /// @custom:member minimumTotalSupply The minimum total supply of NFTs that can be made available when minting.
-/// @custom:member maxTotalSupply The max total supply of NFTs that can be made available when minting. Leave as 0 for
-/// max.
+/// @custom:member maximumTotalSupply The maximum total supply of NFTs that can be made available when minting. 0 means
+/// unlimited.
 /// @custom:member maximumSplitPercent The maximum split percent (out of JBConstants.SPLITS_TOTAL_PERCENT) that a
 /// poster can set. 0 means splits are not allowed.
 /// @custom:member allowedAddresses A list of addresses that are allowed to post on the category through Croptop.

package/src/structs/CTSuckerDeploymentConfig.sol

@@ -3,8 +3,8 @@ pragma solidity ^0.8.0;
 
 import {JBSuckerDeployerConfig} from "@bananapus/suckers-v6/src/structs/JBSuckerDeployerConfig.sol";
 
-/// @custom:member deployerConfigurations The information for how to suck tokens to other chains.
-/// @custom:member salt The salt to use for creating suckers so that they use the same address across chains.
+/// @custom:member deployerConfigurations Sucker deployer configs and token mappings for peer chains.
+/// @custom:member salt The salt combined with `_msgSender()` to create deterministic sucker addresses.
 struct CTSuckerDeploymentConfig {
     JBSuckerDeployerConfig[] deployerConfigurations;
     bytes32 salt;