global19-atlassian-net / zeus Goto Github PK

View Code? Open in Web Editor NEW

This project forked from zeusln/zeus

0.0 1.0 0.0 23.49 MB

A mobile Bitcoin/Lightning app for LND, Core Lightning, and Eclair node operators ⚡️

Home Page: https://zeusln.app/

License: Other

JavaScript 0.68% Ruby 0.11% C 0.02% Objective-C 0.52% Java 0.59% TypeScript 97.87% Swift 0.01% Starlark 0.20%

zeus's Introduction

Zeus

Zeus is a mobile Bitcoin/Lightning node manager and wallet application for LND, Core Lightning, and Eclair. ⚡️

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

App Store links

Get in touch with us

Come chat with us on Telegram
Join our developer Slack
Keep up with us on Twitter
Open a channel with our node

Features

Connecting Zeus to your node

Currently, to use Zeus, you must have a Bitcoin Lightning node running Lightning Network Daemon (lnd), eclair, or Core Lightning using the REST or Spark 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 interchangable 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

Android nodes

Nayuta Core

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

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

iOS

install and setup react-native and its related dependencies under "Building Projects with Native Code" on react-native's Getting Started page
install node dependencies with npm i
cd ios && pod install
open ios/zeus.xcworkspace in Xcode and hit Run. NOTE: if you're using an M1 mac, you may need to right click Xcode > get info > check Open using Rosetta before opening zeus.xcworkspace.

Contributing

Please be sure to run npm run tsc to check for type errors, npm run test to run all tests, and npm 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.

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 ([email protected]). The key can be found in this repo and on the ZeusLN.app 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 ([email protected]), or via PayNym (+holymorning7d1). You can also become an Olympian-level community sponsor and have your Twitter avatar displayed on our website and in-app.

Thank you.