rust-bitcoin / rust-bitcoin / 8726217744

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2692: Add docs for custom signets

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/30a09670e8a53cb74bf5a40f83cecfcc74d94d36">30a09670e Add docs for custom signets (Tobin C. Harding)

Pull request description:

  We have started using `AsRef<Params>` in a few places as a function parameter. If a user of the library wishes to use these functions they need to create a type that can implement this trait. Because we use `non_exhaustive` on the `Params` struct it is not possible to just construct a `Params` type. This may be surprising for some folk.

  Add module level docs to the `consensus::params` module with an example of how to create a type that can be used to describe a custom signet network. Use fields inspired by Mutiny Wallet's described usage.

  Close: #2690

ACKs for top commit:
  sanket1729:
    ACK 30a09670e8a53cb74bf5a40f83cecfcc74d94d36.
  apoelstra:
    ACK 30a09670e8a53cb74bf5a40f83cecfcc74d94d36 this is great; would like to see more `const` but for example code no big deal

Tree-SHA512: 50881763a20742944e6f114ff5f75d1eeeb

19195 of 23090 relevant lines covered (83.13%)

16808.98 hits per line