1 // Copyright (c) 2009-2019 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_NODE_PSBT_H
6 #define BITCOIN_NODE_PSBT_H
7 
8 #include <psbt.h>
9 
10 #include <optional>
11 
12 /**
13  * Holds an analysis of one input from a PSBT
14  */
15 struct PSBTInputAnalysis {
16     bool has_utxo; //!< Whether we have UTXO information for this input
17     bool is_final; //!< Whether the input has all required information including signatures
18     PSBTRole next; //!< Which of the BIP 174 roles needs to handle this input next
19 
20     std::vector<CKeyID> missing_pubkeys; //!< Pubkeys whose BIP32 derivation path is missing
21     std::vector<CKeyID> missing_sigs;    //!< Pubkeys whose signatures are missing
22     uint160 missing_redeem_script;       //!< Hash160 of redeem script, if missing
23     uint256 missing_witness_script;      //!< SHA256 of witness script, if missing
24 };
25 
26 /**
27  * Holds the results of AnalyzePSBT (miscellaneous information about a PSBT)
28  */
29 struct PSBTAnalysis {
30     std::optional<size_t> estimated_vsize;      //!< Estimated weight of the transaction
31     std::optional<CFeeRate> estimated_feerate;  //!< Estimated feerate (fee / weight) of the transaction
32     std::optional<CAmount> fee;                 //!< Amount of fee being paid by the transaction
33     std::vector<PSBTInputAnalysis> inputs;      //!< More information about the individual inputs of the transaction
34     PSBTRole next;                              //!< Which of the BIP 174 roles needs to handle the transaction next
35     std::string error;                          //!< Error message
36 
SetInvalidPSBTAnalysis37     void SetInvalid(std::string err_msg)
38     {
39         estimated_vsize = std::nullopt;
40         estimated_feerate = std::nullopt;
41         fee = std::nullopt;
42         inputs.clear();
43         next = PSBTRole::CREATOR;
44         error = err_msg;
45     }
46 };
47 
48 /**
49  * Provides helpful miscellaneous information about where a PSBT is in the signing workflow.
50  *
51  * @param[in] psbtx the PSBT to analyze
52  * @return A PSBTAnalysis with information about the provided PSBT.
53  */
54 PSBTAnalysis AnalyzePSBT(PartiallySignedTransaction psbtx);
55 
56 #endif // BITCOIN_NODE_PSBT_H
57