rust-bitcoin / rust-bitcoin / 14755418885

83%

Build Type

push

github

Committed by apoelstra

Commit Message

Merge rust-bitcoin/rust-bitcoin#4387: bip32: overhaul error types and add a "maximum depth exceeded" error

b9a12043b bip32: return error when trying to derive a path too deep (Andrew Poelstra)
73781e047 bip32: rename Error to ParseError (Andrew Poelstra)
a66ad97fb bip32: split InvalidChildNumber and InvalidChildNumberFormat out of error (Andrew Poelstra)
a891fb9b7 bip32: remove unused error variants (Andrew Poelstra)
f0a237c00 bip32: split out DerivationError from the main error enum (Andrew Poelstra)
32d96f6c3 bip32: make Xpriv::new_master be infallible (Andrew Poelstra)
0e5e021b6 bip32: change several cryptographically unreachable paths to expects (Andrew Poelstra)

Pull request description:

  This PR makes a first pass at splitting the `bip32::Error` type into multiple distinct types -- one for derivation (which can fail if you try to derive a hardened child of an xpub, or if you try to derive too many layers), one for parsing child numbers or derivation paths, and one for parsing xkeys. Along the way it cleans up a ton of weird things and typos, e.g. the psbt `GetKeyError` having an unused `Bip32` variant whose display text references "bip 23".

  Because all the error types get renamed, every part of this PR is an API break, but only the last commit is a "real" API break which uses the new `DerivationError::MaximumDepthExceeded` error variant to return an error when trying to derive a path of length 256 or longer. This means that `Xpriv::derive_xpriv` again returns an error result.

  I will make a simpler version of this last commit suitable for backporting to 0.32.x. (In 0.32.x `Xpriv::derive_priv` returns an error, so we can change it to error out on max-depth-exceeded without breaking the API. Sadly most users are likely to be ... (continued)

Coverage Stats

80 of 111 new or added lines in 2 files covered. (72.07%)

2 existing lines in 1 file now uncovered.

22873 of 27169 relevant lines covered (84.19%)

16479.84 hits per line