final 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$.InvalidViewif theviewCommonDatais unblinded and equals theviewCommonDataof a direct subview
- Alphabetic
- By Inheritance
- TransactionView
- HasLoggerName
- HasProtocolVersionedWrapper
- HasToByteString
- HasRepresentativeProtocolVersion
- 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
show"This is a string: ${myString.doubleQuoted}"andshow"This is a hash: ${myHash.readableHash}".Enables syntax like
show"This is a string: ${myString.doubleQuoted}"andshow"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 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.
The com.daml.lf.transaction.ContractStateMachine.ActiveLedgerState the com.daml.lf.transaction.ContractStateMachine reaches after interpreting the root action of the view.
Must only be used in mode com.daml.lf.transaction.ContractKeyUniquenessMode.Strict
- Exceptions thrown
java.lang.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded.
- 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
- def allSubviewsWithPosition(rootPos: ViewPosition): 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. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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.IllegalArgumentExceptionifblindingPolicydoes not assign a blinding command to some subtree and all ancestors of subtree have the blinding commandRevealIfNeedBe
- lazy val blindFully: MerkleTree[TransactionView]
- Definition Classes
- MerkleTree
- def castRepresentativeProtocolVersion[T <: HasSupportedProtoVersions[_]](target: T): Either[String, RepresentativeProtocolVersion[T]]
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()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- lazy val companionObj: TransactionView.type
- Attributes
- protected
- Definition Classes
- TransactionView → HasProtocolVersionedWrapper → HasRepresentativeProtocolVersion
- Annotations
- @transient()
- def consumed(implicit loggingContext: NamedLoggingContext): Map[LfContractId, Unit]
- 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.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded
- 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
- 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
- lazy val 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.
- def foldLeft[A](z: A)(f: (A, TransactionView) => A): A
Traverses all unblinded subviews
v1, v2, v3, ...in pre-order and yieldsf(...f(f(z, v1), v2)..., vn) - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded
- 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 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.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded
- def isBlinded: Boolean
- Definition Classes
- MerkleTree
- def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- lazy val isFullyUnblinded: Boolean
- Definition Classes
- MerkleTree
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isSmallerOrEqualThan(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- implicit def loggerNameFromThisClass: LoggerNameFromClass
- Attributes
- protected
- Definition Classes
- HasLoggerName
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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
- def pretty: Pretty[TransactionView]
Indicates how to pretty print this instance.
Indicates how to pretty print this instance. See
PrettyPrintingTestfor examples on how to implement this method.- Definition Classes
- TransactionView → 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 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
- 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
- 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(i12900): not stack safe unless we have limits on the depths of views.
- val representativeProtocolVersion: RepresentativeProtocolVersion[TransactionView.type]
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
protocolVersionRepresentativeForbelow allows to query the representative for an equivalence class.- Definition Classes
- TransactionView → HasRepresentativeProtocolVersion
- lazy val rootHash: RootHash
- Definition Classes
- MerkleTreeInnerNode → MerkleTree
- 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
- def subtrees: Seq[MerkleTree[_]]
- Definition Classes
- TransactionView → MerkleTree
- def subviewHashesConsistentWith(subviewHashes: Seq[ViewHash]): Boolean
- val subviews: TransactionSubviews
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toByteArray: Array[Byte]
Yields a byte array representation of the corresponding
UntypedVersionedMessagewrapper of this instance.Yields a byte array representation of the corresponding
UntypedVersionedMessagewrapper of this instance.- Definition Classes
- HasProtocolVersionedWrapper
- def toByteString: ByteString
Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.- Definition Classes
- HasProtocolVersionedWrapper → HasToByteString
- def toProtoV0: ViewNode
- Attributes
- protected
- def toProtoV1: ViewNode
- Attributes
- protected
- def toProtoVersioned: VersionedMessage[TransactionView]
Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.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
- 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.
Finalto avoid accidental overwriting.- Definition Classes
- PrettyPrinting → AnyRef → Any
- lazy val tryFlattenToParticipantViews: Seq[ParticipantTransactionView]
- def tryUnblindViewParticipantData(fieldName: String)(implicit loggingContext: NamedLoggingContext): ViewParticipantData
- def tryUnwrap: TransactionView
Yields this instance with type
AYields this instance with type
A- Definition Classes
- MerkleTree
- Exceptions thrown
java.lang.UnsupportedOperationExceptionif 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, TransactionView]
- returns
Left(hash), if this is a blinded tree andRight(tree)otherwise.
- Definition Classes
- MerkleTreeInnerNode → MerkleTree
- 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.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded.
- 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.IllegalStateExceptionif the ViewParticipantData of this view or any subview is blinded.
- def validateInstance(): Either[String, Unit]
Will check that default value rules defined in
companionObj.defaultValueshold.Will check that default value rules defined in
companionObj.defaultValueshold.- Definition Classes
- HasProtocolVersionedWrapper
- val viewCommonData: MerkleTree[ViewCommonData]
- val viewHash: ViewHash
- val viewParticipantData: MerkleTree[ViewParticipantData]
- 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])
- def writeDelimitedTo(output: OutputStream): Either[String, Unit]
Serializes this instance to a message together with a delimiter (the message length) to the given output stream.
Serializes this instance to a message together with a delimiter (the message length) to the given output stream.
This method works in conjunction with com.digitalasset.canton.version.HasProtocolVersionedCompanion2.parseDelimitedFromUnsafe which deserializes the message again. It is useful for serializing multiple messages to a single output stream through multiple invocations.
Serialization is only supported for com.digitalasset.canton.version.HasSupportedProtoVersions.VersionedProtoConverter, an error message is returned otherwise.
- output
the sink to which this message is serialized to
- returns
an Either where left represents an error message, and right represents a successful message serialization
- Definition Classes
- HasProtocolVersionedWrapper
- def writeToFile(outputFile: String): Unit
- Definition Classes
- HasProtocolVersionedWrapper