rust-bitcoin

primitive: Fix typos, grammar and formatting in docs

The docs have various typos, grammar and formatting mistakes that should
ideally be fixed before the 1.0 release.

2026-06-21 automated rustfmt nightly

Update API files

Adjust docs on WitnessVersion

primitives: Update API files

Fix base64 panic in from_base64

In sign_message, the from_base64 function can panic if the string has
both a length of 88 bytes, and decodes to an array of bytes > 65. This
can happen for a string of 88 "A" characters, for example. Further, the
function incorrectly parses base64 strings that produce 64 byte arrays.
While the latter is likely caught by the underlying secp parsing, both
should be checked to provide a more meaningful error return.

Add checks for non-65 byte base64 decoding in from_base64, returning
an InvalidLength error for 64 or 66 byte decodes. Also prevent panic on
66 byte decode.

Fix buffer bug in encoding::decode_from_read_unbuffered_with

In decode_from_read_unbuffered_with, the clamped buffer is pushed into
the decoder after a successful read. Some decoders do not completely
consume all provided bytes in a single push_bytes call, which can lead
to parts of the buffer being dropped. Like encoding::decode_from_hex,
the push_bytes should instead be called in a loop until the buffer is
empty, or the error case occurs.

Call push_bytes in a loop to prevent buffer bug in
encoding::decode_from_read_unbuffered_with.

Add regression test for decode_from_read_unbuffered_with bug

The bug in decode_from_read_unbuffered_with is finicky and can only
be triggered in very particular cases. To ensure it is not
reintroduced, a test case should be included.

Introduce regression test for encoding::decode_from_read_unbuffered_with.

Test case produced by Project Loupe.

internals: Update API files

Move ToU64 to bitcoin

Outside of a single usage in p2p which can be replaced by a From call,
the ToU64 trait is only used in bitcoin.

Move ToU64 trait to bitcoin, keeping it pub for use in existing public
API code.

primitives: drop redundant reference in format! calls

Adjust wording on docs to match function behaviour

There are a couple of functions in units that have docs that don't
clearly describe their behaviour. These should be adjusted to better
read and match the functionality.

Adjust from_float_in docs for Amount + SignedAmount and unwrap_or and
unwrap_or_else on NumOpResult.

Fix typos, grammar and formatting in docs

The docs have various typos, grammar and formatting mistakes that should
ideally be fixed before the 1.0 release. This also includes strange
formatting for code in examples.

primitives: Update API files

Update API files

Replace HexPrimitive decoding with consensus_encoding

The HexPrimitive type in primitives provides an alloc-less hex str
decoding for types in primitives. Since consensus_encoding now has
the same functionality in decode_from_hex, the entire from_str on
HexPrimitive (and ParsePrimitiveError) can be completely eliminated.

Replace all decoding uses with decode_from_hex in consensus_encoding.
Remove Parse*Error wrappers around ParsePrimitiveError.

Update API files

primitives: Re-order transaction code

Put the encoding stuff in the conventional order and put other trait
impls all together.

Do `transaction` separately because its a bit more involved.

units: Use uniform whitespace in consts

In some places we have no newlines between associated consts and in
others we have newlines. Lets pick one and be uniform.

Elect to use whitespace.

\me ducks to avoid flaming.

units: Remove all deprecated code

In preparation for releasing `v1.0.0` remove all deprecated code.

consensus_encoding: Update API files

consensus_encoding: Add decode_from_*_with functions

Currently, users of the old encoding traits can call functions to
decode many types (like Vec<u8> or u64) from byte slices. With the new
encoding/decoding traits, there exists no convenient method for users
to decode types without a dedicated Decode impl.

Introduce decode_from_*_with variant functions that are generic on
Decoder + Default instead of Decode.

Update API files

consensus_encoding: Add hex decoding function

Building on the iter decoding functionality, the use of the hex feature
can also provide a decode_from_hex function that allows users to
directly decode a hex &str to a type, without working via a heap vec
and using decode_from_slice.

Introduce decode_from_hex for decoding hex &str to decode types without
heap allocations.

consensus_encoding: Use crate alias in test code

`bitcoin_consensus_encoding` is one hell of a mouthful. Add an alias
to `encoding`.

Test code only.

Run the formatter