final case class SubmissionRequest extends HasProtocolVersionedWrapper[SubmissionRequest] with ProtocolVersionedMemoizedEvidence with Product with Serializable
- Alphabetic
- By Inheritance
- SubmissionRequest
- Serializable
- Product
- Equals
- ProtocolVersionedMemoizedEvidence
- HasCryptographicEvidence
- HasProtocolVersionedWrapper
- HasToByteString
- HasRepresentativeProtocolVersion
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 aggregationId(hashOps: HashOps): Either[ProtoDeserializationError, Option[AggregationId]]
Returns the AggregationId for grouping if this is an aggregatable submission.
Returns the AggregationId for grouping if this is an aggregatable submission. The aggregation ID computationally authenticates the relevant contents of the submission request, namely,
- Envelope contents com.digitalasset.canton.sequencing.protocol.ClosedEnvelope.bytes, the recipients com.digitalasset.canton.sequencing.protocol.ClosedEnvelope.recipients of the batch, and whether there are signatures.
- The maxSequencingTime
- The topologyTimestamp
- The aggregationRule
The AggregationId does not authenticate the following pieces of a submission request:
- The signatures com.digitalasset.canton.sequencing.protocol.ClosedEnvelope.signatures on the closed envelopes because the signatures differ for each sender. Aggregating the signatures is the whole point of an aggregatable submission. In contrast, the presence of signatures is relevant for the ID because it determines how the com.digitalasset.canton.sequencing.protocol.ClosedEnvelope.bytes are interpreted.
- The sender and the messageId, as they are specific to the sender of a particular submission request
- The isConfirmationRequest flag because it is irrelevant for delivery or aggregation
- val aggregationRule: Option[AggregationRule]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val batch: Batch[ClosedEnvelope]
- def castRepresentativeProtocolVersion[T <: BaseVersioningCompanion[_, _, _, _]](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]) @IntrinsicCandidate() @native()
- lazy val companionObj: SubmissionRequest.type
- Attributes
- protected
- Definition Classes
- SubmissionRequest → HasProtocolVersionedWrapper → HasRepresentativeProtocolVersion
- Annotations
- @transient()
- def copy(sender: Member = this.sender, messageId: MessageId = this.messageId, batch: Batch[ClosedEnvelope] = this.batch, maxSequencingTime: CantonTimestamp = this.maxSequencingTime, topologyTimestamp: Option[CantonTimestamp] = this.topologyTimestamp, aggregationRule: Option[AggregationRule] = this.aggregationRule, submissionCost: Option[SequencingSubmissionCost] = this.submissionCost): SubmissionRequest
- Annotations
- @VisibleForTesting()
- 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
- SubmissionRequest → ProtocolVersionedMemoizedEvidence
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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 isConfirmationRequest: Boolean
- def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxSequencingTime: CantonTimestamp
- val messageId: MessageId
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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[SubmissionRequest.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
- SubmissionRequest → HasRepresentativeProtocolVersion
- val sender: Member
- val submissionCost: Option[SequencingSubmissionCost]
- 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 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
- SubmissionRequest → ProtocolVersionedMemoizedEvidence
- lazy val toProtoV30: protocol.v30.SubmissionRequest
- def toProtoVersioned: VersionedMessage[SubmissionRequest]
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).
- Definition Classes
- HasProtocolVersionedWrapper
- val topologyTimestamp: Option[CantonTimestamp]
- def updateAggregationRule(aggregationRule: AggregationRule): SubmissionRequest
- def updateMaxSequencingTime(maxSequencingTime: CantonTimestamp): SubmissionRequest
- 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 parseDelimitedFromTrusted 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.VersionedProtoCodec, 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