CLRUSDTokenPool
Source: defined outside contracts/ · Guide: savings
Network
Chain id
Address
Base Sepolia
84532
Ethereum Sepolia
11155111
Functions that change state
Function
Who can call
Also
acceptOwnership()The pending owner
addRemotePool(uint64 remoteChainSelector, bytes remotePoolAddress)Defined outside
contracts/applyAllowListUpdates(address[] removes, address[] adds)Defined outside
contracts/applyChainUpdates(uint64[] remoteChainSelectorsToRemove, (uint64,bytes[],bytes,(bool,uint128,uint128),(bool,uint128,uint128))[] chainsToAdd)Defined outside
contracts/lockOrBurn((bytes,uint64,address,uint256,address) lockOrBurnIn)Defined outside
contracts/releaseOrMint((bytes,uint64,address,uint256,address,bytes,bytes,bytes) releaseOrMintIn)Defined outside
contracts/removeRemotePool(uint64 remoteChainSelector, bytes remotePoolAddress)Defined outside
contracts/setChainRateLimiterConfig(uint64 remoteChainSelector, (bool,uint128,uint128) outboundConfig, (bool,uint128,uint128) inboundConfig)Defined outside
contracts/setChainRateLimiterConfigs(uint64[] remoteChainSelectors, (bool,uint128,uint128)[] outboundConfigs, (bool,uint128,uint128)[] inboundConfigs)Defined outside
contracts/setRateLimitAdmin(address rateLimitAdmin)Defined outside
contracts/setRouter(address newRouter)Defined outside
contracts/transferOwnership(address to)The owner
Read functions
Anyone can call these; they change nothing.
Function
Returns
getAllowList()address[]
getAllowListEnabled()bool
getCurrentInboundRateLimiterState(uint64 remoteChainSelector)(uint128,uint32,bool,uint128,uint128)
getCurrentOutboundRateLimiterState(uint64 remoteChainSelector)(uint128,uint32,bool,uint128,uint128)
getRateLimitAdmin()address
getRemotePools(uint64 remoteChainSelector)bytes[]
getRemoteToken(uint64 remoteChainSelector)bytes
getRmnProxy()address rmnProxy
getRouter()address router
getSupportedChains()uint64[]
getToken()address token
getTokenDecimals()uint8 decimals
isRemotePool(uint64 remoteChainSelector, bytes remotePoolAddress)bool
isSupportedChain(uint64 remoteChainSelector)bool
isSupportedToken(address token)bool
owner()address
supportsInterface(bytes4 interfaceId)bool
typeAndVersion()string
Events
Event
AllowListAdd(address sender)AllowListRemove(address sender)ChainAdded(uint64 remoteChainSelector, bytes remoteToken, (bool,uint128,uint128) outboundRateLimiterConfig, (bool,uint128,uint128) inboundRateLimiterConfig)ChainConfigured(uint64 remoteChainSelector, (bool,uint128,uint128) outboundRateLimiterConfig, (bool,uint128,uint128) inboundRateLimiterConfig)ChainRemoved(uint64 remoteChainSelector)ConfigChanged((bool,uint128,uint128) config)InboundRateLimitConsumed(uint64 remoteChainSelector indexed, address token, uint256 amount)LockedOrBurned(uint64 remoteChainSelector indexed, address token, address sender, uint256 amount)OutboundRateLimitConsumed(uint64 remoteChainSelector indexed, address token, uint256 amount)OwnershipTransferred(address from indexed, address to indexed)OwnershipTransferRequested(address from indexed, address to indexed)RateLimitAdminSet(address rateLimitAdmin)ReleasedOrMinted(uint64 remoteChainSelector indexed, address token, address sender, address recipient, uint256 amount)RemotePoolAdded(uint64 remoteChainSelector indexed, bytes remotePoolAddress)RemotePoolRemoved(uint64 remoteChainSelector indexed, bytes remotePoolAddress)RouterUpdated(address oldRouter, address newRouter)Errors
Error
AllowListNotEnabled()BucketOverfilled()CallerIsNotARampOnRouter(address caller)CannotTransferToSelf()ChainAlreadyExists(uint64 chainSelector)ChainNotAllowed(uint64 remoteChainSelector)CursedByRMN()DisabledNonZeroRateLimit((bool,uint128,uint128) config)InvalidDecimalArgs(uint8 expected, uint8 actual)InvalidRateLimitRate((bool,uint128,uint128) rateLimiterConfig)InvalidRemoteChainDecimals(bytes sourcePoolData)InvalidRemotePoolForChain(uint64 remoteChainSelector, bytes remotePoolAddress)InvalidSourcePoolAddress(bytes sourcePoolAddress)InvalidToken(address token)MismatchedArrayLengths()MustBeProposedOwner()NonExistentChain(uint64 remoteChainSelector)OnlyCallableByOwner()OverflowDetected(uint8 remoteDecimals, uint8 localDecimals, uint256 remoteAmount)OwnerCannotBeZero()PoolAlreadyAdded(uint64 remoteChainSelector, bytes remotePoolAddress)SenderNotAllowed(address sender)TokenMaxCapacityExceeded(uint256 capacity, uint256 requested, address tokenAddress)TokenRateLimitReached(uint256 minWaitInSeconds, uint256 available, address tokenAddress)Unauthorized(address caller)ZeroAddressNotAllowed()