Permissionless token pools

.changeset/healthy-years-wave.md

@@ -0,0 +1,5 @@
+---
+"ccip": minor
+---
+
+Support self serve token pools

contracts/.changeset/shy-crabs-cheat.md

@@ -0,0 +1,5 @@
+---
+"@chainlink/contracts-ccip": minor
+---
+
+permissionless token pools

contracts/gas-snapshots/rebalancer.gas-snapshot

@@ -19,20 +19,20 @@ OptimismL1BridgeAdapter_finalizeWithdrawERC20:testFinalizeWithdrawERC20Reverts()
 OptimismL1BridgeAdapter_finalizeWithdrawERC20:testfinalizeWithdrawERC20FinalizeSuccess() (gas: 16860)
 OptimismL1BridgeAdapter_finalizeWithdrawERC20:testfinalizeWithdrawERC20proveWithdrawalSuccess() (gas: 20650)
 Rebalancer__report:test_EmptyReportReverts() (gas: 11181)
-Rebalancer_addLiquidity:test_addLiquiditySuccess() (gas: 284793)
+Rebalancer_addLiquidity:test_addLiquiditySuccess() (gas: 284776)
 Rebalancer_rebalanceLiquidity:test_InsufficientLiquidityReverts() (gas: 19579)
 Rebalancer_rebalanceLiquidity:test_InvalidRemoteChainReverts() (gas: 197579)
 Rebalancer_rebalanceLiquidity:test_rebalanceBetweenPoolsSuccess() (gas: 8207096)
-Rebalancer_rebalanceLiquidity:test_rebalanceBetweenPoolsSuccess_AlreadyFinalized() (gas: 7711369)
-Rebalancer_rebalanceLiquidity:test_rebalanceLiquiditySuccess() (gas: 384907)
+Rebalancer_rebalanceLiquidity:test_rebalanceBetweenPoolsSuccess_AlreadyFinalized() (gas: 8077825)
+Rebalancer_rebalanceLiquidity:test_rebalanceLiquiditySuccess() (gas: 384924)
 Rebalancer_removeLiquidity:test_InsufficientLiquidityReverts() (gas: 191702)
 Rebalancer_removeLiquidity:test_OnlyOwnerReverts() (gas: 10923)
-Rebalancer_removeLiquidity:test_removeLiquiditySuccess() (gas: 243250)
+Rebalancer_removeLiquidity:test_removeLiquiditySuccess() (gas: 243268)
 Rebalancer_setCrossChainRebalancer:test_OnlyOwnerReverts() (gas: 16997)
 Rebalancer_setCrossChainRebalancer:test_ZeroAddressReverts() (gas: 21624)
 Rebalancer_setCrossChainRebalancer:test_ZeroChainSelectorReverts() (gas: 13099)
 Rebalancer_setCrossChainRebalancer:test_setCrossChainRebalancerSuccess() (gas: 162244)
 Rebalancer_setLocalLiquidityContainer:test_OnlyOwnerReverts() (gas: 10986)
-Rebalancer_setLocalLiquidityContainer:test_setLocalLiquidityContainerSuccess() (gas: 2887358)
+Rebalancer_setLocalLiquidityContainer:test_setLocalLiquidityContainerSuccess() (gas: 3254087)
 Rebalancer_setMinimumLiquidity:test_OnlyOwnerReverts() (gas: 10925)
 Rebalancer_setMinimumLiquidity:test_setMinimumLiquiditySuccess() (gas: 36422)

contracts/scripts/native_solc_compile_all_ccip

@@ -57,6 +57,7 @@ compileContract ccip/pools/TokenPool.sol
 compileContract shared/token/ERC677/BurnMintERC677.sol
 compileContract ccip/ARM.sol
 compileContract ccip/ARMProxy.sol
+compileContract ccip/pools/TokenAdminRegistry.sol
 
 # Test helpers
 compileContract ccip/test/helpers/BurnMintERC677Helper.sol

contracts/src/v0.8/ccip/interfaces/IEVM2AnyOnRamp.sol

@@ -3,8 +3,6 @@ pragma solidity ^0.8.0;
 
 import {IEVM2AnyOnRampClient} from "./IEVM2AnyOnRampClient.sol";
 
-import {Internal} from "../libraries/Internal.sol";
-
 interface IEVM2AnyOnRamp is IEVM2AnyOnRampClient {
   /// @notice Gets the next sequence number to be used in the onRamp
   /// @return the next sequence number to be used
@@ -14,9 +12,4 @@ interface IEVM2AnyOnRamp is IEVM2AnyOnRampClient {
   /// @param sender The sender to get the nonce for
   /// @return nonce The next nonce for the sender
   function getSenderNonce(address sender) external view returns (uint64 nonce);
-
-  /// @notice Adds and removed token pools.
-  /// @param removes The tokens and pools to be removed
-  /// @param adds The tokens and pools to be added.
-  function applyPoolUpdates(Internal.PoolUpdate[] memory removes, Internal.PoolUpdate[] memory adds) external;
 }

contracts/src/v0.8/ccip/interfaces/ITokenAdminRegistry.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+
+interface ITokenAdminRegistry {
+  /// @notice Returns the pool for the given token.
+  function getPool(address token) external view returns (address);
+
+  /// @notice Returns every token that has ever been configured. This includes tokens
+  /// that are no longer configured or do not have a pool configured.
+  function getAllConfiguredTokens() external view returns (address[] memory);
+}

contracts/src/v0.8/ccip/interfaces/pools/IPool.sol

@@ -6,41 +6,55 @@ import {IERC20} from "../../../vendor/openzeppelin-solidity/v4.8.3/contracts/tok
 // Shared public interface for multiple pool types.
 // Each pool type handles a different child token model (lock/unlock, mint/burn.)
 interface IPool {
+  struct SourceTokenData {
+    bytes sourcePoolAddress;
+    bytes destPoolAddress;
+    bytes extraData;
+  }
+
   /// @notice Lock tokens into the pool or burn the tokens.
   /// @param originalSender Original sender of the tokens.
   /// @param receiver Receiver of the tokens on destination chain.
   /// @param amount Amount to lock or burn.
   /// @param remoteChainSelector Destination chain Id.
   /// @param extraArgs Additional data passed in by sender for lockOrBurn processing
   /// in custom pools on source chain.
-  /// @return retData Optional field that contains bytes. Unused for now but already
-  /// implemented to allow future upgrades while preserving the interface.
+  /// @return poolReturnData Versioned, encoded data fields for the processing of tokens
+  /// on the destination chain.
   function lockOrBurn(
     address originalSender,
     bytes calldata receiver,
     uint256 amount,
     uint64 remoteChainSelector,
     bytes calldata extraArgs
-  ) external returns (bytes memory);
+  ) external returns (bytes memory poolReturnData);
 
   /// @notice Releases or mints tokens to the receiver address.
   /// @param originalSender Original sender of the tokens.
   /// @param receiver Receiver of the tokens.
   /// @param amount Amount to release or mint.
   /// @param remoteChainSelector Source chain Id.
-  /// @param extraData Additional data supplied offchain for releaseOrMint processing in
+  /// @param sourceTokenData The source and dest pool addresses, as well as any additional data
+  /// from calling lockOrBurn on the source chain.
+  /// @param offchainTokenData Additional data supplied offchain for releaseOrMint processing in
   /// custom pools on dest chain. This could be an attestation that was retrieved through a
   /// third party API.
   /// @dev offchainData can come from any untrusted source.
+  /// @return localToken The address of the local token.
   function releaseOrMint(
     bytes memory originalSender,
     address receiver,
     uint256 amount,
     uint64 remoteChainSelector,
-    bytes memory extraData
-  ) external;
+    SourceTokenData memory sourceTokenData,
+    bytes memory offchainTokenData
+  ) external returns (address localToken);
 
   /// @notice Gets the IERC20 token that this pool can lock or burn.
   /// @return token The IERC20 token representation.
   function getToken() external view returns (IERC20 token);
+
+  /// @notice Gets the pool address on the remote chain.
+  /// @param remoteChainSelector Destination chain selector.
+  function getRemotePool(uint64 remoteChainSelector) external view returns (bytes memory);
 }

contracts/src/v0.8/ccip/libraries/Internal.sol

@@ -65,19 +65,19 @@ library Internal {
   /// @notice The cross chain message that gets committed to EVM chains.
   /// @dev RMN depends on this struct, if changing, please notify the RMN maintainers.
   struct EVM2EVMMessage {
-    uint64 sourceChainSelector; // ─────────╮ the chain selector of the source chain, note: not chainId
-    address sender; // ─────────────────────╯ sender address on the source chain
-    address receiver; // ───────────────────╮ receiver address on the destination chain
-    uint64 sequenceNumber; // ──────────────╯ sequence number, not unique across lanes
-    uint256 gasLimit; //                      user supplied maximum gas amount available for dest chain execution
-    bool strict; // ────────────────────────╮ DEPRECATED
-    uint64 nonce; //                        │ nonce for this lane for this sender, not unique across senders/lanes
-    address feeToken; // ───────────────────╯ fee token
-    uint256 feeTokenAmount; //                fee token amount
-    bytes data; //                            arbitrary data payload supplied by the message sender
-    Client.EVMTokenAmount[] tokenAmounts; //  array of tokens and amounts to transfer
-    bytes[] sourceTokenData; //               array of token pool return values, one per token
-    bytes32 messageId; //                     a hash of the message data
+    uint64 sourceChainSelector; // ───────────╮ the chain selector of the source chain, note: not chainId
+    address sender; // ───────────────────────╯ sender address on the source chain
+    address receiver; // ─────────────────────╮ receiver address on the destination chain
+    uint64 sequenceNumber; // ────────────────╯ sequence number, not unique across lanes
+    uint256 gasLimit; //                        user supplied maximum gas amount available for dest chain execution
+    bool strict; // ──────────────────────────╮ DEPRECATED
+    uint64 nonce; //                          │ nonce for this lane for this sender, not unique across senders/lanes
+    address feeToken; // ─────────────────────╯ fee token
+    uint256 feeTokenAmount; //                  fee token amount
+    bytes data; //                              arbitrary data payload supplied by the message sender
+    Client.EVMTokenAmount[] tokenAmounts; //    array of tokens and amounts to transfer
+    bytes[] sourceTokenData; //                 array of token data, one per token
+    bytes32 messageId; //                       a hash of the message data
   }
 
   /// @dev EVM2EVMMessage struct has 13 fields, including 3 variable arrays.

contracts/src/v0.8/ccip/libraries/Pool.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+library Pool {
+  // bytes4(keccak256("POOL_RETURN_DATA_V1_TAG"))
+  bytes4 public constant POOL_RETURN_DATA_V1_TAG = 0x179fa694;
+
+  struct PoolReturnDataV1 {
+    bytes destPoolAddress;
+    bytes destPoolData;
+  }
+
+  function _generatePoolReturnDataV1(
+    bytes memory remotePoolAddress,
+    bytes memory destPoolData
+  ) internal pure returns (bytes memory) {
+    return abi.encode(PoolReturnDataV1({destPoolAddress: remotePoolAddress, destPoolData: destPoolData}));
+
+    // TODO next PR: actually use the tag
+    return abi.encodeWithSelector(
+      POOL_RETURN_DATA_V1_TAG, PoolReturnDataV1({destPoolAddress: remotePoolAddress, destPoolData: destPoolData})
+    );
+  }
+}