Enum AddressPayload

pub enum AddressPayload {
    Pkh(PubkeyHash),
    Sh(ScriptHash),
    Wpkh(WPubkeyHash),
    Wsh(WScriptHash),
    Tr(OutputPk),
}

Internal address content. Consists of serialized hashes or x-only key value.

Variants

Pkh(PubkeyHash)

P2PKH payload.

Sh(ScriptHash)

P2SH and SegWit nested (proprietary) P2WPKH/WSH-in-P2SH payloads.

Wpkh(WPubkeyHash)

P2WPKH payload.

Wsh(WScriptHash)

P2WSH payload.

Tr(OutputPk)

P2TR payload.

Implementations

impl AddressPayload

pub fn into_address(self, network: AddressNetwork) -> Address

Constructs Address from the payload.

pub fn from_script(script: &ScriptPubkey) -> Result<Self, AddressError>

Constructs payload from a given scriptPubkey. Fails on future (post-taproot) witness types with None.

pub fn script_pubkey(self) -> ScriptPubkey

Returns script corresponding to the given address.

pub fn address_type(self) -> AddressType

Detects address type.

Trait Implementations

impl Clone for AddressPayload

fn clone(&self) -> AddressPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressPayload

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

Formats the value using the given formatter.

impl From<AddressPayload> for ScriptPubkey

fn from(ap: AddressPayload) -> Self

Converts to this type from the input type.

impl From<OutputPk> for AddressPayload

fn from(v: OutputPk) -> Self

Converts to this type from the input type.

impl From<PubkeyHash> for AddressPayload

fn from(v: PubkeyHash) -> Self

Converts to this type from the input type.

impl From<ScriptHash> for AddressPayload

fn from(v: ScriptHash) -> Self

Converts to this type from the input type.

impl From<WPubkeyHash> for AddressPayload

fn from(v: WPubkeyHash) -> Self

Converts to this type from the input type.

impl From<WScriptHash> for AddressPayload

fn from(v: WScriptHash) -> Self

Converts to this type from the input type.

impl Hash for AddressPayload

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 AddressPayload

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

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

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

impl Eq for AddressPayload

impl StructuralPartialEq for AddressPayload