The Breez SDK enables mobile developers to integrate Lightning and bitcoin payments into their apps with a very shallow learning curve. The use cases are endless – from social apps that want to integrate tipping between users to content-creation apps interested in adding bitcoin monetization. Crucially, this SDK is an end-to-end, non-custodial, drop-in solution powered by Greenlight, a built-in LSP, on-chain interoperability, third-party fiat on-ramps, and other services users and operators need. The Breez SDK is free for developers.
The Breez SDK provides the following services:
- Sending payments (via various protocols such as: bolt11, keysend, lnurl-pay, lightning address, etc.)
- Receiving payments (via various protocols such as: bolt11, lnurl-withdraw, etc.)
- Fetching node status (e.g. balance, max allow to pay, max allow to receive, on-chain balance, etc.)
- Connecting to a new or existing node.
Download our one pager here.
To get started with the Breez SDK, follow these examples.
Note: in order to use the Breez SDK you need an API key from Breez, please email us at contact@breez.technology for more information.
demo.mp4
For a higher resolution video, click here.
To get started with the Breez SDK, follow these examples.
API documentation is here.
Join this telegram group.
This diagram is a high-level description of the Breez SDK:
Breez SDK CLI Wallet created by @bilthon is CLI client that allows you to test the functionality of the Breez SDK.
The libs folder contains three sub folders and is a structured as a cargo workspace:
- sdk-core: the core SDK rust library.
- sdk-bindings: ffi bindings for Kotlin, Python, Swift, C# and Go.
- sdk-flutter: a flutter plugin (includes ffi bindings for dart).
- sdk-react-native: a react-native plugin.
The tools folder contains a simple command line interface (sdk-cli) to the SDK. See the instructions in each sub project readme on how to build, test and run.
- ‘On-the-fly’ channel creation
- Send/receive bolt11
- LNURL-Pay
- LNURL-Withdraw
- Backup/restore using mnemonics
- Send zero-amount invoices
- Fiat currencies
- Send spontaneous payments
- Send to a Lightning address
- Send to BIP 21
- cli inteface
- Swift bindings
- Kotlin bindings
- API key
- Receive via on-chain address
- React Native bindings
- LNURL-Auth
- Send to an on-chain address
- MoonPay fiat on-ramp
- C# bindings
- Python bindings
- Spend all funds
- Webhook for receiving payments
- Mobile Notifications
- Offline receive via notifications
- Simplifed key management (cloud key backup)
- Performance optimizations
- Improve key share
- Close channels to a predefined address
- Make mempool.space dependency optional
- Receive 0 amount invoice via LSP (unified QR)
- Send/receive bolt12
- Async payments
- LDK support
- Splicing
- WebAssembly support