@layerzerolabs/common-canton 0.2.98 → 0.2.100

package/.turbo/turbo-test.log

@@ -9,75 +9,11 @@
 ✅ dpm-3.4.8-openapi-generator-7.21.0 
 🔧 openapi-generator version: 7.21.0
 $ docker image inspect --format {{.Id}} 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-(node:120364) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/monorepo-internal/monorepo-internal/configs/vm-tooling/values/docker-image-repo.ts is not specified and it doesn't parse as CommonJS.
+(node:121901) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///home/runner/work/monorepo-internal/monorepo-internal/configs/vm-tooling/values/docker-image-repo.ts is not specified and it doesn't parse as CommonJS.
 Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
 To eliminate this warning, add "type": "module" to /home/runner/work/monorepo-internal/monorepo-internal/package.json.
 (Use `node --trace-warnings ...` to show where the warning was created)
-Error response from daemon: No such image: 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-📥 Pulling Docker image from: 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-$ docker pull 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-openapi-generator-7.21.0-patch-1: Pulling from layerzerolabs/canton-openapi-tooling
-6ad39880009f: Pulling fs layer
-de90d86cd9e8: Pulling fs layer
-320d9614051d: Pulling fs layer
-2105e5edb107: Pulling fs layer
-d7fa639f53de: Pulling fs layer
-ca7063794723: Pulling fs layer
-89b1ff25a2ba: Pulling fs layer
-24574a3c3b7e: Pulling fs layer
-72df4dc3c67b: Pulling fs layer
-66fb6c894d14: Pulling fs layer
-f49710e34058: Pulling fs layer
-2c1ce468d9f3: Pulling fs layer
-2c1ce468d9f3: Waiting
-d7fa639f53de: Waiting
-24574a3c3b7e: Waiting
-ca7063794723: Waiting
-89b1ff25a2ba: Waiting
-de90d86cd9e8: Waiting
-6ad39880009f: Waiting
-320d9614051d: Waiting
-2105e5edb107: Waiting
-66fb6c894d14: Waiting
-f49710e34058: Waiting
-72df4dc3c67b: Waiting
-6ad39880009f: Download complete
-2105e5edb107: Verifying Checksum
-2105e5edb107: Download complete
-6ad39880009f: Pull complete
-d7fa639f53de: Verifying Checksum
-d7fa639f53de: Download complete
-de90d86cd9e8: Verifying Checksum
-de90d86cd9e8: Download complete
-320d9614051d: Verifying Checksum
-320d9614051d: Download complete
-89b1ff25a2ba: Verifying Checksum
-89b1ff25a2ba: Download complete
-24574a3c3b7e: Verifying Checksum
-24574a3c3b7e: Download complete
-ca7063794723: Verifying Checksum
-ca7063794723: Download complete
-72df4dc3c67b: Verifying Checksum
-72df4dc3c67b: Download complete
-66fb6c894d14: Download complete
-2c1ce468d9f3: Download complete
-f49710e34058: Verifying Checksum
-f49710e34058: Download complete
-de90d86cd9e8: Pull complete
-320d9614051d: Pull complete
-2105e5edb107: Pull complete
-d7fa639f53de: Pull complete
-ca7063794723: Pull complete
-89b1ff25a2ba: Pull complete
-24574a3c3b7e: Pull complete
-72df4dc3c67b: Pull complete
-66fb6c894d14: Pull complete
-f49710e34058: Pull complete
-2c1ce468d9f3: Pull complete
-Digest: sha256:4ef893994ed509c7de16aec1dc796d5065f53b415bd34f9c6801c2b7beb4b8a9
-Status: Downloaded newer image for 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
-✅ Successfully pulled: 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
+✅ Using cached Docker image: 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1
 👤 Running container as UID:GID 1001:1001
 📜 Executing custom script: set -euo pipefail && rm -rf "src/open-api" && java -jar "$OPENAPI_GENERATOR_JAR" generate -i "$CANTON_OPENAPI_YAML" -g typescript-fetch -o "src/open-api" --additional-properties=importFileExtension=.js
 $ docker run --rm --add-host=host.docker.internal:host-gateway -e LOCAL_UID=1001 -e LOCAL_GID=1001 -v /home/runner/work/monorepo-internal/monorepo-internal:/workspace -w /workspace/packages/vms/canton/common-canton 438003944538.dkr.ecr.us-east-1.amazonaws.com/layerzerolabs/canton-openapi-tooling:openapi-generator-7.21.0-patch-1 bash -c $'set -euo pipefail && rm -rf "src/open-api" && java -jar "$OPENAPI_GENERATOR_JAR" generate -i "$CANTON_OPENAPI_YAML" -g typescript-fetch -o "src/open-api" --additional-properties=importFileExtension=.js'
@@ -759,21 +695,21 @@ $ docker run --rm --add-host=host.docker.internal:host-gateway -e LOCAL_UID=1001
 # We appreciate your support! Please consider donation to help us maintain this project.   #
 # https://opencollective.com/openapi_generator/donate                                      #
 ############################################################################################
-⏳ bash -c set -euo pipefail && rm -rf "src/open-api" && java -jar "$OPENAPI_GENERATOR_JAR" generate -i "$CANTON_OPENAPI_YAML" -g typescript-fetch -o "src/open-api" --additional-properties=importFileExtension=.js: 3.454s
+⏳ bash -c set -euo pipefail && rm -rf "src/open-api" && java -jar "$OPENAPI_GENERATOR_JAR" generate -i "$CANTON_OPENAPI_YAML" -g typescript-fetch -o "src/open-api" --additional-properties=importFileExtension=.js: 4.954s
 Testing types with tsc and vue-tsc is an experimental feature.
 Breaking changes might not follow SemVer, please pin Vitest's version when using it.
 
  RUN  v3.2.4 /home/runner/work/monorepo-internal/monorepo-internal/packages/vms/canton/common-canton
 
- ✓ test/auth/local-token-provider.test.ts (5 tests) 10ms
- ✓ test/auth/client-credentials-token-provider.test.ts (7 tests) 14ms
+ ✓ test/auth/client-credentials-token-provider.test.ts (7 tests) 18ms
+ ✓ test/auth/local-token-provider.test.ts (5 tests) 14ms
 stderr | test/sdk.test.ts > Error Handling (Unhappy Paths) > should handle double archive error
 Mock miss: GET /v2/state/connected-synchronizers
 
 stderr | test/sdk.test.ts > Error Handling (Unhappy Paths) > should handle unauthorized party error
 Mock miss: GET /v2/state/connected-synchronizers
 
- ✓ test/sdk.test.ts (18 tests) 29ms
+ ✓ test/sdk.test.ts (18 tests) 37ms
  ✓  TS  test/sdk.test.ts (18 tests)
  ✓  TS  test/auth/client-credentials-token-provider.test.ts (7 tests)
  ✓  TS  test/auth/local-token-provider.test.ts (5 tests)
@@ -781,6 +717,6 @@ Breaking changes might not follow SemVer, please pin Vitest's version when using
  Test Files  6 passed (6)
       Tests  60 passed (60)
 Type Errors  no errors
-   Start at  02:48:42
-   Duration  3.27s (transform 1.10s, setup 0ms, collect 1.58s, tests 54ms, environment 1ms, prepare 452ms, typecheck 2.93s)
+   Start at  16:50:07
+   Duration  4.06s (transform 1.25s, setup 0ms, collect 1.82s, tests 68ms, environment 1ms, prepare 611ms, typecheck 3.66s)
 

package/dist/auth/client-credentials-token-provider.d.ts

@@ -1,12 +1,25 @@
 import type { TokenProvider } from './token-provider';
 export interface ClientCredentialsTokenProviderConfig {
+    /** Full URL of the IdP token endpoint */
     tokenUrl: string;
     clientId: string;
     clientSecret: string;
+    /** OAuth scope to request (e.g. "daml_ledger_api"). */
     scope?: string;
+    /** Audience parameter — required by some IdPs (Auth0, Okta). */
     audience?: string;
+    /** Re-acquire this many seconds before actual expiry. Default: 60. */
     bufferSeconds?: number;
 }
+/**
+ * Token provider for production environments using the OAuth2 Client
+ * Credentials flow (RFC 6749 Section 4.4).
+ *
+ * Acquires tokens from an external identity provider (Keycloak, Okta, etc.),
+ * caches them in memory, and re-acquires automatically before expiry.
+ * Concurrent callers are coalesced into a single in-flight fetch to prevent
+ * thundering herd on token expiry.
+ */
 export declare class ClientCredentialsTokenProvider implements TokenProvider {
     #private;
     constructor(config: ClientCredentialsTokenProviderConfig);

package/dist/auth/client-credentials-token-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-credentials-token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/client-credentials-token-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,oCAAoC;IAEjD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAmBD,qBAAa,8BAA+B,YAAW,aAAa;;gBAKpD,MAAM,EAAE,oCAAoC;IAKlD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CA0CpC"}
+{"version":3,"file":"client-credentials-token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/client-credentials-token-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,oCAAoC;IACjD,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAUD;;;;;;;;GAQG;AACH,qBAAa,8BAA+B,YAAW,aAAa;;gBAKpD,MAAM,EAAE,oCAAoC;IAKlD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CA0CpC"}

package/dist/auth/local-token-provider.d.ts

@@ -4,9 +4,17 @@ export interface LocalTokenProviderConfig {
     actAs: string[];
     secret?: string;
     audience?: string;
+    /** Token lifetime in seconds. */
     expiresIn?: number;
     admin?: boolean;
 }
+/**
+ * Token provider for local development and sandbox environments.
+ *
+ * Generates short-lived HMAC-SHA256 JWTs on the fly using the Canton
+ * participant node's "unsafe" identity provider manager shared secret.
+ * Tokens are cached in memory and regenerated automatically before expiry.
+ */
 export declare class LocalTokenProvider implements TokenProvider {
     #private;
     constructor(config: LocalTokenProviderConfig);

package/dist/auth/local-token-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"local-token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/local-token-provider.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAgCD,qBAAa,kBAAmB,YAAW,aAAa;;gBAIxC,MAAM,EAAE,wBAAwB;IAWtC,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CAyBpC"}
+{"version":3,"file":"local-token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/local-token-provider.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,WAAW,wBAAwB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAyBD;;;;;;GAMG;AACH,qBAAa,kBAAmB,YAAW,aAAa;;gBAIxC,MAAM,EAAE,wBAAwB;IAWtC,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;CAyBpC"}

package/dist/auth/token-provider.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Provides Bearer tokens for Canton API authentication.
+ *
+ * Implementations handle acquisition, caching, and refresh internally.
+ * Callers should invoke {@link getToken} before each request — the
+ * implementation decides whether to return a cached token or obtain a new one.
+ */
 export interface TokenProvider {
     getToken(): Promise<string>;
 }

package/dist/auth/token-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/token-provider.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,aAAa;IAC1B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B"}
+{"version":3,"file":"token-provider.d.ts","sourceRoot":"","sources":["../../src/auth/token-provider.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B"}

package/dist/client/canton-client.d.ts

@@ -3,18 +3,54 @@ import { type ArchivedEvent, type Command, type CreatedEvent, type DisclosedCont
 import type { Configuration } from '../open-api/runtime';
 import type { ExternalSignature, PreparedTransaction, SubmitActors, SubmitResult, WaitOptions, WaitResult } from '../types';
 import type { CantonTransaction, CantonUpdate, ICantonClient } from './interface';
+/**
+ * CantonClient - The engine layer for Canton ledger operations.
+ *
+ * Responsibilities:
+ * - Synchronizer discovery and caching
+ * - Command submission and completion waiting
+ * - Disclosed contract building
+ * - JSON normalization (temporary workaround)
+ *
+ * This class uses composition (not inheritance) to wrap the generated API,
+ * exposing only the minimal surface needed for ledger app operations.
+ */
 export declare class CantonClient implements ICantonClient {
     #private;
     constructor(config: Configuration, userId?: string);
+    /**
+     * Returns all connected synchronizer IDs.
+     */
     connectedSynchronizers(): Promise<string[]>;
+    /**
+     * Upload a DAR (Daml Archive) to the participant node.
+     *
+     * @param dar - Raw DAR bytes.
+     * @param opts.vetAllPackages - Whether to vet all packages in the DAR.
+     * @param opts.synchronizerId - Synchronizer to upload to (auto-detected if omitted).
+     * @param opts.skipIfVetted - If true, silently succeeds when the DAR is already vetted.
+     */
     uploadDar(dar: Uint8Array<ArrayBuffer>, opts?: {
         vetAllPackages?: boolean;
         synchronizerId?: string;
         skipIfVetted?: boolean;
     }): Promise<object>;
+    /**
+     * Validate a DAR against the participant without uploading it.
+     *
+     * @param dar - Raw DAR bytes.
+     * @param opts.synchronizerId - Synchronizer to validate against (auto-detected if omitted).
+     */
     validateDar(dar: Uint8Array<ArrayBuffer>, opts?: {
         synchronizerId?: string;
     }): Promise<void>;
+    /**
+     * List all known parties on the participant node.
+     *
+     * @param opts.pageSize - Maximum number of results per page
+     * @param opts.pageToken - Pagination token from previous response
+     * @returns Array of party IDs and pagination token
+     */
     listParties(opts?: {
         pageSize?: number;
         pageToken?: string;
@@ -22,40 +58,147 @@ export declare class CantonClient implements ICantonClient {
         parties: string[];
         nextPageToken: string;
     }>;
+    /**
+     * Allocate a new party on the participant node.
+     *
+     * @param partyIdHint - A hint for the party ID (e.g., "alice", "bob")
+     * @param opts.userId - User who gets actAs rights (empty string = no user)
+     * @param opts.synchronizerId - Synchronizer to allocate on (auto-detected if omitted)
+     * @param opts.identityProviderId - Identity provider ID (empty string = default)
+     * @returns The allocated party ID
+     */
     allocateParty(partyIdHint: string, opts?: {
         userId?: string;
         synchronizerId?: string;
         identityProviderId?: string;
     }): Promise<string>;
+    /**
+     * Get the package ID for a package by name.
+     *
+     * @param packageName - The package name (e.g., "layerzero-oft")
+     * @param parties - Parties whose vetting state should be considered
+     * @param opts.synchronizerId - Synchronizer to query (auto-detected if omitted)
+     * @returns The package ID (hash)
+     */
     getPackageId(packageName: string, parties: string[], opts?: {
         synchronizerId?: string;
     }): Promise<string>;
+    /**
+     * Submit a batch of commands atomically.
+     *
+     * @returns commandId and completionOffset for use with waitForCommand()
+     */
     submit(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<SubmitResult>;
+    /**
+     * Wait for a command to be accepted or rejected.
+     *
+     * Uses bounded exponential backoff to avoid hammering the participant.
+     */
     waitForCommand(commandId: string, opts: WaitOptions): Promise<WaitResult>;
+    /**
+     * Build a disclosure for a contract.
+     *
+     * @param contractId - The contract ID to create disclosure for
+     * @param parties - Parties that have visibility to the contract
+     * @returns DisclosedContract if visible, undefined if not found
+     * @throws CantonProtocolError if contract visible but blob missing (server/config mismatch)
+     */
     createDisclosure(contractId: ContractId<unknown>, parties: string[]): Promise<DisclosedContract | undefined>;
+    /**
+     * Fetch a single contract by ID.
+     *
+     * @param contractId The contract ID to fetch
+     * @param parties Parties to use for filtering (required for non-admin tokens)
+     */
     fetchContractById(contractId: ContractId<unknown>, parties: string[]): Promise<CreatedEvent | undefined>;
+    /**
+     * Fetch both the created and archived events for a contract by ID.
+     * Unlike fetchContractById, this preserves archival information.
+     */
     fetchEventsByContractId(contractId: string, parties: string[]): Promise<{
         created: CreatedEvent | undefined;
         archived: ArchivedEvent | undefined;
     }>;
+    /**
+     * Fetch an update (transaction) by its ID.
+     * @param updateId The update ID from a completion
+     * @param parties Parties to use for the query filter
+     * @returns The full update response
+     */
     fetchTransactionByUpdateId(updateId: string, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Fetch a transaction by its offset.
+     * @param offset - The ledger offset
+     * @param parties - Parties to use for the query filter
+     * @returns The full transaction including recordTime
+     */
     fetchTransactionByOffset(offset: number, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Prepare commands for external party signing.
+     *
+     * Returns a typed PreparedTransaction that preserves the contract type
+     * through the signing flow. After signing, use submitSigned() to submit.
+     *
+     * @typeparam T The contract payload type (phantom type for type safety)
+     *
+     * @example
+     * ```ts
+     * const prepared = await client.prepareForSigning<Oft>({ actAs: [party] }, [cmd]);
+     * const signature = await sign(prepared.preparedTransactionHash);
+     * await client.submitSigned(prepared, [signature]);
+     * ```
+     */
     prepareForSigning(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<PreparedTransaction>;
+    /**
+     * Submit a pre-signed transaction.
+     *
+     * The generic type T flows from prepareForSigning() for type documentation.
+     */
     submitSigned(prepared: PreparedTransaction, signatures: ExternalSignature[]): Promise<SubmitResult>;
+    /**
+     * Get the current ledger end offset.
+     */
     getLedgerEndOffset(): Promise<number>;
+    /**
+     * Query active contracts at a given offset with optional template filtering.
+     *
+     * @param party - Party to query as
+     * @param offset - Ledger offset for the snapshot
+     * @param opts.templateIds - Optional template IDs to filter by
+     * @param opts.limit - Maximum number of contracts to return
+     */
     queryActiveContracts(party: string, offset: number, opts?: {
         templateIds?: string[];
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Query active contracts visible to any of the given parties.
+     *
+     * Single API call with all parties in filtersByParty.
+     *
+     * @param parties - Parties to query as (for visibility)
+     * @param offset - Ledger offset for the snapshot
+     * @param templateIds - Template IDs to filter by
+     * @param opts.limit - Maximum number of contracts to return
+     */
     queryActiveContractsByParties(parties: string[], offset: number, templateIds: string[], opts?: {
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Stream transactions from a given offset.
+     *
+     * @param party - Party to query as
+     * @param beginExclusive - Start offset (exclusive)
+     * @param endInclusive - End offset (inclusive)
+     * @param opts.templateIds - Optional template IDs to filter by
+     * @param opts.limit - Maximum number of transactions to return
+     */
     getUpdates(party: string, beginExclusive: number, endInclusive: number, opts?: {
         templateIds?: string[];
         limit?: number;

package/dist/client/canton-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"canton-client.d.ts","sourceRoot":"","sources":["../../src/client/canton-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAgB9C,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAExB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EACR,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EACR,iBAAiB,EACjB,YAAY,EAEZ,aAAa,EAChB,MAAM,aAAa,CAAC;AAcrB,qBAAa,YAAa,YAAW,aAAa;;gBAIlC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,MAA4B;IAkIjE,sBAAsB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IA+B3C,SAAS,CACX,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO,GACzF,OAAO,CAAC,MAAM,CAAC;IAqCZ,WAAW,CACb,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAO,GACvC,OAAO,CAAC,IAAI,CAAC;IA+BV,WAAW,CACb,IAAI,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACrD,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;IAqBlD,aAAa,CACf,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAO,GACrF,OAAO,CAAC,MAAM,CAAC;IAiCZ,YAAY,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAO,GACvC,OAAO,CAAC,MAAM,CAAC;IA2CZ,MAAM,CACR,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,GAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAC5E,OAAO,CAAC,YAAY,CAAC;IAsClB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAyJzE,gBAAgB,CAClB,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAC/B,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAuBnC,iBAAiB,CACnB,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAC/B,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAQ9B,uBAAuB,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;QAAE,OAAO,EAAE,YAAY,GAAG,SAAS,CAAC;QAAC,QAAQ,EAAE,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IAyBhF,0BAA0B,CAC5B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,iBAAiB,CAAC;IAqBvB,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkCvF,iBAAiB,CACnB,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,GAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAC5E,OAAO,CAAC,mBAAmB,CAAC;IAkCzB,YAAY,CACd,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,iBAAiB,EAAE,GAChC,OAAO,CAAC,YAAY,CAAC;IA6ClB,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAarC,oBAAoB,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAgBxB,6BAA6B,CAC/B,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EAAE,EACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAoCxB,UAAU,CACZ,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,YAAY,EAAE,CAAC;CAmE7B"}
+{"version":3,"file":"canton-client.d.ts","sourceRoot":"","sources":["../../src/client/canton-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAgB9C,OAAO,EACH,KAAK,aAAa,EAClB,KAAK,OAAO,EACZ,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAExB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EACR,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EACR,iBAAiB,EACjB,YAAY,EAEZ,aAAa,EAChB,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;GAWG;AACH,qBAAa,YAAa,YAAW,aAAa;;gBAIlC,MAAM,EAAE,aAAa,EAAE,MAAM,GAAE,MAA4B;IA+HvE;;OAEG;IACG,sBAAsB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAuBjD;;;;;;;OAOG;IACG,SAAS,CACX,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAO,GACzF,OAAO,CAAC,MAAM,CAAC;IA+BlB;;;;;OAKG;IACG,WAAW,CACb,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAO,GACvC,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;OAMG;IACG,WAAW,CACb,IAAI,GAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACrD,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;IAYxD;;;;;;;;OAQG;IACG,aAAa,CACf,WAAW,EAAE,MAAM,EACnB,IAAI,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAO,GACrF,OAAO,CAAC,MAAM,CAAC;IAyBlB;;;;;;;OAOG;IACG,YAAY,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,GAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAO,GACvC,OAAO,CAAC,MAAM,CAAC;IAsClB;;;;OAIG;IACG,MAAM,CACR,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,GAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAC5E,OAAO,CAAC,YAAY,CAAC;IAiCxB;;;;OAIG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAiJ/E;;;;;;;OAOG;IACG,gBAAgB,CAClB,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAC/B,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAiBzC;;;;;OAKG;IACG,iBAAiB,CACnB,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,EAC/B,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAIpC;;;OAGG;IACG,uBAAuB,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;QAAE,OAAO,EAAE,YAAY,GAAG,SAAS,CAAC;QAAC,QAAQ,EAAE,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;IAmBtF;;;;;OAKG;IACG,0BAA0B,CAC5B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,iBAAiB,CAAC;IAe7B;;;;;OAKG;IACG,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmB7F;;;;;;;;;;;;;;OAcG;IACG,iBAAiB,CACnB,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,GAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAC5E,OAAO,CAAC,mBAAmB,CAAC;IA6B/B;;;;OAIG;IACG,YAAY,CACd,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,iBAAiB,EAAE,GAChC,OAAO,CAAC,YAAY,CAAC;IA0CxB;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAK3C;;;;;;;OAOG;IACG,oBAAoB,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM9B;;;;;;;;;OASG;IACG,6BAA6B,CAC/B,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EAAE,EACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,OAAO,CAAC,gBAAgB,EAAE,CAAC;IA2B9B;;;;;;;;OAQG;IACG,UAAU,CACZ,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,YAAY,EAAE,CAAC;CAmE7B"}

package/dist/client/grpc.d.ts

@@ -10,6 +10,15 @@ export type CantonGrpcClientOptions = {
     tokenProvider?: TokenProvider;
     tls?: TlsOptions;
 };
+/**
+ * gRPC client for the Canton Admin API.
+ *
+ * Wraps the Topology Manager Read Service for querying topology state
+ * (decentralized namespace definitions, etc.) via the participant's admin endpoint.
+ *
+ * If a {@link TokenProvider} is supplied, a fresh Bearer token is acquired
+ * before each RPC call via per-call metadata.
+ */
 export declare class CantonGrpcClient {
     #private;
     constructor(opts: CantonGrpcClientOptions);

package/dist/client/grpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grpc.d.ts","sourceRoot":"","sources":["../../src/client/grpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,gCAAgC,EAKxC,MAAM,mCAAmC,CAAC;AAI3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,GAAG,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAgBF,qBAAa,gBAAgB;;gBAKb,IAAI,EAAE,uBAAuB;IAenC,yCAAyC,CAC3C,cAAc,EAAE,MAAM,EACtB,oBAAoB,EAAE,MAAM,GAC7B,OAAO,CAAC,gCAAgC,GAAG,SAAS,CAAC;IAgBxD,KAAK,IAAI,IAAI;CAGhB"}
+{"version":3,"file":"grpc.d.ts","sourceRoot":"","sources":["../../src/client/grpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,gCAAgC,EAKxC,MAAM,mCAAmC,CAAC;AAI3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,GAAG,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAOF;;;;;;;;GAQG;AACH,qBAAa,gBAAgB;;gBAKb,IAAI,EAAE,uBAAuB;IAenC,yCAAyC,CAC3C,cAAc,EAAE,MAAM,EACtB,oBAAoB,EAAE,MAAM,GAC7B,OAAO,CAAC,gCAAgC,GAAG,SAAS,CAAC;IAgBxD,KAAK,IAAI,IAAI;CAGhB"}

package/dist/client/interface.d.ts

@@ -1,6 +1,9 @@
 import type { ContractId } from '@daml/types';
 import type { ArchivedEvent, Command, CreatedEvent, DisclosedContract, ExercisedEvent, JsActiveContract, JsTransaction, OffsetCheckpoint2, Reassignment, TopologyTransaction } from '../open-api/models';
 import type { ExternalSignature, PreparedTransaction, SubmitActors, SubmitResult, WaitOptions, WaitResult } from '../types';
+/**
+ * Event union with PascalCase keys matching the actual Canton JSON API response.
+ */
 export type CantonEvent = {
     CreatedEvent: CreatedEvent;
 } | {
@@ -8,9 +11,16 @@ export type CantonEvent = {
 } | {
     ExercisedEvent: ExercisedEvent;
 };
+/**
+ * Transaction type with correctly-cased event types.
+ */
 export type CantonTransaction = Omit<JsTransaction, 'events'> & {
     events?: CantonEvent[];
 };
+/**
+ * Update union with PascalCase keys matching the actual Canton JSON API response.
+ * Covers all update types: Transaction, Reassignment, TopologyTransaction, OffsetCheckpoint.
+ */
 export type CantonUpdate = {
     Transaction: {
         value: CantonTransaction;
@@ -22,37 +32,106 @@ export type CantonUpdate = {
 } | {
     OffsetCheckpoint: OffsetCheckpoint2;
 };
+/**
+ * Response wrapper for a single update (from fetchTransactionByUpdateId/fetchTransactionByOffset).
+ */
 export type CantonUpdateResponse = {
     update: CantonUpdate;
 };
+/**
+ * Interface for CantonClient - the low-level transport layer.
+ *
+ * Implement this interface to create custom clients (e.g., for testing).
+ */
 export interface ICantonClient {
+    /**
+     * Returns all connected synchronizer IDs.
+     */
     connectedSynchronizers(): Promise<string[]>;
+    /**
+     * Submit a batch of commands atomically.
+     */
     submit(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<SubmitResult>;
+    /**
+     * Wait for a command to be accepted or rejected.
+     */
     waitForCommand(commandId: string, opts: WaitOptions): Promise<WaitResult>;
+    /**
+     * Build a disclosure for a contract.
+     * @param contractId - The contract ID to create disclosure for
+     * @param parties - Parties that have visibility to the contract
+     */
     createDisclosure(contractId: ContractId<unknown>, parties: string[]): Promise<DisclosedContract | undefined>;
+    /**
+     * Fetch a single contract by ID.
+     */
     fetchContractById(contractId: ContractId<unknown>, parties: string[]): Promise<CreatedEvent | undefined>;
+    /**
+     * Fetch both the created and archived events for a contract by ID.
+     * Unlike fetchContractById, this preserves archival information.
+     *
+     * Accepts plain string (not ContractId<unknown>) because callers in the
+     * chain layer work with raw contract IDs that aren't branded.
+     */
     fetchEventsByContractId(contractId: string, parties: string[]): Promise<{
         created: CreatedEvent | undefined;
         archived: ArchivedEvent | undefined;
     }>;
+    /**
+     * Fetch a transaction by its update ID.
+     */
     fetchTransactionByUpdateId(updateId: string, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Fetch a transaction by its offset.
+     *
+     * @param offset - The ledger offset
+     * @param parties - Parties to use for the query filter
+     * @returns The full transaction including recordTime (ISO timestamp)
+     */
     fetchTransactionByOffset(offset: number, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Prepare commands for external party signing.
+     */
     prepareForSigning(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<PreparedTransaction>;
+    /**
+     * Submit a pre-signed transaction.
+     */
     submitSigned(prepared: PreparedTransaction, signatures: ExternalSignature[]): Promise<SubmitResult>;
+    /**
+     * Upload a DAR to the participant node.
+     *
+     * POST /v2/dars
+     *
+     * @param opts.skipIfVetted - If true, treat KNOWN_PACKAGE_VERSION errors as success
+     */
     uploadDar(dar: Uint8Array<ArrayBuffer>, opts?: {
         vetAllPackages?: boolean;
         synchronizerId?: string;
         skipIfVetted?: boolean;
     }): Promise<object>;
+    /**
+     * Validate a DAR for upgrade compatibility against the current vetting state.
+     *
+     * POST /v2/dars/validate
+     */
     validateDar(dar: Uint8Array<ArrayBuffer>, opts?: {
         synchronizerId?: string;
     }): Promise<void>;
+    /**
+     * List all known parties on the participant node.
+     *
+     * GET /v2/parties
+     *
+     * @param opts.pageSize - Maximum number of results per page
+     * @param opts.pageToken - Pagination token from previous response
+     * @returns Array of party IDs
+     */
     listParties(opts?: {
         pageSize?: number;
         pageToken?: string;
@@ -60,22 +139,82 @@ export interface ICantonClient {
         parties: string[];
         nextPageToken: string;
     }>;
+    /**
+     * Allocate a new party on the participant node.
+     *
+     * POST /v2/parties
+     *
+     * @param partyIdHint - A hint for the party ID (e.g., "alice", "bob")
+     * @param opts.userId - User who gets actAs rights (empty string = no user)
+     * @param opts.synchronizerId - Synchronizer to allocate on (auto-detected if omitted)
+     * @param opts.identityProviderId - Identity provider ID (empty string = default)
+     * @returns The allocated party ID
+     */
     allocateParty(partyIdHint: string, opts?: {
         userId?: string;
         synchronizerId?: string;
         identityProviderId?: string;
     }): Promise<string>;
+    /**
+     * Get the package ID for a package by name.
+     *
+     * POST /v2/interactive-submission/preferred-packages
+     *
+     * @param packageName - The package name (e.g., "layerzero-oft")
+     * @param parties - Parties whose vetting state should be considered
+     * @param opts.synchronizerId - Synchronizer to query (auto-detected if omitted)
+     * @returns The package ID (hash)
+     */
     getPackageId(packageName: string, parties: string[], opts?: {
         synchronizerId?: string;
     }): Promise<string>;
+    /**
+     * Get the current ledger end offset.
+     *
+     * GET /v2/state/ledger-end
+     *
+     * @returns The current ledger end offset
+     */
     getLedgerEndOffset(): Promise<number>;
+    /**
+     * Query active contracts at a given offset with optional template filtering.
+     *
+     * POST /v2/state/active-contracts
+     *
+     * @param party - Party to query as (for visibility)
+     * @param offset - Ledger offset to query at
+     * @param opts.templateIds - Template IDs to filter by (e.g., "packageId:Module:Template")
+     * @param opts.limit - Maximum number of contracts to return
+     * @returns Array of active contracts
+     */
     queryActiveContracts(party: string, offset: number, opts?: {
         templateIds?: string[];
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Query active contracts visible to any of the given parties (single API call).
+     *
+     * @param parties - Parties to query as (for visibility)
+     * @param offset - Ledger offset to query at
+     * @param templateIds - Template IDs to filter by
+     * @param opts.limit - Maximum number of contracts to return
+     * @returns Array of active contracts
+     */
     queryActiveContractsByParties(parties: string[], offset: number, templateIds: string[], opts?: {
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Stream updates from a given offset.
+     *
+     * POST /v2/updates
+     *
+     * @param party - Party to query as (for visibility)
+     * @param beginExclusive - Start offset (exclusive)
+     * @param endInclusive - End offset (inclusive)
+     * @param opts.templateIds - Template IDs to filter by
+     * @param opts.limit - Maximum number of updates to return
+     * @returns Array of all update types (Transaction, Reassignment, TopologyTransaction, OffsetCheckpoint)
+     */
     getUpdates(party: string, beginExclusive: number, endInclusive: number, opts?: {
         templateIds?: string[];
         limit?: number;