avalanche-types 0.0.54

Avalanche types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use std::{collections::HashMap, io::Result};

use crate::{
    ids,
    rpcchainvm::{
        common::{
            apphandler::AppHandler, appsender::AppSender, http_handler::HttpHandler,
            message::Message,
        },
        context::Context,
        database::manager::Manager,
        health::Checkable,
        snow::State,
    },
};
use tokio::sync::mpsc::Sender;

// TODO: gate definition based on features. Ie state_sync is + StateSync then
// define a matrix which clearly defines each features. This will allow devs to
// customize methods they want to implement on the application level. While
// not needing to reason about rpcchaimvm impl.

/// Vm describes the interface that all consensus VMs must implement
/// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/snow/engine/common#Vm
#[tonic::async_trait]
pub trait Vm: AppHandler + Connector + Checkable {
    async fn initialize(
        &mut self,
        ctx: Option<Context>,
        db_manager: Box<dyn Manager + Send + Sync>,
        genesis_bytes: &[u8],
        upgrade_bytes: &[u8],
        config_bytes: &[u8],
        to_engine: Sender<Message>,
        fxs: &[Fx],
        app_sender: Box<dyn AppSender + Send + Sync>,
    ) -> Result<()>;
    async fn set_state(&self, state: State) -> Result<()>;
    async fn shutdown(&self) -> Result<()>;
    async fn version(&self) -> Result<String>;
    async fn create_static_handlers(&self) -> Result<HashMap<String, HttpHandler>>;
    async fn create_handlers(&self) -> Result<HashMap<String, HttpHandler>>;
}

// TODO: new location?
/// snow.validators.Connector
/// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/snow/validators#Connector
#[tonic::async_trait]
pub trait Connector {
    async fn connected(&self, id: &ids::node::Id) -> Result<()>;
    async fn disconnected(&self, id: &ids::node::Id) -> Result<()>;
}

/// Currently not implemented
// TODO
pub type Fx = ();