milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve rustdocs on addresses module 

These docs are stale, update them.

- Mention segwit and legacy
- Improve example code to show feature gating
- Fix headings to be as typical
This commit is contained in:
Tobin C. Harding 2024-12-12 10:15:54 +11:00
parent ea6bf12a64
commit f85456a726
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
bitcoin/src/address/mod.rs
View File

@ -2,28 +2,25 @@
//! Bitcoin addresses.
//!
//! Support for ordinary base58 Bitcoin addresses and private keys.
//! Support for segwit and legacy addresses (bech32 and base58 respectively).
//!
//! # Example: creating a new address from a randomly-generated key pair
//! # Examples
//!
//! ### Creating a new address from a randomly-generated key pair.
//!
//! ```rust
//! # #[cfg(feature = "rand-std")] {
//! use bitcoin::{Address, PublicKey, Network};
//! #[cfg(feature = "rand-std")] {
//! use bitcoin::secp256k1::{rand, Secp256k1};
//! use bitcoin::{Address, Network, PublicKey};
//!
//! // Generate random key pair.
//! let s = Secp256k1::new();
//! let public_key = PublicKey::new(s.generate_keypair(&mut rand::thread_rng()).1);
//! let secp = Secp256k1::new();
//! let (_sk, pk) = secp.generate_keypair(&mut rand::thread_rng());
//! let public_key = PublicKey::new(pk); // Or `PublicKey::from(pk)`.
//!
//! // Generate pay-to-pubkey-hash address.
//! // Generate a mainnet pay-to-pubkey-hash address.
//! let address = Address::p2pkh(&public_key, Network::Bitcoin);
//! # }
//! ```
//!
//! # Note: creating a new address requires the rand-std feature flag
//!
//! ```toml
//! bitcoin = { version = "...", features = ["rand-std"] }
//! }
//! ```
pub mod error;