rust-bitcoin

Update api files

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

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.

primitives: Update API files

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.

Fix cargo-rmbt typo

hashes: Update API files

consensus_encoding: bump compact size default decoding limit

Bump the max decoding limit on the standard compact size decoder from
4MB to 32MB. This matches the value used in Core as the general anti-DoS
setting.

All current call sites across the crates are updated to use the old
default explicitly. They can be changed to use the new default if it
makes sense on a case by case basis.

This new default breaks on 16-bit machines since it doesn't fit in a
usize. The alternative would be to change the type to a u64 which sucks
for everyone else.

api: update api files

consensus_encoding: add custom limit construcotrs to generic decoders

Allow setting a custom limit in case the default 4MiB is too conservative.

consensus_encoding: fix documentation header

"to usually to encode" is nonsensical.

primitives: Add derives to encoders and decoders

We forgot to derive `Clone` and `Debug` for all the encoders and decoders.

We did do it over in `consensus_encoding` so we can just slap the
derives on. Arguably these could be in the macro for encoders but for
the sake of explicitness just put them on the call site.

Implement Clone for decoders

The composite decoders are missing `Clone` impls. Do the same as we do
for `Debug` and implement them manually.

units: Add derives to encoders and decoders

We forgot to derive `Clone` and `Debug` for all the encoders and
decoders. We did do it over in `consensus_encoding` so we can just
slap the derives on. Arguably these could be in the macro for encoders
but for the sake of explicitness just put them on the call site.

Implement Debug for Decoder6

We did the other composite decoders but forgot this one.

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

ci: switch to rbmt api command

API files have been moved into the package directories themselves instead
of the shared root level api/ directory.

consensus_encoding: Move errors to submodule

In order to make the HTML docs render more clearly it would be nice to
have all the errors separate. We recently introduced a policy for
doing this repo wide.

Add a public `error` submodule and re-export all errors at the crate
root.

Because of anomalies in how `cargo` renders docs for re-exports
between types and modules explicitly use `doc(inline)` and `no_inline`
so we get exactly the behaviour we desire.

consensus_encoding: Set 100 column width

`rust-bitcoin` project uses 100 column width for rustdoc. Now that
`consensus_encoding` is a hair width away from 1.0 update all the
rustdocs to use it.

However do not be dogmatic; if a doc is better with slightly
different colum width then do so.

consensus_encoding: Add whitespace between type and function

consensus_encoding: Pluralize rustdoc title

Match manifest nightly version

Inline merkle node encoding

Add inline to the merkle node encoder, decoder and constructors to match
BlockHash.