@fairmint/canton-node-sdk
Version:
Canton Node SDK
298 lines • 14.2 kB
TypeScript
/**
* @description Query flat transactions update list (blocking call)
* @example
* ```typescript
* const updates = await client.getUpdates({
* beginExclusive: 1000,
* endInclusive: 2000,
* limit: 100,
* streamIdleTimeoutMs: 5000,
* updateFormat: {
* includeTransactions: {
* eventFormat: {
* filtersByParty: {
* 'party1': { cumulative: [] }
* },
* verbose: true
* },
* transactionShape: 'TRANSACTION_SHAPE_ACS_DELTA'
* }
* }
* });
* ```
* @param beginExclusive - Beginning of the requested ledger section (non-negative integer)
* @param endInclusive - End of the requested ledger section (optional)
* @param limit - Maximum number of elements to return (optional)
* @param streamIdleTimeoutMs - Timeout to complete and send result if no new elements are received (optional)
* @param updateFormat - Update format for the request
*/
export declare const GetUpdates: {
new (client: import("../../../../../core").BaseClient): {
execute(params: {
beginExclusive: number;
updateFormat: {
includeTransactions?: {
eventFormat: {
filtersByParty: Record<string, {
cumulative: {
identifierFilter: {
Empty: Record<string, never>;
} | {
InterfaceFilter: {
interfaceId: string;
includeInterfaceView?: boolean | undefined;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
TemplateFilter: {
templateId: string;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
WildcardFilter: {
includeCreatedEventBlob?: boolean | undefined;
};
};
}[];
}>;
filtersForAnyParty?: {
cumulative: {
identifierFilter: {
Empty: Record<string, never>;
} | {
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";
} | undefined;
includeReassignments?: {
filtersByParty: Record<string, {
cumulative: {
identifierFilter: {
Empty: Record<string, never>;
} | {
InterfaceFilter: {
interfaceId: string;
includeInterfaceView?: boolean | undefined;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
TemplateFilter: {
templateId: string;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
WildcardFilter: {
includeCreatedEventBlob?: boolean | undefined;
};
};
}[];
}>;
filtersForAnyParty?: {
cumulative: {
identifierFilter: {
Empty: Record<string, never>;
} | {
InterfaceFilter: {
interfaceId: string;
includeInterfaceView?: boolean | undefined;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
TemplateFilter: {
templateId: string;
includeCreatedEventBlob?: boolean | undefined;
};
} | {
WildcardFilter: {
includeCreatedEventBlob?: boolean | undefined;
};
};
}[];
} | undefined;
verbose?: boolean | undefined;
} | undefined;
includeTopologyEvents?: {
includeParticipantAuthorizationEvents?: {
parties?: string[] | undefined;
} | undefined;
} | undefined;
};
endInclusive?: number | undefined;
limit?: number | undefined;
streamIdleTimeoutMs?: number | undefined;
}): Promise<{
update: {
JsTransaction: {
updateId: string;
effectiveAt: string;
offset: number;
events: {
kind: {
JsCreated: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
contractKey: string | null;
createArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
createdEventBlob: string;
interfaceViews: string[];
witnessParties: string[];
signatories: string[];
observers: string[];
createdAt: string;
packageName: string;
implementedInterfaces?: string[] | undefined;
};
} | {
JsArchived: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
witnessParties: string[];
packageName: string;
implementedInterfaces?: string[] | undefined;
};
} | {
JsAssigned: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
source: string;
target: string;
reassignmentId: string;
submitter: string;
reassignmentCounter: number;
packageName: string;
};
} | {
JsUnassigned: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
source: string;
target: string;
reassignmentId: string;
submitter: string;
reassignmentCounter: number;
packageName: string;
};
};
synchronizerId: string;
reassignmentCounter: number;
}[];
recordTime: string;
commandId?: string | undefined;
workflowId?: string | undefined;
traceContext?: {
traceId?: string | undefined;
spanId?: string | undefined;
parentSpanId?: string | undefined;
metadata?: Record<string, string> | undefined;
} | undefined;
};
} | {
JsTransactionTree: {
updateId: string;
effectiveAt: string;
offset: number;
eventsById: Record<string, {
CreatedTreeEvent: {
value: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
contractKey: string | null;
createArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
createdEventBlob: string;
interfaceViews: string[];
witnessParties: string[];
signatories: string[];
observers: string[];
createdAt: string;
packageName: string;
implementedInterfaces?: string[] | undefined;
};
};
} | {
ExercisedTreeEvent: {
value: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
interfaceId: string | null;
choice: string;
choiceArgument: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
actingParties: string[];
witnessParties: string[];
exerciseResult: Record<string, string | number | boolean | any[] | Record<string, any> | null>;
packageName: string;
consuming: boolean;
lastDescendantNodeId?: number | undefined;
implementedInterfaces?: string[] | undefined;
};
};
} | {
ArchivedTreeEvent: {
value: {
offset: number;
nodeId: number;
contractId: string;
templateId: string;
witnessParties: string[];
packageName: string;
implementedInterfaces?: string[] | undefined;
};
};
}>;
recordTime: string;
commandId?: string | undefined;
workflowId?: string | undefined;
};
} | {
OffsetCheckpoint: {
value: {
offset: number;
synchronizerTimes: {
synchronizerId: string;
recordTime: string;
}[];
};
};
};
}[]>;
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-flats.d.ts.map