zec
/
zcash-android-wallet-sdk
mirror of https://github.com/zcash/zcash-android-wallet-sdk.git

[#502] Prepare 1.4.0-beta01 release

This commit is contained in:
Carter Jernigan 2022-05-09 09:14:30 -04:00 committed by Carter Jernigan
parent 21f67ef23a
commit a9245f2d67
2 changed files with 55 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
CHANGELOG.md
View File

@ -1,37 +1,38 @@
Change Log
==========
Version 1.4.0-beta01 *(2022-01-28)*
Version 1.4.0-beta01
------------------------------------
- Main entrypoint to the SDK has changed. See [MIGRATIONS.md](MIGRATIONS.md)
- The minumum version of Android supported is now API 19
- Fix: Internal bugfixes around concurrent access to resources, which could cause transient failures and data corruption
- Fix: Added ProGuard rules so that SDK clients can use R8 to shrink their apps
- Updated dependencies, including Kotlin 1.6.21
- Updated checkpoints for Mainnet and Testnet
- Internal bugfixes around concurrent access to resources, which could cause transient failures and data corruption
- Added ProGuard rules so that SDK clients can use R8 to shrink their apps
- Updated dependencies, including Kotlin 1.6.21, Coroutines 1.6.1, GRPC 1.46.0, Okio 3.1.0, NDK 23
Version 1.3.0-beta20 *(2022-01-27)*
Version 1.3.0-beta20
------------------------------------
- New: Updated checkpoints for Mainnet and Testnet
Version 1.3.0-beta19 *(2021-11-22)*
Version 1.3.0-beta19
------------------------------------
- New: Updated checkpoints for Mainnet and Testnet
- Fix: Repackaged internal classes to a new `internal` package name
- Fix: Testnet checkpoints have been corrected
- Updated dependencies
Version 1.3.0-beta18 *(2021-08-10)*
Version 1.3.0-beta18
------------------------------------
- Fix: Corrected logic when calculating birthdates for wallets with zero received notes.
Version 1.3.0-beta17 *(2021-07-29)*
Version 1.3.0-beta17
------------------------------------
- Fix: Autoshielding confirmation count error so funds are available after 10 confirmations.
- New: Allow developers to enable Rust logs.
- New: Accept GZIP compression from lightwalletd.
- New: Reduce the UTXO retry time.
Version 1.3.0-beta16 *(2021-06-30)*
Version 1.3.0-beta16
------------------------------------
- Fix: Gracefully handle failures while fetching UTXOs.
- New: Expose StateFlows for balances.
@ -39,44 +40,44 @@ Version 1.3.0-beta16 *(2021-06-30)*
- New: Cleanup default logs.
- New: Convenience functions for WalletBalance objects.
Version 1.3.0-beta15 *(2021-06-21)*
Version 1.3.0-beta15
------------------------------------
- Fix: Increase reconnection attempts on failed app restart.
- New: Updated checkpoints for testnet and mainnet.
Version 1.3.0-beta14 *(2021-06-21)*
Version 1.3.0-beta14
------------------------------------
- New: Add separate flows for sapling, orchard and tranparent balances.
- Fix: Continue troubleshooting and fixing server disconnects.
- Updated dependencies.
Version 1.3.0-beta12 *(2021-06-07)*
Version 1.3.0-beta12
------------------------------------
- New: Expose network height as StateFlow.
- Fix: Reconnect to lightwalletd when a service exception occurs.
Version 1.3.0-beta11 *(2021-05-12)*
Version 1.3.0-beta11
------------------------------------
- Fix: Remove unused flag that was breaking new wallet creation for some wallets.
Version 1.3.0-beta10 *(2021-05-07)*
Version 1.3.0-beta10
------------------------------------
- Fix: Make it safe to call the new prepare function more than once.
Version 1.3.0-beta09 *(2021-05-07)*
Version 1.3.0-beta09
------------------------------------
- New: Add quick rewind feature, which makes it easy to rescan blocks after an upgrade.
- Fix: Repair complex data migration bug that caused crashes on upgrades.
Version 1.3.0-beta08 *(2021-05-01)*
Version 1.3.0-beta08
------------------------------------
- Fix: Disable librustzcash logs by default.
Version 1.3.0-beta07 *(2021-05-01)*
Version 1.3.0-beta07
------------------------------------
- Fix: Address issues with key migration, allowing wallets to reset viewing keys, when needed.
Version 1.3.0-beta06 *(2021-04-29)*
Version 1.3.0-beta06
------------------------------------
- Fix: Repair publishing so that AARs work on Windows machines [issue #222].
- Fix: Incorrect BranchId on 32-bit devics [issue #224].
@ -84,7 +85,7 @@ Version 1.3.0-beta06 *(2021-04-29)*
- New: Drop Android Jetifier since it is no longer used.
- Updated checkpoints, improved tests (added Test Suites) and better error messages.
Version 1.3.0-beta05 *(2021-04-23)*
Version 1.3.0-beta05
------------------------------------
- Major: Consolidate product flavors into one library for the SDK instead of two.
- Major: Integrates with latest Librustzcash including full Data Access API support.
@ -110,43 +111,43 @@ Version 1.3.0-beta05 *(2021-04-23)*
- New: Derive sapling activation height from the active network.
- New: Latest checkpoints for mainnet and testnet.
Version 1.2.1-beta04 *(2021-01-05)*
Version 1.2.1-beta04
------------------------------------
- New: Updated to latest versions of grpc, grpc-okhttp and protoc
- Fix: Addresses root issue of Android 11 crash on SSL sockets
Version 1.2.1-beta03 *(2020-12-18)*
Version 1.2.1-beta03
------------------------------------
- New: Implements ZIP-313, reducing the default fee from 10,000 to 1,000 zats.
- Fix: 80% reduction in build warnings from 90 -> 18 and improved docs [Credit: @herou].
Version 1.2.1-beta02 *(2020-11-24)*
Version 1.2.1-beta02
------------------------------------
- New: Improve birthday configuration and config functions.
- Fix: Broken layout in demo app transaction list.
Version 1.2.1-beta01 *(2020-11-19)*
Version 1.2.1-beta01
------------------------------------
- New: Added latest checkpoints for testnet and mainnet.
- New: Added display name for Canopy.
- New: Update to the latest lightwalletd service definition.
- Fix: Convert Initializer.Builder to Initializer.Config to simplify the constructors.
Version 1.2.0-beta01 *(2020-10-30)*
Version 1.2.0-beta01
------------------------------------
- New: Added ability to erase initializer data.
- Fix: Updated to latest librustzcash, fixing send functionality on Canopy.
Version 1.1.0-beta10 *(2020-10-16)*
Version 1.1.0-beta10
------------------------------------
- New: Modified visibility on a few things to facilitate partner integrations.
Version 1.1.0-beta08 *(2020-10-01)*
Version 1.1.0-beta08
------------------------------------
- Fix: Publishing has been corrected by jcenter's support team.
- New: Minor improvement to initializer
Version 1.1.0-beta05 *(2020-09-11)*
Version 1.1.0-beta05
------------------------------------
- New: Synchronizer can now be started with just a viewing key.
- New: Initializer improvements.
@ -157,7 +158,7 @@ Version 1.1.0-beta05 *(2020-09-11)*
- Fix: Broken testnet demo app.
- Fix: Publishing configuration.
Version 1.1.0-beta04 *(2020-08-13)*
Version 1.1.0-beta04
------------------------------------
- New: Add support for canopy on testnet.
- New: Change the default lightwalletd server.
@ -167,7 +168,7 @@ Version 1.1.0-beta04 *(2020-08-13)*
- New: Added new checkpoints.
- Fix: Minor enhancements.
Version 1.1.0-beta03 *(2020-08-01)*
Version 1.1.0-beta03
------------------------------------
- New: Add robust support for transaction cancellation.
- New: Update to latest version of librustzcash.

30
README.md
View File

@ -1,5 +1,4 @@
[![license](https://img.shields.io/github/license/zcash/zcash-android-wallet-sdk.svg?maxAge=2592000&style=plastic)](https://github.com/zcash/zcash-android-wallet-sdk/blob/master/LICENSE)
[![@gmale](https://img.shields.io/badge/contact-android@z.cash-5AA9E7.svg?style=plastic)](https://github.com/gmale)
![Maven Central](https://img.shields.io/maven-central/v/cash.z.ecc.android/zcash-android-sdk?color=success&style=plastic)
This is a beta build and is currently under active development. Please be advised of the following:
@ -85,6 +84,8 @@ To accomplish this, these responsibilities of the SDK are divided into separate
## Quickstart
Add flavors for testnet v mainnet. Since `productFlavors` cannot start with the word 'test' we recommend:
build.gradle:
```groovy
flavorDimensions 'network'
productFlavors {
@ -99,10 +100,29 @@ productFlavors {
}
}
```
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"))
}
}
```
Add the SDK dependency:
```groovy
implementation 'cash.z.ecc.android:zcash-android-sdk:1.3.0-beta20'
```kotlin
implementation("cash.z.ecc.android:zcash-android-sdk:1.4.0-beta01")
```
Start the [Synchronizer](docs/-synchronizer/README.md)
@ -170,8 +190,8 @@ rustup target add armv7-linux-androideabi aarch64-linux-android i686-linux-andro
<img src="assets/sdk-manager-icon.png?raw=true" width="70%"/>
</p>
6. Then, install NDK ~~20.0.5594570~~ 22.1.7171670
(pro tip: `build.gradle -> ndkVersion` defines the actual required version. Use that because this README may get out-of-date. Also note that the "Show Package Details" box in the bottom right corner must be checked in order to install specific versions of the NDK.)
6. Then, install NDK ~~20.0.5594570~~ 23.1.7779620
(`gradle.properties` defines the actual required version. Use that because this README may get out-of-date. Also note that the "Show Package Details" box in the bottom right corner must be checked in order to install specific versions of the NDK. NDK 24+ is not yet supported.)
<p align="center">
<img src="assets/ndk-window.png?raw=true" width="85%"/>
</p>