sealed abstract class LightTransactionViewTree extends TransactionViewTree with HasProtocolVersionedWrapper[LightTransactionViewTree] with PrettyPrinting
Wraps a GenTransactionTree
where exactly one view (not including subviews) is unblinded.
The commonMetadata
and participantMetadata
are also unblinded.
The submitterMetadata
is unblinded if and only if the unblinded view is a root view.
- Exceptions thrown
LightTransactionViewTree$.InvalidLightTransactionViewTree
if tree is not a light transaction view tree (i.e. the wrong set of nodes is blinded)
- Alphabetic
- By Inheritance
- LightTransactionViewTree
- HasProtocolVersionedWrapper
- HasToByteString
- HasRepresentativeProtocolVersion
- TransactionViewTree
- ViewTree
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- 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 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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: LightTransactionViewTree.type
- Attributes
- protected
- Definition Classes
- LightTransactionViewTree → HasProtocolVersionedWrapper → HasRepresentativeProtocolVersion
- Annotations
- @transient()
- def confirmationPolicy: ConfirmationPolicy
- Definition Classes
- TransactionViewTree
- 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
- def domainId: DomainId
The domain to which the com.digitalasset.canton.protocol.messages.EncryptedViewMessage should be sent to
The domain to which the com.digitalasset.canton.protocol.messages.EncryptedViewMessage should be sent to
- Definition Classes
- TransactionViewTree → ViewTree
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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
- lazy val informees: Set[LfPartyId]
The informees of the view in the tree
The informees of the view in the tree
- Definition Classes
- TransactionViewTree → ViewTree
- def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isSmallerOrEqualThan(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- lazy val isTopLevel: Boolean
Determines whether
view
is top-level.Determines whether
view
is top-level.- Definition Classes
- TransactionViewTree
- lazy val ledgerTime: CantonTimestamp
- Definition Classes
- TransactionViewTree
- def mediator: MediatorRef
The mediator that is responsible for coordinating this request
The mediator that is responsible for coordinating this request
- Definition Classes
- TransactionViewTree → ViewTree
- 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
- lazy val pretty: Pretty[LightTransactionViewTree]
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
- LightTransactionViewTree → ViewTree → 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 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
- val representativeProtocolVersion: RepresentativeProtocolVersion[LightTransactionViewTree.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
protocolVersionRepresentativeFor
below allows to query the representative for an equivalence class.- Definition Classes
- LightTransactionViewTree → HasRepresentativeProtocolVersion
- def rootHash: RootHash
The root hash of the view tree.
The root hash of the view tree.
Two view trees with the same rootHash must also have the same domainId and mediator (except for hash collisions).
- Definition Classes
- TransactionViewTree → ViewTree
- 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
- lazy val submissionTime: CantonTimestamp
- Definition Classes
- TransactionViewTree
- val submitterMetadataO: Option[SubmitterMetadata]
- Definition Classes
- TransactionViewTree
- def subviewHashes: Seq[ViewHash]
Returns the hashes of the direct subviews of the view represented by this tree.
Returns the hashes of the direct subviews of the view represented by this tree. By definition, all subviews are unblinded, therefore this will also work when the subviews are stored in a MerkleSeq.
- Definition Classes
- TransactionViewTree
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBeSigned: Option[RootHash]
Return the hash whose signature is to be included in the com.digitalasset.canton.protocol.messages.EncryptedViewMessage
Return the hash whose signature is to be included in the com.digitalasset.canton.protocol.messages.EncryptedViewMessage
- Definition Classes
- TransactionViewTree → ViewTree
- 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
- 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 → HasToByteString
- def toProtoV0: protocol.v0.LightTransactionViewTree
- def toProtoV1: protocol.v1.LightTransactionViewTree
- def toProtoVersioned: VersionedMessage[LightTransactionViewTree]
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
- 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
- Definition Classes
- TransactionViewTree
- lazy val transactionUuid: UUID
- Definition Classes
- TransactionViewTree
- val tree: GenTransactionTree
- Definition Classes
- LightTransactionViewTree → TransactionViewTree
- 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 validateInstance(): Either[String, Unit]
Will check that default value rules defined in
companionObj.defaultValues
hold.Will check that default value rules defined in
companionObj.defaultValues
hold.- Definition Classes
- HasProtocolVersionedWrapper
- def validated: Either[String, LightTransactionViewTree.this.type]
- Definition Classes
- LightTransactionViewTree → TransactionViewTree
- lazy val view: TransactionView
The (top-most) unblinded view.
The (top-most) unblinded view.
- Definition Classes
- TransactionViewTree
- lazy val viewHash: ViewHash
The hash of the view
The hash of the view
- Definition Classes
- TransactionViewTree → ViewTree
- lazy val viewParticipantData: ViewParticipantData
- Definition Classes
- TransactionViewTree
- lazy val viewPosition: ViewPosition
- Definition Classes
- TransactionViewTree → ViewTree
- 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])
- lazy val workflowIdO: Option[WorkflowId]
- Definition Classes
- TransactionViewTree
- 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