@croptop/core-v6 0.0.39 → 0.0.41

package/package.json

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

package/src/CTDeployer.sol

@@ -36,7 +36,11 @@ import {CTDeployerAllowedPost} from "./structs/CTDeployerAllowedPost.sol";
 import {CTProjectConfig} from "./structs/CTProjectConfig.sol";
 import {CTSuckerDeploymentConfig} from "./structs/CTSuckerDeploymentConfig.sol";
 
-/// @notice A contract that facilitates deploying a simple Juicebox project to receive posts from Croptop templates.
+/// @notice Deploys Juicebox projects pre-configured for Croptop — a permissionless NFT publishing system. Each
+/// deployed project gets a tiered 721 hook (for minting posted NFTs), an optional set of cross-chain suckers, and this
+/// contract set as the data hook so suckers get 0% cash-out tax and mint permission. The hook initially remains owned
+/// by this deployer (allowing the publisher to add tiers); the project owner can later claim full hook ownership via
+/// `claimCollectionOwnershipOf`.
 contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC721Receiver, ICTDeployer {
     //*********************************************************************//
     // --------------------------- custom errors ------------------------- //
@@ -59,7 +63,7 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     /// @notice Mints ERC-721s that represent Juicebox project ownership and transfers.
     IJBProjects public immutable override PROJECTS;
 
-    /// @notice The Croptop publisher.
+    /// @notice The Croptop publisher contract that manages post allowances and content rules.
     ICTPublisher public immutable override PUBLISHER;
 
     /// @notice Deploys and tracks suckers for projects.
@@ -291,8 +295,10 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     // ------------------------- external views -------------------------- //
     //*********************************************************************//
 
-    /// @notice Allow cash outs from suckers without a tax.
-    /// @dev This function is part of `IJBRulesetDataHook`, and gets called before the revnet processes a cash out.
+    /// @notice Called before a cash out is recorded. Grants suckers 0% tax so bridged tokens redeem at full value.
+    /// For non-sucker holders, delegates to the project's stored data hook (if any) or passes through the original
+    /// context values.
+    /// @dev Part of `IJBRulesetDataHook`.
     /// @param context Standard Juicebox cash out context. See `JBBeforeCashOutRecordedContext`.
     /// @return cashOutTaxRate The cash out tax rate, which influences the amount of terminal tokens which get cashed
     /// out.
@@ -332,13 +338,14 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
         return hook.beforeCashOutRecordedWith(context);
     }
 
-    /// @notice Forward the call to the original data hook.
-    /// @dev This function is part of `IJBRulesetDataHook`, and gets called before the revnet processes a payment.
+    /// @notice Called before a payment is recorded. Delegates to the project's stored data hook (the 721 hook) so NFT
+    /// tier minting logic runs. If no hook is set, passes through the original weight.
+    /// @dev Part of `IJBRulesetDataHook`.
     /// @param context Standard Juicebox payment context. See `JBBeforePayRecordedContext`.
     /// @return weight The weight which project tokens are minted relative to. This can be used to customize how many
     /// tokens get minted by a payment.
-    /// @return hookSpecifications Amounts (out of what's being paid in) to be sent to pay hooks instead of being paid
-    /// into the project. Useful for automatically routing funds from a treasury as payments come in.
+    /// @return hookSpecifications Amounts (out of what's paid in) to send to pay hooks instead of adding to the
+    /// project. Useful for automatically routing funds from a treasury as payments come in.
     function beforePayRecordedWith(JBBeforePayRecordedContext calldata context)
         external
         view
@@ -355,8 +362,9 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
         return hook.beforePayRecordedWith(context);
     }
 
-    /// @notice A flag indicating whether an address has permission to mint a project's tokens on-demand.
-    /// @dev A project's data hook can allow any address to mint its tokens.
+    /// @notice Returns whether an address may mint a project's tokens on-demand. Only suckers get this permission, so
+    /// bridged tokens can be minted on the destination chain.
+    /// @dev Part of `IJBRulesetDataHook`.
     /// @param projectId The ID of the project whose token can be minted.
     /// @param addr The address to check the token minting permission of.
     /// @return flag A flag indicating whether the address has permission to mint the project's tokens on-demand.

package/src/CTProjectOwner.sol

@@ -10,10 +10,12 @@ import {JBPermissionIds} from "@bananapus/permission-ids-v6/src/JBPermissionIds.
 import {ICTProjectOwner} from "./interfaces/ICTProjectOwner.sol";
 import {ICTPublisher} from "./interfaces/ICTPublisher.sol";
 
-/// @notice A contract that can be sent a project to be burned, while still allowing croptop posts.
-/// @dev This contract does not expose any function to reconfigure posting criteria. This is by design: posting
-/// criteria are set before transferring the project here, and become immutable once ownership is transferred.
-/// The project owner should configure all desired posting criteria before sending the project NFT to this contract.
+/// @notice A dead-end owner for Juicebox projects that locks ownership while preserving Croptop posting. When a project
+/// NFT is transferred to this contract via `safeTransferFrom`, it automatically grants the Croptop publisher
+/// `ADJUST_721_TIERS` permission so posts can continue. The project can never be transferred out again — effectively
+/// burning ownership while keeping the collection alive.
+/// @dev This contract does not expose any function to reconfigure posting criteria. Criteria are set before
+/// transferring the project here and become immutable once ownership is transferred.
 contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     //*********************************************************************//
     // ---------------- public immutable stored properties --------------- //
@@ -25,7 +27,7 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     /// @notice The contract from which project are minted.
     IJBProjects public immutable override PROJECTS;
 
-    /// @notice The Croptop publisher.
+    /// @notice The Croptop publisher contract that manages post allowances and content rules.
     ICTPublisher public immutable override PUBLISHER;
 
     //*********************************************************************//

package/src/CTPublisher.sol

@@ -21,7 +21,11 @@ import {ICTPublisher} from "./interfaces/ICTPublisher.sol";
 import {CTAllowedPost} from "./structs/CTAllowedPost.sol";
 import {CTPost} from "./structs/CTPost.sol";
 
-/// @notice A contract that facilitates the permissioned publishing of NFT posts to a Juicebox project.
+/// @notice The Croptop publishing engine. Allows anyone to publish NFT posts to a Juicebox project's 721 hook, subject
+/// to per-category posting criteria set by the collection owner (minimum price, supply bounds, allowlist, max split
+/// percent). On each mint, the publisher creates new 721 tiers, routes a 5% fee to the fee project, and pays the
+/// remainder into the project's terminal. Duplicate IPFS URIs are tracked so subsequent mints of the same content reuse
+/// the existing tier rather than creating a new one.
 contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     //*********************************************************************//
     // --------------------------- custom errors ------------------------- //
@@ -54,7 +58,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     // ---------------- public immutable stored properties --------------- //
     //*********************************************************************//
 
-    /// @notice The directory that contains the projects being posted to.
+    /// @notice The directory that contains the projects to post to.
     IJBDirectory public immutable override DIRECTORY;
 
     /// @notice The ID of the project to which fees will be routed.
@@ -88,7 +92,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     // -------------------------- constructor ---------------------------- //
     //*********************************************************************//
 
-    /// @param directory The directory that contains the projects being posted to.
+    /// @param directory The directory that contains the projects to post to.
     /// @param permissions A contract storing permissions.
     /// @param feeProjectId The ID of the project to which fees will be routed.
     /// @param trustedForwarder The trusted forwarder for the ERC2771Context.
@@ -109,7 +113,10 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     // ---------------------- external transactions ---------------------- //
     //*********************************************************************//
 
-    /// @notice Collection owners can set the allowed criteria for publishing a new NFT to their project.
+    /// @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.
     // Categories cannot be fully disabled after creation. This is by design — once a category is
     // created, removing posting would break expectations for existing posters. Projects can set restrictive
@@ -171,8 +178,11 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
         }
     }
 
-    /// @notice Publish an NFT to become mintable, and mint a first copy.
-    /// @dev A fee is taken into the appropriate treasury.
+    /// @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.
+    /// @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.
@@ -422,7 +432,7 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     /// @param posts An array of posts that should be published as NFTs to the specified project.
     /// @return tiersToAdd The tiers that will be created to represent the posts.
     /// @return tierIdsToMint The tier IDs of the posts that should be minted once published.
-    /// @return totalPrice The total price being paid.
+    /// @return totalPrice The total price to pay.
     function _setupPosts(
         IJB721TiersHook hook,
         CTPost[] memory posts

package/src/interfaces/ICTDeployer.sol

@@ -19,7 +19,7 @@ interface ICTDeployer {
     /// @return The projects contract.
     function PROJECTS() external view returns (IJBProjects);
 
-    /// @notice The Croptop publisher that manages posting criteria and minting.
+    /// @notice The CTPublisher contract used to mint NFTs from submitted posts.
     /// @return The publisher contract.
     function PUBLISHER() external view returns (ICTPublisher);
 

package/src/interfaces/ICTPublisher.sol

@@ -57,7 +57,7 @@ interface ICTPublisher {
             address[] memory allowedAddresses
         );
 
-    /// @notice The directory that contains the projects being posted to.
+    /// @notice The directory that contains the projects to post to.
     /// @return The directory contract.
     function DIRECTORY() external view returns (IJBDirectory);
 

package/src/structs/CTPost.sol

@@ -4,10 +4,10 @@ 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 that is being published.
+/// @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 being paid for buying the post that is being published.
+/// @custom:member price The price to pay for buying the post.
 /// @custom:member category The category that the post should be published in.
 /// @custom:member splitPercent The percent of the tier's price to route to the splits (out of
 /// JBConstants.SPLITS_TOTAL_PERCENT).

package/src/structs/CTProjectConfig.sol

@@ -4,13 +4,14 @@ pragma solidity ^0.8.0;
 import {JBTerminalConfig} from "@bananapus/core-v6/src/structs/JBTerminalConfig.sol";
 import {CTDeployerAllowedPost} from "../structs/CTDeployerAllowedPost.sol";
 
-/// @param terminalConfigurations The terminals that the network uses to accept payments through.
+/// @notice Configuration for deploying a new Croptop project via CTDeployer.
+/// @param terminalConfigurations The terminals that the project uses to accept payments through.
 /// @param projectUri The metadata URI containing project info.
-/// @param allowedPosts The type of posts that the project should allow.
-/// @param contractUri A link to the collection's metadata.
-/// @param name The name of the collection where posts will go.
-/// @param symbol The symbol of the collection where posts will go.
-/// @param salt A salt to use for the deterministic deployment.
+/// @param allowedPosts The posting criteria that define what kinds of NFTs can be published to each category.
+/// @param contractUri A link to the 721 collection's metadata (e.g. OpenSea-compatible contract-level metadata).
+/// @param name The name of the 721 collection where posts will be minted.
+/// @param symbol The symbol of the 721 collection where posts will be minted.
+/// @param salt A salt for deterministic deployment of the 721 hook (includes msg.sender for replay protection).
 struct CTProjectConfig {
     JBTerminalConfig[] terminalConfigurations;
     string projectUri;