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

Merge rust-bitcoin/rust-bitcoin#3588: Reword `Address` constructor docs 

8098d5ee05 Reword `Address` constructor docs (Jamil Lambert, PhD)

Pull request description:

  Change the wording of the Address constructor function docs to be a standard format. Following up on [#3584 comment](https://github.com/rust-bitcoin/rust-bitcoin/pull/3584#issuecomment-2457197066)

ACKs for top commit:
  apoelstra:
    ACK 8098d5ee055d672fc8f6e4eef3971b66478a61b0; successfully ran local tests
  tcharding:
    ACK 8098d5ee05

Tree-SHA512: 1027f334d69182465b2ecafd6fcf9f5deb2b299a64d12dea7f09f25379bd98b1e11be52a04fea83c2194164fd428931f6416eee52603f4bc043717b4e4d1b193
This commit is contained in:
merge-script 2024-11-08 15:25:27 +00:00
parent 0667a67b7c 8098d5ee05
commit 9d9f1d84e4
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -202,7 +202,7 @@ pub enum KnownHrp {
} }
impl KnownHrp { impl KnownHrp {
/// Constructs a new `KnownHrp` from `network`. /// Constructs a new [`KnownHrp`] from [`Network`].
fn from_network(network: Network) -> Self { fn from_network(network: Network) -> Self {
use Network::*; use Network::*;
@ -213,7 +213,7 @@ impl KnownHrp {
} }
} }
/// Constructs a new `KnownHrp` from a [`bech32::Hrp`]. /// Constructs a new [`KnownHrp`] from a [`bech32::Hrp`].
fn from_hrp(hrp: Hrp) -> Result<Self, UnknownHrpError> { fn from_hrp(hrp: Hrp) -> Result<Self, UnknownHrpError> {
if hrp == bech32::hrp::BC { if hrp == bech32::hrp::BC {
Ok(Self::Mainnet) Ok(Self::Mainnet)
@ -387,7 +387,7 @@ impl<V: NetworkValidation> Address<V> {
/// Methods and functions that can be called only on `Address<NetworkChecked>`. /// Methods and functions that can be called only on `Address<NetworkChecked>`.
impl Address { impl Address {
/// Constructs a new pay to (compressed) public key hash address from a public key. /// Constructs a new pay-to-public-key-hash (P2PKH) [`Address`] from a public key.
/// ///
/// This is the preferred non-witness type address. /// This is the preferred non-witness type address.
#[inline] #[inline]
@ -396,7 +396,7 @@ impl Address {
Self(AddressInner::P2pkh { hash, network: network.into() }, PhantomData) Self(AddressInner::P2pkh { hash, network: network.into() }, PhantomData)
} }
/// Constructs a new pay to script hash P2SH address from a script. /// Constructs a new pay-to-script-hash (P2SH) [`Address`] from a script.
/// ///
/// This address type was introduced with BIP16 and is the popular type to implement multi-sig /// This address type was introduced with BIP16 and is the popular type to implement multi-sig
/// these days. /// these days.
@ -409,7 +409,7 @@ impl Address {
Ok(Address::p2sh_from_hash(hash, network)) Ok(Address::p2sh_from_hash(hash, network))
} }
/// Constructs a new pay to script hash P2SH address from a script hash. /// Constructs a new pay-to-script-hash (P2SH) [`Address`] from a script hash.
/// ///
/// # Warning /// # Warning
/// ///
@ -419,7 +419,7 @@ impl Address {
Self(AddressInner::P2sh { hash, network: network.into() }, PhantomData) Self(AddressInner::P2sh { hash, network: network.into() }, PhantomData)
} }
/// Constructs a new witness pay to public key address from a public key. /// Constructs a new pay-to-witness-public-key-hash (P2WPKH) [`Address`] from a public key.
/// ///
/// This is the native segwit address type for an output redeemable with a single signature. /// This is the native segwit address type for an output redeemable with a single signature.
pub fn p2wpkh(pk: CompressedPublicKey, hrp: impl Into<KnownHrp>) -> Self { pub fn p2wpkh(pk: CompressedPublicKey, hrp: impl Into<KnownHrp>) -> Self {
@ -427,7 +427,8 @@ impl Address {
Address::from_witness_program(program, hrp) Address::from_witness_program(program, hrp)
} }
/// Constructs a new pay to script address that embeds a witness pay to public key. /// Constructs a new pay-to-script-hash (P2SH) [`Address`] that embeds a
/// pay-to-witness-public-key-hash (P2WPKH).
/// ///
/// This is a segwit address type that looks familiar (as p2sh) to legacy clients. /// This is a segwit address type that looks familiar (as p2sh) to legacy clients.
pub fn p2shwpkh(pk: CompressedPublicKey, network: impl Into<NetworkKind>) -> Address { pub fn p2shwpkh(pk: CompressedPublicKey, network: impl Into<NetworkKind>) -> Address {
@ -436,7 +437,7 @@ impl Address {
Address::p2sh_from_hash(script_hash, network) Address::p2sh_from_hash(script_hash, network)
} }
/// Constructs a new witness pay to script hash address. /// Constructs a new pay-to-witness-script-hash (P2WSH) [`Address`] from a witness script.
pub fn p2wsh( pub fn p2wsh(
witness_script: &Script, witness_script: &Script,
hrp: impl Into<KnownHrp>, hrp: impl Into<KnownHrp>,
@ -445,13 +446,14 @@ impl Address {
Ok(Address::from_witness_program(program, hrp)) Ok(Address::from_witness_program(program, hrp))
} }
/// Constructs a new witness pay to script hash address. /// Constructs a new pay-to-witness-script-hash (P2WSH) [`Address`] from a witness script hash.
pub fn p2wsh_from_hash(hash: WScriptHash, hrp: impl Into<KnownHrp>) -> Address { pub fn p2wsh_from_hash(hash: WScriptHash, hrp: impl Into<KnownHrp>) -> Address {
let program = WitnessProgram::p2wsh_from_hash(hash); let program = WitnessProgram::p2wsh_from_hash(hash);
Address::from_witness_program(program, hrp) Address::from_witness_program(program, hrp)
} }
/// Constructs a new pay to script address that embeds a witness pay to script hash address. /// Constructs a new pay-to-script-hash (P2SH) [`Address`] that embeds a
/// pay-to-witness-script-hash (P2WSH).
/// ///
/// This is a segwit address type that looks familiar (as p2sh) to legacy clients. /// This is a segwit address type that looks familiar (as p2sh) to legacy clients.
pub fn p2shwsh( pub fn p2shwsh(
@ -464,7 +466,7 @@ impl Address {
Ok(Address::p2sh_from_hash(script_hash, network)) Ok(Address::p2sh_from_hash(script_hash, network))
} }
/// Constructs a new pay to Taproot address from an untweaked key. /// Constructs a new pay-to-Taproot (P2TR) [`Address`] from an untweaked key.
pub fn p2tr<C: Verification>( pub fn p2tr<C: Verification>(
secp: &Secp256k1<C>, secp: &Secp256k1<C>,
internal_key: UntweakedPublicKey, internal_key: UntweakedPublicKey,
@ -475,13 +477,13 @@ impl Address {
Address::from_witness_program(program, hrp) Address::from_witness_program(program, hrp)
} }
/// Constructs a new pay to Taproot address from a pre-tweaked output key. /// Constructs a new pay-to-Taproot (P2TR) [`Address`] from a pre-tweaked output key.
pub fn p2tr_tweaked(output_key: TweakedPublicKey, hrp: impl Into<KnownHrp>) -> Address { pub fn p2tr_tweaked(output_key: TweakedPublicKey, hrp: impl Into<KnownHrp>) -> Address {
let program = WitnessProgram::p2tr_tweaked(output_key); let program = WitnessProgram::p2tr_tweaked(output_key);
Address::from_witness_program(program, hrp) Address::from_witness_program(program, hrp)
} }
/// Constructs a new address from an arbitrary witness program. /// Constructs a new [`Address`] from an arbitrary [`WitnessProgram`].
/// ///
/// This only exists to support future witness versions. If you are doing normal mainnet things /// This only exists to support future witness versions. If you are doing normal mainnet things
/// then you likely do not need this constructor. /// then you likely do not need this constructor.
@ -490,7 +492,7 @@ impl Address {
Address(inner, PhantomData) Address(inner, PhantomData)
} }
/// Gets the address type of the address. /// Gets the address type of the [`Address`].
/// ///
/// # Returns /// # Returns
/// ///