lnp2p 0.9.2

LN P2P Library: rust implementation of lightning network peer protocols (BOLT and Bifrost)
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

// LNP P2P library, plmeneting both bolt (BOLT) and Bifrost P2P messaging
// system for Lightning network protocol (LNP)
//
// Written in 2020-2021 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::io;

use strict_encoding::{StrictDecode, StrictEncode};

pub const BIFROST_APP_STORM: u16 = 0x0001;
pub const BIFROST_APP_VENDOR_MASK: u16 = 0x8000;

/// Bifrost application identifier.
///
/// Range up to `0..0x8000` is reserved for applications registered as
/// LNPBP standards. Range `0x8000-0xFFFF` (custom user range) can be used
/// by any application without registration.
///
/// It is strongly advised to use random numbers from custom user range;
/// for instance by taking first two bytes of the SHA256 hash of the
/// application name or developer domain name and do a binary OR operation
/// with `0x8000`.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
pub enum BifrostApp {
    /// Storm: storage and messaging over the lightning.
    #[display("storm")]
    Storm,

    /// Future applications. Numbers are reserved for LNPBP standardized apps.
    #[display("future({0:#06})")]
    Future(u16),

    /// Vendor-specific applications which does not standardized by LNP/BP
    /// Standards Association.
    #[display("vendor({0:#06})")]
    Vendor(u16),
}

impl BifrostApp {
    pub fn app_code(self) -> u16 {
        match self {
            BifrostApp::Storm => BIFROST_APP_STORM,
            BifrostApp::Future(app) => app,
            BifrostApp::Vendor(vendor) => vendor,
        }
    }
}

impl StrictEncode for BifrostApp {
    fn strict_encode<E: io::Write>(
        &self,
        e: E,
    ) -> Result<usize, strict_encoding::Error> {
        self.app_code().strict_encode(e)
    }
}

impl StrictDecode for BifrostApp {
    fn strict_decode<D: io::Read>(
        d: D,
    ) -> Result<Self, strict_encoding::Error> {
        u16::strict_decode(d).map(BifrostApp::from)
    }
}

impl From<BifrostApp> for u16 {
    fn from(app: BifrostApp) -> Self {
        app.app_code()
    }
}

impl From<u16> for BifrostApp {
    fn from(code: u16) -> Self {
        match code {
            BIFROST_APP_STORM => BifrostApp::Storm,
            vendor if vendor & BIFROST_APP_VENDOR_MASK > 0 => {
                BifrostApp::Vendor(vendor)
            }
            future => BifrostApp::Future(future),
        }
    }
}