API Version:

You are viewing documentation for v1.5.0. Switch to latest (v1.5.1)

CCIP v1.5.0 API Reference

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

npm install @chainlink/contracts-ccip@1.5.0

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

yarn add @chainlink/contracts-ccip@1.5.0

If you use Foundry, install the package:

forge install smartcontractkit/ccip@5c711214167b7e6f05cf6de74bdab9f6e26763b2

API References

Core Components

Client - Library providing structs and types for building CCIP messages
CCIPReceiver - Base contract for receiving CCIP messages
IRouterClient - Interface for sending messages through CCIP
Pool - Library providing token pool functions for cross-chain operations

Token Pools

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

Registry Components

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

Error Handling

Errors - Comprehensive list of CCIP error codes and their descriptions