Bump version to v0.28

[dr-orlovsky]

Pending PRs from https://github.com/rust-bitcoin/rust-bitcoin/milestone/10, specifically:

• Change EcdsaSig hash type deser in psbt #776
• Contributing.md #587

Draft for the release info is autogenerated by GitHub, so we have to edit it. Please feel free to edit it right here, in place. Once we will be happy with it, I will add it to the CHANLELOG.md to the release commit.

What's Changed

Breaking changes

• Script serialization/deserialization in serde non-human-readable format by @RCasatta in Script serialization/deserialization in serde non-human-readable format #596
• use Amount type in verify by @RCasatta in use Amount type in verify #621
• Add OP_CHECKSIGADD and OP_SUCCESSxxx by @sanket1729 in Add OP_CHECKSIGADD and OP_SUCCESSxxx #644
• WitnessVersion type by @dr-orlovsky in WitnessVersion type #617
• Taproot P2TR address by @dr-orlovsky in Taproot P2TR address #563
• Improvements to Error types (part 4) by @dr-orlovsky in Improvements to Error types (part 4) #625
• Add Bloom filter network messages by @benthecarman in Add Bloom filter network messages #580
• Adds Taproot BIP341 signature message and create a unified sighash cache for legacy, segwit and taproot inputs by @RCasatta in Adds Taproot BIP341 signature message and create a unified sighash cache for legacy, segwit and taproot inputs #628
• Changes for checking script size and returning Result<Address, Error> for p2sh by @vss96 in Changes for checking script size and returning Result<Address, Error> for p2sh #655
• Add taproot data structures by @sanket1729 in Add taproot data structures #677
• P2TR address from untweaked key by @nlanson in P2TR address from untweaked key #691
• Making globals part of PSBT struct. Closes Why PSBT needs separate Global struct? #652 by @dr-orlovsky in Making globals part of PSBT struct. Closes #652 #654
• New Witness struct to improve ser/de perfomance by @RCasatta in New Witness struct to improve ser/de perfomance #672

Theoretically non-breaking

These are things people shouldn't have depended on in the first place but may be considered breaking in some contexts.

• Removed fuzztarget feature by @Kixunil in Removed fuzztarget feature #634

New APIs/features

• Implement possible_networks function for Address by @elsirion in Implement possible_networks function for Address #618
• Super-trivial: Implement FusedIterator for Instructions by @Kixunil in Super-trivial: Implement FusedIterator for Instructions #733
• Implement Sum for amount types by @sgeisler in Implement Sum for amount types #615
• Implement Block.get_strippedsize() and Transaction.get_vsize() by @visvirial in Implement Block.get_strippedsize() and Transaction.get_vsize() #626
• util/address: make address encoding more modular by @benma in util/address: make address encoding more modular #643

Bug fixes

• Fixing no_std for Amount sum iterator by @dr-orlovsky in Fixing no_std for Amount sum iterator #651
• Fix Uint256::increment panics by @TheBlueMatt in Fix Uint256::increment panics #612
• Hotfix for secp256k1 alloc feature by @dr-orlovsky in Hotfix for secp256k1 alloc feature #694

Mildly interesting improvements

These improvements are mainly internal or documentation but may have noticeable impact on the quality of the crate.

• Document cargo features by @Kixunil in Document cargo features #633
• Add i686 to tested architectures by @Kixunil in Add i686 to tested architectures #659

Other/uncategorized changes

• fix changelog date by @RCasatta in fix changelog date #640
• Use consts for address prefix values by @tcharding in Use consts for address prefix values #632
• Fix documentation referencing macro var by @RCasatta in Fix documentation referencing macro var #623
• Check for overflow in Script::bytes_to_asm_fmt() by @Kixunil in Check for overflow in Script::bytes_to_asm_fmt() #658 (this was released in point release)
• Document lack of support for 16-bit pointers by @Kixunil in Document lack of support for 16-bit pointers #663
• Improve Fuzz CI by @RCasatta in Improve Fuzz CI #664
• Refactor Script::bytes_to_asm_fmt to use iterator by @Kixunil in Refactor Script::bytes_to_asm_fmt to use iterator #662
• no-std cleanup by @devrandom in no-std cleanup #637
• util/address: remove unused generic type by @benma in util/address: remove unused generic type #698
• Clean up module level rustdocs by @tcharding in Clean up module level rustdocs #689
• tests: improve coverage for P2tr and AddressType by @LeoComandini in tests: improve coverage for P2tr and AddressType #683
• Return the correct LeafVersion when building a Taproot ControlBlock by @afilini in Return the correct LeafVersion when building a Taproot ControlBlock #703
• Add unit test for bitcoin_merkle_root functions by @tcharding in Add unit test for bitcoin_merkle_root functions #711
• P2tr fixes by @sanket1729 in P2tr fixes #707
• util/address: Improve docs by @tcharding in util/address: Improve docs #704
• Huffman Bug Fix by @JeremyRubin in Huffman Bug Fix #699
• Huffman Encoding Bug Test by @JeremyRubin in Huffman Encoding Bug Test #700
• Use expect instead of unwrap for calls to consensus_encode by @tcharding in Use expect instead of unwrap for calls to consensus_encode #719
• Use TapTweakHash::from_key_and_tweak() method in computing tweak for UntweakedPublicKey by @nlanson in Use TapTweakHash::from_key_and_tweak() method in computing tweak for UntweakedPublicKey #697
• Decrease Huffman Weights to u32 by @JeremyRubin in Decrease Huffman Weights to u32 #701
• Use un/tweaked public key types by @tcharding in Use un/tweaked public key types #728
• Improvements to script methods related to Taproot by @dr-orlovsky in Improvements to script methods related to Taproot #721
• add helpful message to division-by-zero panic by @z8674558 in add helpful message to division-by-zero panic #743
• Separate signature hash types by @sanket1729 in Separate signature hash types #702
• add MAX_MONEY public constant to Amount by @z8674558 in add MAX_MONEY public constant to Amount #742
• Refactor bitcoin_merkle_root functions by @tcharding in Refactor bitcoin_merkle_root functions #710
• BIP341 test vectors by @sanket1729 in BIP341 test vectors #695
• Fixed a bunch of clippy lints, added clippy.toml by @Kixunil in Fixed a bunch of clippy lints, added clippy.toml #686
• Re-export SigHashType in lib.rs by @sanket1729 in Re-export SigHashType in lib.rs #749
• Fixed docs.rs metadata by @Kixunil in Fixed docs.rs metadata #744
• Improve parsing of Denomination string by @tcharding in Improve parsing of Denomination string #731
• transactions: add a note about get_vsize and standardness rules by @darosior in transactions: add a note about get_vsize and standardness rules #665
• Allow specifing a raw TapLeafHash in sighash computation by @afilini in Allow specifing a raw TapLeafHash in sighash computation #722
• Add support for taproot psbt fields BIP 371 by @sanket1729 in Add support for taproot psbt fields BIP 371 #681
• Tapsighash test vectors by @sanket1729 in Tapsighash test vectors #705
• Deprecate StreamReader by @RCasatta in Deprecate StreamReader #680
• Put rustdocs above attributes by @tcharding in Put rustdocs above attributes #753
• Update to secp256k1 0.21.2 by @sanket1729 in Update to secp256k1 0.21.2 #755
• Use test_data for big objects, add big block for benchmarking by @RCasatta in Use test_data for big objects, add big block for benchmarking #750
• PSBT: partial sig data type by @dr-orlovsky in PSBT: partial sig data type #669
• Converting LeafVersion into an enum by @dr-orlovsky in Converting LeafVersion into an enum #718
• Taproot: BIP32 extended keys using Scep256k1 keys instead of bitcoin ECDSA by @dr-orlovsky in Taproot: BIP32 extended keys using Scep256k1 keys instead of bitcoin ECDSA #590
• Taproot trivial post-merge fixups by @dr-orlovsky in Taproot trivial post-merge fixups #761
• wrap u8 and LeafVersion in backticks and square bracket in doc by @bruteforcecat in wrap u8 and LeafVersion in backticks and square bracket in doc #766
• improve example: take hex-encoded seed instead of WIF in bip32 example by @bruteforcecat in improve example: take hex-encoded seed instead of WIF in bip32 example #760
• PSBT BIP32 keys using to Secp256k1 keys instead of bitcoin ECDSA by @dr-orlovsky in PSBT BIP32 keys using to Secp256k1 keys instead of bitcoin ECDSA #591
• Rename inner key field in PrivateKey and PublicKey by @dr-orlovsky in Rename inner key field in PrivateKey and PublicKey #762
• Add Witness::new() by @sanket1729 in Add Witness::new() #771
• Change type of final script witness to Witness from Vec<Vec> by @sanket1729 in Change type of final script witness to Witness from Vec<Vec<u8>> #774
• Taproot tweaks generalization & KeyPair support by @dr-orlovsky in Taproot tweaks generalization & KeyPair support #696
• Issue Tests: Missing tests for Merkle root calculations #394 - Refactor Block::merkle_root() by @nilswloewen in Issue #394 - Refactor Block::merkle_root()  #775
• Fixups for taproot improvements by @dr-orlovsky in Fixups for taproot improvements #778
• Introduce PsbtSigHashType by @sanket1729 in Introduce PsbtSigHashType #779
• add nano and pico BTC to Denomination enum by @bruteforcecat in add nano and pico BTC to Denomination enum #768
• replace unncessary closure with function pointer in FromStr::from_str for Deonomation by @bruteforcecat in replace unncessary closure with function pointer in FromStr::from_str for Deonomation #784
• Minimally-invasive separation of bitcoin keys from ECDSA signature types by @dr-orlovsky in Minimally-invasive separation of bitcoin keys from ECDSA signature types #757

New Contributors

• @Kixunil made his first contribution in Removed fuzztarget feature #634
• @elsirion made their first contribution in Implement possible_networks function for Address #618
• @tcharding made their first contribution in Use consts for address prefix values #632
• @visvirial made their first contribution in Implement Block.get_strippedsize() and Transaction.get_vsize() #626
• @benthecarman made their first contribution in Add Bloom filter network messages #580
• @vss96 made their first contribution in Changes for checking script size and returning Result<Address, Error> for p2sh #655
• @nlanson made their first contribution in P2TR address from untweaked key #691
• @benma made their first contribution in util/address: remove unused generic type #698
• @LeoComandini made their first contribution in tests: improve coverage for P2tr and AddressType #683
• @z8674558 made their first contribution in add helpful message to division-by-zero panic #743
• @bruteforcecat made their first contribution in wrap u8 and LeafVersion in backticks and square bracket in doc #766
• @nilswloewen made their first contribution in Issue #394 - Refactor Block::merkle_root()  #775

Full Changelog: 0.27.0...0.28.0

[apoelstra]

LOL that half the "first contributors" are established regulars now. It's been a long time since we had a release.

I guess as far as editing, maybe people should just add strikethrough text to the PR they consider too minor to mention, so we can discuss controversial ones?

[tcharding]

I do not have edit permissions on the original post. All of my contributions listed are too minor to mention IMO except perhaps:

• Improve parsing of Denomination string

[apoelstra]

I've invited you to be a maintainer on this repo, so you should be able to edit the issue now.

[darosior]

I guess as far as editing, maybe people should just add strikethrough text to the PR they consider too minor to mention, so we can discuss controversial ones?

I think mine is definitely too minor to be worthy of release notes, feel free to strikethrough/remove.

[tcharding]

I've invited you to be a maintainer on this repo, so you should be able to edit the issue now.

Awesome, thanks!

[vss96]

I guess as far as editing, maybe people should just add strikethrough text to the PR they consider too minor to mention, so we can discuss controversial ones?

My change is minor as well, so feel free to remove it.

[Kixunil]

I strongly believe it'd be very useful to call out breaking changes separately. Will be probably hard to track them down as I'm not confident all of them have API break label.

(Also LOL at my first contribution - I believe my first was overflow bug fix long. My memory is bad, lol.)

[Kixunil]

Started categorizing issues but there are many of them and have to go AFK for a bit and didn't want to risk losing the changes. (Hope it's OK given we can see edit history.)

[afilini]

I guess as far as editing, maybe people should just add strikethrough text to the PR they consider too minor to mention, so we can discuss controversial ones?

I can't directly edit the post, but I think mine aren't worth mentioning. They were mostly improvements/bugfixes to unreleased taproot code, so they also won't have any real impact to external users.

[tcharding]

Strike through done for those requesting it up to now.

[tcharding]

Do we want to re-release secp256k1 with Parity fixup before we release 0.28.0?

[sanket1729]

@apoelstra, I think we should fix the parity along with rust-bitcoin/rust-secp256k1#378. It would simplify a lot of things for rust-miniscript downstream.

[sanket1729]

I don't think we should be tagging everyone for the release notes PR.

The goal of release notes should be

• Document breaking changes. Suggest how to fix them if they are non-trivial
• Highlight new features and APIs that might be of interest.
• Thank everyone for the contributions

[darosior]

I agree with Sanket. I'd add bugfixes as well, as they would definitely be of interest to a downstream project.

…

-------- Original Message --------

On Jan 21, 2022, 03:10, Sanket Kanjalkar wrote: I don't think we should be tagging everyone for the release notes PR. The goal of release notes should be - Document breaking changes. Suggest how to fix them if they are non-trivial - Highlight new features and APIs that might be of interest. - Thank everyone for the contributions — Reply to this email directly, [view it on GitHub](#785 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AFLK3F45VIGRGEWMQBUVKMTUXC57XANCNFSM5MAZVHJQ). Triage notifications on the go with GitHub Mobile for [iOS](https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675) or [Android](https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub). You are receiving this because you were mentioned.Message ID: ***@***.***>

[dr-orlovsky]

Superseded by #915

[tcharding]

I think you meant: superseded by #944