Skip to main content

Coordinator

hotshot_new_protocol::coordinator

Struct Coordinator 

Source 
pub struct Coordinator<T: NodeType, N, S> {
Show 26 fields
    membership_coordinator: EpochMembershipCoordinator<T>,
    consensus: Consensus<T>,
    network: N,
    state_manager: StateManager<T>,
    client: CoordinatorClient<T>,
    vid_disperser: VidDisperser<T>,
    vid_reconstructor: VidReconstructor<T>,
    vote1_collector: VoteCollector<T, QuorumVote2<T>, QuorumCertificate2<T>>,
    vote2_collector: VoteCollector<T, Vote2<T>, Certificate2<T>>,
    timeout_collector: VoteCollector<T, TimeoutVote2<T>, TimeoutCertificate2<T>>,
    timeout_one_honest_collector: VoteCollector<T, TimeoutVote2<T>, TimeoutOneHonest<T>>,
    checkpoint_collector: VoteCollector<T, CheckpointVote<T>, CheckpointCertificate<T>>,
    epoch_root_collector: EpochRootVoteCollector<T>,
    epoch_manager: EpochManager<T>,
    block_builder: BlockBuilder<T>,
    proposal_validator: ProposalValidator<T>,
    share_validator: VidShareValidator<T>,
    storage: Storage<T, S>,
    outbox: Outbox<ConsensusOutput<T>>,
    coordinator_outbox: Outbox<CoordinatorOutput<T>>,
    public_key: T::SignatureKey,
    node_id: KeyPrefix,
    timer: Timer,
    pending_proposal_fetches: PendingProposalFetches<T>,
    cached_validated_proposals: BTreeMap<ViewNumber, ValidatedProposal<T>>,
    cached_vid_shares: BTreeMap<ViewNumber, VidDisperseShare2<T>>,

}

Fields§

§membership_coordinator: EpochMembershipCoordinator<T>§consensus: Consensus<T>§network: N§state_manager: StateManager<T>§client: CoordinatorClient<T>§vid_disperser: VidDisperser<T>§vid_reconstructor: VidReconstructor<T>§vote1_collector: VoteCollector<T, QuorumVote2<T>, QuorumCertificate2<T>>§vote2_collector: VoteCollector<T, Vote2<T>, Certificate2<T>>§timeout_collector: VoteCollector<T, TimeoutVote2<T>, TimeoutCertificate2<T>>§timeout_one_honest_collector: VoteCollector<T, TimeoutVote2<T>, TimeoutOneHonest<T>>§checkpoint_collector: VoteCollector<T, CheckpointVote<T>, CheckpointCertificate<T>>§epoch_root_collector: EpochRootVoteCollector<T>§epoch_manager: EpochManager<T>§block_builder: BlockBuilder<T>§proposal_validator: ProposalValidator<T>§share_validator: VidShareValidator<T>§storage: Storage<T, S>§outbox: Outbox<ConsensusOutput<T>>§coordinator_outbox: Outbox<CoordinatorOutput<T>>§public_key: T::SignatureKey§node_id: KeyPrefix§timer: Timer§pending_proposal_fetches: PendingProposalFetches<T>§cached_validated_proposals: BTreeMap<ViewNumber, ValidatedProposal<T>>§cached_vid_shares: BTreeMap<ViewNumber, VidDisperseShare2<T>>

Implementations§

Source§

impl<T: NodeType, N, S> Coordinator<T, N, S>

Source

pub fn builder() -> CoordinatorBuilder<T, N, S>

Create an instance of Coordinator using the builder syntax

Source§

impl<T, N, S> Coordinator<T, N, S>
where T: NodeType, N: Network<T>, S: NewProtocolStorage<T>,

Source

pub fn start(&mut self)

Emit ViewChanged(current_view + 1) and, if leader, a RequestBlockAndHeader.

Source

fn resume_after_cutover_tc(&mut self)

Kick the leader after the seed lands when a forwarded TC2 had already advanced current_view. No-op unless leader and all prerequisites are present.

Source

pub async fn stop(self)

Source

pub async fn next_consensus_input( &mut self, ) -> Result<ConsensusInput<T>, CoordinatorError>

Source

pub fn apply_consensus(&mut self, input: ConsensusInput<T>)

Source

pub fn process_consensus_output( &mut self, output: ConsensusOutput<T>, ) -> Result<(), CoordinatorError>

Source

pub fn node_id(&self) -> &KeyPrefix

Source

pub fn outbox(&self) -> &Outbox<ConsensusOutput<T>>

Source

pub fn outbox_mut(&mut self) -> &mut Outbox<ConsensusOutput<T>>

Source

pub fn coordinator_outbox(&self) -> &Outbox<CoordinatorOutput<T>>

Source

pub fn coordinator_outbox_mut(&mut self) -> &mut Outbox<CoordinatorOutput<T>>

Source

pub fn current_view(&self) -> ViewNumber

Source

pub fn state(&self, v: ViewNumber) -> Option<&StateEntry<T>>

Source

pub fn client_api(&self) -> &ClientApi<T>

Source

pub(crate) async fn on_network_message( &mut self, message: Message<T, Unchecked>, ) -> Option<ConsensusInput<T>>

Source

fn on_state_manager_output( &mut self, output: StateManagerOutput<T>, ) -> Option<ConsensusInput<T>>

Source

fn on_proposal_and_vid_share( &mut self, validated: ValidatedProposal<T>, vid_share: VidDisperseShare2<T>, ) -> Result<ConsensusInput<T>, CoordinatorError>

Source

fn unicast_to_leader( &mut self, view: ViewNumber, epoch: EpochNumber, msg: BlockMessage<T>, ) -> Result<(), CoordinatorError>

Source

fn leader( &mut self, view: ViewNumber, epoch: EpochNumber, ) -> Option<T::SignatureKey>

Source

async fn on_client_request( &mut self, request: ClientRequest<T>, ) -> Result<(), CoordinatorError>

Source

fn gc(&mut self, view: ViewNumber, epoch: EpochNumber)

Source

pub fn maker<'f1>() -> CoordinatorMaker<'f1, T, N, S>

Auto Trait Implementations§

§

impl<T, N, S> Freeze for Coordinator<T, N, S>
where N: Freeze, <T as NodeType>::SignatureKey: Freeze, <<T as NodeType>::SignatureKey as SignatureKey>::PrivateKey: Freeze, <<T as NodeType>::StateSignatureKey as StateSignatureKey>::StatePrivateKey: Freeze, S: Freeze, <T as NodeType>::BlockHeader: Freeze, <T as NodeType>::BlockPayload: Freeze, <<T as NodeType>::SignatureKey as SignatureKey>::QcType: Freeze,

§

impl<T, N, S> !RefUnwindSafe for Coordinator<T, N, S>

§

impl<T, N, S> Send for Coordinator<T, N, S>
where N: Send, S: Send,

§

impl<T, N, S> Sync for Coordinator<T, N, S>
where N: Sync, S: Sync,

§

impl<T, N, S> Unpin for Coordinator<T, N, S>
where N: Unpin, <T as NodeType>::SignatureKey: Unpin, <<T as NodeType>::SignatureKey as SignatureKey>::PrivateKey: Unpin, <<T as NodeType>::StateSignatureKey as StateSignatureKey>::StatePrivateKey: Unpin, S: Unpin, <T as NodeType>::BlockHeader: Unpin, <T as NodeType>::BlockPayload: Unpin, <<T as NodeType>::SignatureKey as SignatureKey>::QcType: Unpin, T: Unpin, <<T as NodeType>::BlockPayload as BlockPayload<T>>::Metadata: Unpin, <<T as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType: Unpin, <T as NodeType>::Transaction: Unpin, <<T as NodeType>::StateSignatureKey as StateSignatureKey>::StateSignature: Unpin, <T as NodeType>::BuilderSignatureKey: Unpin, <<T as NodeType>::BuilderSignatureKey as BuilderSignatureKey>::BuilderSignature: Unpin, <T as NodeType>::StateSignatureKey: Unpin,

§

impl<T, N, S> UnsafeUnpin for Coordinator<T, N, S>
where N: UnsafeUnpin, <T as NodeType>::SignatureKey: UnsafeUnpin, <<T as NodeType>::SignatureKey as SignatureKey>::PrivateKey: UnsafeUnpin, <<T as NodeType>::StateSignatureKey as StateSignatureKey>::StatePrivateKey: UnsafeUnpin, S: UnsafeUnpin, <T as NodeType>::BlockHeader: UnsafeUnpin, <T as NodeType>::BlockPayload: UnsafeUnpin, <<T as NodeType>::SignatureKey as SignatureKey>::QcType: UnsafeUnpin,

§

impl<T, N, S> !UnwindSafe for Coordinator<T, N, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more