mirror of
https://github.com/aljazceru/breez-sdk-docs.git
synced 2025-12-17 13:54:20 +01:00
Bump Rust snippets SDK dependency to v0.2.9
This commit is contained in:
@@ -5,10 +5,11 @@ use breez_sdk_core::*;
|
||||
|
||||
async fn buy(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: buy-btc
|
||||
let res = sdk.buy_bitcoin(
|
||||
BuyBitcoinRequest {
|
||||
let res = sdk
|
||||
.buy_bitcoin(BuyBitcoinRequest {
|
||||
provider: BuyBitcoinProvider::Moonpay,
|
||||
opening_fee_params: None})
|
||||
opening_fee_params: None,
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: buy-btc
|
||||
|
||||
|
||||
@@ -18,4 +18,4 @@ async fn connect_lsp(sdk: Arc<BreezServices>, lsp_id: String) -> Result<()> {
|
||||
// ANCHOR_END: connect-lsp
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -20,12 +20,14 @@ async fn get_current_rates(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn get_fiat_currencies_and_rates(sdk: Arc<BreezServices>) -> Result<Vec<(FiatCurrency, Rate)>> {
|
||||
async fn get_fiat_currencies_and_rates(
|
||||
sdk: Arc<BreezServices>,
|
||||
) -> Result<Vec<(FiatCurrency, Rate)>> {
|
||||
// ANCHOR: get-fiat-currencies-and-rates
|
||||
let supported_fiat_currencies = sdk.list_fiat_currencies().await?;
|
||||
let fiat_rates = sdk.fetch_fiat_rates().await?;
|
||||
|
||||
let mut rates_map : HashMap<String, Rate> = HashMap::new();
|
||||
let mut rates_map: HashMap<String, Rate> = HashMap::new();
|
||||
for rate in fiat_rates {
|
||||
rates_map.insert(rate.coin.to_string().to_lowercase(), rate);
|
||||
}
|
||||
@@ -33,7 +35,7 @@ async fn get_fiat_currencies_and_rates(sdk: Arc<BreezServices>) -> Result<Vec<(F
|
||||
let mut sorted = supported_fiat_currencies.clone();
|
||||
sorted.sort_by_key(|f| f.info.name.clone());
|
||||
|
||||
let mut result : Vec<(FiatCurrency, Rate)> = Vec::new();
|
||||
let mut result: Vec<(FiatCurrency, Rate)> = Vec::new();
|
||||
for currency in sorted {
|
||||
let rate = rates_map.get(¤cy.id.to_lowercase());
|
||||
if let Some(rate) = rate.cloned() {
|
||||
@@ -43,4 +45,4 @@ async fn get_fiat_currencies_and_rates(sdk: Arc<BreezServices>) -> Result<Vec<(F
|
||||
|
||||
Ok(result)
|
||||
// ANCHOR_END: get-fiat-currencies-and-rates
|
||||
}
|
||||
}
|
||||
|
||||
@@ -19,7 +19,7 @@ async fn getting_started() -> Result<Arc<BreezServices>> {
|
||||
breez_sdk_core::NodeConfig::Greenlight {
|
||||
config: GreenlightNodeConfig {
|
||||
partner_credentials: None,
|
||||
invite_code
|
||||
invite_code,
|
||||
},
|
||||
},
|
||||
);
|
||||
@@ -28,12 +28,7 @@ async fn getting_started() -> Result<Arc<BreezServices>> {
|
||||
config.working_dir = "path to an existing directory".into();
|
||||
|
||||
// Connect to the Breez SDK make it ready for use
|
||||
let sdk = BreezServices::connect(
|
||||
config,
|
||||
seed.to_vec(),
|
||||
Box::new(AppEventListener {}),
|
||||
)
|
||||
.await?;
|
||||
let sdk = BreezServices::connect(config, seed.to_vec(), Box::new(AppEventListener {})).await?;
|
||||
// ANCHOR_END: init-sdk
|
||||
|
||||
Ok(sdk)
|
||||
@@ -47,4 +42,4 @@ async fn getting_started_node_info(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR_END: fetch-balance
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,16 +5,7 @@ use breez_sdk_core::*;
|
||||
|
||||
async fn list_payments(sdk: Arc<BreezServices>) -> Result<Vec<Payment>> {
|
||||
// ANCHOR: list-payments
|
||||
let payments = sdk.list_payments(
|
||||
ListPaymentsRequest {
|
||||
filter: PaymentTypeFilter::All,
|
||||
from_timestamp: None,
|
||||
to_timestamp: None,
|
||||
include_failures: None,
|
||||
offset: None,
|
||||
limit: None
|
||||
}
|
||||
).await?;
|
||||
let payments = sdk.list_payments(ListPaymentsRequest::default()).await?;
|
||||
// ANCHOR_END: list-payments
|
||||
|
||||
Ok(payments)
|
||||
@@ -22,17 +13,15 @@ async fn list_payments(sdk: Arc<BreezServices>) -> Result<Vec<Payment>> {
|
||||
|
||||
async fn list_payments_filtered(sdk: Arc<BreezServices>) -> Result<Vec<Payment>> {
|
||||
// ANCHOR: list-payments-filtered
|
||||
let payments = sdk.list_payments(
|
||||
ListPaymentsRequest {
|
||||
filter: PaymentTypeFilter::Sent,
|
||||
let payments = sdk
|
||||
.list_payments(ListPaymentsRequest {
|
||||
filters: Some(vec![PaymentTypeFilter::Sent]),
|
||||
from_timestamp: Some(1696880000),
|
||||
to_timestamp: None,
|
||||
include_failures: Some(true),
|
||||
offset: None,
|
||||
limit: None
|
||||
}
|
||||
).await?;
|
||||
..Default::default()
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: list-payments-filtered
|
||||
|
||||
Ok(payments)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
use std::sync::Arc;
|
||||
|
||||
use anyhow::Result;
|
||||
use breez_sdk_core::*;
|
||||
use breez_sdk_core::InputType::LnUrlAuth;
|
||||
use breez_sdk_core::*;
|
||||
use log::{error, info};
|
||||
|
||||
async fn auth(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
@@ -11,7 +11,7 @@ async fn auth(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// keyauth://domain.com/auth?key=val
|
||||
let lnurl_auth_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu";
|
||||
|
||||
if let Ok(LnUrlAuth{data: ad}) = parse(lnurl_auth_url).await {
|
||||
if let Ok(LnUrlAuth { data: ad }) = parse(lnurl_auth_url).await {
|
||||
match sdk.lnurl_auth(ad).await {
|
||||
Ok(LnUrlCallbackStatus::Ok) => {
|
||||
info!("Successfully authenticated")
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
use std::sync::Arc;
|
||||
|
||||
use anyhow::Result;
|
||||
use breez_sdk_core::*;
|
||||
use breez_sdk_core::InputType::LnUrlPay;
|
||||
use breez_sdk_core::*;
|
||||
|
||||
async fn pay(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: lnurl-pay
|
||||
@@ -11,15 +11,16 @@ async fn pay(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
|
||||
let lnurl_pay_url = "lightning@address.com";
|
||||
|
||||
if let Ok(LnUrlPay{data: pd}) = parse(lnurl_pay_url).await {
|
||||
if let Ok(LnUrlPay { data: pd }) = parse(lnurl_pay_url).await {
|
||||
let amount_msat = pd.min_sendable;
|
||||
let comment = "Test payment".to_string();
|
||||
|
||||
sdk.lnurl_pay(LnUrlPayRequest {
|
||||
data: pd,
|
||||
amount_msat,
|
||||
comment: Some(comment)
|
||||
}).await?;
|
||||
comment: Some(comment),
|
||||
})
|
||||
.await?;
|
||||
}
|
||||
// ANCHOR_END: lnurl-pay
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
use std::sync::Arc;
|
||||
|
||||
use anyhow::Result;
|
||||
use breez_sdk_core::*;
|
||||
use breez_sdk_core::InputType::LnUrlWithdraw;
|
||||
use breez_sdk_core::*;
|
||||
|
||||
async fn withdraw(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: lnurl-withdraw
|
||||
@@ -10,15 +10,16 @@ async fn withdraw(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// lnurlw://domain.com/lnurl-withdraw?key=val
|
||||
let lnurl_withdraw_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7um9wdekjmmw843xxwpexdnxzen9vgunsvfexq6rvdecx93rgdmyxcuxverrvcursenpxvukzv3c8qunsdecx33nzwpnvg6ryc3hv93nzvecxgcxgwp3h33lxk";
|
||||
|
||||
if let Ok(LnUrlWithdraw{data: wd}) = parse(lnurl_withdraw_url).await {
|
||||
if let Ok(LnUrlWithdraw { data: wd }) = parse(lnurl_withdraw_url).await {
|
||||
let amount_msat = wd.min_withdrawable;
|
||||
let description = "Test withdraw".to_string();
|
||||
|
||||
sdk.lnurl_withdraw(LnUrlWithdrawRequest {
|
||||
data: wd,
|
||||
amount_msat,
|
||||
description: Some(description)
|
||||
}).await?;
|
||||
description: Some(description),
|
||||
})
|
||||
.await?;
|
||||
}
|
||||
// ANCHOR_END: lnurl-withdraw
|
||||
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
mod getting_started;
|
||||
mod receive_payment;
|
||||
mod send_payment;
|
||||
mod send_spontaneous_payment;
|
||||
mod list_payments;
|
||||
mod buy_btc;
|
||||
mod connecting_lsp;
|
||||
mod receive_onchain;
|
||||
mod send_onchain;
|
||||
mod fiat_currencies;
|
||||
mod getting_started;
|
||||
mod list_payments;
|
||||
mod lnurl_auth;
|
||||
mod lnurl_pay;
|
||||
mod lnurl_withdraw;
|
||||
mod lnurl_auth;
|
||||
mod fiat_currencies;
|
||||
mod buy_btc;
|
||||
mod receive_onchain;
|
||||
mod receive_payment;
|
||||
mod send_onchain;
|
||||
mod send_payment;
|
||||
mod send_spontaneous_payment;
|
||||
mod static_channel_backup;
|
||||
|
||||
use anyhow::Result;
|
||||
|
||||
@@ -5,8 +5,8 @@ use breez_sdk_core::*;
|
||||
|
||||
async fn generate_receive_onchain_address(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: generate-receive-onchain-address
|
||||
let swap_info = sdk.receive_onchain(
|
||||
ReceiveOnchainRequest { opening_fee_params: None } )
|
||||
let swap_info = sdk
|
||||
.receive_onchain(ReceiveOnchainRequest::default())
|
||||
.await?;
|
||||
|
||||
// Send your funds to the below bitcoin address
|
||||
@@ -32,7 +32,11 @@ async fn list_refundables(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn execute_refund(sdk: Arc<BreezServices>, refund_tx_fee_rate: u32, refundable: SwapInfo) -> Result<()> {
|
||||
async fn execute_refund(
|
||||
sdk: Arc<BreezServices>,
|
||||
refund_tx_fee_rate: u32,
|
||||
refundable: SwapInfo,
|
||||
) -> Result<()> {
|
||||
// ANCHOR: execute-refund
|
||||
let destination_address = "...".into();
|
||||
let sat_per_vbyte = refund_tx_fee_rate;
|
||||
@@ -40,8 +44,9 @@ async fn execute_refund(sdk: Arc<BreezServices>, refund_tx_fee_rate: u32, refund
|
||||
sdk.refund(RefundRequest {
|
||||
to_address: destination_address,
|
||||
sat_per_vbyte,
|
||||
swap_address: refundable.bitcoin_address
|
||||
}).await?;
|
||||
swap_address: refundable.bitcoin_address,
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: execute-refund
|
||||
|
||||
Ok(())
|
||||
@@ -49,10 +54,13 @@ async fn execute_refund(sdk: Arc<BreezServices>, refund_tx_fee_rate: u32, refund
|
||||
|
||||
async fn get_channel_opening_fees(sdk: Arc<BreezServices>, amount_msat: u64) -> Result<()> {
|
||||
// ANCHOR: get-channel-opening-fees
|
||||
let channel_fees = sdk.open_channel_fee(
|
||||
OpenChannelFeeRequest { amount_msat, expiry: None })
|
||||
let channel_fees = sdk
|
||||
.open_channel_fee(OpenChannelFeeRequest {
|
||||
amount_msat,
|
||||
expiry: None,
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: get-channel-opening-fees
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,18 +5,14 @@ use breez_sdk_core::*;
|
||||
|
||||
async fn receive_payment(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: receive-payment
|
||||
let res = sdk.receive_payment(
|
||||
ReceivePaymentRequest {
|
||||
let res = sdk
|
||||
.receive_payment(ReceivePaymentRequest {
|
||||
amount_msat: 3_000_000,
|
||||
description: "Invoice for 3000 sats".into(),
|
||||
cltv: None,
|
||||
expiry: None,
|
||||
opening_fee_params: None,
|
||||
preimage: None,
|
||||
use_description_hash: None
|
||||
..Default::default()
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: receive-payment
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,13 +6,16 @@ use log::info;
|
||||
|
||||
async fn get_current_fees(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: estimate-current-reverse-swap-total-fees
|
||||
let current_fees = sdk.fetch_reverse_swap_fees(
|
||||
ReverseSwapFeesRequest {
|
||||
let current_fees = sdk
|
||||
.fetch_reverse_swap_fees(ReverseSwapFeesRequest {
|
||||
send_amount_sat: Some(50_000),
|
||||
})
|
||||
.await?;
|
||||
|
||||
info!("Total estimated fees for reverse swap: {:?}", current_fees.total_estimated_fees);
|
||||
info!(
|
||||
"Total estimated fees for reverse swap: {:?}",
|
||||
current_fees.total_estimated_fees
|
||||
);
|
||||
// ANCHOR_END: estimate-current-reverse-swap-total-fees
|
||||
|
||||
Ok(())
|
||||
@@ -27,7 +30,11 @@ async fn list_current_fees(current_fees: ReverseSwapPairInfo) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn start_reverse_swap(sdk: Arc<BreezServices>, current_fees: ReverseSwapPairInfo, fee_rate: u32) -> Result<()> {
|
||||
async fn start_reverse_swap(
|
||||
sdk: Arc<BreezServices>,
|
||||
current_fees: ReverseSwapPairInfo,
|
||||
fee_rate: u32,
|
||||
) -> Result<()> {
|
||||
// ANCHOR: start-reverse-swap
|
||||
let destination_address = String::from("bc1..");
|
||||
let amount_sat = current_fees.min;
|
||||
@@ -37,8 +44,9 @@ async fn start_reverse_swap(sdk: Arc<BreezServices>, current_fees: ReverseSwapPa
|
||||
pair_hash: current_fees.fees_hash,
|
||||
amount_sat,
|
||||
sat_per_vbyte,
|
||||
onchain_recipient_address: destination_address
|
||||
}).await?;
|
||||
onchain_recipient_address: destination_address,
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: start-reverse-swap
|
||||
|
||||
Ok(())
|
||||
@@ -47,9 +55,12 @@ async fn start_reverse_swap(sdk: Arc<BreezServices>, current_fees: ReverseSwapPa
|
||||
async fn check_reverse_swap_status(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR: check-reverse-swaps-status
|
||||
for rs in sdk.in_progress_reverse_swaps().await? {
|
||||
info!("Reverse swap {} in progress, status is {:?}", rs.id, rs.status);
|
||||
info!(
|
||||
"Reverse swap {} in progress, status is {:?}",
|
||||
rs.id, rs.status
|
||||
);
|
||||
}
|
||||
// ANCHOR_END: check-reverse-swaps-status
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,4 +16,4 @@ async fn send_payment(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
// ANCHOR_END: send-payment
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,9 +9,10 @@ async fn send_spontaneous_payment(sdk: Arc<BreezServices>) -> Result<()> {
|
||||
|
||||
sdk.send_spontaneous_payment(SendSpontaneousPaymentRequest {
|
||||
amount_msat: 3_000_000,
|
||||
node_id
|
||||
}).await?;
|
||||
node_id,
|
||||
})
|
||||
.await?;
|
||||
// ANCHOR_END: send-spontaneous-payment
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user