@fairmint/canton-node-sdk 0.0.268 → 0.0.269

package/build/src/utils/ledger/submit-commands.d.ts

@@ -0,0 +1,19 @@
+import { type LedgerJsonApiClient } from '../../clients';
+import { type LedgerSubmission, type SubmittedTransaction } from './types';
+export interface SubmitLedgerCommandsOptions {
+    /** Every command is pinned to this synchronizer. */
+    synchronizerId: string;
+    /**
+     * Package ids the participant prefers when resolving package-name-form template ids. Pinning the packages both
+     * confirming nodes vet keeps a multi-node workflow (for example a registrar and its operator) on the same code.
+     */
+    packageIdSelectionPreference?: readonly string[];
+}
+/**
+ * Submits commands and waits for the resulting transaction, returning its update id and created contracts.
+ *
+ * The command id is `${commandIdPrefix}-${randomUUID()}`: callers keep a stable, searchable prefix per logical action
+ * while each submission stays unique.
+ */
+export declare function submitLedgerCommands(client: LedgerJsonApiClient, submission: LedgerSubmission, options: SubmitLedgerCommandsOptions): Promise<SubmittedTransaction>;
+//# sourceMappingURL=submit-commands.d.ts.map

package/build/src/utils/ledger/submit-commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submit-commands.d.ts","sourceRoot":"","sources":["../../../../src/utils/ledger/submit-commands.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE3E,MAAM,WAAW,2BAA2B;IAC1C,oDAAoD;IACpD,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAClD;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,mBAAmB,EAC3B,UAAU,EAAE,gBAAgB,EAC5B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,oBAAoB,CAAC,CAqB/B"}

package/build/src/utils/ledger/submit-commands.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.submitLedgerCommands = submitLedgerCommands;
+const crypto_1 = require("crypto");
+const parsers_1 = require("../parsers");
+/**
+ * Submits commands and waits for the resulting transaction, returning its update id and created contracts.
+ *
+ * The command id is `${commandIdPrefix}-${randomUUID()}`: callers keep a stable, searchable prefix per logical action
+ * while each submission stays unique.
+ */
+async function submitLedgerCommands(client, submission, options) {
+    const response = await client.submitAndWaitForTransaction({
+        // LedgerCommand mirrors the API's JSON shapes with Record<string, unknown> arguments; the client's zod-inferred
+        // parameter type uses a recursive JsonValue, so the structurally-equal commands need this one cast.
+        commands: submission.commands,
+        commandId: `${submission.commandIdPrefix}-${(0, crypto_1.randomUUID)()}`,
+        actAs: submission.actAs,
+        synchronizerId: options.synchronizerId,
+        ...(options.packageIdSelectionPreference && options.packageIdSelectionPreference.length > 0
+            ? { packageIdSelectionPreference: [...options.packageIdSelectionPreference] }
+            : {}),
+        ...(submission.disclosedContracts && submission.disclosedContracts.length > 0
+            ? { disclosedContracts: submission.disclosedContracts }
+            : {}),
+    });
+    const events = (0, parsers_1.extractEventsFromTransaction)(response);
+    const updateId = response.transaction?.updateId ?? '';
+    return {
+        updateId,
+        created: events.created.map((e) => ({ contractId: e.contractId, templateId: e.templateId })),
+    };
+}
+//# sourceMappingURL=submit-commands.js.map

package/build/src/utils/ledger/submit-commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"submit-commands.js","sourceRoot":"","sources":["../../../../src/utils/ledger/submit-commands.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,wCAA0D;AAa1D;;;;;GAKG;AACI,KAAK,+BACV,MAA2B,EAC3B,UAA4B,EAC5B,OAAoC;IAEpC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,2BAA2B,CAAC;QACxD,gHAAgH;QAChH,oGAAoG;QACpG,QAAQ,EAAE,UAAU,CAAC,QAAyF;QAC9G,SAAS,EAAE,GAAG,UAAU,CAAC,eAAe,IAAI,IAAA,mBAAU,GAAE,EAAE;QAC1D,KAAK,EAAE,UAAU,CAAC,KAAK;QACvB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,GAAG,CAAC,OAAO,CAAC,4BAA4B,IAAI,OAAO,CAAC,4BAA4B,CAAC,MAAM,GAAG,CAAC;YACzF,CAAC,CAAC,EAAE,4BAA4B,EAAE,CAAC,GAAG,OAAO,CAAC,4BAA4B,CAAC,EAAE;YAC7E,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,UAAU,CAAC,kBAAkB,IAAI,UAAU,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAC3E,CAAC,CAAC,EAAE,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,EAAE;YACvD,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAA,sCAA4B,EAAC,QAAQ,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAI,QAAoD,CAAC,WAAW,EAAE,QAAQ,IAAI,EAAE,CAAC;IACnG,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;KAC7F,CAAC;AACJ,CAAC"}

package/build/src/utils/ledger/synchronizers.d.ts

@@ -0,0 +1,4 @@
+import { type LedgerJsonApiClient } from '../../clients';
+/** Ids of the synchronizers `party` is currently connected to. */
+export declare function getConnectedSynchronizerIds(client: LedgerJsonApiClient, party: string): Promise<string[]>;
+//# sourceMappingURL=synchronizers.d.ts.map

package/build/src/utils/ledger/synchronizers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"synchronizers.d.ts","sourceRoot":"","sources":["../../../../src/utils/ledger/synchronizers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzD,kEAAkE;AAClE,wBAAsB,2BAA2B,CAAC,MAAM,EAAE,mBAAmB,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAG/G"}

package/build/src/utils/ledger/synchronizers.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectedSynchronizerIds = getConnectedSynchronizerIds;
+/** Ids of the synchronizers `party` is currently connected to. */
+async function getConnectedSynchronizerIds(client, party) {
+    const { connectedSynchronizers } = await client.getConnectedSynchronizers({ party });
+    return (connectedSynchronizers ?? []).map((s) => s.synchronizerId);
+}
+//# sourceMappingURL=synchronizers.js.map

package/build/src/utils/ledger/synchronizers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synchronizers.js","sourceRoot":"","sources":["../../../../src/utils/ledger/synchronizers.ts"],"names":[],"mappings":";;;AAEA,kEAAkE;AAC3D,KAAK,sCAAsC,MAA2B,EAAE,KAAa;IAC1F,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,yBAAyB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACrF,OAAO,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;AACrE,CAAC"}

package/build/src/utils/ledger/types.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Shared types for reading contracts and submitting commands through the Ledger JSON API.
+ *
+ * `LedgerCommand` mirrors the API's command JSON with `Record<string, unknown>` arguments, so callers can build
+ * commands for templates the SDK has no generated types for (for example Digital Asset's proprietary Registry DARs).
+ * The schema-typed counterparts (`CreateCommand`, `CompositeCommand`, …) are exported from the package root too;
+ * `LedgerCommand` is the ergonomic variant for hand-built commands, converted at the submission boundary.
+ */
+import { type DisclosedContract } from '../../clients';
+export type { DisclosedContract };
+/** A contract as read from the active contract set, in package-id form (`<packageId>:<Module>:<Entity>`). */
+export interface ActiveContract {
+    contractId: string;
+    templateId: string;
+    createArgument: Record<string, unknown>;
+    createdEventBlob?: string;
+    synchronizerId: string;
+}
+export type LedgerCommand = {
+    CreateCommand: {
+        templateId: string;
+        createArguments: Record<string, unknown>;
+    };
+} | {
+    ExerciseCommand: {
+        templateId: string;
+        contractId: string;
+        choice: string;
+        choiceArgument: Record<string, unknown>;
+    };
+} | {
+    CreateAndExerciseCommand: {
+        templateId: string;
+        createArguments: Record<string, unknown>;
+        choice: string;
+        choiceArgument: Record<string, unknown>;
+    };
+};
+export interface LedgerSubmission {
+    /**
+     * Stable prefix identifying the logical action (for example one setup step); the submit helper appends a random
+     * suffix per submission so re-runs do not collide on the ledger's command-id deduplication.
+     */
+    commandIdPrefix: string;
+    actAs: string[];
+    commands: LedgerCommand[];
+    disclosedContracts?: DisclosedContract[];
+}
+export interface CreatedContract {
+    contractId: string;
+    templateId: string;
+}
+export interface SubmittedTransaction {
+    updateId: string;
+    created: CreatedContract[];
+}
+/** The package version a name resolves to for a set of parties on a synchronizer. */
+export interface PreferredPackage {
+    packageName: string;
+    packageId: string;
+    packageVersion: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/src/utils/ledger/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/utils/ledger/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAElC,6GAA6G;AAC7G,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,aAAa,GACrB;IACE,aAAa,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;CACjF,GACD;IACE,eAAe,EAAE;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACzC,CAAC;CACH,GACD;IACE,wBAAwB,EAAE;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACzC,CAAC;CACH,CAAC;AAEN,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B;AAED,qFAAqF;AACrF,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;CACxB"}

package/build/src/utils/ledger/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/src/utils/ledger/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/utils/ledger/types.ts"],"names":[],"mappings":""}

package/build/src/utils/ledger/user-rights.d.ts

@@ -0,0 +1,17 @@
+import { type LedgerJsonApiClient } from '../../clients';
+export interface UserActAsStatus {
+    /** The authenticated user's id. */
+    userId: string;
+    /** Which of the requested parties the user may NOT act as. */
+    missing: string[];
+    /** Whether the user holds the ParticipantAdmin right (required to upload DARs). */
+    participantAdmin: boolean;
+}
+/**
+ * Checks which of `parties` the authenticated user may act as, and whether it is a participant admin.
+ *
+ * Every caller should name its parties explicitly: a client's default party is typically the validator party, and
+ * falling back to it would read or act as the wrong party.
+ */
+export declare function checkUserActAs(client: LedgerJsonApiClient, parties: string[]): Promise<UserActAsStatus>;
+//# sourceMappingURL=user-rights.d.ts.map

package/build/src/utils/ledger/user-rights.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-rights.d.ts","sourceRoot":"","sources":["../../../../src/utils/ledger/user-rights.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,mFAAmF;IACnF,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAWD;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAc7G"}

package/build/src/utils/ledger/user-rights.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkUserActAs = checkUserActAs;
+function canActAsParty(right) {
+    // The request shape nests the right under `value`; the response schema does not. Accept both.
+    return right.kind?.CanActAs?.value?.party ?? right.kind?.CanActAs?.party;
+}
+/**
+ * Checks which of `parties` the authenticated user may act as, and whether it is a participant admin.
+ *
+ * Every caller should name its parties explicitly: a client's default party is typically the validator party, and
+ * falling back to it would read or act as the wrong party.
+ */
+async function checkUserActAs(client, parties) {
+    const { user } = await client.getAuthenticatedUser({});
+    // The schema requires the user, but a misbehaving participant can still omit it; fail with a clear error.
+    const userId = user?.id;
+    if (!userId)
+        throw new Error('The ledger did not return the authenticated user');
+    const { rights } = await client.listUserRights({ userId });
+    const actable = new Set((rights ?? []).map(canActAsParty).filter((p) => p !== undefined));
+    return {
+        userId,
+        missing: parties.filter((p) => !actable.has(p)),
+        participantAdmin: (rights ?? []).some((r) => r.kind?.ParticipantAdmin !== undefined),
+    };
+}
+//# sourceMappingURL=user-rights.js.map

package/build/src/utils/ledger/user-rights.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-rights.js","sourceRoot":"","sources":["../../../../src/utils/ledger/user-rights.ts"],"names":[],"mappings":";;;AAeA,SAAS,aAAa,CAAC,KAAgB;IACrC,8FAA8F;IAC9F,OAAO,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACI,KAAK,yBAAyB,MAA2B,EAAE,OAAiB;IACjF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;IACvD,0GAA0G;IAC1G,MAAM,MAAM,GAAI,IAAoC,EAAE,EAAE,CAAC;IACzD,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACjF,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,IAAI,GAAG,CACpB,CAAC,MAAM,IAAI,EAAE,CAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAC/F,CAAC;IACF,OAAO;QACL,MAAM;QACN,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/C,gBAAgB,EAAG,CAAC,MAAM,IAAI,EAAE,CAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,gBAAgB,KAAK,SAAS,CAAC;KACtG,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairmint/canton-node-sdk",
-  "version": "0.0.268",
+  "version": "0.0.269",
   "description": "Canton Node SDK",
   "keywords": [
     "canton",