Integrate ln addr for spark

Author: benthecarman

orange-sdk/src/ffi/orange/wallet.rs

@@ -251,4 +251,16 @@ impl Wallet {
 	pub fn event_handled(&self) -> bool {
 		self.inner.event_handled().is_ok()
 	}
+
+	/// Gets the lightning address for this wallet, if one is set.
+	pub async fn get_lightning_address(&self) -> Result<Option<String>, WalletError> {
+		let result = self.inner.get_lightning_address().await?;
+		Ok(result)
+	}
+
+	/// Attempts to register the lightning address for this wallet.
+	pub async fn register_lightning_address(&self, name: String) -> Result<(), WalletError> {
+		self.inner.register_lightning_address(name).await?;
+		Ok(())
+	}
 }

orange-sdk/src/lib.rs

@@ -533,7 +533,7 @@ impl Wallet {
 			ExtraConfig::Spark(sp) => Arc::new(Box::new(
 				Spark::init(
 					&config,
-					*sp,
+					sp.clone(),
 					Arc::clone(&store),
 					Arc::clone(&event_queue),
 					tx_metadata.clone(),
@@ -1345,6 +1345,16 @@ impl Wallet {
 		res
 	}
 
+	/// Gets the lightning address for this wallet, if one is set.
+	pub async fn get_lightning_address(&self) -> Result<Option<String>, WalletError> {
+		Ok(self.inner.trusted.get_lightning_address().await?)
+	}
+
+	/// Attempts to register the lightning address for this wallet.
+	pub async fn register_lightning_address(&self, name: String) -> Result<(), WalletError> {
+		Ok(self.inner.trusted.register_lightning_address(name).await?)
+	}
+
 	/// Stops the wallet, which will stop the underlying LDK node and any background tasks.
 	/// This will ensure that any critical tasks have completed before stopping.
 	pub async fn stop(&self) {

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

@@ -469,6 +469,22 @@ impl TrustedWalletInterface for Cashu {
 		})
 	}
 
+	fn get_lightning_address(
+		&self,
+	) -> Pin<Box<dyn Future<Output = Result<Option<String>, TrustedError>> + Send + '_>> {
+		Box::pin(async { Ok(None) })
+	}
+
+	fn register_lightning_address(
+		&self, _name: String,
+	) -> Pin<Box<dyn Future<Output = Result<(), TrustedError>> + Send + '_>> {
+		Box::pin(async {
+			Err(TrustedError::UnsupportedOperation(
+				"register_lightning_address is not supported in Cashu Wallet".to_string(),
+			))
+		})
+	}
+
 	fn stop(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>> {
 		Box::pin(async move {
 			log_info!(self.logger, "Stopping Cashu wallet");

orange-sdk/src/trusted_wallet/dummy.rs

@@ -411,6 +411,22 @@ impl TrustedWalletInterface for DummyTrustedWallet {
 		})
 	}
 
+	fn get_lightning_address(
+		&self,
+	) -> Pin<Box<dyn Future<Output = Result<Option<String>, TrustedError>> + Send + '_>> {
+		Box::pin(async { Ok(None) })
+	}
+
+	fn register_lightning_address(
+		&self, _name: String,
+	) -> Pin<Box<dyn Future<Output = Result<(), TrustedError>> + Send + '_>> {
+		Box::pin(async {
+			Err(TrustedError::UnsupportedOperation(
+				"register_lightning_address is not supported in DummyTrustedWallet".to_string(),
+			))
+		})
+	}
+
 	fn stop(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>> {
 		Box::pin(async move {
 			let _ = self.ldk_node.stop();

orange-sdk/src/trusted_wallet/mod.rs

@@ -89,6 +89,16 @@ pub trait TrustedWalletInterface: Send + Sync + private::Sealed {
 		&self, payment_hash: [u8; 32],
 	) -> Pin<Box<dyn Future<Output = Option<ReceivedLightningPayment>> + Send + '_>>;
 
+	/// Gets the lightning address for this wallet, if one is set.
+	fn get_lightning_address(
+		&self,
+	) -> Pin<Box<dyn Future<Output = Result<Option<String>, TrustedError>> + Send + '_>>;
+
+	/// Attempts to register the lightning address for this wallet.
+	fn register_lightning_address(
+		&self, name: String,
+	) -> Pin<Box<dyn Future<Output = Result<(), TrustedError>> + Send + '_>>;
+
 	/// Stops the wallet, cleaning up any resources.
 	/// This is typically used to gracefully shut down the wallet.
 	fn stop(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>>;

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

@@ -21,7 +21,8 @@ use bitcoin_payment_instructions::amount::Amount;
 use breez_sdk_spark::{
 	BreezSdk, EventListener, GetInfoRequest, ListPaymentsRequest, PaymentDetails, PaymentStatus,
 	PaymentType, PrepareSendPaymentRequest, ReceivePaymentMethod, ReceivePaymentRequest,
-	SdkBuilder, SdkError, SdkEvent, SendPaymentMethod, SendPaymentRequest,
+	RegisterLightningAddressRequest, SdkBuilder, SdkError, SdkEvent, SendPaymentMethod,
+	SendPaymentRequest,
 };
 
 use graduated_rebalancer::ReceivedLightningPayment;
@@ -37,7 +38,7 @@ use std::time::Duration;
 use uuid::Uuid;
 
 /// Configuration options for the Spark wallet.
-#[derive(Debug, Copy, Clone)]
+#[derive(Debug, Clone)]
 pub struct SparkWalletConfig {
 	/// How often to sync the wallet with the blockchain, in seconds.
 	/// Default is 60 seconds.
@@ -46,11 +47,17 @@ pub struct SparkWalletConfig {
 	/// lightning when sending and receiving. This has the benefit of lower fees
 	/// but is at the cost of privacy.
 	pub prefer_spark_over_lightning: bool,
+	/// The domain used for receiving through lnurl-pay and lightning address.
+	pub lnurl_domain: Option<String>,
 }
 
 impl Default for SparkWalletConfig {
 	fn default() -> Self {
-		SparkWalletConfig { sync_interval_secs: 60, prefer_spark_over_lightning: false }
+		SparkWalletConfig {
+			sync_interval_secs: 60,
+			prefer_spark_over_lightning: false,
+			lnurl_domain: Some("breez.tips".to_string()),
+		}
 	}
 }
 
@@ -59,7 +66,7 @@ impl Default for SparkWalletConfig {
 const BREEZ_API_KEY: &str = "MIIBajCCARygAwIBAgIHPnfOjAhBgzAFBgMrZXAwEDEOMAwGA1UEAxMFQnJlZXowHhcNMjUwOTE5MjEzNTU1WhcNMzUwOTE3MjEzNTU1WjAqMRMwEQYDVQQKEwpvcmFuZ2Utc2RrMRMwEQYDVQQDEwpvcmFuZ2Utc2RrMCowBQYDK2VwAyEA0IP1y98gPByiIMoph1P0G6cctLb864rNXw1LRLOpXXejezB5MA4GA1UdDwEB/wQEAwIFoDAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBTaOaPuXmtLDTJVv++VYBiQr9gHCTAfBgNVHSMEGDAWgBTeqtaSVvON53SSFvxMtiCyayiYazAZBgNVHREEEjAQgQ5iZW5Ac3BpcmFsLnh5ejAFBgMrZXADQQCry+1LkA3nrYa1sovS5iFI1Tkpmr/R0nM/4gJtsO93vFOkm3vBEGwjKAV7lrGzFcFbbuyM1wEJPi4Po1XCEG0D";
 
 impl SparkWalletConfig {
-	fn to_breez_config(self, network: Network) -> Result<breez_sdk_spark::Config, TrustedError> {
+	fn into_breez_config(self, network: Network) -> Result<breez_sdk_spark::Config, TrustedError> {
 		let network = match network {
 			Network::Bitcoin => breez_sdk_spark::Network::Mainnet,
 			Network::Regtest => breez_sdk_spark::Network::Regtest,
@@ -75,7 +82,7 @@ impl SparkWalletConfig {
 			real_time_sync_server_url: None,
 			api_key: Some(BREEZ_API_KEY.to_string()),
 			max_deposit_claim_fee: None,
-			lnurl_domain: None,
+			lnurl_domain: self.lnurl_domain,
 			private_enabled_default: true,
 		})
 	}
@@ -245,6 +252,34 @@ impl TrustedWalletInterface for Spark {
 		})
 	}
 
+	fn get_lightning_address(
+		&self,
+	) -> Pin<Box<dyn Future<Output = Result<Option<String>, TrustedError>> + Send + '_>> {
+		Box::pin(async move {
+			match self.spark_wallet.get_lightning_address().await? {
+				None => Ok(None),
+				Some(addr) => Ok(Some(addr.lightning_address)),
+			}
+		})
+	}
+
+	fn register_lightning_address(
+		&self, name: String,
+	) -> Pin<Box<dyn Future<Output = Result<(), TrustedError>> + Send + '_>> {
+		Box::pin(async move {
+			let res = self.get_lightning_address().await?;
+			if res.is_some() {
+				return Err(TrustedError::Other(
+					"Wallet already has a lightning address".to_string(),
+				));
+			}
+
+			let params = RegisterLightningAddressRequest { username: name, description: None };
+			self.spark_wallet.register_lightning_address(params).await?;
+			Ok(())
+		})
+	}
+
 	fn stop(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>> {
 		Box::pin(async move {
 			log_info!(self.logger, "Stopping Spark wallet");
@@ -260,7 +295,8 @@ impl Spark {
 		event_queue: Arc<EventQueue>, tx_metadata: TxMetadataStore, logger: Arc<Logger>,
 		runtime: Arc<Runtime>,
 	) -> Result<Self, InitFailure> {
-		let spark_config: breez_sdk_spark::Config = spark_config.to_breez_config(config.network)?;
+		let spark_config: breez_sdk_spark::Config =
+			spark_config.into_breez_config(config.network)?;
 
 		let seed = match &config.seed {
 			Seed::Seed64(bytes) => breez_sdk_spark::Seed::Entropy(bytes.to_vec()),