lnp-core 0.9.2

LNP Core Library: rust implementation of modular lightning channels architecture
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

// LNP/BP Core Library implementing LNPBP specifications & standards
// Written in 2019 by
//     Dr. Maxim Orlovsky <orlovsky@pandoracore.com>
//
// To the extent possible under law, the author(s) have dedicated all
// copyright and related and neighboring rights to this software to
// the public domain worldwide. This software is distributed without
// any warranty.
//
// You should have received a copy of the MIT License
// along with this software.
// If not, see <https://opensource.org/licenses/MIT>.

use amplify::Slice32;
use internet2::addr::NodeId;
use p2p::bolt::{ChannelFeatures, ChannelId, ShortChannelId};

#[derive(Clone, Copy, Eq, PartialEq, Hash, Debug)]
#[derive(StrictEncode, StrictDecode)]
pub struct DirectionalInfo {
    /// Time stamp
    pub timestamp: u32,

    /// message flags
    // TODO: Introduce a dedicated data type
    pub message_flags: u8,

    /// channel flags
    // TODO: Introduce a dedicated data type
    pub channel_flags: u8,

    /// CLTV expiry delta
    pub cltv_expiry_delta: u16,

    /// minimum HTLC in msat
    pub htlc_minimum_msat: u64,

    /// base fee in msat
    pub fee_base_msat: u32,

    /// fee proportional millionth
    pub fee_proportional_millionths: u32,

    /// Used only if `option_channel_htlc_max` in `message_flags` is set
    pub htlc_maximum_msat: u64,
}

/// Information about channel used for route construction and re-broadcasting
/// gossip messages.
#[derive(Clone, Copy, Eq, PartialEq, Hash, Debug, Display)]
#[derive(StrictEncode, StrictDecode)]
#[display("{short_channel_id}")]
pub struct GossipChannelInfo {
    /// Node identities constituting channel
    pub nodes: (NodeId, NodeId),

    /// Chainhash
    pub chain_hash: Slice32,

    /// Short Channel Id
    pub short_channel_id: ShortChannelId,

    /// Information about each channel direction.
    ///
    /// The first tuple field corresponds to the direction from the first
    /// node id (see [`GossipChannelInfo::nodes`]) to the second one – and the
    /// second tuple field to the opposite direction.
    pub directions: (Option<DirectionalInfo>, Option<DirectionalInfo>),

    /// The channel capacity, known only for local channels - or if it can be
    /// deduced from on-chain data, if they are available
    pub capacity_sats: Option<u64>,

    /// Channel features
    pub features: ChannelFeatures,
}

/// Information about channel used for route construction and re-broadcasting
/// gossip messages.
#[derive(Clone, Copy, Eq, PartialEq, Hash, Debug, Display)]
#[derive(StrictEncode, StrictDecode)]
#[display("{channel_id}@{remote_node}")]
pub struct LocalChannelInfo {
    /// Other node identity
    pub remote_node: NodeId,

    /// Full channel id
    pub channel_id: ChannelId,

    /// Short Channel Id
    pub short_channel_id: ShortChannelId,

    /// Chainhash
    pub chain_hash: Slice32,

    pub inbound_capacity_msat: u64,

    pub outbound_capacity_msat: u64,

    /// CLTV expiry delta
    pub cltv_expiry: u16,

    /// minimum HTLC in msat
    pub htlc_minimum_msat: u64,

    /// maximum HTLC in msat
    pub htlc_maximum_msat: u64,
}