From 05535173ac18b3a4b3516f4a84687136a9b4944d Mon Sep 17 00:00:00 2001 From: matejcik Date: Thu, 9 Dec 2021 13:33:24 +0100 Subject: [PATCH] docs(python): add changelog for 0.13.0 --- python/.changelog.d/1227.added | 1 - python/.changelog.d/1231.added | 1 - python/.changelog.d/1231.incompatible | 1 - python/.changelog.d/1258.added | 1 - python/.changelog.d/1258.changed | 1 - python/.changelog.d/1266.changed | 1 - python/.changelog.d/1442.changed | 1 - python/.changelog.d/1449.changed | 1 - python/.changelog.d/1531.removed | 1 - python/.changelog.d/1541.changed | 1 - python/.changelog.d/1586.added | 1 - python/.changelog.d/1604.added | 1 - python/.changelog.d/1668.changed | 1 - python/.changelog.d/1671.added | 1 - python/.changelog.d/1671.incompatible | 2 - python/.changelog.d/1683.changed.1 | 1 - python/.changelog.d/1683.incompatible.2 | 1 - python/.changelog.d/1710.added | 1 - python/.changelog.d/1745.added | 1 - python/.changelog.d/1745.incompatible | 1 - python/.changelog.d/1765.removed | 1 - python/.changelog.d/1771.added | 1 - python/.changelog.d/1772.added | 1 - python/.changelog.d/1783.added | 1 - python/.changelog.d/1783.incompatible | 1 - python/.changelog.d/1835.added | 1 - python/.changelog.d/1838.changed | 1 - python/.changelog.d/1857.added | 1 - python/.changelog.d/1867.fixed | 1 - python/.changelog.d/1885.changed | 1 - python/.changelog.d/1893.added | 1 - python/.changelog.d/1896.fixed | 1 - python/.changelog.d/1959.fixed | 1 - python/.changelog.d/1967.changed | 1 - python/.changelog.d/379.changed | 1 - python/.changelog.d/379.deprecated.1 | 1 - python/.changelog.d/379.deprecated.2 | 1 - python/.changelog.d/379.deprecated.3 | 1 - python/.changelog.d/810.removed | 1 - python/.changelog.d/noissue.added | 1 - python/CHANGELOG.md | 87 +++++++++++++++++++++++++ 41 files changed, 87 insertions(+), 41 deletions(-) delete mode 100644 python/.changelog.d/1227.added delete mode 100644 python/.changelog.d/1231.added delete mode 100644 python/.changelog.d/1231.incompatible delete mode 100644 python/.changelog.d/1258.added delete mode 100644 python/.changelog.d/1258.changed delete mode 100644 python/.changelog.d/1266.changed delete mode 100644 python/.changelog.d/1442.changed delete mode 100644 python/.changelog.d/1449.changed delete mode 100644 python/.changelog.d/1531.removed delete mode 100644 python/.changelog.d/1541.changed delete mode 100644 python/.changelog.d/1586.added delete mode 100644 python/.changelog.d/1604.added delete mode 100644 python/.changelog.d/1668.changed delete mode 100644 python/.changelog.d/1671.added delete mode 100644 python/.changelog.d/1671.incompatible delete mode 100644 python/.changelog.d/1683.changed.1 delete mode 100644 python/.changelog.d/1683.incompatible.2 delete mode 100644 python/.changelog.d/1710.added delete mode 100644 python/.changelog.d/1745.added delete mode 100644 python/.changelog.d/1745.incompatible delete mode 100644 python/.changelog.d/1765.removed delete mode 100644 python/.changelog.d/1771.added delete mode 100644 python/.changelog.d/1772.added delete mode 100644 python/.changelog.d/1783.added delete mode 100644 python/.changelog.d/1783.incompatible delete mode 100644 python/.changelog.d/1835.added delete mode 100644 python/.changelog.d/1838.changed delete mode 100644 python/.changelog.d/1857.added delete mode 100644 python/.changelog.d/1867.fixed delete mode 100644 python/.changelog.d/1885.changed delete mode 100644 python/.changelog.d/1893.added delete mode 100644 python/.changelog.d/1896.fixed delete mode 100644 python/.changelog.d/1959.fixed delete mode 100644 python/.changelog.d/1967.changed delete mode 100644 python/.changelog.d/379.changed delete mode 100644 python/.changelog.d/379.deprecated.1 delete mode 100644 python/.changelog.d/379.deprecated.2 delete mode 100644 python/.changelog.d/379.deprecated.3 delete mode 100644 python/.changelog.d/810.removed delete mode 100644 python/.changelog.d/noissue.added diff --git a/python/.changelog.d/1227.added b/python/.changelog.d/1227.added deleted file mode 100644 index 5032e6ea5..000000000 --- a/python/.changelog.d/1227.added +++ /dev/null @@ -1 +0,0 @@ -Enabled session management via `EndSession` diff --git a/python/.changelog.d/1231.added b/python/.changelog.d/1231.added deleted file mode 100644 index a5f1dec2d..000000000 --- a/python/.changelog.d/1231.added +++ /dev/null @@ -1 +0,0 @@ -Added parameters to enable Cardano derivation when calling `init_device()`. diff --git a/python/.changelog.d/1231.incompatible b/python/.changelog.d/1231.incompatible deleted file mode 100644 index ebf56602e..000000000 --- a/python/.changelog.d/1231.incompatible +++ /dev/null @@ -1 +0,0 @@ -`client.init_device(derive_cardano=True)` must be used before calling Cardano functions. diff --git a/python/.changelog.d/1258.added b/python/.changelog.d/1258.added deleted file mode 100644 index 0e6ff1c7d..000000000 --- a/python/.changelog.d/1258.added +++ /dev/null @@ -1 +0,0 @@ -two new trezorctl commands - `trezorctl firmware download` and `trezorctl firmware verify` diff --git a/python/.changelog.d/1258.changed b/python/.changelog.d/1258.changed deleted file mode 100644 index decf0c712..000000000 --- a/python/.changelog.d/1258.changed +++ /dev/null @@ -1 +0,0 @@ -`trezorctl firmware-update` command changed to `trezorctl firmware update` diff --git a/python/.changelog.d/1266.changed b/python/.changelog.d/1266.changed deleted file mode 100644 index 2b4cbc6ad..000000000 --- a/python/.changelog.d/1266.changed +++ /dev/null @@ -1 +0,0 @@ -`btc.sign_tx()` accepts keyword arguments for transaction metadata diff --git a/python/.changelog.d/1442.changed b/python/.changelog.d/1442.changed deleted file mode 100644 index 8da49b99e..000000000 --- a/python/.changelog.d/1442.changed +++ /dev/null @@ -1 +0,0 @@ -Raise `ValueError` when the txid for an input is not present in `prev_txes` during `btc.sign_tx` diff --git a/python/.changelog.d/1449.changed b/python/.changelog.d/1449.changed deleted file mode 100644 index 5d6ea71b5..000000000 --- a/python/.changelog.d/1449.changed +++ /dev/null @@ -1 +0,0 @@ -`trezorlib.mappings` was refactored for easier customization diff --git a/python/.changelog.d/1531.removed b/python/.changelog.d/1531.removed deleted file mode 100644 index 4b4013365..000000000 --- a/python/.changelog.d/1531.removed +++ /dev/null @@ -1 +0,0 @@ -dropped debug-only `trezorctl debug show-text` functionality diff --git a/python/.changelog.d/1541.changed b/python/.changelog.d/1541.changed deleted file mode 100644 index 792e26b2c..000000000 --- a/python/.changelog.d/1541.changed +++ /dev/null @@ -1 +0,0 @@ -Refactor protobuf codec for better clarity diff --git a/python/.changelog.d/1586.added b/python/.changelog.d/1586.added deleted file mode 100644 index b740dbe15..000000000 --- a/python/.changelog.d/1586.added +++ /dev/null @@ -1 +0,0 @@ -Support no_script_type option in SignMessage. diff --git a/python/.changelog.d/1604.added b/python/.changelog.d/1604.added deleted file mode 100644 index 4eb50cf08..000000000 --- a/python/.changelog.d/1604.added +++ /dev/null @@ -1 +0,0 @@ -Support for Ethereum EIP1559 transactions diff --git a/python/.changelog.d/1668.changed b/python/.changelog.d/1668.changed deleted file mode 100644 index a06c1300c..000000000 --- a/python/.changelog.d/1668.changed +++ /dev/null @@ -1 +0,0 @@ -`UdpTransport.wait_until_ready` no longer sets socket to nonblocking diff --git a/python/.changelog.d/1671.added b/python/.changelog.d/1671.added deleted file mode 100644 index 724b4a827..000000000 --- a/python/.changelog.d/1671.added +++ /dev/null @@ -1 +0,0 @@ -Debuglink can automatically scroll through paginated views. diff --git a/python/.changelog.d/1671.incompatible b/python/.changelog.d/1671.incompatible deleted file mode 100644 index e4742feaa..000000000 --- a/python/.changelog.d/1671.incompatible +++ /dev/null @@ -1,2 +0,0 @@ -The type of argument to `ui.button_request(x)` is changed from int to ButtonRequest. -The original int value can be accessed as `x.code` diff --git a/python/.changelog.d/1683.changed.1 b/python/.changelog.d/1683.changed.1 deleted file mode 100644 index b0ebb89f2..000000000 --- a/python/.changelog.d/1683.changed.1 +++ /dev/null @@ -1 +0,0 @@ -Cardano transaction parameters are now streamed into the device one by one instead of being sent as one large object diff --git a/python/.changelog.d/1683.incompatible.2 b/python/.changelog.d/1683.incompatible.2 deleted file mode 100644 index 238b608ea..000000000 --- a/python/.changelog.d/1683.incompatible.2 +++ /dev/null @@ -1 +0,0 @@ -Due to transaction streaming in Cardano, it isn't possible to return the whole serialized transaction anymore. Instead the transaction hash, transaction witnesses and auxiliary data supplement are returned and the serialized transaction needs to be assembled by the client. diff --git a/python/.changelog.d/1710.added b/python/.changelog.d/1710.added deleted file mode 100644 index ec233c514..000000000 --- a/python/.changelog.d/1710.added +++ /dev/null @@ -1 +0,0 @@ -Support for Taproot descriptors diff --git a/python/.changelog.d/1745.added b/python/.changelog.d/1745.added deleted file mode 100644 index 734ee5dea..000000000 --- a/python/.changelog.d/1745.added +++ /dev/null @@ -1 +0,0 @@ -`trezorlib.stellar.from_envelope` was added, it includes support for the Stellar [TransactionV1](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0015.md#xdr) format transaction. diff --git a/python/.changelog.d/1745.incompatible b/python/.changelog.d/1745.incompatible deleted file mode 100644 index e875e5ab3..000000000 --- a/python/.changelog.d/1745.incompatible +++ /dev/null @@ -1 +0,0 @@ -`trezorlib.stellar` was reworked to use stellar-sdk instead of providing local implementations diff --git a/python/.changelog.d/1765.removed b/python/.changelog.d/1765.removed deleted file mode 100644 index a82056b27..000000000 --- a/python/.changelog.d/1765.removed +++ /dev/null @@ -1 +0,0 @@ -Removed support for Lisk diff --git a/python/.changelog.d/1771.added b/python/.changelog.d/1771.added deleted file mode 100644 index fe5e9ab41..000000000 --- a/python/.changelog.d/1771.added +++ /dev/null @@ -1 +0,0 @@ -Ethereum: support 64-bit chain IDs diff --git a/python/.changelog.d/1772.added b/python/.changelog.d/1772.added deleted file mode 100644 index c0585b093..000000000 --- a/python/.changelog.d/1772.added +++ /dev/null @@ -1 +0,0 @@ -Support for Cardano multi-sig transactions, token minting, script addresses, multi-sig keys, minting keys and native script verification diff --git a/python/.changelog.d/1783.added b/python/.changelog.d/1783.added deleted file mode 100644 index fa113ee77..000000000 --- a/python/.changelog.d/1783.added +++ /dev/null @@ -1 +0,0 @@ -Added parameters to specify kind of Cardano derivation to all functions and `trezorctl` commands. diff --git a/python/.changelog.d/1783.incompatible b/python/.changelog.d/1783.incompatible deleted file mode 100644 index 5491858c7..000000000 --- a/python/.changelog.d/1783.incompatible +++ /dev/null @@ -1 +0,0 @@ -Cardano derivation now defaults to Icarus method. This will result in different keys for users with 24-word seed. diff --git a/python/.changelog.d/1835.added b/python/.changelog.d/1835.added deleted file mode 100644 index 3ec3866ef..000000000 --- a/python/.changelog.d/1835.added +++ /dev/null @@ -1 +0,0 @@ -Support for EIP-712 in library and `trezorctl ethereum sign-typed-data` diff --git a/python/.changelog.d/1838.changed b/python/.changelog.d/1838.changed deleted file mode 100644 index 5589843da..000000000 --- a/python/.changelog.d/1838.changed +++ /dev/null @@ -1 +0,0 @@ -`trezorlib.stellar` will refuse to process transactions containing MuxedAccount diff --git a/python/.changelog.d/1857.added b/python/.changelog.d/1857.added deleted file mode 100644 index 4b3f9803b..000000000 --- a/python/.changelog.d/1857.added +++ /dev/null @@ -1 +0,0 @@ -Add script_pubkey field to TxInput message. diff --git a/python/.changelog.d/1867.fixed b/python/.changelog.d/1867.fixed deleted file mode 100644 index 721be4e30..000000000 --- a/python/.changelog.d/1867.fixed +++ /dev/null @@ -1 +0,0 @@ -fix operator precedence issue for ethereum sign-tx command diff --git a/python/.changelog.d/1885.changed b/python/.changelog.d/1885.changed deleted file mode 100644 index bd445ffbe..000000000 --- a/python/.changelog.d/1885.changed +++ /dev/null @@ -1 +0,0 @@ -Use unified descriptors format. diff --git a/python/.changelog.d/1893.added b/python/.changelog.d/1893.added deleted file mode 100644 index 25e9a4187..000000000 --- a/python/.changelog.d/1893.added +++ /dev/null @@ -1 +0,0 @@ -Full type hinting checkable with pyright diff --git a/python/.changelog.d/1896.fixed b/python/.changelog.d/1896.fixed deleted file mode 100644 index 45bf970fe..000000000 --- a/python/.changelog.d/1896.fixed +++ /dev/null @@ -1 +0,0 @@ -Updated `tools/build_tx.py` to work with Blockbook's API protections. diff --git a/python/.changelog.d/1959.fixed b/python/.changelog.d/1959.fixed deleted file mode 100644 index 0194d7ca7..000000000 --- a/python/.changelog.d/1959.fixed +++ /dev/null @@ -1 +0,0 @@ -Fix PIN and passphrase entry in certain terminals on Windows diff --git a/python/.changelog.d/1967.changed b/python/.changelog.d/1967.changed deleted file mode 100644 index db2572399..000000000 --- a/python/.changelog.d/1967.changed +++ /dev/null @@ -1 +0,0 @@ -Introduce Trezor models as an abstraction over USB IDs, vendor strings, and possibly protobuf mappings. diff --git a/python/.changelog.d/379.changed b/python/.changelog.d/379.changed deleted file mode 100644 index 0ad0518be..000000000 --- a/python/.changelog.d/379.changed +++ /dev/null @@ -1 +0,0 @@ -protobuf is aware of `required` fields and default values diff --git a/python/.changelog.d/379.deprecated.1 b/python/.changelog.d/379.deprecated.1 deleted file mode 100644 index 026e518e6..000000000 --- a/python/.changelog.d/379.deprecated.1 +++ /dev/null @@ -1 +0,0 @@ -instantiating protobuf objects with positional arguments is deprecated diff --git a/python/.changelog.d/379.deprecated.2 b/python/.changelog.d/379.deprecated.2 deleted file mode 100644 index 633d4f12c..000000000 --- a/python/.changelog.d/379.deprecated.2 +++ /dev/null @@ -1 +0,0 @@ -values of required fields must be supplied at instantiation time. Omitting them is deprecated. diff --git a/python/.changelog.d/379.deprecated.3 b/python/.changelog.d/379.deprecated.3 deleted file mode 100644 index 199e768e1..000000000 --- a/python/.changelog.d/379.deprecated.3 +++ /dev/null @@ -1 +0,0 @@ -`details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead. diff --git a/python/.changelog.d/810.removed b/python/.changelog.d/810.removed deleted file mode 100644 index 901018f51..000000000 --- a/python/.changelog.d/810.removed +++ /dev/null @@ -1 +0,0 @@ -dropped Python 3.5 support diff --git a/python/.changelog.d/noissue.added b/python/.changelog.d/noissue.added deleted file mode 100644 index 170c38bb0..000000000 --- a/python/.changelog.d/noissue.added +++ /dev/null @@ -1 +0,0 @@ -`trezorctl firmware update` shows progress bar (Model T only) diff --git a/python/CHANGELOG.md b/python/CHANGELOG.md index 8100c9af7..d6790c33c 100644 --- a/python/CHANGELOG.md +++ b/python/CHANGELOG.md @@ -5,6 +5,63 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.13.0] - 2021-12-09 +[0.13.0]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.4...python/v0.13.0 + +### Added +- `trezorctl firmware update` shows progress bar (Model T only) +- Enabled session management via `EndSession` [#1227] +- Added parameters to enable Cardano derivation when calling `init_device()`. [#1231] +- two new trezorctl commands - `trezorctl firmware download` and `trezorctl firmware verify` [#1258] +- Support no_script_type option in SignMessage. [#1586] +- Support for Ethereum EIP1559 transactions [#1604] +- Debuglink can automatically scroll through paginated views. [#1671] +- Support for Taproot descriptors [#1710] +- `trezorlib.stellar.from_envelope` was added, it includes support for the Stellar [TransactionV1](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0015.md#xdr) format transaction. [#1745] +- Ethereum: support 64-bit chain IDs [#1771] +- Support for Cardano multi-sig transactions, token minting, script addresses, multi-sig keys, minting keys and native script verification [#1772] +- Added parameters to specify kind of Cardano derivation to all functions and `trezorctl` commands. [#1783] +- Support for EIP-712 in library and `trezorctl ethereum sign-typed-data` [#1835] +- Add script_pubkey field to TxInput message. [#1857] +- Full type hinting checkable with pyright [#1893] + +### Changed +- protobuf is aware of `required` fields and default values [#379] +- `trezorctl firmware-update` command changed to `trezorctl firmware update` [#1258] +- `btc.sign_tx()` accepts keyword arguments for transaction metadata [#1266] +- Raise `ValueError` when the txid for an input is not present in `prev_txes` during `btc.sign_tx` [#1442] +- `trezorlib.mappings` was refactored for easier customization [#1449] +- Refactor protobuf codec for better clarity [#1541] +- `UdpTransport.wait_until_ready` no longer sets socket to nonblocking [#1668] +- Cardano transaction parameters are now streamed into the device one by one instead of being sent as one large object [#1683] +- `trezorlib.stellar` will refuse to process transactions containing MuxedAccount [#1838] +- Use unified descriptors format. [#1885] +- Introduce Trezor models as an abstraction over USB IDs, vendor strings, and possibly protobuf mappings. [#1967] + +### Deprecated +- instantiating protobuf objects with positional arguments is deprecated [#379] +- `details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead. [#379] +- values of required fields must be supplied at instantiation time. Omitting them is deprecated. [#379] + +### Removed +- dropped Python 3.5 support [#810] +- dropped debug-only `trezorctl debug show-text` functionality [#1531] +- Removed support for Lisk [#1765] + +### Fixed +- fix operator precedence issue for ethereum sign-tx command [#1867] +- Updated `tools/build_tx.py` to work with Blockbook's API protections. [#1896] +- Fix PIN and passphrase entry in certain terminals on Windows [#1959] + +### Incompatible changes +- `client.init_device(derive_cardano=True)` must be used before calling Cardano functions. [#1231] +- The type of argument to `ui.button_request(x)` is changed from int to ButtonRequest. + The original int value can be accessed as `x.code` [#1671] +- Due to transaction streaming in Cardano, it isn't possible to return the whole serialized transaction anymore. Instead the transaction hash, transaction witnesses and auxiliary data supplement are returned and the serialized transaction needs to be assembled by the client. [#1683] +- `trezorlib.stellar` was reworked to use stellar-sdk instead of providing local implementations [#1745] +- Cardano derivation now defaults to Icarus method. This will result in different keys for users with 24-word seed. [#1783] + + ## [0.12.4] - 2021-09-07 [0.12.4]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.3...python/v0.12.4 @@ -504,14 +561,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 [#349]: https://github.com/trezor/python-trezor/issues/349 [#351]: https://github.com/trezor/python-trezor/issues/351 [#352]: https://github.com/trezor/python-trezor/issues/352 +[#379]: https://github.com/trezor/trezor-firmware/issues/379 +[#810]: https://github.com/trezor/trezor-firmware/issues/810 [#948]: https://github.com/trezor/trezor-firmware/issues/948 [#1052]: https://github.com/trezor/trezor-firmware/issues/1052 [#1126]: https://github.com/trezor/trezor-firmware/issues/1126 [#1179]: https://github.com/trezor/trezor-firmware/issues/1179 [#1196]: https://github.com/trezor/trezor-firmware/issues/1196 [#1210]: https://github.com/trezor/trezor-firmware/issues/1210 +[#1227]: https://github.com/trezor/trezor-firmware/issues/1227 +[#1231]: https://github.com/trezor/trezor-firmware/issues/1231 [#1257]: https://github.com/trezor/trezor-firmware/issues/1257 +[#1258]: https://github.com/trezor/trezor-firmware/issues/1258 +[#1266]: https://github.com/trezor/trezor-firmware/issues/1266 [#1296]: https://github.com/trezor/trezor-firmware/issues/1296 [#1363]: https://github.com/trezor/trezor-firmware/issues/1363 +[#1442]: https://github.com/trezor/trezor-firmware/issues/1442 +[#1449]: https://github.com/trezor/trezor-firmware/issues/1449 +[#1531]: https://github.com/trezor/trezor-firmware/issues/1531 +[#1541]: https://github.com/trezor/trezor-firmware/issues/1541 +[#1586]: https://github.com/trezor/trezor-firmware/issues/1586 +[#1604]: https://github.com/trezor/trezor-firmware/issues/1604 +[#1668]: https://github.com/trezor/trezor-firmware/issues/1668 +[#1671]: https://github.com/trezor/trezor-firmware/issues/1671 +[#1683]: https://github.com/trezor/trezor-firmware/issues/1683 +[#1710]: https://github.com/trezor/trezor-firmware/issues/1710 [#1738]: https://github.com/trezor/trezor-firmware/issues/1738 +[#1745]: https://github.com/trezor/trezor-firmware/issues/1745 +[#1765]: https://github.com/trezor/trezor-firmware/issues/1765 +[#1771]: https://github.com/trezor/trezor-firmware/issues/1771 +[#1772]: https://github.com/trezor/trezor-firmware/issues/1772 +[#1783]: https://github.com/trezor/trezor-firmware/issues/1783 [#1798]: https://github.com/trezor/trezor-firmware/issues/1798 +[#1835]: https://github.com/trezor/trezor-firmware/issues/1835 +[#1838]: https://github.com/trezor/trezor-firmware/issues/1838 +[#1857]: https://github.com/trezor/trezor-firmware/issues/1857 +[#1867]: https://github.com/trezor/trezor-firmware/issues/1867 +[#1885]: https://github.com/trezor/trezor-firmware/issues/1885 +[#1893]: https://github.com/trezor/trezor-firmware/issues/1893 +[#1896]: https://github.com/trezor/trezor-firmware/issues/1896 +[#1959]: https://github.com/trezor/trezor-firmware/issues/1959 +[#1967]: https://github.com/trezor/trezor-firmware/issues/1967