@croptop/core-v6 0.0.15 → 0.0.17

package/src/CTDeployer.sol

@@ -217,6 +217,9 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     //*********************************************************************//
 
     /// @notice Claim ownership of the collection.
+    /// @dev After calling this, the hook's owner becomes the project (resolved via PROJECTS.ownerOf). The project
+    /// owner must then grant CTPublisher the ADJUST_721_TIERS permission for the project so that mintFrom() continues
+    /// to work. Without this permission grant, all subsequent posts will revert.
     /// @param hook The hook to claim ownership of.
     function claimCollectionOwnershipOf(IJB721TiersHook hook) external override {
         // Get the project ID of the hook.
@@ -308,6 +311,9 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
         }
 
         // Deploy the suckers (if applicable).
+        // The L2 sucker deployer fallback cascade (try primary, fall back to secondary) is
+        // intentionally ordered. If both deployers fail, the deployment proceeds without suckers rather than reverting,
+        // allowing projects to launch on unsupported chains with manual sucker setup later.
         if (suckerDeploymentConfiguration.salt != bytes32(0)) {
             // slither-disable-next-line unused-return
             SUCKER_REGISTRY.deploySuckersFor({
@@ -321,6 +327,9 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
         PROJECTS.transferFrom({from: address(this), to: owner, tokenId: projectId});
 
         // Set permission for the project's owner to do all the NFT things.
+        // These permissions are granted from CTDeployer (address(this)), not from the project owner.
+        // Transferring the project NFT does not invalidate them because the permission account is CTDeployer,
+        // which remains the hook's owner regardless of who holds the project NFT.
         uint8[] memory permissionIds = new uint8[](4);
         permissionIds[0] = JBPermissionIds.ADJUST_721_TIERS;
         permissionIds[1] = JBPermissionIds.SET_721_METADATA;

package/src/CTProjectOwner.sol

@@ -11,6 +11,9 @@ 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.
 contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
     //*********************************************************************//
     // ---------------- public immutable stored properties --------------- //
@@ -71,7 +74,7 @@ contract CTProjectOwner is IERC721Receiver, ICTProjectOwner {
             permissionsData: JBPermissionsData({
                 operator: address(PUBLISHER),
                 // forge-lint: disable-next-line(unsafe-typecast)
-                projectId: uint56(tokenId),
+                projectId: uint64(tokenId),
                 permissionIds: permissionIds
             })
         });

package/src/CTPublisher.sol

@@ -1,8 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
-import {ERC2771Context} from "@openzeppelin/contracts/metatx/ERC2771Context.sol";
-import {Context} from "@openzeppelin/contracts/utils/Context.sol";
 import {IJB721TiersHook} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHook.sol";
 import {IJB721TiersHookStore} from "@bananapus/721-hook-v6/src/interfaces/IJB721TiersHookStore.sol";
 import {JB721Tier} from "@bananapus/721-hook-v6/src/structs/JB721Tier.sol";
@@ -15,6 +13,8 @@ import {JBConstants} from "@bananapus/core-v6/src/libraries/JBConstants.sol";
 import {JBMetadataResolver} from "@bananapus/core-v6/src/libraries/JBMetadataResolver.sol";
 import {JBOwnable} from "@bananapus/ownable-v6/src/JBOwnable.sol";
 import {JBPermissionIds} from "@bananapus/permission-ids-v6/src/JBPermissionIds.sol";
+import {ERC2771Context} from "@openzeppelin/contracts/metatx/ERC2771Context.sol";
+import {Context} from "@openzeppelin/contracts/utils/Context.sol";
 
 import {ICTPublisher} from "./interfaces/ICTPublisher.sol";
 import {CTAllowedPost} from "./structs/CTAllowedPost.sol";
@@ -108,6 +108,9 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
     //*********************************************************************//
 
     /// @notice Get the tiers for the provided encoded IPFS URIs.
+    /// @dev The returned tier IDs may be stale if the corresponding tiers were removed externally via adjustTiers.
+    /// 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.
     /// @return tiers The tiers that correspond to the provided encoded IPFS URIs. If there's no tier yet, an empty tier
@@ -234,6 +237,9 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
 
     /// @notice Collection owners can set the allowed criteria for publishing a new NFT to their project.
     /// @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
+    // allowedPost configurations to effectively disable new posts without removing the category.
     function configurePostingCriteriaFor(CTAllowedPost[] memory allowedPosts) external override {
         // Keep a reference to the number of post criteria.
         uint256 numberOfAllowedPosts = allowedPosts.length;
@@ -332,7 +338,14 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
                 // Note: integer division truncates, so the fee loses up to (FEE_DIVISOR - 1) wei of dust.
                 // For example, a totalPrice of 39 wei with FEE_DIVISOR=20 yields a fee of 1 wei instead of 1.95.
                 // This rounding is in the payer's favor and the loss is negligible for practical amounts.
-                payValue -= totalPrice / FEE_DIVISOR;
+                uint256 fee = totalPrice / FEE_DIVISOR;
+
+                // Make sure enough ETH was sent to cover the fee.
+                if (payValue < fee) {
+                    revert CTPublisher_InsufficientEthSent(totalPrice + fee, msg.value);
+                }
+
+                payValue -= fee;
             }
 
             // Make sure the amount sent to this function is at least the specified price of the tier plus the fee.
@@ -394,6 +407,9 @@ contract CTPublisher is JBPermissioned, ERC2771Context, ICTPublisher {
         }
 
         // Pay a fee if there are funds left.
+        // Force-sent ETH (via selfdestruct or coinbase) cannot be prevented. Routing it to the fee
+        // project (project #1) is the safest option — it prevents ETH from being permanently locked and benefits the
+        // protocol.
         if (address(this).balance != 0) {
             // Get a reference to the fee project's current ETH payment terminal.
             IJBTerminal feeTerminal =

package/src/interfaces/ICTDeployer.sol

@@ -24,6 +24,8 @@ interface ICTDeployer {
     function PUBLISHER() external view returns (ICTPublisher);
 
     /// @notice Claim ownership of a tiered ERC-721 hook collection by transferring it to the project.
+    /// @dev After claiming, the project owner must grant CTPublisher the ADJUST_721_TIERS permission for the project
+    /// so that mintFrom() continues to work.
     /// @param hook The hook to claim ownership of. The caller must own the project the hook belongs to.
     function claimCollectionOwnershipOf(IJB721TiersHook hook) external;