Pool Library API Reference

The Pool library provides various token pool functions to construct return data for cross-chain operations in Chainlink's CCIP.

import { Pool } from "@chainlink/contracts-ccip/src/v0.8/ccip/libraries/Pool.sol";

Types and Constants

CCIP_POOL_V1

The tag used to signal support for the Pool v1 standard.

bytes4 CCIP_POOL_V1

CCIP_POOL_V1_RET_BYTES

The number of bytes in the return data for a pool v1 releaseOrMint call.

uint16 CCIP_POOL_V1_RET_BYTES

CCIP_LOCK_OR_BURN_V1_RET_BYTES

The default maximum number of bytes in the return data for a pool v1 lockOrBurn call.

uint32 CCIP_LOCK_OR_BURN_V1_RET_BYTES

Structs

LockOrBurnInV1

This struct is used when locking or burning tokens for cross-chain operations.

struct LockOrBurnInV1 {
  bytes receiver;
  uint64 remoteChainSelector;
  address originalSender;
  uint256 amount;
  address localToken;
}

LockOrBurnOutV1

This struct represents the output data from a lockOrBurn call.

struct LockOrBurnOutV1 {
  bytes destTokenAddress;
  bytes destPoolData;
}

ReleaseOrMintInV1

This struct is used to release or mint tokens on the destination chain.

struct ReleaseOrMintInV1 {
  bytes originalSender;
  uint64 remoteChainSelector;
  address receiver;
  uint256 amount;
  address localToken;
  bytes sourcePoolAddress;
  bytes sourcePoolData;
  bytes offchainTokenData;
}

ReleaseOrMintOutV1

This struct represents the output data from a releaseOrMint call.

struct ReleaseOrMintOutV1 {
  uint256 destinationAmount;
}