rust-bitcoin

base58: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None.

p2p: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None. For enum errors, also return None for each match arm.

bitcoin: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None. For enum errors, also return None for each match arm.

hashes: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None.

consensus_encoding: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None.

primitives: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None. For enum errors, also return None for each match arm.

units: Add explicit None return impl for std::error::Error

The std::error::Error impls on many error types rely on the default
implementation for the trait, which returns None. While these are
correct, explicit return values make the functionality more obvious to
later developers without requiring pre-existing knowledge of the trait
or needing to search documentation.

Replace all default impls of std::error::Error with explicit impls
returning None.

hashes: Add a full stop to the sha256 error module comment

This was missing from the the original PR, but should be included
because publicly visible doc comments should always be well-formed
English.

CI: Update to latest cargo-rbmt

We are a few commits back; use the commit hash of current tip of
master.

2026-04-05 automated rustfmt nightly

bitcoin: update CompactSize Kani proofs

Rename PublicKey to LegacyPublicKey

The optionally-compressed PublicKey type is no longer used in Bitcoin
outside of legacy transaction handling. Since the name PublicKey
implies a general purpose public key type, it should be renamed to
clarify the niche use compared to the typical compressed public key
type, FullPublicKey.

Rename PublicKey to LegacyPublicKey.
Deprecate PublicKey.

Rename CompressedPublicKey to FullPublicKey

The CompressedPublicKey represents an always compressed ECDSA public
key. This key type is the standard for almost all transactions in
modern Bitcoin. As such, it should be renamed to better clarify
its purpose.

Rename CompressedPublicKey to FullPublicKey.
Deprecate CompressedPublicKey.

primitives: Update API files

primitives: Move block module errors to error submodule

At present, some modules in primitives separate error types into
submodules with re-exports while others simply define the error types
in the module. This inconsistency is confusing and makes the docs vary.
All error types for each top-level module should be moved into a
relevant submodule and re-exported without inline docs.

Move error types from block module into error submodule and re-export.

primitives: Move witness module errors to error submodule

At present, some modules in primitives separate error types into
submodules with re-exports while others simply define the error types
in the module. This inconsistency is confusing and makes the docs vary.
All error types for each top-level module should be moved into a
relevant submodule and re-exported without inline docs.

Move error types from witness module into error submodule and
re-export.

primitives: Move transaction module errors to error submodule

At present, some modules in primitives separate error types into
submodules with re-exports while others simply define the error types
in the module. This inconsistency is confusing and makes the docs vary.
All error types for each top-level module should be moved into a
relevant submodule and re-exported without inline docs.

Move error types from transaction module into error submodule and
re-export.

primitives: Move script module errors to error submodule

At present, some modules in primitives separate error types into
submodules with re-exports while others simply define the error types
in the module. This inconsistency is confusing and makes the docs vary.
All error types for each top-level module should be moved into a
relevant submodule and re-exported without inline docs.

Move error types from script module into error submodule and re-export.

Fix cargo-rmbt typo

fuzz: Replace Unstructured with auto Arbitrary arg for do_test

With the new libfuzzer backend for the fuzz targets, types that
implement Arbitrary can be directly constructed as arguments to the
fuzz_target! callback, rather than taking a byte slice, running it
through Unstructured and then calling Arbitrary impls manually.

ref:
https://rust-fuzz.github.io/book/cargo-fuzz/structure-aware-fuzzing.html

Replace manual arbitrary use with an automatic Arbitrary argument in
arbitrary_block, arbitrary_transaction, arbitrary_witness,
deserialize_psbt and arbitrary_addrv2 fuzz targets.

p2p: Add derives to encoders and decoders

The encoder and decoder types should all have the Debug and Clone
traits implemented. Since the underlying encoders and decoders all have
Clone and Debug, we can use #[derive] to implement them for all
encoders and decoders in p2p.

Add #[derive(Debug, Clone)] to all encoders and decoders in p2p.

base58: Make error re-exports #[doc(no_inline)]

To match the standard set elsewhere, re-exports of errors in top-level
modules of each crate should be #[doc(no_inline)].

chacha20_poly1305: Move errors to error submodule

As part of the process of moving errors to dedicated error submodules,
the main error type in the chacha20 crate should also be moved to a
submodule. While this error type is currently in the root and not a
top-level module, the same pattern should still apply.

Move Error type to error submodule and re-export error type as
no_inline.

hashes: Move errors in hkdf to error submodule

As with the other crates, errors in hashes should be moved to
submodules for each of the top-level modules. Any errors should then
be no_inline re-exported in the top-level module.

Move MaxLengthError to new error submodule and re-export in hkdf.

hashes: Update API files