Struct bitcoins::types::utxo::Utxo

pub struct Utxo {
    pub outpoint: BitcoinOutpoint,
    pub value: u64,
    pub script_pubkey: ScriptPubkey,
    /* private fields */
}

Information necessary to spend an output.

Fields

outpoint: BitcoinOutpoint

UTXO outpoint

value: u64

UTXO value

script_pubkey: ScriptPubkey

The prevout script pubkey

Implementations

impl Utxo

pub fn new(
    outpoint: BitcoinOutpoint,
    value: u64,
    script_pubkey: ScriptPubkey,
    spend_script: SpendScript
) -> Utxo

Instantiate a new UTXO with the given arguments. If spend_script is provided, but the script_pubkey does not require a spend script, the spend_script will be discarded.

pub fn from_tx_output<T>(tx: &T, idx: usize) -> Utxo where
    T: BitcoinTransaction, 

Produce a UTXO from a transaction output

pub fn from_output_and_outpoint(
    output: &TxOut,
    outpoint: &BitcoinOutpoint
) -> Utxo

Produce a UTXO from an output and the outpoint that identifies it

pub fn script_pubkey(&self) -> &ScriptPubkey

Return a reference to the script pubkey

pub fn spend_script(&self) -> &SpendScript

Return a reference to the spend script

pub fn signing_script(&self) -> Option<Script>

Return the script that ought to be signed. This is the spend_script (redeem/witness script) if present, the script pubkey if legacy PKH, and the legacy PKH script if WPKH. .

pub fn standard_type(&self) -> ScriptType

Inspect the Script to determine its type.

pub fn set_spend_script(&mut self, script: Script) -> bool

Attempts to set the script. Returns true if succesful, false otherwise. Before setting, we check that the provided script’s hash matches the payload of the script pubkey. As such, this will always fail for UTXOs with PKH or WPKH script pubkeys.

pub fn sighash_args(
    &self,
    index: usize,
    flag: Sighash
) -> Option<LegacySighashArgs>

Construct LegacySighashArgs from this UTXO. Returns None if the prevout is WSH or SH and the witness or redeem script is Missing. It is safe to unwrap this Option if the signing script is PKH, or WPKH, or if the underlying witness or redeem script is Known.

pub fn witness_sighash_args(
    &self,
    index: usize,
    flag: Sighash
) -> Option<WitnessSighashArgs>

Construct WitnessSighashArgs from this UTXO. Returns None if the prevout is WSH or SH and the witness or redeem script is Missing. It is safe to unwrap this Option if the signing script is PKH, or WPKH, or if the underlying witness or redeem script is Known.

Trait Implementations

impl Clone for Utxo

fn clone(&self) -> Utxo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Utxo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Utxo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for Utxo

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Utxo> for Utxo

fn eq(&self, other: &Utxo) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Utxo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Utxo

impl StructuralEq for Utxo

impl StructuralPartialEq for Utxo