Type Members

1.  final case class AvailabilityAck(from: String, signature: Option[Signature]) extends GeneratedMessage with Updatable[AvailabilityAck] with Product with Serializable

   Annotations

   @SerialVersionUID()

2.  final case class AvailabilityMessage(message: Message) extends GeneratedMessage with Updatable[AvailabilityMessage] with Product with Serializable

   Annotations

   @SerialVersionUID()

3.  final case class Batch(orderingRequests: Seq[OrderingRequest], epochNumber: Long) extends GeneratedMessage with Updatable[Batch] with Product with Serializable
   epochNumber

   epoch number assigned to batch at the time of creation corresponding to last know epoch number at the availability module. it is used for inferring the expiration of the batch.

   Annotations

   @SerialVersionUID()

4.  final case class BatchRequest(batchId: ByteString) extends GeneratedMessage with Updatable[BatchRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

5.  final case class BatchResponse(batchId: ByteString, batch: Option[Batch]) extends GeneratedMessage with Updatable[BatchResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

6.  final case class BftOrderingMessageBody(message: Message) extends GeneratedMessage with Updatable[BftOrderingMessageBody] with Product with Serializable

   Annotations

   @SerialVersionUID()

7.  final case class BftOrderingServiceReceiveRequest(traceContext: String, body: Option[BftOrderingMessageBody], sentBy: String, sentAt: Option[Timestamp]) extends GeneratedMessage with Updatable[BftOrderingServiceReceiveRequest] with Product with Serializable

   Annotations

   @SerialVersionUID()

8.  final case class BftOrderingServiceReceiveResponse(from: String) extends GeneratedMessage with Updatable[BftOrderingServiceReceiveResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

9.  final case class BlockInProgress(prePrepared: Boolean, preparesPresent: Seq[Boolean], commitsPresent: Seq[Boolean]) extends GeneratedMessage with Updatable[BlockInProgress] with Product with Serializable

   Annotations

   @SerialVersionUID()

10.  final case class BlockMetadata(epochNumber: Long, blockNumber: Long) extends GeneratedMessage with Updatable[BlockMetadata] with Product with Serializable

    Annotations

    @SerialVersionUID()

11.  final case class BlockStatus(status: Status) extends GeneratedMessage with Updatable[BlockStatus] with Product with Serializable

    Node's status of consensus of a specific block in a segment, which is identified by its order inside of the SegmentInProgress

    Node's status of consensus of a specific block in a segment, which is identified by its order inside of the SegmentInProgress

    Annotations

    @SerialVersionUID()

12.  final case class BlockTransferRequest(epoch: Long) extends GeneratedMessage with Updatable[BlockTransferRequest] with Product with Serializable

    Annotations

    @SerialVersionUID()

13.  final case class BlockTransferResponse(commitCertificate: Option[CommitCertificate]) extends GeneratedMessage with Updatable[BlockTransferResponse] with Product with Serializable

    A thin wrapper for a commit certificate.

    A thin wrapper for a commit certificate. As long as it merely contains a commit certificate (that in turn includes signed and verified data), its signature verification can be safely skipped. As a result, any node can help with state transfer (even when sending responses signed with a new/rotated key).

    commitCertificate

    Avoid adding more data that would require signing to allow skipping the outer message's signature verification!

    Annotations

    @SerialVersionUID()

14.  final case class CanonicalCommitSet(canonicalCommits: Seq[SignedMessage]) extends GeneratedMessage with Updatable[CanonicalCommitSet] with Product with Serializable

    A canonical (fixed) set of (usually 2f+1) Commit messages that completed the recent stable block.

    A canonical (fixed) set of (usually 2f+1) Commit messages that completed the recent stable block. Check the BFT time design for more details.

    Annotations

    @SerialVersionUID()

15.  final case class Commit(blockHash: ByteString, localTimestamp: Long) extends GeneratedMessage with Updatable[Commit] with Product with Serializable

    A Commit means that a node have received a quorum of Prepare Upon receiving a quorum of Commit, a node considers the round complete

    A Commit means that a node have received a quorum of Prepare Upon receiving a quorum of Commit, a node considers the round complete

    localTimestamp

    creation time, in microseconds of UTC time since Unix epoch

    Annotations

    @SerialVersionUID()

16.  final case class CommitCertificate(prePrepare: Option[SignedMessage], commits: Seq[SignedMessage]) extends GeneratedMessage with Updatable[CommitCertificate] with Product with Serializable

    A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Commits that prove a particular value (payload) was committed for a particular (epoch, block, view)-tuple

    A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Commits that prove a particular value (payload) was committed for a particular (epoch, block, view)-tuple

    Annotations

    @SerialVersionUID()

17.  final case class ConsensusCertificate(certificate: Certificate) extends GeneratedMessage with Updatable[ConsensusCertificate] with Product with Serializable

    Annotations

    @SerialVersionUID()

18.  final case class ConsensusMessage(blockMetadata: Option[BlockMetadata], viewNumber: Long, from: String, message: Message) extends GeneratedMessage with Updatable[ConsensusMessage] with Product with Serializable

    Annotations

    @SerialVersionUID()

19.  final case class DynamicSequencingParametersPayload(pbftViewChangeTimeout: Option[Duration]) extends GeneratedMessage with Updatable[DynamicSequencingParametersPayload] with Product with Serializable

    Annotations

    @SerialVersionUID()

20.  final case class EpochStatus(epochNumber: Long, segments: Seq[SegmentStatus]) extends GeneratedMessage with Updatable[EpochStatus] with Product with Serializable

    Node's status of consensus for the whole epoch.

    Node's status of consensus for the whole epoch. Acts as a retransmission request where receiving node will compute what they can retransmit based on what the requesting node is lacking from looking at this status message.

    Annotations

    @SerialVersionUID()

21.  final case class NewView(viewChanges: Seq[SignedMessage], prePrepares: Seq[SignedMessage]) extends GeneratedMessage with Updatable[NewView] with Product with Serializable

    A NewView message is sent by the next node taking over leader responsibilities of a PBFT instance at the end of a view change

    A NewView message is sent by the next node taking over leader responsibilities of a PBFT instance at the end of a view change

    Annotations

    @SerialVersionUID()

22.  final case class OrderingBlock(proofs: Seq[ProofOfAvailability]) extends GeneratedMessage with Updatable[OrderingBlock] with Product with Serializable

    Annotations

    @SerialVersionUID()

23.  final case class OrderingRequest(traceContext: String, tag: String, payload: ByteString, orderingStartInstant: Option[Timestamp]) extends GeneratedMessage with Updatable[OrderingRequest] with Product with Serializable
    orderingStartInstant

    The following field is only used for metrics.

    Annotations

    @SerialVersionUID()

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

    Annotations

    @SerialVersionUID()

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

    Annotations

    @SerialVersionUID()

26.  final case class PrePrepare(block: Option[OrderingBlock], bftTimeCanonicalCommitSet: Option[CanonicalCommitSet]) extends GeneratedMessage with Updatable[PrePrepare] with Product with Serializable

    A PrePrepare message is the proposal sent by the leader in a round

    A PrePrepare message is the proposal sent by the leader in a round

    Annotations

    @SerialVersionUID()

27.  final case class Prepare(blockHash: ByteString) extends GeneratedMessage with Updatable[Prepare] with Product with Serializable

    A Prepare is an acknowledgement that a node received the PrePrepare

    A Prepare is an acknowledgement that a node received the PrePrepare

    Annotations

    @SerialVersionUID()

28.  final case class PrepareCertificate(prePrepare: Option[SignedMessage], prepares: Seq[SignedMessage]) extends GeneratedMessage with Updatable[PrepareCertificate] with Product with Serializable

    A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Prepares that prove a particular value (payload) was prepared for a particular (epoch, block, view)-tuple

    A self-contained, cryptographically-verifiable set of one PrePrepare and quorum-1 Prepares that prove a particular value (payload) was prepared for a particular (epoch, block, view)-tuple

    Annotations

    @SerialVersionUID()

29.  final case class ProofOfAvailability(batchId: ByteString, acks: Seq[AvailabilityAck], epochNumber: Long) extends GeneratedMessage with Updatable[ProofOfAvailability] with Product with Serializable

    Annotations

    @SerialVersionUID()

30.  final case class RetransmissionMessage(message: Message) extends GeneratedMessage with Updatable[RetransmissionMessage] with Product with Serializable

    Retransmissions

    Retransmissions

    Annotations

    @SerialVersionUID()

31.  final case class RetransmissionResponse(commitCertificates: Seq[CommitCertificate]) extends GeneratedMessage with Updatable[RetransmissionResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

32.  final case class SegmentInProgress(viewNumber: Long, blockStatuses: Seq[BlockStatus]) extends GeneratedMessage with Updatable[SegmentInProgress] with Product with Serializable

    Annotations

    @SerialVersionUID()

33.  final case class SegmentInViewChange(viewNumber: Long, viewChangeMessagesPresent: Seq[Boolean], areBlocksComplete: Seq[Boolean]) extends GeneratedMessage with Updatable[SegmentInViewChange] with Product with Serializable

    Annotations

    @SerialVersionUID()

34.  final case class SegmentStatus(status: Status) extends GeneratedMessage with Updatable[SegmentStatus] with Product with Serializable

    Node's status of consensus for a specific segment, which is identified by its order inside of the EpochStatus

    Node's status of consensus for a specific segment, which is identified by its order inside of the EpochStatus

    Annotations

    @SerialVersionUID()

35.  final case class SignedMessage(message: ByteString, from: String, signature: Option[Signature]) extends GeneratedMessage with Updatable[SignedMessage] with Product with Serializable

    Annotations

    @SerialVersionUID()

36.  final case class StateTransferMessage(message: Message) extends GeneratedMessage with Updatable[StateTransferMessage] with Product with Serializable

    State transfer

    State transfer

    Annotations

    @SerialVersionUID()

37.  final case class StoreRequest(batchId: ByteString, batch: Option[Batch]) extends GeneratedMessage with Updatable[StoreRequest] with Product with Serializable

    A StoreRequest is requesting another availability node to store

    A StoreRequest is requesting another availability node to store

    Annotations

    @SerialVersionUID()

38.  final case class StoreResponse(batchId: ByteString, signature: Option[Signature]) extends GeneratedMessage with Updatable[StoreResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

39.  final case class ViewChange(consensusCerts: Seq[ConsensusCertificate]) extends GeneratedMessage with Updatable[ViewChange] with Product with Serializable

    A ViewChange message is sent when an instance of PBFT fails to make progress before a timeout triggers.

    A ViewChange message is sent when an instance of PBFT fails to make progress before a timeout triggers.

    Annotations

    @SerialVersionUID()