Merge rust-bitcoin/rust-bitcoin#1170: Move `address` out of `util`

22fd107e16 Run rustfmt (Tobin C. Harding)
e1ae9d86bb Move the address module out of util (Tobin C. Harding)
6cc8b22f82 Run cargo fmt (Tobin C. Harding)

Pull request description:

  The identifier 'util' does not convey any real information. We have a whole bunch of modules inside the `util` module.

  As part of work to reduce the amount of arbitrary things in the `util` module move the `address` module to the crate root level.

  - Patch 1: fixes rustfmt issues currently on master, this patch is in heaps of my open PRs at the moment
  - Patch 2: Does the module move
  - Patch 3: Runs the formatter, done separately so reviewers can run `rustfmt +nightly fmt` and check the diff

ACKs for top commit:
  sanket1729:
    ACK 22fd107e16. Reviewed range diff from 9e7998897639ddcf115296b72fbb74ed5d4592c8 which I previously ACKed.
  Kixunil:
    ACK 22fd107e16
  apoelstra:
    ACK 22fd107e16

Tree-SHA512: b1e3384b79b61e2a27bb4afa0a1a37f9da359bd4ab0a2338a45aa29e1a64394a97b552beafa55a8540ed7dcbd99fe6e1aea573dd37648e705b96176a96e0e27f
This commit is contained in:
Andrew Poelstra 2022-08-12 16:59:47 +00:00
commit 67e88e732c
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
13 changed files with 202 additions and 239 deletions

View File

@ -3,10 +3,10 @@ extern crate bitcoin;
use std::str::FromStr; use std::str::FromStr;
use std::{env, process}; use std::{env, process};
use bitcoin::address::Address;
use bitcoin::hashes::hex::FromHex; use bitcoin::hashes::hex::FromHex;
use bitcoin::secp256k1::ffi::types::AlignedType; use bitcoin::secp256k1::ffi::types::AlignedType;
use bitcoin::secp256k1::Secp256k1; use bitcoin::secp256k1::Secp256k1;
use bitcoin::util::address::Address;
use bitcoin::util::bip32::{ChildNumber, DerivationPath, ExtendedPrivKey, ExtendedPubKey}; use bitcoin::util::bip32::{ChildNumber, DerivationPath, ExtendedPrivKey, ExtendedPubKey};
use bitcoin::PublicKey; use bitcoin::PublicKey;

View File

@ -35,7 +35,6 @@ use std::str::FromStr;
use bitcoin::consensus::encode; use bitcoin::consensus::encode;
use bitcoin::hashes::hex::{self, FromHex}; use bitcoin::hashes::hex::{self, FromHex};
use bitcoin::secp256k1::{Secp256k1, Signing, Verification}; use bitcoin::secp256k1::{Secp256k1, Signing, Verification};
use bitcoin::util::address;
use bitcoin::util::amount::ParseAmountError; use bitcoin::util::amount::ParseAmountError;
use bitcoin::util::bip32::{ use bitcoin::util::bip32::{
self, ChildNumber, DerivationPath, ExtendedPrivKey, ExtendedPubKey, Fingerprint, self, ChildNumber, DerivationPath, ExtendedPrivKey, ExtendedPubKey, Fingerprint,
@ -43,8 +42,8 @@ use bitcoin::util::bip32::{
}; };
use bitcoin::util::psbt::{self, Input, Psbt, PsbtSighashType}; use bitcoin::util::psbt::{self, Input, Psbt, PsbtSighashType};
use bitcoin::{ use bitcoin::{
Address, Amount, Network, OutPoint, PackedLockTime, PrivateKey, PublicKey, Script, Sequence, address, Address, Amount, Network, OutPoint, PackedLockTime, PrivateKey, PublicKey, Script,
Transaction, TxIn, TxOut, Txid, Witness, Sequence, Transaction, TxIn, TxOut, Txid, Witness,
}; };
use self::psbt_sign::*; use self::psbt_sign::*;

View File

@ -2,7 +2,7 @@ extern crate bitcoin;
use std::str::FromStr; use std::str::FromStr;
fn do_test(data: &[u8]) { fn do_test(data: &[u8]) {
let data_str = String::from_utf8_lossy(data); let data_str = String::from_utf8_lossy(data);
let addr = match bitcoin::util::address::Address::from_str(&data_str) { let addr = match bitcoin::address::Address::from_str(&data_str) {
Ok(addr) => addr, Ok(addr) => addr,
Err(_) => return, Err(_) => return,
}; };

View File

@ -1,6 +1,6 @@
extern crate bitcoin; extern crate bitcoin;
use bitcoin::util::address::Address; use bitcoin::address::Address;
use bitcoin::network::constants::Network; use bitcoin::network::constants::Network;
use bitcoin::blockdata::script; use bitcoin::blockdata::script;
use bitcoin::consensus::encode; use bitcoin::consensus::encode;

View File

@ -9,7 +9,7 @@
//! //!
//! ```rust //! ```rust
//! use bitcoin::network::constants::Network; //! use bitcoin::network::constants::Network;
//! use bitcoin::util::address::Address; //! use bitcoin::address::Address;
//! use bitcoin::PublicKey; //! use bitcoin::PublicKey;
//! use bitcoin::secp256k1::Secp256k1; //! use bitcoin::secp256k1::Secp256k1;
//! use bitcoin::secp256k1::rand::thread_rng; //! use bitcoin::secp256k1::rand::thread_rng;
@ -22,26 +22,29 @@
//! let address = Address::p2pkh(&public_key, Network::Bitcoin); //! let address = Address::p2pkh(&public_key, Network::Bitcoin);
//! ``` //! ```
use crate::prelude::*;
use core::convert::TryFrom; use core::convert::TryFrom;
use core::fmt; use core::fmt;
use crate::error::ParseIntError;
use core::str::FromStr; use core::str::FromStr;
use secp256k1::{Secp256k1, Verification, XOnlyPublicKey};
use bech32; use bech32;
use crate::hashes::{sha256, Hash, HashEngine}; use secp256k1::{Secp256k1, Verification, XOnlyPublicKey};
use crate::hash_types::{PubkeyHash, ScriptHash};
use crate::blockdata::{script, opcodes}; use crate::blockdata::constants::{
use crate::blockdata::constants::{PUBKEY_ADDRESS_PREFIX_MAIN, SCRIPT_ADDRESS_PREFIX_MAIN, PUBKEY_ADDRESS_PREFIX_TEST, SCRIPT_ADDRESS_PREFIX_TEST, MAX_SCRIPT_ELEMENT_SIZE}; MAX_SCRIPT_ELEMENT_SIZE, PUBKEY_ADDRESS_PREFIX_MAIN, PUBKEY_ADDRESS_PREFIX_TEST,
use crate::network::constants::Network; SCRIPT_ADDRESS_PREFIX_MAIN, SCRIPT_ADDRESS_PREFIX_TEST,
use crate::util::base58; };
use crate::util::taproot::TapBranchHash;
use crate::util::key::PublicKey;
use crate::blockdata::script::Instruction; use crate::blockdata::script::Instruction;
use crate::util::schnorr::{TapTweak, UntweakedPublicKey, TweakedPublicKey}; use crate::blockdata::{opcodes, script};
use crate::error::ParseIntError;
use crate::hash_types::{PubkeyHash, ScriptHash};
use crate::hashes::{sha256, Hash, HashEngine};
use crate::internal_macros::{serde_string_impl, write_err}; use crate::internal_macros::{serde_string_impl, write_err};
use crate::network::constants::Network;
use crate::prelude::*;
use crate::util::base58;
use crate::util::key::PublicKey;
use crate::util::schnorr::{TapTweak, TweakedPublicKey, UntweakedPublicKey};
use crate::util::taproot::TapBranchHash;
/// Address error. /// Address error.
#[derive(Debug, PartialEq, Eq, Clone)] #[derive(Debug, PartialEq, Eq, Clone)]
@ -58,7 +61,7 @@ pub enum Error {
/// Bech32 variant that is required by the used Witness version. /// Bech32 variant that is required by the used Witness version.
expected: bech32::Variant, expected: bech32::Variant,
/// The actual Bech32 variant encoded in the address representation. /// The actual Bech32 variant encoded in the address representation.
found: bech32::Variant found: bech32::Variant,
}, },
/// Script version must be 0 to 16 inclusive. /// Script version must be 0 to 16 inclusive.
InvalidWitnessVersion(u8), InvalidWitnessVersion(u8),
@ -126,16 +129,12 @@ impl std::error::Error for Error {
#[doc(hidden)] #[doc(hidden)]
impl From<base58::Error> for Error { impl From<base58::Error> for Error {
fn from(e: base58::Error) -> Error { fn from(e: base58::Error) -> Error { Error::Base58(e) }
Error::Base58(e)
}
} }
#[doc(hidden)] #[doc(hidden)]
impl From<bech32::Error> for Error { impl From<bech32::Error> for Error {
fn from(e: bech32::Error) -> Error { fn from(e: bech32::Error) -> Error { Error::Bech32(e) }
Error::Bech32(e)
}
} }
/// The different types of addresses. /// The different types of addresses.
@ -229,12 +228,9 @@ pub enum WitnessVersion {
/// Prints [`WitnessVersion`] number (from 0 to 16) as integer, without /// Prints [`WitnessVersion`] number (from 0 to 16) as integer, without
/// any prefix or suffix. /// any prefix or suffix.
impl fmt::Display for WitnessVersion { impl fmt::Display for WitnessVersion {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "{}", *self as u8) }
write!(f, "{}", *self as u8)
}
} }
impl FromStr for WitnessVersion { impl FromStr for WitnessVersion {
type Err = Error; type Err = Error;
@ -255,9 +251,7 @@ impl WitnessVersion {
/// If the integer does not correspond to any witness version, errors with /// If the integer does not correspond to any witness version, errors with
/// [`Error::InvalidWitnessVersion`]. /// [`Error::InvalidWitnessVersion`].
#[deprecated(since = "0.29.0", note = "use try_from instead")] #[deprecated(since = "0.29.0", note = "use try_from instead")]
pub fn from_u5(value: bech32::u5) -> Result<Self, Error> { pub fn from_u5(value: bech32::u5) -> Result<Self, Error> { Self::try_from(value) }
Self::try_from(value)
}
/// Converts an 8-bit unsigned integer value into [`WitnessVersion`] variant. /// Converts an 8-bit unsigned integer value into [`WitnessVersion`] variant.
/// ///
@ -268,9 +262,7 @@ impl WitnessVersion {
/// If the integer does not correspond to any witness version, errors with /// If the integer does not correspond to any witness version, errors with
/// [`Error::InvalidWitnessVersion`]. /// [`Error::InvalidWitnessVersion`].
#[deprecated(since = "0.29.0", note = "use try_from instead")] #[deprecated(since = "0.29.0", note = "use try_from instead")]
pub fn from_num(no: u8) -> Result<Self, Error> { pub fn from_num(no: u8) -> Result<Self, Error> { Self::try_from(no) }
Self::try_from(no)
}
/// Converts bitcoin script opcode into [`WitnessVersion`] variant. /// Converts bitcoin script opcode into [`WitnessVersion`] variant.
/// ///
@ -281,9 +273,7 @@ impl WitnessVersion {
/// If the opcode does not correspond to any witness version, errors with /// If the opcode does not correspond to any witness version, errors with
/// [`Error::MalformedWitnessVersion`]. /// [`Error::MalformedWitnessVersion`].
#[deprecated(since = "0.29.0", note = "use try_from instead")] #[deprecated(since = "0.29.0", note = "use try_from instead")]
pub fn from_opcode(opcode: opcodes::All) -> Result<Self, Error> { pub fn from_opcode(opcode: opcodes::All) -> Result<Self, Error> { Self::try_from(opcode) }
Self::try_from(opcode)
}
/// Converts bitcoin script [`Instruction`] (parsed opcode) into [`WitnessVersion`] variant. /// Converts bitcoin script [`Instruction`] (parsed opcode) into [`WitnessVersion`] variant.
/// ///
@ -305,18 +295,14 @@ impl WitnessVersion {
/// version in bitcoin script. Thus, there is no function to directly convert witness version /// version in bitcoin script. Thus, there is no function to directly convert witness version
/// into a byte since the conversion requires context (bitcoin script or just a version number). /// into a byte since the conversion requires context (bitcoin script or just a version number).
#[deprecated(since = "0.29.0", note = "use to_num instead")] #[deprecated(since = "0.29.0", note = "use to_num instead")]
pub fn into_num(self) -> u8 { pub fn into_num(self) -> u8 { self.to_num() }
self.to_num()
}
/// Returns integer version number representation for a given [`WitnessVersion`] value. /// Returns integer version number representation for a given [`WitnessVersion`] value.
/// ///
/// NB: this is not the same as an integer representation of the opcode signifying witness /// NB: this is not the same as an integer representation of the opcode signifying witness
/// version in bitcoin script. Thus, there is no function to directly convert witness version /// version in bitcoin script. Thus, there is no function to directly convert witness version
/// into a byte since the conversion requires context (bitcoin script or just a version number). /// into a byte since the conversion requires context (bitcoin script or just a version number).
pub fn to_num(self) -> u8 { pub fn to_num(self) -> u8 { self as u8 }
self as u8
}
/// Determines the checksum variant. See BIP-0350 for specification. /// Determines the checksum variant. See BIP-0350 for specification.
pub fn bech32_variant(&self) -> bech32::Variant { pub fn bech32_variant(&self) -> bech32::Variant {
@ -339,9 +325,7 @@ impl TryFrom<bech32::u5> for WitnessVersion {
/// # Errors /// # Errors
/// If the integer does not correspond to any witness version, errors with /// If the integer does not correspond to any witness version, errors with
/// [`Error::InvalidWitnessVersion`]. /// [`Error::InvalidWitnessVersion`].
fn try_from(value: bech32::u5) -> Result<Self, Self::Error> { fn try_from(value: bech32::u5) -> Result<Self, Self::Error> { Self::try_from(value.to_u8()) }
Self::try_from(value.to_u8())
}
} }
impl TryFrom<u8> for WitnessVersion { impl TryFrom<u8> for WitnessVersion {
@ -395,9 +379,11 @@ impl TryFrom<opcodes::All> for WitnessVersion {
fn try_from(opcode: opcodes::All) -> Result<Self, Self::Error> { fn try_from(opcode: opcodes::All) -> Result<Self, Self::Error> {
match opcode.to_u8() { match opcode.to_u8() {
0 => Ok(WitnessVersion::V0), 0 => Ok(WitnessVersion::V0),
version if version >= opcodes::all::OP_PUSHNUM_1.to_u8() && version <= opcodes::all::OP_PUSHNUM_16.to_u8() => version
if version >= opcodes::all::OP_PUSHNUM_1.to_u8()
&& version <= opcodes::all::OP_PUSHNUM_16.to_u8() =>
WitnessVersion::try_from(version - opcodes::all::OP_PUSHNUM_1.to_u8() + 1), WitnessVersion::try_from(version - opcodes::all::OP_PUSHNUM_1.to_u8() + 1),
_ => Err(Error::MalformedWitnessVersion) _ => Err(Error::MalformedWitnessVersion),
} }
} }
} }
@ -435,7 +421,7 @@ impl From<WitnessVersion> for opcodes::All {
fn from(version: WitnessVersion) -> opcodes::All { fn from(version: WitnessVersion) -> opcodes::All {
match version { match version {
WitnessVersion::V0 => opcodes::all::OP_PUSHBYTES_0, WitnessVersion::V0 => opcodes::all::OP_PUSHBYTES_0,
no => opcodes::All::from(opcodes::all::OP_PUSHNUM_1.to_u8() + no.to_num() - 1) no => opcodes::All::from(opcodes::all::OP_PUSHNUM_1.to_u8() + no.to_num() - 1),
} }
} }
} }
@ -468,7 +454,9 @@ impl Payload {
hash_inner.copy_from_slice(&script.as_bytes()[2..22]); hash_inner.copy_from_slice(&script.as_bytes()[2..22]);
Payload::ScriptHash(ScriptHash::from_inner(hash_inner)) Payload::ScriptHash(ScriptHash::from_inner(hash_inner))
} else if script.is_witness_program() { } else if script.is_witness_program() {
if script.witness_version() == Some(WitnessVersion::V0) && !(script.is_v0_p2wpkh() || script.is_v0_p2wsh()) { if script.witness_version() == Some(WitnessVersion::V0)
&& !(script.is_v0_p2wpkh() || script.is_v0_p2wsh())
{
return Err(Error::InvalidSegwitV0ProgramLength(script.len() - 2)); return Err(Error::InvalidSegwitV0ProgramLength(script.len() - 2));
} }
@ -486,17 +474,14 @@ impl Payload {
match *self { match *self {
Payload::PubkeyHash(ref hash) => script::Script::new_p2pkh(hash), Payload::PubkeyHash(ref hash) => script::Script::new_p2pkh(hash),
Payload::ScriptHash(ref hash) => script::Script::new_p2sh(hash), Payload::ScriptHash(ref hash) => script::Script::new_p2sh(hash),
Payload::WitnessProgram { version, program: ref prog } => { Payload::WitnessProgram { version, program: ref prog } =>
script::Script::new_witness_program(version, prog) script::Script::new_witness_program(version, prog),
}
} }
} }
/// Creates a pay to (compressed) public key hash payload from a public key /// Creates a pay to (compressed) public key hash payload from a public key
#[inline] #[inline]
pub fn p2pkh(pk: &PublicKey) -> Payload { pub fn p2pkh(pk: &PublicKey) -> Payload { Payload::PubkeyHash(pk.pubkey_hash()) }
Payload::PubkeyHash(pk.pubkey_hash())
}
/// Creates a pay to script hash P2SH payload from a script /// Creates a pay to script hash P2SH payload from a script
#[inline] #[inline]
@ -534,10 +519,8 @@ impl Payload {
/// Create a pay to script payload that embeds a witness pay to script hash address /// Create a pay to script payload that embeds a witness pay to script hash address
pub fn p2shwsh(script: &script::Script) -> Payload { pub fn p2shwsh(script: &script::Script) -> Payload {
let ws = script::Builder::new() let ws =
.push_int(0) script::Builder::new().push_int(0).push_slice(&script.wscript_hash()).into_script();
.push_slice(&script.wscript_hash())
.into_script();
Payload::ScriptHash(ws.script_hash()) Payload::ScriptHash(ws.script_hash())
} }
@ -603,10 +586,7 @@ impl<'a> fmt::Display for AddressEncoding<'a> {
prefixed[1..].copy_from_slice(&hash[..]); prefixed[1..].copy_from_slice(&hash[..]);
base58::check_encode_slice_to_fmt(fmt, &prefixed[..]) base58::check_encode_slice_to_fmt(fmt, &prefixed[..])
} }
Payload::WitnessProgram { Payload::WitnessProgram { version, program: prog } => {
version,
program: prog,
} => {
let mut upper_writer; let mut upper_writer;
let writer = if fmt.alternate() { let writer = if fmt.alternate() {
upper_writer = UpperWriter(fmt); upper_writer = UpperWriter(fmt);
@ -648,10 +628,7 @@ impl Address {
/// This is the preferred non-witness type address. /// This is the preferred non-witness type address.
#[inline] #[inline]
pub fn p2pkh(pk: &PublicKey, network: Network) -> Address { pub fn p2pkh(pk: &PublicKey, network: Network) -> Address {
Address { Address { network, payload: Payload::p2pkh(pk) }
network,
payload: Payload::p2pkh(pk),
}
} }
/// Creates a pay to script hash P2SH address from a script. /// Creates a pay to script hash P2SH address from a script.
@ -660,10 +637,7 @@ impl Address {
/// these days. /// these days.
#[inline] #[inline]
pub fn p2sh(script: &script::Script, network: Network) -> Result<Address, Error> { pub fn p2sh(script: &script::Script, network: Network) -> Result<Address, Error> {
Ok(Address { Ok(Address { network, payload: Payload::p2sh(script)? })
network,
payload: Payload::p2sh(script)?,
})
} }
/// Creates a witness pay to public key address from a public key. /// Creates a witness pay to public key address from a public key.
@ -673,10 +647,7 @@ impl Address {
/// # Errors /// # Errors
/// Will only return an error if an uncompressed public key is provided. /// Will only return an error if an uncompressed public key is provided.
pub fn p2wpkh(pk: &PublicKey, network: Network) -> Result<Address, Error> { pub fn p2wpkh(pk: &PublicKey, network: Network) -> Result<Address, Error> {
Ok(Address { Ok(Address { network, payload: Payload::p2wpkh(pk)? })
network,
payload: Payload::p2wpkh(pk)?,
})
} }
/// Creates a pay to script address that embeds a witness pay to public key. /// Creates a pay to script address that embeds a witness pay to public key.
@ -686,28 +657,19 @@ impl Address {
/// # Errors /// # Errors
/// Will only return an Error if an uncompressed public key is provided. /// Will only return an Error if an uncompressed public key is provided.
pub fn p2shwpkh(pk: &PublicKey, network: Network) -> Result<Address, Error> { pub fn p2shwpkh(pk: &PublicKey, network: Network) -> Result<Address, Error> {
Ok(Address { Ok(Address { network, payload: Payload::p2shwpkh(pk)? })
network,
payload: Payload::p2shwpkh(pk)?,
})
} }
/// Creates a witness pay to script hash address. /// Creates a witness pay to script hash address.
pub fn p2wsh(script: &script::Script, network: Network) -> Address { pub fn p2wsh(script: &script::Script, network: Network) -> Address {
Address { Address { network, payload: Payload::p2wsh(script) }
network,
payload: Payload::p2wsh(script),
}
} }
/// Creates a pay to script address that embeds a witness pay to script hash address. /// Creates a pay to script address that embeds a witness pay to script hash address.
/// ///
/// 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(script: &script::Script, network: Network) -> Address { pub fn p2shwsh(script: &script::Script, network: Network) -> Address {
Address { Address { network, payload: Payload::p2shwsh(script) }
network,
payload: Payload::p2shwsh(script),
}
} }
/// Creates a pay to taproot address from an untweaked key. /// Creates a pay to taproot address from an untweaked key.
@ -715,22 +677,16 @@ impl Address {
secp: &Secp256k1<C>, secp: &Secp256k1<C>,
internal_key: UntweakedPublicKey, internal_key: UntweakedPublicKey,
merkle_root: Option<TapBranchHash>, merkle_root: Option<TapBranchHash>,
network: Network network: Network,
) -> Address { ) -> Address {
Address { Address { network, payload: Payload::p2tr(secp, internal_key, merkle_root) }
network,
payload: Payload::p2tr(secp, internal_key, merkle_root),
}
} }
/// Creates a pay to taproot address from a pre-tweaked output key. /// Creates a pay to taproot address from a pre-tweaked output key.
/// ///
/// This method is not recommended for use, [`Address::p2tr()`] should be used where possible. /// This method is not recommended for use, [`Address::p2tr()`] should be used where possible.
pub fn p2tr_tweaked(output_key: TweakedPublicKey, network: Network) -> Address { pub fn p2tr_tweaked(output_key: TweakedPublicKey, network: Network) -> Address {
Address { Address { network, payload: Payload::p2tr_tweaked(output_key) }
network,
payload: Payload::p2tr_tweaked(output_key),
}
} }
/// Gets the address type of the address. /// Gets the address type of the address.
@ -741,10 +697,7 @@ impl Address {
match self.payload { match self.payload {
Payload::PubkeyHash(_) => Some(AddressType::P2pkh), Payload::PubkeyHash(_) => Some(AddressType::P2pkh),
Payload::ScriptHash(_) => Some(AddressType::P2sh), Payload::ScriptHash(_) => Some(AddressType::P2sh),
Payload::WitnessProgram { Payload::WitnessProgram { version, program: ref prog } => {
version,
program: ref prog,
} => {
// BIP-141 p2wpkh or p2wsh addresses. // BIP-141 p2wpkh or p2wsh addresses.
match version { match version {
WitnessVersion::V0 => match prog.len() { WitnessVersion::V0 => match prog.len() {
@ -763,22 +716,15 @@ impl Address {
/// ///
/// SegWit addresses with unassigned witness versions or non-standard program sizes are /// SegWit addresses with unassigned witness versions or non-standard program sizes are
/// considered non-standard. /// considered non-standard.
pub fn is_standard(&self) -> bool { pub fn is_standard(&self) -> bool { self.address_type().is_some() }
self.address_type().is_some()
}
/// Constructs an [`Address`] from an output script (`scriptPubkey`). /// Constructs an [`Address`] from an output script (`scriptPubkey`).
pub fn from_script(script: &script::Script, network: Network) -> Result<Address, Error> { pub fn from_script(script: &script::Script, network: Network) -> Result<Address, Error> {
Ok(Address { Ok(Address { payload: Payload::from_script(script)?, network })
payload: Payload::from_script(script)?,
network,
})
} }
/// Generates a script pubkey spending to this address. /// Generates a script pubkey spending to this address.
pub fn script_pubkey(&self) -> script::Script { pub fn script_pubkey(&self) -> script::Script { self.payload.script_pubkey() }
self.payload.script_pubkey()
}
/// Creates a URI string *bitcoin:address* optimized to be encoded in QR codes. /// Creates a URI string *bitcoin:address* optimized to be encoded in QR codes.
/// ///
@ -818,14 +764,14 @@ impl Address {
pub fn is_valid_for_network(&self, network: Network) -> bool { pub fn is_valid_for_network(&self, network: Network) -> bool {
let is_legacy = match self.address_type() { let is_legacy = match self.address_type() {
Some(AddressType::P2pkh) | Some(AddressType::P2sh) => true, Some(AddressType::P2pkh) | Some(AddressType::P2sh) => true,
_ => false _ => false,
}; };
match (self.network, network) { match (self.network, network) {
(a, b) if a == b => true, (a, b) if a == b => true,
(Network::Bitcoin, _) | (_, Network::Bitcoin) => false, (Network::Bitcoin, _) | (_, Network::Bitcoin) => false,
(Network::Regtest, _) | (_, Network::Regtest) if !is_legacy => false, (Network::Regtest, _) | (_, Network::Regtest) if !is_legacy => false,
(Network::Testnet, _) | (Network::Regtest, _) | (Network::Signet, _) => true (Network::Testnet, _) | (Network::Regtest, _) | (Network::Signet, _) => true,
} }
} }
@ -839,7 +785,9 @@ impl Address {
let payload = self.payload.as_bytes(); let payload = self.payload.as_bytes();
let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner); let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner);
(*pubkey_hash == *payload) || (xonly_pubkey.serialize() == *payload) || (*segwit_redeem_hash(&pubkey_hash) == *payload) (*pubkey_hash == *payload)
|| (xonly_pubkey.serialize() == *payload)
|| (*segwit_redeem_hash(&pubkey_hash) == *payload)
} }
/// Returns true if the supplied xonly public key can be used to derive the address. /// Returns true if the supplied xonly public key can be used to derive the address.
@ -869,12 +817,8 @@ impl fmt::Display for Address {
Network::Testnet | Network::Signet => "tb", Network::Testnet | Network::Signet => "tb",
Network::Regtest => "bcrt", Network::Regtest => "bcrt",
}; };
let encoding = AddressEncoding { let encoding =
payload: &self.payload, AddressEncoding { payload: &self.payload, p2pkh_prefix, p2sh_prefix, bech32_hrp };
p2pkh_prefix,
p2sh_prefix,
bech32_hrp,
};
encoding.fmt(fmt) encoding.fmt(fmt)
} }
} }
@ -942,13 +886,7 @@ impl FromStr for Address {
return Err(Error::InvalidBech32Variant { expected, found: variant }); return Err(Error::InvalidBech32Variant { expected, found: variant });
} }
return Ok(Address { return Ok(Address { payload: Payload::WitnessProgram { version, program }, network });
payload: Payload::WitnessProgram {
version,
program,
},
network,
});
} }
// Base58 // Base58
@ -961,36 +899,23 @@ impl FromStr for Address {
} }
let (network, payload) = match data[0] { let (network, payload) = match data[0] {
PUBKEY_ADDRESS_PREFIX_MAIN => ( PUBKEY_ADDRESS_PREFIX_MAIN =>
Network::Bitcoin, (Network::Bitcoin, Payload::PubkeyHash(PubkeyHash::from_slice(&data[1..]).unwrap())),
Payload::PubkeyHash(PubkeyHash::from_slice(&data[1..]).unwrap()), SCRIPT_ADDRESS_PREFIX_MAIN =>
), (Network::Bitcoin, Payload::ScriptHash(ScriptHash::from_slice(&data[1..]).unwrap())),
SCRIPT_ADDRESS_PREFIX_MAIN => ( PUBKEY_ADDRESS_PREFIX_TEST =>
Network::Bitcoin, (Network::Testnet, Payload::PubkeyHash(PubkeyHash::from_slice(&data[1..]).unwrap())),
Payload::ScriptHash(ScriptHash::from_slice(&data[1..]).unwrap()), SCRIPT_ADDRESS_PREFIX_TEST =>
), (Network::Testnet, Payload::ScriptHash(ScriptHash::from_slice(&data[1..]).unwrap())),
PUBKEY_ADDRESS_PREFIX_TEST => (
Network::Testnet,
Payload::PubkeyHash(PubkeyHash::from_slice(&data[1..]).unwrap()),
),
SCRIPT_ADDRESS_PREFIX_TEST => (
Network::Testnet,
Payload::ScriptHash(ScriptHash::from_slice(&data[1..]).unwrap()),
),
x => return Err(Error::Base58(base58::Error::InvalidAddressVersion(x))), x => return Err(Error::Base58(base58::Error::InvalidAddressVersion(x))),
}; };
Ok(Address { Ok(Address { network, payload })
network,
payload,
})
} }
} }
impl fmt::Debug for Address { impl fmt::Debug for Address {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(self, f) }
fmt::Display::fmt(self, f)
}
} }
/// Convert a byte array of a pubkey hash into a segwit redeem hash /// Convert a byte array of a pubkey hash into a segwit redeem hash
@ -1005,14 +930,13 @@ fn segwit_redeem_hash(pubkey_hash: &[u8]) -> crate::hashes::hash160::Hash {
mod tests { mod tests {
use core::str::FromStr; use core::str::FromStr;
use crate::hashes::hex::{FromHex, ToHex};
use crate::blockdata::script::Script;
use crate::network::constants::Network::{Bitcoin, Testnet};
use crate::util::key::PublicKey;
use secp256k1::XOnlyPublicKey; use secp256k1::XOnlyPublicKey;
use super::*; use super::*;
use crate::blockdata::script::Script;
use crate::hashes::hex::{FromHex, ToHex};
use crate::network::constants::Network::{Bitcoin, Testnet};
use crate::util::key::PublicKey;
macro_rules! hex (($hex:literal) => (Vec::from_hex($hex).unwrap())); macro_rules! hex (($hex:literal) => (Vec::from_hex($hex).unwrap()));
macro_rules! hex_key (($hex:literal) => (PublicKey::from_slice(&hex!($hex)).unwrap())); macro_rules! hex_key (($hex:literal) => (PublicKey::from_slice(&hex!($hex)).unwrap()));
@ -1040,7 +964,9 @@ mod tests {
fn test_p2pkh_address_58() { fn test_p2pkh_address_58() {
let addr = Address { let addr = Address {
network: Bitcoin, network: Bitcoin,
payload: Payload::PubkeyHash(hex_pubkeyhash!("162c5ea71c0b23f5b9022ef047c4a86470a5b070")), payload: Payload::PubkeyHash(hex_pubkeyhash!(
"162c5ea71c0b23f5b9022ef047c4a86470a5b070"
)),
}; };
assert_eq!( assert_eq!(
@ -1069,7 +995,9 @@ mod tests {
fn test_p2sh_address_58() { fn test_p2sh_address_58() {
let addr = Address { let addr = Address {
network: Bitcoin, network: Bitcoin,
payload: Payload::ScriptHash(hex_scripthash!("162c5ea71c0b23f5b9022ef047c4a86470a5b070")), payload: Payload::ScriptHash(hex_scripthash!(
"162c5ea71c0b23f5b9022ef047c4a86470a5b070"
)),
}; };
assert_eq!( assert_eq!(
@ -1091,7 +1019,7 @@ mod tests {
} }
#[test] #[test]
fn test_p2sh_parse_for_large_script(){ fn test_p2sh_parse_for_large_script() {
let script = hex_script!("552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123"); let script = hex_script!("552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123552103a765fc35b3f210b95223846b36ef62a4e53e34e2925270c2c7906b92c9f718eb2103c327511374246759ec8d0b89fa6c6b23b33e11f92c5bc155409d86de0c79180121038cae7406af1f12f4786d820a1466eec7bc5785a1b5e4a387eca6d797753ef6db2103252bfb9dcaab0cd00353f2ac328954d791270203d66c2be8b430f115f451b8a12103e79412d42372c55dd336f2eb6eb639ef9d74a22041ba79382c74da2338fe58ad21035049459a4ebc00e876a9eef02e72a3e70202d3d1f591fc0dd542f93f642021f82102016f682920d9723c61b27f562eb530c926c00106004798b6471e8c52c60ee02057ae12123122313123123ac1231231231231313123131231231231313212313213123123");
assert_eq!(Address::p2sh(&script, Testnet), Err(Error::ExcessiveScriptSize)); assert_eq!(Address::p2sh(&script, Testnet), Err(Error::ExcessiveScriptSize));
} }
@ -1099,7 +1027,8 @@ mod tests {
#[test] #[test]
fn test_p2wpkh() { fn test_p2wpkh() {
// stolen from Bitcoin transaction: b3c8c2b6cfc335abbcb2c7823a8453f55d64b2b5125a9a61e8737230cdb8ce20 // stolen from Bitcoin transaction: b3c8c2b6cfc335abbcb2c7823a8453f55d64b2b5125a9a61e8737230cdb8ce20
let mut key = hex_key!("033bc8c83c52df5712229a2f72206d90192366c36428cb0c12b6af98324d97bfbc"); let mut key =
hex_key!("033bc8c83c52df5712229a2f72206d90192366c36428cb0c12b6af98324d97bfbc");
let addr = Address::p2wpkh(&key, Bitcoin).unwrap(); let addr = Address::p2wpkh(&key, Bitcoin).unwrap();
assert_eq!(&addr.to_string(), "bc1qvzvkjn4q3nszqxrv3nraga2r822xjty3ykvkuw"); assert_eq!(&addr.to_string(), "bc1qvzvkjn4q3nszqxrv3nraga2r822xjty3ykvkuw");
assert_eq!(addr.address_type(), Some(AddressType::P2wpkh)); assert_eq!(addr.address_type(), Some(AddressType::P2wpkh));
@ -1126,7 +1055,8 @@ mod tests {
#[test] #[test]
fn test_p2shwpkh() { fn test_p2shwpkh() {
// stolen from Bitcoin transaction: ad3fd9c6b52e752ba21425435ff3dd361d6ac271531fc1d2144843a9f550ad01 // stolen from Bitcoin transaction: ad3fd9c6b52e752ba21425435ff3dd361d6ac271531fc1d2144843a9f550ad01
let mut key = hex_key!("026c468be64d22761c30cd2f12cbc7de255d592d7904b1bab07236897cc4c2e766"); let mut key =
hex_key!("026c468be64d22761c30cd2f12cbc7de255d592d7904b1bab07236897cc4c2e766");
let addr = Address::p2shwpkh(&key, Bitcoin).unwrap(); let addr = Address::p2shwpkh(&key, Bitcoin).unwrap();
assert_eq!(&addr.to_string(), "3QBRmWNqqBGme9er7fMkGqtZtp4gjMFxhE"); assert_eq!(&addr.to_string(), "3QBRmWNqqBGme9er7fMkGqtZtp4gjMFxhE");
assert_eq!(addr.address_type(), Some(AddressType::P2sh)); assert_eq!(addr.address_type(), Some(AddressType::P2sh));
@ -1154,10 +1084,7 @@ mod tests {
"654f6ea368e0acdfd92976b7c2103a1b26313f430654f6ea368e0acdfd92976b7c2103a1b26313f4" "654f6ea368e0acdfd92976b7c2103a1b26313f430654f6ea368e0acdfd92976b7c2103a1b26313f4"
); );
let addr = Address { let addr = Address {
payload: Payload::WitnessProgram { payload: Payload::WitnessProgram { version: WitnessVersion::V13, program },
version: WitnessVersion::V13,
program,
},
network: Network::Bitcoin, network: Network::Bitcoin,
}; };
roundtrips(&addr); roundtrips(&addr);
@ -1169,8 +1096,14 @@ mod tests {
("1QJVDzdqb1VpbDK7uDeyVXy9mR27CJiyhY", Some(AddressType::P2pkh)), ("1QJVDzdqb1VpbDK7uDeyVXy9mR27CJiyhY", Some(AddressType::P2pkh)),
("33iFwdLuRpW1uK1RTRqsoi8rR4NpDzk66k", Some(AddressType::P2sh)), ("33iFwdLuRpW1uK1RTRqsoi8rR4NpDzk66k", Some(AddressType::P2sh)),
("bc1qvzvkjn4q3nszqxrv3nraga2r822xjty3ykvkuw", Some(AddressType::P2wpkh)), ("bc1qvzvkjn4q3nszqxrv3nraga2r822xjty3ykvkuw", Some(AddressType::P2wpkh)),
("bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej", Some(AddressType::P2wsh)), (
("bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr", Some(AddressType::P2tr)), "bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej",
Some(AddressType::P2wsh),
),
(
"bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr",
Some(AddressType::P2tr),
),
// Related to future extensions, addresses are valid but have no type // Related to future extensions, addresses are valid but have no type
// segwit v1 and len != 32 // segwit v1 and len != 32
("bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kt5nd6y", None), ("bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kt5nd6y", None),
@ -1230,7 +1163,6 @@ mod tests {
"tb1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vpggkg4j", "tb1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vpggkg4j",
// Empty data section // Empty data section
"bc1gmk9yu", "bc1gmk9yu",
// 2. BIP-173 test vectors // 2. BIP-173 test vectors
// Invalid human-readable part // Invalid human-readable part
"tc1qw508d6qejxtdg4y5r3zarvary0c5xw7kg3g4ty", "tc1qw508d6qejxtdg4y5r3zarvary0c5xw7kg3g4ty",
@ -1326,14 +1258,21 @@ mod tests {
#[test] #[test]
fn test_qr_string() { fn test_qr_string() {
for el in ["132F25rTsvBdp9JzLLBHP5mvGY66i1xdiM", "33iFwdLuRpW1uK1RTRqsoi8rR4NpDzk66k"].iter() { for el in
["132F25rTsvBdp9JzLLBHP5mvGY66i1xdiM", "33iFwdLuRpW1uK1RTRqsoi8rR4NpDzk66k"].iter()
{
let addr = Address::from_str(el).unwrap(); let addr = Address::from_str(el).unwrap();
assert_eq!(addr.to_qr_uri(), format!("bitcoin:{}", el)); assert_eq!(addr.to_qr_uri(), format!("bitcoin:{}", el));
} }
for el in ["bcrt1q2nfxmhd4n3c8834pj72xagvyr9gl57n5r94fsl", "bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej"].iter() { for el in [
"bcrt1q2nfxmhd4n3c8834pj72xagvyr9gl57n5r94fsl",
"bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej",
]
.iter()
{
let addr = Address::from_str(el).unwrap(); let addr = Address::from_str(el).unwrap();
assert_eq!(addr.to_qr_uri(), format!("BITCOIN:{}", el.to_ascii_uppercase()) ); assert_eq!(addr.to_qr_uri(), format!("BITCOIN:{}", el.to_ascii_uppercase()));
} }
} }
@ -1341,47 +1280,38 @@ mod tests {
fn test_valid_networks() { fn test_valid_networks() {
let legacy_payload = &[ let legacy_payload = &[
Payload::PubkeyHash(PubkeyHash::all_zeros()), Payload::PubkeyHash(PubkeyHash::all_zeros()),
Payload::ScriptHash(ScriptHash::all_zeros()) Payload::ScriptHash(ScriptHash::all_zeros()),
]; ];
let segwit_payload = (0..=16).map(|version| { let segwit_payload = (0..=16)
Payload::WitnessProgram { .map(|version| Payload::WitnessProgram {
version: WitnessVersion::try_from(version).unwrap(), version: WitnessVersion::try_from(version).unwrap(),
program: vec![] program: vec![],
} })
}).collect::<Vec<_>>(); .collect::<Vec<_>>();
const LEGACY_EQUIVALENCE_CLASSES: &[&[Network]] = &[ const LEGACY_EQUIVALENCE_CLASSES: &[&[Network]] =
&[Network::Bitcoin], &[&[Network::Bitcoin], &[Network::Testnet, Network::Regtest, Network::Signet]];
&[Network::Testnet, Network::Regtest, Network::Signet], const SEGWIT_EQUIVALENCE_CLASSES: &[&[Network]] =
]; &[&[Network::Bitcoin], &[Network::Regtest], &[Network::Testnet, Network::Signet]];
const SEGWIT_EQUIVALENCE_CLASSES: &[&[Network]] = &[
&[Network::Bitcoin],
&[Network::Regtest],
&[Network::Testnet, Network::Signet],
];
fn test_addr_type(payloads: &[Payload], equivalence_classes: &[&[Network]]) { fn test_addr_type(payloads: &[Payload], equivalence_classes: &[&[Network]]) {
for pl in payloads { for pl in payloads {
for addr_net in equivalence_classes.iter().flat_map(|ec| ec.iter()) { for addr_net in equivalence_classes.iter().flat_map(|ec| ec.iter()) {
for valid_net in equivalence_classes.iter() for valid_net in equivalence_classes
.iter()
.filter(|ec| ec.contains(addr_net)) .filter(|ec| ec.contains(addr_net))
.flat_map(|ec| ec.iter()) .flat_map(|ec| ec.iter())
{ {
let addr = Address { let addr = Address { payload: pl.clone(), network: *addr_net };
payload: pl.clone(),
network: *addr_net
};
assert!(addr.is_valid_for_network(*valid_net)); assert!(addr.is_valid_for_network(*valid_net));
} }
for invalid_net in equivalence_classes.iter() for invalid_net in equivalence_classes
.iter()
.filter(|ec| !ec.contains(addr_net)) .filter(|ec| !ec.contains(addr_net))
.flat_map(|ec| ec.iter()) .flat_map(|ec| ec.iter())
{ {
let addr = Address { let addr = Address { payload: pl.clone(), network: *addr_net };
payload: pl.clone(),
network: *addr_net
};
assert!(!addr.is_valid_for_network(*invalid_net)); assert!(!addr.is_valid_for_network(*invalid_net));
} }
} }
@ -1395,10 +1325,16 @@ mod tests {
#[test] #[test]
fn p2tr_from_untweaked() { fn p2tr_from_untweaked() {
//Test case from BIP-086 //Test case from BIP-086
let internal_key = XOnlyPublicKey::from_str("cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115").unwrap(); let internal_key = XOnlyPublicKey::from_str(
"cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115",
)
.unwrap();
let secp = Secp256k1::verification_only(); let secp = Secp256k1::verification_only();
let address = Address::p2tr(&secp, internal_key, None, Network::Bitcoin); let address = Address::p2tr(&secp, internal_key, None, Network::Bitcoin);
assert_eq!(address.to_string(), "bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr"); assert_eq!(
address.to_string(),
"bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr"
);
assert_eq!(address.address_type(), Some(AddressType::P2tr)); assert_eq!(address.address_type(), Some(AddressType::P2tr));
roundtrips(&address); roundtrips(&address);
} }
@ -1414,7 +1350,10 @@ mod tests {
let result = address.is_related_to_pubkey(&pubkey); let result = address.is_related_to_pubkey(&pubkey);
assert!(result); assert!(result);
let unused_pubkey = PublicKey::from_str("02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c").expect("pubkey"); let unused_pubkey = PublicKey::from_str(
"02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c",
)
.expect("pubkey");
assert!(!address.is_related_to_pubkey(&unused_pubkey)) assert!(!address.is_related_to_pubkey(&unused_pubkey))
} }
@ -1429,7 +1368,10 @@ mod tests {
let result = address.is_related_to_pubkey(&pubkey); let result = address.is_related_to_pubkey(&pubkey);
assert!(result); assert!(result);
let unused_pubkey = PublicKey::from_str("02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c").expect("pubkey"); let unused_pubkey = PublicKey::from_str(
"02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c",
)
.expect("pubkey");
assert!(!address.is_related_to_pubkey(&unused_pubkey)) assert!(!address.is_related_to_pubkey(&unused_pubkey))
} }
@ -1444,7 +1386,10 @@ mod tests {
let result = address.is_related_to_pubkey(&pubkey); let result = address.is_related_to_pubkey(&pubkey);
assert!(result); assert!(result);
let unused_pubkey = PublicKey::from_str("02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c").expect("pubkey"); let unused_pubkey = PublicKey::from_str(
"02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c",
)
.expect("pubkey");
assert!(!address.is_related_to_pubkey(&unused_pubkey)) assert!(!address.is_related_to_pubkey(&unused_pubkey))
} }
@ -1459,36 +1404,50 @@ mod tests {
let result = address.is_related_to_pubkey(&pubkey); let result = address.is_related_to_pubkey(&pubkey);
assert!(result); assert!(result);
let unused_pubkey = PublicKey::from_str("02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c").expect("pubkey"); let unused_pubkey = PublicKey::from_str(
"02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c",
)
.expect("pubkey");
assert!(!address.is_related_to_pubkey(&unused_pubkey)) assert!(!address.is_related_to_pubkey(&unused_pubkey))
} }
#[test] #[test]
fn test_is_related_to_pubkey_p2tr(){ fn test_is_related_to_pubkey_p2tr() {
let pubkey_string = "0347ff3dacd07a1f43805ec6808e801505a6e18245178609972a68afbc2777ff2b"; let pubkey_string = "0347ff3dacd07a1f43805ec6808e801505a6e18245178609972a68afbc2777ff2b";
let pubkey = PublicKey::from_str(pubkey_string).expect("pubkey"); let pubkey = PublicKey::from_str(pubkey_string).expect("pubkey");
let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner); let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner);
let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(xonly_pubkey); let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(xonly_pubkey);
let address = Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin); let address = Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin);
assert_eq!(address, Address::from_str("bc1pgllnmtxs0g058qz7c6qgaqq4qknwrqj9z7rqn9e2dzhmcfmhlu4sfadf5e").expect("address")); assert_eq!(
address,
Address::from_str("bc1pgllnmtxs0g058qz7c6qgaqq4qknwrqj9z7rqn9e2dzhmcfmhlu4sfadf5e")
.expect("address")
);
let result = address.is_related_to_pubkey(&pubkey); let result = address.is_related_to_pubkey(&pubkey);
assert!(result); assert!(result);
let unused_pubkey = PublicKey::from_str("02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c").expect("pubkey"); let unused_pubkey = PublicKey::from_str(
"02ba604e6ad9d3864eda8dc41c62668514ef7d5417d3b6db46e45cc4533bff001c",
)
.expect("pubkey");
assert!(!address.is_related_to_pubkey(&unused_pubkey)); assert!(!address.is_related_to_pubkey(&unused_pubkey));
} }
#[test] #[test]
fn test_is_related_to_xonly_pubkey(){ fn test_is_related_to_xonly_pubkey() {
let pubkey_string = "0347ff3dacd07a1f43805ec6808e801505a6e18245178609972a68afbc2777ff2b"; let pubkey_string = "0347ff3dacd07a1f43805ec6808e801505a6e18245178609972a68afbc2777ff2b";
let pubkey = PublicKey::from_str(pubkey_string).expect("pubkey"); let pubkey = PublicKey::from_str(pubkey_string).expect("pubkey");
let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner); let xonly_pubkey = XOnlyPublicKey::from(pubkey.inner);
let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(xonly_pubkey); let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(xonly_pubkey);
let address = Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin); let address = Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin);
assert_eq!(address, Address::from_str("bc1pgllnmtxs0g058qz7c6qgaqq4qknwrqj9z7rqn9e2dzhmcfmhlu4sfadf5e").expect("address")); assert_eq!(
address,
Address::from_str("bc1pgllnmtxs0g058qz7c6qgaqq4qknwrqj9z7rqn9e2dzhmcfmhlu4sfadf5e")
.expect("address")
);
let result = address.is_related_to_xonly_pubkey(&xonly_pubkey); let result = address.is_related_to_xonly_pubkey(&xonly_pubkey);
assert!(result); assert!(result);
@ -1497,13 +1456,17 @@ mod tests {
#[test] #[test]
fn test_fail_address_from_script() { fn test_fail_address_from_script() {
let bad_p2wpkh = hex_script!("0014dbc5b0a8f9d4353b4b54c3db48846bb15abfec"); let bad_p2wpkh = hex_script!("0014dbc5b0a8f9d4353b4b54c3db48846bb15abfec");
let bad_p2wsh = hex_script!("00202d4fa2eb233d008cc83206fa2f4f2e60199000f5b857a835e3172323385623"); let bad_p2wsh =
hex_script!("00202d4fa2eb233d008cc83206fa2f4f2e60199000f5b857a835e3172323385623");
let invalid_segwitv0_script = hex_script!("001161458e330389cd0437ee9fe3641d70cc18"); let invalid_segwitv0_script = hex_script!("001161458e330389cd0437ee9fe3641d70cc18");
let expected = Err(Error::UnrecognizedScript); let expected = Err(Error::UnrecognizedScript);
assert_eq!(Address::from_script(&bad_p2wpkh, Network::Bitcoin), expected); assert_eq!(Address::from_script(&bad_p2wpkh, Network::Bitcoin), expected);
assert_eq!(Address::from_script(&bad_p2wsh, Network::Bitcoin), expected); assert_eq!(Address::from_script(&bad_p2wsh, Network::Bitcoin), expected);
assert_eq!(Address::from_script(&invalid_segwitv0_script, Network::Bitcoin), Err(Error::InvalidSegwitV0ProgramLength(17))); assert_eq!(
Address::from_script(&invalid_segwitv0_script, Network::Bitcoin),
Err(Error::InvalidSegwitV0ProgramLength(17))
);
} }
#[test] #[test]

View File

@ -32,7 +32,7 @@ use crate::policy::DUST_RELAY_TX_FEE;
use crate::OutPoint; use crate::OutPoint;
use crate::util::key::PublicKey; use crate::util::key::PublicKey;
use crate::util::address::WitnessVersion; use crate::address::WitnessVersion;
use crate::util::taproot::{LeafVersion, TapBranchHash, TapLeafHash}; use crate::util::taproot::{LeafVersion, TapBranchHash, TapLeafHash};
use secp256k1::{Secp256k1, Verification, XOnlyPublicKey}; use secp256k1::{Secp256k1, Verification, XOnlyPublicKey};
use crate::schnorr::{TapTweak, TweakedPublicKey, UntweakedPublicKey}; use crate::schnorr::{TapTweak, TweakedPublicKey, UntweakedPublicKey};

View File

@ -16,9 +16,7 @@ macro_rules! impl_std_error {
#[cfg(feature = "std")] #[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))] #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for $type { impl std::error::Error for $type {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { Some(&self.$field) }
Some(&self.$field)
}
} }
}; };
} }

View File

@ -61,27 +61,25 @@ extern crate test;
extern crate alloc; extern crate alloc;
// Re-export dependencies we control. // Re-export dependencies we control.
pub use bitcoin_hashes as hashes; #[cfg(feature = "bitcoinconsensus")]
pub use secp256k1;
pub use bech32;
#[cfg(feature="bitcoinconsensus")]
pub use bitcoinconsensus; pub use bitcoinconsensus;
pub use {bech32, bitcoin_hashes as hashes, secp256k1};
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
#[macro_use] #[macro_use]
extern crate actual_serde as serde; extern crate actual_serde as serde;
#[cfg(test)] #[cfg(test)]
#[macro_use] #[macro_use]
mod test_macros; mod test_macros;
mod internal_macros; mod internal_macros;
mod parse;
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
mod serde_utils; mod serde_utils;
mod parse;
#[macro_use] #[macro_use]
pub mod network; pub mod network;
pub mod address;
pub mod blockdata; pub mod blockdata;
pub mod consensus; pub mod consensus;
pub mod error; pub mod error;
@ -95,6 +93,7 @@ use std::io;
#[cfg(not(feature = "std"))] #[cfg(not(feature = "std"))]
use core2::io; use core2::io;
pub use crate::address::{Address, AddressType};
pub use crate::blockdata::block::{Block, BlockHeader}; pub use crate::blockdata::block::{Block, BlockHeader};
pub use crate::blockdata::locktime::{self, LockTime, PackedLockTime}; pub use crate::blockdata::locktime::{self, LockTime, PackedLockTime};
pub use crate::blockdata::script::Script; pub use crate::blockdata::script::Script;
@ -107,7 +106,6 @@ pub use crate::blockdata::witness::Witness;
pub use crate::consensus::encode::VarInt; pub use crate::consensus::encode::VarInt;
pub use crate::hash_types::*; pub use crate::hash_types::*;
pub use crate::network::constants::Network; pub use crate::network::constants::Network;
pub use crate::util::address::{Address, AddressType};
pub use crate::util::amount::{Amount, Denomination, SignedAmount}; pub use crate::util::amount::{Amount, Denomination, SignedAmount};
pub use crate::util::ecdsa::{self, EcdsaSig, EcdsaSigError}; pub use crate::util::ecdsa::{self, EcdsaSig, EcdsaSigError};
pub use crate::util::key::{KeyPair, PrivateKey, PublicKey, XOnlyPublicKey}; pub use crate::util::key::{KeyPair, PrivateKey, PublicKey, XOnlyPublicKey};

View File

@ -1,8 +1,9 @@
use crate::internal_macros::write_err; use core::convert::TryFrom;
use crate::error::impl_std_error;
use core::fmt; use core::fmt;
use core::str::FromStr; use core::str::FromStr;
use core::convert::TryFrom;
use crate::error::impl_std_error;
use crate::internal_macros::write_err;
use crate::prelude::*; use crate::prelude::*;
/// Error with rich context returned when a string can't be parsed as an integer. /// Error with rich context returned when a string can't be parsed as an integer.
@ -28,21 +29,15 @@ pub struct ParseIntError {
impl ParseIntError { impl ParseIntError {
/// Returns the input that was attempted to be parsed. /// Returns the input that was attempted to be parsed.
pub fn input(&self) -> &str { pub fn input(&self) -> &str { &self.input }
&self.input
}
} }
impl From<ParseIntError> for core::num::ParseIntError { impl From<ParseIntError> for core::num::ParseIntError {
fn from(value: ParseIntError) -> Self { fn from(value: ParseIntError) -> Self { value.source }
value.source
}
} }
impl AsRef<core::num::ParseIntError> for ParseIntError { impl AsRef<core::num::ParseIntError> for ParseIntError {
fn as_ref(&self) -> &core::num::ParseIntError { fn as_ref(&self) -> &core::num::ParseIntError { &self.source }
&self.source
}
} }
impl fmt::Display for ParseIntError { impl fmt::Display for ParseIntError {
@ -55,7 +50,10 @@ impl fmt::Display for ParseIntError {
/// Not strictly neccessary but serves as a lint - avoids weird behavior if someone accidentally /// Not strictly neccessary but serves as a lint - avoids weird behavior if someone accidentally
/// passes non-integer to the `parse()` function. /// passes non-integer to the `parse()` function.
pub(crate) trait Integer: FromStr<Err=core::num::ParseIntError> + TryFrom<i8> + Sized {} pub(crate) trait Integer:
FromStr<Err = core::num::ParseIntError> + TryFrom<i8> + Sized
{
}
macro_rules! impl_integer { macro_rules! impl_integer {
($($type:ty),* $(,)?) => { ($($type:ty),* $(,)?) => {

View File

@ -235,9 +235,10 @@ pub mod hex_bytes {
//! Module for serialization of byte arrays as hex strings. //! Module for serialization of byte arrays as hex strings.
#![allow(missing_docs)] #![allow(missing_docs)]
use crate::hashes::hex::{FromHex, ToHex};
use serde; use serde;
use crate::hashes::hex::{FromHex, ToHex};
pub fn serialize<T, S>(bytes: &T, s: S) -> Result<S::Ok, S::Error> pub fn serialize<T, S>(bytes: &T, s: S) -> Result<S::Ok, S::Error>
where where
T: serde::Serialize + AsRef<[u8]>, T: serde::Serialize + AsRef<[u8]>,

View File

@ -552,7 +552,7 @@ mod tests {
use crate::hashes::hex::{FromHex, ToHex}; use crate::hashes::hex::{FromHex, ToHex};
use crate::network::constants::Network::Testnet; use crate::network::constants::Network::Testnet;
use crate::network::constants::Network::Bitcoin; use crate::network::constants::Network::Bitcoin;
use crate::util::address::Address; use crate::address::Address;
#[test] #[test]
fn test_key_derivation() { fn test_key_derivation() {

View File

@ -32,7 +32,7 @@ mod message_signing {
use secp256k1::ecdsa::{RecoveryId, RecoverableSignature}; use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
use crate::util::key::PublicKey; use crate::util::key::PublicKey;
use crate::util::address::{Address, AddressType}; use crate::address::{Address, AddressType};
use crate::internal_macros::write_err; use crate::internal_macros::write_err;
/// An error used for dealing with Bitcoin Signed Messages. /// An error used for dealing with Bitcoin Signed Messages.

View File

@ -9,7 +9,6 @@
pub mod key; pub mod key;
pub mod ecdsa; pub mod ecdsa;
pub mod schnorr; pub mod schnorr;
pub mod address;
pub mod amount; pub mod amount;
pub mod base58; pub mod base58;
pub mod bip32; pub mod bip32;
@ -111,3 +110,10 @@ pub(crate) fn read_to_end<D: io::Read>(mut d: D) -> Result<Vec<u8>, io::Error> {
} }
Ok(result) Ok(result)
} }
/// The `address` module now lives at the crate root, re-export everything so as not to break the
/// API, however deprecate the re-exports so folks know to upgrade sooner or later.
#[deprecated(since = "0.30.0", note = "Please use crate::address")]
pub mod address {
pub use crate::address::*;
}