Struct psbt::Psbt

pub struct Psbt {
    pub psbt_version: PsbtVersion,
    pub tx_version: u32,
    pub fallback_locktime: Option<LockTime>,
    pub inputs: Vec<Input>,
    pub outputs: Vec<Output>,
    pub xpub: BTreeMap<ExtendedPubKey, KeySource>,
    pub proprietary: BTreeMap<ProprietaryKey, Vec<u8>>,
    pub unknown: BTreeMap<Key, Vec<u8>>,
}

Fields

psbt_version: PsbtVersion

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

tx_version: u32

Transaction version.

fallback_locktime: Option<LockTime>

Fallback locktime (used if none of the inputs specifies their locktime).

inputs: Vec<Input>

The corresponding key-value map for each input.

outputs: Vec<Output>

The corresponding key-value map for each output.

xpub: BTreeMap<ExtendedPubKey, KeySource>

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

proprietary: BTreeMap<ProprietaryKey, Vec<u8>>

Global proprietary key-value pairs.

unknown: BTreeMap<Key, Vec<u8>>

Unknown global key-value pairs.

Implementations

impl Psbt

pub fn with(tx: Transaction, psbt_version: PsbtVersion) -> Result<Self, TxError>

Checks that unsigned transaction does not have scriptSig’s or witness data

pub fn lock_time(&self) -> LockTime

pub fn fee(&self) -> Result<u64, FeeError>

Returns fee for a transaction, or returns error reporting resolver problem or wrong transaction structure

pub fn to_txid(&self) -> Txid

Returns transaction ID for an unsigned transaction. For SegWit transactions this is equal to the signed transaction id.

pub fn to_unsigned_tx(&self) -> Transaction

Constructs transaction with empty scriptSig and witness

pub fn into_unsigned_tx(self) -> Transaction

Returns transaction with empty scriptSig and witness

pub fn extract_signed_tx(&self) -> Transaction

Extract the (partially) signed transaction from this PSBT by filling in the available signature information in place.

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

Combines this Psbt 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)

impl Psbt

Extension trait for Psbt for working with proprietary LNPBP4 keys.

pub fn lnpbp4_protocol_info(
    &self,
    protocol_id: ProtocolId
) -> Result<Lnpbp4Info, Lnpbp4KeyError>

Returns an information about the given LNPBP4 ProtocolId, if any.

Errors

If the key is present, but it’s value can’t be deserialized as a valid protocol information block.

pub fn set_lnpbp4_protocol_info(
    &mut self,
    protocol_id: ProtocolId,
    hash_tag: Option<String>,
    inner_id: Option<Slice32>
) -> Result<bool, Lnpbp4KeyError>

Adds LNPBP4 protocol information.

Returns

true, if the protocol information was successfully added, false if it was already present.

Errors

If the key for the given ProtocolId is already present and the information was different.

impl Psbt

pub fn construct<'inputs, 'outputs>(
    descriptor: &Descriptor<DerivationAccount>,
    inputs: impl IntoIterator<Item = &'inputs InputDescriptor>,
    outputs: impl IntoIterator<Item = &'outputs (PubkeyScript, u64)>,
    change_index: impl Into<UnhardenedIndex>,
    fee: u64,
    tapret: Option<&DfsPath>,
    tx_resolver: &impl ResolveTx
) -> Result<Psbt, Error>

Trait Implementations

impl Clone for Psbt

fn clone(&self) -> Psbt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Psbt

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

Formats the value using the given formatter.

impl Default for Psbt

fn default() -> Psbt

Returns the “default value” for a type.

impl Deserialize for Psbt

fn deserialize(bytes: &[u8]) -> Result<Self, Error>

Deserialize a value from raw data.

impl Display for Psbt

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

Formats the value using the given formatter.

impl From<PartiallySignedTransaction> for Psbt

fn from(v0: PsbtV0) -> Self

Converts to this type from the input type.

impl From<Psbt> for PsbtV0

fn from(psbt: Psbt) -> Self

Converts to this type from the input type.

impl FromStr for Psbt

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl LexOrder for Psbt

fn lex_order(&mut self)

fn lex_ordered(self) -> Self where
    Self: Sized, 

impl PartialEq<Psbt> for Psbt

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

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

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

This method tests for !=.

impl Serialize for Psbt

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl StrictDecode for Psbt

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for Psbt

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for Psbt

impl StructuralEq for Psbt

impl StructuralPartialEq for Psbt