rust-bitcoin-unsafe-fast/bitcoin/src
Tobin C. Harding 30a09670e8
Add docs for custom signets
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
2024-04-17 10:35:32 +10:00
..
address 2024-04-07 automated rustfmt nightly 2024-04-07 01:03:23 +00:00
blockdata Improve deprecation notice 2024-04-10 11:05:05 +10:00
consensus Add docs for custom signets 2024-04-17 10:35:32 +10:00
crypto Upgrade secp dependency 2024-04-03 09:24:41 +11:00
merkle_tree 2024-03-31 automated rustfmt nightly 2024-03-31 01:03:18 +00:00
p2p 2024-04-07 automated rustfmt nightly 2024-04-07 01:03:23 +00:00
psbt psbt: Return the internal key for key path spend 2024-04-04 07:36:04 +11:00
taproot 2024-03-31 automated rustfmt nightly 2024-03-31 01:03:18 +00:00
bip32.rs Allow m prefix in derivation paths 2024-04-11 07:23:30 +10:00
bip152.rs Merge rust-bitcoin/rust-bitcoin#2667: Remove deprecated legacy numeric methods 2024-04-07 15:15:47 +00:00
bip158.rs Implement infallible for errors 2024-03-08 16:48:34 +11:00
error.rs Do infallible int from hex conversions 2024-02-27 10:40:52 +11:00
hash_types.rs 2024-03-31 automated rustfmt nightly 2024-03-31 01:03:18 +00:00
internal_macros.rs 2024-03-31 automated rustfmt nightly 2024-03-31 01:03:18 +00:00
lib.rs Minimize usage of Network in public API 2024-04-03 13:32:39 +11:00
network.rs Minimize usage of Network in public API 2024-04-03 13:32:39 +11:00
policy.rs bitcoin: Remove attribution from all files 2023-05-01 09:22:48 +10:00
pow.rs 2024-04-07 automated rustfmt nightly 2024-04-07 01:03:23 +00:00
serde_utils.rs Fix new nightly warnings/errors 2024-02-21 14:13:49 +11:00
sign_message.rs Implement infallible for errors 2024-03-08 16:48:34 +11:00
test_macros.rs bitcoin: Remove attribution from all files 2023-05-01 09:22:48 +10:00