gem-hunter

This is the official home of the Zodl Zcash wallet for Android, a no-frills Zcash mobile wallet leveraging the ZODL Android SDK.

Zodl runs its own F-Droid repository at https://foss.zodl.com. To add it to your F-Droid client, tap this link on Android:

fdroidrepos://foss.zodl.com/fdroid/repo?fingerprint=7e751ab710159dff44f55631f910ba4033f0ebd2f867691af633cece4ddb62e4

…or add the URL manually in F-Droid → Settings → Repositories → +: https://foss.zodl.com/fdroid/repo (fingerprint 7e751ab710159dff44f55631f910ba4033f0ebd2f867691af633cece4ddb62e4).

Unlike the f-droid.org build, our repo ships the same build-time integrations as the Google Play release (Flexa, CMC, Crashlytics) and is signed with the same upload key — no reinstall needed when switching.

Or download the latest APK from the Releases Section.

Obtain help for Zodl and connect with our team at support.zodl.com.

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

For feature requests and issues related to the Zodl user interface that are not Android-specific, please file a GitHub issue here.

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.

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

• Zcash Forum
• Discord Community

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

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

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
   1. See ZCASH_RELEASE_APP_NAME
2. Change the package name under app/build.gradle.kts
   1. See ZCASH_RELEASE_PACKAGE_NAME
3. Change the support email address under strings.xml
   1. See support_email_address
4. Remove any copyrighted Zcash icons, logos, or assets
   1. ui-lib/src/main/res/common/ - All of the the ic_launcher assets
5. Optional
   1. Configure secrets and variables for Continuous Integration
   2. Configure Firebase API keys and place them under app/src/debug/google-services.json and app/src/release/google-services.json

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.
2. 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.
3. Test coverage for Compose code will be low, due to known limitations in the interaction between Compose and Jacoco.
4. Adding the espresso-contrib dependency will cause builds to fail, due to conflicting classes. This is a known issue with the Zcash Android SDK.
5. During app 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.