@croptop/core-v6 0.0.40 → 0.0.41

package/package.json

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

package/src/CTDeployer.sol

@@ -63,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.
@@ -344,8 +344,8 @@ contract CTDeployer is ERC2771Context, JBPermissioned, IJBRulesetDataHook, IERC7
     /// @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

package/src/CTProjectOwner.sol

@@ -27,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

@@ -58,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.
@@ -92,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.
@@ -432,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).