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

use num_derive::{FromPrimitive, ToPrimitive};

/// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/snow/engine/common#Message
#[derive(FromPrimitive, ToPrimitive, PartialEq, Debug)]
pub enum Message {
    /// Notifies a consensus engine that its VM has pending transactions
    /// (i.e. it would like to add a new block/vertex to consensus)
    PendingTxs = 0,

    /// Notifies the state syncer engine that the VM has finishing
    /// syncing the requested state summary.
    StateSyncDone,

    /// StopVertex notifies a consensus that it has a pending stop vertex.
    StopVertex,
}

impl Message {
    /// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/snow/engine/common#Message.String
    pub fn as_str(&self) -> &str {
        match self {
            Message::PendingTxs => "Pending Transactions",
            Message::StateSyncDone => "State Sync Done",
            Message::StopVertex => "Pending Stop Vertex",
        }
    }
}

impl TryFrom<u32> for Message {
    type Error = String;
    fn try_from(v: u32) -> Result<Self, Self::Error> {
        match v {
            x if x == Message::PendingTxs as u32 => Ok(Message::PendingTxs),
            x if x == Message::StateSyncDone as u32 => Ok(Message::StateSyncDone),
            x if x == Message::StopVertex as u32 => Ok(Message::StopVertex),
            _ => Err("invalid message enum".to_string()),
        }
    }
}

#[test]
fn test_message() {
    let m = Message::try_from(0).unwrap();
    assert_eq!(m, Message::PendingTxs);
    assert!(m.as_str().contains("Pending Transactions"));

    assert!(Message::try_from(5).is_err());
}