psbt.cpp File Reference

#include <psbt.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. 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)
	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, const std::string &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]	out	the combined PSBT, if successful
[in]	psbtxs	the PSBTs to combine

Returns

error (OK if we successfully combined the transactions, other error if they were not compatible)

Definition at line 349 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 202 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 374 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,
		const std::string &	tx_data,
		std::string &	error
	)

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

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

Returns

True if we successfully extracted the transaction, false otherwise

Definition at line 333 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 318 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 233 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.

Definition at line 197 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 362 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
	)

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 250 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 213 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: