Struct psbt::Output

pub struct Output {
    pub redeem_script: Option<Script>,
    pub witness_script: Option<Script>,
    pub bip32_derivation: BTreeMap<PublicKey, (Fingerprint, DerivationPath)>,
    pub tap_internal_key: Option<XOnlyPublicKey>,
    pub tap_tree: Option<TapTree>,
    pub tap_key_origins: BTreeMap<XOnlyPublicKey, (Vec<TapLeafHash, Global>, (Fingerprint, DerivationPath))>,
    pub proprietary: BTreeMap<ProprietaryKey<u8>, Vec<u8, Global>>,
    pub unknown: BTreeMap<Key, Vec<u8, Global>>,
}

A key-value map for an output of the corresponding index in the unsigned transaction.

Fields

redeem_script: Option<Script>

The redeem script for this output.

witness_script: Option<Script>

The witness script for this output.

bip32_derivation: BTreeMap<PublicKey, (Fingerprint, DerivationPath)>

A map from public keys needed to spend this output to their corresponding master key fingerprints and derivation paths.

tap_internal_key: Option<XOnlyPublicKey>

The internal pubkey.

tap_tree: Option<TapTree>

Taproot Output tree.

tap_key_origins: BTreeMap<XOnlyPublicKey, (Vec<TapLeafHash, Global>, (Fingerprint, DerivationPath))>

Map of tap root x only keys to origin info and leaf hashes contained in it.

proprietary: BTreeMap<ProprietaryKey<u8>, Vec<u8, Global>>

Proprietary key-value pairs for this output.

unknown: BTreeMap<Key, Vec<u8, Global>>

Unknown key-value pairs for this output.

Implementations

impl Output

pub fn combine(&mut self, other: Output)

Combines this Output with other Output (as described by BIP 174).

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl Decodable for Output

fn consensus_decode<D>(d: D) -> Result<Output, Error> where
    D: Read, 

Decode an object with a well-defined format

impl Default for Output

fn default() -> Output

Returns the “default value” for a type.

impl Encodable for Output

fn consensus_encode<S>(&self, s: S) -> Result<usize, Error> where
    S: Write, 

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl PartialEq<Output> for Output

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

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

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

This method tests for !=.

impl TapretOutput for Output

fn can_host_tapret(&self) -> bool

Returns whether this output may contain tapret commitment. This is detected by the presence of the empty PSBT_OUT_TAPRET_HOST key.

fn set_can_host_tapret(&mut self, can_host_commitment: bool) -> bool

Sets whether this output may contain tapret commitment bu adding or removing PSBT_OUT_TAPRET_HOST key basing on can_host_commitment value.

fn has_tapret_commitment(&self) -> bool

Detects presence of a vaid PSBT_OUT_TAPRET_COMMITMENT.

fn tapret_commitment(&self) -> Option<Slice32>

Returns valid tapret commitment from the PSBT_OUT_TAPRET_COMMITMENT key, if present. If the commitment is absent or invalid, returns None.

fn set_tapret_commitment(
    &mut self,
    commitment: impl Into<[u8; 32]>
) -> Result<(), KeyError>

Assigns value of the tapreturn commitment to this PSBT output, by adding PSBT_OUT_TAPRET_COMMITMENT proprietary key containing the 32-byte commitment as its value.

fn has_tapret_proof(&self) -> bool

Detects presence of a valid PSBT_OUT_TAPRET_PROOF.

fn tapret_proof(&self) -> Option<TaprootMerkleBranch>

Returns valid tapret commitment proof from the PSBT_OUT_TAPRET_PROOF key, if present. If the commitment is absent or invalid, returns None.

impl StructuralPartialEq for Output