NEW

CCIP is now live for all developers. See what's new.

Client Library API Reference

CCIP senders and receivers use the CCIP Client Library to build CCIP messages.

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

Types and Constants

EVMTokenAmount

Use this solidity struct to specify the token address and amount.

struct EVMTokenAmount {
  address token;
  uint256 amount;
}
NameTypeDescription
tokenaddresstoken address on the local chain.
amountuint256Amount of tokens.

Any2EVMMessage

CCIP receivers use this solidity struct to parse the received CCIP message.

struct Any2EVMMessage {
  bytes32 messageId;
  uint64 sourceChainSelector;
  bytes sender;
  bytes data;
  struct Client.EVMTokenAmount[] destTokenAmounts;
}
NameTypeDescription
messageIdbytes32CCIP messageId, generated on the source chain.
sourceChainSelectoruint64Source chain selector.
senderbytesSender address. abi.decode(sender, (address)) if the source chain is an EVM chain.
databytesPayload sent within the CCIP message.
destTokenAmountsClient.EVMTokenAmount[]Tokens and their amounts in their destination chain representation.

EVM2AnyMessage

CCIP senders use this solidity struct to build the CCIP message.

struct EVM2AnyMessage {
  bytes receiver;
  bytes data;
  struct Client.EVMTokenAmount[] tokenAmounts;
  address feeToken;
  bytes extraArgs;
}
NameTypeDescription
receiverbytesReceiver address. Use abi.encode(sender) to encode the address to bytes.
databytesPayload sent within the CCIP message.
tokenAmountsClient.EVMTokenAmount[]Tokens and their amounts in the source chain representation.
feeTokenaddressAddress of feeToken. Set address(0) to pay in native gas tokens such as ETH on Ethereum or MATIC on Polygon.
extraArgsbytesUsers fill in the EVMExtraArgsV1 struct then encode it to bytes using the _argsToBytes function

EVM_EXTRA_ARGS_V1_TAG

bytes4 EVM_EXTRA_ARGS_V1_TAG

EVMExtraArgsV1

struct EVMExtraArgsV1 {
  uint256 gasLimit;
}
NameTypeDescription
gasLimituint256specifies the maximum amount of gas CCIP can consume to execute ccipReceive() on the contract located on the destination blockchain. Read Setting gasLimit for more details.

Functions

_argsToBytes

function _argsToBytes(struct Client.EVMExtraArgsV1 extraArgs) internal pure returns (bytes bts)

It is used to convert the arguments to bytes.

Parameters

NameTypeDescription
extraArgsClient.EVMExtraArgsV1Extra arguments.

Return Values

NameTypeDescription
btsbytesEncoded extra arguments in bytes.

Stay updated on the latest Chainlink news