@fairmint/canton-node-sdk 0.0.266 → 0.0.268

package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.js

@@ -1,126 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetActiveContracts = void 0;
-const zod_1 = require("zod");
-const errors_1 = require("../../../../../core/errors");
-const HttpClient_1 = require("../../../../../core/http/HttpClient");
 const WebSocketClient_1 = require("../../../../../core/ws/WebSocketClient");
-const errors_2 = require("../../../schemas/api/errors");
-const state_1 = require("../../../schemas/api/state");
-const event_format_builder_1 = require("../utils/event-format-builder");
-const path = '/v2/state/active-contracts';
-/**
- * Idle timeout for the active-contracts snapshot stream.
- *
- * The snapshot is a bounded stream that the server closes on its own, so silence this long means the connection is hung
- * rather than slow. Callers that expect longer gaps can raise it or pass `0` to wait indefinitely.
- *
- * Intentionally reuses {@link DEFAULT_HTTP_TIMEOUT_MS} rather than an independent literal: both exist to detect a hung
- * connection at the same "this is clearly stuck" horizon.
- */
-const DEFAULT_IDLE_TIMEOUT_MS = HttpClient_1.DEFAULT_HTTP_TIMEOUT_MS;
-/**
- * We intentionally do not expose the JSON/REST version of this endpoint. The REST variant is too limited, while the
- * WebSocket variant returns the same snapshot and automatically closes the connection once the current state is sent.
- * Wrapping the WebSocket call behind a simple awaitable method gives a better DX and keeps the door open for optional
- * streaming via a callback.
- */
-const ActiveContractsParamsSchema = zod_1.z.object({
-    /** Optional list of parties to scope the filter. */
-    parties: zod_1.z.array(zod_1.z.string()).optional(),
-    /** Optional template filters applied server-side. */
-    templateIds: zod_1.z.array(zod_1.z.string()).optional(),
-    /** Optional interface filters applied server-side. */
-    interfaceIds: zod_1.z.array(zod_1.z.string()).optional(),
-    /** Include interface views in InterfaceFilter results (default true). */
-    includeInterfaceView: zod_1.z.boolean().optional(),
-    /** Include created event blobs in template and interface filter results (default false). */
-    includeCreatedEventBlob: zod_1.z.boolean().optional(),
-    /** Allow caller to omit activeAtOffset; we'll default to ledger end */
-    activeAtOffset: zod_1.z.number().optional(),
-    /** Fail the snapshot when no message arrives for this many milliseconds. `0` waits indefinitely. */
-    idleTimeoutMs: zod_1.z.number().min(0).optional(),
-});
+const active_contracts_request_1 = require("./active-contracts-request");
 class GetActiveContracts {
     constructor(client) {
         this.client = client;
     }
     async execute(params) {
-        const validated = ActiveContractsParamsSchema.parse(params);
-        // Determine activeAtOffset (default to ledger end if not specified)
-        let activeAtOffset;
-        if (validated.activeAtOffset !== undefined) {
-            ({ activeAtOffset } = validated);
-        }
-        else {
-            const ledgerEnd = await this.client.getLedgerEnd({});
-            const { offset } = ledgerEnd;
-            if (offset === undefined) {
-                throw new errors_1.ApiError('Ledger end response did not include an offset');
-            }
-            activeAtOffset = offset;
-        }
-        // Build party list - default to client's party list if not provided
-        const partyList = validated.parties && validated.parties.length > 0 ? validated.parties : this.client.buildPartyList();
-        // Build event format
-        const eventFormat = (0, event_format_builder_1.buildEventFormat)({
-            parties: partyList,
-            ...(validated.templateIds !== undefined && { templateIds: validated.templateIds }),
-            ...(validated.interfaceIds !== undefined && { interfaceIds: validated.interfaceIds }),
-            ...(validated.includeInterfaceView !== undefined && {
-                includeInterfaceView: validated.includeInterfaceView,
-            }),
-            ...(validated.includeCreatedEventBlob !== undefined && {
-                includeCreatedEventBlob: validated.includeCreatedEventBlob,
-            }),
-        });
-        const ActiveContractsResponseMessageSchema = zod_1.z.union([
-            state_1.JsGetActiveContractsResponseItemSchema,
-            errors_2.JsCantonErrorSchema,
-            errors_2.WsCantonErrorSchema,
-        ]);
-        const requestMessage = {
-            verbose: false,
-            activeAtOffset,
-            eventFormat,
-        };
+        const { requestMessage, idleTimeoutMs } = await (0, active_contracts_request_1.buildActiveContractsRequest)(this.client, params);
         const wsClient = new WebSocketClient_1.WebSocketClient(this.client);
         return new Promise((resolve, reject) => {
             const results = [];
             let settled = false;
-            /** Convert a Canton error response to a proper Error object */
-            const toError = (errorResponse) => {
-                // JsCantonError has 'message' string, WsCantonError has 'cause' string
-                // JsCantonError has code as object, WsCantonError has code as string
-                if ('cause' in errorResponse) {
-                    // WsCantonError
-                    return new errors_1.ApiError(`WebSocket error [${errorResponse.code}]: ${errorResponse.cause}`);
-                }
-                // JsCantonError
-                const codeStr = JSON.stringify(errorResponse.code);
-                return new errors_1.ApiError(`WebSocket error [${codeStr}]: ${errorResponse.message}`);
-            };
             void wsClient
-                .connect(path, requestMessage, {
+                .connect(active_contracts_request_1.ACTIVE_CONTRACTS_PATH, requestMessage, {
                 onMessage: async (parsed) => {
-                    const decoded = ActiveContractsResponseMessageSchema.safeParse(parsed);
-                    if (!decoded.success) {
-                        throw new errors_1.ApiError('Unexpected active-contracts WebSocket message');
-                    }
-                    const message = decoded.data;
-                    // Distinguish item vs error union members
-                    if ('contractEntry' in message) {
-                        results.push(message);
+                    const frame = (0, active_contracts_request_1.decodeActiveContractsFrame)(parsed);
+                    if ('item' in frame) {
+                        results.push(frame.item);
                         if (typeof params.onItem === 'function') {
-                            await params.onItem(message);
+                            await params.onItem(frame.item);
                         }
                     }
                     else if (!settled) {
-                        // Treat any non-item as an error message
-                        const error = toError(message);
                         settled = true;
-                        reject(error);
-                        throw error;
+                        reject(frame.error);
+                        throw frame.error;
                     }
                 },
                 onError: (err) => {
@@ -129,13 +35,19 @@ class GetActiveContracts {
                         reject(err instanceof Error ? err : new Error(String(err)));
                     }
                 },
-                onClose: () => {
+                onClose: (code, reason) => {
                     if (!settled) {
                         settled = true;
-                        resolve(results);
+                        const error = (0, active_contracts_request_1.activeContractsCloseError)(code, reason);
+                        if (error === undefined) {
+                            resolve(results);
+                        }
+                        else {
+                            reject(error);
+                        }
                     }
                 },
-            }, { idleTimeoutMs: validated.idleTimeoutMs ?? DEFAULT_IDLE_TIMEOUT_MS })
+            }, { idleTimeoutMs })
                 .catch((err) => {
                 if (!settled) {
                     settled = true;

package/build/src/clients/ledger-json-api/operations/v2/state/get-active-contracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-active-contracts.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/get-active-contracts.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uDAAsD;AACtD,oEAA8E;AAC9E,4EAAyE;AAEzE,wDAKqC;AACrC,sDAIoC;AACpC,wEAAiE;AAEjE,MAAM,IAAI,GAAG,4BAAqC,CAAC;AAEnD;;;;;;;;GAQG;AACH,MAAM,uBAAuB,GAAG,oCAAuB,CAAC;AAExD;;;;;GAKG;AAEH,MAAM,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,oDAAoD;IACpD,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,qDAAqD;IACrD,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,sDAAsD;IACtD,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,yEAAyE;IACzE,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,4FAA4F;IAC5F,uBAAuB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,uEAAuE;IACvE,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,oGAAoG;IACpG,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAOH;IACE,YAA6B,MAA2B;sBAA3B,MAAM;IAAwB,CAAC;IAErD,KAAK,CAAC,OAAO,CAAC,MAAgC;QACnD,MAAM,SAAS,GAAG,2BAA2B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5D,oEAAoE;QACpE,IAAI,cAAsB,CAAC;QAC3B,IAAI,SAAS,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC3C,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACrD,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;YAC7B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,IAAI,iBAAQ,CAAC,+CAA+C,CAAC,CAAC;YACtE,CAAC;YACD,cAAc,GAAG,MAAM,CAAC;QAC1B,CAAC;QAED,oEAAoE;QACpE,MAAM,SAAS,GACb,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAEvG,qBAAqB;QACrB,MAAM,WAAW,GAAG,IAAA,uCAAgB,EAAC;YACnC,OAAO,EAAE,SAAS;YAClB,GAAG,CAAC,SAAS,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC;YAClF,GAAG,CAAC,SAAS,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,YAAY,EAAE,CAAC;YACrF,GAAG,CAAC,SAAS,CAAC,oBAAoB,KAAK,SAAS,IAAI;gBAClD,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;aACrD,CAAC;YACF,GAAG,CAAC,SAAS,CAAC,uBAAuB,KAAK,SAAS,IAAI;gBACrD,uBAAuB,EAAE,SAAS,CAAC,uBAAuB;aAC3D,CAAC;SACH,CAAC,CAAC;QASH,MAAM,oCAAoC,GAAG,OAAC,CAAC,KAAK,CAAC;YACnD,8CAAsC;YACtC,4BAAmB;YACnB,4BAAmB;SACpB,CAAC,CAAC;QAEH,MAAM,cAAc,GAAkC;YACpD,OAAO,EAAE,KAAK;YACd,cAAc;YACd,WAAW;SACZ,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElD,OAAO,IAAI,OAAO,CAA+B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnE,MAAM,OAAO,GAAiC,EAAE,CAAC;YACjD,IAAI,OAAO,GAAG,KAAK,CAAC;YAEpB,+DAA+D;YAC/D,MAAM,OAAO,GAAG,CAAC,aAA4C,EAAS,EAAE;gBACtE,uEAAuE;gBACvE,qEAAqE;gBACrE,IAAI,OAAO,IAAI,aAAa,EAAE,CAAC;oBAC7B,gBAAgB;oBAChB,OAAO,IAAI,iBAAQ,CAAC,oBAAoB,aAAa,CAAC,IAAI,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;gBACzF,CAAC;gBACD,gBAAgB;gBAChB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBACnD,OAAO,IAAI,iBAAQ,CAAC,oBAAoB,OAAO,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;YAChF,CAAC,CAAC;YAEF,KAAK,QAAQ;iBACV,OAAO,CACN,IAAI,EACJ,cAAc,EACd;gBACE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAiB,EAAE;oBACzC,MAAM,OAAO,GAAG,oCAAoC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;oBACvE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;wBACrB,MAAM,IAAI,iBAAQ,CAAC,+CAA+C,CAAC,CAAC;oBACtE,CAAC;oBACD,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;oBAE7B,0CAA0C;oBAC1C,IAAI,eAAe,IAAI,OAAO,EAAE,CAAC;wBAC/B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBACtB,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;4BACxC,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAC/B,CAAC;oBACH,CAAC;yBAAM,IAAI,CAAC,OAAO,EAAE,CAAC;wBACpB,yCAAyC;wBACzC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;wBAC/B,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,CAAC,KAAK,CAAC,CAAC;wBACd,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;oBACf,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE;oBACZ,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,OAAO,CAAC,OAAO,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC;aACF,EACD,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAI,uBAAuB,EAAE,CACtE;iBACA,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;gBACtB,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"get-active-contracts.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/get-active-contracts.ts"],"names":[],"mappings":";;;AAAA,4EAAyE;AAGzE,yEAOoC;AAqBpC;IACE,YAA6B,MAA2B;sBAA3B,MAAM;IAAwB,CAAC;IAErD,KAAK,CAAC,OAAO,CAAC,MAAgC;QACnD,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,sDAA2B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEjG,MAAM,QAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElD,OAAO,IAAI,OAAO,CAA+B,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnE,MAAM,OAAO,GAAiC,EAAE,CAAC;YACjD,IAAI,OAAO,GAAG,KAAK,CAAC;YAEpB,KAAK,QAAQ;iBACV,OAAO,CACN,gDAAqB,EACrB,cAAc,EACd;gBACE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAiB,EAAE;oBACzC,MAAM,KAAK,GAAG,IAAA,qDAA0B,EAAC,MAAM,CAAC,CAAC;oBAEjD,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;wBACpB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBACzB,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;4BACxC,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAClC,CAAC;oBACH,CAAC;yBAAM,IAAI,CAAC,OAAO,EAAE,CAAC;wBACpB,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;wBACpB,MAAM,KAAK,CAAC,KAAK,CAAC;oBACpB,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;oBACf,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;oBACxB,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,GAAG,IAAI,CAAC;wBACf,MAAM,KAAK,GAAG,IAAA,oDAAyB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;wBACtD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;4BACxB,OAAO,CAAC,OAAO,CAAC,CAAC;wBACnB,CAAC;6BAAM,CAAC;4BACN,MAAM,CAAC,KAAK,CAAC,CAAC;wBAChB,CAAC;oBACH,CAAC;gBACH,CAAC;aACF,EACD,EAAE,aAAa,EAAE,CAClB;iBACA,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;gBACtB,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,GAAG,IAAI,CAAC;oBACf,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/build/src/clients/ledger-json-api/operations/v2/state/index.d.ts

@@ -2,4 +2,5 @@ export * from './get-active-contracts';
 export * from './get-connected-synchronizers';
 export * from './get-latest-pruned-offsets';
 export * from './get-ledger-end';
+export * from './stream-active-contracts';
 //# sourceMappingURL=index.d.ts.map

package/build/src/clients/ledger-json-api/operations/v2/state/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC"}

package/build/src/clients/ledger-json-api/operations/v2/state/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./get-active-contracts"), exports);
 __exportStar(require("./get-connected-synchronizers"), exports);
 __exportStar(require("./get-latest-pruned-offsets"), exports);
 __exportStar(require("./get-ledger-end"), exports);
+__exportStar(require("./stream-active-contracts"), exports);
 //# sourceMappingURL=index.js.map

package/build/src/clients/ledger-json-api/operations/v2/state/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,gEAA8C;AAC9C,8DAA4C;AAC5C,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,gEAA8C;AAC9C,8DAA4C;AAC5C,mDAAiC;AACjC,4DAA0C"}

package/build/src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.d.ts

@@ -0,0 +1,64 @@
+import type { LedgerJsonApiClient } from '../../../LedgerJsonApiClient.generated';
+import type { JsGetActiveContractsResponseItem } from '../../../schemas/api/state';
+import { type ActiveContractsParams } from './active-contracts-request';
+/**
+ * Most received items that wait for the consumer before the socket stops reading. Past it the participant's sends back
+ * up behind TCP flow control instead of the snapshot collecting in memory; reading resumes once half have been taken.
+ */
+export declare const ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK = 256;
+/** Parameters of `streamActiveContracts`: those of `getActiveContracts` without its `onItem` callback. */
+export type StreamActiveContractsParams = ActiveContractsParams;
+/**
+ * One read of the active contracts at an offset, returned by `streamActiveContracts`. It can be iterated once: a second
+ * `for await` over the same stream throws instead of reporting an empty snapshot, so a retry has to call
+ * `streamActiveContracts` again.
+ */
+export declare class ActiveContractsStream implements AsyncIterable<JsGetActiveContractsResponseItem> {
+    private readonly client;
+    private readonly params;
+    private offset;
+    private iterated;
+    constructor(client: LedgerJsonApiClient, params: StreamActiveContractsParams);
+    /**
+     * The offset the snapshot is read at: the `activeAtOffset` passed in or, when it is omitted, the ledger end read as
+     * iteration starts. It is `undefined` until the first `next()` has built the request, and set before the first item
+     * is yielded. A reader that continues with `subscribeToUpdates` passes it as `beginExclusive`; reading the ledger end
+     * again instead would skip the updates in between.
+     */
+    get activeAtOffset(): number | undefined;
+    [Symbol.asyncIterator](): AsyncIterator<JsGetActiveContractsResponseItem, void, undefined>;
+    private open;
+}
+/**
+ * Streams the active contracts at an offset one item at a time, without collecting the snapshot.
+ *
+ * Takes the filters, offset and idle timeout of `getActiveContracts`. Canton 3.4's state service serves the snapshot
+ * only as a stream, so this reads the same WebSocket but hands each item to the consumer as it arrives and keeps no
+ * reference to it afterwards. The returned {@link ActiveContractsStream} connects when iteration starts and yields items
+ * in the order the participant sends them. When the consumer falls {@link ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK} items
+ * behind, the socket stops reading until it catches up. A Canton error frame, an unexpected frame, the idle timeout or
+ * a close other than the participant's normal close (1000), such as a dropped connection, ends the iteration with an
+ * error once the items received before it have been yielded. Leaving a `for await` loop early, by `break`, `return` or
+ * a throw, closes the socket; an iterator driven by hand must be run to the end or closed with `return()`. A stream is
+ * read once; to retry, call `streamActiveContracts` again.
+ *
+ * To continue from the snapshot with `subscribeToUpdates`, pass its {@link ActiveContractsStream.activeAtOffset} as
+ * `beginExclusive`.
+ *
+ * @example
+ *   ```typescript
+ *   const snapshot = client.streamActiveContracts({ parties: [party], interfaceIds: [interfaceId] });
+ *   for await (const item of snapshot) {
+ *     if ('JsActiveContract' in item.contractEntry) {
+ *       handle(item.contractEntry.JsActiveContract.createdEvent);
+ *     }
+ *   }
+ *   const beginExclusive = snapshot.activeAtOffset; // the offset the snapshot was read at
+ *   ```;
+ */
+export declare class StreamActiveContracts {
+    private readonly client;
+    constructor(client: LedgerJsonApiClient);
+    execute(params: StreamActiveContractsParams): ActiveContractsStream;
+}
+//# sourceMappingURL=stream-active-contracts.d.ts.map

package/build/src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-active-contracts.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC;AACnF,OAAO,EAKL,KAAK,qBAAqB,EAE3B,MAAM,4BAA4B,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,uCAAuC,MAAM,CAAC;AAE3D,0GAA0G;AAC1G,MAAM,MAAM,2BAA2B,GAAG,qBAAqB,CAAC;AAwIhE;;;;GAIG;AACH,qBAAa,qBAAsB,YAAW,aAAa,CAAC,gCAAgC,CAAC;IAKzF,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IALzB,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAS;IAEzB,YACmB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,2BAA2B,EAClD;IAEJ;;;;;OAKG;IACH,IAAW,cAAc,IAAI,MAAM,GAAG,SAAS,CAE9C;IAEM,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,gCAAgC,EAAE,IAAI,EAAE,SAAS,CAAC,CAQhG;YAEa,IAAI;CAiCnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,qBAAqB;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAAnC,YAA6B,MAAM,EAAE,mBAAmB,EAAI;IAErD,OAAO,CAAC,MAAM,EAAE,2BAA2B,GAAG,qBAAqB,CAEzE;CACF"}

package/build/src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.js

@@ -0,0 +1,230 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamActiveContracts = exports.ActiveContractsStream = exports.ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK = void 0;
+const WebSocketClient_1 = require("../../../../../core/ws/WebSocketClient");
+const active_contracts_request_1 = require("./active-contracts-request");
+/**
+ * Most received items that wait for the consumer before the socket stops reading. Past it the participant's sends back
+ * up behind TCP flow control instead of the snapshot collecting in memory; reading resumes once half have been taken.
+ */
+exports.ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK = 256;
+/** Items received from the socket and not yet taken by the iterator, followed by how the stream ended. */
+class SnapshotQueue {
+    constructor() {
+        this.items = [];
+        this.paused = false;
+        this.ended = false;
+        this.closed = false;
+    }
+    get hasEnded() {
+        return this.ended;
+    }
+    attach(subscription) {
+        this.subscription = subscription;
+        if (this.paused) {
+            subscription.pause?.();
+        }
+    }
+    push(item) {
+        this.items.push(item);
+        if (!this.paused && this.items.length >= exports.ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK) {
+            this.paused = true;
+            this.subscription?.pause?.();
+        }
+        this.signal();
+    }
+    /** Ends the stream; items already queued are still taken before the failure, if any, is thrown. */
+    end(failure) {
+        if (this.ended)
+            return;
+        this.ended = true;
+        this.failure = failure;
+        this.signal();
+    }
+    /** Waits for the next item. Resolves to `undefined` once the stream has ended and every item has been taken. */
+    async take() {
+        for (;;) {
+            const item = this.items.shift();
+            if (item !== undefined) {
+                if (this.paused && this.items.length <= exports.ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK / 2) {
+                    this.paused = false;
+                    this.subscription?.resume?.();
+                }
+                return item;
+            }
+            if (this.ended) {
+                if (this.failure !== undefined)
+                    throw this.failure;
+                return undefined;
+            }
+            await new Promise((resolve) => {
+                this.wake = resolve;
+            });
+        }
+    }
+    /** Ends the stream, drops the items no one will take, and closes the socket; closing again does nothing. */
+    close() {
+        this.end();
+        this.items.length = 0;
+        if (this.closed)
+            return;
+        this.closed = true;
+        this.subscription?.close();
+    }
+    signal() {
+        const { wake } = this;
+        this.wake = undefined;
+        wake?.();
+    }
+}
+/**
+ * The iterator of an {@link ActiveContractsStream}. It reports `done` only after the participant's normal close has
+ * completed the snapshot. Once the read fails, every later `next()` rejects with the same error, and once `return()`
+ * has closed the stream early, every later `next()` rejects too, so that no caller takes part of the snapshot for all
+ * of it. Calls to `next()` are served one at a time in the order they were made, each checking the stored failure again
+ * after it has waited, so a call that was already pending when the stream failed or was closed rejects too. `return()`
+ * closes the socket at once, whether or not a `next()` is waiting for a frame or the connection is still being set up.
+ */
+class SnapshotIterator {
+    constructor(open) {
+        this.open = open;
+        this.completed = false;
+        this.cancelled = false;
+        this.tail = Promise.resolve();
+    }
+    async next() {
+        const result = this.tail.then(async () => this.advance());
+        this.tail = result.catch(() => undefined);
+        return result;
+    }
+    async return() {
+        if (!this.completed) {
+            this.cancelled = true;
+            this.failure ?? (this.failure = { error: new Error('Active-contracts stream was closed before the snapshot completed') });
+            this.queue?.close();
+        }
+        return Promise.resolve({ done: true, value: undefined });
+    }
+    async advance() {
+        this.rethrow();
+        if (this.completed)
+            return { done: true, value: undefined };
+        try {
+            this.queue ?? (this.queue = await this.open());
+            // A return() that came while the connection was being set up could not close a socket that did not exist yet.
+            if (this.cancelled)
+                this.queue.close();
+            const item = await this.queue.take();
+            this.rethrow();
+            if (item === undefined) {
+                this.completed = true;
+                this.queue.close();
+                return { done: true, value: undefined };
+            }
+            return { done: false, value: item };
+        }
+        catch (error) {
+            this.failure ?? (this.failure = { error });
+            this.queue?.close();
+            throw this.failure.error;
+        }
+    }
+    rethrow() {
+        if (this.failure !== undefined)
+            throw this.failure.error;
+    }
+}
+/**
+ * One read of the active contracts at an offset, returned by `streamActiveContracts`. It can be iterated once: a second
+ * `for await` over the same stream throws instead of reporting an empty snapshot, so a retry has to call
+ * `streamActiveContracts` again.
+ */
+class ActiveContractsStream {
+    constructor(client, params) {
+        this.client = client;
+        this.params = params;
+        this.iterated = false;
+    }
+    /**
+     * The offset the snapshot is read at: the `activeAtOffset` passed in or, when it is omitted, the ledger end read as
+     * iteration starts. It is `undefined` until the first `next()` has built the request, and set before the first item
+     * is yielded. A reader that continues with `subscribeToUpdates` passes it as `beginExclusive`; reading the ledger end
+     * again instead would skip the updates in between.
+     */
+    get activeAtOffset() {
+        return this.offset;
+    }
+    [Symbol.asyncIterator]() {
+        if (this.iterated) {
+            throw new Error('An active-contracts stream can be iterated only once; call streamActiveContracts again to read another snapshot');
+        }
+        this.iterated = true;
+        return new SnapshotIterator(async () => this.open());
+    }
+    async open() {
+        const { requestMessage, idleTimeoutMs } = await (0, active_contracts_request_1.buildActiveContractsRequest)(this.client, this.params);
+        this.offset = requestMessage.activeAtOffset;
+        const queue = new SnapshotQueue();
+        const subscription = await new WebSocketClient_1.WebSocketClient(this.client).connect(active_contracts_request_1.ACTIVE_CONTRACTS_PATH, requestMessage, {
+            // Synchronous on purpose: WebSocketClient dispatches the next frame without waiting for this handler, so only a
+            // handler that returns before then keeps the items in order.
+            onMessage: (parsed) => {
+                if (queue.hasEnded)
+                    return;
+                const frame = (0, active_contracts_request_1.decodeActiveContractsFrame)(parsed);
+                if ('error' in frame) {
+                    queue.end(frame.error);
+                    // Rethrown so that WebSocketClient closes the socket.
+                    throw frame.error;
+                }
+                queue.push(frame.item);
+            },
+            onError: (err) => {
+                queue.end(err);
+            },
+            onClose: (code, reason) => {
+                queue.end((0, active_contracts_request_1.activeContractsCloseError)(code, reason));
+            },
+        }, { idleTimeoutMs });
+        queue.attach(subscription);
+        return queue;
+    }
+}
+exports.ActiveContractsStream = ActiveContractsStream;
+/**
+ * Streams the active contracts at an offset one item at a time, without collecting the snapshot.
+ *
+ * Takes the filters, offset and idle timeout of `getActiveContracts`. Canton 3.4's state service serves the snapshot
+ * only as a stream, so this reads the same WebSocket but hands each item to the consumer as it arrives and keeps no
+ * reference to it afterwards. The returned {@link ActiveContractsStream} connects when iteration starts and yields items
+ * in the order the participant sends them. When the consumer falls {@link ACTIVE_CONTRACTS_STREAM_HIGH_WATER_MARK} items
+ * behind, the socket stops reading until it catches up. A Canton error frame, an unexpected frame, the idle timeout or
+ * a close other than the participant's normal close (1000), such as a dropped connection, ends the iteration with an
+ * error once the items received before it have been yielded. Leaving a `for await` loop early, by `break`, `return` or
+ * a throw, closes the socket; an iterator driven by hand must be run to the end or closed with `return()`. A stream is
+ * read once; to retry, call `streamActiveContracts` again.
+ *
+ * To continue from the snapshot with `subscribeToUpdates`, pass its {@link ActiveContractsStream.activeAtOffset} as
+ * `beginExclusive`.
+ *
+ * @example
+ *   ```typescript
+ *   const snapshot = client.streamActiveContracts({ parties: [party], interfaceIds: [interfaceId] });
+ *   for await (const item of snapshot) {
+ *     if ('JsActiveContract' in item.contractEntry) {
+ *       handle(item.contractEntry.JsActiveContract.createdEvent);
+ *     }
+ *   }
+ *   const beginExclusive = snapshot.activeAtOffset; // the offset the snapshot was read at
+ *   ```;
+ */
+class StreamActiveContracts {
+    constructor(client) {
+        this.client = client;
+    }
+    execute(params) {
+        return new ActiveContractsStream(this.client, params);
+    }
+}
+exports.StreamActiveContracts = StreamActiveContracts;
+//# sourceMappingURL=stream-active-contracts.js.map

package/build/src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-active-contracts.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/state/stream-active-contracts.ts"],"names":[],"mappings":";;;AAAA,4EAAqG;AAGrG,yEAOoC;AAEpC;;;GAGG;AACU,QAAA,uCAAuC,GAAG,GAAG,CAAC;AAK3D,0GAA0G;AAC1G,MAAM,aAAa;IAAnB;QACmB,UAAK,GAAuC,EAAE,CAAC;QAExD,WAAM,GAAG,KAAK,CAAC;QAGf,UAAK,GAAG,KAAK,CAAC;QACd,WAAM,GAAG,KAAK,CAAC;IAiEzB,CAAC;IA/DC,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,YAAmC;QAC/C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,YAAY,CAAC,KAAK,EAAE,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAEM,IAAI,CAAC,IAAsC;QAChD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,QAAA,uCAAuC,EAAE,CAAC;YACjF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,mGAAmG;IAC5F,GAAG,CAAC,OAAe;QACxB,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,gHAAgH;IACzG,KAAK,CAAC,IAAI;QACf,SAAS,CAAC;YACR,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAChC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,QAAA,uCAAuC,GAAG,CAAC,EAAE,CAAC;oBACpF,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;oBACpB,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC;gBAChC,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;oBAAE,MAAM,IAAI,CAAC,OAAO,CAAC;gBACnD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAClC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,4GAA4G;IACrG,KAAK;QACV,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACtB,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC;IAC7B,CAAC;IAEO,MAAM;QACZ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,EAAE,EAAE,CAAC;IACX,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,gBAAgB;IAOpB,YAA6B,IAAkC;QAAlC,SAAI,GAAJ,IAAI,CAA8B;QANvD,cAAS,GAAG,KAAK,CAAC;QAClB,cAAS,GAAG,KAAK,CAAC;QAGlB,SAAI,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEe,CAAC;IAE5D,KAAK,CAAC,IAAI;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,kEAAkE,CAAC,EAAE,EAAC;YAC1G,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAC3D,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC5D,IAAI,CAAC;YACH,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,MAAM,IAAI,CAAC,IAAI,EAAE,EAAC;YACjC,8GAA8G;YAC9G,IAAI,IAAI,CAAC,SAAS;gBAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gBACtB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACnB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,KAAZ,IAAI,CAAC,OAAO,GAAK,EAAE,KAAK,EAAE,EAAC;YAC3B,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;YACpB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,OAAO;QACb,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3D,CAAC;CACF;AAED;;;;GAIG;AACH;IAIE,YACmB,MAA2B,EAC3B,MAAmC;QADnC,WAAM,GAAN,MAAM,CAAqB;QAC3B,WAAM,GAAN,MAAM,CAA6B;QAJ9C,aAAQ,GAAG,KAAK,CAAC;IAKtB,CAAC;IAEJ;;;;;OAKG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACb,iHAAiH,CAClH,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,sDAA2B,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtG,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,cAAc,CAAC;QAE5C,MAAM,KAAK,GAAG,IAAI,aAAa,EAAE,CAAC;QAClC,MAAM,YAAY,GAAG,MAAM,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CACjE,gDAAqB,EACrB,cAAc,EACd;YACE,gHAAgH;YAChH,6DAA6D;YAC7D,SAAS,EAAE,CAAC,MAAM,EAAQ,EAAE;gBAC1B,IAAI,KAAK,CAAC,QAAQ;oBAAE,OAAO;gBAC3B,MAAM,KAAK,GAAG,IAAA,qDAA0B,EAAC,MAAM,CAAC,CAAC;gBACjD,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;oBACrB,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACvB,sDAAsD;oBACtD,MAAM,KAAK,CAAC,KAAK,CAAC;gBACpB,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;YACD,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACf,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC;YACD,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;gBACxB,KAAK,CAAC,GAAG,CAAC,IAAA,oDAAyB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YACrD,CAAC;SACF,EACD,EAAE,aAAa,EAAE,CAClB,CAAC;QACF,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH;IACE,YAA6B,MAA2B;sBAA3B,MAAM;IAAwB,CAAC;IAErD,OAAO,CAAC,MAAmC;QAChD,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;CACF"}

package/build/src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.d.ts

@@ -1,14 +1,52 @@
+import { z } from 'zod';
 import type { paths } from '../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi';
 declare const endpoint: '/v2/updates/update-by-id';
-export interface GetUpdateByIdParams {
-    /** The ID of the update to fetch. */
+declare const GetUpdateByIdParamsSchema: z.ZodObject<{
+    updateId: z.ZodString;
+    readAs: z.ZodArray<z.ZodString>;
+    templateIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    interfaceIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    includeInterfaceView: z.ZodOptional<z.ZodBoolean>;
+    includeCreatedEventBlob: z.ZodOptional<z.ZodBoolean>;
+    transactionShape: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"TRANSACTION_SHAPE_ACS_DELTA">, z.ZodLiteral<"TRANSACTION_SHAPE_LEDGER_EFFECTS">]>>;
+}, z.core.$strip>;
+export type GetUpdateByIdParams = z.infer<typeof GetUpdateByIdParamsSchema>;
+export type GetUpdateByIdResponse = paths[typeof endpoint]['post']['responses']['200']['content']['application/json'];
+/**
+ * Fetches one update by its ID.
+ *
+ * Without `templateIds` or `interfaceIds` the request reads every event the `readAs` parties can see (a wildcard filter
+ * per party) with created event blobs included. With at least one template or interface filter, only matching events
+ * are returned, and created event blobs are included only when `includeCreatedEventBlob` is `true`. Interface views are
+ * included by default.
+ *
+ * @example
+ *   ```typescript
+ *   const update = await client.getUpdateById({
+ *     updateId: '1220...',
+ *     readAs: ['party1'],
+ *     interfaceIds: ['#example-package:Example.Module:Asset'],
+ *   });
+ *   ```;
+ */
+export declare const GetUpdateById: new (client: import("../../../../..").BaseClient) => import("../../../../..").ApiOperation<{
     updateId: string;
-    /** Parties to read as (optional). */
     readAs: string[];
-}
-export type GetUpdateByIdResponse = paths[typeof endpoint]['post']['responses']['200']['content']['application/json'];
-export declare const GetUpdateById: new (client: import("../../../../..").BaseClient) => import("../../../../..").ApiOperation<GetUpdateByIdParams, {
+    templateIds?: string[] | undefined;
+    interfaceIds?: string[] | undefined;
+    includeInterfaceView?: boolean | undefined;
+    includeCreatedEventBlob?: boolean | undefined;
+    transactionShape?: "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" | undefined;
+}, {
     update?: import("../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi").components["schemas"]["Update"];
-}, import("../../../../..").OperationExecuteOptions<GetUpdateByIdParams>>;
+}, import("../../../../..").OperationExecuteOptions<{
+    updateId: string;
+    readAs: string[];
+    templateIds?: string[] | undefined;
+    interfaceIds?: string[] | undefined;
+    includeInterfaceView?: boolean | undefined;
+    includeCreatedEventBlob?: boolean | undefined;
+    transactionShape?: "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS" | undefined;
+}>>;
 export {};
 //# sourceMappingURL=get-update-by-id.d.ts.map

package/build/src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-update-by-id.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2GAA2G,CAAC;AAEvI,QAAA,MAAM,QAAQ,EAAG,0BAAmC,CAAC;AAGrD,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAEtH,eAAO,MAAM,aAAa;;yEA6CxB,CAAC"}
+{"version":3,"file":"get-update-by-id.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2GAA2G,CAAC;AAIvI,QAAA,MAAM,QAAQ,EAAG,0BAAmC,CAAC;AAErD,QAAA,MAAM,yBAAyB;;;;;;;;iBAkB7B,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;GAkExB,CAAC"}