v1.9.0-beta01 changes

This commit includes HUSH specific changes starting at v.1.9.0-beta01 release here: https://github.com/zcash/zcash-android-wallet-sdk/releases/tag/v1.9.0-beta01

docs/Architecture.md

@@ -1 +1,35 @@
-TODO
+# Overview
+From an app developer's perspective, this SDK will encapsulate the most complex aspects of using Zcash, freeing the developer to focus on UI and UX, rather than scanning blockchains and building commitment trees! Internally, the SDK is structured as follows:
+
+![SDK Diagram](assets/sdk_diagram_final.png?raw=true "SDK Diagram")
+
+Thankfully, the only thing an app developer has to be concerned with is the following:
+
+![SDK Diagram Developer Perspective](assets/sdk_dev_pov_final.png?raw=true "SDK Diagram Dev PoV")
+
+# Components
+
+| Component                              | Summary                                                                                                                             |
+| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| **LightWalletService**                 | Service used for requesting compact blocks                                                                                          |
+| **CompactBlockStore**                  | Stores compact blocks that have been downloaded from the `LightWalletService`                                                       |
+| **CompactBlockProcessor**              | Validates and scans the compact blocks in the `CompactBlockStore` for transaction details                                           |
+| **OutboundTransactionManager**         | Creates, Submits and manages transactions for spending funds                                                                        |
+| **Initializer**                        | Responsible for all setup that must happen before synchronization can begin. Loads the rust library and helps initialize databases. |
+| **DerivationTool**, **BirthdayTool**   | Utilities for deriving keys, addresses and loading wallet checkpoints, called "birthdays."                                          |
+| **RustBackend**                        | Wraps and simplifies the rust library and exposes its functionality to the Kotlin SDK                                               |
+
+# Checkpoints
+To improve the speed of syncing with the Zcash network, the SDK contains a series of embedded checkpoints.  These should be updated periodically, as new transactions are added to the network.  Checkpoints are stored under the [sdk-lib's assets](../sdk-lib/src/main/assets/co.electriccoin.zcash/checkpoint) directory as JSON files.  Checkpoints for both mainnet and testnet are bundled into the SDK.
+
+To update the checkpoints, see [Checkmate](https://github.com/zcash-hackworks/checkmate).
+
+We generally recommend adding new checkpoints every few weeks.  By convention, checkpoints are added in block increments of 10,000 which provides a reasonable tradeoff in terms of number of checkpoints versus performance.
+
+There are two special checkpoints, one for sapling activation and another for orchard activation.  These are mentioned because they don't follow the "round 10,000" rule.
+ * Sapling activation
+     * Mainnet: 419200
+     * Testnet: 280000
+ * Orchard activation
+     * Mainnet: 1687104
+     * Testnet: 1842420

docs/Consumers.md

@@ -0,0 +1,110 @@
+# Configuring your build
+Add flavors for testnet and mainnet. Since `productFlavors` cannot start with the word 'test' we recommend:
+
+build.gradle
+```groovy
+flavorDimensions 'network'
+productFlavors {
+    // would rather name them "testnet" and "mainnet" but product flavor names cannot start with the word "test"
+    zcashtestnet {
+        dimension 'network'
+        matchingFallbacks = ['zcashtestnet', 'debug']
+    }
+    zcashmainnet {
+        dimension 'network'
+        matchingFallbacks = ['zcashmainnet', 'release']
+    }
+}
+```
+
+build.gradle.kts
+```kotlin
+flavorDimensions.add("network")
+
+productFlavors {
+    // would rather name them "testnet" and "mainnet" but product flavor names cannot start with the word "test"
+    create("zcashtestnet") {
+        dimension = "network"
+        matchingFallbacks.addAll(listOf("zcashtestnet", "debug"))
+    }
+
+    create("zcashmainnet") {
+        dimension = "network"
+        matchingFallbacks.addAll(listOf("zcashmainnet", "release"))
+    }
+}
+```
+
+Resources
+/src/main/res/values/bools.xml
+```
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <bool name="zcash_is_testnet">false</bool>
+</resources>
+
+```
+
+/src/zcashtestnet/res/values/bools.xml
+```
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <bool name="zcash_is_testnet">true</bool>
+</resources>
+```
+
+ZcashNetworkExt.kt
+```
+/**
+ * @return Zcash network determined from resources.
+ */
+fun ZcashNetwork.Companion.fromResources(context: Context) =
+    if (context.resources.getBoolean(R.bool.zcash_is_testnet)) {
+        ZcashNetwork.Testnet
+    } else {
+        ZcashNetwork.Mainnet
+    }
+```
+
+Add the SDK dependency:
+
+```kotlin
+implementation("cash.z.ecc.android:zcash-android-sdk:$LATEST_VERSION")
+```
+
+# Using the SDK
+Start the [Synchronizer](-synchronizer/README.md)
+
+```kotlin
+synchronizer.start(this)
+```
+
+Get the wallet's address
+
+```kotlin
+synchronizer.getAddress()
+
+// or alternatively
+
+DerivationTool.deriveShieldedAddress(viewingKey)
+```
+
+Send funds to another address
+
+```kotlin
+synchronizer.sendToAddress(spendingKey, zatoshi, address, memo)
+```
+
+The [Synchronizer](-synchronizer/README.md) is the primary entrypoint for the SDK.
+
+1. Start the [Synchronizer](-synchronizer/README.md)
+2. Subscribe to wallet data
+
+The [Synchronizer](-synchronizer/README.md) takes care of:
+
+- Connecting to the light wallet server 
+- Downloading the latest compact blocks in a privacy-sensitive way
+- Scanning and trial decrypting those blocks for shielded transactions related to the wallet
+- Processing those related transactions into useful data for the UI
+- Sending payments to a full node through [lightwalletd](https://github.com/zcash/lightwalletd)
+- Monitoring sent payments for status updates

docs/Setup.md

@@ -68,6 +68,7 @@ Start by making sure the command line with Gradle works first, because **all the
         1. Note: When first opening the project, Android Studio will warn that Gradle checksums are not fully supported.  Choose the "Use checksum" option.  This is a security feature that we have explicitly enabled.
         1. Shortly after opening the project, Android Studio may prompt about updating the Android Gradle Plugin.  DO NOT DO THIS.  If you do so, the build will fail because the project also has dependency locking enabled as a security feature.  To learn more, see [Build integrity.md](Build%20Integrity.md)
         1. Android Studio may prompt about updating the Kotlin plugin.  Do this.  Our application often uses a newer version of Kotlin than is bundled with Android Studio.
+        1. Note that some versions of Android Studio on Intel machines have trouble with dependency locks.  If you experience this issue, the workaround is to add the following line to `~/.gradle/gradle.properties` `ZCASH_IS_DEPENDENCY_LOCKING_ENABLED=false`
     1. After Android Studio finishes syncing with Gradle, look for the green "play" run button in the toolbar.  To the left of it, choose the "demo-app" run configuration under the dropdown menu.  Then hit the run button.
         1. Note: The SDK supports both testnet and mainnet.  The decision to switch between them is made at the application level.  To switch between build variants, look for "Build Variants" which is usually a small button in the left gutter of the Android Studio window.
 
@@ -87,7 +88,8 @@ Start by making sure the command line with Gradle works first, because **all the
 ## Gradle Tasks
 A variety of Gradle tasks are set up within the project, and these tasks are also accessible in Android Studio as run configurations.
  * `assemble` - Compiles the SDK and demo application but does not deploy it
- * `sdk-lib:connectedAndroidTest` - Runs the tests against the SDK
+ * `sdk-lib:test` - Runs unit tests in the SDK that don't require Android.  This is generally a small number of tests against plain Kotlin code without Android dependencies.
+ * `sdk-lib:connectedAndroidTest` - Runs the tests against the SDK that require integration with Android.
  * `darkside-test-lib:connectedAndroidTest` - Runs the tests against the SDK which require a localhost lightwalletd server running in darkside mode
  * `assembleAndroidTest` - Compiles the application and tests, but does not deploy the application or run the tests.  The Android Studio run configuration actually runs all of these tasks because the debug APKs are necessary to run the tests: `assembleDebug assembleZcashmainnetDebug assembleZcashtestnetDebug assembleAndroidTest`
  * `detektAll` - Performs static analysis with Detekt
@@ -127,4 +129,4 @@ For Continuous Integration, see [CI.md](CI.md).  The rest of this section is reg
     1. If you are an Electric Coin Co team member: We are still setting up a process for this, because emulator.wtf does not yet support individual API tokens
     1. If you are an open source contributor: Visit http://emulator.wtf and request an API key
 1. Set the emulator.wtf API key as a global Gradle property `ZCASH_EMULATOR_WTF_API_KEY` under `~/.gradle/gradle.properties` 
-1. Run the Gradle task `./gradlew testDebugWithEmulatorWtf :app:testZcashmainnetDebugWithEmulatorWtf` (emulator.wtf tasks do build the app, so you don't need to build them beforehand)
+1. Run the Gradle task `./gradlew testDebugWithEmulatorWtf` (emulator.wtf tasks do build the tests and test APKs, so you don't need to build them beforehand.  This is a different behavior compared to Firebase Test Lab)