nighthawk-apps / nighthawk-android-wallet

Nighthawk Wallet 2.0
https://nighthawkwallet.com
MIT License
8 stars 2 forks source link
zcash zcash-wallet

Nighthawk Wallet

Privacy-preserving wallet maintained by nighthawk apps

Download

<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"> <img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="80">

Getting Started

If you'd like to compile this application from source, please see our Setup Documentation to get started.

Reporting an issue

If you wish to report a security issue, please follow our Responsible Disclosure guidelines. See the Wallet App Threat Model for more information about the security and privacy limitations of the wallet.

If you'd like to report a technical issue or feature request for the Android Wallet, please file a GitHub issue.

General questions and/or support requests are best directed to either:

Contributing

Contributions are very much welcomed! Please read our Contributing Guidelines to learn about our process.

Language translations are welcome at Crowdin Crowdin

Known Issues

  1. Intel-based machines may have trouble building in Android Studio. The workaround is to add the following line to ~/.gradle/gradle.properties ZCASH_IS_DEPENDENCY_LOCKING_ENABLED=false. See #420 for more information.
  2. During builds, a warning will be printed that says "Unable to detect AGP versions for included builds. All projects in the build should use the same AGP version." This can be safely ignored. The version under build-conventions is the same as the version used elsewhere in the application.
  3. When the code coverage Gradle property IS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED is enabled, the debug app APK cannot be run. The coverage flag should therefore only be set when running automated tests.
  4. Test coverage for Compose code will be low, due to known limitations in the interaction between Compose and Jacoco.
  5. Adding the espresso-contrib dependency will cause builds to fail, due to conflicting classes. This is a known issue with the Zcash Android SDK.
  6. Android Studio will warn about the Gradle checksum. This is a known issue and can be safely ignored.
  7. #96 - Release builds print some R8 warnings which can be safely ignored.
  8. During app's first launch, the following exception starting with AndroidKeysetManager: keyset not found, will generate a new one is printed twice. This exception is not an error, and the code is not being invoked twice.

Disclosure Policy

Do not disclose any bug or vulnerability on public forums, message boards, mailing lists, etc. prior to responsibly disclosing to Nighthawk Wallet and giving sufficient time for the issue to be fixed and deployed. Do not execute on or exploit any vulnerability.

Reporting a Bug or Vulnerability

When reporting a bug or vulnerability, please provide the following to nighthawkwallet@protonmail.com

A short summary of the potential impact of the issue (if known). Details explaining how to reproduce the issue or how an exploit may be formed. Your name (optional). If provided, we will provide credit for disclosure. Otherwise, you will be treated anonymously and your privacy will be respected. Your email or other means of contacting you. A PGP key/fingerprint for us to provide encrypted responses to your disclosure. If this is not provided, we cannot guarantee that you will receive a response prior to a fix being made and deployed.

Encrypting the Disclosure

We highly encourage all disclosures to be encrypted to prevent interception and exploitation by third parties prior to a fix being developed and deployed. Please encrypt using the PGP public key with fingerprint: 8c07e1261c5d9330287f4ec35aff0fd018b01972

Disclaimers

There are some known areas for improvement:

See the Wallet App Threat Model for more information about the security and privacy limitations of the wallet.

Contact Nighthawk Apps

zs1nhawkewaslscuey9qhnv9e4wpx77sp73kfu0l8wh9vhna7puazvfnutyq5ymg830hn5u2dmr0sf