@layerzerolabs/common-canton 1.2.65 → 1.2.67

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

@@ -1,280 +0,0 @@
-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;
-    }): Promise<{
-        parties: string[];
-        nextPageToken: string;
-    }>;
-    /**
-     * List the parties the configured user can act/read as.
-     *
-     * Narrower than {@link listParties} (all parties on the node): use this when a
-     * call needs the caller's own read-scoped parties.
-     */
-    listUserParties(): Promise<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;
-        includeCreatedEventBlob?: boolean;
-    }): 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 that implement
-     * the given interfaces (single API call).
-     */
-    queryActiveContractsByInterface(parties: string[], offset: number, interfaceIds: string[], opts?: {
-        limit?: number;
-        includeCreatedEventBlob?: boolean;
-    }): 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[]>;
-}
-//# sourceMappingURL=canton-sdk.d.ts.map

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

@@ -1 +0,0 @@
-{"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;;;;;OAKG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIpC;;;;;;;;;;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,CAAC;QAAC,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GACrF,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;;;OAGG;IACH,+BAA+B,CAC3B,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EAAE,EACtB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,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/sdk/canton-sdk.js

@@ -1,5 +0,0 @@
-export { CantonSdk } from '../D52OIJDY.js';
-import '../3K5JL2TP.js';
-import '../VUOMXK5T.js';
-//# sourceMappingURL=canton-sdk.js.map
-//# sourceMappingURL=canton-sdk.js.map

package/dist/sdk/canton-sdk.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"canton-sdk.js"}

package/dist/sdk/index.d.ts

@@ -1,2 +0,0 @@
-export * from './canton-sdk';
-//# sourceMappingURL=index.d.ts.map

package/dist/sdk/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/sdk/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/sdk/index.js

@@ -1,6 +0,0 @@
-import '../5GUYLHA7.js';
-export { CantonSdk } from '../D52OIJDY.js';
-import '../3K5JL2TP.js';
-import '../VUOMXK5T.js';
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map

package/dist/sdk/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}