Skip to content

Latest commit

 

History

History
118 lines (87 loc) · 5.49 KB

README.md

File metadata and controls

118 lines (87 loc) · 5.49 KB
Raw

Blixt Lightning Wallet

Get it on Google Play  Download on the App Store 

Blixt Wallet is an open source Lightning Bitcoin Wallet for Android with focus on usability and user experience, powered by lnd and Neutrino SPV.

Blixt Lightning Wallet screenshot

Features

  • Embedded lnd with Neutrino
  • Descriptive and clean transaction log
  • Receive payments
  • Autopilot
  • Pincode
  • Fingerprint
  • Optional Recipient/Sender name that will be displayed on transactions
  • Optional "Payer" field for bookkeeping when creating invoice
  • Scheduled sync of chain background job
  • Local channel backup
  • LNURL support (all sub-protocols: pay, channel, auth and withdraw)
  • Channel backup to Google Drive (Android) and iCloud (iOS)
  • WebLN browser
  • Support for Multi-Part Payments (MPP)
  • Integrated Tor support
  • Sending to Lightning Address
  • Automatically open channels when needed (LSP)
  • Receiving via Lightning Address by Lightning Box
  • NFC

Known Bugs

The wallet uses lnd that is young and might have bugs. Check lnd bug list here.

Translation

You can contribute to the project by translating the app via Transifex.

Build Steps

Blixt targets three platforms right now: Web, Android and iOS.

The web target is only used for prototyping and is not a real wallet.

Web

The easiest way get started is to build the web version, because you only need NodeJS and Yarn installed. For the other targets you need to install their respective toolchains and also golang & gomobile in order to build lnd for Blixt.

The web version is not used as a real wallet and is only for fast prototyping. It's useful if you want to make design and GUI changes.

  • Install Node and Yarn
  • Install Node packages: yarn
  • Generate proto files: yarn gen-proto
  • Start the web server: yarn web

Android

To start the application:

  • Run: yarn start-metro
  • Run: yarn android:mainnet-debug or yarn android:testnet-debug

For building Blixt Android on Windows, follow the additional build steps here.

iOS

To build the iOS version, a computer running macOS is required. You also need an Apple Developer account, although you do not need to be enrolled in the Developer Program.

  • Install Xcode, Node and Yarn
  • Build lnd for iOS by following the steps in Build Lnd for mobile
  • Install Node packages: yarn
  • Generate proto files: yarn gen-proto
  • Install CocoaPods libs: cd ios && pod install
  • Setup team signing:
    • Open ios/BlixtWallet/BlixtWallet.xcworkspace with Xcode
    • Login with your Apple Developer account if Xcode asks you to
    • Click on BlixtWallet in the left column
    • Click on the Signing & Capabilities tab
    • Choose your Team in the dropdown and choose a new unique Bundle Identifier (cannot be the same as the ones released on the App Store). Do this for every configuration

To start the application:

  • Run: yarn start-metro
  • Run: yarn ios:mainnet-debug --device "<your device name>" or build from Xcode

macOS

To build the macOS version, a computer running macOS is required.

  • Install Xcode, Node and Yarn
  • Build lnd for macOS by following the steps in build-ios-framework.md
    • Instead of running make ios, run make macos or make apple
  • Install Node packages: yarn
  • Generate proto files: yarn gen-proto
  • Install CocoaPods libs: cd macos && pod install

To start the application:

  • Run: yarn start-metro
  • Build app from Xcode or run yarn macos:mainnet-debug

Commit and Code-Style

Follow the code style of the file you are working in. For commits, make descriptive and atomic git commits.

License

MIT