Merge pull request #894 from johncantrell97/lightning-liquidity

Add LSPS support via `lightning-liquidity` crate

Author: AnthonyRonning

Cargo.lock

@@ -32,6 +32,7 @@ lightning-invoice = { version = "0.26.0", features = ["serde"] }
 lightning-rapid-gossip-sync = { version = "0.0.118" }
 lightning-background-processor = { version = "0.0.118", features = ["futures"] }
 lightning-transaction-sync = { version = "0.0.118", features = ["esplora-async-https"] }
+lightning-liquidity = { git = "https://github.com/lightningdevkit/lightning-liquidity.git", rev = "e00d917a8bb17e29493497538c7a4dda00bef151" }
 chrono = "0.4.22"
 futures-util = { version = "0.3", default-features = false }
 reqwest = { version = "0.11", default-features = false, features = ["json"] }

mutiny-core/Cargo.toml

@@ -69,6 +69,9 @@ pub enum MutinyError {
     /// LSP indicated it was not connected to the client node.
     #[error("Failed to have a connection to the LSP node.")]
     LspConnectionError,
+    /// LSP required an invoice and none was provided.
+    #[error("Failed to provide an invoice to the LSP.")]
+    LspInvoiceRequired,
     /// Subscription Client Not Configured
     #[error("Subscription Client Not Configured")]
     SubscriptionClientNotConfigured,

mutiny-core/src/error.rs

@@ -2,6 +2,7 @@ use crate::fees::MutinyFeeEstimator;
 use crate::keymanager::PhantomKeysManager;
 use crate::ldkstorage::{MutinyNodePersister, PhantomChannelManager};
 use crate::logging::MutinyLogger;
+use crate::lsp::{AnyLsp, Lsp};
 use crate::node::BumpTxEventHandler;
 use crate::nodemanager::ChannelClosure;
 use crate::onchain::OnChainWallet;
@@ -85,7 +86,7 @@ pub struct EventHandler<S: MutinyStorage> {
     keys_manager: Arc<PhantomKeysManager<S>>,
     persister: Arc<MutinyNodePersister<S>>,
     bump_tx_event_handler: Arc<BumpTxEventHandler<S>>,
-    lsp_client_pubkey: Option<PublicKey>,
+    lsp_client: Option<AnyLsp<S>>,
     logger: Arc<MutinyLogger>,
 }
 
@@ -98,15 +99,15 @@ impl<S: MutinyStorage> EventHandler<S> {
         keys_manager: Arc<PhantomKeysManager<S>>,
         persister: Arc<MutinyNodePersister<S>>,
         bump_tx_event_handler: Arc<BumpTxEventHandler<S>>,
-        lsp_client_pubkey: Option<PublicKey>,
+        lsp_client: Option<AnyLsp<S>>,
         logger: Arc<MutinyLogger>,
     ) -> Self {
         Self {
             channel_manager,
             fee_estimator,
             wallet,
             keys_manager,
-            lsp_client_pubkey,
+            lsp_client,
             persister,
             bump_tx_event_handler,
             logger,
@@ -224,10 +225,24 @@ impl<S: MutinyStorage> EventHandler<S> {
                 payment_hash,
                 purpose,
                 amount_msat,
+                counterparty_skimmed_fee_msat,
                 ..
             } => {
                 log_debug!(self.logger, "EVENT: PaymentReceived received payment from payment hash {} of {amount_msat} millisatoshis to {receiver_node_id:?}", payment_hash.0.to_hex());
 
+                let expected_skimmed_fee_msat = self
+                    .lsp_client
+                    .as_ref()
+                    .map(|lsp_client| {
+                        lsp_client.get_expected_skimmed_fee_msat(payment_hash, amount_msat)
+                    })
+                    .unwrap_or(0);
+
+                if counterparty_skimmed_fee_msat > expected_skimmed_fee_msat {
+                    log_error!(self.logger, "ERROR: Payment with hash {} skimmed a fee of {} millisatoshis when we expected a fee of {} millisatoshis", payment_hash, counterparty_skimmed_fee_msat, expected_skimmed_fee_msat);
+                    return;
+                }
+
                 if let Some(payment_preimage) = match purpose {
                     PaymentPurpose::InvoicePayment {
                         payment_preimage, ..
@@ -376,7 +391,12 @@ impl<S: MutinyStorage> EventHandler<S> {
                     Err(e) => log_debug!(self.logger, "EVENT: OpenChannelRequest error: {e:?}"),
                 };
 
-                if self.lsp_client_pubkey.as_ref() != Some(&counterparty_node_id) {
+                let lsp_pubkey = self
+                    .lsp_client
+                    .as_ref()
+                    .map(|client| client.get_lsp_pubkey());
+
+                if lsp_pubkey.as_ref() != Some(&counterparty_node_id) {
                     // did not match the lsp pubkey, normal open
                     let result = self.channel_manager.accept_inbound_channel(
                         &temporary_channel_id,

mutiny-core/src/event.rs

@@ -9,7 +9,7 @@ use bitcoin::bech32::u5;
 use bitcoin::secp256k1::ecdh::SharedSecret;
 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
 use bitcoin::secp256k1::ecdsa::Signature;
-use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, Signing};
+use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, Signing};
 use bitcoin::util::bip32::{ChildNumber, DerivationPath, ExtendedPrivKey};
 use bitcoin::{PackedLockTime, Script, Transaction, TxOut};
 use lightning::ln::msgs::{DecodeError, UnsignedGossipMessage};
@@ -53,6 +53,10 @@ impl<S: MutinyStorage> PhantomKeysManager<S> {
         }
     }
 
+    pub(crate) fn get_node_secret_key(&self) -> SecretKey {
+        self.inner.get_node_secret_key()
+    }
+
     /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
     pub fn spend_spendable_outputs<C: Signing>(
         &self,

mutiny-core/src/keymanager.rs

@@ -21,7 +21,8 @@ pub mod labels;
 mod ldkstorage;
 pub mod lnurlauth;
 pub mod logging;
-mod lspclient;
+mod lsp;
+mod messagehandler;
 mod networking;
 mod node;
 pub mod nodemanager;
@@ -79,6 +80,8 @@ pub struct MutinyWalletConfig {
     user_esplora_url: Option<String>,
     user_rgs_url: Option<String>,
     lsp_url: Option<String>,
+    lsp_connection_string: Option<String>,
+    lsp_token: Option<String>,
     auth_client: Option<Arc<MutinyAuthClient>>,
     subscription_url: Option<String>,
     scorer_url: Option<String>,
@@ -97,6 +100,8 @@ impl MutinyWalletConfig {
         user_esplora_url: Option<String>,
         user_rgs_url: Option<String>,
         lsp_url: Option<String>,
+        lsp_connection_string: Option<String>,
+        lsp_token: Option<String>,
         auth_client: Option<Arc<MutinyAuthClient>>,
         subscription_url: Option<String>,
         scorer_url: Option<String>,
@@ -112,6 +117,8 @@ impl MutinyWalletConfig {
             user_rgs_url,
             scorer_url,
             lsp_url,
+            lsp_connection_string,
+            lsp_token,
             auth_client,
             subscription_url,
             do_not_connect_peers: false,
@@ -695,6 +702,8 @@ mod tests {
             None,
             None,
             None,
+            None,
+            None,
             false,
             true,
         );
@@ -726,6 +735,8 @@ mod tests {
             None,
             None,
             None,
+            None,
+            None,
             false,
             true,
         );
@@ -763,6 +774,8 @@ mod tests {
             None,
             None,
             None,
+            None,
+            None,
             false,
             true,
         );
@@ -801,6 +814,8 @@ mod tests {
             None,
             None,
             None,
+            None,
+            None,
             false,
             true,
         );
@@ -827,6 +842,8 @@ mod tests {
             None,
             None,
             None,
+            None,
+            None,
             false,
             true,
         );