Enum hotshot_types::event::EventType
source · #[non_exhaustive]pub enum EventType<TYPES: NodeType> {
Error {
error: Arc<HotShotError<TYPES>>,
},
Decide {
leaf_chain: Arc<LeafChain<TYPES>>,
qc: Arc<QuorumCertificate2<TYPES>>,
block_size: Option<u64>,
},
ReplicaViewTimeout {
view_number: TYPES::View,
},
ViewFinished {
view_number: TYPES::View,
},
ViewTimeout {
view_number: TYPES::View,
},
Transactions {
transactions: Vec<TYPES::Transaction>,
},
DaProposal {
proposal: Proposal<TYPES, DaProposal<TYPES>>,
sender: TYPES::SignatureKey,
},
QuorumProposal {
proposal: Proposal<TYPES, QuorumProposal2<TYPES>>,
sender: TYPES::SignatureKey,
},
UpgradeProposal {
proposal: Proposal<TYPES, UpgradeProposal<TYPES>>,
sender: TYPES::SignatureKey,
},
ExternalMessageReceived {
sender: TYPES::SignatureKey,
data: Vec<u8>,
},
}
Expand description
The type and contents of a status event emitted by a HotShot
instance
This enum does not include metadata shared among all variants, such as the stage and view
number, and is thus always returned wrapped in an Event
.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Error
A view encountered an error and was interrupted
Fields
error: Arc<HotShotError<TYPES>>
The underlying error
Decide
A new decision event was issued
Fields
leaf_chain: Arc<LeafChain<TYPES>>
The chain of Leaves that were committed by this decision
This list is sorted in reverse view number order, with the newest (highest view number) block first in the list.
This list may be incomplete if the node is currently performing catchup. Vid Info for a decided view may be missing if this node never saw it’s share.
qc: Arc<QuorumCertificate2<TYPES>>
The QC signing the most recent leaf in leaf_chain
.
Note that the QC for each additional leaf in the chain can be obtained from the leaf before it using
ReplicaViewTimeout
A replica task was canceled by a timeout interrupt
ViewFinished
The view has finished. If values were decided on, a Decide
event will also be emitted.
ViewTimeout
The view timed out
Transactions
New transactions were received from the network or submitted to the network by us
Fields
transactions: Vec<TYPES::Transaction>
The list of transactions
DaProposal
DA proposal was received from the network or submitted to the network by us
Fields
proposal: Proposal<TYPES, DaProposal<TYPES>>
Contents of the proposal
sender: TYPES::SignatureKey
Public key of the leader submitting the proposal
QuorumProposal
Quorum proposal was received from the network or submitted to the network by us
Fields
proposal: Proposal<TYPES, QuorumProposal2<TYPES>>
Contents of the proposal
sender: TYPES::SignatureKey
Public key of the leader submitting the proposal
UpgradeProposal
Upgrade proposal was received from the network or submitted to the network by us
Fields
proposal: Proposal<TYPES, UpgradeProposal<TYPES>>
Contents of the proposal
sender: TYPES::SignatureKey
Public key of the leader submitting the proposal
ExternalMessageReceived
A message destined for external listeners was received
Fields
sender: TYPES::SignatureKey
Public Key of the message sender
Trait Implementations§
source§impl<'de, TYPES> Deserialize<'de> for EventType<TYPES>where
TYPES: NodeType,
impl<'de, TYPES> Deserialize<'de> for EventType<TYPES>where
TYPES: NodeType,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl<TYPES> Freeze for EventType<TYPES>where
<TYPES as NodeType>::View: Freeze,
<TYPES as NodeType>::SignatureKey: Freeze,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: Freeze,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: Freeze,
<TYPES as NodeType>::BlockHeader: Freeze,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Freeze,
impl<TYPES> RefUnwindSafe for EventType<TYPES>where
<TYPES as NodeType>::View: RefUnwindSafe,
<TYPES as NodeType>::SignatureKey: RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: RefUnwindSafe,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: RefUnwindSafe,
TYPES: RefUnwindSafe,
<TYPES as NodeType>::BlockHeader: RefUnwindSafe,
<TYPES as NodeType>::Transaction: RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: RefUnwindSafe,
<TYPES as NodeType>::BlockPayload: RefUnwindSafe,
<TYPES as NodeType>::ValidatedState: RefUnwindSafe,
<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta: RefUnwindSafe,
impl<TYPES> Send for EventType<TYPES>
impl<TYPES> Sync for EventType<TYPES>
impl<TYPES> Unpin for EventType<TYPES>where
<TYPES as NodeType>::View: Unpin,
<TYPES as NodeType>::SignatureKey: Unpin,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: Unpin,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: Unpin,
TYPES: Unpin,
<TYPES as NodeType>::BlockHeader: Unpin,
<TYPES as NodeType>::Transaction: Unpin,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: Unpin,
impl<TYPES> UnwindSafe for EventType<TYPES>where
<TYPES as NodeType>::View: UnwindSafe + RefUnwindSafe,
<TYPES as NodeType>::SignatureKey: UnwindSafe + RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: UnwindSafe,
<<TYPES as NodeType>::BlockPayload as BlockPayload<TYPES>>::Metadata: UnwindSafe,
TYPES: UnwindSafe + RefUnwindSafe,
<TYPES as NodeType>::BlockHeader: UnwindSafe + RefUnwindSafe,
<<TYPES as NodeType>::SignatureKey as SignatureKey>::QcType: RefUnwindSafe + UnwindSafe,
<TYPES as NodeType>::Transaction: UnwindSafe,
<TYPES as NodeType>::BlockPayload: RefUnwindSafe,
<TYPES as NodeType>::ValidatedState: RefUnwindSafe,
<<TYPES as NodeType>::ValidatedState as ValidatedState<TYPES>>::Delta: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.