rust-bitcoin

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 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 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 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.

fuzz: pin cargo-fuzz to 0.12.0

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.

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.

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.

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.

hashes: Move errors in sha256 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 MidstateError to new error submodule and re-export in sha256.

Add homepage metadata for all crates

Per the Rust API guidelines:
The homepage metadata should only be set if there is a unique website
for the crate other than the source repository or API documentation.

Add "https://rust-bitcoin.org" homepage to all crate manifests.

Move From<Infallible> impls below type

As is customary put the impl below its type. However when there is an
impl block for the error type put the `From` below that. Note the
layout is then

1. Type definition
2. [Type impl block]
3. `From<Infallible>` for type
4. `Display`
5. `std::error::Error`
6. [other `From` impls]

Anal I know. Code move only.

bitcoin: derive `Clone` for `SighashCache`

Derive `Clone` for `SighashCache` and its internal cache structs.

Replace uses of secp XOnlyPublicKey with parity access

Now that the bitcoin XOnlyPublicKey has parity included, there are some
uses of the secp type that can be replaced by the bitcoin type.

Change Witness::p2wpkh to take bitcoin PublicKey

The p2wpkh function on Witness takes a secp public key. This ultimately
causes various other places to need to convert from the bitcoin type
to the secp type needlessly.

Change Witness::p2wpkh to take bitcoin::PublicKey and adjust call sites
accordingly.

hashes: Split cfg(all(...)) into stacked attributes

bitcoin: Split cfg(all(...)) into stacked attributes

hashes: Adjust hash newtype doc comments

In hashes, a handful of the transparent_newtype invocations for hashes
use doc comments that are missing backticks around names or are
generally unclean. These should be normalised to suit typical style.

Adjust doc comments on sha256t, sha256d, muhash and siphash hash
newtypes.

Move transparent_newtype to use include!

The transparent_newtype macro from internals is one of many cross-crate
macros which we'd like to remove over time.

Copy transparent_newtype macro to include directory. Replace all uses
of internals::transparent_newtype with include! calls and direct usage
of the macro.

Run the formatter

hashes: fmt skip a bunch of stuff

Add attribute to a bunch of stuff recently introduced in #5888.

Introduce From conversion for PrivateKey -> Keypair

In order to reduce the reliance on as_inner for creating keypairs
from private keys, a method of generating Keypairs from PrivateKey
objects should be introduced.

Introduce from_private_key and to_private_key on Keypair.
Introduce From<PrivateKey> for Keypair type.
Replace uses of from_secret_key and to_secret_key with from_private_key
and to_private_key.