API Version: v1.6.2

CCIP v1.6.2 API Reference

Integrate Chainlink CCIP v1.6.2 into your project

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

npm install @chainlink/contracts-ccip@1.6.2

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/"

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

yarn add @chainlink/contracts-ccip@1.6.2

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/"

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.2

Using yarn:

yarn add @chainlink/contracts-ccip@1.6.2

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@0e3e0fc5c0f70f0d50dca66b139142ddf3009294 \
  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/"

API References

Core Components

CCIPReceiver - Base contract for receiving CCIP messages
Client - Library providing structs and types for building CCIP messages
IRouterClient - Interface for sending messages through CCIP
Pool - Library providing token pool functions for cross-chain operations
RateLimiter - Contract for managing rate limits on token transfers
TypeAndVersion - Interface for contract versioning

Token Pools

BurnFromMintTokenPool - Implementation using burnFrom(address, amount) for token burning
BurnMintERC20 - Implementation for burning and minting ERC20 tokens
BurnMintTokenPool - Implementation using burn(amount) for token burning
BurnMintTokenPoolAbstract - Abstract contract for burn/mint token handling
LockReleaseTokenPool - Implementation for locking and releasing tokens on their native chain
TokenPool - Base abstract class defining common functionality for all token pools

Access Control

Ownable2Step - Base contract implementing secure two-step ownership transfer
Ownable2StepMsgSender - Extension of Ownable2Step that sets msg.sender as initial owner

Registry Components

RegistryModuleOwnerCustom - Registry module for token admin registration
TokenAdminRegistry - Contract for storing token pool configurations

Error Handling

Errors - Comprehensive list of CCIP error codes and their descriptions

CCIP v1.6.2 API Reference

API References

Core Components

Token Pools

Access Control

Registry Components

Error Handling

Get the latest Chainlink content straight to your inbox.