Clean up zcash_keys changelog

This commit is contained in:
Jack Grigg 2024-02-22 17:43:17 +00:00
parent 92e54ddce2
commit 25b682728b
1 changed files with 17 additions and 19 deletions

View File

@ -9,43 +9,41 @@ The entries below are relative to the `zcash_client_backend` crate as of
`zcash_client_backend 0.10.0`.
### Added
- The following modules have been extracted from `zcash_client_backend` and
moved to this crate:
- `address`
- `encoding`
- `keys`
- `zcash_keys::address::UnifiedAddress::{unknown, has_orchard, has_sapling,
has_transparent, receiver_types}`:
- `zcash_keys::keys`:
- `zcash_keys::address` (moved from `zcash_client_backend::address`). Further
additions to this module:
- `UnifiedAddress::{has_orchard, has_sapling, has_transparent}`
- `UnifiedAddress::receiver_types`
- `UnifiedAddress::unknown`
- `zcash_keys::encoding` (moved from `zcash_client_backend::encoding`).
- `zcash_keys::keys` (moved from `zcash_client_backend::keys`). Further
additions to this module:
- `AddressGenerationError`
- `UnifiedAddressRequest`
- A new `orchard` feature flag has been added to make it possible to
build client code without `orchard` dependendencies.
### Changed
- The following methods and enum variants have been placed behind an `orchard`
feature flag:
- `zcash_keys::address::UnifiedAddress::orchard`
- `zcash_keys::keys::DerivationError::Orchard`
- `zcash_keys::keys::UnifiedSpendingKey::orchard`
- `zcash_keys::address`:
- `RecipientAddress` has been renamed to `Address`
- `Address::Shielded` has been renamed to `Address::Sapling`
- `RecipientAddress` has been renamed to `Address`.
- `Address::Shielded` has been renamed to `Address::Sapling`.
- `UnifiedAddress::from_receivers` no longer takes an Orchard receiver
argument unless the `orchard` feature is enabled.
- `UnifiedAddress::orchard` is now only available when the `orchard` feature
is enabled.
- `zcash_keys::keys`:
- `DerivationError::Orchard` is now only available when the `orchard` feature
is enabled.
- `UnifiedSpendingKey::address` now takes an argument that specifies the
receivers to be generated in the resulting address. Also, it now returns
`Result<UnifiedAddress, AddressGenerationError>` instead of
`Option<UnifiedAddress>` so that we may better report to the user how
address generation has failed.
- `UnifiedSpendingKey::orchard` is now only available when the `orchard`
feature is enabled.
- `UnifiedSpendingKey::transparent` is now only available when the
`transparent-inputs` feature is enabled.
- `UnifiedFullViewingKey::new` no longer takes an Orchard full viewing key
argument unless the `orchard` feature is enabled.
### Removed
- `zcash_keys::address::AddressMetadata` has been moved to
`zcash_client_backend::data_api::TransparentAddressMetadata` and fields changed.
- `zcash_keys::address::AddressMetadata`
(use `zcash_client_backend::data_api::TransparentAddressMetadata` instead).