Struct BitcoinAddress

pub struct BitcoinAddress<N: BitcoinNetwork> { /* private fields */ }

Represents a Bitcoin address

Implementations

impl<N: BitcoinNetwork> BitcoinAddress<N>

pub fn p2pkh_from_hash(hash: &[u8]) -> Result<Self, AddressError>

Generate a P2PKH address from a hash160.

pub fn p2sh_p2wpkh_from_hash(hash: &[u8]) -> Result<Self, AddressError>

Generate a P2SH_P2WPKH address from a hash160

pub fn p2wsh_from_hash(hash: &[u8]) -> Result<Self, AddressError>

pub fn bech32_from_hash(hash: &[u8]) -> Result<Self, AddressError>

Generate a Bech32 address from a hash160

pub fn cash_addr_from_hash(hash: &[u8]) -> Result<Self, AddressError>

Generate a CashAddr address from a hash160

pub fn p2tr_from_hash(hash: &[u8]) -> Result<Self, AddressError>

pub fn p2pkh( public_key: &<Self as Address>::PublicKey, ) -> Result<Self, AddressError>

Generate a P2PKH address from a given Bitcoin public key.

pub fn p2wsh(original_script: &[u8]) -> Result<Self, AddressError>

pub fn p2sh_p2wpkh( public_key: &<Self as Address>::PublicKey, ) -> Result<Self, AddressError>

Generate a P2SH_P2WPKH address from a given Bitcoin public key.

pub fn bech32( public_key: &<Self as Address>::PublicKey, ) -> Result<Self, AddressError>

Generate a Bech32 address from a given Bitcoin public key.

pub fn cash_addr( public_key: &<Self as Address>::PublicKey, ) -> Result<Self, AddressError>

Generate a CashAddr address from a given Bitcoin public key.

pub fn format(&self) -> BitcoinFormat

Return the format of the Bitcoin address.

pub fn create_redeem_script( public_key: &<Self as Address>::PublicKey, ) -> [u8; 22]

Generate a redeem script from a given Bitcoin public key.

pub fn from_script_pub_key(script_pub_key: &[u8]) -> Result<Self, AddressError>

Decode the ‘script_pub_key’ to a bitcoin address

Trait Implementations

impl<N: BitcoinNetwork> Address for BitcoinAddress<N>

fn from_secret_key( secret_key: &Self::SecretKey, format: &Self::Format, ) -> Result<Self, AddressError>

Returns the address corresponding to the given Bitcoin private key.

fn from_public_key( public_key: &Self::PublicKey, format: &Self::Format, ) -> Result<Self, AddressError>

Returns the address corresponding to the given Bitcoin public key.

type SecretKey = SecretKey

type Format = BitcoinFormat

type PublicKey = BitcoinPublicKey<N>

fn is_valid(address: &str) -> bool

impl<N: Clone + BitcoinNetwork> Clone for BitcoinAddress<N>

fn clone(&self) -> BitcoinAddress<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + BitcoinNetwork> Debug for BitcoinAddress<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N: BitcoinNetwork> Display for BitcoinAddress<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N: BitcoinNetwork> FromStr for BitcoinAddress<N>

type Err = AddressError

The associated error which can be returned from parsing.

fn from_str(address: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<N: Hash + BitcoinNetwork> Hash for BitcoinAddress<N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: Ord + BitcoinNetwork> Ord for BitcoinAddress<N>

fn cmp(&self, other: &BitcoinAddress<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<N: PartialEq + BitcoinNetwork> PartialEq for BitcoinAddress<N>

fn eq(&self, other: &BitcoinAddress<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: PartialOrd + BitcoinNetwork> PartialOrd for BitcoinAddress<N>

fn partial_cmp(&self, other: &BitcoinAddress<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<N: Eq + BitcoinNetwork> Eq for BitcoinAddress<N>

impl<N: BitcoinNetwork> StructuralPartialEq for BitcoinAddress<N>