- Rust 84.2%
- Kotlin 4.3%
- Dart 3.5%
- Swift 2.5%
- JavaScript 1.7%
- Other 3.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
aa070e7d76* Recover from a stale wallet UTXO cache * Address review feedback * Address review feedback * Rework cache repair * Add drain tests |
||
| .githooks | ||
| .github | ||
| cli | ||
| lib | ||
| packages | ||
| regtest | ||
| .gitignore | ||
| .gitmodules | ||
| CONTRIBUTING.md | ||
| DEVELOPMENT.md | ||
| jitpack.yml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| rust-toolchain.toml | ||
Notice for Builders
For new partners looking to add instant, non-custodial bitcoin and stablecoins to their apps or services, we recommend building with the Breez SDK - Spark. For existing partners building with the Breez SDK - Liquid, we recommend moving to the Spark implementation ASAP.
Breez SDK - Liquid
Overview
The Breez SDK provides developers with an end-to-end solution for integrating instant, non-custodial bitcoin and stablecoins into their apps and services. It eliminates the need for third parties, simplifies the complexities of Bitcoin and Lightning, and enables seamless onboarding for billions of users to the future of value transfer.
The Breez SDK is free for developers.
What is the Breez SDK - Liquid?
It’s a nodeless integration that offers a non-custodial, end-to-end solution for integrating bitcoin, utilizing the Liquid Network & Lightning, with on-chain interoperability and third-party fiat on-ramps. Using the SDK you'll be able to:
- Send payments via various protocols such as: Bolt11, Bolt12, BIP353, LNURL-Pay, Lightning address, BTC address
- Receive payments via various protocols such as: Bolt11, Bolt12, BIP353, LNURL-Withdraw, LNURL-Pay, Lightning address, BTC address
Key Features
- Send and receive Lightning payments
- Send and receive on-chain transactions
- Complete LNURL & BOLT12 functionality
- USDT and multi-asset support on Liquid
- Lightning address & BIP353 support
- Multi-app support
- Multi-device support
- Real-time state backup
- WebAssembly support
- Keys are only held by users
- Built-in fiat on-ramp
- Free open-source solution
Getting Started
Head over to the Breez SDK - Liquid documentation to start implementing Lightning in your app.
You'll need an API key to use the Breez SDK. To request an API key is free — you just need to complete this simple form.
API
API documentation is here.
Command Line
The Breez SDK - Liquid cli is a command line client that allows you to interact with and test the functionality of the SDK.
Support
Have a question for the team? Join our Telegram channel or email us at contact@breez.technology
How does the Breez SDK - Liquid work?
The Breez SDK - Liquid uses submarine swaps and reverse submarine swaps to send and receive payments, enabling funds to move frictionlessly between the Lightning Network and the Liquid sidechain.
When sending a payment the SDK performs a submarine swap, converting L-BTC from a user’s Liquid wallet into sats on the Lightning Network, and sends them to the recipient.
When receiving a payment, the SDK performs a reverse submarine swap, converting incoming sats into L-BTC, and then deposits them in the user’s Liquid wallet.
Build & Test
- cli: Contains the Rust command line interface client for the SDK - Liquid.
- lib: Contains the root Rust cargo workspace.
- bindings: The ffi bindings for Kotlin, Python, React Native, and Swift.
- core: The core SDK - Liquid rust library.
- packages: Contains the plugin packages for Flutter & React Native.
Within each sub-project readme, there are instructions on how to build, test, and run.
Contributing
Contributions are always welcome. Please read our contribution guide to get started.
SDK Development Roadmap
- Send/Receive Lightning payments
- CLI Interface
- Foreign languages bindings
- Export/Import SDK data
- Pay BTC on-chain
- Receive via on-chain address
- LNURL-Pay
- LNURL-Withdraw
- Send to a Lightning address
- Receive via Lightning address
- Webhook for receiving payments
- Offline receive via notifications
- Offline swaps via notifications
- Real-time sync
- External input parsers
- Bolt12 send
- BIP353 pay codes
- Amountless BTC swaps
- Support USDT and other Liquid assets
- Pay fees with USDT
- Lower minimum payment amount
- WebAssembly
- Bolt12 receive
- Add fees via a dedicated portal
- USDT <-> LBTC swaps
- NWC
- WebLN