rust-bitcoin

hashes: add one-shot hash method to HashEngine

There is currently no generic way to compute a hash.
The hash() methods we have now live on the hash types, not on any trait.
This adds a one-shot hash() method to HashEngine.

Clear pushnum cache on signature operations in sigop count

The `pushnum_cache` was not cleared when encountering a non-push
signature opcode like `OP_CHECKSIG`. This allowed stale push numbers
to leak into subsequent multisig operations if they weren't directly
preceded by a small int push.

Fix this by resetting the cache on signature opcodes, aligning the
sigop calculation with Bitcoin Core consensus logic.

Adjust PartialMerkleTree arbitrary to satisfy decode checks

The PartialMerkleTreeDecoder has various checks in place that enforce
certain invariants for the decoded values. Arbitrary impls should
enforce the same invariants on constructed values as the decoders do.

Adjust PartialMerkleTree arbitrary impl to enforce the same invariants
as the PartialMerkleTreeDecoder.

Prevent panic in UserAgent arbitrary

The current UserAgent arbitrary impl can panic when calling into
UserAgent::new, as it doesn't correctly sanitise the characters and
length of the name. While the decoder doesn't enforce these checks,
unexpected panics in the arbitrary impl are surprising and should be
avoided.

Prevent panics in UserAgent arbitrary impl by sanitising inputs to
UserAgent::new.

Adjust AddrV2 arbitrary to satisfy decode checks

The AddrV2Decoder has various checks in place that enforce certain
invariants for the decoded values. Arbitrary impls should enforce the
same invariants on constructed values as the decoders do.

Adjust AddrV2 arbitrary impl to enforce the same invariants as the
AddrV2Decoder.

Use let-else to flatten nested optionals in is_multisig

Replace nested if-let blocks with let-else statements to make the
early-return pattern more readable and reduce indentation depth.

No behavioral changes introduced.

Reject non-pushnum opcodes in multisig pattern

When checking whether a script is a multisig, opcodes that are not push
numbers (e.g. OP_RESERVED) in the pubkey count position were incorrectly
treated as valid. Return false when any opcode in that position does not
decode to a push number matching the expected count.

Adjust Transaction arbitrary to satisfy decode checks

The TransactionDecoder has various checks in place that enforce certain
invariants for the decoded Transaction values. In the arbitrary fuzz
targets, this can mean that the arbitrary values can fail to round-trip.
Instead, arbitrary should enforce the same invariants on constructed
values as the decoders do.

Adjust Transaction arbitrary impl to enforce the same invariants as the
TransactionDecoder.

Move from_key_and_merkle_root back to taproot-primitives

Contrary to the prior reasoning, this function is necessary for
TapTweak to be moved to taproot-primitives. Since TapTweak needs to
move to taproot-primitives for the sake of addresses, this will need
to be moved back to taproot-primitives.

Remove TapTweakHashExt and move from_key_and_merkle_root back to the
base type in taproot-primitives.

refactor: split bip32 path parse errors

refactor: split bip32 derivation errors

Add basic test module for serde functionality

The new serde functionality requires tests to kill mutants. Following
other crates, a serde test module should be introduced with basic tests
to cover the functionality. For now, only tests to cover mutants are
included.

Add serde tests module to cover mutants in new serde_as_consensus
module.

Update API files

Move serde_as_consensus to consensus_encoding

With the prerequisite changes in place, serde_as_consensus can now be
moved to consensus_encoding with minimal changes.

Move serde_as_consensus to consensus_encoding, removing re-export from
bitcoin.

Add hex extern to consensus_encoding

When the hex functionality was added to consensus_encoding, the hex
crate was added to the public API. Any crate with types in the public
API should also be re-exported from the top level of the crate.

Add gated pub extern for hex crate to consensus_encoding.

Add serde dep to consensus_encoding

The serde dependency will be necessary for the serde_as_consensus
module.

Add and extern serde dep to consensus_encoding

Replace use of HexPrimitive in serde_as_consensus

After the removal of from_str from HexPrimitive, only a single use of
HexPrimitive remains in the serde_as_consensus module. It should be
replaced prior to moving.

Replace use of HexPrimitive with simplified in-line ConsensusHex object.

Remove macros module from internals

Of all the macros from internals::macros, the only one that remains is
const_assert. Since we want to remove most macros from internals, this
macro should be moved to lib.rs and the macros module otherwise
deleted.

Drop macros module from internals and move const_assert to lib.rs

internals: Update API files

Remove unused and deprecated macros from internals::macros

With the _emit_alloc no longer used from internals, the entire
transparent_newtype macro chain can be removed from the internals
macros module, leaving only the macros still in use from internals.

Remove all unused and deprecated macros from internals macros module.

Remove unnecessary _emit_alloc macro

The _emit_alloc macro in internals emits the inner syntax tokens if an
alloc feature is enabled. In practice, this macro is only used inside
of the transparent_newtype macro, which is also only ever used in alloc
gated locations. As such, the _emit_alloc macro has no purpose and can
be removed.

Remove use of internals::_emit_alloc macro in newtype.rs.

Replace impl_to_hex_from_lower_hex with deprecated inherent to_hex

The impl_to_hex_from_lower_hex macro from internals implements a to_hex
function for a type by calling through to an existing LowerHex impl.
This has been something that we've wanted to remove for a while, so
a first step involves deprecating the macro and removing all uses.

Replace impl_to_hex_from_lower_hex with deprecated inherent to_hex on
all types.

Move impl_array_newtype to include/array_newtype.rs

The array_newtype.rs include file has been used for bitcoin's
previously internal macro impl_array_newtype_stringify. Since the name
lends itself to dual usage with the impl_array_newtype macro, and the
two may be used together, the macro can be copied from internals to
this include file.

Move impl_array_newtype macro to include/array_newtype.rs. Deprecate in
internals and replace uses with include! copy.

Seal the Tag trait

The Tag trait used for script/key tags in primitives claims to be a
sealed trait. Sealing prevents outside users from adding new types
which satisfy the trait, but the Tag trait has no such sealing.

Add sealed::Sealed module + trait and seal Tag trait on Sealed trait.

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.