CCIP v1.5.1 API Reference

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