breez / c-breez

breez

In order to build breez you will need to install gomobile and go 1.19.x. If you install go from homebrew, you will have to ensure the GOPATH environment variable is set yourself.

Prepare your environment

git clone https://github.com/breez/breez.git
go install golang.org/x/mobile/cmd/gomobile
go install golang.org/x/mobile/cmd/gobind
export PATH=$PATH:$GOPATH/bin
gomobile init

Building breez for Android

You need to install the ndk as part of your sdk Tools. If you have a separate ndk installed then make sure to set the ANDROID_NDK_HOME environment variable to your ndk install location.

export ANDROID_HOME=<your android sdk directory>

Or in case you want to use a direct ndk path

export ANDROID_NDK_HOME=<your android ndk directory>

If you are using NDK 24+, install NDK r19 and point ANDROID_NDK_HOME to it's folder due to gomobile incompatibility. Alternatively, you can add -androidapi 19 to gomobile command in build script.

If the library will be run on an emulator target, add -ldflags=-extldflags=-Wl,-soname,libgojni.so to gomobile command in build script.

Then you are ready to run the build:

./build.sh

The file breez.aar will be built in build/android/

Building breez for iOS

./build-ios.sh

The bindings.framework will be built in build/ios/

c-breez's Issues

dummy issue for images

Implement user avatar and name

Implement send to BTC address

Expose the fee rates for greenlight presets

Support zero channel reserve

UX issues with lnurl pay

I was able to pay to tippin service using lnurl pay, here are some issues I found on the way:

1. When copied the url and then switched the app I used the "Paste invoice or node id" menu and I experienced a few seconds of delay before I saw the lnurl withdraw form, I think we need a loader during the time we access the service API.
2. After payment (which was successful) I got error flushbar, see screenshot.
3. After payment I pressed back (from the Android button) and saw the LNURL Invoice page again, it seems that it was still on the stack.

Integrate LNURL Auth

Create native signer once from dart and reuse it.

This is instead of calling init anytime we need to handle a message.

support zero-conf channels

Implement Home page

Currently the home page is broken due to removed code and outdated files.
We need to take this opportunity and clean it up alongside adding the implementation

Add mnemonics for seed

Routing hints are not encoded into invoice

Verified that the channel was private and peer was connected

Remove not used widgets from widgets directory

Make initial wallet home screen looks like Breez

Title should be cBreez (@kingonly is that OK?)

Lnurl Withdraw issue

Currently when scanning an lnurl withdraw QR the dialog is not shown and logs indicate layout issue.

Implement outgoing payment result stream

Implement outgoing payment result stream to unify all payment success/failures into one stream (with their contextual data such as lnurlData) and handle them in one central handler for UI operations(showing flusbar, closing/opening dialogs etc.) to ensure there's a valid BuildContext at all times.

Date Filter does not open due to missing firstDate on paymentsModel with a loaded tx list

Make VLS rust signer compatible with c-lightning

This is to be able to build a pure rust program for mobile.

Implement send payment via invoice

Support multi channels

Implement automatic build for iOS using github actions

Implement send spontaneous payment

Display NoConnectionDialog when there's no internet connection available

Implement LNUrl pay

Implement unit tests for account bloc

Handle gRPC channel reconnection

Occasionally the gRPC channel in dart disconnects and failed to recover.

Implement lock screen

Implement send on-chain funds of closed channels

Display EnterPaymentInfoDialog if clipboard can't be parsed after pressing "Paste Invoice or ID"

fix payment list filter on dark theme

Currently filter doesn't render well

Implement payment list item and payment dialog

This is about making sure we render correctly (same as Breez wallet) the various payment items both in list and in the dialog.
We should consider here the various types of transactions (send/receive/lnurl/).
At this stage we still didn't implement swapping funds and still don't have API for closed channels so these specific types shouldn't be included for now.

Implement signer in mobile package

Implement receive payment

Add warning (Exit breez) when pressing back from home page

Add useful node commands to developers screen

For debugging and support purposes it is better to add some commands to be invoked directly on the node API (Not the NodeService):

1. getNodeInfo
2. listFunds
3. listPeers
4. getPayments
5. getInvoices

Handle gRPC errors when creating an invoice

Use loader when creating invoice

Creating invoice is using the greenlight service and during that time we need to show a loader similar to how we are showing in breez wallet.

Upgrade breez theme to new flutter version

Logs redirection to file and add send logs from developers screen

Allow creating invoice using an existing preimage

Theme issues

Some theming issues, see bellow screenshots. Should be like breezmobile.

Error handling when paying invoice

Currently errors are not shown when payment fails.
The processing payment dialog is missing that logic.

Add Lnurl metadata to payment list item

We want to add the lnurl metadata to the payment list the same way we do in Breez.
Also populate the list item title in these cases.

Implement automatic build for android using github actions

Implement payments list. -adapt it to the new model

Upgrade to Flutter 3.0

Upgrade to Flutter 3.0,
Run dart fix and upgrade packages to latest

Implement receive via BTC address SDK functionality

• create swap address, generate script and persist swap info
• API for listing swaps
• Redeem swap (receive via lightning)
• Refund swap (when swap expires)
• Onchain/Mempool monitoring swap addresses
• Automatic redeem
• Binding API
• Adjustable refund fees

Implement unit tests for InvoiceBloc

Implement open incoming channel from LSP

This is until we have zero-conf implementation where in that point we will create channel on the fly

Implement LNUrl withdrawal