ICCIPTokenPoolGetters

Git Source

Title: ICCIPTokenPoolGetters

The view surface of a Chainlink CCIP TokenPool (version 1.5.1).

Set-valued getters return the values of an enumerable set, whose order changes when entries are removed. Rate limiter states are projected to the current block timestamp before being returned, so the tokens and lastUpdated fields differ from storage. Getters for an unknown chain selector return empty values rather than reverting.

Functions

owner

Returns the owner of the pool.

function owner() external view returns (address owner_);

Returns

Name	Type	Description
owner_	address	The owner.

getToken

Returns the token that the pool locks, burns, releases or mints.

function getToken() external view returns (address token);

Returns

Name	Type	Description
token	address	The token.

getTokenDecimals

Returns the decimals of the pool token on the local chain.

function getTokenDecimals() external view returns (uint8 decimals);

Returns

Name	Type	Description
decimals	uint8	The token decimals.

getRmnProxy

Returns the RMN proxy consulted for curses.

function getRmnProxy() external view returns (address rmnProxy);

Returns

Name	Type	Description
rmnProxy	address	The RMN proxy.

getRouter

Returns the router through which ramp authorization is resolved.

function getRouter() external view returns (address router);

Returns

Name	Type	Description
router	address	The router.

getRateLimitAdmin

Returns the rate limit admin, or the zero address if none is set.

function getRateLimitAdmin() external view returns (address rateLimitAdmin);

Returns

Name	Type	Description
rateLimitAdmin	address	The rate limit admin.

isSupportedChain

Returns whether a remote chain is configured on the pool.

function isSupportedChain(uint64 remoteChainSelector) external view returns (bool supported);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.

Returns

Name	Type	Description
supported	bool	True if the chain is configured.

getSupportedChains

Returns the configured remote chain selectors.

function getSupportedChains() external view returns (uint64[] memory chainSelectors);

Returns

Name	Type	Description
chainSelectors	uint64[]	The chain selectors.

getRemotePools

Returns the accepted remote pools of a remote chain.

function getRemotePools(
        uint64 remoteChainSelector
    ) external view returns (bytes[] memory remotePools);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.

Returns

Name	Type	Description
remotePools	bytes[]	The remote pool addresses.

isRemotePool

Returns whether a remote pool is accepted for a remote chain.

function isRemotePool(
        uint64 remoteChainSelector,
        bytes calldata remotePoolAddress
    ) external view returns (bool accepted);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.
remotePoolAddress	bytes	The remote pool address.

Returns

Name	Type	Description
accepted	bool	True if the remote pool is accepted.

getRemoteToken

Returns the token address on a remote chain.

function getRemoteToken(
        uint64 remoteChainSelector
    ) external view returns (bytes memory remoteToken);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.

Returns

Name	Type	Description
remoteToken	bytes	The remote token address.

getCurrentOutboundRateLimiterState

Returns the outbound token bucket of a remote chain, projected to the current block timestamp.

function getCurrentOutboundRateLimiterState(
        uint64 remoteChainSelector
    ) external view returns (ICCIPRateLimiter.TokenBucket memory bucket);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.

Returns

Name	Type	Description
bucket	ICCIPRateLimiter.TokenBucket	The outbound token bucket.

getCurrentInboundRateLimiterState

Returns the inbound token bucket of a remote chain, projected to the current block timestamp.

function getCurrentInboundRateLimiterState(
        uint64 remoteChainSelector
    ) external view returns (ICCIPRateLimiter.TokenBucket memory bucket);

Parameters

Name	Type	Description
remoteChainSelector	uint64	The chain selector of the remote chain.

Returns

Name	Type	Description
bucket	ICCIPRateLimiter.TokenBucket	The inbound token bucket.

getAllowListEnabled

Returns whether the sender allowlist is enabled. The flag is fixed at pool construction.

function getAllowListEnabled() external view returns (bool enabled);

Returns

Name	Type	Description
enabled	bool	True if the allowlist is enabled.

getAllowList

Returns the sender allowlist.

function getAllowList() external view returns (address[] memory allowList);

Returns

Name	Type	Description
allowList	address[]	The allowlisted addresses.

isSupportedToken

Returns whether the pool supports a token.

function isSupportedToken(address token) external view returns (bool supported);

Parameters

Name	Type	Description
token	address	The token.

Returns

Name	Type	Description
supported	bool	True if the token is the pool token.