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

40 lines
4.2 KiB
Markdown
Raw Normal View History

Initial commit
2021-07-29 10:54:16 -07:00
# secant-android-wallet
[#2] Add project documentation and templates
2021-09-13 12:57:05 -07:00
_Note: As of September 2021, this is a brand new project. Since it is being developed in the open from the beginning, initially this project will not be fully functional. Some of the documentation below will be aspirational until the implementation is further along. During this initial stage of development, the older [Zcash Android Wallet](https://github.com/zcash/zcash-android-wallet) may be a more helpful sample._
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
1. Change the app name under app/
1. Remove any copyrighted ZCash or Electric Coin Company icons, logos, or assets
1. Change the package name
1. Under [app/build.gradle.kts](app/build.gradle.kts), change the package name of the application
# Known Issues
[#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.
[#27] Add documentation for known issues
2021-10-19 13:22:14 -07:00
1. When the code coverage Gradle property `IS_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.
[#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.
[#88] Kotlin 1.6 Updating the Compose compiler must happen in lockstep with the Kotlin version, because they are tightly coupled Kotlin 1.6 also fixes some annoying issues with Java 17, which will make first-time setup less error prone for new contributors
2021-12-03 05:16:24 -08:00
1. The task `ktlintFormat` fails on Java 16 and greater. As a workaround, the task is run under Java 11. This requires that JDK 11 be installed, even if a newer JDK is also installed. While this is configured to use the Java toolchain API, [toolchain support for Java 11 does not work on Apple Silicon](https://github.com/gradle/gradle/issues/19140). [Azul Zulu](https://www.azul.com/downloads/?os=macos&architecture=arm-64-bit&package=jdk) does offer JDK 11, which must be installed manually to run this task from the command line on Apple Silicon.