Package com.daml.ledger.api.v2

Interface UpdateServiceGrpc.AsyncService

All Known Implementing Classes:
UpdateServiceGrpc.UpdateServiceImplBase
Enclosing class:
UpdateServiceGrpc
public static interface UpdateServiceGrpc.AsyncService
 Allows clients to read updates (transactions, (un)assignments, topology events) from the ledger.
 ``GetUpdates`` provides a comprehensive stream of updates/changes
 which happened on the virtual shared ledger. These streams are indexed with ledger
 offsets, which are strictly increasing.
 The virtual shared ledger consist of changes happening on multiple synchronizers which are
 connected to the serving participant. Each update belongs to one synchronizer, this is
 provided in the result (the ``synchronizer_id`` field in ``Transaction``
 for transactions, the ``source`` field in ``UnassignedEvent`` and the ``target`` field in ``AssignedEvent``).
 Consumers can rely on strong causal guarantees on the virtual shared ledger for a single
 synchronizer: updates which have greater offsets are happened after than updates with smaller
 offsets for the same synchronizer. Across different synchronizers this is not guaranteed.

  • Method Details

    • getUpdates

      default void getUpdates(UpdateServiceOuterClass.GetUpdatesRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesResponse> responseObserver)
       Read the ledger's filtered update stream for the specified contents and filters.
 It returns the event types in accordance with the stream contents selected. Also the selection criteria
 for individual events depends on the transaction shape chosen.
 - ACS delta: a requesting party must be a stakeholder of an event for it to be included.
 - ledger effects: a requesting party must be a witness of an event for it to be included.

    • getUpdateByOffset

      default void getUpdateByOffset(UpdateServiceOuterClass.GetUpdateByOffsetRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)
       Lookup an update by its offset.
 If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

    • getUpdateById

      default void getUpdateById(UpdateServiceOuterClass.GetUpdateByIdRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)
       Lookup an update by its ID.
 If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

    • getUpdatesPage

      default void getUpdatesPage(UpdateServiceOuterClass.GetUpdatesPageRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesPageResponse> responseObserver)
       Read a page of ledger's filtered updates. It returns the event types in accordance with
 the specified contents and filters.
 Additionally, the selection criteria for individual events depends on the transaction shape chosen.
 - ACS delta: an event is included only if the requesting party is a stakeholder.
 - ledger effects: an event is included if the requesting party is a witness.