Giter Club home page Giter Club logo

darth-wallet's Introduction

Darth Lightning Wallet

Get it on Google Play  Download on the App Store 

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

Darth 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

Darth Wallet 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 Darth Wallet.

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

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-ios-framework.md
  • Install Node packages: yarn
  • Generate proto files: yarn gen-proto
  • Install CocoaPods libs: cd ios && pod install
  • Setup team signing:
    • Open ios/Darth-Wallet/Darth-Wallet.xcworkspace with Xcode
    • Login with your Apple Developer account if Xcode asks you to
    • Click on Darth-Wallet 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
    • Intead 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

darth-wallet's People

Contributors

ar563 avatar bholm avatar blckbx avatar darth-coin avatar dependabot[bot] avatar fiatjaf avatar fridokus avatar git-sgmoore avatar hsjoberg avatar juanangel avatar matshenricson avatar mmzgc776 avatar reckless-satoshi avatar sesam avatar steliosrammos avatar t4t5 avatar transifex-integration[bot] avatar vafanassieff avatar wchancao avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.