Interface: DeployTokenPoolParams

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:80

Parameters shared by deployTokenPool generation and execution.

Properties

admin?

optional admin?: string

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:120

Token admin party — jointly authorizes Initialize with poolOwner, and must equal the TAR's ccipOwner or instrumentId.admin for the internal ProposeAdministrator call to succeed (its isOwner || isAdmin check). Defaults to instrumentId.admin.

---

decimals

decimals: number

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:94

The token's decimals ON CANTON (10 for Token Standard instruments) — NOT the remote chain's decimals. The pool converts between this and the remote side's decimals (carried in the message). Getting this wrong silently mis-scales every transfer (e.g. 18 here for a 10-decimal Canton token mints 10^8× the intended amount on inbound).

---

deps?

optional deps?: Partial<PoolFactoryDeps>

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:109

Factory deps overrides (TAR, FeeQuoter, RMNRemote raw instance addresses). Any field left unset falls back to the well-known contracts registered for the connected network — end users on a known network omit deps entirely; overrides are for devnet / testing. tokenAdminRegistry is also the TAR Initialize registers with.

---

instanceId

instanceId: string

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:84

Pool instance ID (unique per pool; used to derive the pool instance address).

---

instrumentId

instrumentId: string | { admin: string; id: string; }

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:86

Instrument to bridge ({ admin, id } or "admin::1220…::id"); admin is the pool owner.

---

lanes

lanes: LaneDeploySpec[]

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:122

Remote-chain lanes to wire up atomically with the pool (may be empty).

---

observers

observers: string[]

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:99

Observer parties for EDS auto-detection. Mandatory — the on-ledger ensure clause rejects an empty list.

---

poolReceiveContext?

optional poolReceiveContext?: PoolReceiveContext

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:111

Pool receive-context choice-context.

---

poolType

poolType: PoolType

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:82

Pool type to deploy.

---

rateLimitAdmin?

optional rateLimitAdmin?: string

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:101

Optional rate-limit admin party.

---

transferTimeout?

optional transferTimeout?: TransferTimeout

Defined in: cct/canton/token-pool/operations/deploy-token-pool.ts:113

Transfer timeout (Daml variant; defaults to RelativeHours 24, matching Go).