pub struct TributaryHandle<D: Db, T: Transaction> { /* private fields */ }Expand description
A handle to an instanced Tributary.
Implementations§
Source§impl<D: Db, T: Transaction> TributaryHandle<D, T>
impl<D: Db, T: Transaction> TributaryHandle<D, T>
Sourcepub fn block_time(&self) -> Duration
pub fn block_time(&self) -> Duration
The Tributary’s target block time.
Sourcepub fn tip(&self) -> Option<[u8; 32]>
pub fn tip(&self) -> Option<[u8; 32]>
The Tributary’s tip block.
This is read from the database and is accordingly the last committed block.
Sourcepub async fn blocks_behind(&self) -> u64
pub async fn blocks_behind(&self) -> u64
The amount of blocks the local Tributary is missing in comparison to the current consensus efforts.
This is derivative of ::tendermint::TendermintHandle::observed_block_number, a method
which allows the local process to observe the block validators are obtaining consensus over.
It is not intended to be an explicit counter of the amount of blocks to explicitly sync,
solely a hint.
Sourcepub fn block(&self, hash: [u8; 32]) -> Option<Block<T>>
pub fn block(&self, hash: [u8; 32]) -> Option<Block<T>>
A block on the Tributary, identified by its hash.
This returns None if the block wasn’t committed on this Tributary.
Sourcepub fn commit(&self, block: [u8; 32]) -> Option<Commit>
pub fn commit(&self, block: [u8; 32]) -> Option<Commit>
The commit for a block on the Tributary.
This returns None if no commit was saved for this block.
Sourcepub fn block_after(&self, parent: [u8; 32]) -> Option<[u8; 32]>
pub fn block_after(&self, parent: [u8; 32]) -> Option<[u8; 32]>
The block after a block on the Tributary.
This returns None if either:
- The parent block (identified by its hash) wasn’t committed on this Tributary
- It has no child block committed on the Tributary
Sourcepub fn locally_provided_transactions(
&self,
scope: &'static str,
start: u64,
) -> impl Iterator<Item = [u8; 32]>
pub fn locally_provided_transactions( &self, scope: &'static str, start: u64, ) -> impl Iterator<Item = [u8; 32]>
The hashes of locally provided transactions.
Sourcepub async fn message(&self, message: Message<T>)
pub async fn message(&self, message: Message<T>)
Handle a consensus message.
This will return once the message has been queued to be handled, offering no inspection into when that queue is consumed or if the queued message was valid.
Sourcepub async fn sync(
&self,
block: Block<T>,
commit: Commit,
) -> Result<(), SyncError>
pub async fn sync( &self, block: Block<T>, commit: Commit, ) -> Result<(), SyncError>
Explicitly sync a block.
This is intended to be used when a Tributary is behind, unable to simply observe blocks as they’re produced by the consensus process.
The block’s syntax and the commit is immediately validated. Therefore, this block is either valid, semantically invalid, or ephemerally invalid. Assuming honest behavior, this block will be semantically valid (due to the commit by a supermajority of validators finalizing it) though. This assumption allows simplifying that this function either returns an error or:
- The block was already added
- The block is not ready to be added (due to missing parent blocks)
- The block will be added
This function only queues the block to be added (if verified to be syntactically valid, with a valid commit). This function offers no inspection into when that queue is consumed or if the queued block was entirely valid.
Sourcepub async fn transaction(&self, transaction: T) -> Result<(), MempoolError>
pub async fn transaction(&self, transaction: T) -> Result<(), MempoolError>
Publish a transaction into the Tributary’s mempool.
This is used to publish a transaction, regardless of its kind. Provided transactions are
intended to only be provided by the local node however, meaning the caller MUST check the
kind of a transaction and its origin before calling this method.
The mempool’s rate limit will be bypassed if the transaction’s signer is the Tributary’s validator, ensuring the local validator can publish their own transactions without needing to implement an additional buffer.
Sourcepub async fn censure(&self, validator: [u8; 32])
pub async fn censure(&self, validator: [u8; 32])
Censure a validator.
This will prevent voting for block proposals from this validator and not populate their transactions within the mempool. It only applies to the local view and doesn’t have to performed in any synchrony with other validators.
Sourcepub fn next_block_notification(&self) -> impl Send + Future<Output = ()>
pub fn next_block_notification(&self) -> impl Send + Future<Output = ()>
A future which resolves when the next block is added to the Tributary.
Trait Implementations§
Auto Trait Implementations§
impl<D, T> Freeze for TributaryHandle<D, T>
impl<D, T> RefUnwindSafe for TributaryHandle<D, T>where
D: RefUnwindSafe,
Sender<(Block<T>, Commit<AggregateSignature>)>: RefUnwindSafe,
Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: RefUnwindSafe,
Sender<AsyncAddToMempool<T>>: RefUnwindSafe,
impl<D, T> Send for TributaryHandle<D, T>
impl<D, T> Sync for TributaryHandle<D, T>
impl<D, T> Unpin for TributaryHandle<D, T>
impl<D, T> UnsafeUnpin for TributaryHandle<D, T>where
D: UnsafeUnpin,
Sender<(Block<T>, Commit<AggregateSignature>)>: UnsafeUnpin,
Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: UnsafeUnpin,
Sender<AsyncAddToMempool<T>>: UnsafeUnpin,
impl<D, T> UnwindSafe for TributaryHandle<D, T>where
D: UnwindSafe,
Sender<(Block<T>, Commit<AggregateSignature>)>: UnwindSafe,
Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: UnwindSafe,
Sender<AsyncAddToMempool<T>>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.