@c7-digital/ledger 0.0.2

package/lib/src/generated/async-api.js

@@ -0,0 +1 @@
+export {};

package/lib/src/generated/asyncapi-schema.d.ts

@@ -0,0 +1 @@
+export declare const ASYNCAPI_SCHEMA = "asyncapi: 2.6.0\ninfo:\n  title: JSON Ledger API WebSocket endpoints\n  version: 3.4.7\nchannels:\n  /v2/commands/completions:\n    description: Get completions stream\n    subscribe:\n      operationId: onV2CommandsCompletions\n      description: Get completions stream\n      message:\n        $ref: '#/components/messages/Either_JsCantonError_CompletionStreamResponse'\n    publish:\n      operationId: sendV2CommandsCompletions\n      description: Get completions stream\n      message:\n        $ref: '#/components/messages/CompletionStreamRequest'\n    bindings:\n      ws:\n        method: GET\n  /v2/state/active-contracts:\n    description: Get active contracts stream\n    subscribe:\n      operationId: onV2StateActive-contracts\n      description: Get active contracts stream\n      message:\n        $ref: '#/components/messages/Either_JsCantonError_JsGetActiveContractsResponse'\n    publish:\n      operationId: sendV2StateActive-contracts\n      description: Get active contracts stream\n      message:\n        $ref: '#/components/messages/GetActiveContractsRequest'\n    bindings:\n      ws:\n        method: GET\n  /v2/updates:\n    description: Get updates stream\n    subscribe:\n      operationId: onV2Updates\n      description: Get updates stream\n      message:\n        $ref: '#/components/messages/Either_JsCantonError_JsGetUpdatesResponse'\n    publish:\n      operationId: sendV2Updates\n      description: Get updates stream\n      message:\n        $ref: '#/components/messages/GetUpdatesRequest'\n    bindings:\n      ws:\n        method: GET\n  /v2/updates/flats:\n    description: Get flat transactions update stream. Provided for backwards compatibility,\n      it will be removed in the Canton version 3.5.0, use v2/updates instead.\n    subscribe:\n      operationId: onV2UpdatesFlats\n      description: Get flat transactions update stream. Provided for backwards compatibility,\n        it will be removed in the Canton version 3.5.0, use v2/updates instead.\n      message:\n        $ref: '#/components/messages/Either_JsCantonError_JsGetUpdatesResponse'\n    publish:\n      operationId: sendV2UpdatesFlats\n      description: Get flat transactions update stream. Provided for backwards compatibility,\n        it will be removed in the Canton version 3.5.0, use v2/updates instead.\n      message:\n        $ref: '#/components/messages/GetUpdatesRequest'\n    bindings:\n      ws:\n        method: GET\n  /v2/updates/trees:\n    description: Get update transactions tree stream. Provided for backwards compatibility,\n      it will be removed in the Canton version 3.5.0, use v2/updates instead.\n    subscribe:\n      operationId: onV2UpdatesTrees\n      description: Get update transactions tree stream. Provided for backwards compatibility,\n        it will be removed in the Canton version 3.5.0, use v2/updates instead.\n      message:\n        $ref: '#/components/messages/Either_JsCantonError_JsGetUpdateTreesResponse'\n    publish:\n      operationId: sendV2UpdatesTrees\n      description: Get update transactions tree stream. Provided for backwards compatibility,\n        it will be removed in the Canton version 3.5.0, use v2/updates instead.\n      message:\n        $ref: '#/components/messages/GetUpdatesRequest'\n    bindings:\n      ws:\n        method: GET\ncomponents:\n  schemas:\n    JsCantonError:\n      title: JsCantonError\n      type: object\n      required:\n      - code\n      - cause\n      - context\n      - errorCategory\n      properties:\n        code:\n          type: string\n        cause:\n          type: string\n        correlationId:\n          type: string\n        traceId:\n          type: string\n        context:\n          $ref: '#/components/schemas/Map_String'\n        resources:\n          type: array\n          items:\n            $ref: '#/components/schemas/Tuple2_String_String'\n        errorCategory:\n          type: integer\n          format: int32\n        grpcCodeValue:\n          type: integer\n          format: int32\n        retryInfo:\n          type: string\n        definiteAnswer:\n          type: boolean\n    Map_String:\n      title: Map_String\n      type: object\n      additionalProperties:\n        type: string\n    Tuple2_String_String:\n      title: Tuple2_String_String\n      type: array\n      prefixItems:\n      - type: string\n      - type: string\n    CompletionStreamRequest:\n      title: CompletionStreamRequest\n      type: object\n      required:\n      - userId\n      - beginExclusive\n      properties:\n        userId:\n          description: |-\n            Only completions of commands submitted with the same user_id will be visible in the stream.\n            Must be a valid UserIdString (as described in ``value.proto``).\n            Required unless authentication is used with a user token.\n            In that case, the token's user-id will be used for the request's user_id.\n          type: string\n        parties:\n          description: |-\n            Non-empty list of parties whose data should be included.\n            The stream shows only completions of commands for which at least one of the ``act_as`` parties is in the given set of parties.\n            Must be a valid PartyIdString (as described in ``value.proto``).\n            Required\n          type: array\n          items:\n            type: string\n        beginExclusive:\n          description: |-\n            This optional field indicates the minimum offset for completions. This can be used to resume an earlier completion stream.\n            If not set the ledger uses the ledger begin offset instead.\n            If specified, it must be a valid absolute offset (positive integer) or zero (ledger begin offset).\n            If the ledger has been pruned, this parameter must be specified and greater than the pruning offset.\n          type: integer\n          format: int64\n    Either_JsCantonError_CompletionStreamResponse:\n      title: Either_JsCantonError_CompletionStreamResponse\n      oneOf:\n      - $ref: '#/components/schemas/CompletionStreamResponse'\n      - $ref: '#/components/schemas/JsCantonError'\n    Map_K_V:\n      title: Map_K_V\n      type: object\n      additionalProperties:\n        type: string\n    CompletionStreamResponse:\n      title: CompletionStreamResponse\n      type: object\n      required:\n      - completionResponse\n      properties:\n        completionResponse:\n          $ref: '#/components/schemas/CompletionResponse'\n    CompletionResponse:\n      title: CompletionResponse\n      oneOf:\n      - type: object\n        required:\n        - Completion\n        properties:\n          Completion:\n            $ref: '#/components/schemas/Completion'\n      - type: object\n        required:\n        - Empty\n        properties:\n          Empty:\n            $ref: '#/components/schemas/Empty1'\n      - type: object\n        required:\n        - OffsetCheckpoint\n        properties:\n          OffsetCheckpoint:\n            $ref: '#/components/schemas/OffsetCheckpoint'\n    Completion:\n      title: Completion\n      description: 'A completion represents the status of a submitted command on the\n        ledger: it can be successful or failed.'\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/Completion1'\n    Completion1:\n      title: Completion\n      description: 'A completion represents the status of a submitted command on the\n        ledger: it can be successful or failed.'\n      type: object\n      required:\n      - commandId\n      - updateId\n      - userId\n      - submissionId\n      - deduplicationPeriod\n      - offset\n      properties:\n        commandId:\n          description: |-\n            The ID of the succeeded or failed command.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        status:\n          $ref: '#/components/schemas/JsStatus'\n          description: |-\n            Identifies the exact type of the error.\n            It uses the same format of conveying error details as it is used for the RPC responses of the APIs.\n            Optional\n        updateId:\n          description: |-\n            The update_id of the transaction or reassignment that resulted from the command with command_id.\n            Only set for successfully executed commands.\n            Must be a valid LedgerString (as described in ``value.proto``).\n          type: string\n        userId:\n          description: |-\n            The user-id that was used for the submission, as described in ``commands.proto``.\n            Must be a valid UserIdString (as described in ``value.proto``).\n            Optional for historic completions where this data is not available.\n          type: string\n        actAs:\n          description: |-\n            The set of parties on whose behalf the commands were executed.\n            Contains the ``act_as`` parties from ``commands.proto``\n            filtered to the requesting parties in CompletionStreamRequest.\n            The order of the parties need not be the same as in the submission.\n            Each element must be a valid PartyIdString (as described in ``value.proto``).\n            Optional for historic completions where this data is not available.\n          type: array\n          items:\n            type: string\n        submissionId:\n          description: |-\n            The submission ID this completion refers to, as described in ``commands.proto``.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        deduplicationPeriod:\n          $ref: '#/components/schemas/DeduplicationPeriod'\n        traceContext:\n          $ref: '#/components/schemas/TraceContext'\n          description: |-\n            Optional; ledger API trace context\n\n            The trace context transported in this message corresponds to the trace context supplied\n            by the client application in a HTTP2 header of the original command submission.\n            We typically use a header to transfer this type of information. Here we use message\n            body, because it is used in gRPC streams which do not support per message headers.\n            This field will be populated with the trace context contained in the original submission.\n            If that was not provided, a unique ledger-api-server generated trace context will be used\n            instead.\n        offset:\n          description: |-\n            May be used in a subsequent CompletionStreamRequest to resume the consumption of this stream at a later time.\n            Required, must be a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        synchronizerTime:\n          $ref: '#/components/schemas/SynchronizerTime'\n          description: |-\n            The synchronizer along with its record time.\n            The synchronizer id provided, in case of\n\n            - successful/failed transactions: identifies the synchronizer of the transaction\n            - for successful/failed unassign commands: identifies the source synchronizer\n            - for successful/failed assign commands: identifies the target synchronizer\n\n            Required\n    JsStatus:\n      title: JsStatus\n      type: object\n      required:\n      - code\n      - message\n      properties:\n        code:\n          type: integer\n          format: int32\n        message:\n          type: string\n        details:\n          type: array\n          items:\n            $ref: '#/components/schemas/ProtoAny'\n    ProtoAny:\n      title: ProtoAny\n      type: object\n      required:\n      - typeUrl\n      - value\n      - unknownFields\n      properties:\n        typeUrl:\n          type: string\n        value:\n          type: string\n        unknownFields:\n          $ref: '#/components/schemas/UnknownFieldSet'\n        valueDecoded:\n          type: string\n    UnknownFieldSet:\n      title: UnknownFieldSet\n      type: object\n      required:\n      - fields\n      properties:\n        fields:\n          $ref: '#/components/schemas/Map_Int_Field'\n    Map_Int_Field:\n      title: Map_Int_Field\n      type: object\n      additionalProperties:\n        $ref: '#/components/schemas/Field'\n    Field:\n      title: Field\n      type: object\n      properties:\n        varint:\n          type: array\n          items:\n            type: integer\n            format: int64\n        fixed64:\n          type: array\n          items:\n            type: integer\n            format: int64\n        fixed32:\n          type: array\n          items:\n            type: integer\n            format: int32\n        lengthDelimited:\n          type: array\n          items:\n            type: string\n    DeduplicationPeriod:\n      title: DeduplicationPeriod\n      oneOf:\n      - type: object\n        required:\n        - DeduplicationDuration\n        properties:\n          DeduplicationDuration:\n            $ref: '#/components/schemas/DeduplicationDuration'\n      - type: object\n        required:\n        - DeduplicationOffset\n        properties:\n          DeduplicationOffset:\n            $ref: '#/components/schemas/DeduplicationOffset'\n      - type: object\n        required:\n        - Empty\n        properties:\n          Empty:\n            $ref: '#/components/schemas/Empty'\n    DeduplicationDuration:\n      title: DeduplicationDuration\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/Duration'\n    Duration:\n      title: Duration\n      type: object\n      required:\n      - seconds\n      - nanos\n      properties:\n        seconds:\n          type: integer\n          format: int64\n        nanos:\n          type: integer\n          format: int32\n        unknownFields:\n          $ref: '#/components/schemas/UnknownFieldSet'\n          description: This field is automatically added as part of protobuf to json\n            mapping\n    DeduplicationOffset:\n      title: DeduplicationOffset\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          type: integer\n          format: int64\n    Empty:\n      title: Empty\n      type: object\n    TraceContext:\n      title: TraceContext\n      type: object\n      properties:\n        traceparent:\n          description: https://www.w3.org/TR/trace-context/\n          type: string\n        tracestate:\n          description: ''\n          type: string\n    SynchronizerTime:\n      title: SynchronizerTime\n      type: object\n      required:\n      - synchronizerId\n      properties:\n        synchronizerId:\n          description: |-\n            The id of the synchronizer.\n            Required\n          type: string\n        recordTime:\n          description: |-\n            All commands with a maximum record time below this value MUST be considered lost if their completion has not arrived before this checkpoint.\n            Required\n          type: string\n    Empty1:\n      title: Empty\n      type: object\n    OffsetCheckpoint:\n      title: OffsetCheckpoint\n      description: |-\n        OffsetCheckpoints may be used to:\n\n        - detect time out of commands.\n        - provide an offset which can be used to restart consumption.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/OffsetCheckpoint1'\n    OffsetCheckpoint1:\n      title: OffsetCheckpoint\n      description: |-\n        OffsetCheckpoints may be used to:\n\n        - detect time out of commands.\n        - provide an offset which can be used to restart consumption.\n      type: object\n      required:\n      - offset\n      properties:\n        offset:\n          description: |-\n            The participant's offset, the details of the offset field are described in ``community/ledger-api/README.md``.\n            Required, must be a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        synchronizerTimes:\n          description: ''\n          type: array\n          items:\n            $ref: '#/components/schemas/SynchronizerTime'\n    GetActiveContractsRequest:\n      title: GetActiveContractsRequest\n      description: |-\n        If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,\n        the snapshot may fail with \"FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED\".\n        Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party\n        migration is not concerned with incomplete (un)assignments.\n      type: object\n      required:\n      - verbose\n      - activeAtOffset\n      properties:\n        filter:\n          $ref: '#/components/schemas/TransactionFilter'\n          description: |-\n            Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n            Templates to include in the served snapshot, per party.\n            Optional, if specified event_format must be unset, if not specified event_format must be set.\n        verbose:\n          description: |-\n            Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n            If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n            In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.\n            Optional, if specified event_format must be unset.\n          type: boolean\n        activeAtOffset:\n          description: |-\n            The offset at which the snapshot of the active contracts will be computed.\n            Must be no greater than the current ledger end offset.\n            Must be greater than or equal to the last pruning offset.\n            Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).\n            If zero, the empty set will be returned.\n          type: integer\n          format: int64\n        eventFormat:\n          $ref: '#/components/schemas/EventFormat'\n          description: |-\n            Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of\n            TRANSACTION_SHAPE_ACS_DELTA.\n            Optional for backwards compatibility, defaults to an EventFormat where:\n\n            - filters_by_party is the filter.filters_by_party from this request\n            - filters_for_any_party is the filter.filters_for_any_party from this request\n            - verbose is the verbose field from this request\n    TransactionFilter:\n      title: TransactionFilter\n      description: |-\n        Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n        Used both for filtering create and archive events as well as for filtering transaction trees.\n      type: object\n      required:\n      - filtersByParty\n      properties:\n        filtersByParty:\n          $ref: '#/components/schemas/Map_Filters'\n          description: |-\n            Each key must be a valid PartyIdString (as described in ``value.proto``).\n            The interpretation of the filter depends on the transaction-shape being filtered:\n\n            1. For **transaction trees** (used in GetUpdateTreesResponse for backwards compatibility) all party keys used as\n               wildcard filters, and all subtrees whose root has one of the listed parties as an informee are returned.\n               If there are ``CumulativeFilter``s, those will control returned ``CreatedEvent`` fields where applicable, but will\n               not be used for template/interface filtering.\n            2. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of\n               the listed parties and match the per-party filter.\n            3. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose\n               stakeholders include at least one of the listed parties and match the per-party filter.\n        filtersForAnyParty:\n          $ref: '#/components/schemas/Filters'\n          description: |-\n            Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same\n            with the per-party filter as described above.\n    Map_Filters:\n      title: Map_Filters\n      type: object\n      additionalProperties:\n        $ref: '#/components/schemas/Filters'\n    Filters:\n      title: Filters\n      description: The union of a set of template filters, interface filters, or a\n        wildcard.\n      type: object\n      properties:\n        cumulative:\n          description: |-\n            Every filter in the cumulative list expands the scope of the resulting stream. Each interface,\n            template or wildcard filter means additional events that will match the query.\n            The impact of include_interface_view and include_created_event_blob fields in the filters will\n            also be accumulated.\n            A template or an interface SHOULD NOT appear twice in the accumulative field.\n            A wildcard filter SHOULD NOT be defined more than once in the accumulative field.\n            Optional, if no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with\n            include_created_event_blob unset is used.\n          type: array\n          items:\n            $ref: '#/components/schemas/CumulativeFilter'\n    CumulativeFilter:\n      title: CumulativeFilter\n      description: |-\n        A filter that matches all contracts that are either an instance of one of\n        the ``template_filters`` or that match one of the ``interface_filters``.\n      type: object\n      required:\n      - identifierFilter\n      properties:\n        identifierFilter:\n          $ref: '#/components/schemas/IdentifierFilter'\n    IdentifierFilter:\n      title: IdentifierFilter\n      oneOf:\n      - type: object\n        required:\n        - Empty\n        properties:\n          Empty:\n            $ref: '#/components/schemas/Empty2'\n      - type: object\n        required:\n        - InterfaceFilter\n        properties:\n          InterfaceFilter:\n            $ref: '#/components/schemas/InterfaceFilter'\n      - type: object\n        required:\n        - TemplateFilter\n        properties:\n          TemplateFilter:\n            $ref: '#/components/schemas/TemplateFilter'\n      - type: object\n        required:\n        - WildcardFilter\n        properties:\n          WildcardFilter:\n            $ref: '#/components/schemas/WildcardFilter'\n    Empty2:\n      title: Empty\n      type: object\n    InterfaceFilter:\n      title: InterfaceFilter\n      description: This filter matches contracts that implement a specific interface.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/InterfaceFilter1'\n    InterfaceFilter1:\n      title: InterfaceFilter\n      description: This filter matches contracts that implement a specific interface.\n      type: object\n      required:\n      - includeInterfaceView\n      - includeCreatedEventBlob\n      properties:\n        interfaceId:\n          description: |-\n            The interface that a matching contract must implement.\n            The ``interface_id`` needs to be valid: corresponding interface should be defined in\n            one of the available packages at the time of the query.\n            Both package-name and package-id reference formats for the identifier are supported.\n            Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n            Required\n          type: string\n        includeInterfaceView:\n          description: |-\n            Whether to include the interface view on the contract in the returned ``CreatedEvent``.\n            Use this to access contract data in a uniform manner in your API client.\n            Optional\n          type: boolean\n        includeCreatedEventBlob:\n          description: |-\n            Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n            Use this to access the contract create event payload in your API client\n            for submitting it as a disclosed contract with future commands.\n            Optional\n          type: boolean\n    TemplateFilter:\n      title: TemplateFilter\n      description: This filter matches contracts of a specific template.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/TemplateFilter1'\n    TemplateFilter1:\n      title: TemplateFilter\n      description: This filter matches contracts of a specific template.\n      type: object\n      required:\n      - includeCreatedEventBlob\n      properties:\n        templateId:\n          description: |-\n            A template for which the payload should be included in the response.\n            The ``template_id`` needs to be valid: corresponding template should be defined in\n            one of the available packages at the time of the query.\n            Both package-name and package-id reference formats for the identifier are supported.\n            Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.\n\n            Required\n          type: string\n        includeCreatedEventBlob:\n          description: |-\n            Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n            Use this to access the contract event payload in your API client\n            for submitting it as a disclosed contract with future commands.\n            Optional\n          type: boolean\n    WildcardFilter:\n      title: WildcardFilter\n      description: This filter matches all templates.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/WildcardFilter1'\n    WildcardFilter1:\n      title: WildcardFilter\n      description: This filter matches all templates.\n      type: object\n      required:\n      - includeCreatedEventBlob\n      properties:\n        includeCreatedEventBlob:\n          description: |-\n            Whether to include a ``created_event_blob`` in the returned ``CreatedEvent``.\n            Use this to access the contract create event payload in your API client\n            for submitting it as a disclosed contract with future commands.\n            Optional\n          type: boolean\n    EventFormat:\n      title: EventFormat\n      description: |-\n        A format for events which defines both which events should be included\n        and what data should be computed and included for them.\n\n        Note that some of the filtering behavior depends on the `TransactionShape`,\n        which is expected to be specified alongside usages of `EventFormat`.\n      type: object\n      required:\n      - filtersByParty\n      - verbose\n      properties:\n        filtersByParty:\n          $ref: '#/components/schemas/Map_Filters'\n          description: |-\n            Each key must be a valid PartyIdString (as described in ``value.proto``).\n            The interpretation of the filter depends on the transaction-shape being filtered:\n\n            1. For **ledger-effects** create and exercise events are returned, for which the witnesses include at least one of\n               the listed parties and match the per-party filter.\n            2. For **transaction and active-contract-set streams** create and archive events are returned for all contracts whose\n               stakeholders include at least one of the listed parties and match the per-party filter.\n\n            Optional\n        filtersForAnyParty:\n          $ref: '#/components/schemas/Filters'\n          description: |-\n            Wildcard filters that apply to all the parties existing on the participant. The interpretation of the filters is the same\n            with the per-party filter as described above.\n            Optional\n        verbose:\n          description: |-\n            If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n            In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.\n            Optional\n          type: boolean\n    Either_JsCantonError_JsGetActiveContractsResponse:\n      title: Either_JsCantonError_JsGetActiveContractsResponse\n      oneOf:\n      - $ref: '#/components/schemas/JsCantonError'\n      - $ref: '#/components/schemas/JsGetActiveContractsResponse'\n    JsGetActiveContractsResponse:\n      title: JsGetActiveContractsResponse\n      type: object\n      required:\n      - workflowId\n      - contractEntry\n      properties:\n        workflowId:\n          description: |-\n            The workflow ID used in command submission which corresponds to the contract_entry. Only set if\n            the ``workflow_id`` for the command was set.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        contractEntry:\n          $ref: '#/components/schemas/JsContractEntry'\n    JsContractEntry:\n      title: JsContractEntry\n      oneOf:\n      - type: object\n        required:\n        - JsActiveContract\n        properties:\n          JsActiveContract:\n            $ref: '#/components/schemas/JsActiveContract'\n      - type: object\n        required:\n        - JsEmpty\n        properties:\n          JsEmpty:\n            $ref: '#/components/schemas/JsEmpty'\n      - type: object\n        required:\n        - JsIncompleteAssigned\n        properties:\n          JsIncompleteAssigned:\n            $ref: '#/components/schemas/JsIncompleteAssigned'\n      - type: object\n        required:\n        - JsIncompleteUnassigned\n        properties:\n          JsIncompleteUnassigned:\n            $ref: '#/components/schemas/JsIncompleteUnassigned'\n    JsActiveContract:\n      title: JsActiveContract\n      type: object\n      required:\n      - createdEvent\n      - synchronizerId\n      - reassignmentCounter\n      properties:\n        createdEvent:\n          $ref: '#/components/schemas/CreatedEvent'\n          description: |-\n            Required\n            The event as it appeared in the context of its last update (i.e. daml transaction or\n            reassignment). In particular, the last offset, node_id pair is preserved.\n            The last update is the most recent update created or assigned this contract on synchronizer_id synchronizer.\n            The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used\n            for lookups.\n        synchronizerId:\n          description: |-\n            A valid synchronizer id\n            Required\n          type: string\n        reassignmentCounter:\n          description: |-\n            Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n            with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n            equals zero.\n            This field will be the reassignment_counter of the latest observable activation event on this synchronizer, which is\n            before the active_at_offset.\n            Required\n          type: integer\n          format: int64\n    CreatedEvent:\n      title: CreatedEvent\n      description: Records that a contract has been created, and choices may now be\n        exercised on it.\n      type: object\n      required:\n      - offset\n      - nodeId\n      - contractId\n      - templateId\n      - createdEventBlob\n      - createdAt\n      - packageName\n      - representativePackageId\n      - acsDelta\n      properties:\n        offset:\n          description: |-\n            The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent.\n            Offsets are managed by the participant nodes.\n            Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n            Required, it is a valid absolute offset (positive integer)\n          type: integer\n          format: int64\n        nodeId:\n          description: |-\n            The position of this event in the originating transaction or reassignment.\n            The origin has contextual meaning, please see description at messages that include a CreatedEvent.\n            Node IDs are not necessarily equal across participants,\n            as these may see different projections/parts of transactions.\n            Required, must be valid node ID (non-negative integer)\n          type: integer\n          format: int32\n        contractId:\n          description: |-\n            The ID of the created contract.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        templateId:\n          description: |-\n            The template of the created contract.\n            The identifier uses the package-id reference format.\n\n            Required\n          type: string\n        contractKey:\n          description: |-\n            The key of the created contract.\n            This will be set if and only if ``template_id`` defines a contract key.\n            Optional\n        createArgument: {}\n        createdEventBlob:\n          description: |-\n            Opaque representation of contract create event payload intended for forwarding\n            to an API server as a contract disclosed as part of a command\n            submission.\n            Optional\n          type: string\n        interfaceViews:\n          description: |-\n            Interface views specified in the transaction filter.\n            Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with\n\n            - its party in the ``witness_parties`` of this event,\n            - and which is implemented by the template of this event,\n            - and which has ``include_interface_view`` set.\n\n            Optional\n          type: array\n          items:\n            $ref: '#/components/schemas/JsInterfaceView'\n        witnessParties:\n          description: |-\n            The parties that are notified of this event. When a ``CreatedEvent``\n            is returned as part of a transaction tree or ledger-effects transaction, this will include all\n            the parties specified in the ``TransactionFilter`` that are witnesses  of the event\n            (the stakeholders of the contract and all informees of all the ancestors\n            of this create action that this participant knows about).\n            If served as part of a ACS delta transaction those will\n            be limited to all parties specified in the ``TransactionFilter`` that\n            are stakeholders of the contract (i.e. either signatories or observers).\n            If the ``CreatedEvent`` is returned as part of an AssignedEvent,\n            ActiveContract or IncompleteUnassigned (so the event is related to\n            an assignment or unassignment): this will include all parties of the\n            ``TransactionFilter`` that are stakeholders of the contract.\n\n            The behavior of reading create events visible to parties not hosted\n            on the participant node serving the Ledger API is undefined. Concretely,\n            there is neither a guarantee that the participant node will serve all their\n            create events on the ACS stream, nor is there a guarantee that matching archive\n            events are delivered for such create events.\n\n            For most clients this is not a problem, as they only read events for parties\n            that are hosted on the participant node. If you need to read events\n            for parties that may not be hosted at all times on the participant node,\n            subscribe to the ``TopologyEvent``s for that party by setting a corresponding\n            ``UpdateFormat``.  Using these events, query the ACS as-of an offset where the\n            party is hosted on the participant node, and ignore create events at offsets\n            where the party is not hosted on the participant node.\n            Required\n          type: array\n          items:\n            type: string\n        signatories:\n          description: |-\n            The signatories for this contract as specified by the template.\n            Required\n          type: array\n          items:\n            type: string\n        observers:\n          description: |-\n            The observers for this contract as specified explicitly by the template or implicitly as choice controllers.\n            This field never contains parties that are signatories.\n            Required\n          type: array\n          items:\n            type: string\n        createdAt:\n          description: |-\n            Ledger effective time of the transaction that created the contract.\n            Required\n          type: string\n        packageName:\n          description: |-\n            The package name of the created contract.\n            Required\n          type: string\n        representativePackageId:\n          description: |-\n            A package-id present in the participant package store that typechecks the contract's argument.\n            This may differ from the package-id of the template used to create the contract.\n            For contracts created before Canton 3.4, this field matches the contract's creation package-id.\n\n            NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice.\n\n            Required\n          type: string\n        acsDelta:\n          description: |-\n            Whether this event would be part of respective ACS_DELTA shaped stream,\n            and should therefore considered when tracking contract activeness on the client-side.\n            Required\n          type: boolean\n    JsInterfaceView:\n      title: JsInterfaceView\n      description: View of a create event matched by an interface filter.\n      type: object\n      required:\n      - interfaceId\n      - viewStatus\n      properties:\n        interfaceId:\n          description: |-\n            The interface implemented by the matched event.\n            The identifier uses the package-id reference format.\n\n            Required\n          type: string\n        viewStatus:\n          $ref: '#/components/schemas/JsStatus'\n          description: |-\n            Whether the view was successfully computed, and if not,\n            the reason for the error. The error is reported using the same rules\n            for error codes and messages as the errors returned for API requests.\n            Required\n        viewValue:\n          description: |-\n            The value of the interface's view method on this event.\n            Set if it was requested in the ``InterfaceFilter`` and it could be\n            successfully computed.\n            Optional\n    JsEmpty:\n      title: JsEmpty\n      type: object\n    JsIncompleteAssigned:\n      title: JsIncompleteAssigned\n      type: object\n      required:\n      - assignedEvent\n      properties:\n        assignedEvent:\n          $ref: '#/components/schemas/JsAssignedEvent'\n          description: Required\n    JsAssignedEvent:\n      title: JsAssignedEvent\n      description: Records that a contract has been assigned, and it can be used on\n        the target synchronizer.\n      type: object\n      required:\n      - source\n      - target\n      - reassignmentId\n      - submitter\n      - reassignmentCounter\n      - createdEvent\n      properties:\n        source:\n          description: |-\n            The ID of the source synchronizer.\n            Must be a valid synchronizer id.\n            Required\n          type: string\n        target:\n          description: |-\n            The ID of the target synchronizer.\n            Must be a valid synchronizer id.\n            Required\n          type: string\n        reassignmentId:\n          description: |-\n            The ID from the unassigned event.\n            For correlation capabilities.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        submitter:\n          description: |-\n            Party on whose behalf the assign command was executed.\n            Empty if the assignment happened offline via the repair service.\n            Must be a valid PartyIdString (as described in ``value.proto``).\n            Optional\n          type: string\n        reassignmentCounter:\n          description: |-\n            Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n            with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n            equals zero.\n            Required\n          type: integer\n          format: int64\n        createdEvent:\n          $ref: '#/components/schemas/CreatedEvent'\n          description: |-\n            Required\n            The offset of this event refers to the offset of the assignment,\n            while the node_id is the index of within the batch.\n    JsIncompleteUnassigned:\n      title: JsIncompleteUnassigned\n      type: object\n      required:\n      - createdEvent\n      - unassignedEvent\n      properties:\n        createdEvent:\n          $ref: '#/components/schemas/CreatedEvent'\n          description: |-\n            Required\n            The event as it appeared in the context of its last activation update (i.e. daml transaction or\n            reassignment). In particular, the last activation offset, node_id pair is preserved.\n            The last activation update is the most recent update created or assigned this contract on synchronizer_id synchronizer before\n            the unassigned_event.\n            The offset of the CreatedEvent might point to an already pruned update, therefore it cannot necessarily be used\n            for lookups.\n        unassignedEvent:\n          $ref: '#/components/schemas/UnassignedEvent'\n          description: Required\n    UnassignedEvent:\n      title: UnassignedEvent\n      description: Records that a contract has been unassigned, and it becomes unusable\n        on the source synchronizer\n      type: object\n      required:\n      - reassignmentId\n      - contractId\n      - source\n      - target\n      - submitter\n      - reassignmentCounter\n      - packageName\n      - offset\n      - nodeId\n      properties:\n        reassignmentId:\n          description: |-\n            The ID of the unassignment. This needs to be used as an input for a assign ReassignmentCommand.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        contractId:\n          description: |-\n            The ID of the reassigned contract.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        templateId:\n          description: |-\n            The template of the reassigned contract.\n            The identifier uses the package-id reference format.\n\n            Required\n          type: string\n        source:\n          description: |-\n            The ID of the source synchronizer\n            Must be a valid synchronizer id\n            Required\n          type: string\n        target:\n          description: |-\n            The ID of the target synchronizer\n            Must be a valid synchronizer id\n            Required\n          type: string\n        submitter:\n          description: |-\n            Party on whose behalf the unassign command was executed.\n            Empty if the unassignment happened offline via the repair service.\n            Must be a valid PartyIdString (as described in ``value.proto``).\n            Optional\n          type: string\n        reassignmentCounter:\n          description: |-\n            Each corresponding assigned and unassigned event has the same reassignment_counter. This strictly increases\n            with each unassign command for the same contract. Creation of the contract corresponds to reassignment_counter\n            equals zero.\n            Required\n          type: integer\n          format: int64\n        assignmentExclusivity:\n          description: |-\n            Assignment exclusivity\n            Before this time (measured on the target synchronizer), only the submitter of the unassignment can initiate the assignment\n            Defined for reassigning participants.\n            Optional\n          type: string\n        witnessParties:\n          description: |-\n            The parties that are notified of this event.\n            Required\n          type: array\n          items:\n            type: string\n        packageName:\n          description: |-\n            The package name of the contract.\n            Required\n          type: string\n        offset:\n          description: |-\n            The offset of origin.\n            Offsets are managed by the participant nodes.\n            Reassignments can thus NOT be assumed to have the same offsets on different participant nodes.\n            Required, it is a valid absolute offset (positive integer)\n          type: integer\n          format: int64\n        nodeId:\n          description: |-\n            The position of this event in the originating reassignment.\n            Node IDs are not necessarily equal across participants,\n            as these may see different projections/parts of reassignments.\n            Required, must be valid node ID (non-negative integer)\n          type: integer\n          format: int32\n    GetUpdatesRequest:\n      title: GetUpdatesRequest\n      type: object\n      required:\n      - beginExclusive\n      - verbose\n      properties:\n        beginExclusive:\n          description: |-\n            Beginning of the requested ledger section (non-negative integer).\n            The response will only contain transactions whose offset is strictly greater than this.\n            If zero, the stream will start from the beginning of the ledger.\n            If positive, the streaming will start after this absolute offset.\n            If the ledger has been pruned, this parameter must be specified and be greater than the pruning offset.\n          type: integer\n          format: int64\n        endInclusive:\n          description: |-\n            End of the requested ledger section.\n            The response will only contain transactions whose offset is less than or equal to this.\n            Optional, if empty, the stream will not terminate.\n            If specified, the stream will terminate after this absolute offset (positive integer) is reached.\n          type: integer\n          format: int64\n        filter:\n          $ref: '#/components/schemas/TransactionFilter'\n          description: |-\n            Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n            Requesting parties with template filters.\n            Template filters must be empty for GetUpdateTrees requests.\n            Optional for backwards compatibility, if defined update_format must be unset\n        verbose:\n          description: |-\n            Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n            If enabled, values served over the API will contain more information than strictly necessary to interpret the data.\n            In particular, setting the verbose flag to true triggers the ledger to include labels, record and variant type ids\n            for record fields.\n            Optional for backwards compatibility, if defined update_format must be unset\n          type: boolean\n        updateFormat:\n          $ref: '#/components/schemas/UpdateFormat'\n          description: |-\n            Must be unset for GetUpdateTrees request.\n            Optional for backwards compatibility for GetUpdates request: defaults to an UpdateFormat where:\n\n            - include_transactions.event_format.filters_by_party = the filter.filters_by_party on this request\n            - include_transactions.event_format.filters_for_any_party = the filter.filters_for_any_party on this request\n            - include_transactions.event_format.verbose = the same flag specified on this request\n            - include_transactions.transaction_shape = TRANSACTION_SHAPE_ACS_DELTA\n            - include_reassignments.filter = the same filter specified on this request\n            - include_reassignments.verbose = the same flag specified on this request\n            - include_topology_events.include_participant_authorization_events.parties = all the parties specified in filter\n    UpdateFormat:\n      title: UpdateFormat\n      description: A format specifying what updates to include and how to render them.\n      type: object\n      properties:\n        includeTransactions:\n          $ref: '#/components/schemas/TransactionFormat'\n          description: |-\n            Include Daml transactions in streams.\n            Optional, if unset, no transactions are emitted in the stream.\n        includeReassignments:\n          $ref: '#/components/schemas/EventFormat'\n          description: |-\n            Include (un)assignments in the stream.\n            The events in the result take the shape TRANSACTION_SHAPE_ACS_DELTA.\n            Optional, if unset, no (un)assignments are emitted in the stream.\n        includeTopologyEvents:\n          $ref: '#/components/schemas/TopologyFormat'\n          description: |-\n            Include topology events in streams.\n            Optional, if unset no topology events are emitted in the stream.\n    TransactionFormat:\n      title: TransactionFormat\n      description: |-\n        A format that specifies what events to include in Daml transactions\n        and what data to compute and include for them.\n      type: object\n      required:\n      - transactionShape\n      properties:\n        eventFormat:\n          $ref: '#/components/schemas/EventFormat'\n          description: Required\n        transactionShape:\n          description: |-\n            What transaction shape to use for interpreting the filters of the event format.\n            Required\n          type: string\n          enum:\n          - TRANSACTION_SHAPE_UNSPECIFIED\n          - TRANSACTION_SHAPE_ACS_DELTA\n          - TRANSACTION_SHAPE_LEDGER_EFFECTS\n    TopologyFormat:\n      title: TopologyFormat\n      description: A format specifying which topology transactions to include and\n        how to render them.\n      type: object\n      properties:\n        includeParticipantAuthorizationEvents:\n          $ref: '#/components/schemas/ParticipantAuthorizationTopologyFormat'\n          description: |-\n            Include participant authorization topology events in streams.\n            Optional, if unset no participant authorization topology events are emitted in the stream.\n    ParticipantAuthorizationTopologyFormat:\n      title: ParticipantAuthorizationTopologyFormat\n      description: A format specifying which participant authorization topology transactions\n        to include and how to render them.\n      type: object\n      properties:\n        parties:\n          description: |-\n            List of parties for which the topology transactions should be sent.\n            Empty means: for all parties.\n          type: array\n          items:\n            type: string\n    Either_JsCantonError_JsGetUpdatesResponse:\n      title: Either_JsCantonError_JsGetUpdatesResponse\n      oneOf:\n      - $ref: '#/components/schemas/JsCantonError'\n      - $ref: '#/components/schemas/JsGetUpdatesResponse'\n    JsGetUpdatesResponse:\n      title: JsGetUpdatesResponse\n      type: object\n      required:\n      - update\n      properties:\n        update:\n          $ref: '#/components/schemas/Update'\n    Update:\n      title: Update\n      oneOf:\n      - type: object\n        required:\n        - OffsetCheckpoint\n        properties:\n          OffsetCheckpoint:\n            $ref: '#/components/schemas/OffsetCheckpoint2'\n      - type: object\n        required:\n        - Reassignment\n        properties:\n          Reassignment:\n            $ref: '#/components/schemas/Reassignment'\n      - type: object\n        required:\n        - TopologyTransaction\n        properties:\n          TopologyTransaction:\n            $ref: '#/components/schemas/TopologyTransaction'\n      - type: object\n        required:\n        - Transaction\n        properties:\n          Transaction:\n            $ref: '#/components/schemas/Transaction'\n    OffsetCheckpoint2:\n      title: OffsetCheckpoint\n      description: |-\n        OffsetCheckpoints may be used to:\n\n        - detect time out of commands.\n        - provide an offset which can be used to restart consumption.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/OffsetCheckpoint1'\n    Reassignment:\n      title: Reassignment\n      description: Complete view of an on-ledger reassignment.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/JsReassignment'\n    JsReassignment:\n      title: JsReassignment\n      description: Complete view of an on-ledger reassignment.\n      type: object\n      required:\n      - updateId\n      - commandId\n      - workflowId\n      - offset\n      - recordTime\n      - synchronizerId\n      properties:\n        updateId:\n          description: |-\n            Assigned by the server. Useful for correlating logs.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        commandId:\n          description: |-\n            The ID of the command which resulted in this reassignment. Missing for everyone except the submitting party on the submitting participant.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        workflowId:\n          description: |-\n            The workflow ID used in reassignment command submission. Only set if the ``workflow_id`` for the command was set.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        offset:\n          description: |-\n            The participant's offset. The details of this field are described in ``community/ledger-api/README.md``.\n            Required, must be a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        events:\n          description: The collection of reassignment events. Required.\n          type: array\n          items:\n            $ref: '#/components/schemas/JsReassignmentEvent'\n        traceContext:\n          $ref: '#/components/schemas/TraceContext'\n          description: |-\n            Optional; ledger API trace context\n\n            The trace context transported in this message corresponds to the trace context supplied\n            by the client application in a HTTP2 header of the original command submission.\n            We typically use a header to transfer this type of information. Here we use message\n            body, because it is used in gRPC streams which do not support per message headers.\n            This field will be populated with the trace context contained in the original submission.\n            If that was not provided, a unique ledger-api-server generated trace context will be used\n            instead.\n        recordTime:\n          description: |-\n            The time at which the reassignment was recorded. The record time refers to the source/target\n            synchronizer for an unassign/assign event respectively.\n            Required\n          type: string\n        synchronizerId:\n          description: |-\n            A valid synchronizer id.\n            Identifies the synchronizer that synchronized this Reassignment.\n            Required\n          type: string\n    JsReassignmentEvent:\n      title: JsReassignmentEvent\n      oneOf:\n      - type: object\n        required:\n        - JsAssignmentEvent\n        properties:\n          JsAssignmentEvent:\n            $ref: '#/components/schemas/JsAssignmentEvent'\n      - type: object\n        required:\n        - JsUnassignedEvent\n        properties:\n          JsUnassignedEvent:\n            $ref: '#/components/schemas/JsUnassignedEvent'\n    JsAssignmentEvent:\n      title: JsAssignmentEvent\n      type: object\n      required:\n      - source\n      - target\n      - reassignmentId\n      - submitter\n      - reassignmentCounter\n      - createdEvent\n      properties:\n        source:\n          type: string\n        target:\n          type: string\n        reassignmentId:\n          type: string\n        submitter:\n          type: string\n        reassignmentCounter:\n          type: integer\n          format: int64\n        createdEvent:\n          $ref: '#/components/schemas/CreatedEvent'\n    JsUnassignedEvent:\n      title: JsUnassignedEvent\n      description: Records that a contract has been unassigned, and it becomes unusable\n        on the source synchronizer\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/UnassignedEvent'\n    TopologyTransaction:\n      title: TopologyTransaction\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/JsTopologyTransaction'\n    JsTopologyTransaction:\n      title: JsTopologyTransaction\n      type: object\n      required:\n      - updateId\n      - offset\n      - synchronizerId\n      properties:\n        updateId:\n          description: |-\n            Assigned by the server. Useful for correlating logs.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        offset:\n          description: |-\n            The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n            Required, it is a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        synchronizerId:\n          description: |-\n            A valid synchronizer id.\n            Identifies the synchronizer that synchronized the topology transaction.\n            Required\n          type: string\n        recordTime:\n          description: |-\n            The time at which the changes in the topology transaction become effective. There is a small delay between a\n            topology transaction being sequenced and the changes it contains becoming effective. Topology transactions appear\n            in order relative to a synchronizer based on their effective time rather than their sequencing time.\n            Required\n          type: string\n        events:\n          description: |-\n            A non-empty list of topology events.\n            Required\n          type: array\n          items:\n            $ref: '#/components/schemas/TopologyEvent'\n        traceContext:\n          $ref: '#/components/schemas/TraceContext'\n          description: |-\n            Optional; ledger API trace context\n\n            The trace context transported in this message corresponds to the trace context supplied\n            by the client application in a HTTP2 header of the original command submission.\n            We typically use a header to transfer this type of information. Here we use message\n            body, because it is used in gRPC streams which do not support per message headers.\n            This field will be populated with the trace context contained in the original submission.\n            If that was not provided, a unique ledger-api-server generated trace context will be used\n            instead.\n    TopologyEvent:\n      title: TopologyEvent\n      type: object\n      required:\n      - event\n      properties:\n        event:\n          $ref: '#/components/schemas/TopologyEventEvent'\n    TopologyEventEvent:\n      title: TopologyEventEvent\n      oneOf:\n      - type: object\n        required:\n        - Empty\n        properties:\n          Empty:\n            $ref: '#/components/schemas/Empty3'\n      - type: object\n        required:\n        - ParticipantAuthorizationAdded\n        properties:\n          ParticipantAuthorizationAdded:\n            $ref: '#/components/schemas/ParticipantAuthorizationAdded'\n      - type: object\n        required:\n        - ParticipantAuthorizationChanged\n        properties:\n          ParticipantAuthorizationChanged:\n            $ref: '#/components/schemas/ParticipantAuthorizationChanged'\n      - type: object\n        required:\n        - ParticipantAuthorizationRevoked\n        properties:\n          ParticipantAuthorizationRevoked:\n            $ref: '#/components/schemas/ParticipantAuthorizationRevoked'\n    Empty3:\n      title: Empty\n      type: object\n    ParticipantAuthorizationAdded:\n      title: ParticipantAuthorizationAdded\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/ParticipantAuthorizationAdded1'\n    ParticipantAuthorizationAdded1:\n      title: ParticipantAuthorizationAdded\n      type: object\n      required:\n      - partyId\n      - participantId\n      - participantPermission\n      properties:\n        partyId:\n          description: Required\n          type: string\n        participantId:\n          description: Required\n          type: string\n        participantPermission:\n          description: Required\n          type: string\n          enum:\n          - PARTICIPANT_PERMISSION_UNSPECIFIED\n          - PARTICIPANT_PERMISSION_SUBMISSION\n          - PARTICIPANT_PERMISSION_CONFIRMATION\n          - PARTICIPANT_PERMISSION_OBSERVATION\n    ParticipantAuthorizationChanged:\n      title: ParticipantAuthorizationChanged\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/ParticipantAuthorizationChanged1'\n    ParticipantAuthorizationChanged1:\n      title: ParticipantAuthorizationChanged\n      type: object\n      required:\n      - partyId\n      - participantId\n      - participantPermission\n      properties:\n        partyId:\n          description: Required\n          type: string\n        participantId:\n          description: Required\n          type: string\n        participantPermission:\n          description: Required\n          type: string\n          enum:\n          - PARTICIPANT_PERMISSION_UNSPECIFIED\n          - PARTICIPANT_PERMISSION_SUBMISSION\n          - PARTICIPANT_PERMISSION_CONFIRMATION\n          - PARTICIPANT_PERMISSION_OBSERVATION\n    ParticipantAuthorizationRevoked:\n      title: ParticipantAuthorizationRevoked\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/ParticipantAuthorizationRevoked1'\n    ParticipantAuthorizationRevoked1:\n      title: ParticipantAuthorizationRevoked\n      type: object\n      required:\n      - partyId\n      - participantId\n      properties:\n        partyId:\n          description: Required\n          type: string\n        participantId:\n          description: Required\n          type: string\n    Transaction:\n      title: Transaction\n      description: Filtered view of an on-ledger transaction's create and archive\n        events.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/JsTransaction'\n    JsTransaction:\n      title: JsTransaction\n      description: Filtered view of an on-ledger transaction's create and archive\n        events.\n      type: object\n      required:\n      - updateId\n      - commandId\n      - workflowId\n      - effectiveAt\n      - offset\n      - synchronizerId\n      - recordTime\n      properties:\n        updateId:\n          description: |-\n            Assigned by the server. Useful for correlating logs.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        commandId:\n          description: |-\n            The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        workflowId:\n          description: |-\n            The workflow ID used in command submission.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        effectiveAt:\n          description: |-\n            Ledger effective time.\n            Required\n          type: string\n        events:\n          description: |-\n            The collection of events.\n            Contains:\n\n            - ``CreatedEvent`` or ``ArchivedEvent`` in case of ACS_DELTA transaction shape\n            - ``CreatedEvent`` or ``ExercisedEvent`` in case of LEDGER_EFFECTS transaction shape\n\n            Required\n          type: array\n          items:\n            $ref: '#/components/schemas/Event'\n        offset:\n          description: |-\n            The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n            Required, it is a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        synchronizerId:\n          description: |-\n            A valid synchronizer id.\n            Identifies the synchronizer that synchronized the transaction.\n            Required\n          type: string\n        traceContext:\n          $ref: '#/components/schemas/TraceContext'\n          description: |-\n            Optional; ledger API trace context\n\n            The trace context transported in this message corresponds to the trace context supplied\n            by the client application in a HTTP2 header of the original command submission.\n            We typically use a header to transfer this type of information. Here we use message\n            body, because it is used in gRPC streams which do not support per message headers.\n            This field will be populated with the trace context contained in the original submission.\n            If that was not provided, a unique ledger-api-server generated trace context will be used\n            instead.\n        recordTime:\n          description: |-\n            The time at which the transaction was recorded. The record time refers to the synchronizer\n            which synchronized the transaction.\n            Required\n          type: string\n        externalTransactionHash:\n          description: |-\n            For transaction externally signed, contains the external transaction hash\n            signed by the external party. Can be used to correlate an external submission with a committed transaction.\n            Optional\n          type: string\n    Event:\n      title: Event\n      description: |-\n        Events in transactions can have two primary shapes:\n\n        - ACS delta: events can be CreatedEvent or ArchivedEvent\n        - ledger effects: events can be CreatedEvent or ExercisedEvent\n\n        In the update service the events are restricted to the events\n        visible for the parties specified in the transaction filter. Each\n        event message type below contains a ``witness_parties`` field which\n        indicates the subset of the requested parties that can see the event\n        in question.\n      oneOf:\n      - type: object\n        required:\n        - ArchivedEvent\n        properties:\n          ArchivedEvent:\n            $ref: '#/components/schemas/ArchivedEvent'\n      - type: object\n        required:\n        - CreatedEvent\n        properties:\n          CreatedEvent:\n            $ref: '#/components/schemas/CreatedEvent'\n      - type: object\n        required:\n        - ExercisedEvent\n        properties:\n          ExercisedEvent:\n            $ref: '#/components/schemas/ExercisedEvent'\n    ArchivedEvent:\n      title: ArchivedEvent\n      description: Records that a contract has been archived, and choices may no longer\n        be exercised on it.\n      type: object\n      required:\n      - offset\n      - nodeId\n      - contractId\n      - templateId\n      - packageName\n      properties:\n        offset:\n          description: |-\n            The offset of origin.\n            Offsets are managed by the participant nodes.\n            Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n            Required, it is a valid absolute offset (positive integer)\n          type: integer\n          format: int64\n        nodeId:\n          description: |-\n            The position of this event in the originating transaction or reassignment.\n            Node IDs are not necessarily equal across participants,\n            as these may see different projections/parts of transactions.\n            Required, must be valid node ID (non-negative integer)\n          type: integer\n          format: int32\n        contractId:\n          description: |-\n            The ID of the archived contract.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        templateId:\n          description: |-\n            Identifies the template that defines the choice that archived the contract.\n            This template's package-id may differ from the target contract's package-id\n            if the target contract has been upgraded or downgraded.\n\n            The identifier uses the package-id reference format.\n\n            Required\n          type: string\n        witnessParties:\n          description: |-\n            The parties that are notified of this event. For an ``ArchivedEvent``,\n            these are the intersection of the stakeholders of the contract in\n            question and the parties specified in the ``TransactionFilter``. The\n            stakeholders are the union of the signatories and the observers of\n            the contract.\n            Each one of its elements must be a valid PartyIdString (as described\n            in ``value.proto``).\n            Required\n          type: array\n          items:\n            type: string\n        packageName:\n          description: |-\n            The package name of the contract.\n            Required\n          type: string\n        implementedInterfaces:\n          description: |-\n            The interfaces implemented by the target template that have been\n            matched from the interface filter query.\n            Populated only in case interface filters with include_interface_view set.\n\n            If defined, the identifier uses the package-id reference format.\n\n            Optional\n          type: array\n          items:\n            type: string\n    ExercisedEvent:\n      title: ExercisedEvent\n      description: Records that a choice has been exercised on a target contract.\n      type: object\n      required:\n      - offset\n      - nodeId\n      - contractId\n      - templateId\n      - choice\n      - choiceArgument\n      - consuming\n      - lastDescendantNodeId\n      - exerciseResult\n      - packageName\n      - acsDelta\n      properties:\n        offset:\n          description: |-\n            The offset of origin.\n            Offsets are managed by the participant nodes.\n            Transactions can thus NOT be assumed to have the same offsets on different participant nodes.\n            Required, it is a valid absolute offset (positive integer)\n          type: integer\n          format: int64\n        nodeId:\n          description: |-\n            The position of this event in the originating transaction or reassignment.\n            Node IDs are not necessarily equal across participants,\n            as these may see different projections/parts of transactions.\n            Required, must be valid node ID (non-negative integer)\n          type: integer\n          format: int32\n        contractId:\n          description: |-\n            The ID of the target contract.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        templateId:\n          description: |-\n            Identifies the template that defines the executed choice.\n            This template's package-id may differ from the target contract's package-id\n            if the target contract has been upgraded or downgraded.\n\n            The identifier uses the package-id reference format.\n\n            Required\n          type: string\n        interfaceId:\n          description: |-\n            The interface where the choice is defined, if inherited.\n            If defined, the identifier uses the package-id reference format.\n\n            Optional\n          type: string\n        choice:\n          description: |-\n            The choice that was exercised on the target contract.\n            Must be a valid NameString (as described in ``value.proto``).\n            Required\n          type: string\n        choiceArgument:\n          description: |-\n            The argument of the exercised choice.\n            Required\n        actingParties:\n          description: |-\n            The parties that exercised the choice.\n            Each element must be a valid PartyIdString (as described in ``value.proto``).\n            Required\n          type: array\n          items:\n            type: string\n        consuming:\n          description: |-\n            If true, the target contract may no longer be exercised.\n            Required\n          type: boolean\n        witnessParties:\n          description: |-\n            The parties that are notified of this event. The witnesses of an exercise\n            node will depend on whether the exercise was consuming or not.\n            If consuming, the witnesses are the union of the stakeholders,\n            the actors and all informees of all the ancestors of this event this\n            participant knows about.\n            If not consuming, the witnesses are the union of the signatories,\n            the actors and all informees of all the ancestors of this event this\n            participant knows about.\n            In both cases the witnesses are limited to the querying parties, or not\n            limited in case anyParty filters are used.\n            Note that the actors might not necessarily be observers\n            and thus stakeholders. This is the case when the controllers of a\n            choice are specified using \"flexible controllers\", using the\n            ``choice ... controller`` syntax, and said controllers are not\n            explicitly marked as observers.\n            Each element must be a valid PartyIdString (as described in ``value.proto``).\n            Required\n          type: array\n          items:\n            type: string\n        lastDescendantNodeId:\n          description: |-\n            Specifies the upper boundary of the node ids of the events in the same transaction that appeared as a result of\n            this ``ExercisedEvent``. This allows unambiguous identification of all the members of the subtree rooted at this\n            node. A full subtree can be constructed when all descendant nodes are present in the stream. If nodes are heavily\n            filtered, it is only possible to determine if a node is in a consequent subtree or not.\n            Required\n          type: integer\n          format: int32\n        exerciseResult:\n          description: |-\n            The result of exercising the choice.\n            Required\n        packageName:\n          description: |-\n            The package name of the contract.\n            Required\n          type: string\n        implementedInterfaces:\n          description: |-\n            If the event is consuming, the interfaces implemented by the target template that have been\n            matched from the interface filter query.\n            Populated only in case interface filters with include_interface_view set.\n\n            The identifier uses the package-id reference format.\n\n            Optional\n          type: array\n          items:\n            type: string\n        acsDelta:\n          description: |-\n            Whether this event would be part of respective ACS_DELTA shaped stream,\n            and should therefore considered when tracking contract activeness on the client-side.\n            Required\n          type: boolean\n    Either_JsCantonError_JsGetUpdateTreesResponse:\n      title: Either_JsCantonError_JsGetUpdateTreesResponse\n      oneOf:\n      - $ref: '#/components/schemas/JsCantonError'\n      - $ref: '#/components/schemas/JsGetUpdateTreesResponse'\n    JsGetUpdateTreesResponse:\n      title: JsGetUpdateTreesResponse\n      description: Provided for backwards compatibility, it will be removed in the\n        Canton version 3.5.0.\n      type: object\n      required:\n      - update\n      properties:\n        update:\n          $ref: '#/components/schemas/Update1'\n    Update1:\n      title: Update\n      oneOf:\n      - type: object\n        required:\n        - OffsetCheckpoint\n        properties:\n          OffsetCheckpoint:\n            $ref: '#/components/schemas/OffsetCheckpoint3'\n      - type: object\n        required:\n        - Reassignment\n        properties:\n          Reassignment:\n            $ref: '#/components/schemas/Reassignment1'\n      - type: object\n        required:\n        - TransactionTree\n        properties:\n          TransactionTree:\n            $ref: '#/components/schemas/TransactionTree'\n    OffsetCheckpoint3:\n      title: OffsetCheckpoint\n      description: |-\n        OffsetCheckpoints may be used to:\n\n        - detect time out of commands.\n        - provide an offset which can be used to restart consumption.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/OffsetCheckpoint1'\n    Reassignment1:\n      title: Reassignment\n      description: Complete view of an on-ledger reassignment.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/JsReassignment'\n    TransactionTree:\n      title: TransactionTree\n      description: |-\n        Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n        Complete view of an on-ledger transaction.\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/JsTransactionTree'\n    JsTransactionTree:\n      title: JsTransactionTree\n      description: |-\n        Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n        Complete view of an on-ledger transaction.\n      type: object\n      required:\n      - updateId\n      - commandId\n      - workflowId\n      - offset\n      - eventsById\n      - synchronizerId\n      - recordTime\n      properties:\n        updateId:\n          description: |-\n            Assigned by the server. Useful for correlating logs.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Required\n          type: string\n        commandId:\n          description: |-\n            The ID of the command which resulted in this transaction. Missing for everyone except the submitting party.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        workflowId:\n          description: |-\n            The workflow ID used in command submission. Only set if the ``workflow_id`` for the command was set.\n            Must be a valid LedgerString (as described in ``value.proto``).\n            Optional\n          type: string\n        effectiveAt:\n          description: |-\n            Ledger effective time.\n            Required\n          type: string\n        offset:\n          description: |-\n            The absolute offset. The details of this field are described in ``community/ledger-api/README.md``.\n            Required, it is a valid absolute offset (positive integer).\n          type: integer\n          format: int64\n        eventsById:\n          $ref: '#/components/schemas/Map_Int_TreeEvent'\n          description: |-\n            Changes to the ledger that were caused by this transaction. Nodes of the transaction tree.\n            Each key must be a valid node ID (non-negative integer).\n            Required\n        synchronizerId:\n          description: |-\n            A valid synchronizer id.\n            Identifies the synchronizer that synchronized the transaction.\n            Required\n          type: string\n        traceContext:\n          $ref: '#/components/schemas/TraceContext'\n          description: |-\n            Optional; ledger API trace context\n\n            The trace context transported in this message corresponds to the trace context supplied\n            by the client application in a HTTP2 header of the original command submission.\n            We typically use a header to transfer this type of information. Here we use message\n            body, because it is used in gRPC streams which do not support per message headers.\n            This field will be populated with the trace context contained in the original submission.\n            If that was not provided, a unique ledger-api-server generated trace context will be used\n            instead.\n        recordTime:\n          description: |-\n            The time at which the transaction was recorded. The record time refers to the synchronizer\n            which synchronized the transaction.\n            Required\n          type: string\n    Map_Int_TreeEvent:\n      title: Map_Int_TreeEvent\n      type: object\n      additionalProperties:\n        $ref: '#/components/schemas/TreeEvent'\n    TreeEvent:\n      title: TreeEvent\n      description: |-\n        Provided for backwards compatibility, it will be removed in the Canton version 3.5.0.\n        Each tree event message type below contains a ``witness_parties`` field which\n        indicates the subset of the requested parties that can see the event\n        in question.\n\n        Note that transaction trees might contain events with\n        _no_ witness parties, which were included simply because they were\n        children of events which have witnesses.\n      oneOf:\n      - type: object\n        required:\n        - CreatedTreeEvent\n        properties:\n          CreatedTreeEvent:\n            $ref: '#/components/schemas/CreatedTreeEvent'\n      - type: object\n        required:\n        - ExercisedTreeEvent\n        properties:\n          ExercisedTreeEvent:\n            $ref: '#/components/schemas/ExercisedTreeEvent'\n    CreatedTreeEvent:\n      title: CreatedTreeEvent\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/CreatedEvent'\n    ExercisedTreeEvent:\n      title: ExercisedTreeEvent\n      type: object\n      required:\n      - value\n      properties:\n        value:\n          $ref: '#/components/schemas/ExercisedEvent'\n  messages:\n    CompletionStreamRequest:\n      payload:\n        $ref: '#/components/schemas/CompletionStreamRequest'\n      contentType: application/json\n    Either_JsCantonError_CompletionStreamResponse:\n      payload:\n        $ref: '#/components/schemas/Either_JsCantonError_CompletionStreamResponse'\n      contentType: application/json\n    GetActiveContractsRequest:\n      payload:\n        $ref: '#/components/schemas/GetActiveContractsRequest'\n      contentType: application/json\n    Either_JsCantonError_JsGetActiveContractsResponse:\n      payload:\n        $ref: '#/components/schemas/Either_JsCantonError_JsGetActiveContractsResponse'\n      contentType: application/json\n    GetUpdatesRequest:\n      payload:\n        $ref: '#/components/schemas/GetUpdatesRequest'\n      contentType: application/json\n    Either_JsCantonError_JsGetUpdatesResponse:\n      payload:\n        $ref: '#/components/schemas/Either_JsCantonError_JsGetUpdatesResponse'\n      contentType: application/json\n    Either_JsCantonError_JsGetUpdateTreesResponse:\n      payload:\n        $ref: '#/components/schemas/Either_JsCantonError_JsGetUpdateTreesResponse'\n      contentType: application/json\n  securitySchemes:\n    httpAuth:\n      type: http\n      description: Ledger API standard JWT token\n      scheme: bearer\n    httpApiKeyAuth:\n      type: httpApiKey\n      description: Ledger API standard JWT token (websocket)\n      name: Sec-WebSocket-Protocol\n      in: header\n";