@fairmint/canton-node-sdk 0.0.34 → 0.0.36

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

@@ -4,19 +4,35 @@ declare const endpoint = "/v2/updates/transaction-tree-by-id/{update-id}";
 export declare const GetTransactionTreeByIdParamsSchema: z.ZodObject<{
     updateId: z.ZodString;
     verbose: z.ZodOptional<z.ZodBoolean>;
+    parties: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     updateId: string;
+    parties?: string[] | undefined;
     verbose?: boolean | undefined;
 }, {
     updateId: string;
+    parties?: string[] | undefined;
     verbose?: boolean | undefined;
 }>;
 export type GetTransactionTreeByIdParams = z.infer<typeof GetTransactionTreeByIdParamsSchema>;
 export type GetTransactionTreeByIdResponse = paths[typeof endpoint]['get']['responses']['200']['content']['application/json'];
+/**
+ * @description Retrieves transaction tree data by update ID
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeById({
+ *   updateId: '1220d01cce13fa797bad7de3ea61e919b20dce545d41f05e026ec4b65f1a61c71215',
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param updateId - The update ID to retrieve transaction tree for
+ * @param parties - Optional array of party IDs to filter transactions by
+ */
 export declare const GetTransactionTreeById: {
     new (client: import("../../../../../core").BaseClient): {
         execute(params: {
             updateId: string;
+            parties?: string[] | undefined;
             verbose?: boolean | undefined;
         }): Promise<{
             transaction: import("../../../../../generated/openapi-types").components["schemas"]["JsTransactionTree"];

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

@@ -1 +1 @@
-{"version":3,"file":"get-transaction-tree-by-id.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAEpE,QAAA,MAAM,QAAQ,mDAAmD,CAAC;AAElE,eAAO,MAAM,kCAAkC;;;;;;;;;EAG7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAE9H,eAAO,MAAM,sBAAsB;;;;;;yBAW+34F,sEAAsB;;;;;;;;;;;;;CAAt74F,CAAC"}
+{"version":3,"file":"get-transaction-tree-by-id.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAEpE,QAAA,MAAM,QAAQ,mDAAmD,CAAC;AAElE,eAAO,MAAM,kCAAkC;;;;;;;;;;;;EAI7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAE9H;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;;yBAiC672F,sEAAsB;;;;;;;;;;;;;CAAp/2F,CAAC"}

package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.js

@@ -7,15 +7,41 @@ const endpoint = '/v2/updates/transaction-tree-by-id/{update-id}';
 exports.GetTransactionTreeByIdParamsSchema = zod_1.z.object({
     updateId: zod_1.z.string(),
     verbose: zod_1.z.boolean().optional(),
+    parties: zod_1.z.array(zod_1.z.string()).optional(),
 });
+/**
+ * @description Retrieves transaction tree data by update ID
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeById({
+ *   updateId: '1220d01cce13fa797bad7de3ea61e919b20dce545d41f05e026ec4b65f1a61c71215',
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param updateId - The update ID to retrieve transaction tree for
+ * @param parties - Optional array of party IDs to filter transactions by
+ */
 exports.GetTransactionTreeById = (0, core_1.createApiOperation)({
     paramsSchema: exports.GetTransactionTreeByIdParamsSchema,
     method: 'GET',
-    buildUrl: (params, apiUrl) => {
-        const url = new URL(`${apiUrl}${endpoint.replace('{update-id}', params.updateId)}`);
-        if (params.verbose)
-            url.searchParams.set('verbose', params.verbose.toString());
-        return url.toString();
+    buildUrl: (params, apiUrl, client) => {
+        const currentPartyId = client.getPartyId();
+        const readParties = Array.from(new Set([
+            currentPartyId,
+            ...(params.parties || []),
+        ]));
+        const baseUrl = `${apiUrl}${endpoint.replace('{update-id}', params.updateId)}`;
+        const queryParams = new URLSearchParams();
+        if (readParties.length > 0) {
+            readParties.forEach(party => {
+                queryParams.append('parties', party);
+            });
+        }
+        if (params.verbose) {
+            queryParams.set('verbose', params.verbose.toString());
+        }
+        const queryString = queryParams.toString();
+        return queryString ? `${baseUrl}?${queryString}` : baseUrl;
     },
 });
 //# sourceMappingURL=get-transaction-tree-by-id.js.map

package/build/src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-transaction-tree-by-id.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,6BAAwB;AAGxB,MAAM,QAAQ,GAAG,gDAAgD,CAAC;AAErD,QAAA,kCAAkC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAKU,QAAA,sBAAsB,GAAG,IAAA,yBAAkB,EAGtD;IACA,YAAY,EAAE,0CAAkC;IAChD,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;QAC3B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpF,IAAI,MAAM,CAAC,OAAO;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/E,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"get-transaction-tree-by-id.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-id.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,6BAAwB;AAGxB,MAAM,QAAQ,GAAG,gDAAgD,CAAC;AAErD,QAAA,kCAAkC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAKH;;;;;;;;;;;GAWG;AACU,QAAA,sBAAsB,GAAG,IAAA,yBAAkB,EAGtD;IACA,YAAY,EAAE,0CAAkC;IAChD,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QAE3C,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAC5B,IAAI,GAAG,CAAC;YACN,cAAc;YACd,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;SAC1B,CAAC,CACH,CAAC;QAEF,MAAM,OAAO,GAAG,GAAG,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QAE/E,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;QAE1C,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC1B,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC3C,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7D,CAAC;CACF,CAAC,CAAC"}

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

@@ -1,14 +1,16 @@
 import { z } from 'zod';
 import type { paths } from '../../../../../generated/openapi-types';
 declare const endpoint: "/v2/updates/update-by-id";
-export type GetUpdateByIdParams = paths[typeof endpoint]['post']['requestBody']['content']['application/json'];
+export type GetUpdateByIdParams = {
+    /** The ID of the update to fetch. */
+    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("../../../../../core").BaseClient): {
-        execute(params: {
-            updateId: string;
-            updateFormat?: import("../../../../../generated/openapi-types").components["schemas"]["UpdateFormat"];
-        }): Promise<{
+        execute(params: GetUpdateByIdParams): Promise<{
             update: import("../../../../../generated/openapi-types").components["schemas"]["Update"];
         }>;
         client: import("../../../../../core").BaseClient;

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":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAEpE,QAAA,MAAM,QAAQ,EAAG,0BAAmC,CAAC;AAErD,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAC/G,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;;;;2BAK4jrE,sEAAsB;;oBAA6wuB,sEAAsB;;;;;;;;;;;;;CAA745F,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":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wCAAwC,CAAC;AAEpE,QAAA,MAAM,QAAQ,EAAG,0BAAmC,CAAC;AAGrD,MAAM,MAAM,mBAAmB,GAAG;IAChC,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,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;;;oBA8Bs73F,sEAAsB;;;;;;;;;;;;;CAAp+3F,CAAC"}

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

@@ -5,9 +5,31 @@ const core_1 = require("../../../../../core");
 const zod_1 = require("zod");
 const endpoint = '/v2/updates/update-by-id';
 exports.GetUpdateById = (0, core_1.createApiOperation)({
-    paramsSchema: zod_1.z.any(),
+    paramsSchema: zod_1.z.object({
+        updateId: zod_1.z.string().min(1, 'updateId must be a non-empty string'),
+        readAs: zod_1.z.array(zod_1.z.string()),
+    }),
     method: 'POST',
     buildUrl: (_params, apiUrl) => `${apiUrl}${endpoint}`,
-    buildRequestData: (params) => params,
+    buildRequestData: (params) => {
+        // Validate updateId parameter
+        if (!params.updateId || params.updateId === 'undefined' || params.updateId.trim() === '') {
+            throw new Error(`Invalid updateId: "${params.updateId}". updateId must be a non-empty string.`);
+        }
+        // Build the request body according to the API specification
+        return {
+            updateId: params.updateId,
+            updateFormat: {
+                includeTransactions: {
+                    eventFormat: {
+                        verbose: true,
+                    },
+                    transactionShape: 'TRANSACTION_SHAPE_UNSPECIFIED',
+                },
+            },
+            // Include requestingParties if readAs is provided
+            ...(params.readAs && params.readAs.length > 0 && { requestingParties: params.readAs }),
+        };
+    },
 });
 //# sourceMappingURL=get-update-by-id.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"get-update-by-id.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,6BAAwB;AAGxB,MAAM,QAAQ,GAAG,0BAAmC,CAAC;AAKxC,QAAA,aAAa,GAAG,IAAA,yBAAkB,EAA6C;IAC1F,YAAY,EAAE,OAAC,CAAC,GAAG,EAAE;IACrB,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,QAAQ,EAAE;IACrD,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM;CACrC,CAAC,CAAC"}
+{"version":3,"file":"get-update-by-id.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-update-by-id.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,6BAAwB;AAGxB,MAAM,QAAQ,GAAG,0BAAmC,CAAC;AAYxC,QAAA,aAAa,GAAG,IAAA,yBAAkB,EAA6C;IAC1F,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC;QACrB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,qCAAqC,CAAC;QAClE,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC;KAC5B,CAAC;IACF,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,GAAG,QAAQ,EAAE;IACrD,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE;QAC3B,8BAA8B;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACzF,MAAM,IAAI,KAAK,CACb,sBAAsB,MAAM,CAAC,QAAQ,yCAAyC,CAC/E,CAAC;QACJ,CAAC;QAED,4DAA4D;QAC5D,OAAO;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,YAAY,EAAE;gBACZ,mBAAmB,EAAE;oBACnB,WAAW,EAAE;wBACX,OAAO,EAAE,IAAI;qBACd;oBACD,gBAAgB,EAAE,+BAA+B;iBAClD;aACF;YACD,kDAAkD;YAClD,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;SACvF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairmint/canton-node-sdk",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "Canton Node SDK",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",