API Version: v1.6.3

CCIP v1.6.3 Events API Reference

Integrate Chainlink CCIP v1.6.3 into your project

If you use NPM, install the @chainlink/contracts-ccip NPM package:

npm install @chainlink/contracts-ccip@1.6.3

If you use Yarn, install the @chainlink/contracts-ccip NPM package:

yarn add @chainlink/contracts-ccip@1.6.3

In your Foundry project, for easier integration, if you want to avoid installing the dependencies that are only used by the chainlink-ccip package, you can use either NPM or Yarn to install the chainlink-ccip package:

Using npm:

npm install @chainlink/contracts-ccip@1.6.3

Using yarn:

yarn add @chainlink/contracts-ccip@1.6.3

Then, add the following remappings to your remappings.txt or foundry.toml file:

"@chainlink/contracts-ccip/contracts/=node_modules/@chainlink/contracts-ccip/contracts/",
"@chainlink/contracts/=node_modules/@chainlink/contracts/",
"@openzeppelin/contracts@4.8.3/=node_modules/@openzeppelin/contracts-4.8.3/",
"@openzeppelin/contracts@5.0.2/=node_modules/@openzeppelin/contracts-5.0.2/"

Alternatively, if you prefer to use only forge install, install the chainlink-ccip package along with its dependencies:

forge install \
  smartcontractkit/chainlink-ccip@279b542b5c23646fd3dbbde5ca7c46ca501cb6df \
  smartcontractkit/chainlink-evm@86aa5a1d34b20eda8d18fe6eb0e4882948e545ba  \
  openzeppelin/openzeppelin-contracts@0a25c1940ca220686588c4af3ec526f725fe2582 \
  openzeppelin/openzeppelin-contracts@dbb6104ce834628e473d2173bbc9d47f81a9eec3

Then set the remappings as follows:

"@chainlink/contracts-ccip/contracts/=lib/chainlink-ccip/chains/evm/contracts/",
"@chainlink/contracts/=lib/chainlink-evm/contracts/",
"@openzeppelin/contracts@4.8.3/=lib/openzeppelin-contracts/contracts/",
"@openzeppelin/contracts@5.0.2/=lib/openzeppelin-contracts/contracts/"

When invoking the ccipSend function or when a message is executed via ccipReceive, various events are emitted by CCIP contracts. Below is a compiled list of events you can expect during CCIP operations.

`ccipSend`

These events are emitted when sending a cross-chain message using the ccipSend function.

OnRamp

Event	Parameters	Description
CCIPMessageSent	- indexed uint64 destChainSelector - indexed uint64 sequenceNumber - Internal.EVM2AnyRampMessage message	Emitted when a CCIP message is successfully sent.

Token Pool (Send)

Event	Parameters	Description
LockedOrBurned	- indexed uint64 remoteChainSelector - address token - address sender - uint256 amount	Emitted when tokens are locked or burned during a cross-chain transfer.
OutboundRateLimitConsumed	- indexed uint64 remoteChainSelector - address token - uint256 amount	Emitted when outbound rate limit capacity is consumed for a token transfer.

`ccipReceive`

These events are emitted when a cross-chain message is executed on the destination chain.

OffRamp

Event	Parameters	Description
ExecutionStateChanged	- indexed uint64 sourceChainSelector - indexed uint64 sequenceNumber - indexed bytes32 messageId - bytes32 messageHash - Internal.MessageExecutionState state - bytes returnData - uint256 gasUsed	Emitted when a message execution state changes to SUCCESS or FAILURE.

Router

Event	Parameters	Description
MessageExecuted	- bytes32 messageId - uint64 sourceChainSelector - address offRamp - bytes32 calldataHash	Emitted when the Router successfully routes a message to the receiver.

Token Pool (Receive)

Event	Parameters	Description
ReleasedOrMinted	- indexed uint64 remoteChainSelector - address token - address sender - address recipient - uint256 amount	Emitted when tokens are released or minted to the receiver on the destination chain.
InboundRateLimitConsumed	- indexed uint64 remoteChainSelector - address token - uint256 amount	Emitted when inbound rate limit capacity is consumed for a token transfer.