Type Alias: CantonConfig

CantonConfig = { auth?: CantonAuthConfig; ccipParty: string; ccvs?: string[]; chainId?: string; defaultSendGasLimit?: number | bigint; edsUrl: string; externalEdsUrlsByOwner?: Record<string, string>; feeTransferFactoryAmount?: string; indexerUrl?: string; jwt?: string; packages?: Partial<{ ccipReceiver: string; ccipSender: string; perPartyRouter: string; }>; party: string; senderInstanceId?: string; transferInstructionUrl: string; }

Defined in: chain.ts:207

Configuration for connecting to a Canton Ledger API and fetch CCIP disclosures.

Properties

auth?

optional auth?: CantonAuthConfig

Defined in: chain.ts:231

Optional OAuth 2.0 auth configuration for obtaining a JWT automatically.

Supports static, insecureStatic, clientCredentials, and authorizationCode flows (mirroring the Go commonconfig.AuthConfig). When set, CantonChain.fromUrl resolves a JWT via the auth provider unless jwt is already present.

---

ccipParty

ccipParty: string

Defined in: chain.ts:212

CCIP operator party (CCIPSender signatory / fee recipient on ledger).

---

ccvs?

optional ccvs?: string[]

Defined in: chain.ts:294

Optional Canton CCV instance addresses (hex hashes and/or raw instanceId@party). Used for execute (EDS disclosures + receiver matching) and as the default for Canton send senderRequiredCCVs when extraArgs.ccvRawAddresses is omitted. CLI -x ccvRawAddresses=… overrides this list for send.

---

chainId?

optional chainId?: string

Defined in: chain.ts:257

Optional CCIP Canton chain ID (e.g. canton:TestNet). When set, skips synchronizer-alias detection — required when the ledger reports a generic alias such as global.

---

defaultSendGasLimit?

optional defaultSendGasLimit?: number | bigint

Defined in: chain.ts:280

Default gas limit for Canton → destination sends when message.extraArgs.gasLimit is omitted. ccip-cli --gas-limit and extraArgs.gasLimit override this.

---

edsUrl

edsUrl: string

Defined in: chain.ts:234

Base URL for the EDS (Explicit Disclosure Service) API.

---

externalEdsUrlsByOwner?

optional externalEdsUrlsByOwner?: Record<string, string>

Defined in: chain.ts:241

Optional mapping from a Canton RawInstanceAddress owner party to that owner's external EDS base URL. When absent, edsUrl is used for both global and external EDS endpoints.

---

feeTransferFactoryAmount?

optional feeTransferFactoryAmount?: string

Defined in: chain.ts:286

Transfer-factory preview amount for Canton fee-token payments. Rarely needs changing; mirrors Go CLI transfer-factory "1.0" default.

---

indexerUrl?

optional indexerUrl?: string

Defined in: chain.ts:250

Optional base URL for a transaction indexer to fetch CCV verifications. Used when --indexer is omitted on ccip-cli (CLI --indexer overrides this).

---

jwt?

optional jwt?: string

Defined in: chain.ts:221

JSON Web Token for authentication with the Canton Ledger API.

When auth is provided, jwt is optional — the SDK resolves a JWT from the auth provider on demand. When both are set, jwt takes precedence (explicit override).

---

packages?

optional packages?: Partial<{ ccipReceiver: string; ccipSender: string; perPartyRouter: string; }>

Defined in: chain.ts:263

Optional DAR package names for ACS template filters. Prod testnet bundles PerPartyRouter in ccip-runtime instead of the dev default ccip-perpartyrouter.

---

party

party: string

Defined in: chain.ts:209

User ledger party for actAs, ACS queries, and transaction visibility (often differs from ccipParty).

---

senderInstanceId?

optional senderInstanceId?: string

Defined in: chain.ts:274

Optional CCIPSender instance id for Canton-source sends (ccip-cli -r on Canton lanes). Used only for CLI/SDK routing; on-ledger Send resolves CCIPSender from party via ACS. CLI -r overrides this value.

---

transferInstructionUrl

transferInstructionUrl: string

Defined in: chain.ts:244

Base URL for the Transfer Instruction API.