Integrate token transfers

Author: dangeross

Cargo.lock

@@ -15,6 +15,7 @@ members = [
   "crates/breez-sdk/lnurl-models",
   "crates/breez-sdk/breez-itest",
   "crates/breez-sdk/wasm",
+  "crates/flashnet",
   "crates/macros",
   "crates/macro_test",
   "crates/spark",
@@ -64,6 +65,7 @@ dotenvy = "0.15.7"
 ecies = { version = "0.2.7", default-features = false, features = ["pure"] }
 enum_to_enum = "0.1.0"
 figment = "0.10.19"
+flashnet = { path = "crates/flashnet", default-features = false }
 # frost-core = "2.1.0"
 frost-core = { package = "frost-core-unofficial", version = "2.2.0" }
 # frost-secp256k1-tr = "2.1.0"

Cargo.toml

@@ -61,7 +61,10 @@ async fn send_htlc_alice_to_bob(
         .list_payments(ListPaymentsRequest {
             status_filter: Some(vec![PaymentStatus::Pending]),
             type_filter: Some(vec![PaymentType::Receive]),
-            spark_htlc_status_filter: Some(vec![SparkHtlcStatus::WaitingForPreimage]),
+            payment_details_filter: Some(PaymentDetailsFilter::Spark {
+                htlc_status: Some(vec![SparkHtlcStatus::WaitingForPreimage]),
+                transfer_refund_needed: None,
+            }),
             ..Default::default()
         })
         .await?;
@@ -89,7 +92,10 @@ async fn send_htlc_alice_to_bob(
         .list_payments(ListPaymentsRequest {
             status_filter: Some(vec![PaymentStatus::Pending]),
             type_filter: Some(vec![PaymentType::Send]),
-            spark_htlc_status_filter: Some(vec![SparkHtlcStatus::WaitingForPreimage]),
+            payment_details_filter: Some(PaymentDetailsFilter::Spark {
+                htlc_status: Some(vec![SparkHtlcStatus::WaitingForPreimage]),
+                transfer_refund_needed: None,
+            }),
             ..Default::default()
         })
         .await?;
@@ -239,7 +245,10 @@ async fn test_02_htlc_refund(
         .list_payments(ListPaymentsRequest {
             status_filter: Some(vec![PaymentStatus::Failed]),
             type_filter: Some(vec![PaymentType::Receive]),
-            spark_htlc_status_filter: Some(vec![SparkHtlcStatus::Returned]),
+            payment_details_filter: Some(PaymentDetailsFilter::Spark {
+                htlc_status: Some(vec![SparkHtlcStatus::Returned]),
+                transfer_refund_needed: None,
+            }),
             ..Default::default()
         })
         .await?;
@@ -268,7 +277,10 @@ async fn test_02_htlc_refund(
         .list_payments(ListPaymentsRequest {
             status_filter: Some(vec![PaymentStatus::Failed]),
             type_filter: Some(vec![PaymentType::Send]),
-            spark_htlc_status_filter: Some(vec![SparkHtlcStatus::Returned]),
+            payment_details_filter: Some(PaymentDetailsFilter::Spark {
+                htlc_status: Some(vec![SparkHtlcStatus::Returned]),
+                transfer_refund_needed: None,
+            }),
             ..Default::default()
         })
         .await?;

crates/breez-sdk/breez-itest/tests/spark_htlcs.rs

@@ -5,11 +5,12 @@ use breez_sdk_spark::{
     AssetFilter, BreezSdk, CheckLightningAddressRequest, ClaimDepositRequest,
     ClaimHtlcPaymentRequest, Fee, GetInfoRequest, GetPaymentRequest, GetTokensMetadataRequest,
     InputType, LightningAddressDetails, ListPaymentsRequest, ListUnclaimedDepositsRequest,
-    LnurlPayRequest, LnurlWithdrawRequest, OnchainConfirmationSpeed, PaymentStatus, PaymentType,
-    PrepareLnurlPayRequest, PrepareSendPaymentRequest, ReceivePaymentMethod, ReceivePaymentRequest,
-    RefundDepositRequest, RegisterLightningAddressRequest, SendPaymentMethod, SendPaymentOptions,
-    SendPaymentRequest, SparkHtlcOptions, SparkHtlcStatus, SyncWalletRequest, TokenIssuer,
-    UpdateUserSettingsRequest,
+    LnurlPayRequest, LnurlWithdrawRequest, OnchainConfirmationSpeed, PaymentDetailsFilter,
+    PaymentStatus, PaymentType, PrepareLnurlPayRequest, PrepareSendPaymentRequest,
+    PrepareTransferTokenRequest, ReceivePaymentMethod, ReceivePaymentRequest, RefundDepositRequest,
+    RegisterLightningAddressRequest, SendPaymentMethod, SendPaymentOptions, SendPaymentRequest,
+    SparkHtlcOptions, SparkHtlcStatus, SyncWalletRequest, TokenIssuer, TransferTokenRequest,
+    TransferType, UpdateUserSettingsRequest,
 };
 use clap::Parser;
 use rand::RngCore;
@@ -222,6 +223,20 @@ pub enum Command {
         /// The token identifiers to get metadata for
         token_identifiers: Vec<String>,
     },
+    TokenTransfer {
+        /// The amount to transfer
+        amount: u128,
+
+        #[clap(short = 'f', long, action = clap::ArgAction::SetTrue)]
+        from_bitcoin: bool,
+
+        /// The token identifier of the token
+        token_identifier: String,
+
+        /// The maximum slippage in basis points (1/100 of a percent)
+        #[clap(short = 's', long)]
+        max_slippage_bps: Option<u32>,
+    },
     GetUserSettings,
     SetUserSettings {
         /// Whether spark private mode is enabled.
@@ -286,7 +301,12 @@ pub(crate) async fn execute_command(
                     type_filter,
                     status_filter,
                     asset_filter,
-                    spark_htlc_status_filter,
+                    payment_details_filter: spark_htlc_status_filter.map(|statuses| {
+                        PaymentDetailsFilter::Spark {
+                            htlc_status: Some(statuses),
+                            transfer_refund_needed: None,
+                        }
+                    }),
                     from_timestamp,
                     to_timestamp,
                     sort_ascending,
@@ -585,6 +605,38 @@ pub(crate) async fn execute_command(
             print_value(&res)?;
             Ok(true)
         }
+        Command::TokenTransfer {
+            amount,
+            from_bitcoin,
+            token_identifier,
+            max_slippage_bps,
+        } => {
+            let transfer_type = if from_bitcoin {
+                TransferType::FromBitcoin
+            } else {
+                TransferType::ToBitcoin
+            };
+            let prepare_response = sdk
+                .prepare_transfer_token(PrepareTransferTokenRequest {
+                    amount,
+                    token_identifier,
+                    transfer_type,
+                })
+                .await?;
+            println!("Prepared transfer: {prepare_response:#?}\n Do you want to continue? (y/n)");
+            let line = rl.readline_with_initial("", ("y", ""))?.to_lowercase();
+            if line != "y" {
+                return Ok(true);
+            }
+            let res = sdk
+                .transfer_token(TransferTokenRequest {
+                    prepare_response,
+                    max_slippage_bps,
+                })
+                .await?;
+            print_value(&res)?;
+            Ok(true)
+        }
         Command::GetUserSettings => {
             let res = sdk.get_user_settings().await?;
             print_value(&res)?;

crates/breez-sdk/cli/src/command/mod.rs

@@ -13,9 +13,9 @@ uniffi = [
 openssl-vendored = ["openssl"]
 test-utils = []
 # TLS features
-default-tls = ["reqwest/default-tls", "breez-sdk-common/default-tls"]
-rustls-tls = ["reqwest/rustls-tls", "breez-sdk-common/rustls-tls"]
-native-tls = ["reqwest/native-tls", "breez-sdk-common/native-tls"]
+default-tls = ["reqwest/default-tls", "breez-sdk-common/default-tls", "flashnet/default-tls"]
+rustls-tls = ["reqwest/rustls-tls", "breez-sdk-common/rustls-tls", "flashnet/rustls-tls"]
+native-tls = ["reqwest/native-tls", "breez-sdk-common/native-tls", "flashnet/native-tls"]
 
 [lib]
 crate-type = ["staticlib", "cdylib", "lib"]
@@ -36,6 +36,7 @@ clap = { workspace = true, features = ["derive"] }
 dotenvy.workspace = true
 ecies.workspace = true
 figment = { workspace = true, features = ["env", "yaml"] }
+flashnet.workspace = true
 hex.workspace = true
 lnurl-models.workspace = true
 macros.workspace = true

crates/breez-sdk/core/Cargo.toml

@@ -19,6 +19,9 @@ pub enum SdkError {
     #[error("SparkSdkError: {0}")]
     SparkError(String),
 
+    #[error("Insufficient funds")]
+    InsufficientFunds,
+
     #[error("Invalid UUID: {0}")]
     InvalidUuid(String),
 
@@ -81,6 +84,21 @@ impl From<bitcoin::address::ParseError> for SdkError {
     }
 }
 
+impl From<flashnet::FlashnetError> for SdkError {
+    fn from(e: flashnet::FlashnetError) -> Self {
+        match e {
+            flashnet::FlashnetError::Network { reason, code } => {
+                let code = match code {
+                    Some(c) => format!(" (code: {c})"),
+                    None => String::new(),
+                };
+                SdkError::NetworkError(format!("{reason}{code}"))
+            }
+            _ => SdkError::Generic(e.to_string()),
+        }
+    }
+}
+
 impl From<persist::StorageError> for SdkError {
     fn from(e: persist::StorageError) -> Self {
         SdkError::StorageError(e.to_string())
@@ -125,7 +143,10 @@ impl From<serde_json::Error> for SdkError {
 
 impl From<SparkWalletError> for SdkError {
     fn from(e: SparkWalletError) -> Self {
-        SdkError::SparkError(e.to_string())
+        match e {
+            SparkWalletError::InsufficientFunds => SdkError::InsufficientFunds,
+            _ => SdkError::SparkError(e.to_string()),
+        }
     }
 }
 

crates/breez-sdk/core/src/error.rs

@@ -88,6 +88,8 @@ impl PaymentDetails {
                 SspUserRequest::LeavesSwapRequest(_) => PaymentDetails::Spark {
                     invoice_details: None,
                     htlc_details: None,
+                    transfer_info: None,
+                    transfer_refund_info: None,
                 },
                 SspUserRequest::ClaimStaticDeposit(request) => PaymentDetails::Deposit {
                     tx_id: request.transaction_id.clone(),
@@ -107,6 +109,8 @@ impl PaymentDetails {
             return Ok(Some(PaymentDetails::Spark {
                 invoice_details: Some(invoice_details.into()),
                 htlc_details: None,
+                transfer_info: None,
+                transfer_refund_info: None,
             }));
         }
 
@@ -115,6 +119,17 @@ impl PaymentDetails {
             return Ok(Some(PaymentDetails::Spark {
                 invoice_details: None,
                 htlc_details: Some(htlc_preimage_request.clone().try_into()?),
+                transfer_info: None,
+                transfer_refund_info: None,
+            }));
+        }
+
+        if transfer.transfer_type == TransferType::Transfer {
+            return Ok(Some(PaymentDetails::Spark {
+                invoice_details: None,
+                htlc_details: None,
+                transfer_info: None,
+                transfer_refund_info: None,
             }));
         }