|
| 1 | +# Changelog |
| 2 | +All notable changes to this library will be documented in this file. |
| 3 | + |
| 4 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 5 | +and this library adheres to Rust's notion of |
| 6 | +[Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## Unreleased |
| 9 | +- [808] Adopt lightclient-protocol v0.4.0 |
| 10 | + |
| 11 | +### Added |
| 12 | +### Changed |
| 13 | +- zaino-proto now references v0.4.0 files |
| 14 | +### Removed |
| 15 | +- ` |
| 16 | + |
| 17 | +### Deprecated |
| 18 | +- `zaino-fetch::chain:to_compact` in favor of `to_compact_tx` which takes an |
| 19 | + optional height and a `PoolTypeFilter` (see zaino-proto changes) |
| 20 | +- |
| 21 | +## [v0.4.0] - 2025-12-03 |
| 22 | + |
| 23 | +### Added |
| 24 | +- `compact_formats.CompactTxIn` |
| 25 | +- `compact_formats.TxOut` |
| 26 | +- `service.PoolType` |
| 27 | +- `service.LightdInfo` has added fields `upgradeName`, `upgradeHeight`, and |
| 28 | + `lightwalletProtocolVersion` |
| 29 | +- `compact_formats.CompactTx` has added fields `vin` and `vout`, |
| 30 | + which may be used to represent transparent transaction input and output data. |
| 31 | +- `service.BlockRange` has added field `poolTypes`, which allows |
| 32 | + the caller of service methods that take this type as input to cause returned |
| 33 | + data to be filtered to include information only for the specified protocols. |
| 34 | + For backwards compatibility, when this field is set the default (empty) value, |
| 35 | + servers should return Sapling and Orchard data. This field is to be ignored |
| 36 | + when the type is used as part of a `service.TransparentAddressBlockFilter`. |
| 37 | + |
| 38 | +### Changed |
| 39 | +- The `hash` field of `compact_formats.CompactTx` has been renamed to `txid`. |
| 40 | + This is a serialization-compatible clarification, as the index of this field |
| 41 | + in the .proto type does not change. |
| 42 | +- `service.Exclude` has been renamed to `service.GetMempoolTxRequest` and has |
| 43 | + an added `poolTypes` field, which allows the caller of this method to specify |
| 44 | + which pools the resulting `CompactTx` values should contain data for. |
| 45 | + |
| 46 | +### Deprecated |
| 47 | +- `service.CompactTxStreamer`: |
| 48 | + - The `GetBlockNullifiers` and `GetBlockRangeNullifiers` methods are |
| 49 | + deprecated. |
| 50 | +- `zaino_fetch::FullTransaction::to_compact` deprecated in favor of `to_compact_tx` which includes |
| 51 | + an optional for index to explicitly specify that the transaction is in the mempool and has no |
| 52 | + index and `Vec<PoolType>` to filter pool types according to the transparent data changes of |
| 53 | + lightclient-protocol v0.4.0 |
| 54 | +- `zaino_fetch::chain::Block::to_compact` deprecated in favor of `to_compact_block` allowing callers |
| 55 | + to specify `PoolTypeFilter` to filter pools that are included into the compact block according to |
| 56 | + lightclient-protocol v0.4.0 |
| 57 | +- `zaino_fetch::chain::Transaction::to_compact` deprecated in favor of `to_compact_tx` allowing callers |
| 58 | + to specify `PoolTypFilter` to filter pools that are included into the compact transaction according |
| 59 | + to lightclient-protocol v0.4.0. |
| 60 | + |
| 61 | +## [v0.3.6] - 2025-05-20 |
| 62 | + |
| 63 | +### Added |
| 64 | +- `service.LightdInfo` has added field `donationAddress` |
| 65 | +- `service.CompactTxStreamer.GetTaddressTransactions`. This duplicates |
| 66 | + the `GetTaddressTxids` method, but is more accurately named. |
| 67 | + |
| 68 | +### Deprecated |
| 69 | +- `service.CompactTxStreamer.GetTaddressTxids`. Use `GetTaddressTransactions` |
| 70 | + instead. |
| 71 | + |
| 72 | +## [v0.3.5] - 2023-07-03 |
| 73 | + |
| 74 | +### Added |
| 75 | +- `compact_formats.ChainMetadata` |
| 76 | +- `service.ShieldedProtocol` |
| 77 | +- `service.GetSubtreeRootsArg` |
| 78 | +- `service.SubtreeRoot` |
| 79 | +- `service.CompactTxStreamer.GetBlockNullifiers` |
| 80 | +- `service.CompactTxStreamer.GetBlockRangeNullifiers` |
| 81 | +- `service.CompactTxStreamer.SubtreeRoots` |
| 82 | + |
| 83 | +### Changed |
| 84 | +- `compact_formats.CompactBlock` has added field `chainMetadata` |
| 85 | +- `compact_formats.CompactSaplingOutput.epk` has been renamed to `ephemeralKey` |
| 86 | + |
| 87 | +## [v0.3.4] - UNKNOWN |
| 88 | + |
| 89 | +### Added |
| 90 | +- `service.CompactTxStreamer.GetLatestTreeState` |
| 91 | + |
| 92 | +## [v0.3.3] - 2022-04-02 |
| 93 | + |
| 94 | +### Added |
| 95 | +- `service.TreeState` has added field `orchardTree` |
| 96 | + |
| 97 | +### Changed |
| 98 | +- `service.TreeState.tree` has been renamed to `saplingTree` |
| 99 | + |
| 100 | +## [v0.3.2] - 2021-12-09 |
| 101 | + |
| 102 | +### Changed |
| 103 | +- `compact_formats.CompactOrchardAction.encCiphertext` has been renamed to |
| 104 | + `CompactOrchardAction.ciphertext` |
| 105 | + |
| 106 | +## [v0.3.1] - 2021-12-09 |
| 107 | + |
| 108 | +### Added |
| 109 | +- `compact_formats.CompactOrchardAction` |
| 110 | +- `service.CompactTxStreamer.GetMempoolTx` (removed in 0.3.0) has been reintroduced. |
| 111 | +- `service.Exclude` (removed in 0.3.0) has been reintroduced. |
| 112 | + |
| 113 | +### Changed |
| 114 | +- `compact_formats.CompactSpend` has been renamed `CompactSaplingSpend` |
| 115 | +- `compact_formats.CompactOutput` has been renamed `CompactSaplingOutput` |
| 116 | + |
| 117 | +## [v0.3.0] - 2021-07-23 |
| 118 | + |
| 119 | +### Added |
| 120 | +- `service.CompactTxStreamer.GetMempoolStream` |
| 121 | + |
| 122 | +### Removed |
| 123 | +- `service.CompactTxStreamer.GetMempoolTx` has been replaced by `GetMempoolStream` |
| 124 | +- `service.Exclude` has been removed as it is now unused. |
| 125 | + |
| 126 | +## [v0.2.4] - 2021-01-14 |
| 127 | + |
| 128 | +### Changed |
| 129 | +- `service.GetAddressUtxosArg.address` has been replaced by the |
| 130 | + repeated field `addresses`. This is a [conditionally-safe](https://protobuf.dev/programming-guides/proto3/#conditionally-safe-changes) |
| 131 | + format change. |
| 132 | +- `service.GetAddressUtxosReply` has added field `address` |
| 133 | + |
| 134 | +## [v0.2.3] - 2021-01-14 |
| 135 | + |
| 136 | +### Added |
| 137 | +- `service.LightdInfo` has added fields: |
| 138 | + - `estimatedHeight` |
| 139 | + - `zcashdBuild` |
| 140 | + - `zcashdSubversion` |
| 141 | + |
| 142 | +## [v0.2.2] - 2020-10-22 |
| 143 | + |
| 144 | +### Added |
| 145 | +- `service.TreeState` |
| 146 | +- `service.GetAddressUtxosArg` |
| 147 | +- `service.GetAddressUtxosReply` |
| 148 | +- `service.GetAddressUtxosReplyList` |
| 149 | +- `service.CompactTxStreamer.GetTreeState` |
| 150 | +- `service.CompactTxStreamer.GetAddressUtxos` |
| 151 | +- `service.CompactTxStreamer.GetAddressUtxosStream` |
| 152 | + |
| 153 | +## [v0.2.1] - 2020-10-06 |
| 154 | + |
| 155 | +### Added |
| 156 | +- `service.Address` |
| 157 | +- `service.AddressList` |
| 158 | +- `service.Balance` |
| 159 | +- `service.Exclude` |
| 160 | +- `service.CompactTxStreamer.GetTaddressBalance` |
| 161 | +- `service.CompactTxStreamer.GetTaddressBalanceStream` |
| 162 | +- `service.CompactTxStreamer.GetMempoolTx` |
| 163 | +- `service.LightdInfo` has added fields: |
| 164 | + - `gitCommit` |
| 165 | + - `branch` |
| 166 | + - `buildDate` |
| 167 | + - `buildUser` |
| 168 | + |
| 169 | +## [v0.2.0] - 2020-04-24 |
| 170 | + |
| 171 | +### Added |
| 172 | +- `service.Duration` |
| 173 | +- `service.PingResponse` |
| 174 | +- `service.CompactTxStreamer.Ping` |
| 175 | + |
| 176 | +### Removed |
| 177 | +- `service.TransparentAddress` was removed (it was unused in any service API). |
| 178 | + |
| 179 | +## [v0.1.1] - 2019-11-27 |
| 180 | + |
| 181 | +### Added |
| 182 | +- `service.Empty` |
| 183 | +- `service.LightdInfo` |
| 184 | +- `service.TransparentAddress` |
| 185 | +- `service.TransparentAddressBlockFilter` |
| 186 | +- `service.CompactTxStreamer.GetTaddressTxids` |
| 187 | +- `service.CompactTxStreamer.GetLightdInfo` |
| 188 | +- `service.RawTransaction` has added field `height` |
| 189 | + |
| 190 | +## [v0.1.0] - 2019-09-19 |
| 191 | + |
| 192 | +Initial release |
0 commit comments