@bananapus/omnichain-deployers-v6 0.0.51 → 0.0.53

package/README.md

@@ -2,13 +2,18 @@
 
 `@bananapus/omnichain-deployers-v6` launches Juicebox projects with cross-chain suckers and a 721 hook already wired in. It is the package you use when the default project shape should be omnichain from day one.
 
-Docs: <https://docs.juicebox.money>
-Architecture: [ARCHITECTURE.md](./ARCHITECTURE.md)  
-User journeys: [USER_JOURNEYS.md](./USER_JOURNEYS.md)  
-Skills: [SKILLS.md](./SKILLS.md)  
-Risks: [RISKS.md](./RISKS.md)  
-Administration: [ADMINISTRATION.md](./ADMINISTRATION.md)  
-Audit instructions: [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md)
+
+## Documentation
+
+- [INVARIANTS.md](./INVARIANTS.md) — runtime guarantees enforced by `JBOmnichainDeployer`, per-function caller / effect / invariant inventory, and cross-cutting invariants.
+- [ARCHITECTURE.md](./ARCHITECTURE.md) — system overview, trust boundaries, and source map.
+- [ADMINISTRATION.md](./ADMINISTRATION.md) — control posture, recovery posture, and admin boundaries.
+- [RISKS.md](./RISKS.md) — risk register with priority levels, trust assumptions, and accepted behaviors.
+- [USER_JOURNEYS.md](./USER_JOURNEYS.md) — primary actor flows for launching omnichain projects and adding suckers later.
+- [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md) — audit objective, scope, and verification commands.
+- [SKILLS.md](./SKILLS.md) — orientation for AI agents and contributors working on this repo.
+- [STYLE_GUIDE.md](./STYLE_GUIDE.md) — Solidity and repo conventions across the Juicebox V6 ecosystem.
+- [CHANGELOG.md](./CHANGELOG.md) — version-to-version changes and migration notes.
 
 ## Overview
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@bananapus/omnichain-deployers-v6",
-  "version": "0.0.51",
+  "version": "0.0.53",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Bananapus/nana-omnichain-deployers-v6"
+    "url": "git+https://github.com/Bananapus/nana-omnichain-deployers-v6.git"
   },
   "files": [
     "foundry.toml",
@@ -14,7 +14,7 @@
     "src/"
   ],
   "engines": {
-    "node": "25.9.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "test": "forge test",
@@ -24,16 +24,16 @@
     "artifacts": "source ./.env && npx sphinx artifacts --org-id 'ea165b21-7cdc-4d7b-be59-ecdd4c26bee4' --project-name 'nana-omnichain-deployers-v6'"
   },
   "dependencies": {
-    "@bananapus/721-hook-v6": "^0.0.57",
-    "@bananapus/core-v6": "^0.0.68",
-    "@bananapus/ownable-v6": "^0.0.31",
+    "@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/suckers-v6": "^0.0.58",
+    "@bananapus/suckers-v6": "^0.0.60",
     "@openzeppelin/contracts": "5.6.1"
   },
   "devDependencies": {
-    "@bananapus/address-registry-v6": "^0.0.28",
-    "@bananapus/buyback-hook-v6": "^0.0.55",
+    "@bananapus/address-registry-v6": "^0.0.29",
+    "@bananapus/buyback-hook-v6": "^0.0.58",
     "@sphinx-labs/plugins": "0.33.3",
     "@uniswap/v4-core": "1.0.2"
   }

package/references/operations.md

@@ -10,7 +10,7 @@
 
 - If you edit launch or queue behavior, verify ruleset IDs, carry-forward behavior, and stored hook config keys together.
 - If you edit salt handling, confirm deterministic-address assumptions for both suckers and 721 hooks.
-- If you edit wrapper behavior, check both pay and cash-out paths, not just one.
+- If you edit wrapper behavior, check both pay and cash-out paths, not only one.
 - If you touch mint-permission logic, confirm whether the permission should come from suckers, the extra hook, or neither.
 
 ## Common Failure Modes

package/script/Deploy.s.sol

@@ -13,13 +13,13 @@ import {JBOmnichainDeployer} from "src/JBOmnichainDeployer.sol";
 contract Deploy is Script, Sphinx {
     bytes32 constant NANA_OMNICHAIN_DEPLOYER_SALT = "JBOmnichainDeployerV6_";
 
-    /// @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;
 
     function configureSphinx() public override {
@@ -29,7 +29,7 @@ contract Deploy 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({

package/script/helpers/DeployersDeploymentLib.sol

@@ -42,7 +42,7 @@ library DeployersDeploymentLib {
         view
         returns (DeployersDeployment memory deployment)
     {
-        // Is deployed on all (supported) chains.
+        // Read the omnichain deployer address for this supported chain.
         deployment.deployer = JBOmnichainDeployer(
             _getDeploymentAddress({
                 path: path,

package/src/JBOmnichainDeployer.sol

@@ -37,13 +37,11 @@ import {mulDiv} from "@prb/math/src/Common.sol";
 /// 721 hook and cross-chain suckers in a single transaction, then inserts itself as every ruleset's data hook so it can
 /// coordinate between the 721 hook, an optional extra hook (e.g. buyback), and the sucker registry at pay/cash-out
 /// time. At pay time it merges weight and hook specifications from both the 721 hook and the extra hook. At cash-out
-/// time it
-/// computes cross-chain total supply and surplus (so the bonding curve reflects all chains), grants suckers 0% cash-out
-/// tax, and delegates tax-rate adjustments to the underlying hooks.
+/// time it computes cross-chain total supply and surplus (so the bonding curve reflects all chains), grants suckers 0%
+/// cash-out tax, and delegates tax-rate adjustments to the underlying hooks.
 /// @dev Project NFTs sent to this contract are not recoverable. The deployer does not implement any NFT rescue
 /// mechanism beyond `onERC721Received` for `JBProjects`. This is acceptable because the deployer should never own
-/// project NFTs —
-/// it creates projects and transfers ownership in the same transaction.
+/// project NFTs — it creates projects and transfers ownership in the same transaction.
 contract JBOmnichainDeployer is
     ERC2771Context,
     JBPermissioned,
@@ -136,16 +134,14 @@ contract JBOmnichainDeployer is
         HOOK_DEPLOYER = hookDeployer;
         DIRECTORY = controller.DIRECTORY();
 
-        // Give the sucker registry permission to map tokens for all revnets.
+        // Let the sucker registry map tokens for projects this deployer administers.
         uint8[] memory permissionIds = new uint8[](1);
         permissionIds[0] = JBPermissionIds.MAP_SUCKER_TOKEN;
 
-        // Give the operator the permission.
-        // Set up the permission data.
+        // Grant the registry a deployer-scoped wildcard permission.
         JBPermissionsData memory permissionData =
             JBPermissionsData({operator: address(SUCKER_REGISTRY), projectId: 0, permissionIds: permissionIds});
 
-        // Set the permissions.
         PERMISSIONS.setPermissionsFor({account: address(this), permissionsData: permissionData});
     }
 
@@ -732,8 +728,9 @@ contract JBOmnichainDeployer is
 
     /// @notice Indicates if this contract adheres to the specified interface.
     /// @dev See `IERC165.supportsInterface`.
-    /// @return A flag indicating if the provided interface ID is supported.
-    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
+    /// @param interfaceId The interface ID to check.
+    /// @return flag A flag indicating if the provided interface ID is supported.
+    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool flag) {
         return interfaceId == type(IJBOmnichainDeployer).interfaceId
             || interfaceId == type(IJBRulesetDataHook).interfaceId
             || interfaceId == type(IJBPeerChainAdjustedAccounts).interfaceId
@@ -807,7 +804,7 @@ contract JBOmnichainDeployer is
         // A fresh launch must leave the directory pointing at this deployer's canonical controller.
         _requireController({projectId: projectId, allowUnset: false});
 
-        // Transfer the hook's ownership to the project (now that the project NFT has been minted).
+        // Transfer the hook's ownership to the project after the project NFT has been minted.
         JBOwnable(address(hook)).transferOwnershipToProject(projectId);
 
         // Deploy the suckers (if applicable).
@@ -1001,7 +998,7 @@ contract JBOmnichainDeployer is
             _tiered721HookOf[projectId][rulesetId] =
                 JBTiered721HookConfig({hook: hook721, useDataHookForCashOut: use721ForCashOut});
 
-            // Store custom hook from metadata (same as _setup).
+            // Store any extra hook provided in ruleset metadata.
             if (rulesetConfigurations[i].metadata.dataHook != address(0)) {
                 _extraDataHookOf[projectId][rulesetId] = JBDeployerHookConfig({
                     dataHook: IJBRulesetDataHook(rulesetConfigurations[i].metadata.dataHook),
@@ -1010,7 +1007,7 @@ contract JBOmnichainDeployer is
                 });
             }
 
-            // Set this contract as the data hook, force both pay and cashout through this wrapper.
+            // Set this contract as the data hook, forcing both pay and cash-out through this wrapper.
             rulesetConfigurations[i].metadata.dataHook = address(this);
             rulesetConfigurations[i].metadata.useDataHookForPay = true;
             rulesetConfigurations[i].metadata.useDataHookForCashOut = true;

package/src/interfaces/IJBOmnichainDeployer.sol

@@ -9,10 +9,8 @@ import {JBDeployerHookConfig} from "../structs/JBDeployerHookConfig.sol";
 import {JBOmnichain721Config} from "../structs/JBOmnichain721Config.sol";
 import {JBSuckerDeploymentConfig} from "../structs/JBSuckerDeploymentConfig.sol";
 
-/// @notice Interface for the omnichain deployer — a one-stop contract that launches Juicebox projects with a tiered
-/// 721
-/// hook and cross-chain suckers, then serves as the data hook wrapper that coordinates pay/cash-out logic across all
-/// chains.
+/// @notice Interface for launching Juicebox projects with a 721 tiers hook and cross-chain suckers, then coordinating
+/// pay/cash-out logic through a data hook wrapper.
 interface IJBOmnichainDeployer {
     /// @notice The controller used for every project launch and ruleset queue.
     function CONTROLLER() external view returns (IJBController);

package/src/structs/JBSuckerDeploymentConfig.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 JBSuckerDeploymentConfig {
     JBSuckerDeployerConfig[] deployerConfigurations;
     bytes32 salt;