Update changelog for 1.8 release

This commit is contained in:
Carter Jernigan 2022-07-28 10:01:06 -04:00 committed by Carter Jernigan
parent ecba4884b2
commit 421f932bd5
2 changed files with 12 additions and 0 deletions

View File

@ -1,6 +1,13 @@
Change Log
==========
Version 1.8.0-beta01
------------------------------------
- Added `BlockHeight` typesafe object to represent block heights
- Significantly reduced memory usage, fixing potential OutOfMemoryError during block download
- Kotlin 1.7.10
- Updated checkpoints
Version 1.7.0-beta01
------------------------------------
- Added `Zatoshi` typesafe object to represent amounts.

View File

@ -1,6 +1,11 @@
Troubleshooting Migrations
==========
Migration to Version 1.8 from 1.7
Various APIs used `Int` to represent network block heights. Those APIs now use a typesafe `BlockHeight` type. BlockHeight is constructed with a factory method `BlockHeight.new(ZcashNetwork, Long)` which uses the network to validate the height is above the network's sapling activation height.
`WalletBirthday` has been renamed to `Checkpoint` and removed from the public API. Where clients previously passed in a `WalletBirthday` object, now a `BlockHeight` can be passed in instead.
Migration to Version 1.7 from 1.6
--------------------------------------
Various APIs used `Long` value to represent Zatoshi currency amounts. Those APIs now use a typesafe `Zatoshi` class. When passing amounts, simply wrap Long values with the Zatoshi constructor `Zatoshi(Long)`. When receiving values, simply unwrap Long values with `Zatoshi.value`.