Struct Address 

pub struct Address {
    pub payload: Payload,
    pub network: Network,
    pub prefix_bech32_mainnet: String,
    pub prefix_bech32_testnet: String,
    pub version_pubkeyhash_mainnet: Vec<u8>,
    pub version_pubkeyhash_testnet: Vec<u8>,
    pub version_scripthash_mainnet: Vec<u8>,
    pub version_scripthash_testnet: Vec<u8>,
}

A Bitcoin address

Fields

payload: Payload

The type of the address

network: Network

The network on which this address is usable

prefix_bech32_mainnet: String

Bech32 mainnet prefix

prefix_bech32_testnet: String

Bech32 testnet prefix

version_pubkeyhash_mainnet: Vec<u8>

Checksum: Mainnet Pubkey Hash address

version_pubkeyhash_testnet: Vec<u8>

Checksum: Testnet Pubkey Hash address

version_scripthash_mainnet: Vec<u8>

Checksum: Mainnet Script Hash address

version_scripthash_testnet: Vec<u8>

Checksum: Testnet Script Hash address

Implementations

impl Address

pub fn new_btc() -> Address

Create empty address as BTC

pub fn to_btc(self) -> Address

Convert address to BTC syntax

pub fn new_ltc() -> Address

Create empty address to LTC syntax

pub fn to_ltc(self) -> Address

Convert address to LTC syntax

pub fn new_dash() -> Address

Create empty address to LTC syntax

pub fn to_dash(self) -> Address

Convert address to LTC syntax

pub fn new_zec() -> Address

Create empty address to ZCash syntax

pub fn to_zec(self) -> Address

Convert address to ZCash syntax

pub fn new_doge() -> Address

Create empty address to Dogecoin syntax

pub fn to_doge(self) -> Address

Convert address to Dogecoin syntax

pub fn p2pkh( self, secp: &Secp256k1, pk: &PublicKey, network: Network, ) -> Address

Creates a pay to (compressed) public key hash address from a public key This is the preferred non-witness type address

pub fn p2sh(self, script: &Script, network: Network) -> Address

Creates a 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 these days.

pub fn p2wpkh( self, secp: &Secp256k1, pk: &PublicKey, network: Network, ) -> Result<Address, Error>

Create a witness pay to public key address from a public key This is the native segwit address type for an output redeemable with a single signature

Will only return an Error when an uncompressed public key is provided.

pub fn p2shwpkh( self, secp: &Secp256k1, pk: &PublicKey, network: Network, ) -> Result<Address, Error>

Create a pay to script address that embeds a witness pay to public key This is a segwit address type that looks familiar (as p2sh) to legacy clients

Will only return an Error when an uncompressed public key is provided.

pub fn p2wsh(self, script: &Script, network: Network) -> Address

Create a witness pay to script hash address

pub fn p2shwsh(self, script: &Script, network: Network) -> Address

Create 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

pub fn address_type(&self) -> Option<AddressType>

Get the address type of the address. None if unknown or non-standard.

pub fn is_standard(&self) -> bool

Check whether or not the address is following Bitcoin standardness rules.

Segwit addresses with unassigned witness versions or non-standard program sizes are considered non-standard.

pub fn from_script(self, script: &Script, network: Network) -> Option<Address>

Get an Address from an output script (scriptPubkey).

pub fn script_pubkey(&self) -> Script

Generates a script pubkey spending to this address

pub fn from_str(self, s: &str) -> Result<Address, Error>

Build address from the BTC address string.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Display for Address

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

Formats the value using the given formatter.

impl Hash for Address

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 Ord for Address

fn cmp(&self, other: &Address) -> 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 PartialEq for Address

fn eq(&self, other: &Address) -> 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 PartialOrd for Address

fn partial_cmp(&self, other: &Address) -> 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 Eq for Address

impl StructuralPartialEq for Address