@bananapus/721-hook-v6 0.0.42 → 0.0.45

package/src/JB721TiersHookProjectDeployer.sol

@@ -11,6 +11,7 @@ import {JBRulesetMetadata} from "@bananapus/core-v6/src/structs/JBRulesetMetadat
 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 {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 import {Context} from "@openzeppelin/contracts/utils/Context.sol";
 
 import {IJB721TiersHook} from "./interfaces/IJB721TiersHook.sol";
@@ -23,9 +24,15 @@ import {JBPayDataHookRulesetConfig} from "./structs/JBPayDataHookRulesetConfig.s
 import {JBQueueRulesetsConfig} from "./structs/JBQueueRulesetsConfig.sol";
 
 /// @title JB721TiersHookProjectDeployer
-/// @notice Deploys a project and a 721 tiers hook for it. Can be used to queue rulesets for the project if given
-/// `JBPermissionIds.QUEUE_RULESETS` or `JBPermissionIds.LAUNCH_RULESETS`.
-contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721TiersHookProjectDeployer {
+/// @notice All-in-one deployer that creates a Juicebox project, deploys a 721 tiers hook, and configures its
+/// rulesets in a single transaction. Can also attach a hook to an existing project by launching or queuing rulesets
+/// with `LAUNCH_RULESETS` or `QUEUE_RULESETS` permission.
+contract JB721TiersHookProjectDeployer is
+    ERC2771Context,
+    JBPermissioned,
+    IERC721Receiver,
+    IJB721TiersHookProjectDeployer
+{
     //*********************************************************************//
     // --------------- public immutable stored properties ---------------- //
     //*********************************************************************//
@@ -33,7 +40,7 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
     /// @notice The directory of terminals and controllers for projects.
     IJBDirectory public immutable override DIRECTORY;
 
-    /// @notice The 721 tiers hook deployer.
+    /// @notice The deployer contract used to create new 721 tiers hook instances via clone.
     IJB721TiersHookDeployer public immutable override HOOK_DEPLOYER;
 
     //*********************************************************************//
@@ -64,9 +71,8 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
     /// @notice Launches a new project with a 721 tiers hook attached.
     /// @param owner The address to set as the owner of the project. The ERC-721 which confers this project's ownership
     /// will be sent to this address.
-    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook which is being
-    /// deployed.
-    /// @param launchProjectConfig Configuration which dictates the behavior of the project which is being launched.
+    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook to deploy.
+    /// @param launchProjectConfig Configuration which dictates the behavior of the project to launch.
     /// @param controller The controller that the project's rulesets will be queued with.
     /// @param salt A salt to use for the deterministic deployment.
     /// @return projectId The ID of the newly launched project.
@@ -82,8 +88,9 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
         override
         returns (uint256 projectId, IJB721TiersHook hook)
     {
-        // Get the project's ID, optimistically knowing it will be one greater than the current number of projects.
-        projectId = DIRECTORY.PROJECTS().count() + 1;
+        // Reserve the project ID up front so permissionless project creations cannot invalidate hook deployment.
+        IJBProjects PROJECTS = DIRECTORY.PROJECTS();
+        projectId = PROJECTS.createFor(address(this));
 
         // Deploy the hook.
         hook = HOOK_DEPLOYER.deployHookFor({
@@ -92,22 +99,25 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
             salt: salt == bytes32(0) ? bytes32(0) : keccak256(abi.encode(_msgSender(), salt))
         });
 
-        // Launch the project.
+        // Launch the rulesets for the reserved project.
         _launchProjectFor({
-            owner: owner, launchProjectConfig: launchProjectConfig, dataHook: hook, controller: controller
+            projectId: projectId, launchProjectConfig: launchProjectConfig, dataHook: hook, controller: controller
         });
 
         // Transfer the hook's ownership to the project.
         JBOwnable(address(hook)).transferOwnershipToProject(projectId);
+
+        // Transfer the project NFT to its intended owner.
+        PROJECTS.safeTransferFrom({from: address(this), to: owner, tokenId: projectId});
     }
 
     /// @notice Launches rulesets for a project with an attached 721 tiers hook.
     /// @dev Only a project's owner or an operator with the `LAUNCH_RULESETS & SET_TERMINALS` permission can launch its
     /// rulesets.
-    /// @param projectId The ID of the project that rulesets are being launched for.
-    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook which is being
-    /// deployed.
+    /// @param projectId The ID of the project to launch rulesets for.
+    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook to deploy.
     /// @param launchRulesetsConfig Configuration which dictates the project's new rulesets.
+    /// @param projectUri Metadata URI to associate with the project. Pass an empty string to leave it unchanged.
     /// @param controller The controller that the project's rulesets will be queued with.
     /// @param salt A salt to use for the deterministic deployment.
     /// @return rulesetId The ID of the successfully created ruleset.
@@ -116,6 +126,7 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
         uint256 projectId,
         JBDeploy721TiersHookConfig calldata deployTiersHookConfig,
         JBLaunchRulesetsConfig calldata launchRulesetsConfig,
+        string calldata projectUri,
         IJBController controller,
         bytes32 salt
     )
@@ -125,16 +136,23 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
     {
         // Get the project's projects contract.
         IJBProjects PROJECTS = DIRECTORY.PROJECTS();
+        address projectOwner = PROJECTS.ownerOf(projectId);
 
         // Enforce permissions.
         _requirePermissionFrom({
-            account: PROJECTS.ownerOf(projectId), projectId: projectId, permissionId: JBPermissionIds.LAUNCH_RULESETS
+            account: projectOwner, projectId: projectId, permissionId: JBPermissionIds.LAUNCH_RULESETS
         });
 
         _requirePermissionFrom({
-            account: PROJECTS.ownerOf(projectId), projectId: projectId, permissionId: JBPermissionIds.SET_TERMINALS
+            account: projectOwner, projectId: projectId, permissionId: JBPermissionIds.SET_TERMINALS
         });
 
+        if (bytes(projectUri).length != 0) {
+            _requirePermissionFrom({
+                account: projectOwner, projectId: projectId, permissionId: JBPermissionIds.SET_PROJECT_URI
+            });
+        }
+
         // Deploy the hook.
         hook = HOOK_DEPLOYER.deployHookFor({
             projectId: projectId,
@@ -147,15 +165,18 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
 
         // Launch the rulesets.
         rulesetId = _launchRulesetsFor({
-            projectId: projectId, launchRulesetsConfig: launchRulesetsConfig, dataHook: hook, controller: controller
+            projectId: projectId,
+            launchRulesetsConfig: launchRulesetsConfig,
+            projectUri: projectUri,
+            dataHook: hook,
+            controller: controller
         });
     }
 
     /// @notice Queues rulesets for a project with an attached 721 tiers hook.
     /// @dev Only a project's owner or an operator with the `QUEUE_RULESETS` permission can queue its rulesets.
-    /// @param projectId The ID of the project that rulesets are being queued for.
-    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook which is being
-    /// deployed.
+    /// @param projectId The ID of the project to queue rulesets for.
+    /// @param deployTiersHookConfig Configuration which dictates the behavior of the 721 tiers hook to deploy.
     /// @param queueRulesetsConfig Configuration which dictates the project's newly queued rulesets.
     /// @param controller The controller that the project's rulesets will be queued with.
     /// @param salt A salt to use for the deterministic deployment.
@@ -196,37 +217,28 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
     }
 
     //*********************************************************************//
-    // -------------------------- internal views ------------------------- //
+    // ----------------------- external views ---------------------------- //
     //*********************************************************************//
 
-    /// @dev ERC-2771 specifies the context as being a single address (20 bytes).
-    function _contextSuffixLength() internal view virtual override(ERC2771Context, Context) returns (uint256) {
-        return ERC2771Context._contextSuffixLength();
-    }
-
-    /// @notice The calldata. Preferred to use 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 The message's sender. Preferred to use over `msg.sender`.
-    /// @return sender The address which sent this call.
-    function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) {
-        return ERC2771Context._msgSender();
+    /// @notice Accepts project NFT reservations minted by `JBProjects.createFor`.
+    function onERC721Received(address, address from, uint256, bytes calldata) external view returns (bytes4) {
+        if (msg.sender != address(DIRECTORY.PROJECTS()) || from != address(0)) revert();
+        return IERC721Receiver.onERC721Received.selector;
     }
 
     //*********************************************************************//
     // ----------------------- internal helpers -------------------------- //
     //*********************************************************************//
 
-    /// @notice Launches a project.
-    /// @param owner The address that will own the project.
-    /// @param launchProjectConfig Configuration which dictates the behavior of the project which is being launched.
+    /// @notice Configure and launch rulesets for a newly created project. Converts `JBPayDataHookRulesetConfig` entries
+    /// into standard `JBRulesetConfig` entries with `useDataHookForPay` forced to `true` and the deployed hook set as
+    /// the data hook.
+    /// @param projectId The ID of the reserved project.
+    /// @param launchProjectConfig Configuration which dictates the behavior of the project to launch.
     /// @param dataHook The data hook to use for the project.
     /// @param controller The controller that the project's rulesets will be queued with.
     function _launchProjectFor(
-        address owner,
+        uint256 projectId,
         JBLaunchProjectConfig memory launchProjectConfig,
         IJB721TiersHook dataHook,
         IJBController controller
@@ -279,10 +291,10 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
             }
         }
 
-        // Launch the project.
+        // Launch the rulesets for the reserved project.
         // slither-disable-next-line unused-return
-        controller.launchProjectFor({
-            owner: owner,
+        controller.launchRulesetsFor({
+            projectId: projectId,
             projectUri: launchProjectConfig.projectUri,
             rulesetConfigurations: rulesetConfigurations,
             terminalConfigurations: launchProjectConfig.terminalConfigurations,
@@ -290,15 +302,18 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
         });
     }
 
-    /// @notice Launches rulesets for a project.
+    /// @notice Launch rulesets for an existing project. Same conversion logic as `_launchProjectFor` — each
+    /// `JBPayDataHookRulesetConfig` is transformed into a `JBRulesetConfig` with the hook wired as the data hook.
     /// @param projectId The ID of the project to launch rulesets for.
     /// @param launchRulesetsConfig Configuration which dictates the behavior of the project's rulesets.
+    /// @param projectUri Metadata URI to associate with the project. Pass an empty string to leave it unchanged.
     /// @param dataHook The data hook to use for the project.
     /// @param controller The controller that the project's rulesets will be queued with.
     /// @return rulesetId The ID of the successfully created ruleset.
     function _launchRulesetsFor(
         uint256 projectId,
         JBLaunchRulesetsConfig memory launchRulesetsConfig,
+        string memory projectUri,
         IJB721TiersHook dataHook,
         IJBController controller
     )
@@ -352,15 +367,20 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
         }
 
         // Launch the rulesets.
-        return controller.launchRulesetsFor({
+        uint256 rulesetId = controller.launchRulesetsFor({
             projectId: projectId,
+            projectUri: projectUri,
             rulesetConfigurations: rulesetConfigurations,
             terminalConfigurations: launchRulesetsConfig.terminalConfigurations,
             memo: launchRulesetsConfig.memo
         });
+
+        return rulesetId;
     }
 
-    /// @notice Queues rulesets for a project.
+    /// @notice Queue future rulesets for an existing project. Same conversion logic as the launch functions — each
+    /// `JBPayDataHookRulesetConfig` is transformed into a `JBRulesetConfig` with the hook wired as the data hook.
+    /// Queued rulesets take effect after the current ruleset expires.
     /// @param projectId The ID of the project to queue rulesets for.
     /// @param queueRulesetsConfig Configuration which dictates the behavior of the project's rulesets.
     /// @param dataHook The data hook to use for the project.
@@ -426,4 +446,25 @@ contract JB721TiersHookProjectDeployer is ERC2771Context, JBPermissioned, IJB721
             projectId: projectId, rulesetConfigurations: rulesetConfigurations, memo: queueRulesetsConfig.memo
         });
     }
+
+    //*********************************************************************//
+    // -------------------------- internal views ------------------------- //
+    //*********************************************************************//
+
+    /// @dev ERC-2771 specifies the context as being a single address (20 bytes).
+    function _contextSuffixLength() internal view virtual override(ERC2771Context, Context) returns (uint256) {
+        return ERC2771Context._contextSuffixLength();
+    }
+
+    /// @notice The calldata. Preferred to use 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 The message's sender. Preferred to use over `msg.sender`.
+    /// @return sender The address which sent this call.
+    function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) {
+        return ERC2771Context._msgSender();
+    }
 }