Installing

The Breez SDK is available in the following platforms:

Android

We recommend integrating the Breez SDK as Gradle dependency from our Maven repository.

To do so, add the following to your Gradle dependencies:

repositories {
  maven {
      url("https://mvn.breez.technology/releases")
  }
}

dependencies {
  implementation("breez_sdk:bindings-android:<version>")
}

iOS

We recommend using our official Swift package: breez/breez-sdk-swift.

React Native

We recommmend using the official npm package:

$ npm install @breeztech/react-native-breez-sdk

or

$ yarn add @breeztech/react-native-breez-sdk

C#

Currently c# is built from source only. Please visit the sdk-bindings project for instructions.

rust

Currently rust is still not accessible via cargo and is needed to be built from source. Please visit the sdk-core project for instructions.