Enum Payload

pub enum Payload {
    PubkeyHash(PubkeyHash),
    ScriptHash(ScriptHash),
    WitnessProgram {
        version: WitnessVersion,
        program: Vec<u8>,
    },
}

The method used to produce an address.

Variants

PubkeyHash(PubkeyHash)

P2PKH address.

ScriptHash(ScriptHash)

P2SH address.

WitnessProgram

Segwit address.

Fields

version: WitnessVersion

The witness program version.

program: Vec<u8>

The witness program.

Implementations

impl Payload

pub fn from_script(script: &Script) -> Result<Payload, Error>

Constructs a Payload from an output script (scriptPubkey).

pub fn script_pubkey(&self) -> Script

Generates a script pubkey spending to this Payload.

pub fn p2pkh(pk: &PublicKey) -> Payload

Creates a pay to (compressed) public key hash payload from a public key

pub fn p2sh(script: &Script) -> Result<Payload, Error>

Creates a pay to script hash P2SH payload from a script

pub fn p2wpkh(pk: &PublicKey) -> Result<Payload, Error>

Create a witness pay to public key payload from a public key

pub fn p2shwpkh(pk: &PublicKey) -> Result<Payload, Error>

Create a pay to script payload that embeds a witness pay to public key

pub fn p2wsh(script: &Script) -> Payload

Create a witness pay to script hash payload.

pub fn p2shwsh(script: &Script) -> Payload

Create a pay to script payload that embeds a witness pay to script hash address

pub fn p2tr<C>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, merkle_root: Option<TapBranchHash>, ) -> Payload

where C: Verification,

Create a pay to taproot payload from untweaked key

pub fn p2tr_tweaked(output_key: TweakedPublicKey) -> Payload

Create a pay to taproot payload from a pre-tweaked output key.

This method is not recommended for use and Payload::p2tr() should be used where possible.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of the payload

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Hash for Payload

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

where __H: Hasher,

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 Payload

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

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

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

impl StructuralPartialEq for Payload