Skip to main content
Version: 1.17.1

Type Alias: TokenOnboardingRemoteChain

TokenOnboardingRemoteChain = { allowedFinality?: FinalityAllowed; ccvConfig?: TokenPoolCCVConfig; fastFinalityRateLimits?: { inbound: RateLimitConfig; outbound: RateLimitConfig; }; inboundRateLimiterConfig: RateLimitConfig; outboundRateLimiterConfig: RateLimitConfig; remoteChainSelector: bigint; remotePoolAddresses: string[]; remoteTokenAddress: string; remoteTokenDecimals: number; tokenTransferFeeConfig?: TokenTransferFeeConfig; }

Defined in: cct/solana/onboarding/onboard-token.ts:99

A remote chain to connect the onboarded pool to, on both its 1.6 and 2.0 lane configs.

Properties​

allowedFinality?​

optional allowedFinality?: FinalityAllowed

Defined in: cct/solana/onboarding/onboard-token.ts:116

Finality that transfers to the remote chain may request below full finality. Defaults to { finalityDepth: 0 }, full finality only.


ccvConfig?​

optional ccvConfig?: TokenPoolCCVConfig

Defined in: cct/solana/onboarding/onboard-token.ts:120

CCVs the pool requires on the lane. Defaults to none.


fastFinalityRateLimits?​

optional fastFinalityRateLimits?: { inbound: RateLimitConfig; outbound: RateLimitConfig; }

Defined in: cct/solana/onboarding/onboard-token.ts:125

Rate limits for faster-than-finality (FTF) transfers on the lane. Omit to create no FTF rate limits; the pool then applies inboundRateLimiterConfig/outboundRateLimiterConfig to them.

inbound​

inbound: RateLimitConfig

outbound​

outbound: RateLimitConfig


inboundRateLimiterConfig​

inboundRateLimiterConfig: RateLimitConfig

Defined in: cct/solana/onboarding/onboard-token.ts:109

Rate limit for tokens received from the remote chain.


outboundRateLimiterConfig​

outboundRateLimiterConfig: RateLimitConfig

Defined in: cct/solana/onboarding/onboard-token.ts:111

Rate limit for tokens sent to the remote chain.


remoteChainSelector​

remoteChainSelector: bigint

Defined in: cct/solana/onboarding/onboard-token.ts:101

CCIP selector of the remote chain (u64).


remotePoolAddresses​

remotePoolAddresses: string[]

Defined in: cct/solana/onboarding/onboard-token.ts:105

Remote pool addresses in the remote chain's own format; unique.


remoteTokenAddress​

remoteTokenAddress: string

Defined in: cct/solana/onboarding/onboard-token.ts:103

Remote token address in the remote chain's own format (0x… for EVM, base58 for Solana, …).


remoteTokenDecimals​

remoteTokenDecimals: number

Defined in: cct/solana/onboarding/onboard-token.ts:107

Remote token decimals (u8).


tokenTransferFeeConfig?​

optional tokenTransferFeeConfig?: TokenTransferFeeConfig

Defined in: cct/solana/onboarding/onboard-token.ts:118

Fees the pool charges on transfers to the remote chain. Defaults to disabled.