zec
/
secant-android-wallet
mirror of https://github.com/zcash/secant-android-wallet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update the README for the Zashi Android repository. (#1041) 

* Update the README for the Zashi Android repository.

This depends on [Electric-Coin-Company/zashi#1]

* Remove obsolete instructions from README.md

---------

Co-authored-by: Honza Rychnovský <rychnovsky.honza@gmail.com>
This commit is contained in:
Kris Nuttycombe 2023-11-23 04:01:14 -07:00 committed by GitHub
parent f34aa78f3d
commit cb9d3cf70b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,25 +1,46 @@
# Zashi Android Wallet
This is a sample implementation of a Zcash wallet for Android leveraging the [Zcash Android SDK](https://github.com/Electric-Coin-Company/zcash-android-wallet-sdk). The goal is to exercise the SDK and related Zcash libraries, as well as demonstrate how the SDK works.
While we aim to continue improving this sample, it is not an official product. We open sourced it as a resource to make wallet development easier for the Zcash ecosystem.
This is the official home of the Zashi Zcash wallet for Android, a no-frills
Zcash mobile wallet leveraging the [Zcash Android SDK](https://github.com/Electric-Coin-Company/zcash-android-wallet-sdk).
# Getting Started
If you'd like to compile this application from source, please see our [Setup Documentation](docs/Setup.md) to get started.
# Beta Testing
The Zashi Android wallet is currently in closed beta testing, and will be
publicly available from the Google Play Store when testing is complete.
If you'd like to be added to the waitlist to become a Zashi beta tester,
please [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSeQpykeMF8QcxnX5W8ya0pXIf5YPRRpUXD7H1gvbzv_WyASPw/viewform).
# Reporting an issue
If you wish to report a security issue, please follow our [Responsible Disclosure guidelines](https://github.com/zcash/ZcashLightClientKit/blob/master/responsible_disclosure.md). See the [Wallet App Threat Model](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_threat_model.html) 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](https://github.com/Electric-Coin-Company/zashi-android/issues/new/choose).
If you'd like to report a technical issue or feature request for the Android
Wallet, please file a GitHub issue [here](https://github.com/Electric-Coin-Company/zashi-android/issues/new/choose).
For feature requests and issues related to the Zashi user interface that are
not Android-specific, please file a GitHub issue [here](https://github.com/Electric-Coin-Company/zashi/issues/new/choose).
If you wish to report a security issue, please follow our
[Responsible Disclosure guidelines](https://github.com/Electric-Coin-Company/zashi/blob/master/responsible_disclosure.md).
See the [Wallet App Threat Model](https://github.com/Electric-Coin-Company/zashi/blob/master/wallet_threat_model.md)
for more information about the security and privacy limitations of the wallet.
General Zcash questions and/or support requests and are best directed to either:
* [Zcash Forum](https://forum.zcashcommunity.com/)
* [Discord Community](https://discord.io/zcash-community)
# Contributing
Contributions are very much welcomed! Please read our [Contributing Guidelines](docs/CONTRIBUTING.md) to learn about our process.
# Getting Started
If you'd like to compile this application from source, please see our [Setup Documentation](docs/Setup.md) to get started.
# Forking
If you plan to fork the project to create a new app of your own, please make the following changes. (If you're making a GitHub fork to contribute back to the project, these steps are not necessary.)
If you plan to fork the project to create a new app of your own, please make
the following changes. (If you're making a GitHub fork to contribute back to
the project, these steps are not necessary.)
1. Change the app name under [gradle.properties](gradle.properties)
1. See `ZCASH_RELEASE_APP_NAME`
@ -34,8 +55,16 @@ If you plan to fork the project to create a new app of your own, please make the
1. Configure Firebase API keys and place them under `app/src/debug/google-services.json` and `app/src/release/google-services.json`
# Known Issues
1. 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.
1. 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.
1. 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.
1. 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.
1. Test coverage for Compose code will be low, due to [known limitations](https://github.com/jacoco/jacoco/issues/1208) in the interaction between Compose and Jacoco.
1. Adding the `espresso-contrib` dependency will cause builds to fail, due to conflicting classes. This is a [known issue](https://github.com/Electric-Coin-Company/zcash-android-wallet-sdk/issues/306) with the Zcash Android SDK.
1. Android Studio will warn about the Gradle checksum. This is a [known issue](https://github.com/gradle/gradle/issues/9361) and can be safely ignored.