Struct penumbra_mock_consensus::TestNode

source · 
pub struct TestNode<C> { /* private fields */ }
Expand description

A test node.

A TestNode<C> represents a validator node containing an instance of the state transition machine and its accompanying consensus engine.

§Initialization

Construct a new test node by calling TestNode::builder(). The builder::Builder returned by that method can be used to set the initial application state, and configure validators’ consensus keys that should be present at genesis. Use builder::Builder::init_chain() to consume the builder and initialize the application.

§Consensus Service

A test node is generic in terms of a consensus service C. This service should implement [tower::Service], accepting ConsensusRequests, and returning ConsensusResponses.

For tower-abci users, this should correspond with the C parameter of the Server type.

§Blocks

Blocks can be executed by using TestNode::block(). This can be used to add transactions, signatures, and evidence to a Block, before invoking block::Builder::execute() to execute the next block.

Implementations§

source§

impl<C> TestNode<C>

source

pub fn block(&mut self) -> Builder<'_, C>

Returns a new Builder.

By default, signatures for all of the validators currently within the keyring will be included in the block. Use Builder::with_signatures() to set a different set of validator signatures.

source§

impl TestNode<()>

source

pub fn builder() -> Builder

Returns a new Builder.

source§

impl<C> TestNode<C>
where C: Service<ConsensusRequest, Response = ConsensusResponse, Error = BoxError> + Send + Clone + 'static, C::Future: Send + 'static, C::Error: Sized,

ABCI-related interfaces.

source

pub async fn begin_block( &mut self, header: Header, last_commit_info: CommitInfo ) -> Result<BeginBlock, Error>

Sends a [ConsensusRequest::BeginBlock] request to the ABCI application.

source

pub async fn deliver_tx(&mut self, tx: Bytes) -> Result<DeliverTx, Error>

Sends a [ConsensusRequest::DeliverTx] request to the ABCI application.

source

pub async fn end_block(&mut self) -> Result<EndBlock, Error>

Sends a [ConsensusRequest::EndBlock] request to the ABCI application.

source

pub async fn commit(&mut self) -> Result<Commit, Error>

Sends a [ConsensusRequest::Commit] request to the ABCI application.

source§

impl<C> TestNode<C>

Accessors.

source

pub const CHAIN_ID: &'static str = "penumbra-test-chain"

A chain ID for use in tests.

source

pub fn last_app_hash(&self) -> &[u8] ⓘ

Returns the last app_hash value, represented as a slice of bytes.

source

pub fn last_app_hash_hex(&self) -> String

Returns the last app_hash value, represented as a hexadecimal string.

source

pub fn keyring(&self) -> &BTreeMap<VerificationKey, SigningKey>

Returns a reference to the test node’s set of consensus keys.

source

pub fn keyring_mut(&mut self) -> &mut BTreeMap<VerificationKey, SigningKey>

Returns a mutable reference to the test node’s set of consensus keys.

source§

impl<C> TestNode<C>
where C: Service<ConsensusRequest, Response = ConsensusResponse, Error = BoxError> + Send + Clone + 'static, C::Future: Send + 'static, C::Error: Sized,

Fast forward interfaces.

source

pub async fn fast_forward(&mut self, blocks: u64) -> Result<()>

Fast forwards the given number of blocks.

Auto Trait Implementations§

§

impl<C> Freeze for TestNode<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for TestNode<C>
where C: RefUnwindSafe,

§

impl<C> Send for TestNode<C>
where C: Send,

§

impl<C> Sync for TestNode<C>
where C: Sync,

§

impl<C> Unpin for TestNode<C>
where C: Unpin,

§

impl<C> UnwindSafe for TestNode<C>
where C: 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
§

impl<T> Conv for T

§

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

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

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

§

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
§

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
§

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
§

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
§

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
§

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

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

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

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> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

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

Immutable access to a value. Read more
§

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

Mutable access to a value. Read more
§

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
§

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
§

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
§

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
§

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
§

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
§

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

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

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

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

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

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

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

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

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

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

impl<T> TryConv for T

§

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

§

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

§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more