rust-bitcoin-unsafe-fast/bitcoin
Andrew Poelstra 7a8dafb748
Merge rust-bitcoin/rust-bitcoin#2692: Add docs for custom signets
30a09670e8 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 30a09670e8.
  apoelstra:
    ACK 30a09670e8 this is great; would like to see more `const` but for example code no big deal

Tree-SHA512: 50881763aea99641e24871b0eae60650174c48f620742944e7d5617fcf1edff73a20b2a8f043433f6f114ff5f3f4691703fc37b28880c305bb052c2d75d1eeeb
2024-04-17 17:31:03 +00:00
..
contrib ci: delete *test.sh files 2024-02-28 20:45:56 +00:00
embedded base58: Re-name crate to base58ck 2024-03-19 09:00:46 +11:00
examples Allow m prefix in derivation paths 2024-04-11 07:23:30 +10:00
src Merge rust-bitcoin/rust-bitcoin#2692: Add docs for custom signets 2024-04-17 17:31:03 +00:00
tests Allow m prefix in derivation paths 2024-04-11 07:23:30 +10:00
CHANGELOG.md bitcoin: Bump version to 0.32.0-rc1 2024-04-05 08:10:08 +11:00
Cargo.toml bitcoin: Bump version to 0.32.0-rc1 2024-04-05 08:10:08 +11:00
build.rs Bump MSRV to Rust version 1.56.1 2023-11-23 06:20:02 +11:00