rust-bitcoin

Remove From<SubError> for Error impls

Run the formatter

consensus_encoding: Error on byte-less end for VecDecoder

In the existing encoding, Vec<T> would error when attempting to decode
an empty byte slice (i.e. one without a length prefix). In the new
consensus_encoding crate, a VecDecoder successfully decodes a
completely empty byte slice as 0 length Vec<T>. This difference in
behaviour manifests in various decoders throughout the stack and thus
results in differences in decoding behaviour.

Throw Eof error in VecDecoder::end() if no length prefix has been
provided to the decoder.

primitives: Update API files

primitives: Add Default and new to all decoders

In order to simplify composition of decoder types, the Default trait
and new() function should be provided for all decoder types.

Add Default and new to BlockDecoder, HeaderDecoder, TxInDecoder and
TxOutDecoder.

primitives: Convert encoders to ExactSizeEncoder

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. The TxIn and TxOut encoders in
primitives can be made ExactSizeEncoders but are currently not.

Replace uses of encoder_newtype with encoder_newtype_exact for TxIn and
TxOut encoder types.

internals, hashes, primivties: clean up optional deps

If you use the `dep:OPTIONAL_DEP` syntax in a package's feature, then
the implicit feature flag for the optional dependency is disabled. No need
to tell end users to avoid it.

Re-export serde and arbitrary when they appear in public API

In various crates, we have types from external crates in the public
APIs, such as serde's Serialize or arbitrary's Arbitrary. In order to
simplify dependency handling, we should re-export these crates which
have types appearing in the public API.

Add pub extern crate for serde and arbitrary in bitcoin, network, p2p,
units and primitives as needed.

api: update for CompactSizeU64Decoder

consensus_encoding: move compact size into its own module

Public API is unchanged; lib.rs re-exports all the same types.

units: Add hex parsing for Amount and SignedAmount

The Amount and SignedAmount types are numeric wrapper types that should
include functionality for parsing from hex. Since the types can error
during construction for non-hex reasons, the existing ParseAmountError
needs to be extended

Add additional variants to ParseAmountErrorInner to handle hex parsing.
Introduce from_hex and from_hex_unprefixed to Amount and SignedAmount.

p2p: add version message encoder/decoder

* `VersionMessage` is a composition of 9 decoders, however, there is no
such `Decoder9`. Instead of creating a `Decoder9`, combine the first 3
decoders using a `Decoder3` and then the last 6 using a `Decoder6`.

* Replace `deserialize` in test with `decode_from_slice` since push based
encoding is planned to replace the current serialization provided by
`bitcoin::consensus::encode`.

* In the test cases, replace `serialize` with `encoding::encode_to_vec`
since the push encoding here is planned to replace the existing
`serialize` implementation.

Update the API files

Run `just check-api`.

Move script hexification functions to primitives

The functions for converting scripts to hex have clean API's, we
iterated on them a ton already. Currently the implementation uses the
old consensus code but we have all this available in `primitives` now
as well as an optional dependency on `hex_unstable`.

Lets move them to primitives.

Note that this patch adds a seemingly unnecessary allocation, maybe we
have an API that needs improving or maybe I'm being brain dead ATM.

Intentionally leave the unit test where it is for now to prove nothing
in `bitcoin` breaks.

bitcoin: Replace script hex decoding with new consensus crate

Currently we are using the old consensus deserialization code to
decode scripts as well as the unstable hex crate.

Now that we have both a stable `hex` parsing crate and a
soon-to-be-stable consensus encoding crate we can use them to shore up
the script hex parsing functions.

Remove honggfuzz inputs

We have switched over to libfuzzer, so these honggfuzz inputs are no
longer needed

Fix decoder and encoder re-exports

The bitcoin crate should always be a superset of primitives, and
primitives a superset of units. Due to a filter check in
generate-bitcoin-re-export-test.sh, encoder and decoder types and their
associated errors are not being caught missing from bitcoin.

Remove the encoder/decoder type filter and add pub use (re-exports) to
generate-bitcoin-re-export-test.sh and correctly re-export all required
types.
Add pub use check to primitives re-export script.

Fix decoder error Display and source impls

hashes: Introduce hex stable and remove unecessary uses of hex_unstable

The hashes crate provides various cross-crate macros, which expose
unstable hash errors in the public API of the crates that use them. In
order to remove these unstable errors from the bitcoin API, the hashes
crate needs to use stable hex_conservative errors in these macros.

Introduce hex_conservative 1.0.0 as a dependency for hashes and replace
uses of FromHex with decode_to_vec and decode_to_array.

p2p: Introduce hex stable and remove unecessary uses of hex_unstable

While the p2p crate doesn't directly expose unstable hex errors, it has
various uses of the unstable hex crate where the stable hex crate would
be sufficient.

Introduce hex_conservative 1.0.0 as a dependency for p2p and replace
uses of FromHex with decode_to_vec and decode_to_array.

Add missing license comment

Add missing doc inline

consensus_encoding: Introduce decode_from_slice_unbounded

The old consensus code deserialize function returned an error when
decoding failed to consume all bytes in the input slice. The new
nearest-equivalent function, decode_from_slice, does not error on
unconsumed bytes.

Introduce decode_from_slice_unbounded which errors on unconsumed bytes.
Adjust decode_from_slice to error on unconsumed bytes.
Introduce DecodeError type to specify decoder vs unconsumed bytes
errors for decode_from_slice.

p2p: add serde impls for FilterHash and FilterHeader

p2p: update lock files for serde dependency

Add serde support for Vec<(Signed)Amount>

Expand the serde module to also support Vec<Amount> and
Vec<SignedAmount>.

Add tests of the Vec serialization and
deserialization.