rust-bitcoin

refactor(bip32): rename derivation path extend to join

Use path-like naming convention for non-mutating concatenation like Rust does.

units: Bump version to 0.4.0

In preparation for release add a changelog entry, bump the version,
and update the lock files.

Exclude mutating `ExactSizeEncoder::is_empty`

Encoder tests has been updated to test the outcome of encoders, and
not the internal details of the encoder, this is a default method
which is too trivial to test.

p2p: use char instead of slice

Using a slice is needlessly complex vs a simple char.

bip32: split generic wrapper for Xpriv::new_master

Keep the public new_master accepting impl Into<NetworkKind> and impl
AsRef<Bip32Seed>, but forward the arguments to new_master_inner, thus
preventing inner part from repeating for each inline implementation.

internals: regenerate api snapshots for ArrayVec

The api snapshot files were not refreshed when ArrayVec::set_len and
ArrayVec::spare_capacity_mut were added, leaving cargo rbmt api failing
on master and on every PR that branches from it.

Commit regenerates the entries

bip32: tidy InvalidSeedLengthError trait impls

Follow up to match the conventions used by other errors in this module.

- Derive Copy.
- Add From<Infallible>.
- Use explicit source returning None in std::error::Error.
- Clarify range display message with 'inclusive' word.

bip32: implement Eq for Bip32Seed

Suppress CI from verbose to progress output

I found progress to still be a dramatic enough length reduction to be
worth it while retaining at least some readability while a job is
running.

hashes: fix Miri UB in aarch64 loads

`vld1q_u32` loads four `u32` values, but `&INIT[0]`/`&INIT[4]`
creates a reference to only one `u32`.

Use `INIT.as_ptr()` instead

Update all changelog formats

* H1 Changelog header
* H2 headers for releases
* Diff compare links for relaeses with git tags

Remove root changelog since it is always out of date

hashes: remove outdated readme sections

ci: upgrade cargo-rbmt and fix up breaking changes

The API files are re-generated since cargo-rbmt now de-dupes the output
making it a bit easier on the eyes. The toolchain workflows were updated
as well to use the explicit commands to read current versions instead of
relying on the eval env vars trick.

Fix docs warnings

Remove top-level serde imports

The top-level serde trait imports clutter the global namespace of the
key module and force the use of (*self).serialize() to prevent rust
from using the serde trait functions. By using the serde:: prefix on
all uses of serde in the file, the serialize calls can be simplified.

Remove serde imports and add serde:: prefix to all serde types in key.

Rename and move LegacyPublicKey::to_bytes to serialize

The to_bytes function on LegacyPublicKey no longer yields a vec, but
instead a SerializedLegacyPublicKey. While the type functions like a
byte slice, the typical pattern for the serialising function's name is
serialize(), as is used on the ecdsa and taproot signatures.

Revert LegacyPublicKey::to_bytes to return Vec<u8> and deprecate.
Introduce serialize function that returns SerializedLegacyPublicKey
alongside other serialising functions.

Split encapsulate module to modules per type

The encapsulate module is a name copied from units, where module files
hold encapsulate modules with a single type and a limited API surface.
In crypto::key, the encapsulate module has grown to encompass all of
the key types, which makes it unwieldy. It should be broken into
modules per type, like the single-type encapsulate modules in units.

Split encapsulate module into individual modules per type and adjust
re-exports accordingly.

witness: Allocate in reserve_batch if capacity < MIN_VECTOR_ALLOCATE

Following #6198, the reserve_batch call now allocates a minimum size of
1000 bytes. Since the allocation only updates beyond capacity when
capacity - len == 0, reserve_batch may not always allocate up to the
given required_len.
In WitnessDecoder::push_bytes, reserve_batch is used in such a way that
assumes self.content will have the required_len. This causes a panic
when writing a compact size to the witness content if it does not.

Replace capacity == 0 check with capacity < MIN_VECTOR_ALLOCATE,
ensuring reserve_batch always allocates at least MIN_VECTOR_ALLOCATE
empty content space.

Adjust BIP340 in tapsighash docs

It is policy in this repo to use 4-digit zero padded numbers for BIPs
in documentation. BIP-340 should thus be BIP-0340 in the tapsighash
signing function docs.

Replace pk with key in sighash sign

'pk' typically is shorthand for public key, not private key. Instead,
the generic term key would better suit.

Test consensus encoding error API traits

primitives: move a const to the module level

Make WITNESS_COMMITMENT_MAGIC a module-level const, not a local const in
a function, reuse it in witness_commitment_from_coinbase_simple test.

primitives: witness commitment regression test

Make a block with a witness commitment, but without the witness reserved value.
BIP-0141 forbids this, so check that check_witness_commitment() returns false
and block.validate() returns InvalidWitnessCommitment.

Assisted-by: OpenAI GPT-5

primitives: fix witness commitment check (BIP141)

If a block has a witness commitment, it must also contain exactly one
32-byte witness reserved value EVEN IF no transactions use SegWit.

The commit enforces this check by moving the "there are no transactions
using SegWit" check after the coinbase witness commitment and witness
reserved value checks. Now the check is in line with Bitcoin Core and btcd.

Assisted-by: OpenAI GPT-5