Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package daml
    Definition Classes
    com
  • package ledger
    Definition Classes
    daml
  • package participant
    Definition Classes
    ledger
  • package state
    Definition Classes
    participant
  • package v1

    Interfaces to read from and write to an (abstract) participant state.

    Interfaces to read from and write to an (abstract) participant state.

    A Daml ledger participant is code that allows to actively participate in the evolution of a shared Daml ledger. Each such participant maintains a particular view onto the state of the Daml ledger. We call this view the participant state.

    Actual implementations of a Daml ledger participant will likely maintain more state than what is exposed through the interfaces in this package, which is why we talk about an abstract participant state. It abstracts over the different implementations of Daml ledger participants.

    The interfaces are optimized for easy implementation. The v1.WriteService interface contains the methods for changing the participant state (and potentially the state of the Daml ledger), which all ledger participants must support. These methods are for example exposed via the Daml Ledger API. Actual ledger participant implementations likely support more implementation-specific methods. They are however not exposed via the Daml Ledger API. The v1.ReadService interface contains the one method v1.ReadService.stateUpdates to read the state of a ledger participant. It represents the participant state as a stream of v1.Updates to an initial participant state. The typical consumer of this method is a class that subscribes to this stream of v1.Updates and reconstructs (a view of) the actual participant state. See the comments on v1.Update and v1.ReadService.stateUpdates for details about the kind of updates and the guarantees given to consumers of the stream of v1.Updates.

    We provide a reference implementation of a participant state in com.daml.ledger.on.memory.InMemoryLedgerReaderWriter. There we model an in-memory ledger, which has by construction a single participant, which hosts all parties. See its comments for details on how that is done, and how its implementation can be used as a blueprint for implementing your own participant state.

    We do expect the interfaces provided in com.daml.ledger.participant.state to evolve, which is why we provide them all in the com.daml.ledger.participant.state.v1 package. Where possible we will evolve them in a backwards compatible fashion, so that a simple recompile suffices to upgrade to a new version. Where that is not possible, we plan to introduce new version of this API in a separate package and maintain it side-by-side with the existing version if possible. There can therefore potentially be multiple versions of participant state APIs at the same time. We plan to deprecate and drop old versions on separate and appropriate timelines.

    Definition Classes
    state
  • DivulgedContract
  • PruningResult
  • ReadService
  • RejectionReason
  • RejectionReasonV0
  • SubmissionResult
  • SubmitterInfo
  • TransactionMeta
  • Update
  • Version
  • WriteConfigService
  • WritePackagesService
  • WriteParticipantPruningService
  • WritePartyService
  • WriteService

sealed trait Update extends Product with Serializable

An update to the (abstract) participant state.

Update's are used in ReadService.stateUpdates to communicate changes to abstract participant state to consumers. We describe

We describe the possible updates in the comments of each of the case classes implementing Update.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Known Subclasses
CommandRejected, ConfigurationChangeRejected, ConfigurationChanged, PartyAddedToParticipant, PartyAllocationRejected, PublicPackageUpload, PublicPackageUploadRejected, TransactionAccepted
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Update
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def description: String

    Short human-readable one-line description summarizing the state updates content.

  3. abstract def productArity: Int
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  5. abstract def recordTime: Timestamp

    The record time at which the state change was committed.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def productElementName(n: Int): String
    Definition Classes
    Product
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. def productIterator: Iterator[Any]
    Definition Classes
    Product
  18. def productPrefix: String
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped