CCIP v1.5.1 Internal Library API Reference

Internal

A library for CCIP internal definitions common to multiple contracts. Provides core data structures and utilities for cross-chain message processing.

Git Source

Errors

InvalidEVMAddress

error InvalidEVMAddress(bytes encodedAddress);

Parameters

Enums

MessageExecutionState

Enum listing the possible message execution states within the offRamp contract.

enum MessageExecutionState {
  UNTOUCHED,
  IN_PROGRESS,
  SUCCESS,
  FAILURE
}

OCRPluginType

CCIP OCR plugin type, used to separate execution & commit transmissions and configs.

enum OCRPluginType {
  Commit,
  Execution
}

Structs

PriceUpdates

A collection of token price and gas price updates.

struct PriceUpdates {
  TokenPriceUpdate[] tokenPriceUpdates;
  GasPriceUpdate[] gasPriceUpdates;
}

Properties

TokenPriceUpdate

Token price in USD.

struct TokenPriceUpdate {
  address sourceToken;
  uint224 usdPerToken;
}

Properties

GasPriceUpdate

Gas price for a given chain in USD, its value may contain tightly packed fields.

struct GasPriceUpdate {
  uint64 destChainSelector;
  uint224 usdPerUnitGas;
}

Properties

TimestampedPackedUint224

A timestamped uint224 value that can contain several tightly packed fields.

struct TimestampedPackedUint224 {
  uint224 value;
  uint32 timestamp;
}

Properties

PoolUpdate

Structure for token pool updates.

struct PoolUpdate {
  address token;
  address pool;
}

Properties

SourceTokenData

Structure containing token-specific data from the source chain.

struct SourceTokenData {
  bytes sourcePoolAddress;
  bytes destTokenAddress;
  bytes extraData;
  uint32 destGasAmount;
}

Properties

ExecutionReportSingleChain

Report submitted by the execution DON at the execution phase (including chain selector data).

struct ExecutionReportSingleChain {
  uint64 sourceChainSelector;
  Any2EVMRampMessage[] messages;
  bytes[][] offchainTokenData;
  bytes32[] proofs;
  uint256 proofFlagBits;
}

Properties

ExecutionReport

Report submitted by the execution DON at the execution phase.

struct ExecutionReport {
  EVM2EVMMessage[] messages;
  bytes[][] offchainTokenData;
  bytes32[] proofs;
  uint256 proofFlagBits;
}

Properties

EVM2EVMMessage

The cross chain message that gets committed to EVM chains.

struct EVM2EVMMessage {
  uint64 sourceChainSelector;
  address sender;
  address receiver;
  uint64 sequenceNumber;
  uint256 gasLimit;
  bool strict;
  uint64 nonce;
  address feeToken;
  uint256 feeTokenAmount;
  bytes data;
  Client.EVMTokenAmount[] tokenAmounts;
  bytes[] sourceTokenData;
  bytes32 messageId;
}

Properties

RampMessageHeader

Family-agnostic header for OnRamp & OffRamp messages.

struct RampMessageHeader {
  bytes32 messageId;
  uint64 sourceChainSelector;
  uint64 destChainSelector;
  uint64 sequenceNumber;
  uint64 nonce;
}

Properties

EVM2AnyTokenTransfer

Structure representing token transfers from EVM chains to any destination chain.

struct EVM2AnyTokenTransfer {
  address sourcePoolAddress;
  bytes destTokenAddress;
  bytes extraData;
  uint256 amount;
  bytes destExecData;
}

Properties

Any2EVMTokenTransfer

Structure representing token transfers from any source chain to EVM chains.

struct Any2EVMTokenTransfer {
  bytes sourcePoolAddress;
  address destTokenAddress;
  uint32 destGasAmount;
  bytes extraData;
  uint256 amount;
}

Properties

Any2EVMRampMessage

Family-agnostic message routed to an OffRamp.

struct Any2EVMRampMessage {
  RampMessageHeader header;
  bytes sender;
  bytes data;
  address receiver;
  uint256 gasLimit;
  Any2EVMTokenTransfer[] tokenAmounts;
}

Properties

EVM2AnyRampMessage

Family-agnostic message emitted from the OnRamp.

struct EVM2AnyRampMessage {
  RampMessageHeader header;
  address sender;
  bytes data;
  bytes receiver;
  bytes extraArgs;
  address feeToken;
  uint256 feeTokenAmount;
  uint256 feeValueJuels;
  EVM2AnyTokenTransfer[] tokenAmounts;
}

Properties

MerkleRoot

Struct to hold a merkle root and an interval for a source chain.

struct MerkleRoot {
  uint64 sourceChainSelector;
  bytes onRampAddress;
  uint64 minSeqNr;
  uint64 maxSeqNr;
  bytes32 merkleRoot;
}

Properties

State Variables

GAS_FOR_CALL_EXACT_CHECK

uint16 internal constant GAS_FOR_CALL_EXACT_CHECK = 5_000;

MAX_RET_BYTES

uint16 internal constant MAX_RET_BYTES = 4 + 4 * 32;

MAX_BALANCE_OF_RET_BYTES

uint256 internal constant MAX_BALANCE_OF_RET_BYTES = 32;

GAS_PRICE_BITS

uint8 public constant GAS_PRICE_BITS = 112;

MESSAGE_FIXED_BYTES

uint256 public constant MESSAGE_FIXED_BYTES = 32 * 17;

MESSAGE_FIXED_BYTES_PER_TOKEN

uint256 public constant MESSAGE_FIXED_BYTES_PER_TOKEN = 32 * ((1 + 3 * 3) + 2);

ANY_2_EVM_MESSAGE_FIXED_BYTES

uint256 public constant ANY_2_EVM_MESSAGE_FIXED_BYTES = 32 * 14;

ANY_2_EVM_MESSAGE_FIXED_BYTES_PER_TOKEN

uint256 public constant ANY_2_EVM_MESSAGE_FIXED_BYTES_PER_TOKEN = 32 * ((2 * 3) + 3);

EVM_2_EVM_MESSAGE_HASH

bytes32 internal constant EVM_2_EVM_MESSAGE_HASH = keccak256("EVM2EVMMessageHashV2");

ANY_2_EVM_MESSAGE_HASH

bytes32 internal constant ANY_2_EVM_MESSAGE_HASH = keccak256("Any2EVMMessageHashV1");

EVM_2_ANY_MESSAGE_HASH

bytes32 internal constant EVM_2_ANY_MESSAGE_HASH = keccak256("EVM2AnyMessageHashV1");

CHAIN_FAMILY_SELECTOR_EVM

bytes4 public constant CHAIN_FAMILY_SELECTOR_EVM = 0x2812d52c;

PRECOMPILE_SPACE

uint256 public constant PRECOMPILE_SPACE = 1024;

Functions

_hash (EVM2EVMMessage)

function _hash(
  EVM2EVMMessage memory original,
  bytes32 metadataHash
) internal pure returns (bytes32);

Parameters

Returns

_hash (Any2EVMRampMessage)

function _hash(
  Any2EVMRampMessage memory original,
  bytes32 metadataHash
) internal pure returns (bytes32);

Parameters

Returns

_hash (EVM2AnyRampMessage)

function _hash(
  EVM2AnyRampMessage memory original,
  bytes32 metadataHash
) internal pure returns (bytes32);

Parameters

Returns

_validateEVMAddress

function _validateEVMAddress(
  bytes memory encodedAddress
) internal pure returns (address);

Parameters

Returns