@bananapus/suckers-v6 0.0.34 → 0.0.35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/suckers-v6",
-  "version": "0.0.34",
+  "version": "0.0.35",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/JBArbitrumSucker.sol

@@ -151,7 +151,7 @@ contract JBArbitrumSucker is JBSucker, IJBArbitrumSucker {
     /// @notice Uses the L1/L2 gateway to send the root and assets over the bridge to the peer.
     /// @param transportPayment the amount of `msg.value` that is going to get paid for sending this message.
     /// @param token The token to bridge the outbox tree for.
-    /// @param remoteToken Information about the remote token being bridged to.
+    /// @param remoteToken Information about the remote token to bridge to.
     // forge-lint: disable-next-line(mixed-case-function)
     function _sendRootOverAMB(
         uint256 transportPayment,

package/src/JBCCIPSucker.sol

@@ -201,7 +201,7 @@ contract JBCCIPSucker is JBSucker, IAny2EVMMessageReceiver {
     /// @param transportPayment The amount of `msg.value` that is going to get paid for sending this message.
     /// @param token The token to bridge the outbox tree for.
     /// @param amount The amount of tokens to bridge.
-    /// @param remoteToken Information about the remote token being bridged to.
+    /// @param remoteToken Information about the remote token to bridge to.
     /// @param sucker_message The message root to send to the remote peer.
     // forge-lint: disable-next-line(mixed-case-function)
     function _sendRootOverAMB(

package/src/JBCeloSucker.sol

@@ -122,7 +122,7 @@ contract JBCeloSucker is JBOptimismSucker {
     /// `nativeValue = 0` because Celo's native token is CELO (not ETH), so we never attach ETH as msg.value.
     /// @param transportPayment the amount of `msg.value` that is going to get paid for sending this message.
     /// @param token The token to bridge the outbox tree for.
-    /// @param remoteToken Information about the remote token being bridged to.
+    /// @param remoteToken Information about the remote token to bridge to.
     // forge-lint: disable-next-line(mixed-case-function)
     function _sendRootOverAMB(
         uint256 transportPayment,

package/src/JBOptimismSucker.sol

@@ -87,7 +87,7 @@ contract JBOptimismSucker is JBSucker, IJBOptimismSucker {
     /// over the `OPBRIDGE`.
     /// @param transportPayment the amount of `msg.value` that is going to get paid for sending this message.
     /// @param token The token to bridge the outbox tree for.
-    /// @param remoteToken Information about the remote token being bridged to.
+    /// @param remoteToken Information about the remote token to bridge to.
     // forge-lint: disable-next-line(mixed-case-function)
     function _sendRootOverAMB(
         uint256 transportPayment,

package/src/JBSucker.sol

@@ -389,7 +389,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// messages time to arrive, accepting roots after deprecation provides a stronger guarantee that users can always
     /// claim their bridged tokens. Double-spend is not a concern because `toRemote` is already disabled in
     /// `SENDING_DISABLED` and `DEPRECATED` states, so no new outbound transfers can occur.
-    /// @param root The merkle root, token, and amount being received.
+    /// @param root The merkle root, token, and amount to receive.
     function fromRemote(JBMessageRoot calldata root) external payable {
         // Make sure that the message came from our peer.
         // Use msg.sender (not _msgSender()) because bridge messengers never use ERC2771 meta-transactions.
@@ -620,7 +620,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// for the original caller instead of being added back to `transportPayment`. This preserves
     /// `transportPayment = msg.value - fee`, which is critical for zero-cost bridges (OP, Base, Celo, Arb L2->L1)
     /// that revert on non-zero transport payment. The retained fee is excluded from `amountToAddToBalanceOf`.
-    /// @param token The terminal token being bridged.
+    /// @param token The terminal token to bridge.
     function toRemote(address token) external payable override {
         JBRemoteToken memory remoteToken = _remoteTokenFor[token];
 
@@ -963,7 +963,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     }
 
     /// @notice The action(s) to perform after a user has succesfully proven their claim.
-    /// @param terminalToken The terminal token being sucked.
+    /// @param terminalToken The terminal token to suck.
     /// @param terminalTokenAmount The amount of terminal tokens.
     /// @param projectTokenAmount The amount of project tokens.
     /// @param beneficiary The beneficiary of the project tokens (bytes32 for cross-VM compatibility).
@@ -1000,8 +1000,8 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     }
 
     /// @notice Inserts a new leaf into the outbox merkle tree for the specified `token`.
-    /// @param projectTokenCount The amount of project tokens being cashed out.
-    /// @param token The terminal token being cashed out for.
+    /// @param projectTokenCount The amount of project tokens to cash out.
+    /// @param token The terminal token to cash out for.
     /// @param terminalTokenAmount The amount of terminal tokens reclaimed by cashing out.
     /// @param beneficiary The beneficiary of the project tokens on the remote chain (bytes32 for cross-VM
     /// compatibility).
@@ -1127,7 +1127,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     }
 
     /// @notice Cash out project tokens for terminal tokens.
-    /// @param projectToken The project token being cashed out (unused, kept for interface compatibility).
+    /// @param projectToken The project token to cash out (unused, kept for interface compatibility).
     /// @param count The number of project tokens to cash out.
     /// @param token The terminal token to cash out for.
     /// @param minTokensReclaimed The minimum amount of terminal tokens to reclaim. If the amount reclaimed is less than
@@ -1245,8 +1245,8 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// @dev This is chain/sucker/bridge specific logic.
     /// @param transportPayment The amount of `msg.value` that is going to get paid for sending this message.
     /// @param index The index of the most recent message that is part of the root.
-    /// @param token The terminal token being bridged.
-    /// @param amount The amount of terminal tokens being bridged.
+    /// @param token The terminal token to bridge.
+    /// @param amount The amount of terminal tokens to bridge.
     /// @param remoteToken The remote token which the terminal token is mapped to.
     /// @param message The message/root to send to the remote chain.
     // forge-lint: disable-next-line(mixed-case-function)
@@ -1268,7 +1268,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// @param terminalToken The terminal token that the project tokens were cashed out for.
     /// @param terminalTokenAmount The amount of terminal tokens reclaimed by the cash out.
     /// @param beneficiary The beneficiary of the project tokens (bytes32 for cross-VM compatibility).
-    /// @param index The index of the leaf being proved in the terminal token's inbox tree.
+    /// @param index The index of the leaf to prove in the terminal token's inbox tree.
     /// @param leaves The leaves that prove that the leaf at the `index` is in the tree (i.e. the merkle branch that the
     /// leaf is on).
     function _validate(
@@ -1364,7 +1364,7 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// @param terminalToken The terminal token that the project tokens were cashed out for.
     /// @param terminalTokenAmount The amount of terminal tokens reclaimed by the cash out.
     /// @param beneficiary The beneficiary of the project tokens (bytes32 for cross-VM compatibility).
-    /// @param index The index of the leaf being proved in the terminal token's inbox tree.
+    /// @param index The index of the leaf to prove in the terminal token's inbox tree.
     /// @param leaves The leaves that prove that the leaf at the `index` is in the tree (i.e. the merkle branch that the
     /// leaf is on).
     function _validateForEmergencyExit(
@@ -1467,8 +1467,8 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     }
 
     /// @notice Builds a hash as they are stored in the merkle tree.
-    /// @param projectTokenCount The number of project tokens being cashed out.
-    /// @param terminalTokenAmount The amount of terminal tokens being reclaimed by the cash out.
+    /// @param projectTokenCount The number of project tokens to cash out.
+    /// @param terminalTokenAmount The amount of terminal tokens to reclaim from the cash out.
     /// @param beneficiary The beneficiary which will receive the project tokens (bytes32 for cross-VM compatibility).
     /// @return hash The keccak256 hash of the leaf data.
     function _buildTreeHash(
@@ -1605,9 +1605,9 @@ abstract contract JBSucker is ERC2771Context, JBPermissioned, Initializable, ERC
     /// @dev Delegates snapshot construction to JBSuckerLib (deployed library, called via DELEGATECALL) to reduce
     /// child contract bytecode.
     /// @param transportPayment The amount of `msg.value` that is going to get paid for sending this message.
-    /// @param token The terminal token being bridged.
+    /// @param token The terminal token to bridge.
     /// @param remoteToken The remote token which the terminal token is mapped to.
-    /// @param amount The amount of terminal tokens being bridged.
+    /// @param amount The amount of terminal tokens to bridge.
     /// @param nonce The outbox nonce for this send.
     /// @param root The merkle root of the outbox tree.
     /// @param index The index of the most recent message that is part of the root.

package/src/JBSuckerRegistry.sol

@@ -401,8 +401,8 @@ contract JBSuckerRegistry is ERC2771Context, Ownable, JBPermissioned, IJBSuckerR
     /// @param values The aggregate values recorded so far.
     /// @param hasActiveValue Whether the recorded value for each index came from an active sucker.
     /// @param chainCount The number of populated chain entries.
-    /// @param chainId The peer-chain id being recorded.
-    /// @param value The value being recorded.
+    /// @param chainId The peer-chain id to record.
+    /// @param value The value to record.
     /// @param isActive Whether the value came from an active sucker.
     /// @return The updated number of populated chain entries.
     function _recordPeerValue(

package/src/JBSwapCCIPSucker.sol

@@ -184,7 +184,7 @@ contract JBSwapCCIPSucker is JBCCIPSucker, IUnlockCallback, IUniswapV3SwapCallba
     // ------------------- transient stored properties ------------------- //
     //*********************************************************************//
 
-    /// @notice Leaf index + 1 of the claim currently being processed (set by `claim` override).
+    /// @notice Leaf index + 1 of the claim currently in progress (set by the `claim` override).
     /// @dev Transient storage — auto-resets to 0 each transaction, saving ~9,800 gas per claim vs SSTORE.
     /// Value 0 means no active claim (bypass scaling); non-zero means leafIndex = value - 1.
     uint256 transient _currentClaimLeafIndex;
@@ -370,8 +370,8 @@ contract JBSwapCCIPSucker is JBCCIPSucker, IUnlockCallback, IUniswapV3SwapCallba
     }
 
     /// @notice Uniswap V3 swap callback — delegates to JBSwapPoolLib (via DELEGATECALL) to reduce bytecode.
-    /// @param amount0Delta The amount of token0 being used for the swap.
-    /// @param amount1Delta The amount of token1 being used for the swap.
+    /// @param amount0Delta The amount of token0 used for the swap.
+    /// @param amount1Delta The amount of token1 used for the swap.
     /// @param data Encoded (originalTokenIn, normalizedTokenIn, normalizedTokenOut).
     function uniswapV3SwapCallback(int256 amount0Delta, int256 amount1Delta, bytes calldata data) external override {
         JBSwapPoolLib.executeV3SwapCallback({
@@ -502,7 +502,7 @@ contract JBSwapCCIPSucker is JBCCIPSucker, IUnlockCallback, IUniswapV3SwapCallba
     /// Delegates CCIP message construction to JBCCIPLib (via DELEGATECALL) to reduce bytecode.
     /// @param transportPayment The ETH sent for CCIP fees.
     /// @param index The last leaf index in the current batch.
-    /// @param token The local token being bridged.
+    /// @param token The local token to bridge.
     /// @param amount The amount of local tokens to bridge.
     /// @param remoteToken The remote token configuration (including minGas).
     /// @param sucker_message The merkle root message to send to the remote chain.

package/src/interfaces/IJBPeerChainAdjustedAccounts.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 /// @notice Optional data-hook interface for adding project-specific adjusted accounts to peer-chain snapshots.
 interface IJBPeerChainAdjustedAccounts {
     /// @notice Extra supply, surplus, and balance that should be included in cross-chain peer snapshots.
-    /// @param projectId The ID of the project being snapshotted.
+    /// @param projectId The ID of the project to snapshot.
     /// @param decimals The decimals the returned surplus and balance should use.
     /// @param currency The currency the returned surplus and balance should be in terms of.
     /// @return supply The extra supply to include in `sourceTotalSupply`.

package/src/interfaces/IJBSucker.sol

@@ -61,8 +61,8 @@ interface IJBSucker is IERC165 {
     event NewInboxTreeRoot(address indexed token, uint64 nonce, bytes32 root, address caller);
 
     /// @notice Emitted when the outbox tree root and bridged assets are sent to the remote peer.
-    /// @param root The outbox tree root being sent.
-    /// @param token The terminal token being bridged.
+    /// @param root The outbox tree root sent to the remote peer.
+    /// @param token The terminal token to bridge.
     /// @param index The current outbox tree index.
     /// @param nonce The nonce assigned to this root message.
     /// @param caller The address that initiated the send.

package/src/interfaces/IL1ArbitrumGateway.sol

@@ -7,7 +7,7 @@ interface IL1ArbitrumGateway {
     /// @param _token The L1 token address.
     /// @param _from The sender on L1.
     /// @param _to The recipient on L2.
-    /// @param _amount The amount of tokens being bridged.
+    /// @param _amount The amount of tokens to bridge.
     /// @param _data Additional data (forwarded to the L2 gateway).
     /// @return The ABI-encoded calldata for `finalizeInboundTransfer` on the L2 gateway.
     function getOutboundCalldata(

package/src/libraries/JBCCIPLib.sol

@@ -25,7 +25,7 @@ library JBCCIPLib {
     /// @param token The token to bridge (may be NATIVE_TOKEN).
     /// @param amount The amount to bridge.
     /// @return tokenAmounts The CCIP token amounts array (length 0 or 1).
-    /// @return bridgeToken The actual ERC-20 token address being bridged (WETH if native was wrapped).
+    /// @return bridgeToken The actual ERC-20 token address to bridge (WETH if native was wrapped).
     function prepareTokenAmounts(
         ICCIPRouter ccipRouter,
         address token,

package/src/libraries/JBRelayBeneficiary.sol

@@ -19,7 +19,7 @@ library JBRelayBeneficiary {
     /// @dev Returns `beneficiary` unchanged if the payer is not a registered sucker or if no relay data is found.
     /// @param payer The address that called `terminal.pay()` (i.e. `context.payer`).
     /// @param beneficiary The beneficiary set in the payment context (i.e. `context.beneficiary`).
-    /// @param projectId The project being paid.
+    /// @param projectId The project to pay.
     /// @param metadata The payment metadata (`context.payerMetadata` or `context.metadata`).
     /// @param registry The sucker registry used to verify that `payer` is a legitimate sucker.
     /// @return effectiveBeneficiary The resolved beneficiary — the relay address if valid, or the original.

package/src/libraries/JBSuckerLib.sol

@@ -227,7 +227,7 @@ library JBSuckerLib {
     /// @param prices The price oracle to use for non-ETH terminal-token balances.
     /// @param projectId The project ID.
     /// @param remoteToken The remote token bytes32 address.
-    /// @param amount The amount of terminal tokens being bridged.
+    /// @param amount The amount of terminal tokens to bridge.
     /// @param nonce The outbox nonce for this send.
     /// @param root The merkle root of the outbox tree.
     /// @param messageVersion The message format version.
@@ -269,8 +269,8 @@ library JBSuckerLib {
     /// @notice Optional project-specific adjusted accounts to add to peer-chain snapshots.
     /// @dev Reads the current ruleset's data hook and asks it for extra supply/surplus. Non-supporting hooks,
     /// broken hooks, and short return data are ignored so a project's baseline snapshot remains usable.
-    /// @param controller The controller for the project being snapshotted.
-    /// @param projectId The project being snapshotted.
+    /// @param controller The controller for the project to snapshot.
+    /// @param projectId The project to snapshot.
     /// @return additionalSupply The supply to add to `sourceTotalSupply`.
     /// @return additionalSurplus The surplus to add to `sourceSurplus`, denominated in ETH at 18 decimals.
     /// @return additionalBalance The balance to add to `sourceBalance`, denominated in ETH at 18 decimals.
@@ -308,7 +308,7 @@ library JBSuckerLib {
     /// @notice Builds the local accounting values used in outbound peer-chain snapshots.
     /// @param directory The JB directory to look up controllers and terminals.
     /// @param prices The price oracle to use for non-ETH terminal-token balances.
-    /// @param projectId The project being snapshotted.
+    /// @param projectId The project to snapshot.
     /// @return localTotalSupply The total project token supply, including reserved tokens.
     /// @return ethSurplus The terminal surplus denominated in ETH at 18 decimals.
     /// @return ethBalance The terminal balance denominated in ETH at 18 decimals.

package/src/libraries/JBSwapLib.sol

@@ -54,7 +54,7 @@ library JBSwapLib {
     //*********************************************************************//
 
     /// @notice Estimate the price impact of a swap, scaled by IMPACT_PRECISION.
-    /// @param amountIn The amount of tokens being swapped in.
+    /// @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.
@@ -84,7 +84,7 @@ library JBSwapLib {
 
     /// @notice Compute a sqrtPriceLimitX96 from input/output amounts so the swap stops
     ///         if the execution price would be worse than the minimum acceptable rate.
-    /// @param amountIn The amount of tokens being swapped in.
+    /// @param amountIn The amount of tokens to swap in.
     /// @param minimumAmountOut The minimum acceptable output.
     /// @param zeroForOne True when selling token0 for token1 (price decreases).
     /// @return sqrtPriceLimit The V3-compatible sqrtPriceLimitX96.

package/src/libraries/JBSwapPoolLib.sol

@@ -260,8 +260,8 @@ library JBSwapPoolLib {
     /// `uniswapV3SwapCallback` so the V3 callback logic lives in library bytecode.
     /// @dev DELEGATECALL preserves msg.sender (the V3 pool), allowing pool verification.
     /// @param v3Factory The Uniswap V3 factory for pool verification.
-    /// @param amount0Delta The amount of token0 being used for the swap.
-    /// @param amount1Delta The amount of token1 being used for the swap.
+    /// @param amount0Delta The amount of token0 used for the swap.
+    /// @param amount1Delta The amount of token1 used for the swap.
     /// @param data Encoded (originalTokenIn, normalizedTokenIn, normalizedTokenOut).
     function executeV3SwapCallback(
         IUniswapV3Factory v3Factory,

package/src/structs/JBMessageRoot.sol

@@ -6,7 +6,7 @@ import {JBInboxTreeRoot} from "./JBInboxTreeRoot.sol";
 /// @notice Information about the remote (inbox) tree's root, passed in a message from the remote chain.
 /// @custom:member version The message format version. Used to reject incompatible messages.
 /// @custom:member token The remote token address (bytes32 for cross-VM compatibility with SVM).
-/// @custom:member amount The amount of tokens being sent.
+/// @custom:member amount The amount of tokens to send.
 /// @custom:member remoteRoot The root of the merkle tree.
 /// @custom:member sourceTotalSupply The total token supply (including reserved tokens) on the source chain at the
 /// time the message was sent. Used by the receiving chain to track cross-chain supply for cash out tax calculations.