sealed abstract case class AcsCommitment extends HasProtocolVersionedWrapper[AcsCommitment] with SignedProtocolMessageContent with NoCopy with Product with Serializable
A commitment to the active contract set (ACS) that is shared between two participants on a given domain at a given time.
Given a commitment scheme to the ACS, the semantics are as follows: the sender declares that the shared ACS was exactly the one committed to, at every commitment tick during the specified period and as determined by the period's interval.
The interval is assumed to be a round number of seconds. The ticks then start at the Java EPOCH time, and are exactly interval apart.
- Alphabetic
- By Inheritance
- AcsCommitment
- NoCopy
- SignedProtocolMessageContent
- Serializable
- Product
- Equals
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- HasDomainId
- ProtocolVersionedMemoizedEvidence
- HasCryptographicEvidence
- HasProtocolVersionedWrapper
- HasRepresentativeProtocolVersion
- 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() @HotSpotIntrinsicCandidate()
- val commitment: CommitmentType
- lazy val companionObj: AcsCommitment.type
- Attributes
- protected
- Definition Classes
- AcsCommitment → HasProtocolVersionedWrapper → HasRepresentativeProtocolVersion
- Annotations
- @transient()
- def copy(nothing: Nothing): Nothing
- Attributes
- protected
- Definition Classes
- NoCopy
- val counterParticipant: ParticipantId
- 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
- val 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
- AcsCommitment → ProtocolVersionedMemoizedEvidence
- val domainId: DomainId
- Definition Classes
- AcsCommitment → HasDomainId
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
iof this trait must equalfromByteString(i.toByteString).This method must yield the same result if it is invoked several times.
- Definition Classes
- ProtocolVersionedMemoizedEvidence → HasCryptographicEvidence
- def hashPurpose: HashPurpose
Hash purpose that uniquely identifies the type of message content to be signed.
Hash purpose that uniquely identifies the type of message content to be signed.
- Definition Classes
- AcsCommitment → SignedProtocolMessageContent
- 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 isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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 period: CommitmentPeriod
- lazy val pretty: Pretty[AcsCommitment]
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
- AcsCommitment → SignedProtocolMessageContent → 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
- val representativeProtocolVersion: RepresentativeProtocolVersion[AcsCommitment.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
- AcsCommitment → HasRepresentativeProtocolVersion
- val sender: ParticipantId
- 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 signingTimestamp: CantonTimestamp
The timestamp of the com.digitalasset.canton.crypto.SyncCryptoApi used for signing this message.
The timestamp of the com.digitalasset.canton.crypto.SyncCryptoApi used for signing this message.
- Definition Classes
- AcsCommitment → SignedProtocolMessageContent
- 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
- 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
- AcsCommitment → ProtocolVersionedMemoizedEvidence
- def toProtoSomeSignedProtocolMessage: SomeSignedProtocolMessage
Converts this object into a com.google.protobuf.ByteString using com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence.getCryptographicEvidence and wraps the result in the appropriate com.digitalasset.canton.protocol.v0.SignedProtocolMessage.SomeSignedProtocolMessage constructor.
Converts this object into a com.google.protobuf.ByteString using com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence.getCryptographicEvidence and wraps the result in the appropriate com.digitalasset.canton.protocol.v0.SignedProtocolMessage.SomeSignedProtocolMessage constructor.
- Attributes
- protected[messages]
- Definition Classes
- AcsCommitment → SignedProtocolMessageContent
- def toProtoTypedSomeSignedProtocolMessage: SomeSignedProtocolMessage
Converts this object into a com.google.protobuf.ByteString using com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence.getCryptographicEvidence and wraps the result in the appropriate com.digitalasset.canton.protocol.v0.TypedSignedProtocolMessageContent.SomeSignedProtocolMessage constructor.
Converts this object into a com.google.protobuf.ByteString using com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence.getCryptographicEvidence and wraps the result in the appropriate com.digitalasset.canton.protocol.v0.TypedSignedProtocolMessageContent.SomeSignedProtocolMessage constructor.
- Attributes
- protected[messages]
- Definition Classes
- AcsCommitment → SignedProtocolMessageContent
- def toProtoV0: v0.AcsCommitment
- Attributes
- protected
- def toProtoVersioned: VersionedMessage[AcsCommitment]
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
- 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.defaultValueshold.Will check that default value rules defined in
companionObj.defaultValueshold.- Definition Classes
- HasProtocolVersionedWrapper
- 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.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
- def writeToFile(outputFile: String): Unit
- Definition Classes
- HasProtocolVersionedWrapper