@layerzerolabs/common-canton 0.2.98 → 0.2.99

package/dist/provider.d.ts

@@ -2,21 +2,51 @@ import { type ClientCredentialsTokenProviderConfig } from './auth/client-credent
 import type { TokenProvider } from './auth/token-provider';
 import { CantonGrpcClient } from './client/grpc';
 import type { ICantonClient } from './client/interface';
+/**
+ * Composite provider for Canton — bundles both transport layers and shared auth.
+ *
+ * - {@link client} — JSON Ledger API (commands, queries, updates)
+ * - {@link grpcClient} — gRPC Admin API (topology transactions, namespace queries)
+ * - {@link tokenProvider} — Shared Bearer-token source used by both transports
+ */
 export type CantonProvider = {
     client: ICantonClient;
     grpcClient: CantonGrpcClient;
     tokenProvider: TokenProvider;
 };
 export type CantonUriParams = {
+    /** Base URL of the JSON Ledger API (e.g. "http://localhost:5975") */
     jsonApiUrl: string;
+    /** Host:port of the gRPC Admin API (e.g. "localhost:5076") */
     adminApiHost: string;
+    /** Ledger API user ID (default: "participant_admin") */
     userId: string;
+    /** OAuth2 client credentials config — present only for non-local environments */
     oauth2?: ClientCredentialsTokenProviderConfig;
 };
+/**
+ * Parse a Canton provider URI into its constituent parts.
+ *
+ * URI format:
+ *   `<json-api-base>?admin-api=<host:port>&user-id=<id>[&token-url=...&client-id=...&client-secret=...&scope=...&audience=...]`
+ *
+ * The base URL (everything before the query string) is the JSON Ledger API endpoint.
+ * Canton-specific params are extracted and removed; any remaining query params are
+ * preserved on the JSON API URL.
+ */
 export declare function parseCantonUri(uri: string): CantonUriParams;
 export type CreateCantonProviderOptions = {
+    /** Raw provider URI (from provider config) */
     uri: string;
+    /** When true, uses LocalTokenProvider (self-signed JWTs) instead of OAuth2 */
     isLocal: boolean;
 };
+/**
+ * Create a {@link CantonProvider} from a provider URI.
+ *
+ * - **isLocal=true**: Uses {@link LocalTokenProvider} with admin-level access (self-signed JWTs).
+ * - **isLocal=false**: Uses {@link ClientCredentialsTokenProvider} with OAuth2 client
+ *   credentials extracted from the URI query parameters.
+ */
 export declare function createCantonProvider({ uri, isLocal, }: CreateCantonProviderOptions): CantonProvider;
 //# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,oCAAoC,EAC5C,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAcxD,MAAM,MAAM,cAAc,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;CAChC,CAAC;AAMF,MAAM,MAAM,eAAe,GAAG;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,oCAAoC,CAAC;CACjD,CAAC;AAYF,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAuC3D;AAMD,MAAM,MAAM,2BAA2B,GAAG;IAEtC,GAAG,EAAE,MAAM,CAAC;IAEZ,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AASF,wBAAgB,oBAAoB,CAAC,EACjC,GAAG,EACH,OAAO,GACV,EAAE,2BAA2B,GAAG,cAAc,CAmB9C"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,oCAAoC,EAC5C,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAOxD;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;CAChC,CAAC;AAMF,MAAM,MAAM,eAAe,GAAG;IAC1B,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,MAAM,CAAC,EAAE,oCAAoC,CAAC;CACjD,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAuC3D;AAMD,MAAM,MAAM,2BAA2B,GAAG;IACtC,8CAA8C;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,8EAA8E;IAC9E,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,EACjC,GAAG,EACH,OAAO,GACV,EAAE,2BAA2B,GAAG,cAAc,CAmB9C"}

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

@@ -2,38 +2,169 @@ import type { Choice, ContractId, Party, Template } from '@daml/types';
 import type { CantonTransaction, ICantonClient } from '../client/index';
 import type { ArchivedEvent, Command, CreatedEvent, DisclosedContract, JsActiveContract } from '../open-api/models';
 import type { Contract, ExternalSignature, NormalizedActiveContract, PreparedTransaction, SubmitActors, SubmitResult, WaitOptions, WaitResult } from '../types';
+/**
+ * High-level SDK for Canton/DAML contract operations.
+ *
+ * Users interact with this SDK, not CantonClient directly.
+ *
+ * @example
+ * ```ts
+ * import { CantonClient, CantonSdk } from '@layerzerolabs/common-canton';
+ *
+ * const client = new CantonClient(config, userId);
+ * const sdk = new CantonSdk(client);
+ *
+ * await sdk.submit({ actAs: [party] }, [cmd]);
+ * ```
+ */
 export declare class CantonSdk {
     #private;
     constructor(client: ICantonClient);
+    /**
+     * Build a create command using a generated DAML template.
+     *
+     * @param template The generated DAML template (e.g., StateCommitment)
+     * @param payload The contract payload
+     * @param packageId The package ID from the generated package's index.js
+     */
     buildCreate<T extends object, K, I extends string>(template: Template<T, K, I>, payload: T, packageId: string): Command;
+    /**
+     * Build an exercise command using a generated DAML choice.
+     *
+     * @param choice The generated DAML choice (e.g., StateCommitment.Archive)
+     * @param contractId The contract ID to exercise on
+     * @param args The choice arguments
+     * @param packageId The package ID from the generated package's index.js
+     */
     buildExercise<T extends object, C, R, K>(choice: Choice<T, C, R, K>, contractId: ContractId<T>, args: C, packageId: string): Command;
+    /**
+     * Submit commands to the ledger.
+     */
     submit(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<SubmitResult>;
+    /**
+     * Prepare commands for off-chain signing by external parties.
+     */
     prepareForSigning(actors: SubmitActors, commands: Command[], opts?: {
         disclosedContracts?: DisclosedContract[];
         commandId?: string;
     }): Promise<PreparedTransaction>;
+    /**
+     * Submit a pre-signed transaction (external party flow).
+     */
     submitSigned(prepared: PreparedTransaction, signatures: ExternalSignature[]): Promise<SubmitResult>;
+    /**
+     * Wait for a command to be accepted or rejected.
+     */
     waitForCommand(commandId: string, opts: WaitOptions): Promise<WaitResult>;
+    /**
+     * Fetch a specific contract by ID.
+     * Returns undefined if archived or not visible.
+     *
+     * @param contractId The contract ID to fetch
+     * @param parties Parties to use for visibility filtering
+     */
     get<T extends object>(contractId: ContractId<T>, parties: Party[]): Promise<Contract<T> | undefined>;
+    /**
+     * Fetch an update (transaction) by its ID.
+     *
+     * Use this to get created contract IDs after a command is accepted.
+     * The updateId comes from WaitResult.updateId.
+     *
+     * @param updateId The update ID from WaitResult
+     * @param parties Parties to filter events
+     * @returns Parsed update with events
+     *
+     * @example
+     * ```ts
+     * const waitResult = await sdk.waitForCommand(commandId, opts);
+     * if (waitResult.status === 'accepted') {
+     *     const tx = await sdk.fetchTransaction(waitResult.updateId, [party]);
+     *     const createdIds = (tx.events ?? [])
+     *         .filter(e => 'CreatedEvent' in e)
+     *         .map(e => e.CreatedEvent.contractId);
+     * }
+     * ```
+     */
     fetchTransaction(updateId: string, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Fetch a transaction by its offset.
+     *
+     * @param offset The ledger offset
+     * @param parties Parties to filter events
+     * @returns Parsed transaction with events and timestamps
+     */
     fetchTransactionByOffset(offset: number, parties: string[]): Promise<CantonTransaction>;
+    /**
+     * Fetch both the created and archived events for a contract by ID.
+     *
+     * @param contractId - The contract ID to look up
+     * @param parties - Parties to use for visibility filtering
+     */
     fetchEventsByContractId(contractId: string, parties: string[]): Promise<{
         created: CreatedEvent | undefined;
         archived: ArchivedEvent | undefined;
     }>;
+    /**
+     * Create a disclosure for a contract.
+     *
+     * Disclosures allow a party to share a contract's content with another party
+     * who isn't a stakeholder, enabling them to exercise choices that reference it.
+     *
+     * @param contractId The contract to create disclosure for
+     * @param parties Parties that have visibility to the contract
+     * @returns The disclosed contract, or undefined if contract not found
+     *
+     * @example
+     * ```ts
+     * // Alice creates disclosure for Bob to use
+     * const disclosure = await aliceSdk.createDisclosure(contractId, [aliceParty]);
+     * if (disclosure) {
+     *     // Bob uses the disclosure in his submission
+     *     await bobSdk.submit(
+     *         { actAs: [bobParty] },
+     *         [command],
+     *         { disclosedContracts: [disclosure] }
+     *     );
+     * }
+     * ```
+     */
     createDisclosure<T extends object>(contractId: ContractId<T>, parties: Party[]): Promise<DisclosedContract | undefined>;
+    /**
+     * Get connected synchronizers.
+     */
     connectedSynchronizers(): Promise<string[]>;
+    /**
+     * 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;
@@ -41,26 +172,92 @@ export declare class CantonSdk {
         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
+     *
+     * @example
+     * ```ts
+     * const offset = await sdk.getLedgerEndOffset();
+     * const contracts = await sdk.queryActiveContracts(party, offset, {
+     *     templateIds: ['packageId:SimpleRequest:SimpleRequest'],
+     *     limit: 100,
+     * });
+     * for (const contract of contracts) {
+     *     console.log(contract.createdEvent.contractId, contract.createdEvent.templateId);
+     * }
+     * ```
+     */
     queryActiveContracts(party: string, offset: number, opts?: {
         templateIds?: string[];
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Normalize a ledger API JsActiveContract to a flat shape (contractId, templateId, payload, synchronizerId).
+     * Useful when you only need these fields and not createdEvent / reassignmentCounter.
+     */
     static normalizeActiveContract(contract: JsActiveContract): NormalizedActiveContract;
+    /**
+     * Query active contracts visible to any of the given parties (single API call).
+     */
     queryActiveContractsByParties(parties: string[], offset: number, templateIds: string[], opts?: {
         limit?: number;
     }): Promise<JsActiveContract[]>;
+    /**
+     * Query active contracts visible to any of the given parties, deduplicated by contractId.
+     * Returns normalized contracts (flat shape). Use when you need a merged view across multiple parties.
+     *
+     * @param parties - Party IDs to query as (contracts visible to any party are included, each contract once)
+     * @param opts - Optional templateIds and limit (passed per-party to the ledger API); optional templateFilter (applied after fetch)
+     */
     queryActiveContractsForParties(parties: string[], opts?: {
         templateIds?: string[];
         limit?: number;
+        /** If provided, only contracts whose templateId passes this predicate are returned. */
         templateFilter?: (templateId: string) => boolean;
     }): Promise<NormalizedActiveContract[]>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"canton-sdk.d.ts","sourceRoot":"","sources":["../../src/sdk/canton-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAExE,OAAO,KAAK,EACR,aAAa,EACb,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACR,QAAQ,EACR,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACb,MAAM,UAAU,CAAC;AAiBlB,qBAAa,SAAS;;gBAGN,MAAM,EAAE,aAAa;IAmDjC,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,EAC7C,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,EAAE,CAAC,EACV,SAAS,EAAE,MAAM,GAClB,OAAO;IAsBV,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACnC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC1B,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,IAAI,EAAE,CAAC,EACP,SAAS,EAAE,MAAM,GAClB,OAAO;IAyBV,MAAM,CACF,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,CAAC,EAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACxE,OAAO,CAAC,YAAY,CAAC;IAOxB,iBAAiB,CACb,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,CAAC,EAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACxE,OAAO,CAAC,mBAAmB,CAAC;IAO/B,YAAY,CACR,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,iBAAiB,EAAE,GAChC,OAAO,CAAC,YAAY,CAAC;IAOxB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAenE,GAAG,CAAC,CAAC,SAAS,MAAM,EACtB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,KAAK,EAAE,GACjB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IA0BnC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAWjF,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAUvF,uBAAuB,CACnB,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;IAgCtF,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC7B,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,KAAK,EAAE,GACjB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAWzC,sBAAsB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAW3C,SAAS,CACL,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GACrF,OAAO,CAAC,MAAM,CAAC;IASlB,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAa5F,WAAW,CAAC,IAAI,CAAC,EAAE;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;IAezD,aAAa,CACT,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,GACjF,OAAO,CAAC,MAAM,CAAC;IAclB,YAAY,CACR,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GACnC,OAAO,CAAC,MAAM,CAAC;IAelB,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IA2BrC,oBAAoB,CAChB,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;IAQ9B,MAAM,CAAC,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,wBAAwB;IAapF,6BAA6B,CACzB,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;IAWxB,8BAA8B,CAChC,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,CAAC,EAAE;QACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC;KACpD,GACF,OAAO,CAAC,wBAAwB,EAAE,CAAC;CAsBzC"}
+{"version":3,"file":"canton-sdk.d.ts","sourceRoot":"","sources":["../../src/sdk/canton-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAExE,OAAO,KAAK,EACR,aAAa,EACb,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACR,QAAQ,EACR,iBAAiB,EACjB,wBAAwB,EACxB,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,UAAU,EACb,MAAM,UAAU,CAAC;AAElB;;;;;;;;;;;;;;GAcG;AACH,qBAAa,SAAS;;gBAGN,MAAM,EAAE,aAAa;IA4CjC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,EAC7C,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,EAAE,CAAC,EACV,SAAS,EAAE,MAAM,GAClB,OAAO;IAcV;;;;;;;OAOG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACnC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC1B,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,IAAI,EAAE,CAAC,EACP,SAAS,EAAE,MAAM,GAClB,OAAO;IAsBV;;OAEG;IACH,MAAM,CACF,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,CAAC,EAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACxE,OAAO,CAAC,YAAY,CAAC;IAIxB;;OAEG;IACH,iBAAiB,CACb,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,OAAO,EAAE,EACnB,IAAI,CAAC,EAAE;QAAE,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACxE,OAAO,CAAC,mBAAmB,CAAC;IAI/B;;OAEG;IACH,YAAY,CACR,QAAQ,EAAE,mBAAmB,EAC7B,UAAU,EAAE,iBAAiB,EAAE,GAChC,OAAO,CAAC,YAAY,CAAC;IAIxB;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAQzE;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,SAAS,MAAM,EACtB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,KAAK,EAAE,GACjB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAKnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIjF;;;;;;OAMG;IACH,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIvF;;;;;OAKG;IACH,uBAAuB,CACnB,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;IAQtF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC7B,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,OAAO,EAAE,KAAK,EAAE,GACjB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAQzC;;OAEG;IACH,sBAAsB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAI3C;;;;;;OAMG;IACH,SAAS,CACL,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAC5B,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GACrF,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5F;;;;;;;;OAQG;IACH,WAAW,CAAC,IAAI,CAAC,EAAE;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC;IAIzD;;;;;;;;;;OAUG;IACH,aAAa,CACT,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,GACjF,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;;;;OASG;IACH,YAAY,CACR,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GACnC,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;;;OAMG;IACH,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAChB,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;IAI9B;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,wBAAwB;IAUpF;;OAEG;IACH,6BAA6B,CACzB,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;IAI9B;;;;;;OAMG;IACG,8BAA8B,CAChC,OAAO,EAAE,MAAM,EAAE,EACjB,IAAI,CAAC,EAAE;QACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,uFAAuF;QACvF,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC;KACpD,GACF,OAAO,CAAC,wBAAwB,EAAE,CAAC;CAsBzC"}

package/dist/transaction.d.ts

@@ -33,6 +33,12 @@ export declare const cantonDisclosedContractSchema: z.ZodObject<{
     createdEventBlob: z.ZodString;
     synchronizerId: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Canton transaction schema for Daml Ledger API commands.
+ *
+ * Canton uses an interactive submission (prepare-sign-submit) flow for external party signing.
+ * The populatedTransaction contains the commands to send to prepareForSigning.
+ */
 export declare const cantonTransactionSchema: z.ZodObject<{
     properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     chainName: z.ZodString;
@@ -83,6 +89,9 @@ export declare const cantonTransactionSchema: z.ZodObject<{
         partyToSenderEntity: z.ZodRecord<z.ZodString, z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Assigned transaction includes the inflight transaction data.
+ */
 export declare const cantonAssignedTransactionSchema: z.ZodObject<{
     senderEntityName: z.ZodString;
     nonce: z.ZodNumber;
@@ -144,6 +153,9 @@ export declare const cantonAssignedTransactionSchema: z.ZodObject<{
         partyToSenderEntity: z.ZodRecord<z.ZodString, z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Signed transaction includes the DER-encoded ECDSA signature.
+ */
 export declare const cantonSignedTransactionSchema: z.ZodObject<{
     signedTransaction: z.ZodObject<{
         signatures: z.ZodArray<z.ZodObject<{
@@ -216,6 +228,9 @@ export declare const cantonSignedTransactionSchema: z.ZodObject<{
         partyToSenderEntity: z.ZodRecord<z.ZodString, z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Mined transaction with confirmation result.
+ */
 export declare const cantonMinedTransactionSchema: z.ZodObject<{
     result: z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"success">;
@@ -223,7 +238,9 @@ export declare const cantonMinedTransactionSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"error">;
         error: z.ZodString;
-    }, z.core.$strip>, z.ZodObject<{
+    }, z.core.$strip>, z.
+    /** Output of prepareForSigning — needed by submitSigned to execute the transaction. */
+    ZodObject<{
         type: z.ZodLiteral<"indeterminate">;
         meta: z.ZodAny;
     }, z.core.$strip>], "type">;

package/dist/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAiCjE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;mBAK9B,CAAC;AAIH,eAAO,MAAM,6BAA6B;;;;;iBAKxC,CAAC;AAUH,eAAO,MAAM,uBAAuB;gBAtDL,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqDR,CAAC;AAoBH,eAAO,MAAM,+BAA+B;sBApDlB,EAAG,SAAS;WAAY,EAAG,SAAS;;;;;;;;;;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4ER,CAAC;AAKH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;sBA5DhB,EAAG,SAAS;WAAY,EAAG,SAAS;;;;;;;;;;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmGR,CAAC;AAKH,eAAO,MAAM,4BAA4B;YAxDW,EAAG,qBACvC,EAAE,EAAE,SAAS;cAAgB,EAAG,UAAU;qBACnC,EAAG,SAAS;OAAQ,EAAG,IAAI,CAAC,MAAM,GAAE,EAAG,SAAS;cAAgB,EAC/E,UAAG;eAAyB,EAAG,SAAS;OAAQ,EAAG,IAC3D,CAAI,MAAG,GACN,EAGD,SADQ;cAAgB,EAAG,UAAU;cAAgC,EAAG,MAAM;OAAQ,EACrF,IAAI,CAAC,MAAM;;;;;;;;;;;;;;;;;;;;;sBAnCc,EAAG,SAAS;WAAY,EAAG,SAAS;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2GR,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC/D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAC/E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEzE,MAAM,MAAM,2BAA2B,GAAG,SAAS,CAAC,QAAQ,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC;AAE1F,eAAO,MAAM,sBAAsB,GAC/B,WAAW,MAAM,EACjB,IAAI,2BAA2B,KAChC,OAAO,CAAC,QAAQ,CAQlB,CAAC"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAiCjE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;mBAK9B,CAAC;AAIH,eAAO,MAAM,6BAA6B;;;;;iBAKxC,CAAC;AAIH;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;gBAtDL,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqDR,CAAC;AAiBH;;GAEG;AACH,eAAO,MAAM,+BAA+B;sBApDlB,EAAG,SAAS;WAAY,EAAG,SAAS;;;;;;;;;;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4ER,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;sBA5DhB,EAAG,SAAS;WAAY,EAAG,SAAS;;;;;;;;;;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmGR,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,4BAA4B;YAxDW,EAAG,qBACvC,EAAE,EAAE,SAAS;cAAgB,EAAG,UAAU;qBACnC,EAAG,SAAS;OAAQ,EAAG,IAAI,CAAC,MAAM,GAAE,EAAG,SAAS;cAAgB,EAC/E,UAAG;eAAyB,EAAG,SAAS;OAAQ,EAAG,IAC3D,CAAI,MAAG,GACN;IAED,uFAAuF;IACvF,SADQ;cAAgB,EAAG,UAAU;cAAgC,EAAG,MAAM;OAAQ,EACrF,IAAI,CAAC,MAAM;;;;;;;;;;;;;;;;;;;;;sBAnCc,EAAG,SAAS;WAAY,EAAG,SAAS;gBAjC/B,EAAG,WAAW,CAAE,EAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,MAAM;eAC5E,EAAE,SAAS;gBAAiB,EAAG,SAAS;iBAAmB,EAAG,SAAS;uBAC5D,EAAE,WAAW,CAAE,EAAC,SAAS;gBAAkB,EAAG,WAAW,CAEvE,EAAA,SAAS;cAAiB,EAAE,WAC5B,CAAI,EAAA,SAAQ;mBACP,EAAG,WAAW,CAAE,EAAC,SACrB;OAEK,EAAE,IAAI,CAAC,MAAM;UAAY,EAAG,WAC9B,CAAC,EAAE,SAAS;sBACJ,EAAI,WAAU,CACtB,EAAA,SAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2GR,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC/D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAC/E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEzE,MAAM,MAAM,2BAA2B,GAAG,SAAS,CAAC,QAAQ,EAAE,WAAW,GAAG,YAAY,CAAC,CAAC;AAE1F,eAAO,MAAM,sBAAsB,GAC/B,WAAW,MAAM,EACjB,IAAI,2BAA2B,KAChC,OAAO,CAAC,QAAQ,CAQlB,CAAC"}

package/dist/types.d.ts

@@ -1,11 +1,23 @@
 import type { ContractId, Party } from '@daml/types';
+/**
+ * Core Types
+ */
 export type TemplateId = string;
+/**
+ * Build a Canton template ID from a package ID and module path.
+ *
+ * @example buildTemplateId('abc123', 'RequestFactory:RequestFactory')
+ * // => 'abc123:RequestFactory:RequestFactory'
+ */
 export declare const buildTemplateId: (packageId: string, modulePath: string) => TemplateId;
 export type Contract<T extends object> = {
     templateId: TemplateId;
     contractId: ContractId<T>;
     payload: T;
 };
+/**
+ * Submission Types
+ */
 export type SubmitActors = {
     actAs: Party[];
     readAs?: Party[];
@@ -14,6 +26,9 @@ export type SubmitResult = {
     commandId: string;
     completionOffset: number;
 };
+/**
+ * Wait / Reconciliation Types
+ */
 export declare const CommandStatus: {
     readonly Accepted: "accepted";
     readonly Rejected: "rejected";
@@ -55,19 +70,35 @@ export type WaitOptions = {
         };
     };
 };
+/**
+ * External Party / Interactive Submission Types
+ */
+/**
+ * A prepared transaction ready for external signing.
+ */
 export type PreparedTransaction = {
+    /** The transaction blob to sign */
     preparedTransaction: string;
+    /** Hash of the transaction (sign this) */
     preparedTransactionHash: string;
+    /** Hashing scheme version used */
     hashingSchemeVersion: 'HASHING_SCHEME_VERSION_UNSPECIFIED' | 'HASHING_SCHEME_VERSION_V2';
+    /** Command ID for tracking */
     commandId: string;
 };
 export type ExternalSignature = {
+    /** The party that signed */
     party: Party;
+    /** The signature bytes (base64 or hex) */
     signature: string;
+    /** Fingerprint/ID of the signing key */
     signedBy: string;
+    /** Signature format (e.g., 'Raw') */
     format: string;
+    /** Signing algorithm (e.g., 'Ed25519') */
     signingAlgorithmSpec: string;
 };
+/** Normalized active contract (flat shape derived from JsActiveContract). */
 export type NormalizedActiveContract = {
     contractId: string;
     templateId: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAKrD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAQhC,eAAO,MAAM,eAAe,GAAI,WAAW,MAAM,EAAE,YAAY,MAAM,KAAG,UACxC,CAAC;AAEjC,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI;IACrC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC;CACd,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAKF,eAAO,MAAM,aAAa;;;;CAIhB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,OAAO,aAAa,CAAC,QAAQ,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,OAAO,aAAa,CAAC,QAAQ,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAChE,CAAC;AACF,KAAK,WAAW,GAAG;IACf,MAAM,EAAE,OAAO,aAAa,CAAC,OAAO,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;AAEnE,MAAM,MAAM,WAAW,GAAG;IACtB,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,SAAS,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;KAChD,CAAC;CACL,CAAC;AASF,MAAM,MAAM,mBAAmB,GAAG;IAE9B,mBAAmB,EAAE,MAAM,CAAC;IAE5B,uBAAuB,EAAE,MAAM,CAAC;IAEhC,oBAAoB,EAAE,oCAAoC,GAAG,2BAA2B,CAAC;IAEzF,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE5B,KAAK,EAAE,KAAK,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,MAAM,CAAC;IAEf,oBAAoB,EAAE,MAAM,CAAC;CAChC,CAAC;AAGF,MAAM,MAAM,wBAAwB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,WAAW,MAAM,EAAE,YAAY,MAAM,KAAG,UACxC,CAAC;AAEjC,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI;IACrC,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;CAIhB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,OAAO,aAAa,CAAC,QAAQ,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,KAAK,YAAY,GAAG;IAChB,MAAM,EAAE,OAAO,aAAa,CAAC,QAAQ,CAAC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAChE,CAAC;AACF,KAAK,WAAW,GAAG;IACf,MAAM,EAAE,OAAO,aAAa,CAAC,OAAO,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;AAEnE,MAAM,MAAM,WAAW,GAAG;IACtB,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,SAAS,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;KAChD,CAAC;CACL,CAAC;AAEF;;GAEG;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,mCAAmC;IACnC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,0CAA0C;IAC1C,uBAAuB,EAAE,MAAM,CAAC;IAChC,kCAAkC;IAClC,oBAAoB,EAAE,oCAAoC,GAAG,2BAA2B,CAAC;IACzF,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,4BAA4B;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,oBAAoB,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,wBAAwB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/common-canton",
-  "version": "0.2.98",
+  "version": "0.2.99",
   "private": false,
   "description": "Canton VM client and utilities",
   "license": "MIT",
@@ -21,8 +21,8 @@
     "@protobuf-ts/grpc-transport": "^2.9.4",
     "es-toolkit": "^1.39.10",
     "zod": "4.3.5",
-    "@layerzerolabs/common-chain-model": "0.2.98",
-    "@layerzerolabs/typescript-utils": "0.2.98"
+    "@layerzerolabs/common-chain-model": "0.2.99",
+    "@layerzerolabs/typescript-utils": "0.2.99"
   },
   "devDependencies": {
     "@types/node": "^22.18.6",
@@ -31,12 +31,12 @@
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
     "vitest": "^3.2.3",
-    "@layerzerolabs/eslint-configuration": "^0.2.98",
-    "@layerzerolabs/tsup-configuration": "0.2.98",
-    "@layerzerolabs/typescript-configuration": "0.2.98",
-    "@layerzerolabs/ver-signer-adapter": "0.2.98",
-    "@layerzerolabs/vitest-configuration": "0.2.98",
-    "@layerzerolabs/vm-tooling-canton": "0.2.98"
+    "@layerzerolabs/eslint-configuration": "^0.2.99",
+    "@layerzerolabs/typescript-configuration": "0.2.99",
+    "@layerzerolabs/tsup-configuration": "0.2.99",
+    "@layerzerolabs/ver-signer-adapter": "0.2.99",
+    "@layerzerolabs/vitest-configuration": "0.2.99",
+    "@layerzerolabs/vm-tooling-canton": "0.2.99"
   },
   "publishConfig": {
     "access": "restricted",

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-    "extends": ["@layerzerolabs/typescript-configuration/tsconfig.bundler.json"],
+    "extends": ["@layerzerolabs/typescript-configuration/tsconfig.base.json"],
     "compilerOptions": {
         "rootDir": "./src",
         "outDir": "./dist",