refactor: share bitcoind aliases, LexeNode -> UserNode

Author: MaxFangX

lexe-ln/src/alias.rs

@@ -0,0 +1,6 @@
+use crate::bitcoind::LexeBitcoind;
+
+pub type WalletType = LexeBitcoind;
+pub type BlockSourceType = LexeBitcoind;
+pub type BroadcasterType = LexeBitcoind;
+pub type FeeEstimatorType = LexeBitcoind;

lexe-ln/src/lib.rs

@@ -4,6 +4,11 @@
 // Enforce disallowed methods clippy lint
 #![deny(clippy::disallowed_methods)]
 
+/// Type aliases.
+pub mod alias;
+/// BitcoinD client.
 pub mod bitcoind;
+/// Keys manager
 pub mod keys_manager;
+/// LDK + SGX compatible logger
 pub mod logger;

node/src/cli/mod.rs

@@ -7,7 +7,7 @@ use common::enclave;
 use common::rng::SysRng;
 
 use crate::api::LexeApiClient;
-use crate::init::LexeNode;
+use crate::init::UserNode;
 use crate::provision::provision;
 
 /// the Lexe node CLI
@@ -27,7 +27,7 @@ impl Args {
                     .expect("Failed to build Tokio runtime");
                 let mut rng = SysRng::new();
                 rt.block_on(async {
-                    let node = LexeNode::init(&mut rng, args).await?;
+                    let node = UserNode::init(&mut rng, args).await?;
                     node.run().await
                 })
                 .context("Error running node")

node/src/command/test/mod.rs

@@ -14,7 +14,7 @@ use common::rng::SysRng;
 use lexe_ln::logger;
 
 use crate::command::owner;
-use crate::init::LexeNode;
+use crate::init::UserNode;
 use crate::lexe::channel_manager::NodeChannelManager;
 use crate::lexe::peer_manager::{ChannelPeer, NodePeerManager};
 use crate::lexe::persister::NodePersister;
@@ -84,7 +84,7 @@ fn bitcoind_exe_path() -> String {
 
 struct CommandTestHarness {
     bitcoind: BitcoinD,
-    node: LexeNode,
+    node: UserNode,
 }
 
 impl CommandTestHarness {
@@ -107,7 +107,7 @@ impl CommandTestHarness {
 
         // Init node
         let mut rng = SysRng::new();
-        let node = LexeNode::init(&mut rng, args)
+        let node = UserNode::init(&mut rng, args)
             .await
             .expect("Error during init");
 

node/src/init.rs

@@ -18,6 +18,9 @@ use common::rng::Crng;
 use common::shutdown::ShutdownChannel;
 use common::task::LxTask;
 use futures::future;
+use lexe_ln::alias::{
+    BlockSourceType, BroadcasterType, FeeEstimatorType, WalletType,
+};
 use lexe_ln::bitcoind::LexeBitcoind;
 use lexe_ln::keys_manager::LexeKeysManager;
 use lexe_ln::logger::LexeTracingLogger;
@@ -44,9 +47,8 @@ use crate::lexe::peer_manager::NodePeerManager;
 use crate::lexe::persister::NodePersister;
 use crate::lexe::sync::SyncedChainListeners;
 use crate::types::{
-    ApiClientType, BlockSourceType, BroadcasterType, ChainMonitorType,
-    ChannelMonitorType, FeeEstimatorType, InvoicePayerType, NetworkGraphType,
-    P2PGossipSyncType, PaymentInfoStorageType, WalletType,
+    ApiClientType, ChainMonitorType, ChannelMonitorType, InvoicePayerType,
+    NetworkGraphType, P2PGossipSyncType, PaymentInfoStorageType,
 };
 use crate::{api, command};
 
@@ -55,9 +57,7 @@ pub const DEFAULT_CHANNEL_SIZE: usize = 256;
 const P2P_RECONNECT_INTERVAL: Duration = Duration::from_secs(60);
 const SHUTDOWN_JOIN_TIMEOUT: Duration = Duration::from_secs(15);
 
-// TODO: Remove once keys_manager, persister, invoice_payer are read in SGX
-#[allow(dead_code)]
-pub struct LexeNode {
+pub struct UserNode {
     // --- General --- //
     args: RunArgs,
     pub peer_port: Port,
@@ -70,11 +70,12 @@ pub struct LexeNode {
     pub persister: NodePersister,
     chain_monitor: Arc<ChainMonitorType>,
     pub network_graph: Arc<NetworkGraphType>,
+    #[allow(dead_code)]
     invoice_payer: Arc<InvoicePayerType>,
     pub wallet: Arc<WalletType>,
     block_source: Arc<BlockSourceType>,
-    fee_estimator: Arc<FeeEstimatorType>,
     broadcaster: Arc<BroadcasterType>,
+    fee_estimator: Arc<FeeEstimatorType>,
     logger: LexeTracingLogger,
     inactivity_timer: InactivityTimer,
 
@@ -84,12 +85,14 @@ pub struct LexeNode {
     channel_manager_blockhash: BlockHash,
 
     // --- Run --- //
+    #[allow(dead_code)]
     inbound_payments: PaymentInfoStorageType,
+    #[allow(dead_code)]
     outbound_payments: PaymentInfoStorageType,
     shutdown: ShutdownChannel,
 }
 
-impl LexeNode {
+impl UserNode {
     #[instrument(skip_all)]
     pub async fn init<R: Crng>(
         rng: &mut R,
@@ -340,8 +343,8 @@ impl LexeNode {
             shutdown.clone(),
         );
 
-        // Build and return the LexeNode
-        let node = LexeNode {
+        // Build and return the UserNode
+        let node = UserNode {
             // General
             args,
             peer_port,

node/src/lexe/channel_manager/mod.rs

@@ -5,6 +5,7 @@ use anyhow::{anyhow, Context};
 use bitcoin::BlockHash;
 use common::cli::RunArgs;
 use common::ln::channel::LxOutPoint;
+use lexe_ln::alias::{BlockSourceType, BroadcasterType, FeeEstimatorType};
 use lexe_ln::keys_manager::LexeKeysManager;
 use lexe_ln::logger::LexeTracingLogger;
 use lightning::chain::chainmonitor::MonitorUpdateId;
@@ -19,10 +20,7 @@ use tracing::{debug, info};
 
 use crate::lexe::peer_manager::{ChannelPeer, NodePeerManager};
 use crate::lexe::persister::NodePersister;
-use crate::types::{
-    BlockSourceType, BroadcasterType, ChainMonitorType, ChannelManagerType,
-    ChannelMonitorType, FeeEstimatorType,
-};
+use crate::types::{ChainMonitorType, ChannelManagerType, ChannelMonitorType};
 
 /// NOTE: Important security parameter!!
 ///

node/src/lexe/persister.rs

@@ -11,6 +11,7 @@ use common::enclave::Measurement;
 use common::ln::channel::LxOutPoint;
 use common::shutdown::ShutdownChannel;
 use common::task::LxTask;
+use lexe_ln::alias::{BroadcasterType, FeeEstimatorType};
 use lexe_ln::keys_manager::LexeKeysManager;
 use lexe_ln::logger::LexeTracingLogger;
 use lightning::chain::chainmonitor::{MonitorUpdateId, Persist};
@@ -29,9 +30,8 @@ use tracing::{debug, error};
 use crate::lexe::channel_manager::{LxChannelMonitorUpdate, USER_CONFIG};
 use crate::lexe::peer_manager::ChannelPeer;
 use crate::types::{
-    ApiClientType, BroadcasterType, ChainMonitorType, ChannelManagerType,
-    ChannelMonitorType, FeeEstimatorType, LoggerType, NetworkGraphType,
-    ProbabilisticScorerType, SignerType,
+    ApiClientType, ChainMonitorType, ChannelManagerType, ChannelMonitorType,
+    LoggerType, NetworkGraphType, ProbabilisticScorerType, SignerType,
 };
 
 // Singleton objects use SINGLETON_DIRECTORY with a fixed filename

node/src/lexe/sync.rs

@@ -7,6 +7,7 @@ use bitcoin::BlockHash;
 use common::cli::Network;
 use common::shutdown::ShutdownChannel;
 use common::task::LxTask;
+use lexe_ln::alias::{BlockSourceType, BroadcasterType, FeeEstimatorType};
 use lexe_ln::logger::LexeTracingLogger;
 use lightning::chain::transaction::OutPoint;
 use lightning::chain::{Listen, Watch};
@@ -17,8 +18,7 @@ use tracing::{info, warn};
 
 use crate::lexe::channel_manager::NodeChannelManager;
 use crate::types::{
-    BlockSourceType, BroadcasterType, ChainMonitorType,
-    ChannelMonitorListenerType, ChannelMonitorType, FeeEstimatorType,
+    ChainMonitorType, ChannelMonitorListenerType, ChannelMonitorType,
 };
 
 /// How often the SpvClient client polls for an updated chain tip

node/src/types/alias.rs

@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 use std::sync::{Arc, Mutex};
 
-use lexe_ln::bitcoind::LexeBitcoind;
+use lexe_ln::alias::{BroadcasterType, FeeEstimatorType};
 use lexe_ln::keys_manager::LexeKeysManager;
 use lexe_ln::logger::LexeTracingLogger;
 use lightning::chain::chainmonitor::ChainMonitor;
@@ -82,9 +82,4 @@ pub type NetworkGraphType = NetworkGraph<LoggerType>;
 
 pub type ChainAccessType = dyn Access + Send + Sync;
 
-pub type WalletType = LexeBitcoind;
-pub type BlockSourceType = LexeBitcoind;
-pub type BroadcasterType = LexeBitcoind;
-pub type FeeEstimatorType = LexeBitcoind;
-
 pub type LoggerType = LexeTracingLogger;