psbt.h File Reference

#include <attributes.h>
#include <node/transaction.h>
#include <optional.h>
#include <policy/feerate.h>
#include <primitives/transaction.h>
#include <pubkey.h>
#include <script/sign.h>
#include <script/signingprovider.h>

Include dependency graph for psbt.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PSBTInput
	A structure for PSBTs which contain per-input information. More...
struct	PSBTOutput
	A structure for PSBTs which contains per output information. More...
struct	PartiallySignedTransaction
	A version of CTransaction with the PSBT format. More...

Enumerations
enum	PSBTRole {   PSBTRole::CREATOR, PSBTRole::UPDATER, PSBTRole::SIGNER, PSBTRole::FINALIZER,   PSBTRole::EXTRACTOR }

Functions
std::string	PSBTRoleName (PSBTRole role)
bool	PSBTInputSigned (const PSBTInput &input)
	Checks whether a PSBTInput is already signed. More...
bool	SignPSBTInput (const SigningProvider &provider, PartiallySignedTransaction &psbt, int index, int sighash=SIGHASH_ALL, SignatureData *out_sigdata=nullptr, bool use_dummy=false)
	Signs a PSBTInput, verifying that all provided data matches what is being 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...
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...
NODISCARD 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...
NODISCARD bool	DecodeBase64PSBT (PartiallySignedTransaction &decoded_psbt, const std::string &base64_psbt, std::string &error)
	Decode a base64ed PSBT into a PartiallySignedTransaction. More...
NODISCARD bool	DecodeRawPSBT (PartiallySignedTransaction &decoded_psbt, const std::string &raw_psbt, std::string &error)
	Decode a raw (binary blob) PSBT into a PartiallySignedTransaction. More...

Variables
static constexpr uint8_t	PSBT_MAGIC_BYTES [5] = {'p', 's', 'b', 't', 0xff}
static constexpr uint8_t	PSBT_GLOBAL_UNSIGNED_TX = 0x00
static constexpr uint8_t	PSBT_IN_NON_WITNESS_UTXO = 0x00
static constexpr uint8_t	PSBT_IN_WITNESS_UTXO = 0x01
static constexpr uint8_t	PSBT_IN_PARTIAL_SIG = 0x02
static constexpr uint8_t	PSBT_IN_SIGHASH = 0x03
static constexpr uint8_t	PSBT_IN_REDEEMSCRIPT = 0x04
static constexpr uint8_t	PSBT_IN_WITNESSSCRIPT = 0x05
static constexpr uint8_t	PSBT_IN_BIP32_DERIVATION = 0x06
static constexpr uint8_t	PSBT_IN_SCRIPTSIG = 0x07
static constexpr uint8_t	PSBT_IN_SCRIPTWITNESS = 0x08
static constexpr uint8_t	PSBT_OUT_REDEEMSCRIPT = 0x00
static constexpr uint8_t	PSBT_OUT_WITNESSSCRIPT = 0x01
static constexpr uint8_t	PSBT_OUT_BIP32_DERIVATION = 0x02
static constexpr uint8_t	PSBT_SEPARATOR = 0x00
const std::streamsize	MAX_FILE_SIZE_PSBT = 100000000

Enumeration Type Documentation

enum PSBTRole

strong

Enumerator
CREATOR
UPDATER
SIGNER
FINALIZER
EXTRACTOR

Definition at line 559 of file psbt.h.

Function Documentation

NODISCARD 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 325 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

size_t CountPSBTUnsignedInputs

(

const PartiallySignedTransaction &

psbt

)

Counts the unsigned inputs of a PSBT.

Definition at line 197 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NODISCARD bool DecodeBase64PSBT	(	PartiallySignedTransaction &	decoded_psbt,
		const std::string &	base64_psbt,
		std::string &	error
	)

Decode a base64ed PSBT into a PartiallySignedTransaction.

Definition at line 350 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NODISCARD bool DecodeRawPSBT	(	PartiallySignedTransaction &	decoded_psbt,
		const std::string &	raw_psbt,
		std::string &	error
	)

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

Definition at line 361 of file psbt.cpp.

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool PSBTInputSigned

(

const PSBTInput &

input

)

Checks whether a PSBTInput is already signed.

Definition at line 192 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string PSBTRoleName

(

PSBTRole

role

)

Definition at line 338 of file psbt.cpp.

Here is the caller graph for this function:

bool SignPSBTInput	(	const SigningProvider &	provider,
		PartiallySignedTransaction &	psbt,
		int	index,
		int	sighash = SIGHASH_ALL,
		SignatureData *	out_sigdata = nullptr,
		bool	use_dummy = false
	)

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

Definition at line 227 of file psbt.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

const std::streamsize MAX_FILE_SIZE_PSBT = 100000000

Definition at line 45 of file psbt.h.

constexpr uint8_t PSBT_GLOBAL_UNSIGNED_TX = 0x00

static

Definition at line 21 of file psbt.h.

constexpr uint8_t PSBT_IN_BIP32_DERIVATION = 0x06

static

Definition at line 30 of file psbt.h.

constexpr uint8_t PSBT_IN_NON_WITNESS_UTXO = 0x00

static

Definition at line 24 of file psbt.h.

constexpr uint8_t PSBT_IN_PARTIAL_SIG = 0x02

static

Definition at line 26 of file psbt.h.

constexpr uint8_t PSBT_IN_REDEEMSCRIPT = 0x04

static

Definition at line 28 of file psbt.h.

constexpr uint8_t PSBT_IN_SCRIPTSIG = 0x07

static

Definition at line 31 of file psbt.h.

constexpr uint8_t PSBT_IN_SCRIPTWITNESS = 0x08

static

Definition at line 32 of file psbt.h.

constexpr uint8_t PSBT_IN_SIGHASH = 0x03

static

Definition at line 27 of file psbt.h.

constexpr uint8_t PSBT_IN_WITNESS_UTXO = 0x01

static

Definition at line 25 of file psbt.h.

constexpr uint8_t PSBT_IN_WITNESSSCRIPT = 0x05

static

Definition at line 29 of file psbt.h.

constexpr uint8_t PSBT_MAGIC_BYTES[5] = {'p', 's', 'b', 't', 0xff}

static

Definition at line 18 of file psbt.h.

constexpr uint8_t PSBT_OUT_BIP32_DERIVATION = 0x02

static

Definition at line 37 of file psbt.h.

constexpr uint8_t PSBT_OUT_REDEEMSCRIPT = 0x00

static

Definition at line 35 of file psbt.h.

constexpr uint8_t PSBT_OUT_WITNESSSCRIPT = 0x01

static

Definition at line 36 of file psbt.h.

constexpr uint8_t PSBT_SEPARATOR = 0x00

static

Definition at line 41 of file psbt.h.