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.
- Alphabetic
- By Inheritance
- GenTransactionTree
- MerkleTreeInnerNode
- MerkleTree
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}"
.Enables the syntax
show"${myEither.showMerged}"
.- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- 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
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- Instances of
- lazy val allTransactionViewTrees: Seq[FullTransactionViewTree]
Returns subviews in pre-order so, in the end, the tree is in pre-order.
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
ifblindingPolicy
does not assign a blinding command to some subtree and all ancestors of subtree have the blinding commandRevealIfNeedBe
- lazy val blindFully: MerkleTree[GenTransactionTree]
- Definition Classes
- MerkleTree
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val commonMetadata: MerkleTree[CommonMetadata]
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- lazy val hasAllLeavesBlinded: Boolean
- Definition Classes
- MerkleTree
- val hashOps: HashOps
- Definition Classes
- MerkleTreeInnerNode
- 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
- def isBlinded: Boolean
- Definition Classes
- MerkleTree
- lazy val isFullyUnblinded: Boolean
- Definition Classes
- MerkleTree
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapUnblindedRootViews(f: (TransactionView) => TransactionView): GenTransactionTree
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- val participantMetadata: MerkleTree[ParticipantMetadata]
- 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
- GenTransactionTree → PrettyPrinting
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- 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
- 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
- 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
- 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
- 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
- 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
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- lazy val rootHash: RootHash
- Definition Classes
- MerkleTreeInnerNode → MerkleTree
- val rootViews: MerkleSeq[TransactionView]
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- 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
- val submitterMetadata: MerkleTree[SubmitterMetadata]
- def subtrees: Seq[MerkleTree[_]]
- Definition Classes
- GenTransactionTree → MerkleTree
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toProtoV30: protocol.v30.GenTransactionTree
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- 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
- lazy val transactionId: TransactionId
- 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 withviewHash
- 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.
- 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
- 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
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unwrap: Either[RootHash, GenTransactionTree]
- returns
Left(hash)
, if this is a blinded tree andRight(tree)
otherwise.
- Definition Classes
- MerkleTreeInnerNode → MerkleTree
- def validated: Either[String, GenTransactionTree.this.type]
- 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. - final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])