Misty Breez

Misty Breez is a mobile app built with Flutter that serves as a reference implementation for the Breez SDK - Nodeless that:

Demonstrates the full capabilities of building with the SDK
Showcases best practices for designing an intuitive UI and UX for self-custodial Lightning payments
Offers a ready-made solution that can be white-labeled for partners looking to build a new app

Features

Sending payments via various protocols such as: Bolt11, Bolt12, BIP353, LNURL-Pay, Lightning address, BTC address
Receiving payments via various protocols such as: Bolt11, LNURL-Withdraw, LNURL-Pay, Lightning address, BTC address
A built-in, customizable user@breez.fun 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!)

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