zeus

A mobile Bitcoin wallet fit for the gods. ⚡️ Est. 563345

View the Project on GitHub ZeusLN/zeus

ZEUS

ZEUS screenshots

ZEUS is a mobile Bitcoin/Lightning wallet and remote node manager for LND and Core Lightning. ⚡️

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

Read more on our documentation site.

Get in touch with us

Features

Connecting ZEUS to your node

You can connect ZEUS to a remote Bitcoin Lightning node running Lightning Network Daemon (lnd), eclair, or Core Lightning using the REST or Sparko API.

You must provide ZEUS with your node’s hostname, port number, and the 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.

Tor Connection Guides

ZEUS has support for connecting to you node entirely over the Tor network. You can refer to these guides to set up a Tor hidden service on your lnd node. The instructions are generally interchangeable and typically only require you to change your Tor path.

Integrations

ZEUS is proud to be integrated on the following platforms:

Full node solutions

Payment platforms

Starting development

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

Prerequisites

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 yarn
  4. open up your Android simulator or connect your phone and run npx react-native start
  5. open a new tab and run npx 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 yarn
  3. cd ios && pod install
  4. open ios/zeus.xcworkspace in Xcode and hit Run.

Contributing

Please be sure to run yarn run tsc to check for type errors, yarn run test to run all tests, and yarn run prettier to run the prettier

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

If you’re looking for a quick way to get a lightning development environment running, check out Polar.

NOTE: When configuring a new node on Android in dev, the Host field must be 10.0.2.2 - 127.0.0.1 or localhost won’t work.

Reproducible builds

Read our docs on reproducible builds here.

Translations

Do not directly modify the files in /locales unless you are adding new copy to the app in English. Instead, translators and reviewers should visit out Transifex page and request a role on the language you’d like to contribute to.

Release + Commit Verification

All releases and all maintainer commits as of October 20, 2021 are signed by key AAC48DE8AB8DEE84 (zeusln@tutanota.com). The key can be found in this repo and on the ZeusLN.com website.

Past Keys

989CC718EBA8BB68 (January 24, 2020 - October 19, 2021)

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 us via our BTCPayServer portal, via Lightning Address (tips@pay.zeusln.app), or via PayNym (+holymorning7d1). You can also become a community sponsor and have your Twitter or Nostr avatar displayed on our website and in-app.

Thank you.

License

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