Struct SystemContext

pub struct SystemContext<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {

    pub(crate) public_key: TYPES::SignatureKey,
    pub(crate) private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
    pub(crate) state_private_key: <TYPES::StateSignatureKey as StateSignatureKey>::StatePrivateKey,
    pub config: HotShotConfig<TYPES>,
    pub network: Arc<I::Network>,
    pub membership_coordinator: EpochMembershipCoordinator<TYPES>,
    pub(crate) metrics: Arc<ConsensusMetricsValue>,
    pub(crate) consensus: OuterConsensus<TYPES>,
    pub(crate) instance_state: Arc<TYPES::InstanceState>,
    pub(crate) start_view: TYPES::View,
    pub(crate) start_epoch: Option<TYPES::Epoch>,
    pub(crate) output_event_stream: (Sender<Event<TYPES>>, InactiveReceiver<Event<TYPES>>),
    pub(crate) external_event_stream: (Sender<Event<TYPES>>, InactiveReceiver<Event<TYPES>>),
    pub(crate) anchored_leaf: Leaf2<TYPES>,
    pub(crate) internal_event_stream: (Sender<Arc<HotShotEvent<TYPES>>>, InactiveReceiver<Arc<HotShotEvent<TYPES>>>),
    pub id: u64,
    pub storage: I::Storage,
    pub storage_metrics: Arc<StorageMetricsValue>,
    pub upgrade_lock: UpgradeLock<TYPES, V>,
}

Holds the state needed to participate in HotShot consensus

Fields

public_key: TYPES::SignatureKey

The public key of this node

private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey

The private key of this node

state_private_key: <TYPES::StateSignatureKey as StateSignatureKey>::StatePrivateKey

The private key to sign the light client state

config: HotShotConfig<TYPES>

Configuration items for this hotshot instance

network: Arc<I::Network>

The underlying network

membership_coordinator: EpochMembershipCoordinator<TYPES>

Memberships used by consensus

metrics: Arc<ConsensusMetricsValue>

the metrics that the implementor is using.

consensus: OuterConsensus<TYPES>

The hotstuff implementation

instance_state: Arc<TYPES::InstanceState>

Immutable instance state

start_view: TYPES::View

The view to enter when first starting consensus

start_epoch: Option<TYPES::Epoch>

The epoch to enter when first starting consensus

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

Access to the output event stream.

external_event_stream: (Sender<Event<TYPES>>, InactiveReceiver<Event<TYPES>>)

External event stream for communication with the application.

anchored_leaf: Leaf2<TYPES>

Anchored leaf provided by the initializer.

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

id: u64

uid for instrumentation

storage: I::Storage

Reference to the internal storage for consensus datum.

storage_metrics: Arc<StorageMetricsValue>

Storage metrics

upgrade_lock: UpgradeLock<TYPES, V>

shared lock for upgrade information

Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> SystemContext<TYPES, I, V>

pub async fn new( public_key: TYPES::SignatureKey, private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey, state_private_key: <TYPES::StateSignatureKey as StateSignatureKey>::StatePrivateKey, nonce: u64, config: HotShotConfig<TYPES>, memberships: EpochMembershipCoordinator<TYPES>, network: Arc<I::Network>, initializer: HotShotInitializer<TYPES>, consensus_metrics: ConsensusMetricsValue, storage: I::Storage, storage_metrics: StorageMetricsValue, ) -> Arc<Self>

Creates a new Arc<SystemContext> with the given configuration options.

To do a full initialization, use fn init instead, which will set up background tasks as well.

Use this instead of init if you want to start the tasks manually

Panics

Panics if storage migration fails.

pub async fn new_from_channels( public_key: TYPES::SignatureKey, private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey, state_private_key: <TYPES::StateSignatureKey as StateSignatureKey>::StatePrivateKey, nonce: u64, config: HotShotConfig<TYPES>, membership_coordinator: EpochMembershipCoordinator<TYPES>, network: Arc<I::Network>, initializer: HotShotInitializer<TYPES>, consensus_metrics: ConsensusMetricsValue, storage: I::Storage, storage_metrics: StorageMetricsValue, internal_channel: (Sender<Arc<HotShotEvent<TYPES>>>, Receiver<Arc<HotShotEvent<TYPES>>>), external_channel: (Sender<Event<TYPES>>, Receiver<Event<TYPES>>), ) -> Arc<Self>

Creates a new Arc<SystemContext> with the given configuration options.

To do a full initialization, use fn init instead, which will set up background tasks as well.

Use this function if you want to use some preexisting channels and to spin up the tasks and start consensus manually. Mostly useful for tests

pub async fn start_consensus(&self)

“Starts” consensus by sending a Qc2Formed, ViewChange events

Panics

Panics if sending genesis fails

pub(crate) async fn send_external_event(&self, event: Event<TYPES>)

Emit an external event

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

Publishes a transaction asynchronously to the network.

Errors

Always returns Ok; does not return an error if the transaction couldn’t be published to the network

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

Returns a copy of the consensus struct

pub fn instance_state(&self) -> Arc<TYPES::InstanceState>

Returns a copy of the instance state

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

Returns a copy of the last decided leaf

Panics

Panics if internal leaf for consensus is inconsistent

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

[Non-blocking] instantly returns a copy of the last decided leaf if it is available to be read. If not, we return None.

Panics

Panics if internal state for consensus is inconsistent

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

Returns the last decided validated state.

Panics

Panics if internal state for consensus is inconsistent

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.

pub async fn init( public_key: TYPES::SignatureKey, private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey, state_private_key: <TYPES::StateSignatureKey as StateSignatureKey>::StatePrivateKey, node_id: u64, config: HotShotConfig<TYPES>, memberships: EpochMembershipCoordinator<TYPES>, network: Arc<I::Network>, initializer: HotShotInitializer<TYPES>, consensus_metrics: ConsensusMetricsValue, storage: I::Storage, storage_metrics: StorageMetricsValue, ) -> Result<(SystemContextHandle<TYPES, I, V>, Sender<Arc<HotShotEvent<TYPES>>>, Receiver<Arc<HotShotEvent<TYPES>>>), HotShotError<TYPES>>

Initializes a new SystemContext and does the work of setting up all the background tasks

Assumes networking implementation is already primed.

Underlying HotShot instance starts out paused, and must be unpaused

Upon encountering an unrecoverable error, such as a failure to send to a broadcast channel, the HotShot instance will log the error and shut down.

To construct a SystemContext without setting up tasks, use fn new instead.

Errors

Can throw an error if Self::new fails.

pub fn next_view_timeout(&self) -> u64

return the timeout for a view for self

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> SystemContext<TYPES, I, V>

pub async fn run_tasks(&self) -> SystemContextHandle<TYPES, I, V>

Spawn all tasks that operate on SystemContextHandle.

For a list of which tasks are being spawned, see this module’s documentation.

Trait Implementations

impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> Clone for SystemContext<TYPES, I, V>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.