Skip to main content

Tributary

Struct Tributary 

Source
pub struct Tributary<D: Db, T: Transaction, MN: MempoolNetwork<T>, Tendermint = (), Loop = ()> { /* private fields */ }
Expand description

An instanced Tributary.

This is a collection of futures which MUST be polled in order for the Tributary to make progress. It may be directly polled, acting as a single-threaded sequential executor for each of the contained futures, or unrolled via its IntoIterator implementation, allowing the futures to be individually spawned on an executor.

Implementations§

Source§

impl<D: Send + Sync + for<'db> Db<Transaction<'db>: Send>, T: Send + Sync + Transaction, MN: MempoolNetwork<T>> Tributary<D, T, MN>

Source

pub async fn new<N: Send + Sync + Network<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>, Sleep: Send>>( db: D, genesis: [u8; 16], genesis_time: Option<u64>, validators: HashMap<[u8; 32], NonZero<u16>>, tendermint_network: N, mempool_network: MN, key: Zeroizing<<Ristretto as Ciphersuite>::F>, mempool_rate_limit: usize, ) -> Result<(Tributary<D, T, MN, impl Send + Future<Output = ()>, impl Send + Future<Output = ()>>, TributaryHandle<D, T>), TributaryError>

Instance a Tributary.

This MUST be the only Tributary instanced with this genesis value. It will be reloaded from the database if prior instanced. For further context on the limitations of this, please refer to the limitations placed upon ::tendermint::Tendermint.

The genesis argument will be expanded to a 32-byte genesis by prefixing 16 0s.

genesis_time is expressed in milliseconds since the epoch and used to limit the minimum time blocks may be published with. This prevents a malicious supermajority from backdating blocks, allowing flooding the honest minority with valid blocks which still respect the minimum spacing between blocks. It is optional as it is not strictly required, but it is practically required for resilience against a dishonest supermajority (who can compromise the integrity of the Tributary in general). Whatever value is set, it MUST be consistent across participants AND reboots.

validators represents the validators present in the Tributary (keyed by their Ristretto public keys, valued by their weight in the consensus process). It MUST be a valid value for the ::tendermint::ValidatorSet trait.

key is the validator’s Ristretto private key. It MUST be consistent across reboots.

mempool_rate_limit is the maximum amount of transactions each validator may have pending within the mempool. It MAY be locally configured independently of other validators. It does not apply to provided nor unsigned transactions which are privileged within the Tributary.

Trait Implementations§

Source§

impl<D: Db, T: Transaction, MN: MempoolNetwork<T>, Tendermint: Future<Output = ()>, Loop: Future<Output = ()>> Future for Tributary<D, T, MN, Tendermint, Loop>

Source§

type Output = ()

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
Source§

impl<D: 'static + Send + for<'db> Db<Transaction<'db>: Send>, T: 'static + Send + Transaction, MN: 'static + Send + MempoolNetwork<T>, Tendermint: 'static + Send + Future<Output = ()>, Loop: 'static + Send + Future<Output = ()>> IntoIterator for Tributary<D, T, MN, Tendermint, Loop>

Source§

type Item = Pin<Box<dyn Future<Output = ()> + Send>>

The type of the elements being iterated over.
Source§

type IntoIter = <[<Tributary<D, T, MN, Tendermint, Loop> as IntoIterator>::Item; 3] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'__pin, D: Db, T: Transaction, MN: MempoolNetwork<T>, Tendermint, Loop> Unpin for Tributary<D, T, MN, Tendermint, Loop>
where PinnedFieldsOf<__Origin<'__pin, D, T, MN, Tendermint, Loop>>: Unpin,

Auto Trait Implementations§

§

impl<D, T, MN, Tendermint = (), Loop = ()> !UnsafeUnpin for Tributary<D, T, MN, Tendermint, Loop>

§

impl<D, T, MN, Tendermint, Loop> Freeze for Tributary<D, T, MN, Tendermint, Loop>
where Tendermint: Freeze, MempoolFuture<D, T, MN>: Freeze, Loop: Freeze,

§

impl<D, T, MN, Tendermint, Loop> RefUnwindSafe for Tributary<D, T, MN, Tendermint, Loop>
where Tendermint: RefUnwindSafe, MempoolFuture<D, T, MN>: RefUnwindSafe, Loop: RefUnwindSafe,

§

impl<D, T, MN, Tendermint, Loop> Send for Tributary<D, T, MN, Tendermint, Loop>
where Tendermint: Send, MempoolFuture<D, T, MN>: Send, Loop: Send,

§

impl<D, T, MN, Tendermint, Loop> Sync for Tributary<D, T, MN, Tendermint, Loop>
where Tendermint: Sync, MempoolFuture<D, T, MN>: Sync, Loop: Sync,

§

impl<D, T, MN, Tendermint, Loop> UnwindSafe for Tributary<D, T, MN, Tendermint, Loop>
where Tendermint: UnwindSafe, MempoolFuture<D, T, MN>: UnwindSafe, Loop: UnwindSafe,

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<I> BidiIterator for I

Source§

fn bidi(self, cond: bool) -> Bidi<Self::IntoIter> ⓘ

Conditionally reverses the direction of iteration. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Conv for T

Source§

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

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

impl<T> FmtForward for T

Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

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

Source§

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

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

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

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

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

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

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

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

Immutable access to a value. Read more
Source§

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

Mutable access to a value. Read more
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> TryConv for T

Source§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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