Skip to content
/ zeus Public
forked from ZeusLN/zeus

A mobile Bitcoin app for Lightning Network Daemon (lnd) node operators ⚡️

License

Notifications You must be signed in to change notification settings

Swissnode/zeus

 
 

Repository files navigation

Zeus

A mobile Bitcoin app for Lightning Network Daemon (lnd) node operators ⚡️

Notice: If you are looking for Zeus Server, the Lightning-based Point-of-Sale solution (unrelated to this project), please visit puzzle/zeus.

Zeus is built on TypeScript and React-Native. It runs on both iOS and Android.

Disclaimer: Zeus and Lightning in general are software projects in their early development stages. Please be wary when using Lightning and do not fund your node with more money than you are willing to lose.

App Store links

Get in touch with us

Connecting to your node

Currently, to use Zeus, you must have a Bitcoin Lightning node running Lightning Network Daemon (lnd).

You must provide Zeus with your node's hostname, port number, and the lnd macaroon you choose to use in hex format. If you need help converting your macaroon to hex format we wrote up a Node.js script that can use here. Alternatively, if you're running a Unix-based operating system (eg. macOS, Linux) you can run xxd -ps -u -c 1000 /path/to/admin.macaroon to generate your macaroon in hex format.

If you would like to learn more about running your own guide we suggest checking out the following guides:

Building Zeus from source

Don't trust, verify the code with your own two eyes. Then when ready proceed to the steps below based on your platform.

Android

  1. install and setup react-native and its related dependencies under "Building Projects with Native Code" on react-native's Getting Started page
  2. if using your phone, enable Developer mode and USB Debugging , then make sure it is connected to your computer by running adb devices
  3. install node dependencies with npm i
  4. open up your Android simulator or connect your phone and run react-native run-android

iOS

  1. install and setup react-native and its related dependencies under "Building Projects with Native Code" on react-native's Getting Started page
  2. install node dependencies with npm i
  3. apply patches with npm run patch
  4. open ios/zeus.xcodeproj in Xcode and hit Run

Contributing

Please be sure to run tsc to check for type errors and npm run test to run all tests.

If you are making cosmetic changes please test on both Android and iOS as things don't render exactly the same on both platforms.

Donations

If you'd like to help us with the cost of running Zeus project (iOS developer account, Google Play developer account, hosting) you can send a payment to 3Lbz4vdt15Fsa4wVD3Yk8uGf6ugKKY4zSc.

Thank you.

License

Distributed under the GNU Affero General Public License (AGPL v3). See LICENSE file.

About

A mobile Bitcoin app for Lightning Network Daemon (lnd) node operators ⚡️

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 94.4%
  • Java 2.7%
  • Objective-C 1.8%
  • Other 1.1%