Type Members

1.  final case class AcknowledgeRequest extends HasProtocolVersionedWrapper[AcknowledgeRequest] with ProtocolVersionedMemoizedEvidence with Product with Serializable
2.  final case class AggregationId(id: Hash) extends PrettyPrinting with Product with Serializable
3.  final case class AggregationRule(eligibleSenders: NonEmpty[Seq[Member]], threshold: PositiveInt)(representativeProtocolVersion: RepresentativeProtocolVersion[AggregationRule.type]) extends HasProtocolVersionedWrapper[AggregationRule] with PrettyPrinting with Product with Serializable

   Encodes the conditions on when an aggregatable submission request's envelopes are sequenced and delivered.

   Encodes the conditions on when an aggregatable submission request's envelopes are sequenced and delivered.

   Aggregatable submissions are grouped by their SubmissionRequest.aggregationId. An aggregatable submission's envelopes are delivered to their recipients when the threshold's submission request in its group has been sequenced. The aggregatable submission request that triggers the threshold defines the sequencing timestamp (and thus the sequencer counters) for all delivered envelopes. The sender of an aggregatable submission request receives a receipt of delivery immediately when its request was sequenced, not when its envelopes were delivered. When the envelopes are actually delivered, no further delivery receipt is sent.

   So a threshold of 1 means that no aggregation takes place and the event is sequenced immediately. In this case, one can completely omit the aggregation rule in the submission request.

4.  final case class Batch[+Env <: Envelope[_]] extends HasProtocolVersionedWrapper[Batch[Envelope[_]]] with PrettyPrinting with Product with Serializable

   A batch is a a list of n tuples (m_i , recipients_i), where m_i is a message, and recipients_i is the list of recipients of m_i, for 0 <= i < n.

5.  final case class ClosedEnvelope extends Envelope[ByteString] with HasProtocolVersionedWrapper[ClosedEnvelope] with Product with Serializable

   A ClosedEnvelope's contents are serialized as a com.google.protobuf.ByteString.

   A ClosedEnvelope's contents are serialized as a com.google.protobuf.ByteString.

   The serialization is interpreted as a com.digitalasset.canton.protocol.messages.EnvelopeContent if signatures are empty, and as a com.digitalasset.canton.protocol.messages.TypedSignedProtocolMessageContent otherwise. It itself is serialized without version wrappers inside a Batch.

6.  case class Deliver[+Env <: Envelope[_]] extends SequencedEvent[Env] with Product with Serializable

   Intuitively, the member learns all envelopes addressed to it.

   Intuitively, the member learns all envelopes addressed to it. It learns some recipients of these envelopes, as defined by com.digitalasset.canton.sequencing.protocol.Recipients.forMember

   Annotations

   @SuppressWarnings()

7.  sealed abstract case class DeliverError extends SequencedEvent[Nothing] with NoCopy with Product with Serializable
8.  trait Envelope[+M] extends PrettyPrinting

   An Envelope wraps an envelope content such as a com.digitalasset.canton.protocol.messages.ProtocolMessage together with the recipients.

   An Envelope wraps an envelope content such as a com.digitalasset.canton.protocol.messages.ProtocolMessage together with the recipients.

   M

   The type of the envelope content

9.  final case class GetTrafficStateForMemberRequest extends HasProtocolVersionedWrapper[GetTrafficStateForMemberRequest] with Product with Serializable

   A request to receive the topology state for initialization

10.  final case class GetTrafficStateForMemberResponse extends HasProtocolVersionedWrapper[GetTrafficStateForMemberResponse] with Product with Serializable

    A response from the GetTrafficForMember RPC

11.  sealed trait GroupRecipient extends Recipient
12.  sealed trait GroupRecipientCode extends AnyRef
13.  final case class HandshakeRequest(clientProtocolVersions: Seq[ProtocolVersion], minimumProtocolVersion: Option[ProtocolVersion]) extends Product with Serializable
14.  sealed trait HandshakeResponse extends AnyRef
15.  sealed trait MaxRequestSizeToDeserialize extends AnyRef
16.  final case class MediatorGroupRecipient(group: MediatorGroupIndex) extends GroupRecipient with Product with Serializable
17.  final case class MemberRecipient(member: Member) extends Recipient with Product with Serializable
18.  final case class MessageId(str: String73) extends LengthLimitedStringWrapper with PrettyPrinting with Product with Serializable

    Identifier assigned by caller to a submission request.

19.  final case class OpenEnvelope[+M <: ProtocolMessage](protocolMessage: M, recipients: Recipients)(protocolVersion: ProtocolVersion) extends Envelope[M] with Product with Serializable

    An OpenEnvelope contains a not serialized protocol message

    An OpenEnvelope contains a not serialized protocol message

    M

    The type of the protocol message

20.  sealed trait Recipient extends Product with Serializable with PrettyPrinting
21.  final case class Recipients(trees: NonEmpty[Seq[RecipientsTree]]) extends PrettyPrinting with Product with Serializable

    Recipients of a batch.

    Recipients of a batch. Uses a list of com.digitalasset.canton.sequencing.protocol.RecipientsTrees that define the members receiving a batch, and which members see which other recipients.

22.  final case class RecipientsTree(recipientGroup: NonEmpty[Set[Recipient]], children: Seq[RecipientsTree]) extends PrettyPrinting with Product with Serializable

    A tree representation of the recipients for a batch.

    A tree representation of the recipients for a batch. Each member receiving the batch should see only subtrees of recipients from a node containing the member. If a member is present in a subtree A and a sub-subtree of A then it should only see the top-level subtree A.

23.  sealed trait SendAsyncError extends PrettyPrinting

    Synchronous error returned by a sequencer.

24.  sealed trait SequencedEvent[+Env <: Envelope[_]] extends Product with Serializable with ProtocolVersionedMemoizedEvidence with PrettyPrinting with HasProtocolVersionedWrapper[SequencedEvent[Envelope[_]]]

    The Deliver events are received as a consequence of a Send command, received by the recipients of the originating Send event.

25.  sealed trait SequencerDeliverError extends TransactionError
26.  sealed abstract class SequencerDeliverErrorCode extends ErrorCode
27.  final case class SequencingSubmissionCost(cost: NonNegativeLong)(representativeProtocolVersion: RepresentativeProtocolVersion[SequencingSubmissionCost.type]) extends HasProtocolVersionedWrapper[SequencingSubmissionCost] with PrettyPrinting with Product with Serializable

    Encodes the submission cost calculated by the sender.

    Encodes the submission cost calculated by the sender. It will be validated by the sequencer and the submission will be rejected if the cost is incorrect.

28.  final case class SignedContent[+A <: HasCryptographicEvidence] extends HasProtocolVersionedWrapper[SignedContent[HasCryptographicEvidence]] with ProtocolVersionedMemoizedEvidence with Serializable with Product

29.  final case class SubmissionRequest extends HasProtocolVersionedWrapper[SubmissionRequest] with ProtocolVersionedMemoizedEvidence with Product with Serializable

30.  final case class SubscriptionRequestV2(member: Member, timestamp: Option[CantonTimestamp])(representativeProtocolVersion: RepresentativeProtocolVersion[SubscriptionRequestV2.type]) extends HasProtocolVersionedWrapper[SubscriptionRequestV2] with Product with Serializable

    A request to receive events from a given counter from a sequencer.

    A request to receive events from a given counter from a sequencer.

    member

    the member subscribing to the sequencer

    timestamp

    inclusive lower bound for the timestamp of the events to receive.

31.  final case class SubscriptionResponse(signedSequencedEvent: SignedContent[SequencedEvent[ClosedEnvelope]], traceContext: TraceContext) extends Product with Serializable
32.  final case class TimeProof extends PrettyPrinting with HasCryptographicEvidence with Product with Serializable

    Wrapper for a sequenced event that has the correct properties to act as a time proof:

    Wrapper for a sequenced event that has the correct properties to act as a time proof:

    • a deliver event with no envelopes
    • has a message id that suggests it was requested as a time proof (this is practically unnecessary but will act as a safeguard against future sequenced event changes)
33.  final case class TopologyStateForInitRequest(member: Member)(representativeProtocolVersion: RepresentativeProtocolVersion[TopologyStateForInitRequest.type]) extends HasProtocolVersionedWrapper[TopologyStateForInitRequest] with Product with Serializable

    A request to receive the topology state for initialization

    A request to receive the topology state for initialization

    member

    the member subscribing to the sequencer

34.  final case class TopologyStateForInitResponse(topologyTransactions: Traced[GenericStoredTopologyTransactions]) extends Product with Serializable
35.  final case class TrafficState(extraTrafficPurchased: NonNegativeLong, extraTrafficConsumed: NonNegativeLong, baseTrafficRemainder: NonNegativeLong, lastConsumedCost: NonNegativeLong, timestamp: CantonTimestamp, serial: Option[PositiveInt]) extends PrettyPrinting with Product with Serializable

    Traffic state of a member at a given timestamp

36.  final case class WithOpeningErrors[+Event](event: Event, openingErrors: Seq[ProtoDeserializationError]) extends WithGeneric[Event, Seq[ProtoDeserializationError], WithOpeningErrors] with Product with Serializable
37.  final case class WithRecipients[+A](x: A, recipients: Recipients) extends Product with Serializable