Create proper trusted error type

Author: benthecarman

graduated-rebalancer/src/lib.rs

@@ -61,7 +61,7 @@ impl Default for RebalanceTunables {
 /// Trait representing a trusted wallet backend
 pub trait TrustedWallet: Send + Sync {
 	/// Error type for trusted wallet operations
-	type Error: std::error::Error + Send + Sync + 'static;
+	type Error: Debug + Send + Sync + 'static;
 
 	/// Get the current balance of the trusted wallet
 	fn get_balance(&self) -> impl Future<Output = Result<Amount, Self::Error>> + Send;
@@ -83,7 +83,7 @@ pub trait TrustedWallet: Send + Sync {
 /// Trait representing a lightning wallet backend
 pub trait LightningWallet: Send + Sync {
 	/// Error type for lightning wallet operations
-	type Error: std::error::Error + Send + Sync + 'static;
+	type Error: Debug + Send + Sync + 'static;
 
 	/// Get the current balance of the lightning wallet
 	fn get_balance(&self) -> LightningBalance;

orange-sdk/src/lib.rs

@@ -53,7 +53,7 @@ pub mod trusted_wallet;
 
 use lightning_wallet::LightningWallet;
 use logging::Logger;
-use trusted_wallet::Error as TrustedError;
+use trusted_wallet::TrustedError;
 use trusted_wallet::TrustedWalletInterface;
 
 pub use bitcoin_payment_instructions;
@@ -380,7 +380,7 @@ pub enum InitFailure {
 	/// Failure to start the LDK node.
 	LdkNodeStartFailure(NodeError),
 	/// Failure in the trusted wallet implementation.
-	TrustedFailure(Box<TrustedError>),
+	TrustedFailure(TrustedError),
 }
 
 impl From<io::Error> for InitFailure {
@@ -403,7 +403,7 @@ impl From<NodeError> for InitFailure {
 
 impl From<TrustedError> for InitFailure {
 	fn from(e: TrustedError) -> InitFailure {
-		InitFailure::TrustedFailure(Box::new(e))
+		InitFailure::TrustedFailure(e)
 	}
 }
 

orange-sdk/src/trusted_wallet/dummy.rs

@@ -3,7 +3,7 @@
 use crate::bitcoin::hashes::Hash;
 use crate::event::EventQueue;
 use crate::store::TxStatus;
-use crate::trusted_wallet::{Error, Payment, TrustedWalletInterface};
+use crate::trusted_wallet::{Payment, TrustedError, TrustedWalletInterface};
 use crate::{InitFailure, WalletConfig};
 use bitcoin_payment_instructions::PaymentMethod;
 use bitcoin_payment_instructions::amount::Amount;
@@ -187,25 +187,27 @@ impl TrustedWalletInterface for DummyTrustedWallet {
 		}
 	}
 
-	fn get_balance(&self) -> impl Future<Output = Result<Amount, Error>> + Send {
+	fn get_balance(&self) -> impl Future<Output = Result<Amount, TrustedError>> + Send {
 		async move {
 			let msats = self.current_bal_msats.load(Ordering::SeqCst);
 			Ok(Amount::from_milli_sats(msats).expect("valid msats"))
 		}
 	}
 
-	fn get_reusable_receive_uri(&self) -> impl Future<Output = Result<String, Error>> + Send {
+	fn get_reusable_receive_uri(
+		&self,
+	) -> impl Future<Output = Result<String, TrustedError>> + Send {
 		async move {
 			match self.ldk_node.bolt12_payment().receive_variable_amount("dummy offer", None) {
 				Ok(offer) => Ok(offer.to_string()),
-				Err(e) => Err(Error::Generic(e.to_string())),
+				Err(e) => Err(TrustedError::WalletOperationFailed(e.to_string())),
 			}
 		}
 	}
 
 	fn get_bolt11_invoice(
 		&self, amount: Option<Amount>,
-	) -> impl Future<Output = Result<Bolt11Invoice, Error>> + Send {
+	) -> impl Future<Output = Result<Bolt11Invoice, TrustedError>> + Send {
 		async move {
 			let desc = Bolt11InvoiceDescription::Direct(Description::empty());
 			match amount {
@@ -226,19 +228,19 @@ impl TrustedWalletInterface for DummyTrustedWallet {
 		}
 	}
 
-	fn list_payments(&self) -> impl Future<Output = Result<Vec<Payment>, Error>> + Send {
+	fn list_payments(&self) -> impl Future<Output = Result<Vec<Payment>, TrustedError>> + Send {
 		async move { Ok(self.payments.read().unwrap().clone()) }
 	}
 
 	fn estimate_fee(
 		&self, _method: &PaymentMethod, _amount: Amount,
-	) -> impl Future<Output = Result<Amount, Error>> + Send {
+	) -> impl Future<Output = Result<Amount, TrustedError>> + Send {
 		async move { Ok(Amount::ZERO) }
 	}
 
 	fn pay(
 		&self, method: &PaymentMethod, amount: Amount,
-	) -> impl Future<Output = Result<[u8; 32], Error>> + Send {
+	) -> impl Future<Output = Result<[u8; 32], TrustedError>> + Send {
 		async move {
 			let id = match method {
 				PaymentMethod::LightningBolt11(inv) => {

orange-sdk/src/trusted_wallet/mod.rs

@@ -11,8 +11,6 @@ use ldk_node::lightning_invoice::Bolt11Invoice;
 use bitcoin_payment_instructions::PaymentMethod;
 use bitcoin_payment_instructions::amount::Amount;
 
-use spark_wallet::SparkWalletError;
-
 use std::future::Future;
 use std::sync::Arc;
 use std::time::Duration;
@@ -21,9 +19,6 @@ use std::time::Duration;
 pub mod dummy;
 pub mod spark;
 
-// todo generic error type
-pub(crate) type Error = SparkWalletError;
-
 /// Represents a payment with its associated details.
 ///
 /// This struct contains information about a payment, including its unique ID,
@@ -57,29 +52,30 @@ pub trait TrustedWalletInterface: Sized + Send + Sync + private::Sealed {
 	) -> impl Future<Output = Result<Self, InitFailure>> + Send;
 
 	/// Returns the current balance of the wallet.
-	fn get_balance(&self) -> impl Future<Output = Result<Amount, Error>> + Send;
+	fn get_balance(&self) -> impl Future<Output = Result<Amount, TrustedError>> + Send;
 
 	/// Generates a new reusable address for receiving payments.
 	/// Generally, this should be a BOLT 12 offer.
-	fn get_reusable_receive_uri(&self) -> impl Future<Output = Result<String, Error>> + Send;
+	fn get_reusable_receive_uri(&self)
+	-> impl Future<Output = Result<String, TrustedError>> + Send;
 
 	/// Generates a Bolt11 invoice for the specified amount.
 	fn get_bolt11_invoice(
 		&self, amount: Option<Amount>,
-	) -> impl Future<Output = Result<Bolt11Invoice, Error>> + Send;
+	) -> impl Future<Output = Result<Bolt11Invoice, TrustedError>> + Send;
 
 	/// Lists all payments made through the wallet.
-	fn list_payments(&self) -> impl Future<Output = Result<Vec<Payment>, Error>> + Send;
+	fn list_payments(&self) -> impl Future<Output = Result<Vec<Payment>, TrustedError>> + Send;
 
 	/// Estimates the fee for a payment to the given payment method with the specified amount.
 	fn estimate_fee(
 		&self, method: &PaymentMethod, amount: Amount,
-	) -> impl Future<Output = Result<Amount, Error>> + Send;
+	) -> impl Future<Output = Result<Amount, TrustedError>> + Send;
 
 	/// Pays to the given payment method with the specified amount.
 	fn pay(
 		&self, method: &PaymentMethod, amount: Amount,
-	) -> impl Future<Output = Result<[u8; 32], Error>> + Send;
+	) -> impl Future<Output = Result<[u8; 32], TrustedError>> + Send;
 
 	/// Stops the wallet, cleaning up any resources.
 	/// This is typically used to gracefully shut down the wallet.
@@ -89,7 +85,7 @@ pub trait TrustedWalletInterface: Sized + Send + Sync + private::Sealed {
 pub(crate) struct WalletTrusted<T: TrustedWalletInterface>(pub(crate) Arc<T>);
 
 impl<T: TrustedWalletInterface> graduated_rebalancer::TrustedWallet for WalletTrusted<T> {
-	type Error = crate::trusted_wallet::Error;
+	type Error = TrustedError;
 
 	fn get_balance(&self) -> impl Future<Output = Result<Amount, Self::Error>> + Send {
 		async move { self.0.get_balance().await }
@@ -127,3 +123,28 @@ mod private {
 	#[cfg(feature = "_test-utils")]
 	impl Sealed for super::dummy::DummyTrustedWallet {}
 }
+
+/// An error type for the Spark wallet implementation.
+#[derive(Debug)]
+pub enum TrustedError {
+	/// Not enough funds to complete the operation.
+	InsufficientFunds,
+	/// The wallet operation failed with a specific message.
+	WalletOperationFailed(String),
+	/// The provided network is invalid.
+	InvalidNetwork,
+	/// The spark wallet does not yet support the operation.
+	UnsupportedOperation(String),
+	/// Failed to convert an amount.
+	AmountError,
+	/// An I/O error occurred.
+	IOError(ldk_node::lightning::io::Error),
+	/// An unspecified error occurred.
+	Other(String),
+}
+
+impl From<ldk_node::lightning::io::Error> for TrustedError {
+	fn from(e: ldk_node::lightning::io::Error) -> Self {
+		TrustedError::IOError(e)
+	}
+}