Skip to main content
Version: 1.4.2

Interface: ApplyChainUpdatesParams

Defined in: token-admin/types.ts:721

Parameters for configuring remote chains on a token pool.

Uniform across all chain families — only poolAddress is needed. The SDK auto-discovers chain-specific details (program ID, mint, module name) from the pool account on-chain.

Example​

TypeScript
const params: ApplyChainUpdatesParams = {
  poolAddress: '0x1234...',
  remoteChainSelectorsToRemove: [],
  chainsToAdd: [{
    remoteChainSelector: 16015286601757825753n,
    remotePoolAddresses: ['0xd7BF...'],
    remoteTokenAddress: '0xa42B...',
    outboundRateLimiterConfig: { isEnabled: false, capacity: '0', rate: '0' },
    inboundRateLimiterConfig: { isEnabled: false, capacity: '0', rate: '0' },
  }],
}

Properties​

chainsToAdd​

chainsToAdd: RemoteChainConfig[]

Defined in: token-admin/types.ts:727

Remote chain configurations to add (can be empty).

poolAddress​

poolAddress: string

Defined in: token-admin/types.ts:723

Local pool address.

remoteChainSelectorsToRemove​

remoteChainSelectorsToRemove: bigint[]

Defined in: token-admin/types.ts:725

Remote chain selectors to remove (can be empty).