From 1a8102715a243d360e512c90777e12a4b0253887 Mon Sep 17 00:00:00 2001 From: Elias Rohrer Date: Fri, 26 Aug 2022 15:10:54 +0200 Subject: [PATCH] Initial project layout and utils --- .github/workflows/build.yml | 27 +++++ Cargo.toml | 33 ++++++ LICENSE-APACHE | 201 ++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 16 +++ LICENSE.md | 14 +++ rustfmt.toml | 5 + src/error.rs | 130 +++++++++++++++++++++++ src/hex_utils.rs | 46 +++++++++ src/logger.rs | 112 ++++++++++++++++++++ 9 files changed, 584 insertions(+) create mode 100644 .github/workflows/build.yml create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 LICENSE.md create mode 100644 rustfmt.toml create mode 100644 src/error.rs create mode 100644 src/hex_utils.rs create mode 100644 src/logger.rs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..1a70ea03f --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,27 @@ +name: Continuous Integration Checks + +on: [push, pull_request] + +jobs: + build: + strategy: + matrix: + toolchain: [ stable, beta ] + include: + - toolchain: stable + check-fmt: true + runs-on: ubuntu-latest + steps: + - name: Checkout source code + uses: actions/checkout@v2 + - name: Install Rust ${{ matrix.toolchain }} toolchain + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.toolchain }} + override: true + profile: minimal + - name: Build on Rust ${{ matrix.toolchain }} + run: cargo build --verbose --color always + - name: Check formatting + if: matrix.check-fmt + run: rustup component add rustfmt && cargo fmt --all -- --check diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 000000000..d996a65ec --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,33 @@ +[package] +name = "ldk-lite" +version = "0.1.0" +authors = ["Elias Rohrer "] +license = "MIT OR Apache-2.0" +edition = "2018" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +lightning = { version = "0.0.110", features = ["max_level_trace", "std"] } +lightning-invoice = { version = "0.18" } +lightning-net-tokio = { version = "0.0.110" } +lightning-persister = { version = "0.0.110" } +lightning-background-processor = { version = "0.0.110" } +lightning-rapid-gossip-sync = { version = "0.0.110" } + +#bdk = "0.20.0" +bdk = { git = "https://github.com/tnull/bdk", branch="feat/use-external-esplora-client", features = ["use-esplora-ureq", "key-value-db"]} +bitcoin = "0.28.1" + +rand = "0.8.5" +chrono = "0.4" +futures = "0.3" +serde_json = { version = "1.0" } +tokio = { version = "1", features = [ "io-util", "macros", "rt", "rt-multi-thread", "sync", "net", "time" ] } + + +[profile.release] +panic = "abort" + +[profile.dev] +panic = "abort" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 000000000..9d982a4d6 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,16 @@ +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..c3f44cabd --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,14 @@ +This software is licensed under [Apache 2.0](LICENSE-APACHE) or +[MIT](LICENSE-MIT), at your option. + +Some files retain their own copyright notice, however, for full authorship +information, see version control history. + +Except as otherwise noted in individual files, all files in this repository are +licensed under the Apache License, Version 2.0 or the MIT license , at your option. + +You may not use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of this software or any files in this repository except in +accordance with one or both of these licenses. diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 000000000..c00f65546 --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,5 @@ +hard_tabs = true # use tab characters for indentation, spaces for alignment +use_field_init_shorthand = true +max_width = 100 +use_small_heuristics = "Max" +fn_args_layout = "Compressed" diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 000000000..e3b34613a --- /dev/null +++ b/src/error.rs @@ -0,0 +1,130 @@ +use bdk::blockchain::esplora; +use lightning::ln::msgs; +use lightning::util::errors; +use lightning_invoice::payment; +use std::fmt; +use std::io; +use std::time; + +#[derive(Debug)] +/// An error that possibly needs to be handled by the user. +pub enum LdkLiteError { + /// Returned when trying to start LdkLite while it is already running. + AlreadyRunning, + /// Returned when trying to stop LdkLite while it is not running. + NotRunning, + /// The funding transaction could not be created. + FundingTxCreationFailed, + /// A network connection has been closed. + ConnectionFailed, + /// Payment of the given invoice has already been intiated. + NonUniquePaymentHash, + /// A given peer info could not be parsed. + PeerInfoParse(&'static str), + /// A wrapped LDK `APIError` + LdkApi(errors::APIError), + /// A wrapped LDK `DecodeError` + LdkDecode(msgs::DecodeError), + /// A wrapped LDK `PaymentError` + LdkPayment(payment::PaymentError), + /// A wrapped LDK `SignOrCreationError` + LdkInvoiceCreation(lightning_invoice::SignOrCreationError), + /// A wrapped BDK error + Bdk(bdk::Error), + /// A wrapped `EsploraError` + Esplora(esplora::EsploraError), + /// A wrapped `Bip32` error + Bip32(bitcoin::util::bip32::Error), + /// A wrapped `std::io::Error` + StdIo(io::Error), + /// A wrapped `SystemTimeError` + StdTime(time::SystemTimeError), +} + +impl fmt::Display for LdkLiteError { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match *self { + LdkLiteError::AlreadyRunning => write!(f, "LDKLite is already running."), + LdkLiteError::NotRunning => write!(f, "LDKLite is not running."), + LdkLiteError::FundingTxCreationFailed => { + write!(f, "the funding transaction could not be created") + } + LdkLiteError::ConnectionFailed => write!(f, "network connection closed"), + LdkLiteError::NonUniquePaymentHash => write!(f, "an invoice must not get payed twice."), + LdkLiteError::PeerInfoParse(ref e) => { + write!(f, "given peer info could not be parsed: {}", e) + } + LdkLiteError::LdkDecode(ref e) => write!(f, "LDK decode error: {}", e), + LdkLiteError::LdkApi(ref e) => write!(f, "LDK API error: {:?}", e), + LdkLiteError::LdkPayment(ref e) => write!(f, "LDK payment error: {:?}", e), + LdkLiteError::LdkInvoiceCreation(ref e) => { + write!(f, "LDK invoice sign or creation error: {:?}", e) + } + LdkLiteError::Bdk(ref e) => write!(f, "BDK error: {}", e), + LdkLiteError::Esplora(ref e) => write!(f, "Esplora error: {}", e), + LdkLiteError::Bip32(ref e) => write!(f, "Bitcoin error: {}", e), + LdkLiteError::StdIo(ref e) => write!(f, "IO error: {}", e), + LdkLiteError::StdTime(ref e) => write!(f, "time error: {}", e), + } + } +} + +impl From for LdkLiteError { + fn from(e: errors::APIError) -> Self { + Self::LdkApi(e) + } +} + +impl From for LdkLiteError { + fn from(e: msgs::DecodeError) -> Self { + Self::LdkDecode(e) + } +} + +impl From for LdkLiteError { + fn from(e: payment::PaymentError) -> Self { + Self::LdkPayment(e) + } +} + +impl From for LdkLiteError { + fn from(e: lightning_invoice::SignOrCreationError) -> Self { + Self::LdkInvoiceCreation(e) + } +} + +impl From for LdkLiteError { + fn from(e: bdk::Error) -> Self { + Self::Bdk(e) + } +} + +impl From for LdkLiteError { + fn from(e: bdk::sled::Error) -> Self { + Self::Bdk(bdk::Error::Sled(e)) + } +} + +impl From for LdkLiteError { + fn from(e: bitcoin::util::bip32::Error) -> Self { + Self::Bip32(e) + } +} + +impl From for LdkLiteError { + fn from(e: io::Error) -> Self { + Self::StdIo(e) + } +} + +impl From for LdkLiteError { + fn from(e: time::SystemTimeError) -> Self { + Self::StdTime(e) + } +} + +impl From for LdkLiteError { + fn from(e: esplora::EsploraError) -> Self { + Self::Esplora(e) + } +} diff --git a/src/hex_utils.rs b/src/hex_utils.rs new file mode 100644 index 000000000..e57e73511 --- /dev/null +++ b/src/hex_utils.rs @@ -0,0 +1,46 @@ +use bitcoin::secp256k1::PublicKey; +use std::fmt::Write; + +pub fn to_vec(hex: &str) -> Option> { + let mut out = Vec::with_capacity(hex.len() / 2); + + let mut b = 0; + for (idx, c) in hex.as_bytes().iter().enumerate() { + b <<= 4; + match *c { + b'A'..=b'F' => b |= c - b'A' + 10, + b'a'..=b'f' => b |= c - b'a' + 10, + b'0'..=b'9' => b |= c - b'0', + _ => return None, + } + if (idx & 1) == 1 { + out.push(b); + b = 0; + } + } + + Some(out) +} + +#[inline] +pub fn to_string(value: &[u8]) -> String { + let mut res = String::with_capacity(2 * value.len()); + for v in value { + write!(&mut res, "{:02x}", v).expect("Unable to write"); + } + res +} + +pub fn to_compressed_pubkey(hex: &str) -> Option { + if hex.len() != 33 * 2 { + return None; + } + let data = match to_vec(&hex[0..33 * 2]) { + Some(bytes) => bytes, + None => return None, + }; + match PublicKey::from_slice(&data) { + Ok(pk) => Some(pk), + Err(_) => None, + } +} diff --git a/src/logger.rs b/src/logger.rs new file mode 100644 index 000000000..317f294b4 --- /dev/null +++ b/src/logger.rs @@ -0,0 +1,112 @@ +pub(crate) use lightning::util::logger::Logger; +use lightning::util::logger::Record; +use lightning::util::ser::Writer; + +use chrono::Utc; + +use std::fs; +use std::path::Path; + +pub(crate) struct FilesystemLogger { + file_path: String, +} + +impl FilesystemLogger { + pub(crate) fn new(file_path: String) -> Self { + if let Some(parent_dir) = Path::new(&file_path).parent() { + fs::create_dir_all(parent_dir).unwrap(); + } + Self { file_path } + } +} +impl Logger for FilesystemLogger { + fn log(&self, record: &Record) { + let raw_log = record.args.to_string(); + let log = format!( + "{} {:<5} [{}:{}] {}\n", + Utc::now().format("%Y-%m-%d %H:%M:%S"), + record.level.to_string(), + record.module_path, + record.line, + raw_log + ); + fs::OpenOptions::new() + .create(true) + .append(true) + .open(self.file_path.clone()) + .unwrap() + .write_all(log.as_bytes()) + .unwrap(); + } +} + +macro_rules! log_internal { + ($logger: expr, $lvl:expr, $($arg:tt)+) => ( + $logger.log(&lightning::util::logger::Record::new($lvl, format_args!($($arg)+), module_path!(), file!(), line!())) + ); +} +pub(crate) use log_internal; + +macro_rules! log_given_level { + ($logger: expr, $lvl:expr, $($arg:tt)+) => ( + match $lvl { + #[cfg(not(any(feature = "max_level_off")))] + lightning::util::logger::Level::Error => log_internal!($logger, $lvl, $($arg)*), + #[cfg(not(any(feature = "max_level_off", feature = "max_level_error")))] + lightning::util::logger::Level::Warn => log_internal!($logger, $lvl, $($arg)*), + #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn")))] + lightning::util::logger::Level::Info => log_internal!($logger, $lvl, $($arg)*), + #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info")))] + lightning::util::logger::Level::Debug => log_internal!($logger, $lvl, $($arg)*), + #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug")))] + lightning::util::logger::Level::Trace => log_internal!($logger, $lvl, $($arg)*), + #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug", feature = "max_level_trace")))] + lightning::util::logger::Level::Gossip => log_internal!($logger, $lvl, $($arg)*), + + #[cfg(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug", feature = "max_level_trace"))] + _ => { + // The level is disabled at compile-time + }, + } + ); +} +pub(crate) use log_given_level; + +#[allow(unused_macros)] +macro_rules! log_error { + ($logger: expr, $($arg:tt)*) => ( + log_given_level!($logger, lightning::util::logger::Level::Error, $($arg)*) + ) +} +pub(crate) use log_error; + +#[allow(unused_macros)] +macro_rules! log_warn { + ($logger: expr, $($arg:tt)*) => ( + log_given_level!($logger, lightning::util::logger::Level::Warn, $($arg)*) + ) +} +pub(crate) use log_warn; + +#[allow(unused_macros)] +macro_rules! log_info { + ($logger: expr, $($arg:tt)*) => ( + log_given_level!($logger, lightning::util::logger::Level::Info, $($arg)*) + ) +} +pub(crate) use log_info; + +#[allow(unused_macros)] +macro_rules! log_debug { + ($logger: expr, $($arg:tt)*) => ( + log_given_level!($logger, lightning::util::logger::Level::Debug, $($arg)*) + ) +} + +#[allow(unused_macros)] +macro_rules! log_trace { + ($logger: expr, $($arg:tt)*) => ( + log_given_level!($logger, lightning::util::logger::Level::Trace, $($arg)*) + ) +} +pub(crate) use log_trace;