zcash-hackworks
/
zircles-android
mirror of https://github.com/zcash-hackworks/zircles-android.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
121 Commits 9 Branches 1 Tag 6.5 MiB
Kotlin 100%
Go to file
Linda Lee 768c8819a0
Update README.md 
Add back in traffic analysis.
 		2020-06-10 13:57:12 -05:00
.github/ISSUE_TEMPLATE Update issue templates 2020-01-17 16:00:43 -06:00
app Simplify the build, per the README instructions. 2020-06-10 12:53:23 -04:00
buildSrc Explicitly disable all feedback, dev info and crash reporting. 2020-06-10 10:02:53 -04:00
feedback Explicitly disable all feedback, dev info and crash reporting. 2020-06-10 10:02:53 -04:00
gradle/wrapper Updated to the newly refactored (and published) SDK. 2020-06-10 07:49:38 -04:00
lockbox Dependency cleanup so plugin dependencies are easier to find. 2020-05-27 14:37:44 -04:00
mnemonic New: Provide checksum warning to user. 2020-06-10 08:26:21 -04:00
qrecycler Dependency cleanup so plugin dependencies are easier to find. 2020-05-27 14:37:44 -04:00
.gitignore Initial commit. 2019-11-26 15:29:16 -05:00
CHANGELOG.md Updated build, dependencies and added changelog. 2020-02-21 19:03:00 -05:00
LICENSE Initial commit 2019-11-24 16:40:00 -05:00
README.md Update README.md 2020-06-10 13:57:12 -05:00
build.gradle Simplify the build, per the README instructions. 2020-06-10 12:53:23 -04:00
gradle.properties General fixes and cleanup. 2020-01-31 11:32:36 -05:00
gradlew Initial commit. 2019-11-26 15:29:16 -05:00
gradlew.bat Initial commit. 2019-11-26 15:29:16 -05:00
settings.gradle Updated to the newly refactored (and published) SDK. 2020-06-10 07:49:38 -04:00

README.md

zcash-android-wallet

An Android wallet using the Zcash Android SDK that is maintained by ECC developers.

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 Zcash ecosystem.

Setup

Requirements

  1. Open Android Studio and setup an emulator or connect your device
  2. Clone the repo
  3. Open the project and press play. It should just work.

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/zcash-android-wallet
./gradlew

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.
  • This wallet currently only supports receiving at shielded addresses, which makes it incompatible with wallets that do not support sending to shielded addresses.
  • 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.
  • This app has been developed and run exclusively on mainnet it might not work on testnet.

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!

License

MIT