aljaz/breez-sdk-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/breez-sdk-docs.git synced 2025-12-17 05:44:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document swap limits

Browse Source
This commit is contained in:
Roei Erez
2023-12-12 17:29:31 +02:00
parent 4ff204dadc
commit 78b91e9373
9 changed files with 84 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
snippets/csharp/ReceiveOnchain.cs
View File

@@ -2,83 +2,84 @@ using Breez.Sdk;
public class ReceiveOnchainSnippets
{
public void ReceiveOnchain(BlockingBreezServices sdk)
public void ReceiveOnchain(BlockingBreezServices sdk)
{
// ANCHOR: generate-receive-onchain-address
try
{
// ANCHOR: generate-receive-onchain-address
try
{
var swapInfo = sdk.ReceiveOnchain(new ReceiveOnchainRequest());
// Send your funds to the below bitcoin address
var address = swapInfo.bitcoinAddress;
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: generate-receive-onchain-address
var swapInfo = sdk.ReceiveOnchain(new ReceiveOnchainRequest());
// Send your funds to the below bitcoin address
var address = swapInfo.bitcoinAddress;
Console.WriteLine($"Minimum amount allowed to deposit in sats: {swapInfo.minAllowedDeposit}");
Console.WriteLine($"Maximum amount allowed to deposit in sats: {swapInfo.maxAllowedDeposit}");
}
public void GetInProgressSwap(BlockingBreezServices sdk)
catch (Exception)
{
// ANCHOR: in-progress-swap
try
{
var swapInfo = sdk.InProgressSwap();
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: in-progress-swap
// Handle error
}
// ANCHOR_END: generate-receive-onchain-address
}
public void ListRefundables(BlockingBreezServices sdk)
public void GetInProgressSwap(BlockingBreezServices sdk)
{
// ANCHOR: in-progress-swap
try
{
// ANCHOR: list-refundables
try
{
var refundables = sdk.ListRefundables();
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: list-refundables
var swapInfo = sdk.InProgressSwap();
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: in-progress-swap
}
public void ExecuteRefund(BlockingBreezServices sdk, uint refundTxFeeRate, SwapInfo refundable)
public void ListRefundables(BlockingBreezServices sdk)
{
// ANCHOR: list-refundables
try
{
// ANCHOR: execute-refund
var destinationAddress = "...";
var satPerVbyte = refundTxFeeRate;
try
{
var result = sdk.Refund(
new RefundRequest(
refundable.bitcoinAddress,
destinationAddress,
satPerVbyte));
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: execute-refund
var refundables = sdk.ListRefundables();
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: list-refundables
}
public void GetChannelOpeningFees(BlockingBreezServices sdk, ulong amountMsat)
public void ExecuteRefund(BlockingBreezServices sdk, uint refundTxFeeRate, SwapInfo refundable)
{
// ANCHOR: execute-refund
var destinationAddress = "...";
var satPerVbyte = refundTxFeeRate;
try
{
// ANCHOR: get-channel-opening-fees
try
{
var channelFees = sdk.OpenChannelFee(
new OpenChannelFeeRequest(amountMsat));
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: get-channel-opening-fees
var result = sdk.Refund(
new RefundRequest(
refundable.bitcoinAddress,
destinationAddress,
satPerVbyte));
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: execute-refund
}
public void GetChannelOpeningFees(BlockingBreezServices sdk, ulong amountMsat)
{
// ANCHOR: get-channel-opening-fees
try
{
var channelFees = sdk.OpenChannelFee(
new OpenChannelFeeRequest(amountMsat));
}
catch (Exception)
{
// Handle error
}
// ANCHOR_END: get-channel-opening-fees
}
}

2
snippets/dart_snippets/lib/receive_onchain.dart
View File

@@ -9,6 +9,8 @@ Future<SwapInfo> generateReceiveOnchainAddress() async {
// Send your funds to the below bitcoin address
String address = swapInfo.bitcoinAddress;
print(address);
print("Minimum amount allowed to deposit in sats: ${swapInfo.minAllowedDeposit}");
print("Maximum amount allowed to deposit in sats: ${swapInfo.maxAllowedDeposit}");
return swapInfo;
// ANCHOR_END: generate-receive-onchain-address
}

3
snippets/go/receive_onchain.go
View File

@@ -12,6 +12,9 @@ func GenerateReceiveOnchainAddress() {
// Send your funds to the below bitcoin address
address := swapInfo.BitcoinAddress
log.Printf("%v", address)
log.Printf("Minimum amount allowed to deposit in sats: %v", swapInfo.minAllowedDeposit)
log.Printf("Maximum amount allowed to deposit in sats: %v", swapInfo.maxAllowedDeposit)
}
// ANCHOR_END: generate-receive-onchain-address
}

2
snippets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/ReceiveOnchain.kt
View File

@@ -8,6 +8,8 @@ class ReceiveOnchain {
val swapInfo = sdk.receiveOnchain(ReceiveOnchainRequest())
// Send your funds to the bellow bitcoin address
val address = swapInfo.bitcoinAddress
// Log.v("Breez", "Minimum amount allowed to deposit in sats: ${swapInfo.minAllowedDeposit}")
// Log.v("Breez", "Maximum amount allowed to deposit in sats: ${swapInfo.maxAllowedDeposit}")
} catch (e: Exception) {
// handle error
}

2
snippets/python/src/receive_onchain.py
View File

@@ -7,6 +7,8 @@ def generate_receive_onchain_address(sdk_services):
# Send your funds to the below bitcoin address
address = swap_info.bitcoin_address
print("Minimum amount allowed to deposit in sats: {}", swap_info.min_allowed_deposit);
print("Maximum amount allowed to deposit in sats: {}", swap_info.max_allowed_deposit);
# ANCHOR_END: generate-receive-onchain-address
except Exception as error:
print(error)

2
snippets/react-native/receive_onchain.ts
View File

@@ -12,6 +12,8 @@ const exampleReceiveOnchain = async () => {
// Send your funds to the below bitcoin address
const address = swapInfo.bitcoinAddress
console.log("Minimum amount allowed to deposit in sats: {}", swapInfo.minAllowedDeposit);
console.log("Maximum amount allowed to deposit in sats: {}", swapInfo.maxAllowedDeposit);
// ANCHOR_END: generate-receive-onchain-address
}

2
snippets/rust/src/receive_onchain.rs
View File

@@ -11,6 +11,8 @@ async fn generate_receive_onchain_address(sdk: Arc<BreezServices>) -> Result<()>
// Send your funds to the below bitcoin address
let address = swap_info.bitcoin_address;
info!("Minimum amount allowed to deposit in sats: {}", swap_info.min_allowed_deposit);
info!("Maximum amount allowed to deposit in sats: {}", swap_info.max_allowed_deposit);
// ANCHOR_END: generate-receive-onchain-address
Ok(())

2
snippets/swift/BreezSDKExamples/Sources/ReceiveOnchain.swift
View File

@@ -14,6 +14,8 @@ func generateReceiveOnchainAddress(sdk: BlockingBreezServices) -> String? {
// Send your funds to the bellow bitcoin address
let address = swapInfo?.bitcoinAddress
print("Minimum amount allowed to deposit in sats: \(swapInfo.minAllowedDeposit)")
print("Maximum amount allowed to deposit in sats: \(swapInfo.maxAllowedDeposit)")
// ANCHOR_END: generate-receive-onchain-address
return address