mirror of
https://github.com/aljazceru/breez-sdk-liquid.git
synced 2026-01-17 04:54:20 +01:00
104 lines
4.5 KiB
Markdown
104 lines
4.5 KiB
Markdown
# Breez SDK - Nodeless *(Liquid Implementation)*
|
||
|
||
## **Overview**
|
||
|
||
The Breez SDK provides developers with a end-to-end solution for integrating self-custodial Lightning payments 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 peer-to-peer payments.
|
||
|
||
To provide the best experience for their end-users, developers can choose between the following implementations:
|
||
|
||
- [Breez SDK - Nodeless *(Liquid Implementation)*](https://sdk-doc-liquid.breez.technology/)
|
||
- [Breez SDK - Native *(Greenlight Implementation)*](https://sdk-doc.breez.technology/)
|
||
|
||
**The Breez SDK is free for developers.**
|
||
|
||
## **What Is the Breez SDK - Nodeless *(Liquid Implementation)*?**
|
||
|
||
It’s a nodeless integration that offers a self-custodial, end-to-end solution for integrating Lightning payments, utilizing the Liquid Network with on-chain interoperability and third-party fiat on-ramps. Using the SDK you'll 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, LNURL-Withdraw, LNURL-Pay, Lightning address, BTC address
|
||
|
||
**Key Features**
|
||
|
||
- [x] Send and receive Lightning payments
|
||
- [x] On-chain interoperability
|
||
- [x] Complete LNURL functionality
|
||
- [x] Multi-app support
|
||
- [x] Multi-device support
|
||
- [x] Real-time state backup
|
||
- [x] Keys are only held by users
|
||
- [x] USDT and multi-asset support on Liquid
|
||
- [x] Built-in fiat on-ramp
|
||
- [x] Free open-source solution
|
||
|
||
|
||
## Getting Started
|
||
|
||
Head over to the [Breez SDK - Nodeless *(Liquid Implementation)* documentation](https://sdk-doc-liquid.breez.technology/) to start implementing Lightning in your app.
|
||
|
||
You'll need an API key to use the Breez SDK - Nodeless *(Liquid Implementation)*. To request an API key is free — you just need to [complete this simple form.](https://breez.technology/request-api-key/#contact-us-form-sdk)
|
||
|
||
## **API**
|
||
|
||
API documentation is [here](https://breez.github.io/breez-sdk-liquid/breez_sdk_liquid/).
|
||
|
||
## **Command Line**
|
||
|
||
The [Breez SDK - Nodeless *(Liquid Implementation)* cli](https://github.com/breez/breez-sdk-liquid/tree/main/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](https://t.me/breezsdk) or email us at [contact@breez.technology](mailto:contact@breez.technology)
|
||
|
||
## How Does Nodeless *(Liquid Implementation)* Work?
|
||
|
||
The Breez SDK - Nodeless *(Liquid Implementation)* 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, Flutter, Python, React Native, and Swift.
|
||
- **core**: The core SDK - *Liquid* rust library.
|
||
- **packages**: Contains the plugin packages for Dart, Flutter, and 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](CONTRIBUTING.md) to get started.
|
||
|
||
## **SDK Development Roadmap**
|
||
|
||
- [x] Send/Receive Lightning payments
|
||
- [x] CLI Interface
|
||
- [x] Foreign languages bindings
|
||
- [x] Export/Import SDK data
|
||
- [x] Pay BTC on-chain
|
||
- [x] Receive via on-chain address
|
||
- [x] LNURL-Pay
|
||
- [x] LNURL-Withdraw
|
||
- [x] Send to a Lightning address
|
||
- [x] Receive via Lightning address
|
||
- [x] Webhook for receiving payments
|
||
- [x] Offline receive via notifications
|
||
- [x] Offline swaps via notifications
|
||
- [x] Real-time sync
|
||
- [x] External input parsers
|
||
- [x] Bolt12 send
|
||
- [x] BIP353 pay codes
|
||
- [x] Amountless BTC swaps
|
||
- [x] Support USTD and other Liquid assets
|
||
- [ ] USDT <-> LBTC swaps
|
||
- [ ] Pay fees with USDT
|
||
- [ ] Bolt12 receive
|
||
- [ ] Lower minimum payment amount
|
||
- [ ] TLV support
|
||
- [ ] WebAssembly
|