zec
/
orchard
mirror of https://github.com/zcash/orchard.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clean up changelog

This commit is contained in:
Jack Grigg 2024-01-10 22:29:59 +00:00
parent 4b09ef6ab5
commit 21cff6bb9d
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
CHANGELOG.md
View File

@ -15,29 +15,31 @@ and this project adheres to Rust's notion of
with or without use of the license exception. with or without use of the license exception.
### Added ### Added
- `orchard::builder::bundle` - `orchard::builder`:
- `orchard::builder::BundleMetadata` - `bundle`
- `orchard::builder::BundleType` - `BundleMetadata`
- `orchard::builder::OutputInfo` - `BundleType`
- `OutputInfo`
- `orchard::bundle::Flags::{ENABLED, SPENDS_DISABLED, OUTPUTS_DISABLED}` - `orchard::bundle::Flags::{ENABLED, SPENDS_DISABLED, OUTPUTS_DISABLED}`
- `orchard::tree::Anchor::empty_tree` - `orchard::tree::Anchor::empty_tree`
### Changed ### Changed
- `orchard::builder::Builder::new` now takes the bundle type to be used - `orchard::builder`:
in bundle construction, instead of taking the flags and anchor separately. - `Builder::new` now takes the bundle type to be used in bundle construction,
- `orchard::builder::Builder::add_recipient` has been renamed to `add_output` instead of taking the flags and anchor separately.
in order to clarify than more than one output of a given transaction may be - `Builder::add_recipient` has been renamed to `add_output` in order to
sent to the same recipient. clarify than more than one output of a given transaction may be sent to the
- `orchard::builder::Builder::build` now takes an additional `BundleType` argument same recipient.
that specifies how actions should be padded, instead of using hardcoded padding. - `Builder::build` now takes an additional `BundleType` argument that
It also now returns a `Result<Option<(Bundle<...>, BundleMetadata)>, ...>` instead of a specifies how actions should be padded, instead of using hardcoded padding.
`Result<Bundle<...>, ...>`. It also now returns a `Result<Option<(Bundle<...>, BundleMetadata)>, ...>`
- `orchard::builder::BuildError` has additional variants: instead of a `Result<Bundle<...>, ...>`.
- `SpendsDisabled` - `BuildError` has additional variants:
- `OutputsDisabled` - `SpendsDisabled`
- `AnchorMismatch` - `OutputsDisabled`
- `orchard::builder::SpendInfo::new` now returns a `Result<SpendInfo, SpendError>` - `AnchorMismatch`
instead of an `Option`. - `SpendInfo::new` now returns a `Result<SpendInfo, SpendError>` instead of an
`Option`.
### Removed ### Removed
- `orchard::bundle::Flags::from_parts` - `orchard::bundle::Flags::from_parts`