Struct Vm

pub struct Vm<A> {
    pub state: Arc<RwLock<State>>,
    pub app_sender: Option<A>,
    pub mempool: Arc<RwLock<VecDeque<Vec<u8>>>>,
}

Implements snowman.block.ChainVM interface.

Fields

state: Arc<RwLock<State>>

Maintains the Vm-specific states.

app_sender: Option<A>

mempool: Arc<RwLock<VecDeque<Vec<u8>>>>

A queue of data that have not been put into a block and proposed yet. Mempool is not persistent, so just keep in memory via Vm.

Implementations

impl<A> Vm<A>

where A: Send + Sync + Clone + 'static,

pub fn new() -> Self

pub async fn is_bootstrapped(&self) -> bool

pub async fn notify_block_ready(&self)

Signals the consensus engine that a new block is ready to be created.

pub async fn propose_block(&self, d: Vec<u8>) -> Result<()>

Proposes arbitrary data to mempool and notifies that a block is ready for builds. Other VMs may optimize mempool with more complicated batching mechanisms.

Errors

Can fail if the data size exceeds PROPOSE_LIMIT_BYTES.

pub async fn set_state(&self, snow_state: State) -> Result<()>

Sets the state of the Vm.

Errors

Will fail if the snow::State is syncing

pub async fn last_accepted(&self) -> Result<Id>

Returns the last accepted block Id.

Errors

Will fail if there’s no state or if the db can’t be accessed

Trait Implementations

impl<A> BatchedChainVm for Vm<A>

where A: Send + Sync + Clone + 'static,

type Block = Block

fn get_ancestors<'life0, 'async_trait>( &'life0 self, _block_id: Id, _max_block_num: i32, _max_block_size: i32, _max_block_retrival_time: Duration, ) -> Pin<Box<dyn Future<Output = Result<Vec<Bytes>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attempts to obtain the ancestors of a block.

fn batched_parse_block<'life0, 'life1, 'async_trait>( &'life0 self, _blocks: &'life1 [Vec<u8>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::Block>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Attempts to batch parse_block requests.

impl<A> ChainVm for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn build_block<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<<Self as ChainVm>::Block>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds a block from mempool data.

type Block = Block

fn set_preference<'life0, 'async_trait>( &'life0 self, id: Id, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Notify the Vm of the currently preferred block.

fn last_accepted<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Id>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the ID of the last accepted block. If no blocks have been accepted, this should return the genesis block

fn issue_tx<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<<Self as ChainVm>::Block>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Issues a transaction to the chain

fn verify_height_index<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns empty if the height index is available. Returns ErrIndexIncomplete if the height index is not currently available. TODO: Remove after v1.11.x activates.

fn get_block_id_at_height<'life0, 'async_trait>( &'life0 self, _height: u64, ) -> Pin<Box<dyn Future<Output = Result<Id>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the ID of the block that was accepted with [height]. Returns ErrNotFound if the [height] index is unknown.

fn state_sync_enabled<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns whether state sync is enabled.

impl<A> Checkable for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl<A: Clone> Clone for Vm<A>

fn clone(&self) -> Vm<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> CommonVm for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Called when the node is shutting down.

fn create_static_handlers<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, HttpHandler<Self::StaticHandler>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates static handlers.

fn create_handlers<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, HttpHandler<Self::ChainHandler>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates VM-specific handlers.

type DatabaseManager = DatabaseManager

type AppSender = A

type ChainHandler = ChainHandler<ChainService<A>>

type StaticHandler = StaticHandler

type ValidatorState = ValidatorStateClient

fn initialize<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 mut self, ctx: Option<Context<Self::ValidatorState>>, db_manager: Self::DatabaseManager, genesis_bytes: &'life1 [u8], _upgrade_bytes: &'life2 [u8], _config_bytes: &'life3 [u8], to_engine: Sender<Message>, _fxs: &'life4 [Fx], app_sender: Self::AppSender, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

fn set_state<'life0, 'async_trait>( &'life0 self, snow_state: State, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn version<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl<A> Connector for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn connected<'life0, 'life1, 'async_trait>( &'life0 self, _id: &'life1 Id, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn disconnected<'life0, 'life1, 'async_trait>( &'life0 self, _id: &'life1 Id, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl<A> CrossChainAppHandler for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn cross_chain_app_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _chain_id: &'life1 Id, _request_id: u32, _deadline: DateTime<Utc>, _request: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Currently, no cross chain specific messages, so returning Ok.

fn cross_chain_app_request_failed<'life0, 'life1, 'async_trait>( &'life0 self, _chain_id: &'life1 Id, _request_id: u32, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Currently, no cross chain specific messages, so returning Ok.

fn cross_chain_app_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _chain_id: &'life1 Id, _request_id: u32, _response: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Currently, no cross chain specific messages, so returning Ok.

impl<A> Default for Vm<A>

where A: Send + Sync + Clone + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<A> Getter for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

type Block = Block

fn get_block<'life0, 'async_trait>( &'life0 self, blk_id: Id, ) -> Pin<Box<dyn Future<Output = Result<<Self as Getter>::Block>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl<A> NetworkAppHandler for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

fn app_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 Id, _request_id: u32, _deadline: DateTime<Utc>, _request: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Currently, no app-specific messages, so returning Ok.

fn app_request_failed<'life0, 'life1, 'async_trait>( &'life0 self, _node_id: &'life1 Id, _request_id: u32, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Currently, no app-specific messages, so returning Ok.

fn app_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 Id, _request_id: u32, _response: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Currently, no app-specific messages, so returning Ok.

fn app_gossip<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _node_id: &'life1 Id, _msg: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Currently, no app-specific messages, so returning Ok.

impl<A> Parser for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,

type Block = Block

fn parse_block<'life0, 'life1, 'async_trait>( &'life0 self, bytes: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<<Self as Parser>::Block>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl<A> AppHandler for Vm<A>

where A: AppSender + Send + Sync + Clone + 'static,