Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify receive_onchain docs #1123

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Clarify receive_onchain docs #1123

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1feca69
Clarify `receive_onchain` docs
danielgranhao Nov 14, 2024
08579a9
Update libs/sdk-core/src/breez_services.rs
danielgranhao Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion libs/sdk-core/src/breez_services.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,8 @@ impl BreezServices {
/// Onchain receive swap API
///
/// Create and start a new swap. A user-selected [OpeningFeeParams] can be optionally set in the argument.
/// If set, and the operation requires a new channel, the SDK will try to use the given fee params.
/// If set, and the operation requires a new channel, the SDK will enforce the use the given fee params.
danielgranhao marked this conversation as resolved.
Show resolved Hide resolved
/// The provided [OpeningFeeParams] need to be valid at the time of swap redeeming.
///
/// Since we only allow one in-progress swap this method will return error if there is currently
/// a swap waiting for confirmation to be redeemed and by that complete the swap.
Expand Down
Loading