Type Alias bitcoin::util::psbt::Psbt

pub type Psbt = PartiallySignedTransaction;

Partially signed transaction, commonly referred to as a PSBT.

Aliased Type

struct Psbt {
    pub unsigned_tx: Transaction,
    pub version: u32,
    pub xpub: BTreeMap<ExtendedPubKey, (Fingerprint, DerivationPath), Global>,
    pub proprietary: BTreeMap<ProprietaryKey<u8>, Vec<u8, Global>, Global>,
    pub unknown: BTreeMap<Key, Vec<u8, Global>, Global>,
    pub inputs: Vec<Input, Global>,
    pub outputs: Vec<Output, Global>,
}

Fields

unsigned_tx: Transaction

The unsigned transaction, scriptSigs and witnesses for each input must be empty.

version: u32

The version number of this PSBT. If omitted, the version number is 0.

xpub: BTreeMap<ExtendedPubKey, (Fingerprint, DerivationPath), Global>

A global map from extended public keys to the used key fingerprint and derivation path as defined by BIP 32.

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

Global proprietary key-value pairs.

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

Unknown global key-value pairs.

inputs: Vec<Input, Global>

The corresponding key-value map for each input in the unsigned transaction.

outputs: Vec<Output, Global>

The corresponding key-value map for each output in the unsigned transaction.

Implementations

impl PartiallySignedTransaction

pub fn iter_funding_utxos(&self) -> impl Iterator<Item = Result<&TxOut, Error>>

Returns an iterator for the funding UTXOs of the psbt

For each PSBT input that contains UTXO information Ok is returned containing that information. The order of returned items is same as the order of inputs.

Errors

The function returns error when UTXO information is not present or is invalid.

Panics

The function panics if the length of transaction inputs is not equal to the length of PSBT inputs.

pub fn from_unsigned_tx(tx: Transaction) -> Result<Self, Error>

Creates a PSBT from an unsigned transaction.

Errors

If transactions is not unsigned.

pub fn extract_tx(self) -> Transaction

Extracts the Transaction from a PSBT by filling in the available signature information.

pub fn combine(&mut self, other: Self) -> Result<(), Error>

Combines this PartiallySignedTransaction with other PSBT as described by BIP 174.

In accordance with BIP 174 this function is commutative i.e., A.combine(B) == B.combine(A)

Trait Implementations

impl Clone for PartiallySignedTransaction

fn clone(&self) -> PartiallySignedTransaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartiallySignedTransaction

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

Formats the value using the given formatter.

impl Decodable for PartiallySignedTransaction

fn consensus_decode_from_finite_reader<R: Read + ?Sized>( r: &mut R ) -> Result<Self, Error>

Decode Self from a size-limited reader.

fn consensus_decode<R: Read + ?Sized>(reader: &mut R) -> Result<Self, Error>

Decode an object with a well-defined format.

impl<'de> Deserialize<'de> for PartiallySignedTransaction

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

Deserialize this value from the given Serde deserializer.

impl Encodable for PartiallySignedTransaction

fn consensus_encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<usize, Error>

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

impl Hash for PartiallySignedTransaction

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 PartialEq<PartiallySignedTransaction> for PartiallySignedTransaction

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PartiallySignedTransaction

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 PartiallySignedTransaction

impl StructuralEq for PartiallySignedTransaction

impl StructuralPartialEq for PartiallySignedTransaction