Put cashu and spark behind feature flags

Author: benthecarman

orange-sdk/Cargo.toml

@@ -4,7 +4,10 @@ version = "0.1.0"
 edition = "2024"
 
 [features]
-_test-utils = ["corepc-node"]
+default = ["spark"]
+spark = ["spark-wallet", "uuid"]
+cashu = ["cdk", "serde_json"]
+_test-utils = ["corepc-node", "cashu"]
 
 [dependencies]
 graduated-rebalancer = { path = "../graduated-rebalancer", version = "0.1.0" }
@@ -14,11 +17,11 @@ bitcoin-payment-instructions = { version = "0.4.0", features = ["http"] }
 chrono = { version = "0.4", default-features = false }
 rand = "0.8.5"
 reqwest = { version = "0.12.23", default-features = false, features = ["rustls-tls"] }
-spark-wallet = { path = "../../rust-spark/crates/spark-wallet" }
+spark-wallet = { path = "../../rust-spark/crates/spark-wallet", optional = true }
 tokio = { version = "1.0", default-features = false, features = ["rt-multi-thread", "sync"] }
-uuid = { version = "1.0", default-features = false }
-cdk = "0.12.0"
-serde_json = "1.0"
+uuid = { version = "1.0", default-features = false, optional = true }
+cdk = { version = "0.12.0", default-features = false, features = ["wallet"], optional = true }
+serde_json = { version = "1.0", optional = true }
 async-trait = "0.1"
 
 corepc-node = { version = "0.8.0", features = ["29_0", "download"], optional = true }

orange-sdk/src/builder.rs

@@ -1,5 +1,6 @@
 //! Builder for constructing [`Wallet`] instances with a fluent API.
 
+#[cfg(feature = "spark")]
 use crate::trusted_wallet::TrustedError;
 use crate::{
 	ChainSource, ExtraConfig, InitFailure, Seed, StorageConfig, Tunables, Wallet, WalletConfig,
@@ -8,7 +9,6 @@ use crate::{
 use ldk_node::bitcoin::secp256k1::PublicKey;
 use ldk_node::bitcoin::{Network, io};
 use ldk_node::lightning::ln::msgs::SocketAddress;
-use spark_wallet::SparkWalletConfig;
 use std::fmt;
 use std::path::PathBuf;
 use std::sync::Arc;
@@ -285,14 +285,15 @@ impl WalletBuilder {
 	/// - Network connection fails
 	/// - Trusted wallet initialization fails
 	/// - LDK node fails to start
+	#[cfg(feature = "spark")]
 	pub async fn build_spark(
-		self, spark_config: Option<SparkWalletConfig>,
+		self, spark_config: Option<spark_wallet::SparkWalletConfig>,
 	) -> Result<Wallet, InitFailure> {
 		let spark_config = match spark_config {
 			Some(cfg) => cfg,
 			None => {
 				let network = self.network.ok_or(BuilderError::MissingNetwork)?;
-				SparkWalletConfig::default_config(
+				spark_wallet::SparkWalletConfig::default_config(
 					network
 						.try_into()
 						.map_err(|_| InitFailure::TrustedFailure(TrustedError::InvalidNetwork))?,

orange-sdk/src/lib.rs

@@ -21,9 +21,11 @@ use bitcoin_payment_instructions::amount::Amount;
 
 use crate::rebalancer::{OrangeRebalanceEventHandler, OrangeTrigger};
 use crate::store::{PaymentId, TxMetadata, TxMetadataStore, TxType};
+#[cfg(feature = "cashu")]
 use crate::trusted_wallet::cashu::Cashu;
 #[cfg(feature = "_test-utils")]
 use crate::trusted_wallet::dummy::DummyTrustedWallet;
+#[cfg(feature = "spark")]
 use crate::trusted_wallet::spark::Spark;
 use crate::trusted_wallet::{DynTrustedWalletInterface, WalletTrusted};
 use graduated_rebalancer::GraduatedRebalancer;
@@ -60,12 +62,17 @@ use lightning_wallet::LightningWallet;
 use logging::Logger;
 use trusted_wallet::TrustedError;
 
+#[cfg(feature = "cashu")]
+pub use crate::trusted_wallet::cashu::CashuConfig;
 pub use bitcoin_payment_instructions;
 pub use builder::{BuilderError, WalletBuilder};
+#[cfg(feature = "cashu")]
+pub use cdk::nuts::nut00::CurrencyUnit;
 pub use event::{Event, EventQueue};
 pub use ldk_node::bip39::Mnemonic;
 pub use ldk_node::bitcoin;
 pub use ldk_node::payment::ConfirmationStatus;
+#[cfg(feature = "spark")]
 pub use spark_wallet::{OperatorPoolConfig, ServiceProviderConfig, SparkWalletConfig};
 pub use store::{PaymentType, Transaction, TxStatus};
 pub use trusted_wallet::ExtraConfig;
@@ -496,18 +503,22 @@ impl Wallet {
 		let event_queue = Arc::new(EventQueue::new(Arc::clone(&store), Arc::clone(&logger)));
 
 		let trusted: Arc<Box<DynTrustedWalletInterface>> = match &config.extra_config {
-			ExtraConfig::Spark(_) => Arc::new(Box::new(
+			#[cfg(feature = "spark")]
+			ExtraConfig::Spark(sp) => Arc::new(Box::new(
 				Spark::init(
 					&config,
+					sp.clone(),
 					Arc::clone(&store),
 					Arc::clone(&event_queue),
 					Arc::clone(&logger),
 				)
 				.await?,
 			)),
-			ExtraConfig::Cashu(_) => Arc::new(Box::new(
+			#[cfg(feature = "cashu")]
+			ExtraConfig::Cashu(cashu) => Arc::new(Box::new(
 				Cashu::init(
 					&config,
+					cashu.clone(),
 					Arc::clone(&store),
 					Arc::clone(&event_queue),
 					Arc::clone(&logger),

orange-sdk/src/store.rs

@@ -92,6 +92,7 @@ pub struct Transaction {
 /// A [Transaction] that is stored in the database. We have to modify the `Transaction` type
 /// to have types that all implement `Writeable` and `Readable` so that we can store it in the database.
 #[derive(Debug, Clone)]
+#[allow(dead_code)] // Some trusted backends don't use this
 pub(crate) struct StoreTransaction {
 	pub status: TxStatus,
 	pub outbound: bool,

orange-sdk/src/trusted_wallet/cashu/mod.rs

@@ -3,7 +3,7 @@
 use crate::logging::Logger;
 use crate::store::{PaymentId, TxStatus};
 use crate::trusted_wallet::{Payment, TrustedError, TrustedWalletInterface};
-use crate::{Event, EventQueue, ExtraConfig, InitFailure, Seed, WalletConfig};
+use crate::{Event, EventQueue, InitFailure, Seed, WalletConfig};
 
 use ldk_node::bitcoin::hashes::Hash;
 use ldk_node::bitcoin::hashes::sha256::Hash as Sha256;
@@ -267,14 +267,9 @@ impl TrustedWalletInterface for Cashu {
 
 impl Cashu {
 	pub(crate) async fn init(
-		config: &WalletConfig, store: Arc<dyn KVStore + Sync + Send>,
+		config: &WalletConfig, cashu_config: CashuConfig, store: Arc<dyn KVStore + Sync + Send>,
 		event_queue: Arc<EventQueue>, logger: Arc<Logger>,
 	) -> Result<Self, InitFailure> {
-		let cashu_config = match config.extra_config {
-			ExtraConfig::Cashu(ref c) => c.clone(),
-			_ => unreachable!(),
-		};
-
 		// Create the seed from the configuration
 		let seed = match &config.seed {
 			Seed::Seed64(bytes) => {
@@ -372,13 +367,7 @@ impl Cashu {
 			}
 		}
 
-		Ok(Cashu {
-			cashu_wallet,
-			shutdown_sender,
-			logger,
-			supports_bolt12,
-			mint_quote_sender,
-		})
+		Ok(Cashu { cashu_wallet, shutdown_sender, logger, supports_bolt12, mint_quote_sender })
 	}
 
 	/// Convert an ID string to a 32-byte array

orange-sdk/src/trusted_wallet/mod.rs

@@ -12,10 +12,12 @@ use std::pin::Pin;
 use std::sync::Arc;
 use std::time::Duration;
 
+#[cfg(feature = "cashu")]
+pub mod cashu;
 #[cfg(feature = "_test-utils")]
 pub mod dummy;
+#[cfg(feature = "spark")]
 pub mod spark;
-pub mod cashu;
 
 /// Represents a payment with its associated details.
 ///
@@ -115,8 +117,10 @@ impl<T: ?Sized + TrustedWalletInterface> graduated_rebalancer::TrustedWallet for
 /// Extra configuration needed for different types of wallets.
 pub enum ExtraConfig {
 	/// Configuration for Spark wallet.
+	#[cfg(feature = "spark")]
 	Spark(crate::SparkWalletConfig),
 	/// Configuration for Cashu wallet.
+	#[cfg(feature = "cashu")]
 	Cashu(cashu::CashuConfig),
 	/// Configuration for dummy wallet (test-only).
 	#[cfg(feature = "_test-utils")]
@@ -131,7 +135,9 @@ mod private {
 	pub trait Sealed {}
 
 	// Only implement Sealed for types you want to allow
+	#[cfg(feature = "spark")]
 	impl Sealed for super::spark::Spark {}
+	#[cfg(feature = "cashu")]
 	impl Sealed for super::cashu::Cashu {}
 	#[cfg(feature = "_test-utils")]
 	impl Sealed for super::dummy::DummyTrustedWallet {}

orange-sdk/src/trusted_wallet/spark.rs

@@ -5,7 +5,7 @@ use crate::bitcoin::{Txid, io};
 use crate::logging::Logger;
 use crate::store::{PaymentId, StoreTransaction, TxStatus};
 use crate::trusted_wallet::{Payment, TrustedError, TrustedWalletInterface};
-use crate::{Event, EventQueue, ExtraConfig, InitFailure, PaymentType, Seed, WalletConfig};
+use crate::{Event, EventQueue, InitFailure, PaymentType, Seed, WalletConfig};
 
 use ldk_node::bitcoin::hashes::Hash;
 use ldk_node::bitcoin::hashes::sha256::Hash as Sha256;
@@ -21,8 +21,8 @@ use bitcoin_payment_instructions::PaymentMethod;
 use bitcoin_payment_instructions::amount::Amount;
 
 use spark_wallet::{
-	DefaultSigner, Order, PagingFilter, PayLightningInvoiceResult, SparkWallet, SparkWalletError,
-	SspUserRequest, TransferStatus, WalletEvent, WalletTransfer,
+	DefaultSigner, Order, PagingFilter, PayLightningInvoiceResult, SparkWallet, SparkWalletConfig,
+	SparkWalletError, SspUserRequest, TransferStatus, WalletEvent, WalletTransfer,
 };
 
 use tokio::sync::watch;
@@ -226,37 +226,32 @@ const SPARK_SYNC_OFFSET_KEY: &str = "sync_offset";
 impl Spark {
 	/// Initialize a new Spark wallet instance with the given configuration.
 	pub(crate) async fn init(
-		config: &WalletConfig, store: Arc<dyn KVStore + Sync + Send>, event_queue: Arc<EventQueue>,
-		logger: Arc<Logger>,
+		config: &WalletConfig, spark_config: SparkWalletConfig,
+		store: Arc<dyn KVStore + Sync + Send>, event_queue: Arc<EventQueue>, logger: Arc<Logger>,
 	) -> Result<Self, InitFailure> {
-		let extra_config = match &config.extra_config {
-			ExtraConfig::Spark(sp) => sp.clone(),
-			_ => unreachable!("Not reachable, we are in Spark"),
-		};
-
-		if config.network != extra_config.network.into() {
+		if config.network != spark_config.network.into() {
 			Err(TrustedError::InvalidNetwork)?
 		}
 
 		let signer = match &config.seed {
 			Seed::Seed64(bytes) => {
 				// hash the seed to make sure it does not conflict with the lightning keys
 				let seed = Sha256::hash(bytes);
-				DefaultSigner::new(&seed[..], extra_config.network)
+				DefaultSigner::new(&seed[..], spark_config.network)
 					.map_err(|e| TrustedError::Other(format!("Failed to create signer: {e}")))?
 			},
 			Seed::Mnemonic { mnemonic, passphrase } => {
 				// We don't hash the seed here, as mnemonics are meant to be easily recoverable
 				// and if we hashed them, then you could not recover your spark coins from the mnemonic
 				// in separate wallets.
 				let seed = mnemonic.to_seed(passphrase.as_deref().unwrap_or(""));
-				DefaultSigner::new(&seed[..], extra_config.network)
+				DefaultSigner::new(&seed[..], spark_config.network)
 					.map_err(|e| TrustedError::Other(format!("Failed to create signer: {e}")))?
 			},
 		};
 
 		let spark_wallet = Arc::new(
-			SparkWallet::connect(extra_config, signer)
+			SparkWallet::connect(spark_config, signer)
 				.await
 				.map_err(|e| InitFailure::TrustedFailure(e.into()))?,
 		);