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 std::fmt::{self, Display, Formatter};
use std::str::FromStr;

use internet2::addr::{
    AddrParseError, NodeAddr, NodeAddrParseError, PartialNodeAddr,
};
#[cfg(feature = "bifrost")]
use p2p::bifrost::LNP2P_BIFROST_PORT;
#[cfg(feature = "bolt")]
use p2p::bolt::LNP2P_BOLT_PORT;
use p2p::Protocol;

/// LNP node address containing both node address and the used protocol.
/// When parsed from string or displayed, it may omit port information and use
/// the protocol default port.
#[derive(Copy, Clone, PartialEq, Eq, Ord, PartialOrd, Hash, Debug)]
#[derive(NetworkEncode, NetworkDecode)]
pub struct LnpAddr {
    /// Protocol used for connection.
    pub protocol: Protocol,

    /// Remote peer address for connecting to.
    pub node_addr: NodeAddr,
}

impl LnpAddr {
    #[cfg(feature = "bolt")]
    /// Construct BOLT-compatible node address.
    pub fn bolt(addr: PartialNodeAddr) -> LnpAddr {
        LnpAddr {
            protocol: Protocol::Bolt,
            node_addr: addr.node_addr(LNP2P_BOLT_PORT),
        }
    }

    #[cfg(feature = "bifrost")]
    /// Construct Bifrost-compatible node address.
    pub fn bifrost(addr: PartialNodeAddr) -> LnpAddr {
        LnpAddr {
            protocol: Protocol::Bifrost,
            node_addr: addr.node_addr(LNP2P_BIFROST_PORT),
        }
    }

    /// Returns used port address.
    pub fn port(self) -> u16 {
        self.node_addr
            .addr
            .port()
            .expect("port information always present in NodeAddr")
    }
}

impl Display for LnpAddr {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}://{}@{}",
            self.protocol,
            self.node_addr.id,
            self.node_addr.addr.address()
        )?;
        if self.protocol.default_port() != self.port() {
            write!(f, ":{}", self.port())?;
        }
        Ok(())
    }
}

impl FromStr for LnpAddr {
    type Err = NodeAddrParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut split = s.split("://");
        match (
            split.next().map(str::to_lowercase).as_deref(),
            split.next(),
            split.next(),
        ) {
            #[cfg(feature = "bolt")]
            (Some("bolt"), Some(addr), None) => {
                PartialNodeAddr::from_str(addr).map(LnpAddr::bolt)
            }
            #[cfg(feature = "bifrost")]
            (Some("bifrost"), Some(addr), None) => {
                PartialNodeAddr::from_str(addr).map(LnpAddr::bifrost)
            }
            (Some(unknown), ..) => {
                Err(AddrParseError::UnknownProtocolError(unknown.to_owned())
                    .into())
            }
            _ => Err(AddrParseError::WrongAddrFormat(s.to_owned()).into()),
        }
    }
}