snarkos_node_consensus

Struct Consensus

Source 
pub struct Consensus<N: Network> { /* private fields */ }
Expand description

Wrapper around BFT that adds additional functionality, such as a mempool.

Consensus acts as a rate limiter to prevents workers in BFT from being overloaded. Each worker maintains a ready queue (which is essentially also a mempool), but verifies transactions/solutions before enquing them. Consensus only passes more transactions/solutions to the BFT layer if its ready queues are not already full.

Implementations§

Source§

impl<N: Network> Consensus<N>

Source

pub async fn new( account: Account<N>, ledger: Arc<dyn LedgerService<N>>, block_sync: Arc<BlockSync<N>>, ip: Option<SocketAddr>, trusted_validators: &[SocketAddr], storage_mode: StorageMode, ping: Arc<Ping<N>>, ) -> Result<Self>

Initializes a new instance of consensus and spawn its background tasks.

Source

pub const fn bft(&self) -> &BFT<N>

Returns the underlying BFT struct.

Source§

impl<N: Network> Consensus<N>

Source

pub fn num_unconfirmed_transmissions(&self) -> usize

Returns the number of unconfirmed transmissions in the BFT’s workers (not in the mempool).

Source

pub fn num_unconfirmed_ratifications(&self) -> usize

Returns the number of unconfirmed ratifications in the BFT’s workers (not in the mempool).

Source

pub fn num_unconfirmed_solutions(&self) -> usize

Returns the number unconfirmed solutions in the BFT’s workers (not in the mempool).

Source

pub fn num_unconfirmed_transactions(&self) -> usize

Returns the number of unconfirmed transactions.

Source§

impl<N: Network> Consensus<N>

Source

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

Returns the unconfirmed transmission IDs.

Source

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

Returns the unconfirmed transmissions.

Source

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

Returns the unconfirmed solutions.

Source

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

Returns the unconfirmed transactions.

Source§

impl<N: Network> Consensus<N>

Source

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

Returns the worker transmission IDs.

Source

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

Returns the worker transmissions.

Source

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

Returns the worker solutions.

Source

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

Returns the worker transactions.

Source§

impl<N: Network> Consensus<N>

Source

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

Returns the transmission IDs in the inbound queue.

Source

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

Returns the transmissions in the inbound queue.

Source

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

Returns the solutions in the inbound queue.

Source

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

Returns the transactions in the inbound queue.

Source§

impl<N: Network> Consensus<N>

Source

pub async fn add_unconfirmed_solution( &self, solution: Solution<N>, ) -> Result<()>

Adds the given unconfirmed solution to the memory pool, which will then eventually be passed to the BFT layer for inclusion in a batch.

Source

pub async fn add_unconfirmed_transaction( &self, transaction: Transaction<N>, ) -> Result<()>

Adds the given unconfirmed transaction to the memory pool, which will then eventually be passed to the BFT layer for inclusion in a batch.

Source§

impl<N: Network> Consensus<N>

Source

pub async fn shut_down(&self)

Shuts down the consensus and BFT layers.

Trait Implementations§

Source§

impl<N: Clone + Network> Clone for Consensus<N>
where N::TransactionID: Clone,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<N> Freeze for Consensus<N>
where <N as Environment>::Field: Freeze, <N as Environment>::Scalar: Freeze, <N as Environment>::Projective: Freeze,

§

impl<N> !RefUnwindSafe for Consensus<N>

§

impl<N> Send for Consensus<N>

§

impl<N> Sync for Consensus<N>

§

impl<N> Unpin for Consensus<N>
where <N as Environment>::Field: Unpin, <N as Environment>::Scalar: Unpin, <N as Environment>::Projective: Unpin,

§

impl<N> !UnwindSafe for Consensus<N>

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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

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

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

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

Source§

fn vzip(self) -> V

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

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