2019-11-24 13:40:00 -08:00
# zcash-android-wallet
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
An Android wallet using the Zcash Android SDK that is maintained by ECC developers.
2020-06-10 08:11:25 -07:00
### Motivation
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
[Dogfooding ](https://en.wikipedia.org/wiki/Eating_your_own_dog_food ) - _transitive verb_ - is the practice of an organization using its own product. This app was created to help us learn.
2020-06-10 08:11:25 -07:00
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
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.
2020-06-10 08:11:25 -07:00
### Setup
2020-06-11 14:10:36 -07:00
To run, clone the repo, open it in Android Studio and press play. It should just work.™
2020-06-10 08:11:25 -07:00
2020-06-11 14:10:36 -07:00
#### Requirements
- [The code ](https://github.com/zcash/zcash-android-wallet )
- [Android Studio ](https://developer.android.com/studio/index.html ) or [adb ](https://www.xda-developers.com/what-is-adb/ )
- A device or emulator
2020-05-28 15:43:14 -07:00
2020-06-11 14:10:36 -07:00
### Install from Android Studio
2020-06-15 10:05:28 -07:00
1. [Install Android studio ](https://developer.android.com/studio/install ) and setup an emulator
1a. If using a device, be sure to [put it in developer mode ](https://developer.android.com/studio/debug/dev-options ) to enable side-loading apps
2020-06-11 14:10:36 -07:00
2. `Import` the zcash-android-wallet folder.
It will be recognized as an Android project.
3. Press play (once it is done opening and indexing)
2020-06-10 08:11:25 -07:00
2020-06-11 14:10:36 -07:00
### OR Install from the command line
2020-06-10 08:11:25 -07:00
To build from the command line, [setup ADB ](https://www.xda-developers.com/install-adb-windows-macos-linux/ ) and connect your device. Then simply run this and it will both build and install the app:
```bash
cd /path/to/zcash-android-wallet
./gradlew
```
## Disclaimers
There are some known areas for improvement:
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
2020-06-10 11:35:44 -07:00
- This app is mainly intended for learning and improving the related libraries that it uses. There may be bugs.
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
- This wallet currently only supports receiving at shielded addresses, which makes it incompatible with wallets that do not support sending to shielded addresses.
2020-06-10 11:57:12 -07:00
- Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user.
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
- 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` .
2020-05-28 15:43:14 -07:00
2020-06-10 08:11:25 -07:00
See the [Wallet App Threat Model ](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_threat_model.html )
2020-05-28 15:43:14 -07:00
for more information about the security and privacy limitations of the wallet.
2020-06-10 08:11:25 -07:00
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!
Update README.md
- clarify that this is maintained by ECC
- delete duplicate sentence about the wallet threat model (kept in the disclaimers, deleted in the intro).
- delete "Traffic analysis, like in other cryptocurrency wallets, can leak some privacy of the user." --we agreed that we didn't want to give off the impression that our wallet is worse than other apps, when it is actually better for privacy.
- delete "We recommend backing up your seed and using this with amounts of funds..." --we reiterate that this is not a product, and Taylor has looked at our code enough to feel confident about our wallets not losing funds.
- delete "We aim to make it as beautiful as it is useful. Internally, we will continue to extensively use it to innovate and interate on everything from [protocol changes](https://electriccoin.co/blog/introducing-heartwood/) to [lottie animations](https://lottiefiles.com/popular). Of course, Zcash has a strong history of being open-source, even when it's difficult. It would be easier to keep this internal-only so that we could fill it with crash-reporting and feedback tools but, instead, we decided to disable those things and make it available as a community resource." -- this takes away from the point that this is only for dogfooding, and that this is not a product.
2020-06-10 10:43:05 -07:00
2020-06-10 08:11:25 -07:00
### License
MIT
