@fairmint/canton-node-sdk 0.0.89 → 0.0.91

package/build/src/core/ws/WebSocketErrorUtils.d.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+/**
+ * Utility functions for consistent WebSocket error handling
+ */
+export declare class WebSocketErrorUtils {
+    /**
+     * Safely parses a message using multiple schemas, throwing descriptive errors if all fail
+     * @param msg - The message to parse
+     * @param schemas - Array of schemas to try in order
+     * @param operationName - Name of the operation for error context
+     * @returns The parsed message
+     * @throws CantonError if all schemas fail to parse
+     */
+    static parseWithFallback<T>(msg: unknown, schemas: Array<{
+        schema: z.ZodSchema<T>;
+        name: string;
+    }>, operationName: string): T;
+    /**
+     * Parses a union schema and returns the result without type assertion
+     * @param msg - The message to parse
+     * @param unionSchema - The Zod union schema
+     * @param operationName - Name of the operation for error context
+     * @returns The parsed message with proper typing
+     * @throws CantonError if parsing fails
+     */
+    static parseUnion<T>(msg: unknown, unionSchema: z.ZodSchema<T>, operationName: string): T;
+    /**
+     * Creates a safe JSON parser that throws descriptive errors
+     * @param data - Raw data to parse
+     * @param context - Context for error messages
+     * @returns Parsed JSON object
+     * @throws CantonError if JSON parsing fails
+     */
+    static safeJsonParse(data: string, context: string): unknown;
+}
+//# sourceMappingURL=WebSocketErrorUtils.d.ts.map

package/build/src/core/ws/WebSocketErrorUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketErrorUtils.d.ts","sourceRoot":"","sources":["../../../../src/core/ws/WebSocketErrorUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;GAEG;AACH,qBAAa,mBAAmB;IAC9B;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CAAC,CAAC,EACxB,GAAG,EAAE,OAAO,EACZ,OAAO,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,EACxD,aAAa,EAAE,MAAM,GACpB,CAAC;IAsBJ;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,EACjB,GAAG,EAAE,OAAO,EACZ,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAC3B,aAAa,EAAE,MAAM,GACpB,CAAC;IAmBJ;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;CAW7D"}

package/build/src/core/ws/WebSocketErrorUtils.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketErrorUtils = void 0;
+const zod_1 = require("zod");
+const errors_1 = require("../errors");
+/**
+ * Utility functions for consistent WebSocket error handling
+ */
+class WebSocketErrorUtils {
+    /**
+     * Safely parses a message using multiple schemas, throwing descriptive errors if all fail
+     * @param msg - The message to parse
+     * @param schemas - Array of schemas to try in order
+     * @param operationName - Name of the operation for error context
+     * @returns The parsed message
+     * @throws CantonError if all schemas fail to parse
+     */
+    static parseWithFallback(msg, schemas, operationName) {
+        const errors = [];
+        for (const { schema, name } of schemas) {
+            try {
+                return schema.parse(msg);
+            }
+            catch (error) {
+                if (error instanceof zod_1.z.ZodError) {
+                    errors.push(`${name}: ${error.issues.map(e => e.message).join(', ')}`);
+                }
+                else {
+                    errors.push(`${name}: ${error instanceof Error ? error.message : String(error)}`);
+                }
+            }
+        }
+        throw new errors_1.CantonError(`Failed to parse ${operationName} message with any expected schema. Errors: ${errors.join('; ')}`, 'VALIDATION_ERROR', { originalMessage: msg, attemptedSchemas: schemas.map(s => s.name) });
+    }
+    /**
+     * Parses a union schema and returns the result without type assertion
+     * @param msg - The message to parse
+     * @param unionSchema - The Zod union schema
+     * @param operationName - Name of the operation for error context
+     * @returns The parsed message with proper typing
+     * @throws CantonError if parsing fails
+     */
+    static parseUnion(msg, unionSchema, operationName) {
+        try {
+            return unionSchema.parse(msg);
+        }
+        catch (error) {
+            if (error instanceof zod_1.z.ZodError) {
+                throw new errors_1.CantonError(`Failed to parse ${operationName} message: ${error.issues.map(e => e.message).join(', ')}`, 'VALIDATION_ERROR', { originalMessage: msg, validationErrors: error.issues });
+            }
+            throw new errors_1.CantonError(`Failed to parse ${operationName} message: ${error instanceof Error ? error.message : String(error)}`, 'VALIDATION_ERROR', { originalMessage: msg });
+        }
+    }
+    /**
+     * Creates a safe JSON parser that throws descriptive errors
+     * @param data - Raw data to parse
+     * @param context - Context for error messages
+     * @returns Parsed JSON object
+     * @throws CantonError if JSON parsing fails
+     */
+    static safeJsonParse(data, context) {
+        try {
+            return JSON.parse(data);
+        }
+        catch (error) {
+            throw new errors_1.CantonError(`Failed to parse JSON in ${context}: ${error instanceof Error ? error.message : String(error)}`, 'VALIDATION_ERROR', { rawData: data, context });
+        }
+    }
+}
+exports.WebSocketErrorUtils = WebSocketErrorUtils;
+//# sourceMappingURL=WebSocketErrorUtils.js.map

package/build/src/core/ws/WebSocketErrorUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketErrorUtils.js","sourceRoot":"","sources":["../../../../src/core/ws/WebSocketErrorUtils.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,sCAAwC;AAExC;;GAEG;AACH,MAAa,mBAAmB;IAC9B;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CACtB,GAAY,EACZ,OAAwD,EACxD,aAAqB;QAErB,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;oBAChC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACzE,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,oBAAW,CACnB,mBAAmB,aAAa,8CAA8C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EACjG,kBAAkB,EAClB,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CACf,GAAY,EACZ,WAA2B,EAC3B,aAAqB;QAErB,IAAI,CAAC;YACH,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,oBAAW,CACnB,mBAAmB,aAAa,aAAa,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC1F,kBAAkB,EAClB,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,CAAC,MAAM,EAAE,CACzD,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,oBAAW,CACnB,mBAAmB,aAAa,aAAa,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EACrG,kBAAkB,EAClB,EAAE,eAAe,EAAE,GAAG,EAAE,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,IAAY,EAAE,OAAe;QAChD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,oBAAW,CACnB,2BAA2B,OAAO,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAC/F,kBAAkB,EAClB,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAC3B,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AApFD,kDAoFC"}

package/build/src/core/ws/index.d.ts

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

package/build/src/core/ws/index.d.ts.map

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

package/build/src/core/ws/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WebSocketClient"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/core/ws/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/ws/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC"}

package/build/src/generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi.d.ts

@@ -226,6 +226,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v2/parties/external/allocate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Allocate a new external party */
+        post: operations["postV2PartiesExternalAllocate"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v2/parties/participant-id": {
         parameters: {
             query?: never;
@@ -261,6 +278,23 @@ export interface paths {
         patch: operations["patchV2PartiesParty"];
         trace?: never;
     };
+    "/v2/parties/external/generate-topology": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Generate a topology for an external party */
+        post: operations["postV2PartiesExternalGenerate-topology"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v2/state/active-contracts": {
         parameters: {
             query?: never;
@@ -329,6 +363,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v2/updates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Query updates list (blocking call) */
+        post: operations["postV2Updates"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v2/updates/flats": {
         parameters: {
             query?: never;
@@ -338,7 +389,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Query flat transactions update list (blocking call) */
+        /** @description Query flat transactions update list (blocking call, deprecated: use v2/updates instead) */
         post: operations["postV2UpdatesFlats"];
         delete?: never;
         options?: never;
@@ -355,7 +406,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Query update transactions tree list (blocking call) */
+        /** @description Query update transactions tree list (blocking call, deprecated: use v2/updates instead) */
         post: operations["postV2UpdatesTrees"];
         delete?: never;
         options?: never;
@@ -647,6 +698,39 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /**
+         * AllocateExternalPartyRequest
+         * @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
+         */
+        AllocateExternalPartyRequest: {
+            /** @description TODO(#27670) support synchronizer aliases
+             *     Synchronizer ID on which to onboard the party
+             *     Required */
+            synchronizer: string;
+            /** @description TopologyTransactions to onboard the external party
+             *     Can contain:
+             *     - A namespace for the party.
+             *     This can be either a single NamespaceDelegation,
+             *     or DecentralizedNamespaceDefinition along with its authorized namespace owners in the form of NamespaceDelegations.
+             *     May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
+             *     - A PartyToKeyMapping to register the party's signing keys.
+             *     May be provided, if so it must be fully authorized by the signatures in this request combined with the existing topology state.
+             *     - A PartyToParticipant to register the hosting relationship of the party.
+             *     Must be provided.
+             *     Required */
+            onboardingTransactions?: components["schemas"]["SignedTransaction"][];
+            /** @description Optional signatures of the combined hash of all onboarding_transactions
+             *     This may be used instead of providing signatures on each individual transaction */
+            multiHashSignatures?: components["schemas"]["Signature"][];
+            /** @description The id of the ``Identity Provider``
+             *     If not set, assume the party is managed by the default identity provider.
+             *     Optional */
+            identityProviderId: string;
+        };
+        /** AllocateExternalPartyResponse */
+        AllocateExternalPartyResponse: {
+            partyId: string;
+        };
         /**
          * AllocatePartyRequest
          * @description Required authorization: ``HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id)``
@@ -1437,6 +1521,44 @@ export interface components {
              *     Optional */
             cumulative?: components["schemas"]["CumulativeFilter"][];
         };
+        /** GenerateExternalPartyTopologyRequest */
+        GenerateExternalPartyTopologyRequest: {
+            /** @description TODO(#27670) support synchronizer aliases
+             *     Required: synchronizer-id for which we are building this request. */
+            synchronizer: string;
+            /** @description Required: the actual party id will be constructed from this hint and a fingerprint of the public key */
+            partyHint: string;
+            /** @description Required: public key */
+            publicKey?: components["schemas"]["SigningPublicKey"];
+            /** @description Optional: if true, then the local participant will only be observing, not confirming. Default false. */
+            localParticipantObservationOnly: boolean;
+            /** @description Optional: other participant ids which should be confirming for this party */
+            otherConfirmingParticipantUids?: string[];
+            /**
+             * Format: int32
+             * @description Optional: Confirmation threshold >= 1 for the party. Defaults to all available confirmers (or if set to 0).
+             */
+            confirmationThreshold: number;
+            /** @description Optional: other observing participant ids for this party */
+            observingParticipantUids?: string[];
+        };
+        /**
+         * GenerateExternalPartyTopologyResponse
+         * @description Response message with topology transactions and the multi-hash to be signed.
+         */
+        GenerateExternalPartyTopologyResponse: {
+            /** @description the generated party id */
+            partyId: string;
+            /** @description the fingerprint of the supplied public key */
+            publicKeyFingerprint: string;
+            /** @description The serialized topology transactions which need to be signed and submitted as part of the allocate party process
+             *     Note that the serialization includes the versioning information. Therefore, the transaction here is serialized
+             *     as an `UntypedVersionedMessage` which in turn contains the serialized `TopologyTransaction` in the version
+             *     supported by the synchronizer. */
+            topologyTransactions?: string[];
+            /** @description the multi-hash which may be signed instead of each individual transaction */
+            multiHash: string;
+        };
         /**
          * GetActiveContractsRequest
          * @description If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,
@@ -2195,6 +2317,15 @@ export interface components {
             /** @description When true, the response will contain additional details on how the transaction was encoded and hashed
              *     This can be useful for troubleshooting of hash mismatches. Should only be used for debugging. */
             verboseHashing: boolean;
+            /** @description Maximum timestamp at which the transaction can be recorded onto the ledger via the synchronizer specified in the `PrepareSubmissionResponse`.
+             *     If submitted after it will be rejected even if otherwise valid, in which case it needs to be prepared and signed again
+             *     with a new valid max_record_time.
+             *     Use this to limit the time-to-life of a prepared transaction,
+             *     which is useful to know when it can definitely not be accepted
+             *     anymore and resorting to preparing another transaction for the same
+             *     intent is safe again.
+             *     Optional */
+            maxRecordTime?: string;
         };
         /**
          * JsPrepareSubmissionResponse
@@ -2833,6 +2964,26 @@ export interface components {
             /** @description The signing algorithm specification used to produce this signature */
             signingAlgorithmSpec: string;
         };
+        /** SignedTransaction */
+        SignedTransaction: {
+            transaction: string;
+            signatures?: components["schemas"]["Signature"][];
+        };
+        /** SigningPublicKey */
+        SigningPublicKey: {
+            /**
+             * @description The serialization format of the public key
+             * @example CRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
+             */
+            format: string;
+            /** @description Serialized public key in the format specified above */
+            keyData: string;
+            /**
+             * @description The key specification
+             * @example SIGNING_KEY_SPEC_EC_CURVE25519
+             */
+            keySpec: string;
+        };
         /**
          * SinglePartySignatures
          * @description Signatures provided by a single party
@@ -3951,6 +4102,46 @@ export interface operations {
             };
         };
     };
+    postV2PartiesExternalAllocate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AllocateExternalPartyRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllocateExternalPartyResponse"];
+                };
+            };
+            /** @description Invalid value for: body, Invalid value for: headers */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsCantonError"];
+                };
+            };
+        };
+    };
     "getV2PartiesParticipant-id": {
         parameters: {
             query?: never;
@@ -4070,6 +4261,46 @@ export interface operations {
             };
         };
     };
+    "postV2PartiesExternalGenerate-topology": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GenerateExternalPartyTopologyRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GenerateExternalPartyTopologyResponse"];
+                };
+            };
+            /** @description Invalid value for: body, Invalid value for: headers */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsCantonError"];
+                };
+            };
+        };
+    };
     "postV2StateActive-contracts": {
         parameters: {
             query?: {
@@ -4117,8 +4348,8 @@ export interface operations {
     };
     "getV2StateConnected-synchronizers": {
         parameters: {
-            query: {
-                party: string;
+            query?: {
+                party?: string;
                 participantId?: string;
             };
             header?: never;
@@ -4226,6 +4457,51 @@ export interface operations {
             };
         };
     };
+    postV2Updates: {
+        parameters: {
+            query?: {
+                /** @description maximum number of elements to return, this param is ignored if is bigger than server setting */
+                limit?: number;
+                /** @description timeout to complete and send result if no new elements are received (for open ended streams) */
+                stream_idle_timeout_ms?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GetUpdatesRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsGetUpdatesResponse"][];
+                };
+            };
+            /** @description Invalid value for: body, Invalid value for: query parameter limit, Invalid value for: query parameter stream_idle_timeout_ms, Invalid value for: headers */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["JsCantonError"];
+                };
+            };
+        };
+    };
     postV2UpdatesFlats: {
         parameters: {
             query?: {