9ee5a4e568
* Switch to FsBlockDb for caching CompactBlocks * Add RustBackend.getLatestHeight() method * Raise MSRV to 1.60 * Migrate to latest Rust crate API * Add RustBackend.findBlockMetadata() method * Add RustBackend.rewindBlockMetadataToHeight() method * [#765] implementation of FileCompactBlockRepository * writing block metadata to database * split write function into smaller easier to test blocks * testing for FileCompactBlockRepository * fixed rewinding * fixed tests * fixed FileCompactBlockRepositoryTest and SynchronizerFactoryTest * code review fixes * updated proto files * override all functions in FakeRustBackend * code review fixes * Fix function body formatting * Improve clear function clarity * Use length of string const * Delete single file instead of directory * Improve function clarity * Refactor outputs counting - Found a typo in intermediary model class JniBlockMeta parameter change of which does not impact encoding from rust to kotlin according to rust layer implementation. * Check blocks mkdir result * Remove unnecessary detekt warning suppression * Refactor buffer size check * Improve visibility annotations * Make file finalise obvious and self documenting * Remove prevHash logging * Move instantiation to the object itself * Enrich fixture with default values * Extend eror message * Rename benchmark blocks range fixture * Fix rebase changes * Improve FileCompactBlockRepositoryTest - "De-integrated" the test suite - it now works with fixture blocks - Created needed fixtures for a clear mocked blocks providing - Enhanced getting of FileCompactBlockRepository in FileCompactBlockRepositoryTest to clarify that it works with mock components * Fix ktlintFormat findings * Bump actions/cache from 3.2.4 to 3.2.5 in /.github/actions/setup (#927) Bumps [actions/cache](https://github.com/actions/cache) from 3.2.4 to 3.2.5. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits]( |
||
|---|---|---|
| .. | ||
| assets | ||
| src | ||
| README.md | ||
| build.gradle.kts | ||
| lint-baseline.xml | ||
| proguard-project.txt | ||
README.md
Android demo app
This is a demo app that exercises code in https://github.com/zcash/zcash-android-wallet-sdk, which has all the Android-related functionalities necessary to build a mobile Zcash shielded wallet.
It relies on Lightwalletd, a backend service that provides a bandwidth-efficient interface to the Zcash blockchain. There is an equivalent iOS demo app.
Contents
Requirements
The demo app is built in Kotlin, and targets API 21. The demo pulls the pre-built SDK from jcenter so, unlike the SDK, it does not require Rust or the NDK!
Installation
In short, you simply will need to:
- (pre-requisite) Install Android Studio and setup an emulator or device
- Clone this repo: https://github.com/zcash/zcash-android-wallet-sdk
- Open the
demo-appfolder in Android Studio and launch the app
(recommended build variant:zcashmainnetDebug)
Exploring the demo app
After building the app, the emulator should launch with a basic app that exercises the SDK (see picture below). To explore the app, click on each menu item, in order, and also look at the associated code.
The demo app is not trying to show what's possible, but to present how to accomplish the building blocks of wallet functionality in a simple way in code. It is comprised of the following self-contained demos. All data is reset between demos in order to keep the behavior repeatable and independent of state.
Demos
| Menu Item | Related Code | Description |
|---|---|---|
| Get Private Key | GetPrivateKeyFragment.kt | Given a seed, display its viewing key and spending key |
| Get Address | GetAddressFragment.kt | Given a seed, display its z-addr |
| Get Balance | GetBalanceFragment.kt | Display the balance |
| Get Latest Height | GetLatestHeightFragment.kt | Given a lightwalletd server, retrieve the latest block height |
| Get Block | GetBlockFragment.kt | Given a lightwalletd server, retrieve a compact block |
| Get Block Range | GetBlockRangeFragment.kt | Given a lightwalletd server, retrieve a range of compact blocks |
| List Transactions | ListTransactionsFragment.kt | Given a seed, list all related shielded transactions |
| Send | SendFragment.kt | Send and monitor a transaction, the most complex demo |
Getting started
We’re assuming you already have a brilliant app idea, a vision for the app’s UI, and know the ins and outs of the Android lifecycle. We’ll just stick to the Zcash app part of “getting started.”
Similarly, the best way to build a functioning Zcash shielded app is to implement the functionalities that are listed in the demo app, in roughly that order:
- Generate and safely store your private key.
- Get the associated address, and display it to the user on a receive screen. You may also want to generate a QR code from this address.
- Make sure your app can talk to the lightwalletd server and check by asking for the latest height, and verify that it’s current with the Zcash network.
- Try interacting with lightwalletd by fetching a block and processing it. Then try fetching a range of blocks, which is much more efficient.
- Now that you have the blocks process them and list transactions that send to or are from that wallet, to calculate your balance.
- With a current balance (and funds, of course), send a transaction and monitor its transaction status and update the UI with the results.
Resources
You don’t need to do it all on your own.
- Chat with the wallet team: Zcash discord community channel, wallet
- Discuss ideas with other community members: Zcash forum
- Get funded to build a Zcash app: Zcash foundation grants program
- Follow Zcash-specific best practices: Zcash wallet developer checklist
- Get more information and see FAQs about the wallet: Shielded resources documentation