@bananapus/suckers-v6 0.0.1

package/src/libraries/ARBAddresses.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice Global constants used across Juicebox contracts.
+library ARBAddresses {
+    /// @notice The respective Inbox used by L1 or Testnet L1
+    address public constant L1_ETH_INBOX = 0x4Dbd4fc535Ac27206064B68FfCf827b0A60BAB3f;
+    address public constant L1_SEP_INBOX = 0xaAe29B0366299461418F5324a79Afc425BE5ae21;
+
+    /// @notice The gateway router used to bridge tokens between the local and remote chain.
+    address public constant L1_GATEWAY_ROUTER = 0x72Ce9c846789fdB6fC1f34aC4AD25Dd9ef7031ef;
+    address public constant L2_GATEWAY_ROUTER = 0x5288c571Fd7aD117beA99bF60FE0846C4E84F933;
+
+    /// @notice The testnet gateway routers used for bridging tokens.
+    address public constant L1_SEP_GATEWAY_ROUTER = 0xcE18836b233C83325Cc8848CA4487e94C6288264;
+    address public constant L2_SEP_GATEWAY_ROUTER = 0x9fDD1C4E4AA24EEc1d913FABea925594a20d43C7;
+}

package/src/libraries/ARBChains.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice Global constants used across Juicebox contracts.
+library ARBChains {
+    /// @notice Arbitrum relevant chains and their respective ids.
+    uint256 public constant ETH_CHAINID = 1;
+    uint256 public constant ETH_SEP_CHAINID = 11_155_111;
+    uint256 public constant ARB_CHAINID = 42_161;
+    uint256 public constant ARB_SEP_CHAINID = 421_614;
+}

package/src/libraries/CCIPHelper.sol

@@ -0,0 +1,136 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.23;
+
+/// @notice CCIP chain-specific constants used across Juicebox sucker contracts.
+library CCIPHelper {
+    error CCIPHelper_UnsupportedChain(uint256 chainId);
+    /// @notice The respective CCIP router used by the chain
+    address public constant ETH_ROUTER = 0x80226fc0Ee2b096224EeAc085Bb9a8cba1146f7D;
+    address public constant ETH_SEP_ROUTER = 0x0BF3dE8c5D3e8A2B34D2BEeB17ABfCeBaf363A59;
+    address public constant OP_ROUTER = 0x3206695CaE29952f4b0c22a169725a865bc8Ce0f;
+    address public constant OP_SEP_ROUTER = 0x114A20A10b43D4115e5aeef7345a1A71d2a60C57;
+    address public constant ARB_ROUTER = 0x141fa059441E0ca23ce184B6A78bafD2A517DdE8;
+    address public constant ARB_SEP_ROUTER = 0x2a9C5afB0d0e4BAb2BCdaE109EC4b0c4Be15a165;
+    address public constant POLY_ROUTER = 0x849c5ED5a80F5B408Dd4969b78c2C8fdf0565Bfe;
+    address public constant AVA_ROUTER = 0xF4c7E640EdA248ef95972845a62bdC74237805dB;
+    address public constant BNB_ROUTER = 0x34B03Cb9086d7D758AC55af71584F81A598759FE;
+    address public constant BASE_ROUTER = 0x881e3A65B4d4a04dD529061dd0071cf975F58bCD;
+    address public constant BASE_SEP_ROUTER = 0xD3b06cEbF099CE7DA4AcCf578aaebFDBd6e88a93;
+
+    /// @notice The respective chain ids per network
+    uint256 public constant ETH_ID = 1;
+    uint256 public constant ETH_SEP_ID = 11_155_111;
+    uint256 public constant OP_ID = 10;
+    uint256 public constant OP_SEP_ID = 11_155_420;
+    uint256 public constant ARB_ID = 42_161;
+    uint256 public constant ARB_SEP_ID = 421_614;
+    uint256 public constant POLY_ID = 137;
+    uint256 public constant AVA_ID = 43_114;
+    uint256 public constant BNB_ID = 56;
+    uint256 public constant BASE_ID = 8453;
+    uint256 public constant BASE_SEP_ID = 84_532;
+
+    /// @notice The chain selector per network
+    uint64 public constant ETH_SEL = 5_009_297_550_715_157_269;
+    uint64 public constant ETH_SEP_SEL = 16_015_286_601_757_825_753;
+    uint64 public constant OP_SEL = 3_734_403_246_176_062_136;
+    uint64 public constant OP_SEP_SEL = 5_224_473_277_236_331_295;
+    uint64 public constant ARB_SEL = 4_949_039_107_694_359_620;
+    uint64 public constant ARB_SEP_SEL = 3_478_487_238_524_512_106;
+    uint64 public constant POLY_SEL = 4_051_577_828_743_386_545;
+    uint64 public constant AVA_SEL = 6_433_500_567_565_415_381;
+    uint64 public constant BNB_SEL = 11_344_663_589_394_136_015;
+    uint64 public constant BASE_SEL = 15_971_525_489_660_198_786;
+    uint64 public constant BASE_SEP_SEL = 10_344_971_235_874_465_080;
+
+    /// @notice The WETH address of each chain
+    address public constant ETH_WETH = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
+    address public constant ETH_SEP_WETH = 0x097D90c9d3E0B50Ca60e1ae45F6A81010f9FB534;
+    address public constant OP_WETH = 0x4200000000000000000000000000000000000006;
+    address public constant ARB_WETH = 0x82aF49447D8a07e3bd95BD0d56f35241523fBab1;
+    address public constant ARB_SEP_WETH = 0xE591bf0A0CF924A0674d7792db046B23CEbF5f34;
+    address public constant POLY_WETH = 0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270;
+    address public constant AVA_WETH = 0xB31f66AA3C1e785363F0875A1B74E27b85FD66c7;
+    address public constant BNB_WETH = 0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c;
+    address public constant BASE_WETH = 0x4200000000000000000000000000000000000006;
+
+    function routerOfChain(uint256 _chainId) internal pure returns (address router) {
+        if (_chainId == ETH_ID) {
+            return ETH_ROUTER;
+        } else if (_chainId == OP_ID) {
+            return OP_ROUTER;
+        } else if (_chainId == ARB_ID) {
+            return ARB_ROUTER;
+        } else if (_chainId == POLY_ID) {
+            return POLY_ROUTER;
+        } else if (_chainId == AVA_ID) {
+            return AVA_ROUTER;
+        } else if (_chainId == BNB_ID) {
+            return BNB_ROUTER;
+        } else if (_chainId == BASE_ID) {
+            return BASE_ROUTER;
+        } else if (_chainId == ETH_SEP_ID) {
+            return ETH_SEP_ROUTER;
+        } else if (_chainId == ARB_SEP_ID) {
+            return ARB_SEP_ROUTER;
+        } else if (_chainId == OP_SEP_ID) {
+            return OP_SEP_ROUTER;
+        } else if (_chainId == BASE_SEP_ID) {
+            return BASE_SEP_ROUTER;
+        } else {
+            revert CCIPHelper_UnsupportedChain(_chainId);
+        }
+    }
+
+    function selectorOfChain(uint256 _chainId) internal pure returns (uint64 selectorId) {
+        if (_chainId == ETH_ID) {
+            return ETH_SEL;
+        } else if (_chainId == OP_ID) {
+            return OP_SEL;
+        } else if (_chainId == ARB_ID) {
+            return ARB_SEL;
+        } else if (_chainId == POLY_ID) {
+            return POLY_SEL;
+        } else if (_chainId == AVA_ID) {
+            return AVA_SEL;
+        } else if (_chainId == BNB_ID) {
+            return BNB_SEL;
+        } else if (_chainId == BASE_ID) {
+            return BASE_SEL;
+        } else if (_chainId == ETH_SEP_ID) {
+            return ETH_SEP_SEL;
+        } else if (_chainId == ARB_SEP_ID) {
+            return ARB_SEP_SEL;
+        } else if (_chainId == OP_SEP_ID) {
+            return OP_SEP_SEL;
+        } else if (_chainId == BASE_SEP_ID) {
+            return BASE_SEP_SEL;
+        } else {
+            revert CCIPHelper_UnsupportedChain(_chainId);
+        }
+    }
+
+    function wethOfChain(uint256 _chainId) public pure returns (address weth) {
+        if (_chainId == ETH_ID) {
+            return ETH_WETH;
+        } else if (_chainId == OP_ID) {
+            return OP_WETH;
+        } else if (_chainId == ARB_ID) {
+            return ARB_WETH;
+        } else if (_chainId == POLY_ID) {
+            return POLY_WETH;
+        } else if (_chainId == AVA_ID) {
+            return AVA_WETH;
+        } else if (_chainId == BNB_ID) {
+            return BNB_WETH;
+        } else if (_chainId == BASE_ID) {
+            return BASE_WETH;
+        } else if (_chainId == ETH_SEP_ID) {
+            return ETH_SEP_WETH;
+        } else if (_chainId == ARB_SEP_ID) {
+            return ARB_SEP_WETH;
+        } else {
+            revert CCIPHelper_UnsupportedChain(_chainId);
+        }
+    }
+}

package/src/structs/JBClaim.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {JBLeaf} from "./JBLeaf.sol";
+
+/// @custom:member token The token to claim.
+/// @custom:member leaf The leaf to claim from.
+/// @custom:member proof The proof to claim with. Must be of length `JBSucker._TREE_DEPTH`.
+struct JBClaim {
+    address token;
+    JBLeaf leaf;
+    bytes32[32] proof;
+}

package/src/structs/JBInboxTreeRoot.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice The root of an inbox tree for a given token in a `JBSucker`.
+/// @dev Inbox trees are used to receive from the remote chain to the local chain. Tokens can be `claim`ed from the
+/// inbox tree.
+/// @custom:member nonce Tracks the nonce of the tree. The nonce cannot decrease.
+/// @custom:member root The root of the tree.
+struct JBInboxTreeRoot {
+    uint64 nonce;
+    bytes32 root;
+}

package/src/structs/JBLeaf.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice A leaf in the inbox or outbox tree of a `JBSucker`. Used to `claim` tokens from the inbox tree.
+/// @custom:member index The index of the leaf.
+/// @custom:member beneficiary The beneficiary of the leaf.
+/// @custom:member projectTokenCount The number of project tokens to claim.
+/// @custom:member terminalTokenAmount The amount of terminal tokens to claim.
+struct JBLeaf {
+    uint256 index;
+    bytes32 beneficiary;
+    uint256 projectTokenCount;
+    uint256 terminalTokenAmount;
+}

package/src/structs/JBMessageRoot.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+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 remoteRoot The root of the merkle tree.
+struct JBMessageRoot {
+    uint8 version;
+    bytes32 token;
+    uint256 amount;
+    JBInboxTreeRoot remoteRoot;
+}

package/src/structs/JBOutboxTree.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {MerkleLib} from "../utils/MerkleLib.sol";
+
+/// @notice A merkle tree used to track the outbox for a given token in a `JBSucker`.
+/// @dev The outbox is used to send from the local chain to the remote chain.
+/// @custom:member nonce The nonce of the outbox.
+/// @custom:member balance The balance of the outbox.
+/// @custom:member tree The merkle tree.
+/// @custom:member numberOfClaimsSent the number of claims that have been sent to the peer. Used to determine which
+/// claims have been sent.
+struct JBOutboxTree {
+    uint64 nonce;
+    uint256 balance;
+    MerkleLib.Tree tree;
+    uint256 numberOfClaimsSent;
+}

package/src/structs/JBRemoteToken.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice A struct that represents a token on the remote chain.
+/// @dev Invariant: If the `emergencyHatch` is true then the `enabled` is always false.
+/// @custom:member enabled Whether the token is enabled.
+/// @custom:member emergencyHatchOpened Whether the emergency hatch is opened.
+/// @custom:member minGas The minimum gas to use when bridging.
+/// @custom:member addr The address of the token on the remote chain.
+/// @custom:member minBridgeAmount The minimum amount to bridge.
+struct JBRemoteToken {
+    bool enabled;
+    bool emergencyHatch;
+    uint32 minGas;
+    bytes32 addr;
+    uint256 minBridgeAmount;
+}

package/src/structs/JBSuckerDeployerConfig.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {IJBSuckerDeployer} from "../interfaces/IJBSuckerDeployer.sol";
+import {JBTokenMapping} from "./JBTokenMapping.sol";
+
+/// @custom:member deployer The deployer to use.
+/// @custom:member mappings The token mappings to use.
+struct JBSuckerDeployerConfig {
+    IJBSuckerDeployer deployer;
+    JBTokenMapping[] mappings;
+}

package/src/structs/JBSuckersPair.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @custom:member local The local address.
+/// @custom:member remote The remote address.
+/// @custom:member remoteChainId The chain ID of the remote address.
+struct JBSuckersPair {
+    address local;
+    bytes32 remote;
+    uint256 remoteChainId;
+}

package/src/structs/JBTokenMapping.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @custom:member localToken The local token address.
+/// @custom:member minGas The minimum gas amount to bridge.
+/// @custom:member remoteToken The remote token address.
+/// @custom:member minBridgeAmount The minimum bridge amount.
+struct JBTokenMapping {
+    address localToken;
+    uint32 minGas;
+    bytes32 remoteToken;
+    uint256 minBridgeAmount;
+}