@fairmint/canton-node-sdk
Version:
Canton Node SDK
45 lines • 2.42 kB
TypeScript
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/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>>;
}, z.core.$strip>;
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;
verbose?: boolean | undefined;
parties?: string[] | undefined;
}): Promise<{
transaction: import("../../../../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi").components["schemas"]["JsTransactionTree"];
}>;
client: import("../../../../../core").BaseClient;
validateParams<T>(params: T, schema: z.ZodSchema<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[];
};
};
export {};
//# sourceMappingURL=get-transaction-tree-by-id.d.ts.map