Releases: breez/breez-sdk-liquid
Releases · breez/breez-sdk-liquid
Breez SDK - Nodeless (Liquid Implementation) 0.5.1
Features and Bug fixes
- Pay bolt12 offers
- Connect to an external signer
- Drain to a Liquid address
- Preimage information added to received payments
- Retrieve LNURL-Pay fees before paying
What's Changed
- Add notification plugin CI by @dangeross in #526
- Add prepare_lnurl_pay by @dangeross in #524
- Bump sdk-common by @dangeross in #527
- Fix SDK checkout by @dangeross in #528
- Fix list payments filter by @dangeross in #529
- Log exact error root cause when failing to lookup script address by @ok300 in #530
GetInfoResponse
: add fingerprint by @ok300 in #532- Support user implemented signer. by @roeierez in #495
- Add API key to RN example by @dangeross in #533
- Skip missed ticks by @dangeross in #534
- Add swift framework plists by @dangeross in #536
- Bring remaining u32 amount types to u64 by @ok300 in #537
- Receive Chain Swap: support refund even when lockup address is re-used by @ok300 in #471
- Prevent swap double claim by @dangeross in #542
- Reserved address pool by @dangeross in #531
- Send: Fix double-lockup when payment is TimedOut by @hydra-yse in #541
- Propagate signer interface changes by @ok300 in #544
- Send: Allow transition from
TimedOut
state toCreated
by @hydra-yse in #545 - Store claim_address for incoming chain swap when claiming by @dangeross in #548
- Onchain payment flow: add more logging by @ok300 in #551
- Fix chronological order of
list_payments
by @dangeross in #552 - Retry chain swap server lockup tx verification by @dangeross in #557
- Liquid/Lightning drain by @dangeross in #553
- Validate the pay_onchain address by @dangeross in #561
- Notification Plugin: Notify success when waiting for confirmation by @dangeross in #562
- Log errors on starting an SDK instance by @erdemyerebasmaz in #565
- Wipe storage cache in case of data corrupted issue by @roeierez in #566
- Android: Replaced with "$rootDir" with "$projectDir" by @larcho in #558
- Configurable cache dir by @dangeross in #567
- Fix Swift URL init compatibility by @dangeross in #569
- Add support for paying to BOLT12 by @ok300 in #549
- Add preimage to receive payment by @dangeross in #571
- Add precision validation for Moonpay call by @ok300 in #576
- Remove 32bit support by @ok300 in #575
- Remote csharp reference to 32bit binding by @ok300 in #577
New Contributors
Full Changelog: 0.4.0-rc3...0.5.1
Breez SDK Liquid 0.5.0-rc8
Features & Bug fixes
- Support paying bolt12 offer
- Fix preimage missing for received payments
- Add validation for fiat onramp amounts
What's Changed
- Android: Replaced with "$rootDir" with "$projectDir" by @larcho in #558
- Configurable cache dir by @dangeross in #567
- Fix Swift URL init compatibility by @dangeross in #569
- Add support for paying to BOLT12 by @ok300 in #549
- Add preimage to receive payment by @dangeross in #571
- Add precision validation for Moonpay call by @ok300 in #576
- Remove 32bit support by @ok300 in #575
- Remote csharp reference to 32bit binding by @ok300 in #577
New Contributors
Full Changelog: 0.5.0-rc5...0.5.0-rc8
Breez SDK Liquid 0.5.0-rc5
Features & Bug fixes
- Support connecting to external signer
- Retrieve LnurlPay fees before paying
- Fix chain swap refund for multiple lockup transactions
- Fix swift framework
- fix list_payment chronological order
What's Changed
- Add notification plugin CI by @dangeross in #526
- Add prepare_lnurl_pay by @dangeross in #524
- Bump sdk-common by @dangeross in #527
- Fix SDK checkout by @dangeross in #528
- Fix list payments filter by @dangeross in #529
- Log exact error root cause when failing to lookup script address by @ok300 in #530
GetInfoResponse
: add fingerprint by @ok300 in #532- Support user implemented signer. by @roeierez in #495
- Add API key to RN example by @dangeross in #533
- Skip missed ticks by @dangeross in #534
- Add swift framework plists by @dangeross in #536
- Bring remaining u32 amount types to u64 by @ok300 in #537
- Receive Chain Swap: support refund even when lockup address is re-used by @ok300 in #471
- Prevent swap double claim by @dangeross in #542
- Reserved address pool by @dangeross in #531
- Send: Fix double-lockup when payment is TimedOut by @hydra-yse in #541
- Propagate signer interface changes by @ok300 in #544
- Send: Allow transition from
TimedOut
state toCreated
by @hydra-yse in #545 - Store claim_address for incoming chain swap when claiming by @dangeross in #548
- Onchain payment flow: add more logging by @ok300 in #551
- Fix chronological order of
list_payments
by @dangeross in #552 - Retry chain swap server lockup tx verification by @dangeross in #557
- Liquid/Lightning drain by @dangeross in #553
- Validate the pay_onchain address by @dangeross in #561
- Notification Plugin: Notify success when waiting for confirmation by @dangeross in #562
- Log errors on starting an SDK instance by @erdemyerebasmaz in #565
- Wipe storage cache in case of data corrupted issue by @roeierez in #566
Full Changelog: 0.4.0-rc3...0.5.0-rc5
Breez SDK Liquid 0.4.0-rc3
Features & Bug fixes
- PendingConfirmation notification now is fixed for received payments via magic hints.
get_payment
by hash API function was addedlist_payments
now supports filtering by address- Fix incorrect chain swap refund fees
list_refundables
now reflects the correct refund amount in case of multiple utxos.
Breaking changes
default_config
function now must receive API key on mainnet.
What's Changed
- Fix lowball fee rates for onchain liquid tx by @roeierez in #498
- Fix pay onchain claim fee by @dangeross in #499
- Flutter uniFFI by @erdemyerebasmaz in #510
- Update
flutter_rust_bridge
to2.4.0
by @erdemyerebasmaz in #511 - Fix publishing of Flutter sources by @dangeross in #513
- Re-add convenience Flutter gen command by @dangeross in #514
- Chain swap cooperative refund: fix triggering of
refund_incoming_swap
by @ok300 in #517 - Fix: Incoming Chain Swap Refund by @hydra-yse in #522
list-refundables
: show refundable amount, not swap amount by @ok300 in #516- SDK: Require Breez API key globally by @hydra-yse in #520
- Get Payment by @dangeross in #476
- Add Breez electrum server for Liquid Mainnet by @ok300 in #525
Full Changelog: 0.3.4...0.4.0-rc3
Breez SDK Liquid 0.3.4
Bug fixes
- Fix error on sending an amount closed to the balance
- Use the correct claim fee rate on
pay_onchain
Breez SDK Liquid 0.3.2
Features
- Use lowball fees for direct Liquid transactions
- Send all funds is now supported in
pay_onchain
- Update default electrum URLs
Breaking Changes
- API key is now required: https://breez.technology/request-api-key/#contact-us-form-sdk
- Parse invoice: short_channel_id is now formatted as a string instead of a number
What's Changed
- Set optional prepare params as null by @dangeross in #472
melos pub-upgrade
by @erdemyerebasmaz in #477- Tests: fix swap handlers by switching to mock chain service by @hydra-yse in #475
- Sync: correctly detect payment by refund tx ID by @ok300 in #470
- Set
PaymentDetails
as mandatory, default to LiquidAddress by @hydra-yse in #474 - Fix payment details rebase by @dangeross in #483
- RN: prevent conversion of ReadableMap to HashMap by @dangeross in #482
- Change short_channel_id to string by @dangeross in #484
- Fix publish CI issues by @dangeross in #485
- prepare-pay-onchain: add an option to drain by @ok300 in #464
- Bump boltz client library by @ok300 in #486
- Build SDK bindings for Flutter by @dangeross in #488
- Fix the namespace conflict by @dangeross in #490
- Remove transaction by @dangeross in #493
- Add lowball broadcast support with API key for all transaction types by @hydra-yse in #489
- Send & Chain: localize refund flow to swap handlers by @hydra-yse in #407
- Chain: fix claim after refactoring changes by @hydra-yse in #496
- Update electrum URLs by @dangeross in #497
Full Changelog: 0.3.0...0.3.2
Breez SDK Liquid 0.3.0
Features
- LNURL-Pay support for receiving variant amounts
- Added Go & C# bindings
- Background receive via mobile notifications
- Enable direct payments to and from a Liquid address
- Fix fees calculation for pay_onchain
- Add sign_message and check_message API
- Emit pending confirmation for direct Liquid payments
- Added PaymentDetails to the Payment structure
Breaking changes
- Payment structure has changed to contain PaymentDetails
- PrepareReceiveRequest has changed and now consists of PaymentMethod. It serves as a single interface for receiving funds.
What's Changed
- Fix lowball broadcast by @dangeross in #418
- Send: Show regular onchain fees when MRH payment is detected by @hydra-yse in #421
- Bugfix: Correct the relative path on bindings scripts by @erdemyerebasmaz in #425
- Pause event notifications on first sync by @ok300 in #424
- Receive payment: remove retry backoff, reduce wait time to 1 sec by @ok300 in #431
- Allow working with local library on iOS by @erdemyerebasmaz in #434
- Downgrade Flutter to 3.22.3 by @erdemyerebasmaz in #438
- Address
cargo clippy
warnings by @erdemyerebasmaz in #439 - Bump
flutter_rust_bridge
to2.2.0
by @erdemyerebasmaz in #442 - Receive payment: remove MRH BIP21 amount validation by @ok300 in #448
- Confirm chain swap claims by @dangeross in #450
- Bugfix: Update production podpsec's version with version script by @erdemyerebasmaz in #447
- Depend on
sdk-common
withliquid
feature by @erdemyerebasmaz in #452 - Send/Receive: Add BIP21 support by @hydra-yse in #414
- Handle in RN codegen multiple fields in enum variant by @dangeross in #453
- Send: Consider request amount when preparing the payment by @hydra-yse in #454
- pay-onchain: fix user lockup fee calculation, boltz fee calculation by @ok300 in #459
- Fix chain swap limits validation by @ok300 in #456
- Add Go/CS bindings by @dangeross in #147
- Integrate webhooks by @dangeross in #410
- Add description hash to receive payment by @dangeross in #440
- Add
sign_message
andcheck_message
by @dangeross in #443 - Android notification plugin by @dangeross in #433
- Ensure non-MRH invoices use lockup amount for fee calculation by @hydra-yse in #461
- Swift notification plugin by @dangeross in #436
- Restore: Associate swap tx IDs from onchain data by @ok300 in #399
- Emit pending confirmation for liquid transactions by @roeierez in #462
- Update
flutter_rust_bridge
to2.3.0
by @erdemyerebasmaz in #465 - Fix C# symbol export by @dangeross in #466
- Add CLI commands to readme by @dangeross in #463
- Fix Swift macOS platform definition by @dangeross in #467
Full Changelog: 0.2.1...0.3.0
Breez SDK Liquid 0.2.1
Breez SDK Liquid 0.2.0
Features & Bug fixes
- Add way to set claim fee in chain swap
- But bitcoin via Moonpay
- Improve lightning receive performance
- Support custom description on lightning receive payments
- Set per wallet directory structure (Breaking change)
Breaking changes
We changed the wallet directory structure to be scoped by network and the wallet identifier, it prevents any collision when user sets the same working directory.
It is a breaking change as on upgrade the sdk will restore the onchain transactions but the swap info will be missing.
In order to get the swap info users can bakcup their sdk data before the upgrade and then restore after upgrade.
We do understand it is a bit annoying but better do this change at this early stage then leave it to later.
What's Changed
- Update LNURL URL success action validation by @dangeross in #395
- Set
PreparePayOnchainRequest
sat_per_vbyte
default value by @dangeross in #397 - Persistence: consolidate state filter by @ok300 in #400
- Buy Bitcoin by @dangeross in #398
- Add rustdocs generation to CI by @dangeross in #402
- Remove
sync
call when handling Boltz update by @ok300 in #401 - Fix payment position fluctuation in
list_payments
for Send by @ok300 in #404 - Test: Complete Chain Swap Tests by @hydra-yse in #392
- Update
BreezSDKLiquid
by @erdemyerebasmaz in #406 - Fix React Native CI by @dangeross in #408
- Update boltz-rust and add receive payment description by @dangeross in #409
- SDK: Add per-wallet directory structure for persister and lwk by @hydra-yse in #413
- Storage: Split based on network by @hydra-yse in #419
Full Changelog: 0.1.4...0.2.0
Breez SDK Liquid 0.1.4
Features & Bug fixes
- Send/Receive Lightning payments
- CLI Interface
- Foreign languages bindings
- Pay BTC on-chain
- Receive via on-chain address
- LNURL-Pay
- LNURL-Withdraw
- Send to a Lightning address
What's Changed
- Definining an Interface for the First Tests by @hydra-yse in #2
- Split models and rename wallet by @hydra-yse in #11
- Add support for logging by @ok300 in #14
- Add
get_info
method to wallet by @hydra-yse in #12 - Temporarily removing wallet cache persistence by @hydra-yse in #20
- Setting claim absolute fees to constant amount by @hydra-yse in #17
- Simplify workspace layout by @ok300 in #21
- Remove unused variable by @ok300 in #22
- Simplify range validation by @ok300 in #23
- Fix receive-payment by increasing claim absolute_fee by @ok300 in #24
- Simplify readme intros by @ok300 in #27
- Add SQLite primary methods for ongoing swaps by @hydra-yse in #28
- Consolidate wallet initialization by @ok300 in #30
- Simplify cargo dependencies by @ok300 in #35
- Add CI config by @ok300 in #37
- Add requested amount field to
receive_payment
by @hydra-yse in #33 - docs: add mention of necessary sqlite3 env setup by @ok300 in #40
- Add
onchain_amount_sat
field to received swaps by @hydra-yse in #41 - Remove unused dependency: tokio by @ok300 in #46
- Add automatic database directory on wallet startup by @hydra-yse in #47
- Derive Debug for relevant structs by @ok300 in #45
- Change to blinding variant
slip77
by @ok300 in #49 - Simplify init arg by @ok300 in #50
- Default to a 12-word mnemonic by @ok300 in #51
- Consolidate constants and default init values by @ok300 in #52
- Make network a mandatory arg of init() by @ok300 in #53
- Replace
get_chain()
with aFrom
trait by @ok300 in #54 - Consolidate reverse swap amounts calculation by @ok300 in #55
- Fix processing of the init network flag by @ok300 in #57
- Consolidate reverse swap onchain amount arg by @ok300 in #58
- Bump lwk to v0.3.0 by @ok300 in #61
- Bump
boltz-client
by @ok300 in #62 - Add support for pending send by @hydra-yse in #48
- Switch to single-threaded claiming by @hydra-yse in #63
- Remove Boltz internal txid logging by @hydra-yse in #64
- Update library tests with hardcoded data by @hydra-yse in #67
- Bump boltz-client, fix fee calculation by @ok300 in #68
- Differentiate between mainnet and testnet Electrum URLs by @ok300 in #69
- Add QR code to receive command in cli by @hydra-yse in #71
- Add transaction persistence to lwk instance by @hydra-yse in #70
- Add JSON response objects to cli by @hydra-yse in #81
- Switch to persisting invoice rather than amount by @hydra-yse in #66
- Add uniffi bindings by @ok300 in #59
- cli: Add log file by @hydra-yse in #87
- CLI: Use qrcode-rs instead of qr2term by @ok300 in #88
- Use a different DB file per network by @ok300 in #91
- Address uniffi feedback by @ok300 in #90
- Add fee persistence to payments by @hydra-yse in #83
- Remove
active_address
fromWalletInfo
by @ok300 in #95 - Rename BoltzError to Generic by @ok300 in #96
- LWK cache removal: remove dependency on hash tag by @ok300 in #102
- Remove receive options from CLI by @hydra-yse in #100
- Add backup and restore functionality by @hydra-yse in #65
- Add fee calculation to payment receive by @hydra-yse in #101
- Add pre-commit hook to repo by @hydra-yse in #94
- Add Android / iOS bindings by @dangeross in #97
- Add React Native bindings by @dangeross in #98
- Add React Native package by @dangeross in #99
- Add more details to
swap_status
error by @ok300 in #106 - Bump boltz-client by @ok300 in #108
- CLI: Change log write mode to "append" by @hydra-yse in #110
- CI: build bindings, add binding tests by @ok300 in #114
- Add CI step to check RN bindings by @ok300 in #115
- Integrate boltz-client fix for swapstatus by @ok300 in #111
- Expand error message on invalid swap state by @ok300 in #112
- Rename init() to connect() by @ok300 in #119
- [frb] : Add support for Dart/Flutter bindings - Part I by @erdemyerebasmaz in #116
- Add license by @dangeross in #122
- Rename project: Rust, uniffi by @ok300 in #133
- Rename project: android, swift and react native bindings by @dangeross in #134
- Add python bindings by @dangeross in #129
- Update receive to support only payer amount by @ok300 in #131
- Add more robust resolve for pending swaps by @hydra-yse in #137
- Rename workspace members (subfolders) by @ok300 in #149
- CLI: Allow choosing custom network by @ok300 in #151
- Integrate ureq fix from Boltz Client by @ok300 in #148
- Add request, response to API methods by @ok300 in #153
- Fix ordering of default UDL fields by @dangeross in #156
- Add kotlin multiplatform bindings by @dangeross in #128
- Add CI workflows for publishing by @dangeross in #130
- [frb] : Add support for Dart/Flutter bindings - Part II by @erdemyerebasmaz in #121
- Change secp256k1-zkp source by @dangeross in #160
- Rename wallet to SDK or LiquidSdk by @ok300 in #157
- Fix BindingWallet naming by @dangeross in #163
- CI: Check Dart/Flutter bindings & run static code analysis for Dart/Flutter packages by @erdemyerebasmaz in #161
- Fix conversion of enum's in Kotlin by @dangeross in #165
- Various CI fixes by @dangeross in #162
- Set line length back to 110 on Dart projects by @erdemyerebasmaz in #167
- Upgrade
send_payment
to v2 by @hydra-yse in #171 - [Draft] Migrate receive-payment to V2 API, use WS to get status by @ok300 in #166
- [Draft] Track swap status updates via websocket event stream by @ok300 in #170
- Add refund flow and improve v2 submarine state handling by @hydra-yse in #182
- Improve submarine swap flow by @hydra-yse in https://github.com/breez/breez-sdk-liquid...