Breez.Sdk 0.3.0

.NET 6.0
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Breez.Sdk --version 0.3.0
NuGet\Install-Package Breez.Sdk -Version 0.3.0
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.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Breez.Sdk --version 0.3.0
#r "nuget: Breez.Sdk, 0.3.0"
#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.3.0

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

Breez SDK

Overview

The Breez SDK enables 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

https://user-images.githubusercontent.com/31890660/208511040-989ff42c-ceb8-4a34-b2cb-a17a0a8c0150.mp4

For a higher resolution video, click here.

Features

Screenshot_2023-06-27-20-18-57-35_e2d5b3f32b79de1d45acd1fad96fbb0f

Using the SDK

To get started with the Breez SDK, follow these examples.

API

API documentation is here.

Support

Join this telegram group.

Architecture

This diagram is a high-level description of the Breez SDK:

SDK Architecture

Command line

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

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.

TODOs

  • ‘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.4.1-rc2 82 5/8/2024
0.4.0 207 5/4/2024
0.4.0-rc5 258 4/17/2024
0.4.0-rc2 162 4/15/2024
0.4.0-rc1 191 4/11/2024
0.3.9 332 3/28/2024
0.3.8 186 3/21/2024
0.3.6 244 3/17/2024
0.3.5 212 3/15/2024
0.3.4 248 3/13/2024
0.3.3 142 3/11/2024
0.3.2 233 3/5/2024
0.3.1 429 2/15/2024
0.3.0 208 2/13/2024
0.2.15 107 1/26/2024
0.2.14 92 1/23/2024
0.2.12 307 12/13/2023
0.2.11 236 12/13/2023
0.2.10 313 11/26/2023
0.2.9 234 11/10/2023
0.2.7 375 10/24/2023
0.2.5 182 10/5/2023
0.2.3 269 9/5/2023
0.2.2 248 8/31/2023
0.2.1 199 8/31/2023
0.2.0 287 8/29/2023
0.0.3 260 7/28/2023
0.0.2 286 7/28/2023