@fairmint/canton-node-sdk
Version:
Canton Node SDK
118 lines • 10.5 kB
TypeScript
import { BaseClient, ClientConfig } from '../../core';
import type { AsyncSubmitParams, AsyncSubmitResponse } from './operations/v2/commands/async/submit';
import type { AsyncSubmitReassignmentParams, AsyncSubmitReassignmentResponse } from './operations/v2/commands/async/submit-reassignment';
import type { CompletionsParams, CompletionsResponse } from './operations/v2/commands/completions';
import type { SubmitAndWaitParams } from './operations/v2/commands/submit-and-wait';
import type { SubmitAndWaitForTransactionParams, SubmitAndWaitForTransactionResponse } from './operations/v2/commands/submit-and-wait-for-transaction';
import type { SubmitAndWaitForTransactionTreeParams, SubmitAndWaitForTransactionTreeResponse } from './operations/v2/commands/submit-and-wait-for-transaction-tree';
import type { EventsByContractIdParams, EventsByContractIdResponse } from './operations/v2/events/get-events-by-contract-id';
import type { GetTransactionByOffsetParams, GetTransactionByOffsetResponse } from './operations/v2/updates/get-transaction-by-offset';
import type { GetTransactionTreeByOffsetParams, GetTransactionTreeByOffsetResponse } from './operations/v2/updates/get-transaction-tree-by-offset';
import type { GetUpdateByOffsetParams, GetUpdateByOffsetResponse } from './operations/v2/updates/get-update-by-offset';
import type { GetUpdateByIdParams, GetUpdateByIdResponse } from './operations/v2/updates/get-update-by-id';
import type { GetTransactionByIdParams, GetTransactionByIdResponse } from './operations/v2/updates/get-transaction-by-id';
import type { GetTransactionTreeByIdParams, GetTransactionTreeByIdResponse } from './operations/v2/updates/get-transaction-tree-by-id';
import type { GetActiveContractsParams, GetActiveContractsResponse } from './operations/v2/state/get-active-contracts';
import type { GetConnectedSynchronizersParams, GetConnectedSynchronizersResponse } from './operations/v2/state/get-connected-synchronizers';
import type { GetLedgerEndParams, GetLedgerEndResponse } from './operations/v2/state/get-ledger-end';
import type { GetLatestPrunedOffsetsParams, GetLatestPrunedOffsetsResponse } from './operations/v2/state/get-latest-pruned-offsets';
import type { CreateUserParams } from './operations/v2/users/create-user';
import type { DeleteUserParams, DeleteUserResponse } from './operations/v2/users/delete-user';
import type { GetUserParams, GetUserResponse } from './operations/v2/users/get-user';
import type { GrantUserRightsParams, GrantUserRightsResponse } from './operations/v2/users/grant-user-rights';
import type { ListUserRightsParams, ListUserRightsResponse } from './operations/v2/users/list-user-rights';
import type { ListUsersParams, ListUsersResponse } from './operations/v2/users/list-users';
import type { RevokeUserRightsParams, RevokeUserRightsResponse } from './operations/v2/users/revoke-user-rights';
import type { UpdateUserIdentityProviderParams, UpdateUserIdentityProviderResponse } from './operations/v2/users/update-user-identity-provider';
import type { UpdateUserParams, UpdateUserResponse } from './operations/v2/users/update-user';
import type { UploadDarFileParams } from './operations/v2/packages/post';
import type { UploadDarFileResponse } from './schemas/api';
import type { InteractiveSubmissionAllocatePartyParams } from './schemas/operations';
import type { InteractiveSubmissionCreateUserParams } from './schemas/operations';
import type { InteractiveSubmissionUploadDarParams } from './schemas/operations';
import type { InteractiveSubmissionGetPreferredPackageVersionParams } from './schemas/operations';
import type { InteractiveSubmissionGetPreferredPackagesParams } from './schemas/operations';
import type { InteractiveSubmissionAllocatePartyResponse, InteractiveSubmissionCreateUserResponse, InteractiveSubmissionUploadDarResponse } from './schemas/api';
import type { GetPreferredPackageVersionResponse, GetPreferredPackagesResponse } from './schemas/api';
import type { GetPartiesParams } from './operations/v2/parties/get';
import type { GetParticipantIdParams, GetParticipantIdResponse } from './operations/v2/parties/get-participant-id';
import type { GetPartyDetailsParams } from './schemas/operations';
import type { AllocatePartyParams } from './operations/v2/parties/post';
import type { AllocatePartyResponse } from './schemas/api';
import type { UpdatePartyDetailsParams } from './operations/v2/parties/update-party-details';
/** Client for interacting with Canton's Ledger JSON API */
export declare class LedgerJsonApiClient extends BaseClient {
asyncSubmit: (params: AsyncSubmitParams) => Promise<AsyncSubmitResponse>;
asyncSubmitReassignment: (params: AsyncSubmitReassignmentParams) => Promise<AsyncSubmitReassignmentResponse>;
completions: (params: CompletionsParams) => Promise<CompletionsResponse>;
submitAndWait: (params: SubmitAndWaitParams) => Promise<any>;
submitAndWaitForTransactionTree: (params: SubmitAndWaitForTransactionTreeParams) => Promise<SubmitAndWaitForTransactionTreeResponse>;
submitAndWaitForTransaction: (params: SubmitAndWaitForTransactionParams) => Promise<SubmitAndWaitForTransactionResponse>;
getEventsByContractId: (params: EventsByContractIdParams) => Promise<EventsByContractIdResponse>;
getTransactionByOffset: (params: GetTransactionByOffsetParams) => Promise<GetTransactionByOffsetResponse>;
getTransactionTreeByOffset: (params: GetTransactionTreeByOffsetParams) => Promise<GetTransactionTreeByOffsetResponse>;
getUpdateByOffset: (params: GetUpdateByOffsetParams) => Promise<GetUpdateByOffsetResponse>;
getUpdateById: (params: GetUpdateByIdParams) => Promise<GetUpdateByIdResponse>;
getTransactionById: (params: GetTransactionByIdParams) => Promise<GetTransactionByIdResponse>;
getTransactionTreeById: (params: GetTransactionTreeByIdParams) => Promise<GetTransactionTreeByIdResponse>;
getActiveContracts: (params: GetActiveContractsParams) => Promise<GetActiveContractsResponse>;
getConnectedSynchronizers: (params: GetConnectedSynchronizersParams) => Promise<GetConnectedSynchronizersResponse>;
getLedgerEnd: (params: GetLedgerEndParams) => Promise<GetLedgerEndResponse>;
getLatestPrunedOffsets: (params: GetLatestPrunedOffsetsParams) => Promise<GetLatestPrunedOffsetsResponse>;
createUser: (params: CreateUserParams) => Promise<any>;
deleteUser: (params: DeleteUserParams) => Promise<DeleteUserResponse>;
getUser: (params: GetUserParams) => Promise<GetUserResponse>;
grantUserRights: (params: GrantUserRightsParams) => Promise<GrantUserRightsResponse>;
listUserRights: (params: ListUserRightsParams) => Promise<ListUserRightsResponse>;
listUsers: (params: ListUsersParams) => Promise<ListUsersResponse>;
revokeUserRights: (params: RevokeUserRightsParams) => Promise<RevokeUserRightsResponse>;
updateUserIdentityProvider: (params: UpdateUserIdentityProviderParams) => Promise<UpdateUserIdentityProviderResponse>;
updateUser: (params: UpdateUserParams) => Promise<UpdateUserResponse>;
getParties: (params: GetPartiesParams) => Promise<import('../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi').paths['/v2/parties']['get']['responses']['200']['content']['application/json']>;
getParticipantId: (params: GetParticipantIdParams) => Promise<GetParticipantIdResponse>;
getPartyDetails: (params: GetPartyDetailsParams) => Promise<import('../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi').paths['/v2/parties/{party}']['get']['responses']['200']['content']['application/json']>;
allocateParty: (params: AllocatePartyParams) => Promise<AllocatePartyResponse>;
updatePartyDetails: (params: UpdatePartyDetailsParams) => Promise<import('../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi').paths['/v2/parties/{party}']['patch']['responses']['200']['content']['application/json']>;
/**
* List all packages uploaded on the participant node
* @description List all packages uploaded on the participant node
* @returns The list of package IDs available on the participant node.
* @example
* ```typescript
* const packages = await client.listPackages();
* console.log(`Available packages: ${packages.packageIds.join(', ')}`);
* ```
*/
listPackages: () => Promise<import('../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi').paths['/v2/packages']['get']['responses']['200']['content']['application/json']>;
/**
* Upload a DAR file to the participant node
* @description Upload a DAR file to the participant node
* @returns The upload result.
* @example
* ```typescript
* const result = await client.uploadDarFile({
* darFile: fs.readFileSync('my-package.dar'),
* submissionId: 'unique-submission-id'
* });
* ```
*/
uploadDarFile: (params: UploadDarFileParams) => Promise<UploadDarFileResponse>;
/**
* Get the version details of the participant node
* @description Get the version details of the participant node
* @returns The version information of the participant node.
* @example
* ```typescript
* const version = await client.getVersion();
* console.log(`Participant version: ${version.version}`);
* ```
*/
getVersion: () => Promise<import('../../generated/canton/community/ledger/ledger-json-api/src/test/resources/json-api-docs/openapi').paths['/v2/version']['get']['responses']['200']['content']['application/json']>;
interactiveSubmissionAllocateParty: (params: InteractiveSubmissionAllocatePartyParams) => Promise<InteractiveSubmissionAllocatePartyResponse>;
interactiveSubmissionCreateUser: (params: InteractiveSubmissionCreateUserParams) => Promise<InteractiveSubmissionCreateUserResponse>;
interactiveSubmissionUploadDar: (params: InteractiveSubmissionUploadDarParams) => Promise<InteractiveSubmissionUploadDarResponse>;
interactiveSubmissionGetPreferredPackageVersion: (params: InteractiveSubmissionGetPreferredPackageVersionParams) => Promise<GetPreferredPackageVersionResponse>;
interactiveSubmissionGetPreferredPackages: (params: InteractiveSubmissionGetPreferredPackagesParams) => Promise<GetPreferredPackagesResponse>;
constructor(clientConfig: ClientConfig);
}
//# sourceMappingURL=LedgerJsonApiClient.d.ts.map