Breez.Sdk 0.5.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Breez.Sdk --version 0.5.2                

                    
                

            
NuGet\Install-Package Breez.Sdk -Version 0.5.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Breez.Sdk" Version="0.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Breez.Sdk --version 0.5.2                

                    
                

            
#r "nuget: Breez.Sdk, 0.5.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Breez.Sdk as a Cake Addin
#addin nuget:?package=Breez.Sdk&version=0.5.2

// Install Breez.Sdk as a Cake Tool
#tool nuget:?package=Breez.Sdk&version=0.5.2

Breez SDK - Greenlight

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:

The Breez SDK is free for developers.

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

What Is the Greenlight Implementation?

The Greenlight implementation is a cloud-based Lightning integration. It 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.

Core Functions

  • Sending payments via protocols such as: bolt11, keysend, lnurl-pay, lightning address, btc address.
  • Receiving payments via protocols such as: bolt11, lnurl-withdraw, btc address.
  • Interacting with a node e.g. balance, max allow to pay, max allow to receive, on-chain balance.

Key Features

  • On-chain interoperability
  • Built-in LSP
  • Integrated watchtower
  • LNURL functionality
  • Multi-app support
  • Multi-device support
  • Real-time state backup
  • Keys are only held by users
  • Fiat on-ramps
  • Open-source

Getting Started

Head over to the Breez SDK - Greenlight 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 the Greenlight Implementation Work?

The 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.

Breez SDK - Greenlight

Build & Test

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.

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
  • LSPS2 support
  • LSPS1 support
  • 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
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.3-rc2 47 11/18/2024
0.6.3-rc1 153 11/1/2024
0.6.2 150 10/14/2024
0.6.1 204 9/24/2024
0.6.0-rc1 258 9/17/2024
0.5.2 243 8/7/2024
0.5.1-rc6 157 7/19/2024
0.5.1-rc5 146 7/18/2024
0.5.1-rc4 71 7/17/2024
0.5.1-rc3 104 7/16/2024
0.5.1-rc1 130 7/16/2024
0.5.0 228 7/1/2024
0.4.3-rc1 169 6/24/2024
0.4.2-rc3 158 6/17/2024
0.4.2-rc2 162 6/16/2024
0.4.2-rc1 219 5/28/2024
0.4.1 196 5/15/2024
0.4.1-rc2 156 5/8/2024
0.4.0 247 5/4/2024
0.4.0-rc5 315 4/17/2024
0.4.0-rc2 218 4/15/2024
0.4.0-rc1 271 4/11/2024
0.3.9 442 3/28/2024
0.3.8 245 3/21/2024
0.3.6 291 3/17/2024
0.3.5 235 3/15/2024
0.3.4 365 3/13/2024
0.3.3 219 3/11/2024
0.3.2 308 3/5/2024
0.3.1 508 2/15/2024
0.3.0 380 2/13/2024
0.2.15 182 1/26/2024
0.2.14 156 1/23/2024
0.2.12 365 12/13/2023
0.2.11 308 12/13/2023
0.2.10 389 11/26/2023
0.2.9 329 11/10/2023
0.2.7 451 10/24/2023
0.2.5 258 10/5/2023
0.2.3 338 9/5/2023
0.2.2 308 8/31/2023
0.2.1 263 8/31/2023
0.2.0 354 8/29/2023
0.0.3 315 7/28/2023
0.0.2 334 7/28/2023