rust-bitcoin

units: Update serde_regression test

The serde_regression test case in units checks for regressions in the
serde implementations for any type in units. Since new types with serde
impls have been added to units, this needs to be updated.

Update the serde_bincode and add Target and Work to Serde test struct
in serde tests.

Move pow serde tests to units

The serde regression tests for the proof-of-work types can and should
be moved to units, rather than remaining in bitcoin to ensure that any
regressions are caught by the crate that implements the serde traits,
rather than one that uses them.

Move regression_target and regression_work serde tests to units, moving
the u256 bincode as necessary.

Replace upper-lower serde parsing with from_unprefixed_hex

The U256 deserialize impl manually splits a known-length string into
upper and lower halves. While this functions correctly, it's a
needless reimplementation of the same functionality present in U256's
from_unprefixed_hex function.

Replace the manual split of strings in U256 deserialize with a single
call to from_unprefixed_hex.

Remove visit_bytes from U256 serde

In the U256 serde deserialize impl, a visitor struct is defined inside
of an is_human_readable() condition block. The visit_bytes function in
this block can't be used as the data is human readable and thus only
visit_str is required. As such, it can be removed.

Remove the visit_bytes from the HexVisitor struct in U256 Deserialize.

Update API files

Update API files

Add psbt fuzz target

units: Add #[inline] attributes to simple functions

Where functions merely delegate to other functions, or only perform
trivial operations, they should be annotated with #[inline] to nudge
the compiler towards improving performance by inlining them.

Add #[inline] to trivial functions in all modules.

Update api files

p2p: Implement ExactSizeEncoder for AddrV2Encoder

For encoders, the use of the encoder_newtype_exact macro allows for
the implementation of the ExactSizeEncoder trait. This provides users
with the ability to determine the encoding length of types without
needing to perform the entire encoding process. Since the AddrV2Encoder
can do the necessary calculation in constant time, this trait should
be implemented for it too.

Implement ExactSizeEncoder for AddrV2Encoder.
Add test cases to confirm correct encoding + length calculation for
all types of AddrV2.

key: Make as_inner pub(super) for secret key types

As part of the long-term goal to remove the need to access the inner
secp types for all key types, the secret keys can now have their
inner accessor functions made pub(super). These functions are still
needed for functionality in the key module, but are no longer
necessary in the bitcoin crate or in the wider ecosystem.

Make as_inner pub(super) on PrivateKey and Keypair.

key: Add From conversions for references for secret key types

As with the changes to the from_* functions, there should exist From
impls that take references for all From impls that work on secret key
types. This further simplifies working with the non-Copy secret types.

Add From<&TweakedKeypair> for &Keypair, From<&PrivateKey> for Keypair
and From<&TweakedKeypair> for TweakedPublicKey.

key: Adjust all from_* functions to take refs

The secret key types in bitcoin are no longer Copy. Since some
conversions to public key types take the key types by value, this makes
the use of private keys fairly unergonomic. Except where necessary,
conversion constructors for all key types (that is, from_* functions)
should always take references. This can help avoid costly copies.

Change from_keypair on TweakedPublicKey, from_private_key on
CompressedPublicKey and from_secret_bytes on PrivateKey to all take
references instead of values.

Add panics section to docs

Docs cleanup

Add a couple of missing full stops and capital letters.

bitcoin: Move key module errors to error submodule

At present, some modules in bitcoin 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 key module into error submodule and re-export.

bitcoin: Move transaction module errors to error submodule

At present, some modules in bitcoin 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.

bitcoin: Move sighash module errors to error submodule

At present, some modules in bitcoin 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 sighash module into error submodule and re-export.

bitcoin: Move ecdsa module errors to error submodule

At present, some modules in bitcoin 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 ecdsa module into error submodule and re-export.

bitcoin: Move bip32 module errors to error submodule

At present, some modules in bitcoin 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 bip32 module into error submodule and re-export.

bitcoin: Move sign_message module errors to error submodule

At present, some modules in bitcoin 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 sign_message module into error submodule and
re-export.

fuzz: pin cargo-fuzz to 0.12.0

primitives: Replace decoder definitions with decoder_newtype macro

Introduce decoder_newtype macro in primitives through the include!
macro.
Replace all newtype Decoder structs in primitives with decoder_newtype
calls.

units: Replace decoder definitions with decoder_newtype macro

Throughout the crates, there exist various decoder types that are
newtype wrappers around existing encoders. Almost all of these use the
same boilerplate for most of their logic and can be replaced by a
macro that provides the same functionality.

Introduce private decoder_newtype macro in include file and introduce
to units crate through include! macro.
Replace all Decoder structs in units with decoder_newtype calls.

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.