@bananapus/suckers-v6 0.0.60 → 0.0.62

package/README.md

@@ -2,13 +2,18 @@
 
 `@bananapus/suckers-v6` provides cross-chain bridging for Juicebox project tokens and the terminal assets that back them. A pair of suckers lets users burn on one chain, move value across a bridge, and mint the same project token representation on another chain.
 
-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) — guarantees this code enforces at runtime, organized by user/operator/contract.
+- [ARCHITECTURE.md](./ARCHITECTURE.md) — system layout, contract responsibilities, and the bridge-variant taxonomy.
+- [ADMINISTRATION.md](./ADMINISTRATION.md) — change-management posture, Safe-controlled surfaces, and operational roles.
+- [RISKS.md](./RISKS.md) — bridge-flavored risk register: AMB trust, merkle progression, mapping, deprecation, atomicity.
+- [USER_JOURNEYS.md](./USER_JOURNEYS.md) — end-to-end flows for token holders, operators, and integrators.
+- [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md) — scope, entrypoints, and reading order for security review.
+- [SKILLS.md](./SKILLS.md) — reusable patterns and gotchas distilled from this codebase.
+- [STYLE_GUIDE.md](./STYLE_GUIDE.md) — Solidity conventions used across this repo.
+- [CHANGELOG.md](./CHANGELOG.md) — versioned change history.
 
 The codebase includes multiple bridge variants, but the canonical deployment and discovery tooling in this repo is narrower than the full runtime surface. Treat the deployment scripts and helper libraries as the source of truth for what is operationally supported today.
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@bananapus/suckers-v6",
-  "version": "0.0.60",
+  "version": "0.0.62",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Bananapus/nana-suckers-v6"
+    "url": "git+https://github.com/Bananapus/nana-suckers-v6.git"
   },
   "files": [
     "foundry.toml",
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@arbitrum/nitro-contracts": "3.2.0",
-    "@bananapus/core-v6": "^0.0.66",
+    "@bananapus/core-v6": "^0.0.72",
     "@bananapus/permission-ids-v6": "^0.0.27",
     "@chainlink/contracts-ccip": "1.6.4",
     "@chainlink/local": "0.2.7",

package/src/JBSucker.sol

@@ -360,7 +360,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
 
     /// @notice Emergency escape hatch: lets a user reclaim their project tokens and terminal tokens on the chain they
     /// originally deposited from, when the bridge has become permanently non-functional. Must be enabled by the project
-    /// owner via the registry's `setEmergencyHatchStatusOf`.
+    /// owner via `enableEmergencyHatchFor`.
     /// @param claimData The terminal token, merkle tree leaf, and proof for the claim.
     function exitThroughEmergencyHatch(JBClaim calldata claimData) external override {
         // Does all the needed validation to ensure that the claim is valid *and* that claiming through the emergency

package/src/libraries/JBSwapLib.sol

@@ -9,19 +9,19 @@ import {TickMath} from "@uniswap/v3-core/contracts/libraries/TickMath.sol";
 /// @dev Uses continuous sigmoid formula for smooth slippage tolerance across all swap sizes.
 library JBSwapLib {
     /// @notice The denominator used for slippage tolerance basis points.
-    uint256 internal constant SLIPPAGE_DENOMINATOR = 10_000;
+    uint256 internal constant _SLIPPAGE_DENOMINATOR = 10_000;
 
     /// @notice The maximum slippage ceiling (88%).
-    uint256 internal constant MAX_SLIPPAGE = 8800;
+    uint256 internal constant _MAX_SLIPPAGE = 8800;
 
     /// @notice The precision multiplier for impact calculations.
     /// @dev Using 1e18 instead of 1e5 gives 13 extra orders of magnitude,
     ///      preventing small-swap-in-deep-pool impacts from rounding to zero.
-    uint256 internal constant IMPACT_PRECISION = 1e18;
+    uint256 internal constant _IMPACT_PRECISION = 1e18;
 
-    /// @notice The K parameter for the sigmoid curve, scaled to match IMPACT_PRECISION.
+    /// @notice The K parameter for the sigmoid curve, scaled to match _IMPACT_PRECISION.
     /// @dev K_new = 5000 * 1e18 / 1e5 = 5e16
-    uint256 internal constant SIGMOID_K = 5e16;
+    uint256 internal constant _SIGMOID_K = 5e16;
 
     //*********************************************************************//
     // -------------------- Slippage Tolerance -------------------------- //
@@ -29,22 +29,22 @@ library JBSwapLib {
 
     /// @notice Compute a continuous sigmoid slippage tolerance based on swap impact and pool fee.
     /// @dev tolerance = minSlippage + (maxSlippage - minSlippage) * impact / (impact + K)
-    /// @param impact The estimated price impact from calculateImpact (scaled by IMPACT_PRECISION).
+    /// @param impact The estimated price impact from calculateImpact (scaled by _IMPACT_PRECISION).
     /// @param poolFeeBps The pool fee in basis points (e.g., 30 for 0.3%).
-    /// @return tolerance The slippage tolerance in basis points of SLIPPAGE_DENOMINATOR.
+    /// @return tolerance The slippage tolerance in basis points of _SLIPPAGE_DENOMINATOR.
     function getSlippageTolerance(uint256 impact, uint256 poolFeeBps) internal pure returns (uint256) {
-        if (poolFeeBps >= MAX_SLIPPAGE) return MAX_SLIPPAGE;
+        if (poolFeeBps >= _MAX_SLIPPAGE) return _MAX_SLIPPAGE;
 
         uint256 minSlippage = poolFeeBps + 100;
         if (minSlippage < 200) minSlippage = 200;
-        if (minSlippage >= MAX_SLIPPAGE) return MAX_SLIPPAGE;
+        if (minSlippage >= _MAX_SLIPPAGE) return _MAX_SLIPPAGE;
 
         if (impact == 0) return minSlippage;
 
-        if (impact > type(uint256).max - SIGMOID_K) return MAX_SLIPPAGE;
+        if (impact > type(uint256).max - _SIGMOID_K) return _MAX_SLIPPAGE;
 
-        uint256 range = MAX_SLIPPAGE - minSlippage;
-        uint256 tolerance = minSlippage + mulDiv({x: range, y: impact, denominator: impact + SIGMOID_K});
+        uint256 range = _MAX_SLIPPAGE - minSlippage;
+        uint256 tolerance = minSlippage + mulDiv({x: range, y: impact, denominator: impact + _SIGMOID_K});
 
         return tolerance;
     }
@@ -53,12 +53,12 @@ library JBSwapLib {
     // -------------------- Impact Calculation -------------------------- //
     //*********************************************************************//
 
-    /// @notice Estimate the price impact of a swap, scaled by IMPACT_PRECISION.
+    /// @notice Estimate the price impact of a swap, scaled by _IMPACT_PRECISION.
     /// @param amountIn The amount of tokens to swap in.
     /// @param liquidity The pool's in-range liquidity.
     /// @param sqrtP The sqrt price in Q96 format.
     /// @param zeroForOne Whether the swap is token0 -> token1.
-    /// @return impact The estimated price impact scaled by IMPACT_PRECISION.
+    /// @return impact The estimated price impact scaled by _IMPACT_PRECISION.
     function calculateImpact(
         uint256 amountIn,
         uint128 liquidity,
@@ -71,7 +71,7 @@ library JBSwapLib {
     {
         if (liquidity == 0 || sqrtP == 0) return 0;
 
-        uint256 base = mulDiv({x: amountIn, y: IMPACT_PRECISION, denominator: uint256(liquidity)});
+        uint256 base = mulDiv({x: amountIn, y: _IMPACT_PRECISION, denominator: uint256(liquidity)});
 
         impact = zeroForOne
             ? mulDiv({x: base, y: uint256(sqrtP), denominator: uint256(1) << 96})