You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dependabot[bot] 92f2acf28a
Bump actions/cache from 3.2.3 to 3.2.4 in /.github/actions/setup (#739)
15 hours ago
.github Bump actions/cache from 3.2.3 to 3.2.4 in /.github/actions/setup (#739) 15 hours ago
.idea [#682] Testing Documentation Update 1 month ago
app [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
build-conventions-secant [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
build-info-lib [#700] Kotlin 1.8 2 weeks ago
buildSrc [#678] Gradle 7.6 2 months ago
crash-android-lib [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
crash-lib [#700] Kotlin 1.8 2 weeks ago
docs [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
gradle/wrapper [#678] Gradle 7.6 2 months ago
preference-api-lib [#700] Kotlin 1.8 2 weeks ago
preference-impl-android-lib [#592] Instrumentation coverage 2 weeks ago
sdk-ext-lib [#592] Instrumentation coverage 2 weeks ago
sdk-ext-ui-lib [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
spackle-android-lib [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
spackle-lib [#700] Kotlin 1.8 2 weeks ago
test-lib [#586] AGP 7.3 4 months ago
tools [#733] Configure Detekt convention plugin 1 week ago
ui-benchmark-test [#592] Instrumentation coverage 2 weeks ago
ui-design-lib [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
ui-integration-test [#592] Instrumentation coverage 2 weeks ago
ui-lib [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
ui-screenshot-test [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
.gitignore [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
LICENSE Initial commit 2 years ago
README.md [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
build.gradle.kts [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
buildscript-gradle.lockfile [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
gradle.properties [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago
gradlew [#678] Gradle 7.6 2 months ago
gradlew.bat [#678] Gradle 7.6 2 months ago
settings.gradle.kts [#346][#304] Configure Crashlytics and analytics opt-out 5 days ago

README.md

secant-android-wallet

Note: This is a new and unreleased 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 may be a more helpful sample.

This is a sample implementation of a Zcash wallet for Android leveraging the Zcash Android 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 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 Zcash questions and/or support requests and are best directed to either:

Contributing

Contributions are very much welcomed! Please read our Contributing Guidelines 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 and package name under gradle.properties
    1. ZCASH_RELEASE_APP_NAME
    2. ZCASH_RELEASE_PACKAGE_NAME
  2. Change the support email address under ui-lib/src/res/ui/support/values/strings.xml
  3. 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
  4. Change the package name
    1. Under app/build.gradle.kts, change the package name of the application
  5. Optional
    1. Configure secrets for Continuous Integration.
    2. Configure Firebase API keys and placing 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 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 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.