Breez SDK

Overview

The Breez SDK provides developers with an end-to-end solution for integrating instant, non-custodial bitcoin and stablecoins 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 value transfer.

What is the Breez SDK?

It’s a nodeless integration that offers a non-custodial, end-to-end solution for integrating bitcoin and stablecoins, utilizing the Bitcoin-native Layer 2 Lightning & Spark, with on-chain interoperability and third-party fiat on-ramps.

Installation

For React Native Apps

To install the package:

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

For Expo Managed Workflow

To install the package in an Expo project:

npx expo install @breeztech/breez-sdk-spark-react-native

Then add the plugin to your app.json or app.config.js:

{
  "expo": {
    "plugins": [
      "@breeztech/breez-sdk-spark-react-native"
    ]
  }
}

Plugin Options

To enable Passkey support, set enablePasskey to true. This adds webcredentials:keys.breez.technology to the iOS Associated Domains entitlement:

{
  "expo": {
    "plugins": [
      ["@breeztech/breez-sdk-spark-react-native", {
        "enablePasskey": true
      }]
    ]
  }
}

After adding the plugin, rebuild your app:

npx expo prebuild
npx expo run:ios
npx expo run:android

Note: This package contains native code and requires a custom development build. It will not work with Expo Go.

Usage

Head over to the Breez SDK documentation to start implementing instant bitcoin and stablecoins in your app or service.

import { connect, defaultConfig } from '@breeztech/breez-sdk-spark-react-native';
import RNFS from 'react-native-fs';

// ...

const mnemonic = 
  'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about';

let config = defaultConfig(Network.Mainnet);
config.apiKey = apiKey;

const sdk = await connect({
  config,
  mnemonic,
  storageDir: `${RNFS.DocumentDirectoryPath}/breezSdkSpark`,
});

Pricing

The Breez SDK is free for developers.

Support

Have a question for the team? Join us on Telegram or email us at [email protected].

Information for Maintainers and Contributors

This repository is used to publish a NPM package providing React Native bindings to the Breez SDK's underlying Rust implementation. The React Native bindings are generated using UniFFi Bindgen React Native.

Any changes to Breez SDK, the React Native bindings, and the configuration of this React Native package must be made via the spark-sdk repository.