@distrohelena/canton-typescript-sdk 0.1.0

package/dist/transports/grpc/generated/canton/com/daml/ledger/api/v2/state_service.d.ts

@@ -0,0 +1,553 @@
+import { ServiceType } from "@protobuf-ts/runtime-rpc";
+import { MessageType } from "@protobuf-ts/runtime";
+import { SynchronizerTime } from "./offset_checkpoint.js";
+import { AssignedEvent } from "./reassignment.js";
+import { UnassignedEvent } from "./reassignment.js";
+import { CreatedEvent } from "./event.js";
+import { EventFormat } from "./transaction_filter.js";
+/**
+ * If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,
+ * the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED".
+ * Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party
+ * migration is not concerned with incomplete (un)assignments.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.GetActiveContractsRequest
+ */
+export interface GetActiveContractsRequest {
+    /**
+     * The offset at which the snapshot of the active contracts will be computed.
+     * Must be no greater than the current ledger end offset.
+     * Must be greater than or equal to the last pruning offset.
+     * Must be a valid absolute offset (positive integer) or ledger begin offset (zero).
+     * If zero, the empty set will be returned.
+     *
+     * Required
+     *
+     * @generated from protobuf field: int64 active_at_offset = 3
+     */
+    activeAtOffset: string;
+    /**
+     * Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
+     * TRANSACTION_SHAPE_ACS_DELTA.
+     *
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.EventFormat event_format = 4
+     */
+    eventFormat?: EventFormat;
+    /**
+     * Opaque representation of a continuation token defining a position in the active contracts snapshot.
+     * The prefix of the active contracts snapshot will be omitted up to and including the element from which
+     * the continuation token was read.
+     * To reuse the continuation token from a `GetActiveContractsPageResponse`:
+     *
+     * - subsequent request must be executed on the same participant with the same version of canton,
+     * - subsequent request must have the same active_at_offset,
+     * - subsequent request must have the same event_format
+     * - and the participant must not have been pruned after the active_at_offset.
+     *
+     * If not specified, the whole active contracts snapshot will be returned.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: optional bytes stream_continuation_token = 5
+     */
+    streamContinuationToken?: Uint8Array;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetActiveContractsPageRequest
+ */
+export interface GetActiveContractsPageRequest {
+    /**
+     * The offset at which the snapshot of the active contracts will be computed.
+     * Must be no greater than the current ledger end offset.
+     * Must be greater than or equal to the last pruning offset.
+     * Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero).
+     * If zero, the empty set will be returned.
+     * If not defined, the current ledger end will be used and it will be populated in the response.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: optional int64 active_at_offset = 1
+     */
+    activeAtOffset?: string;
+    /**
+     * Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
+     * TRANSACTION_SHAPE_ACS_DELTA.
+     *
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.EventFormat event_format = 2
+     */
+    eventFormat?: EventFormat;
+    /**
+     * The result page will contain at most max_page_size entries of the respective active contract snapshot.
+     * The server might reject max_page_size breaching the server-specified limit.
+     * Optional, if not defined, the default will be determined by the server.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: optional int32 max_page_size = 3
+     */
+    maxPageSize?: number;
+    /**
+     * To get the next page of the active contracts snapshot, the ``page_token`` should be set to the
+     * ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
+     * The page token only works if subsequent requests:
+     *
+     * - are executed on the same participant,
+     * - use the same active_at_offset and event_format,
+     * - and the participant's store was not pruned to after the active_at_offset.
+     *
+     * If not specified, the first page of the active contracts snapshot will be returned.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: optional bytes page_token = 4
+     */
+    pageToken?: Uint8Array;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetActiveContractsResponse
+ */
+export interface GetActiveContractsResponse {
+    /**
+     * The workflow ID used in command submission which corresponds to the contract_entry. Only set if
+     * the ``workflow_id`` for the command was set.
+     * Must be a valid LedgerString (as described in ``value.proto``).
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string workflow_id = 1
+     */
+    workflowId: string;
+    /**
+     * For a contract there could be multiple contract_entry-s in the entire snapshot. These together define
+     * the state of one contract in the snapshot.
+     * A contract_entry is included in the result, if and only if there is at least one stakeholder party of the contract
+     * that is hosted on the synchronizer at the time of the event and the party satisfies the
+     * ``TransactionFilter`` in the query.
+     *
+     * Required
+     *
+     * @generated from protobuf oneof: contract_entry
+     */
+    contractEntry: {
+        oneofKind: "activeContract";
+        /**
+         * The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer (
+         * created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same
+         * synchronizer, until the active_at_offset.
+         * Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one
+         * synchronizer, but already archived on another.
+         * There will be one such message for each synchronizer the contract is active on.
+         *
+         * @generated from protobuf field: com.daml.ledger.api.v2.ActiveContract active_contract = 2
+         */
+        activeContract: ActiveContract;
+    } | {
+        oneofKind: "incompleteUnassigned";
+        /**
+         * Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding
+         * assigned event before or at the active_at_offset.
+         *
+         * @generated from protobuf field: com.daml.ledger.api.v2.IncompleteUnassigned incomplete_unassigned = 3
+         */
+        incompleteUnassigned: IncompleteUnassigned;
+    } | {
+        oneofKind: "incompleteAssigned";
+        /**
+         * Important: this message is not indicating that the contract is active on the target synchronizer!
+         * Included iff the assigned event was before or at the active_at_offset, but there was no corresponding
+         * unassigned event before or at the active_at_offset.
+         *
+         * @generated from protobuf field: com.daml.ledger.api.v2.IncompleteAssigned incomplete_assigned = 4
+         */
+        incompleteAssigned: IncompleteAssigned;
+    } | {
+        oneofKind: undefined;
+    };
+    /**
+     * Opaque representation of a continuation token which can be used in the request to bypass the already processed part
+     * of the active contracts snapshot.
+     * Only populated for the streaming ``GetActiveContracts`` rpc call.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: bytes stream_continuation_token = 5
+     */
+    streamContinuationToken: Uint8Array;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetActiveContractsPageResponse
+ */
+export interface GetActiveContractsPageResponse {
+    /**
+     * The collection of active contracts for this page response.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.GetActiveContractsResponse active_contracts = 1
+     */
+    activeContracts: GetActiveContractsResponse[];
+    /**
+     * The active_at_offset which was specified in the request, or the calculated active_at_offset from the actual
+     * ledger end from at the evaluation of the request.
+     *
+     * Required
+     *
+     * @generated from protobuf field: int64 active_at_offset = 2
+     */
+    activeAtOffset: string;
+    /**
+     * If not present this is the last page. If present, this token must be used to get the next page.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: optional bytes next_page_token = 3
+     */
+    nextPageToken?: Uint8Array;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.ActiveContract
+ */
+export interface ActiveContract {
+    /**
+     * The event as it appeared in the context of its last update (i.e. daml transaction or
+     * reassignment). In particular, the last offset, node_id pair is preserved.
+     * The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.
+     * The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
+     * for lookups.
+     *
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.CreatedEvent created_event = 1
+     */
+    createdEvent?: CreatedEvent;
+    /**
+     * A valid synchronizer id
+     *
+     * Required
+     *
+     * @generated from protobuf field: string synchronizer_id = 2
+     */
+    synchronizerId: string;
+    /**
+     * Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases
+     * with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter
+     * equals zero.
+     * This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is
+     * before the active_at_offset.
+     *
+     * Required
+     *
+     * @generated from protobuf field: uint64 reassignment_counter = 3
+     */
+    reassignmentCounter: string;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.IncompleteUnassigned
+ */
+export interface IncompleteUnassigned {
+    /**
+     * The event as it appeared in the context of its last activation update (i.e. daml transaction or
+     * reassignment). In particular, the last activation offset, node_id pair is preserved.
+     * The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before
+     * the unassigned_event.
+     * The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used
+     * for lookups.
+     *
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.CreatedEvent created_event = 1
+     */
+    createdEvent?: CreatedEvent;
+    /**
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.UnassignedEvent unassigned_event = 2
+     */
+    unassignedEvent?: UnassignedEvent;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.IncompleteAssigned
+ */
+export interface IncompleteAssigned {
+    /**
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.AssignedEvent assigned_event = 1
+     */
+    assignedEvent?: AssignedEvent;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersRequest
+ */
+export interface GetConnectedSynchronizersRequest {
+    /**
+     * The party of interest
+     * Must be a valid PartyIdString (as described in ``value.proto``).
+     * If empty, all synchronizers this node is connected to will be returned
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string party = 1
+     */
+    party: string;
+    /**
+     * The id of a participant whose mapping of a party to connected synchronizers is requested.
+     * Must be a valid participant-id retrieved through a prior call to getParticipantId.
+     * Defaults to the participant id of the host participant.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string participant_id = 2
+     */
+    participantId: string;
+    /**
+     * The ID of the identity provider configured by ``Identity Provider Config``
+     * If not set, it's assumed the user is managed by the default identity provider.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string identity_provider_id = 3
+     */
+    identityProviderId: string;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersResponse
+ */
+export interface GetConnectedSynchronizersResponse {
+    /**
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer connected_synchronizers = 1
+     */
+    connectedSynchronizers: GetConnectedSynchronizersResponse_ConnectedSynchronizer[];
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer
+ */
+export interface GetConnectedSynchronizersResponse_ConnectedSynchronizer {
+    /**
+     * The alias of the synchronizer
+     *
+     * Required
+     *
+     * @generated from protobuf field: string synchronizer_alias = 1
+     */
+    synchronizerAlias: string;
+    /**
+     * The ID of the synchronizer
+     *
+     * Required
+     *
+     * @generated from protobuf field: string synchronizer_id = 2
+     */
+    synchronizerId: string;
+    /**
+     * The permission on the synchronizer
+     * Set if a party was used in the request, otherwise unspecified.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.ParticipantPermission permission = 3
+     */
+    permission: ParticipantPermission;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetLedgerEndRequest
+ */
+export interface GetLedgerEndRequest {
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetLedgerEndResponse
+ */
+export interface GetLedgerEndResponse {
+    /**
+     * It will always be a non-negative integer.
+     * If zero, the participant view of the ledger is empty.
+     * If positive, the absolute offset of the ledger as viewed by the participant.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: int64 offset = 1
+     */
+    offset: string;
+    /**
+     * Final record times observed by this participant for each of the sequencers that were ever connected.
+     * If there is no connection to a sequencer, corresponding record time can be arbitrarily far back in the past.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.SynchronizerTime synchronizer_times = 2
+     */
+    synchronizerTimes: SynchronizerTime[];
+}
+/**
+ * Empty for now, but may contain fields in the future.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest
+ */
+export interface GetLatestPrunedOffsetsRequest {
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse
+ */
+export interface GetLatestPrunedOffsetsResponse {
+    /**
+     * It will always be a non-negative integer.
+     * If positive, the absolute offset up to which the ledger has been pruned,
+     * disregarding the state of all divulged contracts pruning.
+     * If zero, the ledger has not been pruned yet.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: int64 participant_pruned_up_to_inclusive = 1
+     */
+    participantPrunedUpToInclusive: string;
+    /**
+     * It will always be a non-negative integer.
+     * If positive, the absolute offset up to which all divulged events have been pruned on the ledger.
+     * It can be at or before the ``participant_pruned_up_to_inclusive`` offset.
+     * For more details about all divulged events pruning,
+     * see ``PruneRequest.prune_all_divulged_contracts`` in ``participant_pruning_service.proto``.
+     * If zero, the divulged events have not been pruned yet.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: int64 all_divulged_contracts_pruned_up_to_inclusive = 2
+     */
+    allDivulgedContractsPrunedUpToInclusive: string;
+}
+/**
+ * Enum indicating the permission level that the participant has for the party
+ * whose connected synchronizers are being listed.
+ *
+ * @generated from protobuf enum com.daml.ledger.api.v2.ParticipantPermission
+ */
+export declare enum ParticipantPermission {
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_PERMISSION_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from protobuf enum value: PARTICIPANT_PERMISSION_SUBMISSION = 1;
+     */
+    SUBMISSION = 1,
+    /**
+     * participant can only confirm transactions
+     *
+     * @generated from protobuf enum value: PARTICIPANT_PERMISSION_CONFIRMATION = 2;
+     */
+    CONFIRMATION = 2,
+    /**
+     * participant can only observe transactions
+     *
+     * @generated from protobuf enum value: PARTICIPANT_PERMISSION_OBSERVATION = 3;
+     */
+    OBSERVATION = 3
+}
+declare class GetActiveContractsRequest$Type extends MessageType<GetActiveContractsRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetActiveContractsRequest
+ */
+export declare const GetActiveContractsRequest: GetActiveContractsRequest$Type;
+declare class GetActiveContractsPageRequest$Type extends MessageType<GetActiveContractsPageRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetActiveContractsPageRequest
+ */
+export declare const GetActiveContractsPageRequest: GetActiveContractsPageRequest$Type;
+declare class GetActiveContractsResponse$Type extends MessageType<GetActiveContractsResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetActiveContractsResponse
+ */
+export declare const GetActiveContractsResponse: GetActiveContractsResponse$Type;
+declare class GetActiveContractsPageResponse$Type extends MessageType<GetActiveContractsPageResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetActiveContractsPageResponse
+ */
+export declare const GetActiveContractsPageResponse: GetActiveContractsPageResponse$Type;
+declare class ActiveContract$Type extends MessageType<ActiveContract> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.ActiveContract
+ */
+export declare const ActiveContract: ActiveContract$Type;
+declare class IncompleteUnassigned$Type extends MessageType<IncompleteUnassigned> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.IncompleteUnassigned
+ */
+export declare const IncompleteUnassigned: IncompleteUnassigned$Type;
+declare class IncompleteAssigned$Type extends MessageType<IncompleteAssigned> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.IncompleteAssigned
+ */
+export declare const IncompleteAssigned: IncompleteAssigned$Type;
+declare class GetConnectedSynchronizersRequest$Type extends MessageType<GetConnectedSynchronizersRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersRequest
+ */
+export declare const GetConnectedSynchronizersRequest: GetConnectedSynchronizersRequest$Type;
+declare class GetConnectedSynchronizersResponse$Type extends MessageType<GetConnectedSynchronizersResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersResponse
+ */
+export declare const GetConnectedSynchronizersResponse: GetConnectedSynchronizersResponse$Type;
+declare class GetConnectedSynchronizersResponse_ConnectedSynchronizer$Type extends MessageType<GetConnectedSynchronizersResponse_ConnectedSynchronizer> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetConnectedSynchronizersResponse.ConnectedSynchronizer
+ */
+export declare const GetConnectedSynchronizersResponse_ConnectedSynchronizer: GetConnectedSynchronizersResponse_ConnectedSynchronizer$Type;
+declare class GetLedgerEndRequest$Type extends MessageType<GetLedgerEndRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetLedgerEndRequest
+ */
+export declare const GetLedgerEndRequest: GetLedgerEndRequest$Type;
+declare class GetLedgerEndResponse$Type extends MessageType<GetLedgerEndResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetLedgerEndResponse
+ */
+export declare const GetLedgerEndResponse: GetLedgerEndResponse$Type;
+declare class GetLatestPrunedOffsetsRequest$Type extends MessageType<GetLatestPrunedOffsetsRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetLatestPrunedOffsetsRequest
+ */
+export declare const GetLatestPrunedOffsetsRequest: GetLatestPrunedOffsetsRequest$Type;
+declare class GetLatestPrunedOffsetsResponse$Type extends MessageType<GetLatestPrunedOffsetsResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.GetLatestPrunedOffsetsResponse
+ */
+export declare const GetLatestPrunedOffsetsResponse: GetLatestPrunedOffsetsResponse$Type;
+/**
+ * @generated ServiceType for protobuf service com.daml.ledger.api.v2.StateService
+ */
+export declare const StateService: ServiceType;
+export {};