Struct hotshot::types::SystemContextHandle

source ·
pub struct SystemContextHandle<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {
    pub(crate) output_event_stream: (Sender<Event<TYPES>>, InactiveReceiver<Event<TYPES>>),
    pub(crate) internal_event_stream: (Sender<Arc<HotShotEvent<TYPES>>>, InactiveReceiver<Arc<HotShotEvent<TYPES>>>),
    pub(crate) consensus_registry: ConsensusTaskRegistry<HotShotEvent<TYPES>>,
    pub(crate) network_registry: NetworkTaskRegistry,
    pub hotshot: Arc<SystemContext<TYPES, I, V>>,
    pub(crate) storage: Arc<RwLock<I::Storage>>,
    pub network: Arc<I::Network>,
    pub memberships: Arc<TYPES::Membership>,
    pub epoch_height: u64,
}
Expand description

Event streaming handle for a SystemContext instance running in the background

This type provides the means to message and interact with a background SystemContext instance, allowing the ability to receive Events from it, send transactions to it, and interact with the underlying storage.

Fields§

§output_event_stream: (Sender<Event<TYPES>>, InactiveReceiver<Event<TYPES>>)

The sender and receiver, to allow the application to communicate with HotShot.

§internal_event_stream: (Sender<Arc<HotShotEvent<TYPES>>>, InactiveReceiver<Arc<HotShotEvent<TYPES>>>)

access to the internal event stream, in case we need to, say, shut something down

§consensus_registry: ConsensusTaskRegistry<HotShotEvent<TYPES>>

registry for controlling consensus tasks

§network_registry: NetworkTaskRegistry

registry for controlling network tasks

§hotshot: Arc<SystemContext<TYPES, I, V>>

Internal reference to the underlying SystemContext

§storage: Arc<RwLock<I::Storage>>

Reference to the internal storage for consensus datum.

§network: Arc<I::Network>

Networks used by the instance of hotshot

§memberships: Arc<TYPES::Membership>

Memberships used by consensus

§epoch_height: u64

Number of blocks in an epoch, zero means there are no epochs

Implementations§

source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES> + 'static, V: Versions> SystemContextHandle<TYPES, I, V>

source

pub fn add_task<S: TaskState<Event = HotShotEvent<TYPES>> + 'static>( &mut self, task_state: S, )

Adds a hotshot consensus-related task to the SystemContextHandle.

source

pub fn event_stream(&self) -> impl Stream<Item = Event<TYPES>>

obtains a stream to expose to the user

source

pub async fn send_external_message( &self, msg: Vec<u8>, recipients: RecipientList<TYPES::SignatureKey>, ) -> Result<()>

Message other participants with a serialized message from the application Receivers of this message will get an Event::ExternalMessageReceived via the event stream.

§Errors

Errors if serializing the request fails, or the request fails to be sent

source

pub fn request_proposal( &self, view: TYPES::View, epoch: TYPES::Epoch, leaf_commitment: Commitment<Leaf2<TYPES>>, ) -> Result<impl Future<Output = Result<Proposal<TYPES, QuorumProposal2<TYPES>>>>>

Request a proposal from the all other nodes. Will block until some node returns a valid proposal with the requested commitment. If nobody has the proposal this will block forever

§Errors

Errors if signing the request for proposal fails

source

pub fn event_stream_known_impl(&self) -> Receiver<Event<TYPES>>

HACK so we can know the types when running tests… there are two cleaner solutions:

  • make the stream generic and in nodetypes or nodeimpelmentation
  • type wrapper
source

pub fn internal_event_stream_sender(&self) -> Sender<Arc<HotShotEvent<TYPES>>>

HACK so we can create dependency tasks when running tests

source

pub fn internal_event_stream_receiver_known_impl( &self, ) -> Receiver<Arc<HotShotEvent<TYPES>>>

HACK so we can know the types when running tests… there are two cleaner solutions:

  • make the stream generic and in nodetypes or nodeimpelmentation
  • type wrapper

NOTE: this is only used for sanity checks in our tests

source

pub async fn decided_state(&self) -> Arc<TYPES::ValidatedState>

Get the last decided validated state of the SystemContext instance.

§Panics

If the internal consensus is in an inconsistent state.

source

pub async fn state( &self, view: TYPES::View, ) -> Option<Arc<TYPES::ValidatedState>>

Get the validated state from a given view.

Returns the requested state, if the SystemContext is tracking this view. Consensus tracks views that have not yet been decided but could be in the future. This function may return None if the requested view has already been decided (but see decided_state) or if there is no path for the requested view to ever be decided.

source

pub async fn decided_leaf(&self) -> Leaf2<TYPES>

Get the last decided leaf of the SystemContext instance.

§Panics

If the internal consensus is in an inconsistent state.

source

pub fn try_decided_leaf(&self) -> Option<Leaf2<TYPES>>

Tries to get the most recent decided leaf, returning instantly if we can’t acquire the lock.

§Panics

Panics if internal consensus is in an inconsistent state.

source

pub async fn submit_transaction( &self, tx: TYPES::Transaction, ) -> Result<(), HotShotError<TYPES>>

Submits a transaction to the backing SystemContext instance.

The current node broadcasts the transaction to all nodes on the network.

§Errors

Will return a HotShotError if some error occurs in the underlying SystemContext instance.

source

pub fn consensus(&self) -> Arc<RwLock<Consensus<TYPES>>>

Get the underlying consensus state for this SystemContext

source

pub async fn shut_down(&mut self)

Shut down the the inner hotshot and wait until all background threads are closed.

source

pub fn next_view_timeout(&self) -> u64

return the timeout for a view of the underlying SystemContext

source

pub async fn leader( &self, view_number: TYPES::View, epoch_number: TYPES::Epoch, ) -> Result<TYPES::SignatureKey>

Wrapper for HotShotConsensusApi’s leader function

§Errors

Returns an error if the leader cannot be calculated

source

pub fn public_key(&self) -> TYPES::SignatureKey

Wrapper to get this node’s public key

source

pub fn external_channel_sender(&self) -> Sender<Event<TYPES>>

Get the sender side of the external event stream for testing purpose

source

pub fn internal_channel_sender(&self) -> Sender<Arc<HotShotEvent<TYPES>>>

Get the sender side of the internal event stream for testing purpose

source

pub async fn cur_view(&self) -> TYPES::View

Wrapper to get the view number this node is on.

source

pub async fn cur_epoch(&self) -> TYPES::Epoch

Wrapper to get the epoch number this node is on.

source

pub fn storage(&self) -> Arc<RwLock<I::Storage>>

Provides a reference to the underlying storage for this SystemContext, allowing access to historical data

Trait Implementations§

source§

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> ConsensusApi<TYPES, I> for SystemContextHandle<TYPES, I, V>

source§

fn total_nodes(&self) -> NonZeroUsize

Total number of nodes in the network. Also known as n.
source§

fn builder_timeout(&self) -> Duration

The maximum amount of time a leader can wait to get a block from a builder.
source§

fn send_event<'life0, 'async_trait>( &'life0 self, event: Event<TYPES>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Notify the system of an event within hotshot-consensus.
source§

fn public_key(&self) -> &TYPES::SignatureKey

Get a reference to the public key.
source§

fn private_key(&self) -> &<TYPES::SignatureKey as SignatureKey>::PrivateKey

Get a reference to the private key.

Auto Trait Implementations§

§

impl<TYPES, I, V> Freeze for SystemContextHandle<TYPES, I, V>

§

impl<TYPES, I, V> !RefUnwindSafe for SystemContextHandle<TYPES, I, V>

§

impl<TYPES, I, V> Send for SystemContextHandle<TYPES, I, V>

§

impl<TYPES, I, V> Sync for SystemContextHandle<TYPES, I, V>

§

impl<TYPES, I, V> Unpin for SystemContextHandle<TYPES, I, V>

§

impl<TYPES, I, V> !UnwindSafe for SystemContextHandle<TYPES, I, V>

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> 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> 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, 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.
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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T