secant-android-wallet/README.md

# Secant Android Wallet
This is a sample implementation of a Zcash wallet for Android leveraging the [Zcash Android SDK](https://github.com/zcash/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.

# Getting Started
If you'd like to compile this application from source, please see our [Setup Documentation](docs/Setup.md) to get started.

# 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/zcash/secant-android-wallet/issues/new/choose).

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.

# 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.)

1. Change the app name under [gradle.properties](gradle.properties)
    1. See `ZCASH_RELEASE_APP_NAME`
1. Change the package name under [app/build.gradle.kts](app/build.gradle.kts)
    1. See `ZCASH_RELEASE_PACKAGE_NAME`
1. Change the support email address under [gradle.properties](gradle.properties)
    1. See `ZCASH_SUPPORT_EMAIL_ADDRESS`
1. Remove any copyrighted ZCash or Electric Coin Company icons, logos, or assets
    1. ui-lib/src/main/res/common/ - All of the the ic_launcher assets
1. Optional
    1. Configure secrets and variables for [Continuous Integration](docs/CI.md)
    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. 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](https://github.com/zcash/secant-android-wallet/issues/420) for more information.
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/zcash/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.
1. [#96](https://github.com/zcash/secant-android-wallet/issues/96) - Release builds print some R8 warnings which can be safely ignored.
1. 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.
Remove link to ECC Wallet in readme 2023-05-11 12:30:39 -07:00			`# Secant Android Wallet`
[#2] Add project documentation and templates 2021-09-13 12:57:05 -07:00			`This is a sample implementation of a Zcash wallet for Android leveraging the [Zcash Android SDK](https://github.com/zcash/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.`

			`# Getting Started`
			`If you'd like to compile this application from source, please see our [Setup Documentation](docs/Setup.md) to get started.`

			`# Reporting an issue`
[#3] Add skeleton Gradle project structure 2021-09-14 14:02:06 -07:00			`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.`
[#2] Add project documentation and templates 2021-09-13 12:57:05 -07:00
			`If you'd like to report a technical issue or feature request for the Android Wallet, please file a [GitHub issue](https://github.com/zcash/secant-android-wallet/issues/new/choose).`

			`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.`
[#3] Add skeleton Gradle project structure 2021-09-14 14:02:06 -07:00
			`# Forking`
[#13] Add initial preference infrastructure This adds infrastructure to read/write preferences, with both a multiplatform wrapper and an Android-specific implementation. This implementation is primarily designed to cover the initial needs of implementing the wallet SDK integration for issue #28 for securely storing keys (with encryption) for the user's wallet. 2021-10-19 05:02:15 -07:00			`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.)`
[#3] Add skeleton Gradle project structure 2021-09-14 14:02:06 -07:00
[#784] Refactor support email address to CI variable --------- Co-authored-by: Honza <rychnovsky.honza@gmail.com> 2023-03-13 06:19:14 -07:00			`1. Change the app name under [gradle.properties](gradle.properties)`
			1. See `ZCASH_RELEASE_APP_NAME`
			`1. Change the package name under [app/build.gradle.kts](app/build.gradle.kts)`
			1. See `ZCASH_RELEASE_PACKAGE_NAME`
			`1. Change the support email address under [gradle.properties](gradle.properties)`
			1. See `ZCASH_SUPPORT_EMAIL_ADDRESS`
[#3] Add skeleton Gradle project structure 2021-09-14 14:02:06 -07:00			`1. Remove any copyrighted ZCash or Electric Coin Company icons, logos, or assets`
[#14] Splash screen 2021-12-03 05:19:15 -08:00			`1. ui-lib/src/main/res/common/ - All of the the ic_launcher assets`
Configure build with GitHub Actions 2022-01-26 12:13:19 -08:00			`1. Optional`
[#784] Refactor support email address to CI variable --------- Co-authored-by: Honza <rychnovsky.honza@gmail.com> 2023-03-13 06:19:14 -07:00			`1. Configure secrets and variables for [Continuous Integration](docs/CI.md)`
			1. Configure Firebase API keys and place them under `app/src/debug/google-services.json` and `app/src/release/google-services.json`
[#3] Add skeleton Gradle project structure 2021-09-14 14:02:06 -07:00
			`# Known Issues`
[#547] Configurable dependency locking This implementation is somewhat special from our other Gradle properties, because it does not get declared in the root gradle.properties. The reason is that included builds are supposed to have their own properties e.g. root_project/gradle.properties root_project/buildSrc/gradle.properties root_project/build-conventions/gradle.properties Instead of declaring the property in three different places which might lead to confusion, this leaves the property undeclared, with the Gradle scripts assuming a default value of true. The only time this is expected to be overridden is due to a workaround for an Android Studio bug. 2022-07-22 10:00:04 -07:00			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](https://github.com/zcash/secant-android-wallet/issues/420) for more information.
[#8] Restrict maven repositories This improves security by ensuring that Google's dependencies only from the Google Maven repo. A dependency on Jitpack has also been removed. 2021-10-19 10:52:50 -07:00			`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.`
[#464] Use Kover for multiplatform coverage 2022-06-02 10:00:32 -07:00			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.
[#27] Add documentation for known issues 2021-10-19 13:22:14 -07:00			`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.`
[#50] Preliminary design guide Known issues - We cannot use downloadable fonts with Compose, so the fonts must be embedded with the app Questions - How does the transparent button show a disabled state? - Are the navigation buttons and secondary buttons supposed to be effectively the same style but one is smaller? TODO - Add gradients. Gradients are not implemented for background, progress bar, etc. Currently they simply use the start color for the gradient - Icons are using Material Icons, pending decision on how to leverage the vectors in the design - Add the border for hero images - Add shapes for the callout, which is currently square - Add padding - Add drop shadows - Double-check colors for correctness 2021-10-31 10:36:51 -07:00			1. Adding the `espresso-contrib` dependency will cause builds to fail, due to conflicting classes. This is a [known issue](https://github.com/zcash/zcash-android-wallet-sdk/issues/306) with the Zcash Android SDK.
[#16] Skeleton for wallet creation In addition to the UI, this implements improved state management for the WalletViewModel which emits a sealed class now. Work remaining for followup PRs: - Use drag-and-drop for chips instead of dropdown menus #85 - Add red background color for test fail screen #86 - Add images for various screens (depends on #66 #64) - Implement copy to clipboard #49 2021-11-17 12:19:49 -08:00			`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.`
[#23] Minify release builds 2021-12-03 05:12:40 -08:00			`1. [#96](https://github.com/zcash/secant-android-wallet/issues/96) - Release builds print some R8 warnings which can be safely ignored.`
[#99] Ktlint 0.43.1 2021-11-30 07:33:16 -08:00			1. 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.