Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package digitalasset
    Definition Classes
    com
  • package canton
    Definition Classes
    digitalasset
  • package ledger
    Definition Classes
    canton
  • 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.digitalasset.canton.ledger.participant.state to evolve, which is why we provide them all in the com.digitalasset.canton.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
  • ReassignmentAccepted
  • TransactionAccepted

final case class TransactionAccepted(completionInfoO: Option[CompletionInfo], transactionMeta: TransactionMeta, transaction: CommittedTransaction, transactionId: TransactionId, recordTime: Timestamp, divulgedContracts: List[DivulgedContract], blindingInfoO: Option[BlindingInfo], hostedWitnesses: List[Party], contractMetadata: Map[ContractId, Bytes]) extends Update with Product with Serializable

Signal the acceptance of a transaction.

completionInfoO

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 com.digitalasset.canton.ledger.configuration.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.

contractMetadata

For each contract created in this transaction, this map may contain contract metadata assigned by the ledger implementation. This data is opaque and can only be used in com.daml.lf.command.DisclosedContracts when submitting transactions trough the WriteService. If a contract created by this transaction is not element of this map, its metadata is equal to the empty byte array.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransactionAccepted
  2. Update
  3. PrettyPrinting
  4. PrettyUtil
  5. ShowUtil
  6. ShowSyntax
  7. ToShowOps
  8. Serializable
  9. Product
  10. Equals
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TransactionAccepted(completionInfoO: Option[CompletionInfo], transactionMeta: TransactionMeta, transaction: CommittedTransaction, transactionId: TransactionId, recordTime: Timestamp, divulgedContracts: List[DivulgedContract], blindingInfoO: Option[BlindingInfo], hostedWitnesses: List[Party], contractMetadata: Map[ContractId, Bytes])

    completionInfoO

    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 com.digitalasset.canton.ledger.configuration.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.

    contractMetadata

    For each contract created in this transaction, this map may contain contract metadata assigned by the ledger implementation. This data is opaque and can only be used in com.daml.lf.command.DisclosedContracts when submitting transactions trough the WriteService. If a contract created by this transaction is not element of this map, its metadata is equal to the empty byte array.

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  9. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val blindingInfoO: Option[BlindingInfo]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val completionInfoO: Option[CompletionInfo]
  9. val contractMetadata: Map[ContractId, Bytes]
  10. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  11. val divulgedContracts: List[DivulgedContract]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. val hostedWitnesses: List[Party]
  15. def indicateOmittedFields[T]: (T) => Option[Tree]

    Use this to indicate that you've omitted fields from pretty printing

    Use this to indicate that you've omitted fields from pretty printing

    Definition Classes
    PrettyUtil
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  21. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  22. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  23. def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree only written if not matching the default value

    A tree only written if not matching the default value

    Definition Classes
    PrettyUtil
  24. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  25. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  26. def pretty: Pretty[TransactionAccepted]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    TransactionAcceptedPrettyPrinting
  27. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  28. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  29. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  30. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  31. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  32. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. 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
    TransactionAcceptedUpdate
  35. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  36. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  39. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  40. val transaction: CommittedTransaction
  41. val transactionId: TransactionId
  42. val transactionMeta: TransactionMeta
  43. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  44. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  45. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. 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
    Deprecated

Inherited from Update

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped