case class TransactionView extends MerkleTreeInnerNode[TransactionView] with HasProtocolVersionedWrapper[TransactionView] with HasLoggerName with Product with Serializable

Encapsulates a subaction of the underlying transaction.

Exceptions thrown

TransactionView$.InvalidView if the viewCommonData is unblinded and equals the viewCommonData of a direct subview

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransactionView
  2. HasLoggerName
  3. HasProtocolVersionedWrapper
  4. HasRepresentativeProtocolVersion
  5. MerkleTreeInnerNode
  6. MerkleTree
  7. PrettyPrinting
  8. PrettyUtil
  9. ShowUtil
  10. ShowSyntax
  11. ToShowOps
  12. Serializable
  13. Product
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 activeLedgerState(implicit loggingContext: NamedLoggingContext): ActiveLedgerState[Unit]

    The com.daml.lf.transaction.ContractStateMachine.ActiveLedgerState the com.daml.lf.transaction.ContractStateMachine reaches after interpreting the root action of the view.

  5. 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
  6. def allSubviewsWithPosition(rootPos: MerklePathElement): Seq[(TransactionView, ViewPosition)]

    Yields all (direct and indirect) subviews of this view in pre-order, along with the subview position under the root view position rootPos.

    Yields all (direct and indirect) subviews of this view in pre-order, along with the subview position under the root view position rootPos. The first element is this view.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final def blind(blindingPolicy: PartialFunction[MerkleTree[_], BlindingCommand]): MerkleTree[TransactionView]

    Blinds this Merkle tree according to the commands given by blindingStatus.

    Blinds this Merkle tree according to the commands given by blindingStatus. Traverses this tree in pre-order.

    blindingPolicy

    assigns blinding commands to subtrees

    Definition Classes
    MerkleTree
    Exceptions thrown

    java.lang.IllegalArgumentException if blindingPolicy does not assign a blinding command to some subtree and all ancestors of subtree have the blinding command RevealIfNeedBe

  9. lazy val blindFully: MerkleTree[TransactionView]
    Definition Classes
    MerkleTree
  10. def castRepresentativeProtocolVersion[V, T <: HasSupportedProtoVersions[V]](target: T): Either[String, RepresentativeProtocolVersion[V]]

    Casts this instance's representative protocol version to one for the target type.

    Casts this instance's representative protocol version to one for the target type. This only succeeds if the versioning schemes are the same.

    Definition Classes
    HasProtocolVersionedWrapper
    Annotations
    @SuppressWarnings()
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. val companionObj: HasProtocolVersionedWrapperCompanion[TransactionView]
  13. def consumed(implicit loggingContext: NamedLoggingContext): Map[LfContractId, Unit]
  14. def createdContracts(implicit loggingContext: NamedLoggingContext): Map[LfContractId, CreatedContractInView]

    The contracts appearing in create nodes in the view (including subviews).

    The contracts appearing in create nodes in the view (including subviews).

    Exceptions thrown

    java.lang.IllegalStateException if the ViewParticipantData of this view or any subview is blinded

  15. 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
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. implicit def errorLoggingContextFromNamedLoggingContext(implicit loggingContext: NamedLoggingContext): ErrorLoggingContext

    Convert a com.digitalasset.canton.logging.NamedLoggingContext into an com.digitalasset.canton.logging.ErrorLoggingContext to fix the logger name to the current class name.

    Convert a com.digitalasset.canton.logging.NamedLoggingContext into an com.digitalasset.canton.logging.ErrorLoggingContext to fix the logger name to the current class name.

    Attributes
    protected
    Definition Classes
    HasLoggerName
  18. def flatten: Seq[TransactionView]

    Yields all (direct and indirect) subviews of this view in pre-order.

    Yields all (direct and indirect) subviews of this view in pre-order. The first element is this view.

  19. def foldLeft[A](z: A)(f: (A, TransactionView) => A): A

    Traverses all unblinded subviews v1, v2, v3, ... in pre-order and yields f(...f(f(z, v1), v2)..., vn)

  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def globalKeyInputs(implicit loggingContext: NamedLoggingContext): Map[LfGlobalKey, KeyResolutionWithMaintainers]

    The global key inputs that the com.daml.lf.transaction.ContractStateMachine computes while interpreting the root action of the view, enriched with the maintainers of the key and the com.digitalasset.canton.protocol.LfTransactionVersion to be used for serializing the key.

    The global key inputs that the com.daml.lf.transaction.ContractStateMachine computes while interpreting the root action of the view, enriched with the maintainers of the key and the com.digitalasset.canton.protocol.LfTransactionVersion to be used for serializing the key.

    Exceptions thrown

    java.lang.IllegalStateException if the ViewParticipantData of this view or any subview is blinded

    java.lang.UnsupportedOperationException if the protocol version is below com.digitalasset.canton.version.ProtocolVersion.v3

  22. lazy val hasAllLeavesBlinded: Boolean
    Definition Classes
    MerkleTree
  23. val hashOps: HashOps
    Definition Classes
    MerkleTreeInnerNode
  24. def inputContracts(implicit loggingContext: NamedLoggingContext): Map[LfContractId, InputContract]

    The input contracts of the view (including subviews).

    The input contracts of the view (including subviews).

    Exceptions thrown

    java.lang.IllegalStateException if the ViewParticipantData of this view or any subview is blinded

  25. def isBlinded: Boolean
    Definition Classes
    MerkleTree
  26. def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
    Definition Classes
    HasProtocolVersionedWrapper
  27. lazy val isFullyUnblinded: Boolean
    Definition Classes
    MerkleTree
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. implicit def loggerNameFromThisClass: LoggerNameFromClass
    Attributes
    protected
    Definition Classes
    HasLoggerName
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. 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
  34. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  35. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  36. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  37. 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
  38. def pretty: Pretty[TransactionView]

    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
    TransactionViewPrettyPrinting
  39. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  40. 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
  41. 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
  42. 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
  43. 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
  44. 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
  45. def productElementNames: Iterator[String]
    Definition Classes
    Product
  46. def protoVersion: ProtoVersion

    Yields the Proto version that this class will be serialized to

    Yields the Proto version that this class will be serialized to

    Definition Classes
    HasProtocolVersionedWrapper
  47. def replace(h: ViewHash, v: TransactionView): TransactionView

    If the view with the given hash appears either as this view or one of its unblinded descendants, replace it by the given view.

    If the view with the given hash appears either as this view or one of its unblinded descendants, replace it by the given view. TODO(M40): not stack safe unless we have limits on the depths of views.

  48. val representativeProtocolVersion: RepresentativeProtocolVersion[TransactionView]

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions.

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions. The representative is one instance of this list, usually the smallest value. In other words, the Proto versions induce an equivalence relation on the list of protocol version, thus use of representative.

    The method protocolVersionRepresentativeFor below allows to query the representative for an equivalence class.

    Definition Classes
    TransactionViewHasProtocolVersionedWrapperHasRepresentativeProtocolVersion
  49. lazy val rootHash: RootHash
    Definition Classes
    MerkleTreeInnerNodeMerkleTree
  50. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  51. 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
  52. def subtrees: Seq[MerkleTree[_]]
    Definition Classes
    TransactionViewMerkleTree
  53. def subviewHashesConsistentWith(subviewHashes: Seq[ViewHash]): Boolean
  54. val subviews: TransactionSubviews
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. def toByteArray: Array[Byte]

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapper
  57. def toByteString: ByteString

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapper
  58. def toProtoV0: ViewNode
    Attributes
    protected
  59. def toProtoV1: ViewNode
    Attributes
    protected
  60. def toProtoVersioned: VersionedMessage[TransactionView]

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).

    Be aware that if calling on a class that defines a LegacyProtoConverter, this method will still return a VersionedMessage. If the current protocol version maps to the legacy converter, deserialization will then fail (as it will try to deserialize to the raw protobuf instead of the VersionedMessage wrapper this was serialized to. Prefer using toByteString which handles this use case correctly.

    Definition Classes
    HasProtocolVersionedWrapper
  61. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  62. 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
  63. def tryUnblindViewParticipantData(fieldName: String)(implicit loggingContext: NamedLoggingContext): ViewParticipantData
  64. def tryUnwrap: TransactionView

    Yields this instance with type A

    Yields this instance with type A

    Definition Classes
    MerkleTree
    Exceptions thrown

    java.lang.UnsupportedOperationException if this is blinded

  65. 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
  66. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  67. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  68. def unwrap: Either[RootHash, TransactionView]

    returns

    Left(hash), if this is a blinded tree and Right(tree) otherwise.

    Definition Classes
    MerkleTreeInnerNodeMerkleTree
  69. def updatedKeyValues(implicit loggingContext: NamedLoggingContext): Map[LfGlobalKey, KeyMapping]

    The keys that this view updates (including reassigning the key), along with the assignment of that key at the end of the transaction.

    The keys that this view updates (including reassigning the key), along with the assignment of that key at the end of the transaction.

    Must only be used in mode com.daml.lf.transaction.ContractKeyUniquenessMode.Strict

    Exceptions thrown

    java.lang.IllegalStateException if the ViewParticipantData of this view or any subview is blinded.

    java.lang.UnsupportedOperationException if the protocol version is below com.digitalasset.canton.version.ProtocolVersion.v3

  70. def updatedKeys(implicit loggingContext: NamedLoggingContext): Map[LfGlobalKey, Set[LfPartyId]]

    The keys that this view updates (including reassigning the key), along with the maintainers of the key.

    The keys that this view updates (including reassigning the key), along with the maintainers of the key.

    Must only be used in mode com.daml.lf.transaction.ContractKeyUniquenessMode.Strict

    Exceptions thrown

    java.lang.IllegalStateException if the ViewParticipantData of this view or any subview is blinded.

    java.lang.UnsupportedOperationException if the protocol version is below com.digitalasset.canton.version.ProtocolVersion.v3

  71. val viewCommonData: MerkleTree[ViewCommonData]
  72. val viewHash: ViewHash
  73. val viewParticipantData: MerkleTree[ViewParticipantData]
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  76. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  77. def writeToFile(outputFile: String): Unit
    Definition Classes
    HasProtocolVersionedWrapper

Deprecated Value Members

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

Inherited from HasLoggerName

Inherited from MerkleTree[TransactionView]

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