Bitcoin Core  24.99.0
P2P Digital Currency
Functions
psbt.cpp File Reference
#include <psbt.h>
#include <policy/policy.h>
#include <util/check.h>
#include <util/strencodings.h>
Include dependency graph for psbt.cpp:

Go to the source code of this file.

Functions

bool PSBTInputSigned (const PSBTInput &input)
 Checks whether a PSBTInput is already signed by checking for non-null finalized fields. More...
 
bool PSBTInputSignedAndVerified (const PartiallySignedTransaction psbt, unsigned int input_index, const PrecomputedTransactionData *txdata)
 Checks whether a PSBTInput is already signed by doing script verification using final fields. More...
 
size_t CountPSBTUnsignedInputs (const PartiallySignedTransaction &psbt)
 Counts the unsigned inputs of a PSBT. More...
 
void UpdatePSBTOutput (const SigningProvider &provider, PartiallySignedTransaction &psbt, int index)
 Updates a PSBTOutput with information from provider. More...
 
PrecomputedTransactionData PrecomputePSBTData (const PartiallySignedTransaction &psbt)
 Compute a PrecomputedTransactionData object from a psbt. More...
 
bool SignPSBTInput (const SigningProvider &provider, PartiallySignedTransaction &psbt, int index, const PrecomputedTransactionData *txdata, int sighash, SignatureData *out_sigdata, bool finalize)
 Signs a PSBTInput, verifying that all provided data matches what is being signed. More...
 
bool FinalizePSBT (PartiallySignedTransaction &psbtx)
 Finalizes a PSBT if possible, combining partial signatures. More...
 
bool FinalizeAndExtractPSBT (PartiallySignedTransaction &psbtx, CMutableTransaction &result)
 Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized. More...
 
TransactionError CombinePSBTs (PartiallySignedTransaction &out, const std::vector< PartiallySignedTransaction > &psbtxs)
 Combines PSBTs with the same underlying transaction, resulting in a single PSBT with all partial signatures from each input. More...
 
std::string PSBTRoleName (PSBTRole role)
 
bool DecodeBase64PSBT (PartiallySignedTransaction &psbt, const std::string &base64_tx, std::string &error)
 Decode a base64ed PSBT into a PartiallySignedTransaction. More...
 
bool DecodeRawPSBT (PartiallySignedTransaction &psbt, Span< const std::byte > tx_data, std::string &error)
 Decode a raw (binary blob) PSBT into a PartiallySignedTransaction. More...
 

Function Documentation

◆ CombinePSBTs()

TransactionError CombinePSBTs ( PartiallySignedTransaction out,
const std::vector< PartiallySignedTransaction > &  psbtxs 
)

Combines PSBTs with the same underlying transaction, resulting in a single PSBT with all partial signatures from each input.

Parameters
[out]outthe combined PSBT, if successful
[in]psbtxsthe PSBTs to combine
Returns
error (OK if we successfully combined the transactions, other error if they were not compatible)

Definition at line 464 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CountPSBTUnsignedInputs()

size_t CountPSBTUnsignedInputs ( const PartiallySignedTransaction psbt)

Counts the unsigned inputs of a PSBT.

Definition at line 312 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DecodeBase64PSBT()

bool DecodeBase64PSBT ( PartiallySignedTransaction psbt,
const std::string &  base64_tx,
std::string &  error 
)

Decode a base64ed PSBT into a PartiallySignedTransaction.

Definition at line 489 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DecodeRawPSBT()

bool DecodeRawPSBT ( PartiallySignedTransaction psbt,
Span< const std::byte >  tx_data,
std::string &  error 
)

Decode a raw (binary blob) PSBT into a PartiallySignedTransaction.

Definition at line 499 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FinalizeAndExtractPSBT()

bool FinalizeAndExtractPSBT ( PartiallySignedTransaction psbtx,
CMutableTransaction result 
)

Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized.

Parameters
[in]psbtxPartiallySignedTransaction
[out]resultCMutableTransaction representing the complete transaction, if successful
Returns
True if we successfully extracted the transaction, false otherwise

Definition at line 448 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FinalizePSBT()

bool FinalizePSBT ( PartiallySignedTransaction psbtx)

Finalizes a PSBT if possible, combining partial signatures.

Parameters
[in,out]psbtxPartiallySignedTransaction to finalize return True if the PSBT is now complete, false otherwise

Definition at line 433 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PrecomputePSBTData()

PrecomputedTransactionData PrecomputePSBTData ( const PartiallySignedTransaction psbt)

Compute a PrecomputedTransactionData object from a psbt.

Definition at line 343 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PSBTInputSigned()

bool PSBTInputSigned ( const PSBTInput input)

Checks whether a PSBTInput is already signed by checking for non-null finalized fields.

Definition at line 278 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PSBTInputSignedAndVerified()

bool PSBTInputSignedAndVerified ( const PartiallySignedTransaction  psbt,
unsigned int  input_index,
const PrecomputedTransactionData txdata 
)

Checks whether a PSBTInput is already signed by doing script verification using final fields.

Definition at line 283 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PSBTRoleName()

std::string PSBTRoleName ( PSBTRole  role)

Definition at line 477 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SignPSBTInput()

bool SignPSBTInput ( const SigningProvider provider,
PartiallySignedTransaction psbt,
int  index,
const PrecomputedTransactionData txdata,
int  sighash = SIGHASH_ALL,
SignatureData out_sigdata = nullptr,
bool  finalize = true 
)

Signs a PSBTInput, verifying that all provided data matches what is being signed.

txdata should be the output of PrecomputePSBTData (which can be shared across multiple SignPSBTInput calls). If it is nullptr, a dummy signature will be created.

Definition at line 360 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ UpdatePSBTOutput()

void UpdatePSBTOutput ( const SigningProvider provider,
PartiallySignedTransaction psbt,
int  index 
)

Updates a PSBTOutput with information from provider.

This fills in the redeem_script, witness_script, and hd_keypaths where possible.

Definition at line 323 of file psbt.cpp.

Here is the call graph for this function:
Here is the caller graph for this function: