Update LDK past v0.0.112 to include Future patch

- `0.0.112` introduced a bug where calls to
  `get_persistable_update_future` always return a `Future` which is
  `Ready`.
- After some back-and-forth with Matt, the bug was resolved in
  lightningdevkit/rust-lightning#1851
- Although 1851 hasn't been merged yet, I went ahead and picked the
  changes into the `lexe-v0.0.112-with-fix` branch of our LDK fork, and
  changed the workspace root `Cargo.toml`s to use this patch.
- One extra perk is that we now have early access to the `ChannelReady`
  event which is set to be released with `0.0.113`.
- Once `0.0.113` is released, we should switch back to using the
  crates.io version of LDK.

Author: MaxFangX

Cargo.lock

@@ -23,6 +23,15 @@ sgx-isa = { git = "https://github.com/lexe-tech/rust-sgx", branch = "lexe" }
 sgxs-loaders = { git = "https://github.com/lexe-tech/rust-sgx", branch = "lexe" }
 tokio = { git = "https://github.com/lexe-tech/tokio",  branch = "tokio-sgx-1.21.2" }
 
+# 0.0.112 introduced a bug which breaks our integration tests. The fix is
+# implemented in https://github.com/lightningdevkit/rust-lightning/pull/1851.
+# In the meantime, we have to use a git dependency until 0.0.113 is released.
+# TODO(max): Comment this section out once 0.0.113 is released
+lightning = { git = "https://github.com/lexe-tech/rust-lightning", branch = "lexe-v0.0.112-with-fix" }
+lightning-block-sync = { git = "https://github.com/lexe-tech/rust-lightning", branch = "lexe-v0.0.112-with-fix" }
+lightning-invoice = { git = "https://github.com/lexe-tech/rust-lightning", branch = "lexe-v0.0.112-with-fix" }
+lightning-net-tokio = { git = "https://github.com/lexe-tech/rust-lightning", branch = "lexe-v0.0.112-with-fix" }
+
 # For debugging LDK or testing patches during local development
 # lightning = { path = "../ldk/lightning", features = ["max_level_trace"]}
 # lightning-block-sync = { path = "../ldk/lightning-block-sync", features = [ "rpc-client" ] }

Cargo.toml

@@ -19,10 +19,10 @@ base64 = "0.13.0"
 
 # --- LIGHTNING --- #
 
-lightning = { version = "0.0.111", features = ["max_level_trace"] }
-# lightning-block-sync = { version = "0.0.111", features = [ "rpc-client" ] }
-lightning-invoice = { version = "0.19" }
-# lightning-net-tokio = { version = "0.0.111" }
+lightning = { version = "0.0.112", features = ["max_level_trace"] }
+# lightning-block-sync = { version = "0.0.112", features = [ "rpc-client" ] }
+lightning-invoice = { version = "0.20" }
+# lightning-net-tokio = { version = "0.0.112" }
 
 # lightning = { git = "https://github.com/lexe-tech/rust-lightning", features = ["max_level_trace"], branch = "main" }
 # lightning-block-sync = { git = "https://github.com/lexe-tech/rust-lightning", features = [ "rpc-client" ], branch = "main" }

common/Cargo.toml

@@ -26,10 +26,10 @@ base64 = "0.13.0"
 
 # --- LIGHTNING --- #
 
-lightning = { version = "0.0.111", features = ["max_level_trace"] }
-lightning-block-sync = { version = "0.0.111", features = [ "rpc-client" ] }
-lightning-invoice = { version = "0.19" }
-lightning-net-tokio = { version = "0.0.111" }
+lightning = { version = "0.0.112", features = ["max_level_trace"] }
+lightning-block-sync = { version = "0.0.112", features = [ "rpc-client" ] }
+lightning-invoice = { version = "0.20" }
+lightning-net-tokio = { version = "0.0.112" }
 
 # lightning = { git = "https://github.com/lexe-tech/rust-lightning", features = # ["max_level_trace"], branch = "main" }
 # lightning-block-sync = { git = "https://github.com/lexe-tech/rust-lightning", # features = [ "rpc-client" ], branch = "main" }

lexe-ln/Cargo.toml

@@ -49,7 +49,6 @@ pub type P2PGossipSyncType = P2PGossipSync<
 >;
 
 pub type LexeChannelManagerType<PERSISTER> = ChannelManager<
-    SignerType,
     Arc<LexeChainMonitorType<PERSISTER>>,
     Arc<BroadcasterType>,
     LexeKeysManager,
@@ -61,7 +60,7 @@ pub type ProbabilisticScorerType =
     ProbabilisticScorer<Arc<NetworkGraphType>, LexeTracingLogger>;
 
 pub type OnionMessengerType =
-    OnionMessenger<SignerType, LexeKeysManager, LexeTracingLogger>;
+    OnionMessenger<LexeKeysManager, LexeTracingLogger, IgnoringMessageHandler>;
 
 pub type LexePeerManagerType<CHANNEL_MANAGER> = PeerManager<
     SocketDescriptor,
@@ -74,17 +73,16 @@ pub type LexePeerManagerType<CHANNEL_MANAGER> = PeerManager<
 
 pub type PaymentInfoStorageType = Arc<Mutex<HashMap<PaymentHash, PaymentInfo>>>;
 
-pub type RouterType = DefaultRouter<Arc<NetworkGraphType>, LexeTracingLogger>;
-
-// TODO(max): Expand this further to InvoicePayerUsingTime?
-pub type LexeInvoicePayerType<CHANNEL_MANAGER, EVENT_HANDLER> = InvoicePayer<
-    CHANNEL_MANAGER,
-    RouterType,
-    Arc<Mutex<ProbabilisticScorerType>>,
+pub type RouterType = DefaultRouter<
+    Arc<NetworkGraphType>,
     LexeTracingLogger,
-    EVENT_HANDLER,
+    Arc<Mutex<ProbabilisticScorerType>>,
 >;
 
+// TODO(max): Expand this further to InvoicePayerUsingTime?
+pub type LexeInvoicePayerType<CHANNEL_MANAGER, EVENT_HANDLER> =
+    InvoicePayer<CHANNEL_MANAGER, RouterType, LexeTracingLogger, EVENT_HANDLER>;
+
 /// This is the tuple that LDK impl'd `Listen` for
 pub type ChannelMonitorListenerType = (
     ChannelMonitorType,

lexe-ln/src/alias.rs

@@ -92,7 +92,7 @@ impl LexeBackgroundProcessor {
                     _ = ng_timer.tick() => {
                         debug!("Pruning and persisting network graph");
                         let network_graph = gossip_sync.network_graph();
-                        network_graph.remove_stale_channels();
+                        network_graph.remove_stale_channels_and_tracking();
                         let persist_res = persister
                             .persist_graph(network_graph)
                             .await;

lexe-ln/src/background_processor.rs

@@ -5,7 +5,6 @@ use std::sync::Arc;
 use std::time::Duration;
 
 use anyhow::{ensure, Context};
-use bitcoin::blockdata::block::Block;
 use bitcoin::blockdata::transaction::Transaction;
 use bitcoin::consensus::encode;
 use bitcoin::hash_types::{BlockHash, Txid};
@@ -19,7 +18,7 @@ use lightning::chain::chaininterface::{
 use lightning_block_sync::http::HttpEndpoint;
 use lightning_block_sync::rpc::RpcClient;
 use lightning_block_sync::{
-    AsyncBlockSourceResult, BlockHeaderData, BlockSource,
+    AsyncBlockSourceResult, BlockData, BlockHeaderData, BlockSource,
 };
 use tokio::time;
 use tracing::{debug, error};
@@ -287,7 +286,7 @@ impl BlockSource for LexeBitcoind {
     fn get_block<'a>(
         &'a self,
         header_hash: &'a BlockHash,
-    ) -> AsyncBlockSourceResult<'a, Block> {
+    ) -> AsyncBlockSourceResult<'a, BlockData> {
         debug!("get_block() called for {header_hash}");
         Box::pin(async move { self.rpc_client.get_block(header_hash).await })
     }

lexe-ln/src/bitcoind/mod.rs

@@ -13,6 +13,7 @@ use tracing::info;
 use crate::alias::{LexeInvoicePayerType, PaymentInfoStorageType};
 use crate::invoice::{HTLCStatus, LxPaymentError, MillisatAmount, PaymentInfo};
 use crate::keys_manager::LexeKeysManager;
+use crate::logger::LexeTracingLogger;
 use crate::traits::{
     LexeChannelManager, LexeEventHandler, LexePeerManager, LexePersister,
 };
@@ -50,6 +51,7 @@ where
 pub fn get_invoice<CM, PS>(
     channel_manager: CM,
     keys_manager: LexeKeysManager,
+    logger: LexeTracingLogger,
     inbound_payments: PaymentInfoStorageType,
     network: Network,
     req: GetInvoiceRequest,
@@ -64,6 +66,7 @@ where
     let invoice = lightning_invoice::utils::create_invoice_from_channelmanager(
         &channel_manager,
         keys_manager,
+        logger,
         currency,
         req.amt_msat,
         "lexe-node".to_string(),

lexe-ln/src/command.rs

@@ -3,7 +3,9 @@ use lightning::util::events::Event;
 // TODO(max): Perhaps we should upstream this as a Display impl?
 pub fn get_event_name(event: &Event) -> &'static str {
     match event {
+        Event::OpenChannelRequest { .. } => "open channel request",
         Event::FundingGenerationReady { .. } => "funding generation ready",
+        Event::ChannelReady { .. } => "channel ready",
         Event::PaymentReceived { .. } => "payment received",
         Event::PaymentClaimed { .. } => "payment claimed",
         Event::PaymentSent { .. } => "payment sent",
@@ -17,7 +19,6 @@ pub fn get_event_name(event: &Event) -> &'static str {
         Event::PaymentForwarded { .. } => "payment forwarded",
         Event::ChannelClosed { .. } => "channel closed",
         Event::DiscardFunding { .. } => "discard funding",
-        Event::OpenChannelRequest { .. } => "open channel request",
         Event::HTLCHandlingFailed { .. } => "HTLC handling failed",
     }
 }

lexe-ln/src/event.rs

@@ -2,14 +2,14 @@ use std::collections::HashMap;
 use std::marker::PhantomData;
 use std::sync::Arc;
 
-use anyhow::{anyhow, Context};
+use anyhow::{anyhow, bail, Context};
 use bitcoin::blockdata::block::BlockHeader;
 use bitcoin::BlockHash;
 use common::cli::Network;
 use common::shutdown::ShutdownChannel;
 use common::task::LxTask;
 use lightning::chain::transaction::{OutPoint, TransactionData};
-use lightning::chain::{Listen, Watch};
+use lightning::chain::{ChannelMonitorUpdateStatus, Listen, Watch};
 use lightning_block_sync::poll::{ChainPoller, ValidatedBlockHeader};
 use lightning_block_sync::{init as block_sync_init, SpvClient};
 use tokio::sync::mpsc;
@@ -243,12 +243,15 @@ where
             if let LxListener::ChannelMonitor(cmcl) = chain_listener.listener {
                 let (channel_monitor, funding_outpoint) =
                     cmcl.into_monitor_and_outpoint();
-                chain_monitor
-                    .watch_channel(funding_outpoint, channel_monitor)
-                    .map_err(|e| anyhow!("{e:?}"))
-                    .context(
-                        "Couldn't pass channel monitor to chain monitor",
-                    )?;
+                let status = chain_monitor
+                    .watch_channel(funding_outpoint, channel_monitor);
+                match status {
+                    ChannelMonitorUpdateStatus::Completed => {}
+                    ChannelMonitorUpdateStatus::InProgress => {}
+                    ChannelMonitorUpdateStatus::PermanentFailure => {
+                        bail!("Channel monitor update permanently failed")
+                    }
+                }
             }
         }