Type Members

1.  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.

   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.

2.  trait BaseLocalRejectErrorCode extends AnyRef

   Base type for error codes related to local reject.

3.  final case class CausalityMessage(domainId: DomainId, transferId: TransferId, clock: VectorClock)(representativeProtocolVersion: RepresentativeProtocolVersion[ProtocolMessage]) extends ProtocolMessage with PrettyPrinting with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

   Causality messages are sent along with a transfer-in response.

   Causality messages are sent along with a transfer-in response. They propagate causality information on the events a participant has "seen" for a party at the time of the transfer-out. TODO(i9514): Encrypt the causality messages

   domainId

   The domain ID that the causality message is addressed to

   transferId

   The ID of the transfer for which we are propagating causality information

   clock

   The vector clock specifying causality information at the time of the transfer out

4.  final case class CommitmentPeriod(fromExclusive: CantonTimestampSecond, periodLength: PositiveSeconds) extends PrettyPrinting with Product with Serializable
5.  case class ConfirmationRequest(informeeMessage: InformeeMessage, viewEnvelopes: Seq[OpenEnvelope[TransactionViewMessage]], protocolVersion: ProtocolVersion) extends PrettyPrinting with Product with Serializable

   Represents the confirmation request as sent from a submitting node to the sequencer.

6.  type DefaultOpenEnvelope = OpenEnvelope[ProtocolMessage]
7.  case class DeliveredTransferOutResult(result: SignedContent[Deliver[DefaultOpenEnvelope]]) extends PrettyPrinting with Product with Serializable
8.  case class DomainTopologyTransactionMessage extends ProtocolMessage with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable
9.  sealed trait EncryptedView[+VT <: ViewType] extends Product with Serializable

   An encrypted com.digitalasset.canton.data.ViewTree together with its com.digitalasset.canton.data.ViewType.

   An encrypted com.digitalasset.canton.data.ViewTree together with its com.digitalasset.canton.data.ViewType. The correspondence is encoded via a path-dependent type. The type parameter VT exposes a upper bound on the type of view types that may be contained.

   The view tree is compressed before encryption.

10.  sealed trait EncryptedViewMessage[+VT <: ViewType] extends ProtocolMessage with HasRepresentativeProtocolVersion

    An encrypted view message.

    An encrypted view message.

    See https://engineering.da-int.net/docs/platform-architecture-handbook/arch/canton/tx-data-structures.html#transaction-hashes-and-views

11.  sealed trait EncryptedViewMessageDecryptionError[+VT <: ViewType] extends Product with Serializable with PrettyPrinting
12.  final case class EncryptedViewMessageV0[+VT <: ViewType](submitterParticipantSignature: Option[Signature], viewHash: ViewHash, randomnessMap: Map[ParticipantId, Encrypted[SecureRandomness]], encryptedView: EncryptedView[VT], domainId: DomainId) extends EncryptedViewMessage[VT] with ProtocolMessageV0 with Product with Serializable
13.  final case class EncryptedViewMessageV1[+VT <: ViewType](submitterParticipantSignature: Option[Signature], viewHash: ViewHash, randomness: Seq[AsymmetricEncrypted[SecureRandomness]], encryptedView: EncryptedView[VT], domainId: DomainId, viewEncryptionScheme: SymmetricKeyScheme)(informeeParticipants: Option[Set[ParticipantId]]) extends EncryptedViewMessage[VT] with ProtocolMessageV1 with Product with Serializable
14.  final case class EnvelopeContent(message: ProtocolMessage)(representativeProtocolVersion: RepresentativeProtocolVersion[EnvelopeContent]) extends HasProtocolVersionedWrapper[EnvelopeContent] with Product with Serializable
15.  trait HasDomainId extends AnyRef
16.  trait HasRequestId extends AnyRef
17.  case class InformeeMessage(fullInformeeTree: FullInformeeTree)(protocolVersion: ProtocolVersion) extends MediatorRequest with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

    The informee message to be sent to the mediator.

18.  case class LocalApprove()(representativeProtocolVersion: RepresentativeProtocolVersion[LocalVerdict]) extends LocalVerdict with Product with Serializable
19.  trait LocalReject extends LocalVerdict with TransactionError
20.  abstract class LocalRejectErrorCode extends ErrorCode with BaseLocalRejectErrorCode

    Base type for ErrorCodes related to LocalReject, if the rejection does not (necessarily) occur due to malicious behavior.

21.  abstract class LocalRejectImpl extends LocalReject

    Base class for LocalReject errors, if the rejection does not (necessarily) occur due to malicious behavior.

22.  sealed trait LocalVerdict extends Product with Serializable with PrettyPrinting with HasProtocolVersionedWrapper[LocalVerdict]

    Possible verdicts on a transaction view from the participant's perspective.

    Possible verdicts on a transaction view from the participant's perspective. The verdict can be LocalApprove, LocalReject or Malformed. The verdicts LocalReject and Malformed include a reason pointing out which checks in Phase 3 have failed.

23.  sealed abstract class Malformed extends BaseAlarm with LocalReject

    Base class for LocalReject errors, if the rejection occurs due to malicious behavior.

24.  abstract class MalformedErrorCode extends AlarmErrorCode with BaseLocalRejectErrorCode

    Base type for ErrorCodes related to LocalReject, if the rejection is due to malicious behavior.

25.  case class MalformedMediatorRequestResult extends MediatorResult with SignedProtocolMessageContent with HasProtocolVersionedWrapper[MalformedMediatorRequestResult] with PrettyPrinting with Product with Serializable

    Sent by the mediator to indicate that a mediator request was malformed.

    Sent by the mediator to indicate that a mediator request was malformed. The request counts as being rejected and the request UUID will not be deduplicated.

26.  trait MediatorRequest extends ProtocolMessage
27.  case class MediatorResponse extends SignedProtocolMessageContent with HasProtocolVersionedWrapper[MediatorResponse] with HasDomainId with PrettyPrinting with Product with Serializable

    Payload of a response sent to the mediator in reaction to a request.

28.  trait MediatorResult extends ProtocolVersionedMemoizedEvidence with HasDomainId with HasRequestId with SignedProtocolMessageContent
29.  trait ProtocolMessage extends Product with Serializable with HasDomainId with PrettyPrinting with HasRepresentativeProtocolVersion

    Parent trait of messages that are sent through the sequencer

30.  trait ProtocolMessageV0 extends ProtocolMessage
31.  trait ProtocolMessageV1 extends ProtocolMessage
32.  final case class RegisterTopologyTransactionRequest extends ProtocolMessage with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

33.  final case class RegisterTopologyTransactionResponse[+Res <: RegisterTopologyTransactionResponseResult](requestedBy: Member, participant: ParticipantId, requestId: TopologyRequestId, results: Seq[Res], domainId: DomainId)(representativeProtocolVersion: RepresentativeProtocolVersion[Result]) extends ProtocolMessage with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable
34.  sealed trait RegisterTopologyTransactionResponseResult extends AnyRef
35.  trait RegularMediatorResult extends MediatorResult

    The mediator issues a regular mediator result for well-formed mediator requests.

    The mediator issues a regular mediator result for well-formed mediator requests. Malformed mediator requests lead to a MalformedMediatorRequestResult.

36.  final case class RootHashMessage[+Payload <: RootHashMessagePayload](rootHash: RootHash, domainId: DomainId, viewType: ViewType, payload: Payload)(representativeProtocolVersion: RepresentativeProtocolVersion[ProtocolMessage]) extends ProtocolMessage with ProtocolMessageV0 with ProtocolMessageV1 with PrettyPrinting with Product with Serializable

    One root hash message is sent for each participant involved in a mediator request that requires root hash messages.

    One root hash message is sent for each participant involved in a mediator request that requires root hash messages. The root hash message is delivered to the participant and the mediator. The mediator checks that it receives the right root hash messages and that they all contain the root hash that the mediator request message specifies. The mediator also checks that all payloads have the same serialization and, if it can parse the mediator request envelope, that the payload fits to the mediator request.

37.  trait RootHashMessagePayload extends PrettyPrinting with HasCryptographicEvidence

    Payloads of RootHashMessage

38.  case class SerializedRootHashMessagePayload(bytes: ByteString) extends RootHashMessagePayload with Product with Serializable
39.  case class SignedProtocolMessage[+M <: SignedProtocolMessageContent](message: M, signature: Signature)(representativeProtocolVersion: RepresentativeProtocolVersion[SignedProtocolMessage[SignedProtocolMessageContent]]) extends ProtocolMessage with ProtocolMessageV0 with ProtocolMessageV1 with HasProtocolVersionedWrapper[SignedProtocolMessage[SignedProtocolMessageContent]] with Product with Serializable
40.  trait SignedProtocolMessageContent extends ProtocolVersionedMemoizedEvidence with HasDomainId with PrettyPrinting with Product with Serializable
41.  case class TransactionResultMessage extends RegularMediatorResult with HasProtocolVersionedWrapper[TransactionResultMessage] with PrettyPrinting with Product with Serializable

    Transaction result message that the mediator sends to all stakeholders of a confirmation request with its verdict.

    Transaction result message that the mediator sends to all stakeholders of a confirmation request with its verdict. https://engineering.da-int.net/docs/platform-architecture-handbook/arch/canton/transactions.html#phase-6-broadcast-of-result

42.  type TransactionViewMessage = EncryptedViewMessage[TransactionViewType]
43.  sealed trait TransferDomainId extends Product with Serializable with PrettyPrinting
44.  case class TransferInDomainId(domain: DomainId) extends TransferDomainId with Product with Serializable
45.  case class TransferInMediatorMessage(tree: TransferInViewTree) extends MediatorRequest with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

    Message sent to the mediator as part of a transfer-in request

    Message sent to the mediator as part of a transfer-in request

    tree

    The transfer-in view tree blinded for the mediator

    Exceptions thrown

    java.lang.IllegalArgumentException if the common data is blinded or the view is not blinded

46.  type TransferInResult = TransferResult[TransferInDomainId]
47.  case class TransferOutDomainId(domain: DomainId) extends TransferDomainId with Product with Serializable
48.  case class TransferOutMediatorMessage(tree: TransferOutViewTree) extends MediatorRequest with ProtocolMessageV0 with ProtocolMessageV1 with Product with Serializable

    Message sent to the mediator as part of a transfer-out request

    Message sent to the mediator as part of a transfer-out request

    tree

    The transfer-out view tree blinded for the mediator

    Exceptions thrown

    java.lang.IllegalArgumentException if the common data is blinded or the view is not blinded

49.  type TransferOutResult = TransferResult[TransferOutDomainId]
50.  case class TransferResult[+Domain <: TransferDomainId] extends RegularMediatorResult with HasProtocolVersionedWrapper[TransferResult[TransferDomainId]] with PrettyPrinting with Product with Serializable

    Mediator result for a transfer request

51.  case class VectorClock(sourceDomainId: DomainId, localTs: CantonTimestamp, partyId: LfPartyId, clock: Map[DomainId, CantonTimestamp]) extends PrettyPrinting with Product with Serializable

    A vector clock represents the causal constraints that must be respected for a party at a certain point in time.

    A vector clock represents the causal constraints that must be respected for a party at a certain point in time. Vector clocks are maintained per-domain

    sourceDomainId

    The domain of the vector clock

    localTs

    The timestamp on sourceDomainId specifying the time at which the causal constraints are valid

    partyId

    The party who has seen the causal information specified by clock

    clock

    The most recent timestamp on each domain that partyId has causally observed

52.  sealed trait Verdict extends Product with Serializable with PrettyPrinting with HasProtocolVersionedWrapper[Verdict]