Skip to content

breez/misty-breez

Repository files navigation

Build Android workflow Build iOS workflow CI workflow

Misty Breez

Misty Breez is a reference app built with the Breez SDK - Nodeless, showcasing best practices for delivering a frictionless bitcoin payment experience — and is available to partners as a white-label solution.

The app demonstrates how to design intuitive UI and UX with the Breez SDK, and offer end-users self-custodial Lightning payments — with no channels or setup fees — so they can send and receive bitcoin out-of-the-box.

Powered by a nodeless Lightning implementation, Misty Breez is a ready-made solution for partners to offer bitcoin payments in their own branded apps.

Features

  • Sending payments via protocols such as: Bolt11, Bolt12, LNURL-Pay, Lightning address, BTC address
  • Receiving payments via protocols such as: Bolt11, LNURL-Withdraw, LNURL-Pay, Lightning address, BTC address
  • A built-in, customizable [email protected] Lightning address
  • Receive payments even when the app is offline (requires notifications)
  • Self-custodial: keys are only held by users
  • Free open-source software (ofc!)

Installation

Android

Latest APK

iOS

TestFlight

For Developers

Build the lightning_tookit plugin

Misty Breez depends on Breez Liquid SDK's breez_liquid & flutter_breez_liquid plugin, so be sure to follow those instructions first.

After successfully having build the breez_liquid & flutter_breez_liquid make sure that breez-sdk-liquid and misty-breez are side by side like so:

breez-sdk-liquid/
├─ lib/
│  ├─ bindings/
│  ├─ core/
├─ packages/
│  ├─ dart/
│  ├─ flutter/
misty-breez/
├─ android/
├─ ios/

Add Firebase configuration

FlutterFire CLI currently requires the official Firebase CLI to also be installed, see Install the Firebase CLI for how to install it.

After installing Firebase CLI, log into Firebase using your Google account by running the following command:

firebase login

then, install the FlutterFire CLI by running the following command from any directory:

dart pub global activate flutterfire_cli

From Flutter project directory, run the following command to start the app configuration workflow:

flutterfire configure -p breez-technology -o lib/firebase/firebase_options.dart --platforms="android,ios" -a com.breez.liquid.l_breez -y

Android

flutter build apk --target=lib/main/main.dart 

iOS

flutter build ios --target=lib/main/main.dart 

Run

flutter run --target=lib/main/main.dart 

About

Misty Breez is a Breez SDK reference mobile app built with Flutter.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages