Interface: DeployTokenPoolParams

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

Parameters shared by deployTokenPool generation and execution.

Properties

admin

admin: string

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

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).

---

ccipOwner

ccipOwner: string

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

CCIP owner party ID (the protocol-level owner).

---

decimals

decimals: number

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

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:111

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.

---

existingTokenConfigCid?

optional existingTokenConfigCid?: string

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

Existing TokenConfig contract ID, for the third-party-admin flow: the instrument's admin (or ccipOwner) proposed admin out of band, and Initialize accepts the role on the existing config instead of creating one. Resolve the current CID via getTokenAdminRegistry (it rotates on every write). NOTE: on-ledger, ProposeAdministrator rejects an existing config that already has an admin — so this cannot be used to re-deploy a pool for an instrument that already completed admin setup.

---

instanceId

instanceId: string

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

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:89

Instrument to bridge ({ admin, id } or "admin::1220…::id").

---

lanes

lanes: LaneDeploySpec[]

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

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:102

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

---

poolOwner

poolOwner: string

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

Pool owner party ID (hint::1220…) — must equal instrumentId.admin.

---

poolReceiveContext?

optional poolReceiveContext?: PoolReceiveContext

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

Pool receive-context choice-context.

---

poolType

poolType: PoolType

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

Pool type to deploy.

---

rateLimitAdmin?

optional rateLimitAdmin?: string

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

Optional rate-limit admin party.

---

tokenAdminRegistryInstanceAddress

tokenAdminRegistryInstanceAddress: string

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

TAR InstanceAddress (0x<64-hex> or "instanceId@ccipOwner"). Resolved via the EDS disclosure service (preferred) or the ACS.

---

transferTimeout?

optional transferTimeout?: TransferTimeout

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

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