hush-android-wallet

A sample Android wallet using the Zcash Android SDK.

Motivation

Dogfooding - transitive verb - is the practice of an organization using its own product. This app was created to help us learn.

Please take note: the wallet is not an official product by ECC, but rather a tool for learning about our libraries that it is built on. This means that we do not have robust infrasturcture or user support for this application. We open sourced it as a resource to make wallet development easier for the Hush ecosystem.

Disclaimers

There are some known areas for improvement:

• This app is mainly intended for learning and improving the related libraries that it uses. There may be bugs.
• Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user.
• The wallet requires a trust in the server to display accurate transaction information.

See the Wallet App Threat Model for more information about the security and privacy limitations of the wallet.

If you'd like to sign up to help us test, reach out on discord and let us know! We're always happy to get feedback!

Description

This a sample wallet for the following set of features:

• z2z transactions w/ encrypted memos
• reply-to formatted memos

note: z means sapling shielded addresses.

Prerequisites

• The code
• Android Studio or adb
• An Android device or emulator

Building the App

To run, clone the repo, open it in Android Studio and press play. It should just work.™

Install from Android Studio

1. Install Android Studio and setup an emulator 1a. If using a device, be sure to put it in developer mode to enable side-loading apps
2. Import the hush-android-wallet folder.
   It will be recognized as an Android project.
3. Press play (once it is done opening and indexing)

OR Install from the command line

To build from the command line, setup ADB and connect your device. Then simply run this and it will both build and install the app:

cd /path/to/hush-android-wallet
./gradlew

Note: The lack of an explicit Gradle task is not a typo. A default task is configured via build.gradle.kts.

Tip: On macOS and Linux, Gradle is invoked with ./gradlew. On Windows, Gradle is invoked with gradlew.

Included builds

To simplify implementation of SDK features in conjunction with changes to the app, a Gradle Included Build can be configured.

1. Check out the SDK to a directory path of ../hush-android-sdk relative to the root of this app's repo. For example:

    parent/
        hush-android-wallet/
        hush-android-sdk/
   

2. Verify that the hush-android-sdk builds correctly on its own

3. Build hush-android-wallet, setting the Gradle property IS_SDK_INCLUDED_BUILD=true

There are some limitations of included builds:

1. Properties from hush-android-wallet will override those set in hush-android-sdk with the same name
2. Modules in each project cannot share the same name. For this reason, build-conventions have different names in each repo (hush-android-sdk/build-conventions vs secant-android-wallet/build-convention)
3. Kotlin and KSP versions will need to be coordinated between the two projects, because KSP is tightly coupled to the Kotlin version

Contributing

Contributions are very much welcomed! Please read our Contributing Guidelines and Code of Conduct. Our backlog has many Issues tagged with the good first issue label. Please fork the repo and make a pull request for us to review.

Reporting an issue

If you wish to report a security issue, please follow our Responsible Disclosure guidelines.

For other kind of inquiries, feel welcome to open an Issue if you encounter a bug or would like to request a feature.