CCIP v1.5.1 Pool Library API Reference

Pool

A library that provides core data structures and constants for token pool operations in cross-chain transfers.

Git Source

Structs

LockOrBurnInV1

Input parameters for locking or burning tokens in cross-chain transfers.

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

LockOrBurnOutV1

Output data from a lock or burn operation.

struct LockOrBurnOutV1 {
  bytes destTokenAddress;
  bytes destPoolData;
}

ReleaseOrMintInV1

Input parameters for releasing or minting tokens in cross-chain transfers.

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

ReleaseOrMintOutV1

Output data from a release or mint operation.

struct ReleaseOrMintOutV1 {
  uint256 destinationAmount;
}

State Variables

CCIP_POOL_V1

bytes4 public constant CCIP_POOL_V1 = 0xaff2afbf;

CCIP_POOL_V1_RET_BYTES

uint16 public constant CCIP_POOL_V1_RET_BYTES = 32;

CCIP_LOCK_OR_BURN_V1_RET_BYTES

uint32 public constant CCIP_LOCK_OR_BURN_V1_RET_BYTES = 32;