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
  • ChangeId
  • CompletionInfo
  • DivulgedContract
  • PruningResult
  • ReadService
  • SubmissionResult
  • SubmitterInfo
  • TransactionMeta
  • Update
  • WriteConfigService
  • WritePackagesService
  • WriteParticipantPruningService
  • WritePartyService
  • WriteService

final case class SubmitterInfo(actAs: List[Party], readAs: List[Party], applicationId: ApplicationId, commandId: CommandId, deduplicationPeriod: DeduplicationPeriod, submissionId: Option[SubmissionId], ledgerConfiguration: Configuration) extends Product with Serializable

Collects context information for a submission.

Note that this is used for party-originating changes only. They are usually issued via the Ledger API.

actAs

the non-empty set of parties that submitted the change.

readAs

the parties on whose behalf (in addition to all parties listed in actAs) contracts can be retrieved.

applicationId

an identifier for the Daml application that submitted the command. This is used for monitoring, command deduplication, and to allow Daml applications subscribe to their own submissions only.

commandId

a submitter-provided identifier to identify an intended ledger change within all the submissions by the same parties and application.

deduplicationPeriod

The deduplication period for the command submission. Used for the deduplication guarantee described in the ReadService.stateUpdates.

submissionId

An identifier for the submission that allows an application to correlate completions to its submissions.

ledgerConfiguration

The ledger configuration used during interpretation.

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

Instance Constructors

  1. new SubmitterInfo(actAs: List[Party], readAs: List[Party], applicationId: ApplicationId, commandId: CommandId, deduplicationPeriod: DeduplicationPeriod, submissionId: Option[SubmissionId], ledgerConfiguration: Configuration)

    actAs

    the non-empty set of parties that submitted the change.

    readAs

    the parties on whose behalf (in addition to all parties listed in actAs) contracts can be retrieved.

    applicationId

    an identifier for the Daml application that submitted the command. This is used for monitoring, command deduplication, and to allow Daml applications subscribe to their own submissions only.

    commandId

    a submitter-provided identifier to identify an intended ledger change within all the submissions by the same parties and application.

    deduplicationPeriod

    The deduplication period for the command submission. Used for the deduplication guarantee described in the ReadService.stateUpdates.

    submissionId

    An identifier for the submission that allows an application to correlate completions to its submissions.

    ledgerConfiguration

    The ledger configuration used during interpretation.

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. val actAs: List[Party]
  5. val applicationId: ApplicationId
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val changeId: ChangeId

    The ID for the ledger change

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. val commandId: CommandId
  10. val deduplicationPeriod: DeduplicationPeriod
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val ledgerConfiguration: Configuration
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val readAs: List[Party]
  20. val submissionId: Option[SubmissionId]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toCompletionInfo(statistics: Option[TransactionNodeStatistics] = None): CompletionInfo
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped