Struct Primary 

pub struct Primary<N: Network> { /* private fields */ }

The primary logic of a node. AleoBFT adopts a primary-worker architecture as described in the Narwhal and Tusk paper (Section 4.2).

Implementations

impl<N: Network> Primary<N>

pub const MAX_TRANSMISSIONS_TOLERANCE: usize = 100usize

The maximum number of unconfirmed transmissions to send to the primary.

pub fn new( account: Account<N>, storage: Storage<N>, ledger: Arc<dyn LedgerService<N>>, block_sync: Arc<BlockSync<N>>, ip: Option<SocketAddr>, trusted_validators: &[SocketAddr], trusted_peers_only: bool, storage_mode: StorageMode, dev: Option<u16>, ) -> Result<Self>

Initializes a new primary instance.

pub async fn run( &mut self, ping: Option<Arc<Ping<N>>>, bft_sender: Option<BFTSender<N>>, primary_sender: PrimarySender<N>, primary_receiver: PrimaryReceiver<N>, ) -> Result<()>

Run the primary instance.

pub fn current_round(&self) -> u64

Returns the current round.

pub fn is_synced(&self) -> bool

Returns true if the primary is synced.

pub const fn gateway(&self) -> &Gateway<N>

Returns the gateway.

pub const fn storage(&self) -> &Storage<N>

Returns the storage.

pub const fn ledger(&self) -> &Arc<dyn LedgerService<N>>

Returns the ledger.

pub fn num_workers(&self) -> u8

Returns the number of workers.

pub const fn workers(&self) -> &Arc<[Worker<N>]>

Returns the workers.

pub fn proposed_batch(&self) -> &Arc<ProposedBatch<N>>

Returns the batch proposal of our primary, if one currently exists.

impl<N: Network> Primary<N>

pub fn num_unconfirmed_transmissions(&self) -> usize

Returns the number of unconfirmed transmissions.

pub fn num_unconfirmed_ratifications(&self) -> usize

Returns the number of unconfirmed ratifications.

pub fn num_unconfirmed_solutions(&self) -> usize

Returns the number of unconfirmed solutions.

pub fn num_unconfirmed_transactions(&self) -> usize

Returns the number of unconfirmed transactions.

impl<N: Network> Primary<N>

pub fn worker_transmission_ids( &self, ) -> impl '_ + Iterator<Item = TransmissionID<N>>

Returns the worker transmission IDs.

pub fn worker_transmissions( &self, ) -> impl '_ + Iterator<Item = (TransmissionID<N>, Transmission<N>)>

Returns the worker transmissions.

pub fn worker_solutions( &self, ) -> impl '_ + Iterator<Item = (SolutionID<N>, Data<Solution<N>>)>

Returns the worker solutions.

pub fn worker_transactions( &self, ) -> impl '_ + Iterator<Item = (N::TransactionID, Data<Transaction<N>>)>

Returns the worker transactions.

impl<N: Network> Primary<N>

pub fn clear_worker_solutions(&self)

Clears the worker solutions.

impl<N: Network> Primary<N>

pub async fn propose_batch(&self) -> Result<()>

Proposes the batch for the current round.

This method performs the following steps:

1. Drain the workers.
2. Sign the batch.
3. Set the batch proposal in the primary.
4. Broadcast the batch header to all validators for signing.

impl<N: Network> Primary<N>

pub async fn shut_down(&self)

Shuts down the primary.

Trait Implementations

impl<N: Clone + Network> Clone for Primary<N>

fn clone(&self) -> Primary<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.