Merge pull request #128 from LNP-BP/v0.1

v0.1 release candidate

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lnpbp"
-version = "0.1.0"
+version = "0.1.0-rc.1"
 license = "MIT"
 authors = ["Dr. Maxim Orlovsky <orlovsky@pandoracore.com>"]
 description = "LNP/BP Core Library implementing LNPBP specifications & standards"
@@ -40,9 +40,8 @@ lnpbp_derive = { path = "derive" }
 # ----------------------------------------------------
 bitcoin = "~0.25.0"
 bitcoin_hashes = "~0.9.0" # we need macro from here
-lightning = { version = "~0.0.11", optional = true }
-miniscript = "~2.0.0" # TODO: (new) Upgrade to 2.0.0 (requires rebasing
-                      #       `develop` branch in miniscript fork
+# lightning = { version = "~0.0.11", optional = true }
+miniscript = "~2.0.0"
 bech32 = "~0.7.2"
 #   Used only as a part of RGB for encoding Ed25519 key data (for instance as
 #   a part of Tor address)
@@ -82,11 +81,11 @@ num-derive = "~0.3.0"
 # 3. Once async traits will get to rust compiler, this one will be also not
 #    needed
 async-trait = { version = "~0.1.30", optional = true }
+torut = { version = "~0.1.6", features = ["v2", "v3"] }
 
 [dev-dependencies]
 miniscript = { version = "~2.0.0", features = ["compiler"] }
-bitcoin = { version = "~0.25.0", branch = "develop", features = ["rand"] }
-torut = { version = "~0.1.6", features = ["v2", "v3"] }
+bitcoin = { version = "~0.25.0", features = ["rand"] }
 
 # Forked dependencies
 # -------------------
@@ -102,11 +101,12 @@ torut = { version = "~0.1.6", features = ["v2", "v3"] }
 # NB: These patches MUST be applied in exactly same manner by any library which
 #     uses this as a dependency
 [patch.crates-io]
-bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop" }
-bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-beta-4" }
-lightning = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
-# No changes here, just need to import forked `bitcoin` library
-miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop" }
+# We need this b/c of breaking change in tagged hash type generation
+bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-rc1" }
+bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", tag = "lnpbp-v0.1.0-rc1" }
+# We need custom branches here just to depend on the same bitcoin master and do
+# not have secp256k1 version conflict
+miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", tag = "lnpbp-v0.1.0-rc1" }
 
 # Features
 # ========
@@ -126,7 +126,7 @@ all = [
        "tor", "url", "websockets", "vendored_openssl"]
 # High-level library components
 # -----------------------------
-lnp = ["lightning", "async", "zmq"]
+lnp = ["async", "zmq"]
 rgb = ["bulletproofs", "ed25519-dalek", "deflate", "inflate"]
 # Exposing core rust componens
 # ----------------------------
@@ -145,6 +145,6 @@ tor = ["amplify/tor"] # Exposes dependency feature
 vendored_openssl = ["torut/vendored_openssl"]
 
 [workspace]
-members = ["derive", "."]
-default-members = ["derive", "."]
+members = [".", "derive"]
+default-members = [".", "derive"]
 exclude = ["dep_test"]

README.md

@@ -141,14 +141,12 @@ section:
 ```toml
 lnpbp = { git = "https://github.com/lnp-bp/rust-lnpbp.git", branch = "master" }
 
-[patch.crates-io]
-bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop" }
-bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-beta-4" }
-lightning = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
-miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop" }
-# TODO: (new) remove them before 1.0 release
-amplify = { git = "https://github.com/LNP-BP/rust-amplify", branch = "develop" }
-torut = { git = "https://github.com/LNP-BP/torut", branch = "develop" }
+# We need this b/c of breaking change in tagged hash type generation
+bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-rc1" }
+bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", tag = "lnpbp-v0.1.0-rc1" }
+# We need custom branches here just to depend on the same bitcoin master and do
+# not have secp256k1 version conflict
+miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", tag = "lnpbp-v0.1.0-rc1" }
 ```
 NB: These patches MUST be applied in exactly same manner by any library which
 uses LNP/BP Core library as a dependency for now

contrib/depCargo.toml

@@ -3,12 +3,11 @@
 lnpbp = { path = "..", features = ["all"] }
 
 [patch.crates-io]
-bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop" }
-bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-beta-4" }
-lightning = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
-miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop" }
-# TODO: (new) remove them before 1.0 release
-amplify = { git = "https://github.com/LNP-BP/rust-amplify", branch = "develop" }
-torut = { git = "https://github.com/LNP-BP/torut", branch = "develop" }
+# We need this b/c of breaking change in tagged hash type generation
+bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-rc1" }
+bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", tag = "lnpbp-v0.1.0-rc1" }
+# We need custom branches here just to depend on the same bitcoin master and do
+# not have secp256k1 version conflict
+miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", tag = "lnpbp-v0.1.0-rc1" }
 
 [workspace]

derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lnpbp_derive"
-version = "0.1.0"
+version = "0.1.0-rc.1"
 license = "MIT"
 authors = ["Dr. Maxim Orlovsky <orlovsky@pandoracore.com>"]
 description = "LNP/BP Core Library derive macros"

src/lnp/application/peer.rs

@@ -47,6 +47,16 @@ pub struct PeerOutput {
 }
 
 impl Peer {
+    #[cfg(feature = "lightning")]
+    pub async fn new_outbound(
+        node: NodeAddr,
+        private_key: &secp256k1::SecretKey,
+        ephemeral_private_key: &secp256k1::SecretKey,
+    ) -> Result<Self, ConnectionError> {
+        unimplemented!()
+    }
+
+    #[cfg(not(feature = "lightning"))]
     pub async fn new_outbound(
         node: NodeAddr,
         private_key: &secp256k1::SecretKey,

src/lnp/mod.rs

@@ -29,6 +29,6 @@ pub use session::{
 };
 pub use transport::{tcp, tor, websocket, zmq};
 
-pub use lightning::ln::peers::encryption::LN_MAX_MSG_LEN as LNP_MSG_MAX_LEN;
+pub const LNP_MSG_MAX_LEN: usize = u64::MAX as usize;
 
 pub const LIGHTNING_P2P_DEFAULT_PORT: u16 = 9735;

src/lnp/presentation/error.rs

@@ -12,10 +12,13 @@
 // If not, see <https://opensource.org/licenses/MIT>.
 
 use crate::strict_encoding;
+
+#[cfg(feature = "lightning")]
 use lightning::ln::msgs::DecodeError;
 
 #[derive(Clone, PartialEq, Eq, Debug, Display, Error, From)]
 #[display(Debug)]
+#[non_exhaustive]
 pub enum Error {
     #[from(std::io::Error)]
     Io,
@@ -35,6 +38,7 @@ pub enum Error {
     TlvRecordInvalidLen,
 }
 
+#[cfg(feature = "lightning")]
 impl From<DecodeError> for Error {
     fn from(err: DecodeError) -> Self {
         match err {

src/lnp/presentation/message.rs

@@ -24,7 +24,6 @@ use super::tlv;
 use super::{
     Encode, Error, EvenOdd, UnknownTypeError, Unmarshall, UnmarshallFn,
 };
-use crate::lnp::presentation::tlv::Stream;
 use crate::strict_encoding::{StrictDecode, StrictEncode};
 
 wrapper!(
@@ -80,8 +79,8 @@ impl Message for RawMessage {
         Payload(vec![Arc::new(self.payload.clone())])
     }
 
-    fn get_tlvs(&self) -> Stream {
-        Stream::new()
+    fn get_tlvs(&self) -> tlv::Stream {
+        tlv::Stream::new()
     }
 }
 

src/lnp/presentation/tlv.rs

@@ -17,11 +17,13 @@ use std::collections::BTreeMap;
 use std::io;
 use std::sync::Arc;
 
-use lightning::util::ser::{BigSize, Readable};
+#[cfg(feature = "lightning")]
+use lightning::{
+    ln::msgs::DecodeError,
+    util::ser::{BigSize, Readable},
+};
 
 use super::{Error, EvenOdd, Unmarshall, UnmarshallFn};
-use crate::lnp::LNP_MSG_MAX_LEN;
-use lightning::ln::msgs::DecodeError;
 
 wrapper!(
     Type,
@@ -73,6 +75,17 @@ impl Unmarshall for Unmarshaller {
     type Data = Stream;
     type Error = Error;
 
+    // TODO: (v0.2.0) Right now TLV implementation uses BigInt from lightning
+    //       library. It has to be re-implemented in order to get TLVs working
+    #[cfg(not(feature = "lightning"))]
+    fn unmarshall(
+        &self,
+        data: &dyn Borrow<[u8]>,
+    ) -> Result<Stream, Self::Error> {
+        unimplemented!()
+    }
+
+    #[cfg(feature = "lightning")]
     fn unmarshall(
         &self,
         data: &dyn Borrow<[u8]>,
@@ -151,6 +164,14 @@ impl Unmarshaller {
         }
     }
 
+    // TODO: (v0.2.0) Right now TLV implementation uses BigInt from lightning
+    //       library. It has to be re-implemented in order to get TLVs working
+    #[cfg(not(feature = "lightning"))]
+    fn raw_parser(reader: &mut dyn io::Read) -> Result<Arc<dyn Any>, Error> {
+        unimplemented!()
+    }
+
+    #[cfg(feature = "lightning")]
     fn raw_parser(
         mut reader: &mut dyn io::Read,
     ) -> Result<Arc<dyn Any>, Error> {

src/lnp/session/connection.rs

@@ -11,33 +11,27 @@
 // along with this software.
 // If not, see <https://opensource.org/licenses/MIT>.
 
-use std::convert::TryInto;
 use std::io;
-use std::net::SocketAddr;
 
-#[cfg(feature = "tokio")]
+#[cfg(all(feature = "tokio", feature = "lightning"))]
 use tokio::io::AsyncReadExt;
-#[cfg(feature = "tokio")]
+#[cfg(all(feature = "tokio", feature = "lightning"))]
 use tokio::io::AsyncWriteExt;
-#[cfg(feature = "tokio")]
+#[cfg(all(feature = "tokio"))]
 use tokio::net::{tcp, TcpStream};
 
 #[cfg(not(feature = "tokio"))]
 use std::io::{Read as IoRead, Write as IoWrite};
 #[cfg(not(feature = "tokio"))]
 use std::net::TcpStream;
 
-use bitcoin::secp256k1;
-
-#[cfg(feature = "tokio")]
+#[cfg(all(feature = "tokio", feature = "lightning"))]
 use lightning::ln::peers::encryption::{Decryptor, Encryptor};
-use lightning::ln::peers::handshake::CompletedHandshakeInfo as Transcoder;
-use lightning::ln::peers::handshake::PeerHandshake;
-use lightning::ln::peers::transport::IPeerHandshake;
-
-use super::NodeAddr;
-use super::MAX_TRANSPORT_FRAME_SIZE;
-//use crate::lnp::transport::{Read, Write};
+#[cfg(feature = "lightning")]
+use lightning::ln::peers::{
+    handshake::{CompletedHandshakeInfo as Transcoder, PeerHandshake},
+    transport::IPeerHandshake,
+};
 
 #[derive(Debug, Display)]
 #[display(Debug)]
@@ -56,25 +50,28 @@ impl From<io::Error> for ConnectionError {
 pub struct Connection {
     pub stream: TcpStream,
     pub outbound: bool,
-    #[allow(dead_code)]
+    #[cfg(feature = "lightning")]
     transcoder: Transcoder,
 }
 
 #[cfg(feature = "tokio")]
 pub struct ConnectionInput {
     pub istream: tcp::OwnedReadHalf,
     pub outbound: bool,
+    #[cfg(feature = "lightning")]
     pub decryptor: Decryptor,
 }
 
 #[cfg(feature = "tokio")]
 pub struct ConnectionOutput {
     pub ostream: tcp::OwnedWriteHalf,
     pub outbound: bool,
+    #[cfg(feature = "lightning")]
     pub encryptor: Encryptor,
 }
 
 impl Connection {
+    #[cfg(feature = "lightning")]
     pub async fn new(
         node: &NodeAddr,
         private_key: &secp256k1::SecretKey,
@@ -183,11 +180,13 @@ impl Connection {
             ConnectionInput {
                 istream,
                 outbound: self.outbound,
+                #[cfg(feature = "lightning")]
                 decryptor: self.transcoder.decryptor,
             },
             ConnectionOutput {
                 ostream,
                 outbound: self.outbound,
+                #[cfg(feature = "lightning")]
                 encryptor: self.transcoder.encryptor,
             },
         )