sealed abstract class TransferOutView extends MerkleTreeLeaf[TransferOutView] with HasProtocolVersionedWrapper[TransferOutView] with ProtocolVersionedMemoizedEvidence

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransferOutView
  2. ProtocolVersionedMemoizedEvidence
  3. HasCryptographicEvidence
  4. HasProtocolVersionedWrapper
  5. HasRepresentativeProtocolVersion
  6. MerkleTreeLeaf
  7. MerkleTree
  8. PrettyPrinting
  9. PrettyUtil
  10. ShowUtil
  11. ShowSyntax
  12. ToShowOps
  13. Serializable
  14. Product
  15. Equals
  16. AnyRef
  17. 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

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def contractId: LfContractId

    The id of the contract to be transferred.

  3. abstract def deserializedFrom: Option[ByteString]

    Returns the com.google.protobuf.ByteString from which this object has been deserialized, if any.

    Returns the com.google.protobuf.ByteString from which this object has been deserialized, if any. If defined, getCryptographicEvidence will use this as the serialization.

    Definition Classes
    ProtocolVersionedMemoizedEvidence
  4. abstract def pretty: Pretty[TransferOutView.this.type]

    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[logging.pretty]
    Definition Classes
    PrettyPrinting
  5. abstract def productArity: Int
    Definition Classes
    Product
  6. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  7. abstract def representativeProtocolVersion: RepresentativeProtocolVersion[companionObj.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
    HasRepresentativeProtocolVersion
  8. abstract def salt: Salt

    The salt used to blind the Merkle hash.

    The salt used to blind the Merkle hash.

    Definition Classes
    TransferOutViewMerkleTreeLeaf
  9. abstract def submitterMetadata: TransferSubmitterMetadata
  10. abstract def targetDomain: TargetDomainId

    The domain to which the contract is transferred.

  11. abstract def targetProtocolVersion: TargetProtocolVersion
  12. abstract def targetTimeProof: TimeProof

    The sequenced event from the target domain whose timestamp defines the baseline for measuring time periods on the target domain

  13. abstract def templateId: LfTemplateId

    The template of the contract to be transferred.

    The template of the contract to be transferred. This is a dummy value until protocol version 4.

  14. abstract def toProtoV0: protocol.v0.TransferOutView
    Attributes
    protected
  15. abstract def toProtoV1: protocol.v1.TransferOutView
    Attributes
    protected
  16. abstract def toProtoV2: protocol.v2.TransferOutView
    Attributes
    protected
  17. abstract def transferCounterO: TransferCounterO

    The com.digitalasset.canton.TransferCounter of the contract.

    The com.digitalasset.canton.TransferCounter of the contract. The value is defined iff the protocol versions is at least com.digitalasset.canton.version.ProtocolVersion.CNTestNet.

Concrete 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. val applicationId: LedgerApplicationId
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def blind(blindingPolicy: PartialFunction[MerkleTree[_], BlindingCommand]): MerkleTree[TransferOutView]

    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

  8. lazy val blindFully: MerkleTree[TransferOutView]
    Definition Classes
    MerkleTree
  9. 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()
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val commandId: LedgerCommandId
  12. lazy val companionObj: TransferOutView.type
    Attributes
    protected
    Definition Classes
    TransferOutViewHasProtocolVersionedWrapperHasRepresentativeProtocolVersion
    Annotations
    @transient()
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final lazy val getCryptographicEvidence: ByteString

    Returns the serialization of the object into a com.google.protobuf.ByteString.

    Returns the serialization of the object into a com.google.protobuf.ByteString. In particular, every instance i of this trait must equal fromByteString(i.toByteString).

    This method must yield the same result if it is invoked several times.

    Definition Classes
    ProtocolVersionedMemoizedEvidenceHasCryptographicEvidence
  18. lazy val hasAllLeavesBlinded: Boolean
    Definition Classes
    MerkleTree
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val hashOps: HashOps
    Definition Classes
    MerkleTreeLeaf
  21. def hashPurpose: HashPurpose

    The HashPurpose to be used for computing the root hash.

    The HashPurpose to be used for computing the root hash. Must uniquely identify the type of this instance. Must be different from HashPurpose.MerkleTreeInnerNode.

    Definition Classes
    TransferOutViewMerkleTreeLeaf
    See also

    com.digitalasset.canton.crypto.HashBuilder

  22. 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
  23. def isBlinded: Boolean
    Definition Classes
    MerkleTree
  24. def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
    Definition Classes
    HasProtocolVersionedWrapper
  25. lazy val isFullyUnblinded: Boolean
    Definition Classes
    MerkleTree
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. 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
  31. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  32. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  33. 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
  34. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  35. 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
  36. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  37. 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
  38. 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
  39. 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
  40. 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
  41. 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
  42. def productElementName(n: Int): String
    Definition Classes
    Product
  43. def productElementNames: Iterator[String]
    Definition Classes
    Product
  44. def productIterator: Iterator[Any]
    Definition Classes
    Product
  45. def productPrefix: 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. lazy val rootHash: RootHash
    Definition Classes
    MerkleTreeLeafMerkleTree
  48. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  49. 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
  50. val submissionId: Option[LedgerSubmissionId]
  51. val submitter: LfPartyId
  52. val submittingParticipant: LedgerParticipantId
  53. def subtrees: Seq[MerkleTree[_]]
    Definition Classes
    MerkleTreeLeafMerkleTree
  54. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55. 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
  56. 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
  57. def toByteStringUnmemoized: ByteString

    Computes the serialization of the object as a com.google.protobuf.ByteString.

    Computes the serialization of the object as a com.google.protobuf.ByteString.

    Must meet the contract of getCryptographicEvidence except that when called several times, different com.google.protobuf.ByteStrings may be returned.

    Attributes
    protected[this]
    Definition Classes
    TransferOutViewProtocolVersionedMemoizedEvidence
  58. def toProtoVersioned: VersionedMessage[TransferOutView]

    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
  59. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  60. 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
  61. def tryUnwrap: TransferOutView

    Yields this instance with type A

    Yields this instance with type A

    Definition Classes
    MerkleTree
    Exceptions thrown

    java.lang.UnsupportedOperationException if this is blinded

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

    returns

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

    Definition Classes
    MerkleTreeLeafMerkleTree
  66. 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
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. val workflowId: Option[LfWorkflowId]
  71. 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.parseDelimitedFrom 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
  72. 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
    Deprecated

Inherited from MerkleTree[TransferOutView]

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