bitcoin

• Backport: Make SendCmpct idempotent #6525
• Add consensus_encoding to block/compact-block p2p message types #6457
• Add consensus_encoding support to types in bitcoin-primitives #6333
• Add consensus_encoding support to core p2p message types #6443
• Add consensus_encoding support to BIP157/158 filter message types #6444
• Use write! in ParseNetwork and UnknownAddressType error displays #6386

Bump the MSRV to Rust 1.60.0

Exposes the new stabilized encoding library through the optional encoding feature. Note that enabling it bumps the MSRV to 1.74.0.

• Remove mutagen #6337
• Use write! in ParseNetwork and UnknownAddressType error displays #6386
• Add consensus_encoding to types present in units 1.0 #6184

This release was yanked because the MSRV bump to 1.74.0 was too aggressive for some users. See version 0.32.101 for a smaller upgrade to 1.60.0.

Bump the MSRV to Rust 1.74.0

Note the version number jump. We jumped to v0.32.100 when doing the MSRV bump so as to leave room for a bunch of secuity releases up to this number if needed.

• Our primary users (BDK and LDK) are at 1.85 already well ahead of 1.74.
• We would like to deliver the new sans-IO consensus_encoding crate in a point release.
• The would like to later support ergonomic conversion to other 1.0 types (from bitcoin-units, and and bitcoin-primitives) without forcing the whole ecosystem to upgrade.
• Opens the door to the possibility of doing releases and then using the semver trick.

• Backport: Make SendCmpct idempotent #6527

• Fix bug in LeafVerison::Future's Display output #6208
• Manually revert VarInt range check #6182
• Backport - p2p: Add a hash value to Inventory's Error variant #6147
• Backport - p2p: Error on RawNetworkMessage decode if payload partly consumed #6140
• Backport - p2p: Error on invalid FeeRate in FeeFilter decode #6142
• Backport - Validate ASCII and preserve embedded nulls in CommandString parsing #6136
• Remove the internals dependency #6200

• Backport - Fix Unknown NetworkMessage encoding #6106
• Backport - Arbitrary #5085
• Backport - Add CompactSize range check to deserialization #5921

• Backport - bip158: Return no match for empty query #4972
• Remove doc_auto_cfg

• Backport - Use _u32 in FeeRate constructor instead of _unchecked #4552
• Backport - Add support for pay to anchor outputs #4691
• Backport - Remove non_exhaustive from Network #4658

• Backport - Fix is_invalid_use_of_sighash_single() incompatibility with Bitcoin Core #4122
• Backport - Backport witness fixes #4101
• Backport - bip32: Return error when attempting to derive past maximum depth #4434
• Backport - Add XOnlyPublicKey support for PSBT key retrieval and improve Taproot signing #4443
• Backport - Add methods to retrieve inner types #4450

• Backport - Re-export bech32 crate #3662
• Backport - Add API for extracting the inner payload of RawNetworkMessage #3523
• Backport - Fix bug in witness stack getters #3626
• Backport - address: Add Address::into_unchecked #3655

• Bound decode methods on Read, rather than BufRead #3173
• Backport - Some additional inspectors on Script and Witness #2646
• Backport - Add difficulty adjustment calculation #3494
• Backport - Add testnet 4 support #3453
• Backport - CI: Copy main workflow from master #3418

• Backport BIP-0032 alias' without typo #3252

• Fix a bug when parsing 256-bit numeric types #2837

Fix things we broke/removed from the Address API in the last release.

• Enable getting the witness program from an address #2804
• Make Address:p2sh_from_hash public #2806
• Add an AddressData type #2810

If you are looking for the address::Payload type we removed in v0.32.0 then the AddressData type might be what you are after.

• Bump MSRV to Rust 1.56.1 #2188
• Remove "no-std" feature #2233
• Enforce displaying Amount with trailing zeros #2604

Things you will almost certainly hit when upgrading

• Rename Signature field names #2338
  • sig becomes signature
  • hash_ty becomes sighash_type
• Rename txid to compute_txid #2366
• In hardcoded BIP-0032 derivation paths: Remove m/ prefix requirement #2451

Crate smashing

This release we continued our effort to split up the library into smaller crates AKA crate smashing.

• Release new bitcoin-units crate docs
• Release new base58ck crate docs
• Release new bitcoin-io crate docs

Bug fixes

• Fix FeeRate::checked_mul_by_weight #2182
• Use network when calculating difficulty #2168
• Fix InputWeightPrediction::P2WPKH_MAX constant DER sig length #2213
• Fix CJDNS marker byte check #2546
• Add resource limit check during deserialization of Merkle block #2607

Changes to and involving the Network type

In release 0.31.0 we managed to annoy a lot of people by the addition of non_exhaustive to the Network type. After much discussion, and in an effort to cater to multiple camps, we did a bunch of changes this release. To sum up, "network" is ill defined and it means different things to different devs/software. Your software should probably have some custom handling of whatever "network" means to you.

In particular consider having some type that implements AsRef<Params>, we have attempted to replace Network in much of the API (#2541).

• Add NetworkKind #2232
• Reduce usage of Network in the public API #2541
• Remove Network from AddressInner #1832
• Add consts to Params for individual networks #2396
• Add params() method to Network #2172
• Use KnownHrp instead of Network #2387
• Add check to max difficulty transition threshold #2337

Other API additions

• Add CompressedPublicKey #2277
• Add a consensus::deserialize_hex function #2039
• Add Witness::p2tr_key_spend function #2097
• Add taproot::SerializedSignature #2156
• Add input weight predictions for p2pkh outputs #2185
• Add Weight::from_vb_weight function function (added in #2206, renamed in #2228
• Implement LowerHex and UpperHex for CompactTarget #2221
• Add conversions from TXIDs to Merkle nodes #2227
• Add transaction::effective_value() function #2230
• Improve LockTimes and related types:
  • Improve relative locktime API #2549
  • Implement ordered::ArbitraryOrd for absolute and relative locktimes, introducing the "ordered" feature:
    • #2581
    • #2248
• Add and use custom ArrayVec
  • #2287
  • #2286
  • #2310
• Add the implementation of Display for transaction::Version #2309
• Add functionality to serialize signatures to a writer #2392
• Add unchecked integer operations to Amount and SignedAmount (add, sum etc.) #2436
• Add methods p2wpkh_script_code to Script and ScriptBuf #2445
• Improve API for signing Taproot inputs in PSBTs #2458
• Add TapNodeHash getter method on TapTree and NodeInfo #2467
• Add hex parsing to pow types #2514
• Implement From<core::convert::Infallible> for errors #2516
• Add ServiceFlags::P2P_V2 #2555

Other API breaking changes

• Require io::BufRead instead of io::Read in consensus decode trait #2240
• Make Payload and AddressEncoding private #1979
• Remove bech32 from the public API #2381
• Make from_hex inherent for byte-like types #2491
• Remove the FromHexStr trait #2492

Error handling

• Split Prevouts errors out into specific error types #2042
• Improve error handling in the sighash module #2329
• Improve lock time errors #2417
• Split relative locktime error up #2433
• Improve amount module errors #2487
• Add the FromScriptError for handling errors in address #2497
• Add NetworkValidationError #2508 but don't return it #2610
• Improve leaf errors ("leaf" means not enum with nested error type) #2530

• Fix bug in FeeRate::checked_mul_by_weight #2128
• Add BIP-0032 types remove in 0.31 back in and mark as deprecated #2258

• Bump MSRV to Rust 1.48.0 #1729

• Add new example code for signature verification #1776

• Manually implement Debug on Witness #1913

• Use new bech32 API #1951 and #2117

• Upgrade to secp256k1 v0.28.0 #2098

• Upgrade to base64 v0.21.3 #2032

• API Improvements:

  • Add kilo weight unit conversion #1735
  • Add ChainHash::from_genesis_block_hash#1753
  • Add implementation of PartialEq trait for Address<NetworkUnchecked> #1757
  • Add unsafe address type conversions #1765
  • Add Inventory::network_hash() method #515
  • Implement serde::Serialize for Address #1785
  • Expose valid (min, max) difficulty transition thresholds #1820
  • Add functionality to generate PrivateKey #1837
  • Allow parsing sub-sat denominations with decimal points #1768
  • Fix associated constants of InputWeightPrediction #1835
  • Add FeeRate::checked_mul_by_weight #1864
  • Use Amount type for the TxOut value field #1811
  • Add support for alloc-free parse errors #1297
  • Add Amount::from_int_btc #1870
  • Make ckd_priv function private and impl AsRef for ChildNumber #1882
  • Use hex_lit::hex in benches (also backported to v0.30.1) #1941
  • Add a verify function to PublicKey #1911
  • Add method Script::count_sigops #1890
  • Implement From<PublicKey> for XOnlyPublicKey #1901
  • Implement From<secp256k1::PublicKey> for bitcoin::PublicKey #1949
  • Add DerivationPath::to_u32_vec #1946
  • Use Target as type for pow_limit #2107
  • Add Witness::p2wpkh constructor #2084
  • Make Instruction be able to read the script number #2081
  • Add Script::is_mulitsig #2078
  • Count sigops for Transaction #2073
  • Add Psbt fee checks #2064
  • Add version bytes consts #2020
  • Add transaction::Version data type #2006

• Moves, Removes, and renames:

  • Move witness types to the script module #1846
  • Remove reexport of psbt::Prevouts #1872
  • Rename Transaction::is_coin_base to is_coinbase #1796
  • Rename TaprootSpendInfo::as_script_map to script_map #1897
  • Rename Script::empty to Script::new #1925
  • Rename PartiallySignedTransaction to Psbt #1938
  • Rename XpubIdentifier to XKeyIdentifier #2021
  • Rename ExtendedPubKey to Xpub #2019
  • Rename ExtendedPrivKey to Xpriv #2019
  • Remove _v0 from various function names (eg, new_v0_p2wpkh) #1994
  • Remove SighashCache::segwit_signature_hash (add p2wpkh_signature_hash and p2wsh_signature_hash) #1995
  • Reexport all the hash types from the crate root #1998
  • Rename opcodes::All to Opcode #1995
  • Removed TxOut::default(), the same logic now exists as TxOut::NULL #1811 and #1838

• Error handling improvements:

  • Improve hashes::Error #1873
  • Add ValidationError #1874
  • Improve crypto::taproot error type #1895
  • Audit error types code base wide #2101

• Expose valid (min, max) difficulty transition thresholds [#1820](Expose valid (min, max) difficulty transition thresholds)

• Fix compilation when RUSTFLAGS=--cfg=bench is set

Backported a set of changes from 0.29 which may cause some specific transactions and/or blocks to fail to deserialize. No known such transactions exist on any public blockchain.

• Fix Display impl of ChildNumber

The previous release changed the behavior of Display for ChildNumber, assuming that any correct usage would not be affected. Issue 608 goes into the details of why this isn't the case and how we broke both rust-miniscript and BDK.

• Change Amount Debug impl to BTC with 8 decimals
• Make uint types (un)serializable
• Add more derives for key::Error
• Fix optional amount serialization
• Add PSBT base64 (de)serialization with Display & FromStr
• Add non-API breaking derives for error & transaction types
• Fix error derives
• Add function to check RBF-ness of transactions
• Add Script:dust_value() to get minimum output value for a spk
• Improving bip32 ChildNumber display implementation
• Make Script::fmt_asm a static method and add Script::str_asm
• Return BlockHash from BlockHeader::validate_pow
• Add a method to error on non-standard hashtypes
• Include proprietary key in deserialized PSBT
• Fix Script::dust_value()'s calculation for non-P2*PKH script_pubkeys
• Add Address to optimized QR string conversion
• Correct Transaction struct encode_signing_data_to doc comment
• Fixing CI if base image's apt db is outdated
• Introduce some policy constants from Bitcoin Core
• Fix warnings for sighashtype
• Introduction of Schnorr keys
• Adding constructors for compressed and uncompressed ECDSA keys
• Count bytes read in encoding
• Add verify_with_flags to Script and Transaction
• Fixes documentation intra-links and enforce it
• Fixing hashes core dependency and fuzz feature

• Add signet support
• Add wtxidrelay message and WTx inv type for BIP 339
• Add addrv2 support
• Distinguish FilterHeader and FilterHash
• Add hash preimage fields to PSBT
• Detect write errors for PublicKey::write_into
• impl Ord and PartialOrd for Inventory
• Add binary encoding for BIP32 xkeys
• Add Taproot Tagged Hashes
• Add message::MAX_INV_SIZE constant
• impl ToSocketAddrs for network addresses
• Add new global fields to PSBT
• Serde serialization of PSBT data
• Make Inventory and NetworkMessage enums exhaustive
• Add PSBT proprietary keys
• Add PublicKey::read_from method symmetric with write_to
• Bump rust-secp to 0.20, turn off recovery feature by default
• Change return value of consensus_encode to io::Error

• Remove an incorrect debug_assert that can cause a panic when running using the dev profile.

• Bump MSRV to 1.29.0

• Remove the BitcoinHash trait
• Introduce SigHashCache structure to replace SighashComponents and support all sighash modes
• Add Transaction::get_size method
• Export util::amount::Denomination
• Add Block::get_size and Block::get_weight methods
• Add MerkleBlock::from_header_txids
• Add BlockHeader::u256_from_compact_target
• Add feefilter network message
• Cleanup/replace Script::Instructions iterator API
• Disallow uncompressed pubkeys in witness address generation
• Deprecate util::contracthash module
• Add modulo division operation for Uint128 and Uint256
• Add slice_to_u64_be endian conversion method

• Update secp256k1 dependency to 0.17.1.
• Update bitcoinconsensus dependency to 0.19.0-1.
• Update bech32 dependency to 0.7.2.

• Add ServiceFlags type.
• Add NetworkMessage::command.
• Add key::Error.
• Add newtypes for specific hashes:
  • Txid
  • Wtxid
  • BlockHash
  • SigHash
  • PubkeyHash
  • ScriptHash
  • WPubkeyHash
  • WScriptHash
  • TxMerkleNode
  • WitnessMerkleNode
  • WitnessCommitment
  • XpubIdentifier
  • FilterHash
• Refactor CommandString.
• Refactor Reject message.
• Rename RejectReason enum variants.
• Refactor encode::Error.
• Implement Default for TxIn.
• Implement std::hash::Hash for Inventory.
• Implement Copy for InvType enum.
• Use psbt::Error in PartiallySignedTransaction::from_unsigned_tx.
• Drop message decode max length to 4_000_000.
• Drop hex and byteorder dependencies.

• Add serde to BlockHeader and Block
• Clean up StreamReader API (breaking change)
• Add reject message to p2p messages

• Update secp256k1 0.15 and bitcoinconsensus 0.17

• Add Amount and SignedAmount types.
• Add BIP-0158 support with BlockFilter and related types.
• Add util::misc::signed_msg_hash() for signing messages.
• Add MerkleBlock and PartialMerkleTree types.
• bip32: Support serde serialization for types and add some utility methods:
  • ChildNumber::increment
  • DerivationPath::children_from
  • DerivationPath::normal_children
  • DerivationPath::hardened_children
• Add blockdata::script::Builder::push_verify to verify-ify an opcode.
• Add sendheaders network message.
• Add OutPoint::new() method and JSON-serialize as <txid>:<vout>.
• Refactor Address type:
  • Now supports segwit addresses with version >0.
  • Add Address::from_script constructor.
  • Add Address::address_type inspector.
  • Parsing now returns an address::Error instead of encode::Error.
  • Removed bitcoin_bech32 dependency for bech32 payloads.
• bip143: Rename witness_script to script_code
• Rename BlockHeader::spv_validate to validate_pow
• Rename OP_NOP2 and OP_NOP3 to OP_CLTV and OP_CSV
• psbt: Use BTreeMap instead of HashMap to ensure serialization roundtrips.
• Drop Decimal type.
• Drop LoneHeaders type.
• Replace strason dependency with (optional) serde_json.
• Export the bitcoin_hashes and secp256k1 dependent crates.
• Updated bitcoin_hashes dependency to v0.7.
• Removed rand and serde_test dependencies.
• Internal improvements to consensus encoding logic.

• Update bitcoin-bech32 version to 0.9
• add to_bytes method for util::key types
• add serde impls for util::key types
• contracthash: minor cleanups, use util::key types instead of secp256k1 types

• Add some trait impls to PublicKey for miniscript interoperability

• Update minimum rustc version to 1.22.
• Replace rust-crypto with bitcoin_hashes; refactor hash types
• Remove Address::p2pk
• Remove misleading blanket MerkleRoot implementation; it is now only defined for Block
• Add BIP157 (client-side block filtering messages)
• Allow network messages to be deserialized even across multiple packets
• Replace all key types to better match abstractions needed for PSBT
• Clean up BIP32 in preparation for PSBT; use new native key types rather than secp256k1 ones
• Remove apparently-used Option serialization code
• Finally merge PSBT after nearly nine months

• Reorganize opcode types to eliminate unsafe code
• Un-expose some macros that were unintentionally exported
• Update rust-secp256k1 dependency to 0.12
• Remove util::iter::Pair type which does not belong in this library
• Minor bugfixes and optimizations

• Detect p2pk addresses with compressed keys

• Significant API overhaul:
  • Remove nu_select macro and low-level networking support
  • Move network::consensus_params to consensus::params
  • Move many other things into consensus::params
  • Move BitcoinHash from network::serialize to util::hash; remove impl for Vec<u8>
  • Rename/restructure error types
  • Rename Consensus{De,En}coder to consensus::{De,En}coder
  • Replace Raw{De,En}coder with blanket impls of consensus::{De,En}coder on io::Read and io::Write
  • make serialize and serialize_hex infallible
• Make 0-input transaction de/serialization always use segwit
• Implement FromStr and Display for many more types