t

com.digitalasset.canton.serialization

HasCryptographicEvidence

trait HasCryptographicEvidence extends HasVersionedToByteString

Trait for deterministically serializing an object to a com.google.protobuf.ByteString.

A class should extend this trait to indicate that the serialize method yields the same ByteString if invoked several times. Typical use cases of this behavior include:

  • Classes that represent a leaf of a Merkle tree.
  • Classes that represent content that is signed e.g. Hash or SignedProtocolMessageContent.
  • Classes that are mere wrappers of ByteString (for convenience of the caller) e.g. AuthenticationToken.

If a class merely represents content that is transmitted over a network, the class does not need to extend this trait.

It is strongly recommended to extend this trait by mixing in ProtocolVersionedMemoizedEvidence or MemoizedEvidenceWithFailure, instead of directly extending this trait.

Classes C implementing HasCryptographicEvidence must define a fromByteString: ByteString => C method in their companion object that converts a serialization back into an equal object. In particular, c.fromByteString(byteString).toByteString must equal byteString.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasCryptographicEvidence
  2. HasVersionedToByteString
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def 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.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toByteString(version: ProtocolVersion): 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. This method may yield different results if it is invoked several times.

    Definition Classes
    HasCryptographicEvidenceHasVersionedToByteString
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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

Inherited from AnyRef

Inherited from Any

Ungrouped