psbt.cpp File Reference

#include <psbt.h>
#include <common/types.h>
#include <node/types.h>
#include <policy/policy.h>
#include <script/signingprovider.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...
PSBTError	SignPSBTInput (const SigningProvider &provider, PartiallySignedTransaction &psbt, int index, const PrecomputedTransactionData *txdata, std::optional< int > sighash, SignatureData *out_sigdata, bool finalize)
	Signs a PSBTInput, verifying that all provided data matches what is being signed. More...
void	RemoveUnnecessaryTransactions (PartiallySignedTransaction &psbtx)
	Reduces the size of the PSBT by dropping unnecessary non_witness_utxos (i.e. 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...
bool	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, std::span< const std::byte > tx_data, std::string &error)
	Decode a raw (binary blob) PSBT into a PartiallySignedTransaction. More...

Function Documentation

CombinePSBTs()

bool 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]	out	the combined PSBT, if successful
[in]	psbtxs	the PSBTs to combine

Returns

True if we successfully combined the transactions, false if they were not compatible

Definition at line 583 of file psbt.cpp.

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 354 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 608 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,
		std::span< const std::byte >	tx_data,
		std::string &	error
	)

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

Definition at line 618 of file psbt.cpp.

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]	psbtx	PartiallySignedTransaction
[out]	result	CMutableTransaction representing the complete transaction, if successful

Returns

True if we successfully extracted the transaction, false otherwise

Definition at line 567 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]

psbtx

PartiallySignedTransaction to finalize return True if the PSBT is now complete, false otherwise

Definition at line 551 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 385 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 320 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 325 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 596 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveUnnecessaryTransactions()

void RemoveUnnecessaryTransactions

(

PartiallySignedTransaction &

psbtx

)

Reduces the size of the PSBT by dropping unnecessary non_witness_utxos (i.e.

complete previous transactions) from a psbt when all inputs are segwit v1.

Definition at line 514 of file psbt.cpp.

Here is the caller graph for this function:

SignPSBTInput()

PSBTError SignPSBTInput	(	const SigningProvider &	provider,
		PartiallySignedTransaction &	psbt,
		int	index,
		const PrecomputedTransactionData *	txdata,
		std::optional< int >	sighash = std::nullopt,
		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 402 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 365 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: