Type Members

1.  final case class AcknowledgeRequest(member: String, timestamp: Long) extends GeneratedMessage with Updatable[AcknowledgeRequest] with Product with Serializable
   member

   Who is the acknowledgement being sent on behalf of

   timestamp

   The timestamp in sequencer time that they are acknowledging and will not re-read earlier events. It is expected that the caller has a received an event with this timestamp but this is not validated. In microseconds of UTC time since Unix epoch

   Annotations

   @SerialVersionUID()

2.  final case class AcknowledgeResponse() extends GeneratedMessage with Updatable[AcknowledgeResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

3.  final case class AcknowledgeSignedRequest(signedAcknowledgeRequest: ByteString) extends GeneratedMessage with Updatable[AcknowledgeSignedRequest] with Product with Serializable
   signedAcknowledgeRequest

   contains a versioned AcknowledgeRequest TODO(i17383): Have exactly one signature instead of multiple signatures. Serialized SignedContent[AcknowledgeRequest]

   Annotations

   @SerialVersionUID()

4.  final case class AcknowledgeSignedResponse() extends GeneratedMessage with Updatable[AcknowledgeSignedResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

5.  final case class ConnectToSequencerChannelRequest(request: Request, traceContext: Option[TraceContext]) extends GeneratedMessage with Updatable[ConnectToSequencerChannelRequest] with Product with Serializable

   The sequencer channel service protocol consists of several messages which are sent as a request or a response (that is as a ConnectToSequencerChannelRequest or a ConnectToSequencerChannelResponse).

   The sequencer channel service protocol consists of several messages which are sent as a request or a response (that is as a ConnectToSequencerChannelRequest or a ConnectToSequencerChannelResponse).

   The protocol transitions through several stages. - To bootstrap the channel, initialization messages between the sequencer channel client and service need to be exchanged, that are SequencerChannelMetadata and SequencerChannelConnectedToAllEndpoints messages. - To secure the channel, sequencer channel client member endpoints setup a session key with the SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages. - To transfer data through the channel, members use opaque (encrypted) payload messages which the sequencer channel service forwards between channel member endpoints.

   Using payload messages channel client users can implement their own application protocol such as the Online Party Replication.

   Note that both, request and response need to implement SequencerChannelSessionKey and SequencerChannelSessionKeyAck messages because of the bidirectional gRPC streams. For example, when the sequencer channel service receives a SequencerChannelSessionKeyAck request message from a sequencer channel client, it needs to forward it as a SequencerChannelSessionKeyAck response message to the destination sequencer channel client.

   traceContext

   Canton trace context Required

   Annotations

   @SerialVersionUID()

6.  final case class ConnectToSequencerChannelResponse(response: Response, traceContext: Option[TraceContext]) extends GeneratedMessage with Updatable[ConnectToSequencerChannelResponse] with Product with Serializable
   traceContext

   Canton trace context Required

   Annotations

   @SerialVersionUID()

7.  final case class DownloadTopologyStateForInitRequest(member: String) extends GeneratedMessage with Updatable[DownloadTopologyStateForInitRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

8.  final case class DownloadTopologyStateForInitResponse(topologyTransactions: Option[TopologyTransactions]) extends GeneratedMessage with Updatable[DownloadTopologyStateForInitResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

9.  final case class GetTrafficStateForMemberRequest(member: String, timestamp: Long) extends GeneratedMessage with Updatable[GetTrafficStateForMemberRequest] with Product with Serializable
   member

   Member for which to get the traffic state

   timestamp

   Timestamp at which to to get the traffic state

   Annotations

   @SerialVersionUID()

10.  final case class GetTrafficStateForMemberResponse(trafficState: Option[TrafficState]) extends GeneratedMessage with Updatable[GetTrafficStateForMemberResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

11.  final case class PingRequest() extends GeneratedMessage with Updatable[PingRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

12.  final case class PingResponse() extends GeneratedMessage with Updatable[PingResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

13.  final case class SendAsyncRequest(signedSubmissionRequest: ByteString) extends GeneratedMessage with Updatable[SendAsyncRequest] with Product with Serializable
    signedSubmissionRequest

    Contains a versioned SignedContent which itself contains a versioned SubmissionRequest. TODO(i17383): Have exactly one signature instead of multiple signatures.

    Annotations

    @SerialVersionUID()

14.  final case class SendAsyncResponse() extends GeneratedMessage with Updatable[SendAsyncResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

15.  final case class SequencerAuthentication() extends GeneratedMessage with Updatable[SequencerAuthentication] with Product with Serializable

    Annotations

    @SerialVersionUID()

16.  final case class SequencerChannelConnectedToAllEndpoints() extends GeneratedMessage with Updatable[SequencerChannelConnectedToAllEndpoints] with Product with Serializable

    Notification that a sequencer channel has been connected to the members specified in the SequencerChannelMetadata.

    Notification that a sequencer channel has been connected to the members specified in the SequencerChannelMetadata.

    Annotations

    @SerialVersionUID()

17.  final case class SequencerChannelMetadata(channelId: String, initiatingMember: String, receivingMember: String) extends GeneratedMessage with Updatable[SequencerChannelMetadata] with Product with Serializable

    Metadata for a sequencer channel to be established between two members.

    Metadata for a sequencer channel to be established between two members.

    channelId

    Channel identifier Required

    initiatingMember

    The member initiating the channel connect request Required

    receivingMember

    The member to connect to via the channel Required

    Annotations

    @SerialVersionUID()

18.  final case class SequencerChannelSessionKey(encryptedSessionKey: Option[AsymmetricEncrypted]) extends GeneratedMessage with Updatable[SequencerChannelSessionKey] with Product with Serializable

    Public key encrypted session key to secure the communication between two members.

    Public key encrypted session key to secure the communication between two members.

    encryptedSessionKey

    The public key is determined by the timestamp as agreed by the connecting members beforehand. The timestamp is expected to originate from a recent topology transaction that has already taken effect; meaning it's not a future timestamp. Required

    Annotations

    @SerialVersionUID()

19.  final case class SequencerChannelSessionKeyAck() extends GeneratedMessage with Updatable[SequencerChannelSessionKeyAck] with Product with Serializable

    Acknowledgement that the session key has been received

    Acknowledgement that the session key has been received

    Annotations

    @SerialVersionUID()

20.  final case class SequencerConnect() extends GeneratedMessage with Updatable[SequencerConnect] with Product with Serializable

    Annotations

    @SerialVersionUID()

21.  final case class SubscriptionRequestV2(member: String, timestamp: Option[Long]) extends GeneratedMessage with Updatable[SubscriptionRequestV2] with Product with Serializable
    timestamp

    Timestamp to start the subscription from (inclusive). Members can use the timestamp of the last event they have received to continue from there and compare the event, or can subscribe from previous event timestamp's immediate successor to get the next event. To subscribe from the beginning, set the optional to None. If it refers to an event that has already been acknowledged, the sequencer may reject the request. In microseconds of UTC time since Unix epoch

    Annotations

    @SerialVersionUID()

22.  final case class SubscriptionResponse(signedSequencedEvent: ByteString, traceContext: Option[TraceContext]) extends GeneratedMessage with Updatable[SubscriptionResponse] with Product with Serializable
    signedSequencedEvent

    Contains a versioned SignedContent which itself contains a versioned SequencedEvent Serialized SignedContent[SequencedEvent[ClosedEnvelope]]

    traceContext

    optional, canton trace context DO NOT RENAME this field, as the ApiRequestLogger uses reflection to read this field. We typically use a header to transfer this information however streamed items do not have per item/message headers, so we instead in this instance set it in the body.

    Annotations

    @SerialVersionUID()

23.  final case class TrafficControlErrorReason(error: Option[Error]) extends GeneratedMessage with Updatable[TrafficControlErrorReason] with Product with Serializable
    error

    Message containing details on the error

    Annotations

    @SerialVersionUID()