hopr-api 1.10.0

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
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
57
58
59

/// An enum representing the current state of the HOPR node.
///
/// The states represent granular steps in the node initialization and lifecycle,
/// providing detailed progress information suitable for UI applications.
#[atomic_enum::atomic_enum]
#[derive(PartialEq, Eq, strum::Display, strum::EnumIter)]
pub enum HoprState {
    /// Node instance created but not yet started
    #[strum(to_string = "Node is not yet initialized")]
    Uninitialized = 0,

    /// Waiting for the node wallet to receive initial funding
    #[strum(to_string = "Waiting for initial wallet funding")]
    WaitingForFunds = 1,

    /// Verifying the wallet has sufficient balance to operate
    #[strum(to_string = "Verifying wallet balance")]
    CheckingBalance = 2,

    /// Validating network parameters like ticket price and winning probability
    #[strum(to_string = "Validating network configuration")]
    ValidatingNetworkConfig = 3,

    /// Subscribing to on-chain account announcements
    #[strum(to_string = "Checking onchain address")]
    CheckingOnchainAddress = 4,

    /// Registering the Safe contract with this node
    #[strum(to_string = "Registering Safe contract")]
    RegisteringSafe = 5,

    /// Announcing node multiaddresses on the blockchain
    #[strum(to_string = "Announcing node on chain")]
    AnnouncingNode = 6,

    /// Waiting for the node's key binding to appear on-chain
    #[strum(to_string = "Waiting for on-chain key binding confirmation")]
    AwaitingKeyBinding = 7,

    /// Initializing internal services (sessions, tickets, transport, channels)
    #[strum(to_string = "Initializing internal services")]
    InitializingServices = 8,

    /// Node is fully operational and ready for use
    #[strum(to_string = "Node is running")]
    Running = 9,

    /// Node has been shut down
    #[strum(to_string = "Node has been terminated")]
    Terminated = 10,

    /// One or more components are degraded but the node is still operational
    #[strum(to_string = "Node is running in degraded state")]
    Degraded = 11,

    /// One or more components are unavailable, node cannot function properly
    #[strum(to_string = "Node has failed")]
    Failed = 12,
}