@fairmint/canton-node-sdk 0.0.29

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

@@ -0,0 +1,161 @@
+/**
+ * @description Get transaction by offset
+ * @example
+ * ```typescript
+ * const transaction = await client.getTransactionByOffset({
+ *   offset: 1000,
+ *   transactionFormat: {
+ *     eventFormat: {
+ *       filtersByParty: {
+ *         'party1': { cumulative: [] }
+ *       },
+ *       verbose: true
+ *     },
+ *     transactionShape: 'TRANSACTION_SHAPE_ACS_DELTA'
+ *   }
+ * });
+ * ```
+ * @param offset - Offset of the transaction being looked up
+ * @param transactionFormat - Transaction format for the request
+ */
+export declare const GetTransactionByOffset: {
+    new (client: import("../../../../../core").BaseClient): {
+        execute(params: {
+            offset: number;
+            transactionFormat: {
+                eventFormat: {
+                    filtersByParty: Record<string, {
+                        cumulative: {
+                            identifierFilter: {
+                                Empty: {};
+                            } | {
+                                InterfaceFilter: {
+                                    interfaceId: string;
+                                    includeInterfaceView?: boolean | undefined;
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            } | {
+                                TemplateFilter: {
+                                    templateId: string;
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            } | {
+                                WildcardFilter: {
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            };
+                        }[];
+                    }>;
+                    filtersForAnyParty?: {
+                        cumulative: {
+                            identifierFilter: {
+                                Empty: {};
+                            } | {
+                                InterfaceFilter: {
+                                    interfaceId: string;
+                                    includeInterfaceView?: boolean | undefined;
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            } | {
+                                TemplateFilter: {
+                                    templateId: string;
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            } | {
+                                WildcardFilter: {
+                                    includeCreatedEventBlob?: boolean | undefined;
+                                };
+                            };
+                        }[];
+                    } | undefined;
+                    verbose?: boolean | undefined;
+                };
+                transactionShape: "TRANSACTION_SHAPE_ACS_DELTA" | "TRANSACTION_SHAPE_LEDGER_EFFECTS";
+            };
+        }): Promise<{
+            transaction: {
+                offset: number;
+                updateId: string;
+                recordTime: string;
+                events: {
+                    synchronizerId: string;
+                    kind: {
+                        JsCreated: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            contractKey: string | null;
+                            createdEventBlob: string;
+                            nodeId: number;
+                            createArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            interfaceViews: string[];
+                            witnessParties: string[];
+                            signatories: string[];
+                            observers: string[];
+                            createdAt: string;
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    } | {
+                        JsArchived: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            nodeId: number;
+                            witnessParties: string[];
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    } | {
+                        JsAssigned: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            submitter: string;
+                            reassignmentId: string;
+                            source: string;
+                            target: string;
+                            nodeId: number;
+                            reassignmentCounter: number;
+                        };
+                    } | {
+                        JsUnassigned: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            submitter: string;
+                            reassignmentId: string;
+                            source: string;
+                            target: string;
+                            nodeId: number;
+                            reassignmentCounter: number;
+                        };
+                    };
+                    reassignmentCounter: number;
+                }[];
+                effectiveAt: string;
+                commandId?: string | undefined;
+                workflowId?: string | undefined;
+                traceContext?: {
+                    metadata?: Record<string, string> | undefined;
+                    traceId?: string | undefined;
+                    spanId?: string | undefined;
+                    parentSpanId?: string | undefined;
+                } | undefined;
+            };
+        }>;
+        client: import("../../../../../core").BaseClient;
+        validateParams<T>(params: T, schema: import("zod").ZodType<T>): T;
+        makeGetRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePostRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makeDeleteRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePatchRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        getManagedParties(): string[];
+        getPartyId(): string | undefined;
+        getApiUrl(): string;
+        buildPartyList(additionalParties?: string[]): string[];
+    };
+};
+//# sourceMappingURL=get-transaction-by-offset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-transaction-by-offset.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-by-offset.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAejC,CAAC"}

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetTransactionByOffset = void 0;
+const core_1 = require("../../../../../core");
+const operations_1 = require("../../../schemas/operations");
+/**
+ * @description Get transaction by offset
+ * @example
+ * ```typescript
+ * const transaction = await client.getTransactionByOffset({
+ *   offset: 1000,
+ *   transactionFormat: {
+ *     eventFormat: {
+ *       filtersByParty: {
+ *         'party1': { cumulative: [] }
+ *       },
+ *       verbose: true
+ *     },
+ *     transactionShape: 'TRANSACTION_SHAPE_ACS_DELTA'
+ *   }
+ * });
+ * ```
+ * @param offset - Offset of the transaction being looked up
+ * @param transactionFormat - Transaction format for the request
+ */
+exports.GetTransactionByOffset = (0, core_1.createApiOperation)({
+    paramsSchema: operations_1.GetTransactionByOffsetParamsSchema,
+    method: 'POST',
+    buildUrl: (_params, apiUrl) => `${apiUrl}/v2/updates/transaction-by-offset`,
+    buildRequestData: (params) => {
+        const request = {
+            offset: params.offset,
+            transactionFormat: params.transactionFormat,
+        };
+        return request;
+    },
+});
+//# sourceMappingURL=get-transaction-by-offset.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-transaction-by-offset.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-by-offset.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,4DAA+G;AAG/G;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,sBAAsB,GAAG,IAAA,yBAAkB,EAGtD;IACA,YAAY,EAAE,+CAAkC;IAChD,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,CAAC,OAAqC,EAAE,MAAc,EAAE,EAAE,CAAC,GAAG,MAAM,mCAAmC;IACjH,gBAAgB,EAAE,CAAC,MAAoC,EAAE,EAAE;QACzD,MAAM,OAAO,GAAiC;YAC5C,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;SAC5C,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAC,CAAC"}

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

@@ -0,0 +1,91 @@
+/**
+ * @description Get transaction tree by id
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeById({
+ *   updateId: 'update-123',
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param updateId - Update ID to fetch the 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;
+        }): Promise<{
+            transaction: {
+                offset: number;
+                updateId: string;
+                recordTime: string;
+                effectiveAt: string;
+                eventsById: Record<string, {
+                    CreatedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            contractKey: string | null;
+                            createdEventBlob: string;
+                            nodeId: number;
+                            createArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            interfaceViews: string[];
+                            witnessParties: string[];
+                            signatories: string[];
+                            observers: string[];
+                            createdAt: string;
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    };
+                } | {
+                    ExercisedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            interfaceId: string | null;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            choice: string;
+                            choiceArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            nodeId: number;
+                            witnessParties: string[];
+                            actingParties: string[];
+                            exerciseResult: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            consuming: boolean;
+                            implementedInterfaces?: string[] | undefined;
+                            lastDescendantNodeId?: number | undefined;
+                        };
+                    };
+                } | {
+                    ArchivedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            nodeId: number;
+                            witnessParties: string[];
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    };
+                }>;
+                commandId?: string | undefined;
+                workflowId?: string | undefined;
+            };
+        }>;
+        client: import("../../../../../core").BaseClient;
+        validateParams<T>(params: T, schema: import("zod").ZodType<T>): T;
+        makeGetRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePostRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makeDeleteRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePatchRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        getManagedParties(): string[];
+        getPartyId(): string | undefined;
+        getApiUrl(): string;
+        buildPartyList(additionalParties?: string[]): string[];
+    };
+};
+//# sourceMappingURL=get-transaction-tree-by-id.d.ts.map

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

@@ -0,0 +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":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BjC,CAAC"}

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetTransactionTreeById = void 0;
+const core_1 = require("../../../../../core");
+const operations_1 = require("../../../schemas/operations");
+/**
+ * @description Get transaction tree by id
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeById({
+ *   updateId: 'update-123',
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param updateId - Update ID to fetch the transaction tree for
+ * @param parties - Optional array of party IDs to filter transactions by
+ */
+exports.GetTransactionTreeById = (0, core_1.createApiOperation)({
+    paramsSchema: operations_1.GetTransactionTreeByIdParamsSchema,
+    method: 'GET',
+    buildUrl: (params, apiUrl, client) => {
+        const currentPartyId = client.getPartyId();
+        const readParties = Array.from(new Set([
+            currentPartyId,
+            ...(params.parties || []),
+        ]));
+        const baseUrl = `${apiUrl}/v2/updates/transaction-tree-by-id/${params.updateId}`;
+        if (readParties.length > 0) {
+            const queryParams = new URLSearchParams();
+            readParties.forEach(party => {
+                queryParams.append('parties', party);
+            });
+            return `${baseUrl}?${queryParams.toString()}`;
+        }
+        return 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

@@ -0,0 +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,4DAA+G;AAG/G;;;;;;;;;;;GAWG;AACU,QAAA,sBAAsB,GAAG,IAAA,yBAAkB,EAGtD;IACA,YAAY,EAAE,+CAAkC;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,sCAAsC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAEjF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC1B,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,OAAO,IAAI,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;QAChD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAC,CAAC"}

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

@@ -0,0 +1,96 @@
+/**
+ * @description Retrieves transaction tree data starting from a specific offset
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeByOffset({
+ *   offset: 1000,
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param offset - The starting offset for transaction retrieval
+ * @param parties - Optional array of party IDs to filter transactions by
+ */
+export declare const GetTransactionTreeByOffset: {
+    new (client: import("../../../../../core").BaseClient): {
+        execute(params: {
+            offset: string;
+            parties?: string[] | undefined;
+        }): Promise<{
+            transaction: {
+                offset: number;
+                updateId: string;
+                synchronizerId: string;
+                recordTime: string;
+                effectiveAt: string;
+                eventsById: Record<string, {
+                    CreatedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            contractKey: string | null;
+                            createdEventBlob: string;
+                            nodeId: number;
+                            createArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            interfaceViews: string[];
+                            witnessParties: string[];
+                            signatories: string[];
+                            observers: string[];
+                            createdAt: string;
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    };
+                } | {
+                    ExercisedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            interfaceId: string | null;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            choice: string;
+                            choiceArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            nodeId: number;
+                            witnessParties: string[];
+                            actingParties: string[];
+                            exerciseResult: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
+                            consuming: boolean;
+                            implementedInterfaces?: string[] | undefined;
+                            lastDescendantNodeId?: number | undefined;
+                        };
+                    };
+                } | {
+                    ArchivedTreeEvent: {
+                        value: {
+                            contractId: string;
+                            templateId: string;
+                            offset: number;
+                            packageName: string;
+                            nodeId: number;
+                            witnessParties: string[];
+                            implementedInterfaces?: string[] | undefined;
+                        };
+                    };
+                }>;
+                commandId?: string | undefined;
+                workflowId?: string | undefined;
+                traceContext?: {
+                    traceparent: string;
+                    tracestate: string | null;
+                } | undefined;
+            };
+        }>;
+        client: import("../../../../../core").BaseClient;
+        validateParams<T>(params: T, schema: import("zod").ZodType<T>): T;
+        makeGetRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePostRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makeDeleteRequest<T>(url: string, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        makePatchRequest<T>(url: string, data: unknown, config?: import("../../../../../core").RequestConfig): Promise<T>;
+        getManagedParties(): string[];
+        getPartyId(): string | undefined;
+        getApiUrl(): string;
+        buildPartyList(additionalParties?: string[]): string[];
+    };
+};
+//# sourceMappingURL=get-transaction-tree-by-offset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-transaction-tree-by-offset.d.ts","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-offset.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BrC,CAAC"}

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetTransactionTreeByOffset = void 0;
+const core_1 = require("../../../../../core");
+const operations_1 = require("../../../schemas/operations");
+/**
+ * @description Retrieves transaction tree data starting from a specific offset
+ * @example
+ * ```typescript
+ * const transactionTree = await client.getTransactionTreeByOffset({
+ *   offset: 1000,
+ *   parties: ['party1', 'party2']
+ * });
+ * ```
+ * @param offset - The starting offset for transaction retrieval
+ * @param parties - Optional array of party IDs to filter transactions by
+ */
+exports.GetTransactionTreeByOffset = (0, core_1.createApiOperation)({
+    paramsSchema: operations_1.GetTransactionTreeByOffsetParamsSchema,
+    method: 'GET',
+    buildUrl: (params, apiUrl, client) => {
+        const currentPartyId = client.getPartyId();
+        const readParties = Array.from(new Set([
+            currentPartyId,
+            ...(params.parties || []),
+        ]));
+        const baseUrl = `${apiUrl}/v2/updates/transaction-tree-by-offset/${params.offset}`;
+        if (readParties.length > 0) {
+            const queryParams = new URLSearchParams();
+            readParties.forEach(party => {
+                queryParams.append('parties', party);
+            });
+            return `${baseUrl}?${queryParams.toString()}`;
+        }
+        return baseUrl;
+    },
+});
+//# sourceMappingURL=get-transaction-tree-by-offset.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"get-transaction-tree-by-offset.js","sourceRoot":"","sources":["../../../../../../../src/clients/ledger-json-api/operations/v2/updates/get-transaction-tree-by-offset.ts"],"names":[],"mappings":";;;AAAA,8CAAyD;AACzD,4DAAuH;AAGvH;;;;;;;;;;;GAWG;AACU,QAAA,0BAA0B,GAAG,IAAA,yBAAkB,EAG1D;IACA,YAAY,EAAE,mDAAsC;IACpD,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,0CAA0C,MAAM,CAAC,MAAM,EAAE,CAAC;QAEnF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBAC1B,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,OAAO,IAAI,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;QAChD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAC,CAAC"}