Skip to main content

TributaryHandle

Struct TributaryHandle 

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

Source

pub fn genesis(&self) -> [u8; 32]

The Tributary’s genesis.

Source

pub fn block_time(&self) -> Duration

The Tributary’s target block time.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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
Source

pub fn locally_provided_transactions( &self, scope: &'static str, start: u64, ) -> impl Iterator<Item = [u8; 32]>

The hashes of locally provided transactions.

Source

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.

Source

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:

  1. The block was already added
  2. The block is not ready to be added (due to missing parent blocks)
  3. 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.

Source

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.

Source

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.

Source

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§

Source§

impl<D: Clone + Db, T: Clone + Transaction> Clone for TributaryHandle<D, T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<D, T> Freeze for TributaryHandle<D, T>
where D: Freeze, Sender<(Block<T>, Commit<AggregateSignature>)>: Freeze, Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: Freeze, Sender<AsyncAddToMempool<T>>: Freeze,

§

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>
where D: Send, Sender<(Block<T>, Commit<AggregateSignature>)>: Send, Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: Send, Sender<AsyncAddToMempool<T>>: Send,

§

impl<D, T> Sync for TributaryHandle<D, T>
where D: Sync, Sender<(Block<T>, Commit<AggregateSignature>)>: Sync, Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: Sync, Sender<AsyncAddToMempool<T>>: Sync,

§

impl<D, T> Unpin for TributaryHandle<D, T>
where D: Unpin, Sender<(Block<T>, Commit<AggregateSignature>)>: Unpin, Sender<Message<[u8; 32], [u8; 64], AggregateSignature, ReadWriteAsBorsh<Block<T>>>>: Unpin, Sender<AsyncAddToMempool<T>>: Unpin,

§

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