CCIP v1.5.1 API Reference
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
- RateLimiter - Contract for managing rate limits on token transfers
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
- BurnMintERC20 - Implementation for burning and minting ERC20 tokens
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