final case class GenTransactionTree extends MerkleTreeInnerNode[GenTransactionTree] with Product with Serializable

A DAML transaction, decomposed into views (cf. ViewDecomposition) and embedded in a Merkle tree. Merkle tree nodes may or may not be blinded. This class is also used to represent transaction view trees and informee trees.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenTransactionTree
  2. MerkleTreeInnerNode
  3. MerkleTree
  4. PrettyPrinting
  5. PrettyUtil
  6. ShowUtil
  7. ShowSyntax
  8. ToShowOps
  9. Serializable
  10. Product
  11. Equals
  12. AnyRef
  13. 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:

    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. lazy val allTransactionViewTrees: Seq[FullTransactionViewTree]

    Returns subviews in pre-order so, in the end, the tree is in pre-order.

  6. def allTransactionViewTreesWithRecipients(topologySnapshot: TopologySnapshot)(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, InvalidWitnesses, Seq[ViewWithWitnessesAndRecipients]]

    All lightweight transaction trees in this GenTransactionTree, accompanied by their recipients tree that will serve to group session keys to encrypt view messages.

    All lightweight transaction trees in this GenTransactionTree, accompanied by their recipients tree that will serve to group session keys to encrypt view messages.

    The lightweight transaction + BCC scheme requires that each parent view contains the randomness for all its direct children, allowing it to derive the encryption key and subsequently decrypt those views. By default, the randomness is reused if views share the same recipients tree, and this information is stored in a temporary cache to be used in multiple transactions.

    The caller should ensure that the provided randomness is long enough to be used for the default HMAC implementation.

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

    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[GenTransactionTree]
    Definition Classes
    MerkleTree
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  11. val commonMetadata: MerkleTree[CommonMetadata]
  12. 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
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. lazy val hasAllLeavesBlinded: Boolean
    Definition Classes
    MerkleTree
  16. val hashOps: HashOps
    Definition Classes
    MerkleTreeInnerNode
  17. 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
  18. def isBlinded: Boolean
    Definition Classes
    MerkleTree
  19. lazy val isFullyUnblinded: Boolean
    Definition Classes
    MerkleTree
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def mapUnblindedRootViews(f: (TransactionView) => TransactionView): GenTransactionTree
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  25. 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
  26. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  27. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  28. 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
  29. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  30. 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
  31. val participantMetadata: MerkleTree[ParticipantMetadata]
  32. def pretty: Pretty[GenTransactionTree]

    Indicates how to pretty print this instance.

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

    Attributes
    protected
    Definition Classes
    GenTransactionTreePrettyPrinting
  33. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  34. 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
  35. 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
  36. def prettyOfClassWithName[T](name: String)(getParamTrees: (T) => Option[Tree]*): Pretty[T]

    Like prettyOfClass, except takes an explicit name for the class.

    Like prettyOfClass, except takes an explicit name for the class.

    Definition Classes
    PrettyUtil
  37. 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
  38. 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
  39. 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
  40. def productElementNames: Iterator[String]
    Definition Classes
    Product
  41. lazy val rootHash: RootHash
    Definition Classes
    MerkleTreeInnerNodeMerkleTree
  42. val rootViews: MerkleSeq[TransactionView]
  43. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  44. 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
  45. val submitterMetadata: MerkleTree[SubmitterMetadata]
  46. def subtrees: Seq[MerkleTree[_]]
    Definition Classes
    GenTransactionTreeMerkleTree
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toProtoV30: protocol.v30.GenTransactionTree
  49. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  50. 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
  51. lazy val transactionId: TransactionId
  52. def transactionViewTree(viewHash: RootHash): FullTransactionViewTree

    Yields the transaction view tree corresponding to a given view.

    Yields the transaction view tree corresponding to a given view. If some subtrees have already been blinded, they will remain blinded.

    Exceptions thrown

    java.lang.IllegalArgumentException if there is no transaction view in this tree with viewHash

  53. def tryFullInformeeTree(protocolVersion: ProtocolVersion): FullInformeeTree

    Yields the full informee tree corresponding to this transaction tree.

    Yields the full informee tree corresponding to this transaction tree. The resulting informee tree is full, only if every view common data is unblinded.

  54. def tryUnwrap: GenTransactionTree

    Yields this instance with type A

    Yields this instance with type A

    Definition Classes
    MerkleTree
    Exceptions thrown

    java.lang.UnsupportedOperationException if this is blinded

  55. 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
  56. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  57. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  58. def unwrap: Either[RootHash, GenTransactionTree]

    returns

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

    Definition Classes
    MerkleTreeInnerNodeMerkleTree
  59. def validated: Either[String, GenTransactionTree.this.type]
  60. def viewPosition(viewHash: RootHash): Option[ViewPosition]

    Finds the position of the view corresponding to the given hash.

    Finds the position of the view corresponding to the given hash. Returns None if no such view exists in this tree.

  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  63. 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

    (Since version 9)

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