Commit Graph

2359 Commits

Author SHA1 Message Date
Andrew Poelstra cc5b6ef53a
Merge rust-bitcoin/rust-bitcoin#1163: Remove old deprecated code
dfb8ef97dc Remove deprecated MerkleBlock methods (Tobin C. Harding)
b171f88bc3 Remove deprecated SighashComponents struct (Tobin C. Harding)
c2bbf7c343 Use SighashCache instead of SigHashCache (Tobin C. Harding)
1c04a99ec3 Use sighash::SighashCache for bip143 unit tests (Tobin C. Harding)
f65e034742 Refactor test module imports (Tobin C. Harding)

Pull request description:

  I'm not sure what the exact policy we decided on for deprecating is but we have code deprecated since v0.24.0 and v.026.2, both of these seem reasonable safe to remove.

  Removal of `SighashCompontents` uncovered the fact that we never moved the BIP 143 test vector code over to the new `SighashCache`.

  - Patch 1: Trivial preparatory cleanup
  - Patch 2: Re-write bip143 test vectors using `sighash::SighashCache`
  - Patch 3: Trivial, use `SighashCache` instead of `SigHashCache`
  - Patch 4: Remove `SighashComponents` struct deprecated in 0.24.0
  - Patch 5: Remove `MerkleBlock` methods deprecated in 0.26.2

ACKs for top commit:
  apoelstra:
    ACK dfb8ef97dc
  sanket1729:
    ACK dfb8ef97dc

Tree-SHA512: 493525859a131307fbe3ea17f8edb70045dc56526d5579a4fc0d6e7c3fded58c890304721502d1cfceed0a61f4b3d1827a60760e42af0114f3b3ba29b136238c
2022-08-11 13:24:20 +00:00
Andrew Poelstra 0afe5f849d
Merge rust-bitcoin/rust-bitcoin#1166: Deprecate `Transaction`'s `signature_hash`/`encode_signing_data_to` methods
c062e4ff80 Deprecate legacy sighash methods (Tobin C. Harding)
1fdf5f9b82 Move legacy sighash unit test data to test_data (Tobin C. Harding)
6fa0329930 Re-order import statements (Tobin C. Harding)

Pull request description:

  When we introduced the `SighashCache` we put encoding and sighash code
  for segwit (v0 and taproo) in the `sighash` module. We also added
  methods for legacy inputs that wrapped calls to encode/sighash methods
  in the `transaction` module. This is confusing for a couple of reasons

  - When devs read `Transaction` there are two methods that apparently
  enable encodeing tx data and calculating the sighash but there is no
  indication that these methods are only for legacy inputs.

  - Once devs work out that segwit inputs have to be handled by methods on
  the `SighashCache` it is not obvious why the methods on `Transaction`
  exist at all.

  Move the legacy encode/sighash code over to the `sighash` module and
  deprecate the old methods. (Includes moving unit tests.)

  Patch 1 and 2 are preparation.

  (I did this work because I got lost in `Transaction::signature_hash` when messing with `TxOut::Amount` and trying to understand the signing algorithm vs bip143.

  sanket1729 is there some other reason that I'm missing why we left the legacy code in `transaction`?

ACKs for top commit:
  sanket1729:
    ACK c062e4ff80
  apoelstra:
    ACK c062e4ff80

Tree-SHA512: b94de928e64e652ec75e34af94d5d161f5c52a862b5b10904e980b8ae669b3b434f8639d5ddadad84a7bbdf36ac21bdd287398448e844b5bb531c3664e91fb02
2022-08-11 13:17:30 +00:00
Andrew Poelstra d29f81ad25
Merge rust-bitcoin/rust-bitcoin#1180: Clean up bip158 module
167ee8e72c Improve docs on bip158 module (Tobin C. Harding)
5cfe9169f5 Refactor tests module imports (Tobin C. Harding)
2447d96b44 Use Gcs instead of GCS (Tobin C. Harding)
e9846ad579 Improve docs on filter_header (Tobin C. Harding)
e0fddce9e9 Refactor new_script_filter (Tobin C. Harding)
f6105a16a7 Improve module docs (Tobin C. Harding)
25d1472924 Move new to top of impl block (Tobin C. Harding)
08e55bc4f1 Remove unneeded newlines (Tobin C. Harding)
28853fd3cc Use generics instead of dynamic dispatch (Tobin C. Harding)
d79c6b8358 Remove unnecessary use of Cursor (Tobin C. Harding)

Pull request description:

  In attempt to resolve #1147 clean up the `bip158` module.

  I was unable to resolve the `"confusing method names read and write that look like those from std:i:o::{trait}"`

  I find the `bip158` data types and abstractions kind a funky but was unable to come up with any improvements.

  Open question: Are all the public data types really meant to be public? Perhaps we should have an issue to write an example module that uses the bip158 module?

ACKs for top commit:
  sanket1729:
    ACK 167ee8e72c
  apoelstra:
    ACK 167ee8e72c

Tree-SHA512: 7caa661432f02d90cf32c13b54a635647b871bb1564d1df67957b6422465880fcfca8f74d51d4b0255dc34306a56cd866366febabc9a27ecdc00a2d1e6a21d5a
2022-08-11 13:05:17 +00:00
Martin Habovstiak 94eeabfd6c Remove accidentally-exported internal macros
Closes #1176
2022-08-11 11:10:56 +02:00
Tobin C. Harding c062e4ff80 Deprecate legacy sighash methods
When we introduced the `SighashCache` we put encoding and sighash code
for segwit (v0 and taproo) in the `sighash` module. We also added
methods for legacy inputs that wrapped calls to encode/sighash methods
in the `transaction` module. This is confusing for a couple of reasons

- When devs read `Transaction` there are two methods that apparently
enable encodeing tx data and calculating the sighash but there is no
indication that these methods are only for legacy inputs.

- Ocne devs work out that segwit inputs have to be handled by methods on
the `SighashCache` it is not obvious why the methods on `Transaction`
exist at all.

Move the legacy encode/sighash code over to the `sighash` module and
deprecate the old methods. (Includes moving unit tests.)
2022-08-11 08:54:48 +10:00
Tobin C. Harding 1fdf5f9b82 Move legacy sighash unit test data to test_data
The legacy sighash test data is massive, move it to a file instead of
inline in the unit tests.
2022-08-11 08:54:48 +10:00
Tobin C. Harding 6fa0329930 Re-order import statements
In preparation for adding imports; do a trivial refactor to clean up the
import statements.

Refactor only, no logic changes.
2022-08-11 08:54:48 +10:00
Tobin C. Harding 167ee8e72c Improve docs on bip158 module
Make an effort to improve the rustdocs throughout the `bip158` module.
2022-08-11 08:42:43 +10:00
Tobin C. Harding 5cfe9169f5 Refactor tests module imports
Refactor the import statements for the bip158 tests module. Includes
removing `extern crate` which is unnecessary now we have edition 2018.
2022-08-11 08:42:43 +10:00
Tobin C. Harding 2447d96b44 Use Gcs instead of GCS
Rust convention stipulates that acronyms are in snake case not all caps.
We should use `Gcs` for Golomb Coded Sets
2022-08-11 08:42:43 +10:00
Tobin C. Harding e9846ad579 Improve docs on filter_header 2022-08-11 08:42:43 +10:00
Tobin C. Harding e0fddce9e9 Refactor new_script_filter
Refactor the `new_script_filter` by doing:

- Put it directly below the `new` constructor
- Improve docs
- Remove unneeded scope
- Correctly indent `where` keyword
2022-08-11 08:42:43 +10:00
Tobin C. Harding f6105a16a7 Improve module docs
Improve the module rustdocs for `bip158` by doing:

- Add bip references
- Use correct markdown headings
- Use caps in title
2022-08-11 08:42:43 +10:00
Tobin C. Harding 25d1472924 Move new to top of impl block
To ease reading, put the `new` method at the top of the impl block.
Improve rustdocs while we do it.
2022-08-11 08:42:43 +10:00
Tobin C. Harding 08e55bc4f1 Remove unneeded newlines
Conventionally we only put a single newline between types, impl blocks,
and functions.
2022-08-11 08:42:43 +10:00
Tobin C. Harding 28853fd3cc Use generics instead of dynamic dispatch
Currently in the `bip158` module we do a bunch of dynamic dispatch using
the reader/writer objects. We can improve runtime performance, at the
cost of compile time, by using generics instead of dynamic dispatch.
2022-08-11 08:42:43 +10:00
Tobin C. Harding d79c6b8358 Remove unnecessary use of Cursor
The function `match_all` takes an iterator, it does not need to use the
`Seek` trait, we can just pass in the content as a slice, no need to
wrap it in a `Cursor`.
2022-08-11 08:42:43 +10:00
Andrew Poelstra 9a606fc68a
Merge rust-bitcoin/rust-bitcoin#1178: Pin `serde` to 1.0.142
7a28a56ac4 Pin `serde` to 1.0.142 (Martin Habovstiak)

Pull request description:

  1.0.143 bumps MSRV higher than what we support.

  Closes #1175

  Unfortunately I have to go now, will try to get back ASAP.

ACKs for top commit:
  apoelstra:
    ACK 7a28a56ac4
  tcharding:
    ACK 7a28a56ac4

Tree-SHA512: 09546984d3d68c24068cb357e4a57db223cea6b48e32471fab551998d8afe46eeaac2e6a49ec3d8bf2cc9767b564f12ccd6022ef8167d8e5eefdc6c898f3077a
2022-08-10 21:43:13 +00:00
Martin Habovstiak 7a28a56ac4 Pin `serde` to 1.0.142
1.0.143 bumps MSRV higher than what we support.
2022-08-09 15:59:27 +02:00
Andrew Poelstra 8a30169d36
Merge rust-bitcoin/rust-bitcoin#1109: Release tracking PR - v0.29.0
110b5d8963 Bump version to v0.29.0 (Tobin C. Harding)

Pull request description:

  Add changelog notes and bump the version number to v0.29.0.

  ## Notes

  I attempted to go through all the PRs since last release, please sing out if you had a PR merged that is not mentioned and you would like it mentioned.

  The changelog notes can be changed or improved, please do not take me writing them to imply I know exactly what goes on round here - I just made an effort to save others having to do it.

  ## TODO
  - [x]  merge all 'required' PRs
    - https://github.com/rust-bitcoin/rust-bitcoin/pull/1131
    - #1137
    - https://github.com/rust-bitcoin/rust-bitcoin/pull/1129
    - https://github.com/rust-bitcoin/rust-bitcoin/pull/1151
    - https://github.com/rust-bitcoin/rust-bitcoin/pull/1165 (add release notes still)
  - [x] Ensure all green from the CI run on: https://github.com/rust-bitcoin/rust-miniscript/pull/450
  - [ ] Carry out (and improve) the https://github.com/rust-bitcoin/rust-bitcoin/discussions/1106

ACKs for top commit:
  tcharding:
    ACK 110b5d8963
  Kixunil:
    ACK 110b5d8963
  apoelstra:
    ACK 110b5d8963
  sanket1729:
    reACK 110b5d8963

Tree-SHA512: d00c70534476794c01cd694ea9a23affef947c4f913b14344405272bc99cc00763f1ac755cc677e7afbd3dbef573d786251c9093d5dbafd76ee0cf86ca3b0ebd
2022-08-08 18:32:46 +00:00
Andrew Poelstra 995c83c38c
Merge rust-bitcoin/rust-bitcoin#1171: Remove `MAX_SEQUENCE` constant
b6c5fc3622 Remove MAX_SEQUENCE const (Tobin C. Harding)

Pull request description:

  This is follow up work to the recent addition of the `Sequence` type. We
  do not need to keep a public integer const for `MAX_SEQUENCE` because we
  offer the `Sequenc::MAX` associated type.

  Use the all-bits-set u64 directly in the associated type `Sequence::MAX`.

  cc nlanson

ACKs for top commit:
  Kixunil:
    ACK b6c5fc3622
  apoelstra:
    ACK b6c5fc3622

Tree-SHA512: c0acacc25d7cb2f8774e8c6dee8acb3faca0bf6cbd657054ea7262f26b4dfe8baaf2066662966dc507d26716c0468c97d09c590deec48ecd9d11a415ab2bf9ff
2022-08-05 14:40:46 +00:00
Tobin C. Harding b6c5fc3622 Remove MAX_SEQUENCE const
This is follow up work to the recent addition of the `Sequence` type. We
do not need to keep a public integer const for `MAX_SEQUENCE` because we
offer the `Sequenc::MAX` associated type.

Use the all-bits-set u64 directly in the associated type `Sequence::MAX`.
2022-08-05 13:53:37 +10:00
Tobin C. Harding 613f1cf2d5 Implement std::error::Error::source for bip152
During the recent merge of bip152 we ended up with a Rust 1.29 version
of the `error::Error`.

Implement `source` inline with our new MSRV.
2022-08-05 11:19:37 +10:00
Tobin C. Harding a37ab82503 Add non_exhaustive to _all_ errors
We are no using `non_exhaustive` on any error types unless we are
_really_ sure there will be no additional variants required.

There are only three error enums that do not have it in the codebase as
of this commit, add it to all three.
2022-08-05 11:19:37 +10:00
Tobin C. Harding 110b5d8963 Bump version to v0.29.0
Add changelog notes and bump the version number to v0.29.0.
2022-08-05 11:14:41 +10:00
sanket1729 9bac1a0b8b
Merge rust-bitcoin/rust-bitcoin#1165: Update bitcoinconsensus dependency
7f554774a3 Update bitcoinconsensus dependency (Tobin C. Harding)

Pull request description:

  We recently released a couple of new versions of
  `rust-bitcoinconsensus`, the first was mainly to move to git subtree,
  included in this release was a bump of the patch version of bitcoin
  core. The next release updated bitcoin core major version to 0.20.2

  Update our bitcoinconsensus dependency to `0.20.2-0.5.0`.

ACKs for top commit:
  apoelstra:
    ACK 7f554774a3
  sanket1729:
    utACK 7f554774a3

Tree-SHA512: e30857846e6dcf237e6c87ea5cce81f091104772ce3293c8b7193f253aab3176627466ca41fc3764c949edb4f6c4ae5dc00968d71a4492e19a8a1a1e9dba7013
2022-08-04 16:26:14 -07:00
Tobin C. Harding 7f554774a3 Update bitcoinconsensus dependency
We recently released a couple of new versions of
`rust-bitcoinconsensus`, the first was mainly to move to git subtree,
included in this release was a bump of the patch version of bitcoin
core. The next release updated bitcoin core major version to 0.20.2

Update our bitcoinconsensus dependency to `0.20.2-0.5.0`.
2022-08-04 08:21:41 +10:00
Tobin C. Harding dfb8ef97dc Remove deprecated MerkleBlock methods
We have two methods that have been deprecated since 0.26.2,  we can
safely remove them now.
2022-08-03 12:34:51 +10:00
Tobin C. Harding b171f88bc3 Remove deprecated SighashComponents struct
This struct was deprecated in v0.24.0, we can safely remove it now.
2022-08-03 12:34:50 +10:00
Tobin C. Harding c2bbf7c343 Use SighashCache instead of SigHashCache
The `bip143::SigHashCache` is deprecated in favour of
`sighash::SighashCache` however we still use it in `bip143` unit tests.

Use the new `sighash::SighashCache` in `bip143` unit tests.
2022-08-03 12:30:20 +10:00
Tobin C. Harding 1c04a99ec3 Use sighash::SighashCache for bip143 unit tests
We have a bunch of unit tests that verify the BIP 143 test vectors.
Three of these use the deprecated `SighashComponents` struct. We should
implement these tests using the new `SighashCache`. In order to do so we
have to move the tests to the `sighash` module so they can get access to
the private `segwit_cache()` function, and verify the cache internal
state against the test vectors.

Re-write the BIP 143 test vector code using `SighashCache` and remove
the versions using `SighashComponents`.

Done in preparation for removing the deprecated `SighashComponents`.
2022-08-03 12:22:31 +10:00
Tobin C. Harding f65e034742 Refactor test module imports
In preparation for adding unit tests to the `sighash` module clean up
the import statements.

Refactor only, no logic changes.
2022-08-03 11:56:27 +10:00
Andrew Poelstra 5d44b2dda6
Merge rust-bitcoin/rust-bitcoin#1161: Fix public API clippy warnings
5cef2f1a8f Remove stutter for error variants (Tobin C. Harding)
08c4a2204a Allow wrong_self_convention for non-Copy type (Tobin C. Harding)
0786d92a5c Take self by value (Tobin C. Harding)

Pull request description:

  [Turns out](https://github.com/rust-lang/rust-clippy/issues/9248) by default clippy does not lint certain parts of the public API.

  Specifically, by setting `avoid-breaking-exported-api = false` we can get clippy to lint the public API for various things including
  `wrong_self_convention`.

  This means the saga of to/into/as continues ... we have used the wrong from for many of our `to_*` methods, they should consme `self`. Patch 1 fixes them. Patch 2 adds an `allow`. Patch 3 fixes a few error enum variant identifiers (removes `Error` suffix).

ACKs for top commit:
  Kixunil:
    ACK 5cef2f1a8f
  sanket1729:
    code review ACK 5cef2f1a8f
  apoelstra:
    ACK 5cef2f1a8f

Tree-SHA512: f1cdb94764a132a7c58f3e97a208f3f8d618e4f2620753d0394590b19d3dab0df7669e187f6e0a3d0aa358a7d8aee5495f78008f244b6eedb33715ff1df151b1
2022-08-02 14:37:58 +00:00
Tobin C. Harding 5cef2f1a8f Remove stutter for error variants
Error variants should not end with the same identifier as the enum,
i.e., they should not stutter.

Found by clippy after setting:

  avoid-breaking-exported-api = false
2022-08-02 08:55:00 +10:00
Tobin C. Harding 08c4a2204a Allow wrong_self_convention for non-Copy type
Clippy gives a warning about `wrong_self_convention` because we consume
self in a method called `is_*`. We have to consume self because the
object has a generic `E` (error type) that does not implement `Copy`.
2022-08-02 08:54:54 +10:00
Tobin C. Harding 0786d92a5c Take self by value
Turns out by default clippy does not lint certain parts of the public
API. Specifically, by setting

  avoid-breaking-exported-api = false

we can get clippy to lint the public API for various things including
`wrong_self_convention`.

Clippy emits:

 warning: methods with the following characteristics: (`to_*` and `self`
 type is `Copy`) usually take `self` by value

As suggested, take `self` by value for methods named `to_*`.
2022-08-02 08:54:53 +10:00
Andrew Poelstra ef5014f3e8
Merge rust-bitcoin/rust-bitcoin#1144: Remove deprecated `StreamReader`
0c9c14128b Remove deprecated `StreamReader` (Martin Habovstiak)

Pull request description:

  `StreamReader` was deprecated for a while, yet we needlessly maintain it
  and it eats our testing time. This change removes it completely.

  Closes #1123

ACKs for top commit:
  tcharding:
    ACK 0c9c14128b (with the function rename).
  sanket1729:
    utACK 0c9c14128b.
  apoelstra:
    ACK 0c9c14128b

Tree-SHA512: 3f10c48081f92c02bc5a9f3187df1d9279451a79eb2776b10b3e4c4dc5370a9816b3eb5f04b6e1ede61dfe13c1844d606ba00b00a2bfc6a56aefda900cd9ccc2
2022-08-01 19:20:19 +00:00
sanket1729 bb4396266a
Merge rust-bitcoin/rust-bitcoin#1151: Update finalize API
870ad59a5e Rename is_finalized to is_finalizable (sanket1729)
aaadd25ddc Add breaking test that allowed incomplete builders to be created (sanket1729)
0b88051318 Update TaprootBuilder::finalize (sanket1729)
5813ec7ac0 Return EmptyTree instead of OverCompleteTree when there are no scripts to add (sanket1729)

Pull request description:

  Found while reviewing https://github.com/rust-bitcoin/rust-miniscript/pull/450/ . There is also a BUG fix in the second commit that would have let users spendinfo from incomplete trees.

  The bug was introduced in #936 which I am responsible for ACKing

ACKs for top commit:
  apoelstra:
    ACK 870ad59a5e
  Kixunil:
    ACK 870ad59a5e
  tcharding:
    ACK 870ad59a5e

Tree-SHA512: 61442bd95df6912865cbecdc207f330b241e7fbb88b5e915243b2b48a756bea9eb29cb28d8c8249647a0a2ac514df4737bddab695f63075bd55284be5be228ff
2022-08-01 00:51:35 -07:00
Martin Habovstiak 0c9c14128b Remove deprecated `StreamReader`
`StreamReader` was deprecated for a while, yet we needlessly maintain it
and it eats our testing time. This change removes it completely.

Closes #1123
2022-07-30 14:59:42 +02:00
sanket1729 870ad59a5e Rename is_finalized to is_finalizable
I really liked the is_complete naming, but that was changed earlier in b0f3992db1
Was also suggested by Andrew https://github.com/rust-bitcoin/rust-bitcoin/pull/929#discussion_r850631207
2022-07-29 13:04:37 -07:00
sanket1729 aaadd25ddc Add breaking test that allowed incomplete builders to be created 2022-07-29 13:04:37 -07:00
sanket1729 0b88051318 Update TaprootBuilder::finalize
This commit does two things:
1) BUG FIX: We should have checked that the length of the branch is 1
before computing the spend_info on it. This was introduced in #936, but
slipped past my review :(
2) Update the return type to return the consumed `self` value. This
function can only error when there the tree building is not complete.
Returning TaprootBuilderError causes issues in downstream projects that
need to deal with error cases which cannot happen in this function
2022-07-29 13:04:37 -07:00
Andrew Poelstra f54fe69c8d
Merge rust-bitcoin/rust-bitcoin#1137: Impl string conversion traits for `CommandString`
405be52f5c Impl string conversion traits for `CommandString` (Martin Habovstiak)

Pull request description:

  After MSRV bump `try_from` usually refers to `TryFrom` method but
  `CommandString` used inherent one making it confusing and non-idiomatic.

  This implements `FromStr` and `TryFrom<{stringly type}>` for
  `CommandString` and deprecates the inherent method in favor of those.
  To keep the code using `&'static str` efficient it provides
  `try_from_static` inherent method that only converts from
  `&'static str`.

  Closes #1135

ACKs for top commit:
  sanket1729:
    utACK 405be52f5c
  tcharding:
    ACK 405be52f5c

Tree-SHA512: 754fc960a4bc5c096cccf47b85a620e33fcf863f3c57ea113eae91cd34006168113dd1efc47231e79e6e237e2fc412890cc9e8a72d4cfc633bfebbecdc4610e6
2022-07-29 14:03:00 +00:00
Andrew Poelstra 0b02e43da9
Merge rust-bitcoin/rust-bitcoin#1146: Remove needless allocation from BIP-158 encoding
1003ca08e1 Remove needless allocation from BIP-158 encoding (Martin Habovstiak)

Pull request description:

  The BIP-158 finalize code was serializing value to `Vec` only to
  serialize it to writer right away. Thus the intermediary `Vec` was not
  needed.

  Even more, the code used `write` which, while correct in case of `Vec`,
  could trigger code analysis tools or reviewers.

ACKs for top commit:
  tcharding:
    ACK 1003ca08e1
  sanket1729:
    ACK 1003ca08e1
  apoelstra:
    ACK 1003ca08e1

Tree-SHA512: 01e198726f45ef1b0e4bbe80154674d9db12350281e682531259d1d6467881bc7503cfed30d3837813437c3081a35ba7893c3ae4490d07daf20f1b75dbc62d52
2022-07-29 13:29:34 +00:00
sanket1729 5813ec7ac0 Return EmptyTree instead of OverCompleteTree when there are no scripts
to add
2022-07-28 17:19:10 -07:00
Martin Habovstiak 1003ca08e1 Remove needless allocation from BIP-158 encoding
The BIP-158 finalize code was serializing value to `Vec` only to
serialize it to writer right away. Thus the intermediary `Vec` was not
needed.

Even more, the code used `write` which, while correct in case of `Vec`,
could trigger code analysis tools or reviewers.
2022-07-28 23:02:06 +02:00
Martin Habovstiak 405be52f5c Impl string conversion traits for `CommandString`
After MSRV bump `try_from` usually refers to `TryFrom` method but
`CommandString` used inherent one making it confusing and non-idiomatic.

This implements `FromStr` and `TryFrom<{stringly type}>` for
`CommandString` and deprecates the inherent method in favor of those.
To keep the code using `&'static str` efficient it provides
`try_from_static` inherent method that only converts from
`&'static str`.

Closes #1135
2022-07-28 15:24:49 +02:00
Andrew Poelstra ed3fb45c9a
Merge rust-bitcoin/rust-bitcoin#1129: Parse int error
071a1c02b7 Implement string parsing for `Sequence` (Martin Habovstiak)
c39bc3909d Extend `ParseIntError` to carry more context (Martin Habovstiak)

Pull request description:

  When debugging parsing errors it's very useful to know some context:
  what the input was and what integer type was parsed. `ParseIntError`
  from `core` doesn't contain this information.

  In this commit a custom `ParseIntError` type is crated that carries the
  one from `core` as well as additional information. Its `Display`
  implementation displays this additional information as a well-formed
  English sentence to aid users with understanding the problem. A helper
  function parses any integer type from common string types returning the
  new `ParseIntError` type on error.

  To clean up the error code a bit some new macros are added and used.
  New modules are added to organize the types, functions and macros.

  Closes #1113

  Depends on #994

ACKs for top commit:
  apoelstra:
    ACK 071a1c02b7
  tcharding:
    ACK 071a1c02b7

Tree-SHA512: 31cb84b9e4d5fe3bdeb1cd48b85da2cbe9b9d17d93d029c2f95e0eed5b8842d7a553afafcf8b4a87c075aa53cf0274776e893bed6dca37e7dbc2e1ee1d602b8e
2022-07-28 13:04:13 +00:00
Tobin C. Harding 34f955a073 Introduce new canonical license blurb
Recently we introduced SPDX license ids but there was some confusion
about the use, form, and purpose of lines before (library name, author).

It was pointed out to me by Andrew that if/when folks cut'n'paste our
code they often will keep the whole blurb. Design it with that in
mind. FTR, Andrew also indicated that he did not mind his name being
removed in favour of "The rust-bitcoin developers".

At first I thought the term "The rust-bitcoin developers" was a bit
wishy-washy but yesterday I realised that I am proud to be part of that
crew, striving to deliver code to the highest possible standard.

Introduce a canonical format for the licences blurb.

- Use the name of the library
- Use "The rust-bitcoin developers"
- Use the SPDX ID
2022-07-28 08:18:01 +10:00
Andrew Poelstra a550fa8fbf
Merge rust-bitcoin/rust-bitcoin#1131: Upgrade bech32 to version 0.9.0
c67f74bb81 Upgrade bech32 to version 0.9.0 (Tobin C. Harding)

Pull request description:

  Recently `rust-bech32` v0.9.0 was released, this release included
  updating the MSRV to 1.41.1.

ACKs for top commit:
  apoelstra:
    ACK c67f74bb81
  Kixunil:
    ACK c67f74bb81

Tree-SHA512: 59aac2f40e0bc8c63a7549a988ff7cdc114ca7768421c7926cc6badbaa1d4f9de0c5cf41d987e4f5124a5c9042650e722cf5fbd892e91d0232ac175122eb042d
2022-07-27 21:28:38 +00:00