refactor: Move LexeBitcoind, LxTask into common

Author: MaxFangX

Cargo.lock

@@ -29,6 +29,7 @@ pub mod rng;
 pub mod root_seed;
 pub mod sha256;
 pub mod shutdown;
+pub mod task;
 
 /// Assert at compile time that two `usize` values are equal. This assert has a
 /// nice benefit where there compiler error will actually _print out_ the

common/src/lib.rs

@@ -0,0 +1,32 @@
+use core::future::Future;
+use core::pin::Pin;
+use core::task::{Context, Poll};
+
+use tokio::task::{JoinError, JoinHandle};
+
+/// A thin wrapper around [`tokio::task::JoinHandle`] that adds the
+/// `#[must_use]` lint to ensure that all spawned tasks are joined or explictly
+/// annotated that no joining is required.
+#[must_use]
+pub struct LxTask<T>(JoinHandle<T>);
+
+impl<T> LxTask<T> {
+    #[allow(clippy::disallowed_methods)]
+    pub fn spawn<F>(future: F) -> LxTask<F::Output>
+    where
+        F: Future<Output = T> + Send + 'static,
+        F::Output: Send + 'static,
+    {
+        Self(tokio::spawn(future))
+    }
+}
+
+impl<T> Future for LxTask<T> {
+    type Output = Result<T, JoinError>;
+    fn poll(
+        mut self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+    ) -> Poll<Self::Output> {
+        Pin::new(&mut self.0).poll(cx)
+    }
+}

common/src/task.rs

@@ -50,6 +50,9 @@ anyhow = "1"
 once_cell = "1"
 # A wrapper type for carefully handling secrets
 secrecy = "0.8"
+# Serialization / deserialization framework
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
 # Logging
 tracing = "0.1"
 tracing-core = "0.1"
@@ -58,3 +61,19 @@ tracing-subscriber = { version = "0.3", default-features = false, features = [
     "fmt",
     "tracing-log",
 ] }
+
+# --- PATCHED DEPENDENCIES --- #
+# - Be sure to use the specific patched versions.
+# - See the workspace Cargo.toml for patch declarations.
+# - The versions for transitive dependencies (such as hyper, mio, ring, etc) are
+#   declared in `common`'s Cargo.toml and propagated to other crates by
+#   workspace-level dependency resolution.
+
+tokio = { version = "=1.15.0", default-features = false, features = [
+    "io-util",
+    "macros",
+    "net",
+    "rt",
+    "sync",
+    "time"
+] }

lexe-ln/Cargo.toml

@@ -11,6 +11,7 @@ use bitcoin::consensus::encode;
 use bitcoin::hash_types::{BlockHash, Txid};
 use bitcoin::util::address::Address;
 use common::cli::{BitcoindRpcInfo, Network};
+use common::task::LxTask;
 use lightning::chain::chaininterface::{
     BroadcasterInterface, ConfirmationTarget, FeeEstimator,
 };
@@ -22,8 +23,6 @@ use lightning_block_sync::{
 use tokio::time;
 use tracing::{debug, error};
 
-use crate::types::LxTask;
-
 mod types;
 
 pub use types::*;

node/src/lexe/bitcoind/mod.rs renamed to lexe-ln/src/bitcoind/mod.rs

@@ -1,5 +1,9 @@
 //! The `lexe-ln` crate contains shared Lexe newtypes for bitcoin / lightning
 //! types (usually) defined in LDK.
 
+// Enforce disallowed methods clippy lint
+#![deny(clippy::disallowed_methods)]
+
+pub mod bitcoind;
 pub mod keys_manager;
 pub mod logger;

node/src/lexe/bitcoind/types.rs renamed to lexe-ln/src/bitcoind/types.rs

@@ -60,7 +60,7 @@ futures = "0.3"
 http = "0.2"
 # Used to hold a Tokio runtime used by the sync fns in the Persister trait impl
 once_cell = "1"
-# Used to serialize / deserialize from API
+# Serialization / deserialization framework
 serde = { version = "1", features = ["derive"] }
 serde_qs = "0"
 serde_json = "1"

lexe-ln/src/lib.rs

@@ -12,6 +12,8 @@ use bitcoin::secp256k1::Secp256k1;
 use bitcoin_bech32::WitnessProgram;
 use common::cli::Network;
 use common::hex;
+use common::task::LxTask;
+use lexe_ln::bitcoind::LexeBitcoind;
 use lexe_ln::keys_manager::LexeKeysManager;
 use lightning::chain::chaininterface::{
     BroadcasterInterface, ConfirmationTarget, FeeEstimator,
@@ -21,10 +23,9 @@ use lightning::util::events::{Event, EventHandler, PaymentPurpose};
 use tokio::runtime::Handle;
 use tracing::{debug, error};
 
-use crate::lexe::bitcoind::LexeBitcoind;
 use crate::lexe::channel_manager::NodeChannelManager;
 use crate::types::{
-    HTLCStatus, LxTask, MillisatAmount, NetworkGraphType, PaymentInfo,
+    HTLCStatus, MillisatAmount, NetworkGraphType, PaymentInfo,
     PaymentInfoStorageType,
 };
 

node/Cargo.toml

@@ -227,7 +227,7 @@ mod tests {
 
         // Spawn a task to generate an activity event 500ms in
         let activity_tx = mats.activity_tx.clone();
-        use crate::types::LxTask;
+        use common::task::LxTask;
         let activity_task = LxTask::spawn(async move {
             time::sleep(Duration::from_millis(500)).await;
             let _ = activity_tx.send(()).await;
@@ -255,7 +255,7 @@ mod tests {
         // signal 750ms in
         let activity_tx = mats.activity_tx.clone();
         let shutdown = mats.shutdown.clone();
-        use crate::types::LxTask;
+        use common::task::LxTask;
         let activity_task = LxTask::spawn(async move {
             time::sleep(Duration::from_millis(500)).await;
             let _ = activity_tx.send(()).await;