Class: CantonTokenManager

Defined in: cct/canton/index.ts:78

Canton CCT manager. Holds a CantonChain and exposes the CCT admin operations as methods. Each write op has a generateUnsigned<Op> (build unsigned JsCommands, no signing) and an <op> (sign + submit) variant; each read op has a single <op> method (no wallet).

Extends

• TokenManager<typeof Canton>

Constructors

Constructor

new CantonTokenManager(chain: CantonChain): CantonTokenManager

Defined in: cct/canton/index.ts:93

Creates a Canton CCT manager for an existing chain.

Parameters

Parameter	Type
chain	CantonChain

Returns

CantonTokenManager

Overrides

TokenManager<typeof ChainFamily.Canton>.constructor

Properties

chain

readonly chain: CantonChain

Defined in: cct/canton/index.ts:79

Chain this manager builds and submits through.

Overrides

TokenManager.chain

Methods

applyChainUpdates()

applyChainUpdates(opts: ExecuteApplyChainUpdatesParams): Promise<ExecuteApplyChainUpdatesResult>

Defined in: cct/canton/index.ts:146

Adds and/or removes remote-chain configs on a token pool.

Parameters

Parameter	Type
opts	ExecuteApplyChainUpdatesParams

Returns

Promise<ExecuteApplyChainUpdatesResult>

---

deployTokenPool()

deployTokenPool(opts: ExecuteDeployTokenPoolParams): Promise<CantonDeployResult>

Defined in: cct/canton/index.ts:127

Atomically deploys and initializes a BurnMintTokenPool/LockReleaseTokenPool (registry-pools family).

Parameters

Parameter	Type
opts	ExecuteDeployTokenPoolParams

Returns

Promise<CantonDeployResult>

---

generateUnsignedApplyChainUpdates()

generateUnsignedApplyChainUpdates(opts: GenerateApplyChainUpdatesParams): Promise<UnsignedCantonTx>

Defined in: cct/canton/index.ts:139

Builds unsigned applyChainUpdates commands.

Parameters

Parameter	Type
opts	GenerateApplyChainUpdatesParams

Returns

Promise<UnsignedCantonTx>

Remarks

Remote addresses are in the remote chain's own format; its chain family must be registered (e.g. import '@chainlink/ccip-sdk/all').

---

generateUnsignedDeployTokenPool()

generateUnsignedDeployTokenPool(opts: GenerateDeployTokenPoolParams): Promise<UnsignedCantonTx>

Defined in: cct/canton/index.ts:120

Builds unsigned deployTokenPool commands — a single CreateAndExercise that creates the registry-pools BurnMintTokenPool/LockReleaseTokenPool and atomically calls Initialize on it (TAR registration + lane rate limiters).

Parameters

Parameter	Type
opts	GenerateDeployTokenPoolParams

Returns

Promise<UnsignedCantonTx>

Remarks

The pool owner is instrumentId.admin and admin defaults to it; the TAR (and so ccipOwner) is deps.tokenAdminRegistry.

---

generateUnsignedSetObservers()

generateUnsignedSetObservers(opts: GenerateSetObserversParams): Promise<UnsignedCantonTx>

Defined in: cct/canton/index.ts:177

Builds unsigned setObservers commands.

Parameters

Parameter	Type
opts	GenerateSetObserversParams

Returns

Promise<UnsignedCantonTx>

---

generateUnsignedSetRateLimitConfig()

generateUnsignedSetRateLimitConfig(opts: GenerateSetRateLimitConfigParams): Promise<UnsignedCantonTx>

Defined in: cct/canton/index.ts:158

Builds unsigned setRateLimitConfig commands.

Parameters

Parameter	Type
opts	GenerateSetRateLimitConfigParams

Returns

Promise<UnsignedCantonTx>

---

getRateLimiterState()

getRateLimiterState(opts: GetRateLimiterStateParams): Promise<GetRateLimiterStateResult>

Defined in: cct/canton/index.ts:205

Reads a RateLimiter contract's config (capacity/rate/enabled/observers) from the ACS.

Parameters

Parameter	Type
opts	GetRateLimiterStateParams

Returns

Promise<GetRateLimiterStateResult>

---

getTokenAdminRegistry()

getTokenAdminRegistry(opts: GetTokenAdminRegistryParams): Promise<GetTokenAdminRegistryResult>

Defined in: cct/canton/index.ts:191

Reads the TAR state for an instrument (admin, pendingAdmin, pool, factory wiring).

Parameters

Parameter	Type
opts	GetTokenAdminRegistryParams

Returns

Promise<GetTokenAdminRegistryResult>

---

getTokenPoolState()

getTokenPoolState(opts: GetTokenPoolStateParams): Promise<GetTokenPoolStateResult>

Defined in: cct/canton/index.ts:200

Reads a token pool's config (including its poolType) from the ACS.

Parameters

Parameter	Type
opts	GetTokenPoolStateParams

Returns

Promise<GetTokenPoolStateResult>

---

setObservers()

setObservers(opts: ExecuteSetObserversParams): Promise<ExecutePoolChoiceResult>

Defined in: cct/canton/index.ts:184

Updates a pool's EDS observer parties.

Parameters

Parameter	Type
opts	ExecuteSetObserversParams

Returns

Promise<ExecutePoolChoiceResult>

---

setRateLimitConfig()

setRateLimitConfig(opts: ExecuteSetRateLimitConfigParams): Promise<ExecuteSetRateLimitConfigResult>

Defined in: cct/canton/index.ts:170

Sets one lane rate limiter's isEnabled/capacity/rate. Callable by the pool owner or the pool's rateLimitAdmin. Note: isEnabled: false means unlimited throughput (and requires zero capacity/rate); to block a direction, set isEnabled: true, capacity: 0n, rate: 0n.

Parameters

Parameter	Type
opts	ExecuteSetRateLimitConfigParams

Returns

Promise<ExecuteSetRateLimitConfigResult>

---

fromChain()

static fromChain(chain: CantonChain): CantonTokenManager

Defined in: cct/canton/index.ts:99

Wraps an existing CantonChain.

Parameters

Parameter	Type
chain	CantonChain

Returns

CantonTokenManager

---

fromUrl()

static fromUrl(url: string, ctx?: ChainContext): Promise<CantonTokenManager>

Defined in: cct/canton/index.ts:104

Creates from a Canton JSON Ledger API URL.

Parameters

Parameter	Type
url	string
ctx?	ChainContext

Returns

Promise<CantonTokenManager>