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 v2

    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 v2.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 v2.ReadService interface contains the one method v2.ReadService.stateUpdates to read the state of a ledger participant. It represents the participant state as a stream of v2.Updates to an initial participant state. The typical consumer of this method is a class that subscribes to this stream of v2.Updates and reconstructs (a view of) the actual participant state. See the comments on v2.Update and v2.ReadService.stateUpdates for details about the kind of updates and the guarantees given to consumers of the stream of v2.Updates.

    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.v2 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
  • object Update extends Serializable
    Definition Classes
    v2
  • CommandRejected
  • ConfigurationChangeRejected
  • ConfigurationChanged
  • PartyAddedToParticipant
  • PartyAllocationRejected
  • PublicPackageUpload
  • PublicPackageUploadRejected
  • TransactionAccepted

final case class TransactionAccepted(optCompletionInfo: Option[CompletionInfo], transactionMeta: TransactionMeta, transaction: CommittedTransaction, transactionId: TransactionId, recordTime: Timestamp, divulgedContracts: List[DivulgedContract], blindingInfo: Option[BlindingInfo]) extends Update with Product with Serializable

Signal the acceptance of a transaction.

optCompletionInfo

The information provided by the submitter of the command that created this transaction. It must be provided if this participant hosts one of the SubmitterInfo.actAs parties and shall output a completion event for this transaction. This in particular applies if this participant has submitted the command to the WriteService. The ReadService implementation must ensure that command deduplication guarantees are met.

transactionMeta

The metadata of the transaction that was provided by the submitter. It is visible to all parties that can see the transaction.

transaction

The view of the transaction that was accepted. This view must include at least the projection of the accepted transaction to the set of all parties hosted at this participant. See https://docs.daml.com/concepts/ledger-model/ledger-privacy.html on how these views are computed. Note that ledgers with weaker privacy models can decide to forgo projections of transactions and always show the complete transaction.

recordTime

The ledger-provided timestamp at which the transaction was recorded. The last Configuration set before this TransactionAccepted determines how this transaction's recordTime relates to its TransactionMeta.ledgerEffectiveTime.

divulgedContracts

List of divulged contracts. See DivulgedContract for details.

Linear Supertypes
Update, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransactionAccepted
  2. Update
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TransactionAccepted(optCompletionInfo: Option[CompletionInfo], transactionMeta: TransactionMeta, transaction: CommittedTransaction, transactionId: TransactionId, recordTime: Timestamp, divulgedContracts: List[DivulgedContract], blindingInfo: Option[BlindingInfo])

    optCompletionInfo

    The information provided by the submitter of the command that created this transaction. It must be provided if this participant hosts one of the SubmitterInfo.actAs parties and shall output a completion event for this transaction. This in particular applies if this participant has submitted the command to the WriteService. The ReadService implementation must ensure that command deduplication guarantees are met.

    transactionMeta

    The metadata of the transaction that was provided by the submitter. It is visible to all parties that can see the transaction.

    transaction

    The view of the transaction that was accepted. This view must include at least the projection of the accepted transaction to the set of all parties hosted at this participant. See https://docs.daml.com/concepts/ledger-model/ledger-privacy.html on how these views are computed. Note that ledgers with weaker privacy models can decide to forgo projections of transactions and always show the complete transaction.

    recordTime

    The ledger-provided timestamp at which the transaction was recorded. The last Configuration set before this TransactionAccepted determines how this transaction's recordTime relates to its TransactionMeta.ledgerEffectiveTime.

    divulgedContracts

    List of divulged contracts. See DivulgedContract for details.

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. val blindingInfo: Option[BlindingInfo]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def description: String

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

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

    Definition Classes
    TransactionAccepted → Update
  8. val divulgedContracts: List[DivulgedContract]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  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() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. val optCompletionInfo: Option[CompletionInfo]
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val recordTime: Timestamp

    The record time at which the state change was committed.

    The record time at which the state change was committed.

    Definition Classes
    TransactionAccepted → Update
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. val transaction: CommittedTransaction
  20. val transactionId: TransactionId
  21. val transactionMeta: TransactionMeta
  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()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Update

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped