⚠️ DEPRECATION NOTICE

This repository (breez-sdk-greenlight) is deprecated and no longer maintained. It's highly recommend migrating to Breez SDK – Nodeless:

• Liquid implementation
• Spark beta

Breez SDK - Native (Greenlight Implementation)

Overview

What Is the Breez SDK?

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 - Native (Greenlight Implementation)
• Breez SDK - Nodeless (Liquid Implementation)

The Breez SDK is free for developers.

Learn more about the Breez SDK — download our one pager here.

What Is the Breez SDK - Native (Greenlight Implementation)?

It's a cloud-based Lightning integration that offers a self-custodial, end-to-end solution for integrating Lightning payments, utilizing nodes-on-demand provided by Blockstream’s Greenlight, with built-in Lightning Service Providers (LSP), on-chain interoperability, and third-party fiat on-ramps. Using the SDK you'll able to:

• Send payments via various protocols such as: Bolt11, LNURL-Pay, Lightning address, BTC address
• Receive payments via various protocols such as: Bolt11, LNURL-Withdraw, LNURL-Pay, Lightning address, BTC address

Key Features

• On-chain interoperability
• Built-in LSP
• Integrated watchtower
• Complete LNURL functionality
• Multi-app support
• Multi-device support
• Real-time state backup
• Keys are only held by users
• Built-in fiat on-ramp
• Free open-source solution

Getting Started

Head over to the Breez SDK - Native (Greenlight Implementation) documentation to start implementing Lightning into your app.

Note: You'll need an API key to use the Greenlight implementation. For more info, email us at contact@breez.technology.

API

API documentation is here.

Command line

Breez sdk-cli is a command line client that allows you to interact with and test the functionality of the Breez SDK.

Support

Have a question for the team? Join our Telegram channel or email us at contact@breez.technology

How Does Native (Greenlight Implementation) Work?

The Breez SDK - Native (Greenlight implementation) allows end-users to send and receive payments using the Breez SDK through several key components:

• Signer: The app integrating the Breez SDK runs a validating signer that interacts with the end-user node.
• Node: End-user nodes are hosted on Blockstream’s Greenlight cloud infrastructure. The SDK creates a node when an end-user needs to send or receive a payment via the Lightning Network. Each end-user has their own node.
• Lightning Service Providers (LSP): Design partners use LSPs, operated by entities other than Breez, to facilitate channel connectivity. LSP nodes are connected to Breez’s routing nodes, which in turn connect to other nodes in the Lightning Network.
• Submarine Swaps: Submarine swaps and reverse submarine swaps are used for transactions involving BTC addresses (on-chain). When receiving funds, submarine swaps convert the BTC to the user node on the Lightning Network. When sending funds to BTC addresses, reverse submarine swaps convert Lightning Network funds back to BTC.

Build & Test

The libs folder contains three sub-folders and is a structured as a cargo workspace:

• sdk-common: common SDK functionality for Breez SDK - Native and Breez SDK - Nodeless.
• 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.

Contributing

Contributions are always welcome. Please read our contribution guide to get started.

SDK Development Roadmap

• ‘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
• Offline receive via notifications
• Taproot swaps
• Send/receive bolt12
• Simplifed key management (cloud key backup)
• WebAssembly support
• Improve key share
• Close channels to a predefined address
• Make mempool.space dependency optional
• Receive 0 amount invoice via LSP (unified QR)
• Async payments
• LDK support
• Splicing