Branch data Line data Source code
1 : : // Copyright (c) 2009-present 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_PSBT_H
6 : : #define BITCOIN_PSBT_H
7 : :
8 : : #include <common/types.h>
9 : : #include <musig.h>
10 : : #include <node/transaction.h>
11 : : #include <policy/feerate.h>
12 : : #include <primitives/transaction.h>
13 : : #include <pubkey.h>
14 : : #include <script/keyorigin.h>
15 : : #include <script/sign.h>
16 : : #include <script/signingprovider.h>
17 : : #include <span.h>
18 : : #include <streams.h>
19 : : #include <uint256.h>
20 : : #include <util/result.h>
21 : : #include <util/expected.h>
22 : :
23 : : #include <optional>
24 : : #include <bitset>
25 : :
26 : : namespace node {
27 : : enum class TransactionError;
28 : : } // namespace node
29 : :
30 : : using common::PSBTError;
31 : :
32 : : // Magic bytes
33 : : inline constexpr uint8_t PSBT_MAGIC_BYTES[5] = {'p', 's', 'b', 't', 0xff};
34 : :
35 : : // Global types
36 : : inline constexpr uint8_t PSBT_GLOBAL_UNSIGNED_TX = 0x00;
37 : : inline constexpr uint8_t PSBT_GLOBAL_XPUB = 0x01;
38 : : inline constexpr uint8_t PSBT_GLOBAL_TX_VERSION = 0x02;
39 : : inline constexpr uint8_t PSBT_GLOBAL_FALLBACK_LOCKTIME = 0x03;
40 : : inline constexpr uint8_t PSBT_GLOBAL_INPUT_COUNT = 0x04;
41 : : inline constexpr uint8_t PSBT_GLOBAL_OUTPUT_COUNT = 0x05;
42 : : inline constexpr uint8_t PSBT_GLOBAL_TX_MODIFIABLE = 0x06;
43 : : inline constexpr uint8_t PSBT_GLOBAL_VERSION = 0xFB;
44 : : inline constexpr uint8_t PSBT_GLOBAL_PROPRIETARY = 0xFC;
45 : :
46 : : // Input types
47 : : inline constexpr uint8_t PSBT_IN_NON_WITNESS_UTXO = 0x00;
48 : : inline constexpr uint8_t PSBT_IN_WITNESS_UTXO = 0x01;
49 : : inline constexpr uint8_t PSBT_IN_PARTIAL_SIG = 0x02;
50 : : inline constexpr uint8_t PSBT_IN_SIGHASH = 0x03;
51 : : inline constexpr uint8_t PSBT_IN_REDEEMSCRIPT = 0x04;
52 : : inline constexpr uint8_t PSBT_IN_WITNESSSCRIPT = 0x05;
53 : : inline constexpr uint8_t PSBT_IN_BIP32_DERIVATION = 0x06;
54 : : inline constexpr uint8_t PSBT_IN_SCRIPTSIG = 0x07;
55 : : inline constexpr uint8_t PSBT_IN_SCRIPTWITNESS = 0x08;
56 : : inline constexpr uint8_t PSBT_IN_RIPEMD160 = 0x0A;
57 : : inline constexpr uint8_t PSBT_IN_SHA256 = 0x0B;
58 : : inline constexpr uint8_t PSBT_IN_HASH160 = 0x0C;
59 : : inline constexpr uint8_t PSBT_IN_HASH256 = 0x0D;
60 : : inline constexpr uint8_t PSBT_IN_PREVIOUS_TXID = 0x0e;
61 : : inline constexpr uint8_t PSBT_IN_OUTPUT_INDEX = 0x0f;
62 : : inline constexpr uint8_t PSBT_IN_SEQUENCE = 0x10;
63 : : inline constexpr uint8_t PSBT_IN_REQUIRED_TIME_LOCKTIME = 0x11;
64 : : inline constexpr uint8_t PSBT_IN_REQUIRED_HEIGHT_LOCKTIME = 0x12;
65 : : inline constexpr uint8_t PSBT_IN_TAP_KEY_SIG = 0x13;
66 : : inline constexpr uint8_t PSBT_IN_TAP_SCRIPT_SIG = 0x14;
67 : : inline constexpr uint8_t PSBT_IN_TAP_LEAF_SCRIPT = 0x15;
68 : : inline constexpr uint8_t PSBT_IN_TAP_BIP32_DERIVATION = 0x16;
69 : : inline constexpr uint8_t PSBT_IN_TAP_INTERNAL_KEY = 0x17;
70 : : inline constexpr uint8_t PSBT_IN_TAP_MERKLE_ROOT = 0x18;
71 : : inline constexpr uint8_t PSBT_IN_MUSIG2_PARTICIPANT_PUBKEYS = 0x1a;
72 : : inline constexpr uint8_t PSBT_IN_MUSIG2_PUB_NONCE = 0x1b;
73 : : inline constexpr uint8_t PSBT_IN_MUSIG2_PARTIAL_SIG = 0x1c;
74 : : inline constexpr uint8_t PSBT_IN_PROPRIETARY = 0xFC;
75 : :
76 : : // Output types
77 : : inline constexpr uint8_t PSBT_OUT_REDEEMSCRIPT = 0x00;
78 : : inline constexpr uint8_t PSBT_OUT_WITNESSSCRIPT = 0x01;
79 : : inline constexpr uint8_t PSBT_OUT_BIP32_DERIVATION = 0x02;
80 : : inline constexpr uint8_t PSBT_OUT_AMOUNT = 0x03;
81 : : inline constexpr uint8_t PSBT_OUT_SCRIPT = 0x04;
82 : : inline constexpr uint8_t PSBT_OUT_TAP_INTERNAL_KEY = 0x05;
83 : : inline constexpr uint8_t PSBT_OUT_TAP_TREE = 0x06;
84 : : inline constexpr uint8_t PSBT_OUT_TAP_BIP32_DERIVATION = 0x07;
85 : : inline constexpr uint8_t PSBT_OUT_MUSIG2_PARTICIPANT_PUBKEYS = 0x08;
86 : : inline constexpr uint8_t PSBT_OUT_PROPRIETARY = 0xFC;
87 : :
88 : : // The separator is 0x00. Reading this in means that the unserializer can interpret it
89 : : // as a 0 length key which indicates that this is the separator. The separator has no value.
90 : : inline constexpr uint8_t PSBT_SEPARATOR = 0x00;
91 : :
92 : : // BIP 174 does not specify a maximum file size, but we set a limit anyway
93 : : // to prevent reading a stream indefinitely and running out of memory.
94 : : inline constexpr std::streamsize MAX_FILE_SIZE_PSBT{100'000'000}; // 100 MB
95 : :
96 : : // PSBT version number
97 : : inline constexpr uint32_t PSBT_HIGHEST_VERSION = 2;
98 : :
99 : : /** A structure for PSBT proprietary types */
100 : 0 : struct PSBTProprietary
101 : : {
102 : : uint64_t subtype;
103 : : std::vector<unsigned char> identifier;
104 : : std::vector<unsigned char> key;
105 : : std::vector<unsigned char> value;
106 : :
107 : 15 : bool operator<(const PSBTProprietary &b) const {
108 : 15 : return key < b.key;
109 : : }
110 : : bool operator==(const PSBTProprietary &b) const {
111 : : return key == b.key;
112 : : }
113 : : };
114 : :
115 : : // Takes a stream and multiple arguments and serializes them as if first serialized into a vector and then into the stream
116 : : // The resulting output into the stream has the total serialized length of all of the objects followed by all objects concatenated with each other.
117 : : template<typename Stream, typename... X>
118 : 17 : void SerializeToVector(Stream& s, const X&... args)
119 : : {
120 : 17 : SizeComputer sizecomp;
121 : 17 : SerializeMany(sizecomp, args...);
122 : 17 : WriteCompactSize(s, sizecomp.size());
123 : 17 : SerializeMany(s, args...);
124 : 17 : }
125 : :
126 : : // Takes a stream and multiple arguments and unserializes them first as a vector then each object individually in the order provided in the arguments
127 : : template<typename Stream, typename... X>
128 : 130 : void UnserializeFromVector(Stream& s, X&&... args)
129 : : {
130 [ - + ]: 130 : size_t expected_size = ReadCompactSize(s);
131 : 130 : size_t remaining_before = s.size();
132 [ - + ]: 130 : UnserializeMany(s, args...);
133 : 130 : size_t remaining_after = s.size();
134 [ - + ]: 130 : if (remaining_after + expected_size != remaining_before) {
135 [ # # ]: 0 : throw std::ios_base::failure("Size of value was not the stated size");
136 : : }
137 : 130 : }
138 : :
139 : : // Deserialize bytes of given length from the stream as a KeyOriginInfo
140 : : template<typename Stream>
141 : 0 : KeyOriginInfo DeserializeKeyOrigin(Stream& s, uint64_t length)
142 : : {
143 : : // Read in key path
144 [ # # # # ]: 0 : if (length % 4 || length == 0) {
145 [ # # ]: 0 : throw std::ios_base::failure("Invalid length for HD key path");
146 : : }
147 : :
148 : 0 : KeyOriginInfo hd_keypath;
149 [ # # ]: 0 : s >> hd_keypath.fingerprint;
150 [ # # ]: 0 : for (unsigned int i = 4; i < length; i += sizeof(uint32_t)) {
151 : : uint32_t index;
152 : 0 : s >> index;
153 [ # # ]: 0 : hd_keypath.path.push_back(index);
154 : : }
155 : 0 : return hd_keypath;
156 : 0 : }
157 : :
158 : : // Deserialize a length prefixed KeyOriginInfo from a stream
159 : : template<typename Stream>
160 : 0 : void DeserializeHDKeypath(Stream& s, KeyOriginInfo& hd_keypath)
161 : : {
162 : 0 : hd_keypath = DeserializeKeyOrigin(s, ReadCompactSize(s));
163 : 0 : }
164 : :
165 : : // Deserialize HD keypaths into a map
166 : : template<typename Stream>
167 [ # # ]: 0 : void DeserializeHDKeypaths(Stream& s, const std::vector<unsigned char>& key, std::map<CPubKey, KeyOriginInfo>& hd_keypaths)
168 : : {
169 : : // Make sure that the key is the size of pubkey + 1
170 [ # # # # ]: 0 : if (key.size() != CPubKey::SIZE + 1 && key.size() != CPubKey::COMPRESSED_SIZE + 1) {
171 [ # # ]: 0 : throw std::ios_base::failure("Size of key was not the expected size for the type BIP32 keypath");
172 : : }
173 : : // Read in the pubkey from key
174 : 0 : CPubKey pubkey(key.begin() + 1, key.end());
175 [ # # ]: 0 : if (!pubkey.IsFullyValid()) {
176 [ # # ]: 0 : throw std::ios_base::failure("Invalid pubkey");
177 : : }
178 : :
179 : 0 : KeyOriginInfo keypath;
180 [ # # ]: 0 : DeserializeHDKeypath(s, keypath);
181 : :
182 : : // Add to map
183 [ # # ]: 0 : hd_keypaths.emplace(pubkey, std::move(keypath));
184 : 0 : }
185 : :
186 : : // Serialize a KeyOriginInfo to a stream
187 : : template<typename Stream>
188 : 6 : void SerializeKeyOrigin(Stream& s, KeyOriginInfo hd_keypath)
189 : : {
190 : 6 : s << hd_keypath.fingerprint;
191 [ + + ]: 24 : for (const auto& path : hd_keypath.path) {
192 : 18 : s << path;
193 : : }
194 : 6 : }
195 : :
196 : : // Serialize a length prefixed KeyOriginInfo to a stream
197 : : template<typename Stream>
198 : 6 : void SerializeHDKeypath(Stream& s, KeyOriginInfo hd_keypath)
199 : : {
200 [ - + ]: 6 : WriteCompactSize(s, (hd_keypath.path.size() + 1) * sizeof(uint32_t));
201 [ + - ]: 6 : SerializeKeyOrigin(s, hd_keypath);
202 : 6 : }
203 : :
204 : : // Serialize HD keypaths to a stream from a map
205 : : template<typename Stream>
206 : 4 : void SerializeHDKeypaths(Stream& s, const std::map<CPubKey, KeyOriginInfo>& hd_keypaths, CompactSizeWriter type)
207 : : {
208 [ + + ]: 10 : for (const auto& keypath_pair : hd_keypaths) {
209 [ - + ]: 6 : if (!keypath_pair.first.IsValid()) {
210 [ # # ]: 0 : throw std::ios_base::failure("Invalid CPubKey being serialized");
211 : : }
212 : 6 : SerializeToVector(s, type, std::span{keypath_pair.first});
213 [ + - ]: 12 : SerializeHDKeypath(s, keypath_pair.second);
214 : : }
215 : 4 : }
216 : :
217 : : // Deserialize a PSBT_{IN/OUT}_MUSIG2_PARTICIPANT_PUBKEYS field
218 : : template<typename Stream>
219 : 0 : void DeserializeMuSig2ParticipantPubkeys(Stream& s, SpanReader& skey, std::map<CPubKey, std::vector<CPubKey>>& out, std::string context)
220 : : {
221 : : std::array<unsigned char, CPubKey::COMPRESSED_SIZE> agg_pubkey_bytes;
222 : 0 : skey >> std::as_writable_bytes(std::span{agg_pubkey_bytes});
223 : 0 : CPubKey agg_pubkey(agg_pubkey_bytes);
224 [ # # ]: 0 : if (!agg_pubkey.IsFullyValid()) {
225 [ # # # # ]: 0 : throw std::ios_base::failure(context + " musig2 aggregate pubkey is invalid");
226 : : }
227 : :
228 : 0 : std::vector<CPubKey> participants;
229 [ # # ]: 0 : std::vector<unsigned char> val;
230 [ # # ]: 0 : s >> val;
231 : 0 : SpanReader s_val{val};
232 [ # # ]: 0 : while (s_val.size() >= CPubKey::COMPRESSED_SIZE) {
233 : : std::array<unsigned char, CPubKey::COMPRESSED_SIZE> part_pubkey_bytes;
234 [ # # ]: 0 : s_val >> std::as_writable_bytes(std::span{part_pubkey_bytes});
235 : 0 : CPubKey participant(part_pubkey_bytes);
236 [ # # # # ]: 0 : if (!participant.IsFullyValid()) {
237 [ # # # # ]: 0 : throw std::ios_base::failure(context + " musig2 participant pubkey is invalid");
238 : : }
239 [ # # ]: 0 : participants.push_back(participant);
240 : : }
241 [ # # ]: 0 : if (!s_val.empty()) {
242 [ # # # # ]: 0 : throw std::ios_base::failure(context + " musig2 participants pubkeys value size is not a multiple of 33");
243 : : }
244 : :
245 [ # # ]: 0 : out.emplace(agg_pubkey, participants);
246 : 0 : }
247 : :
248 : : // Deserialize the MuSig2 participant identifiers from PSBT_MUSIG2_{PUBNONCE/PARTIAL_SIG} fields
249 : : // Both fields contain the same data after the type byte - aggregate pubkey | participant pubkey | leaf script hash
250 : : template<typename Stream>
251 : 0 : void DeserializeMuSig2ParticipantDataIdentifier(Stream& skey, CPubKey& agg_pub, CPubKey& part_pub, uint256& leaf_hash)
252 : : {
253 : 0 : leaf_hash.SetNull();
254 : :
255 : : std::array<unsigned char, CPubKey::COMPRESSED_SIZE> part_pubkey_bytes;
256 : : std::array<unsigned char, CPubKey::COMPRESSED_SIZE> agg_pubkey_bytes;
257 : :
258 : 0 : skey >> std::as_writable_bytes(std::span{part_pubkey_bytes}) >> std::as_writable_bytes(std::span{agg_pubkey_bytes});
259 : 0 : agg_pub.Set(agg_pubkey_bytes.begin(), agg_pubkey_bytes.end());
260 [ # # ]: 0 : if (!agg_pub.IsFullyValid()) {
261 [ # # ]: 0 : throw std::ios_base::failure("musig2 aggregate pubkey is invalid");
262 : : }
263 : :
264 : 0 : part_pub.Set(part_pubkey_bytes.begin(), part_pubkey_bytes.end());
265 [ # # ]: 0 : if (!part_pub.IsFullyValid()) {
266 [ # # ]: 0 : throw std::ios_base::failure("musig2 participant pubkey is invalid");
267 : : }
268 : :
269 [ # # ]: 0 : if (!skey.empty()) {
270 : 0 : skey >> leaf_hash;
271 : : }
272 : 0 : }
273 : :
274 : 142 : static inline void ExpectedKeySize(const std::string& key_name, const std::vector<unsigned char>& key, uint64_t expected_size) {
275 [ - + - + ]: 142 : if (key.size() != expected_size) {
276 [ # # # # ]: 0 : throw std::ios_base::failure(tfm::format("Size of key was not %d for the type %s", expected_size, key_name));
277 : : }
278 : 142 : }
279 : :
280 : : /** A structure for PSBTs which contain per-input information */
281 : : class PSBTInput
282 : : {
283 : : private:
284 : : uint32_t m_psbt_version;
285 : :
286 : : public:
287 : : CTransactionRef non_witness_utxo;
288 : : CTxOut witness_utxo;
289 : : CScript redeem_script;
290 : : CScript witness_script;
291 : : CScript final_script_sig;
292 : : CScriptWitness final_script_witness;
293 : : std::map<CPubKey, KeyOriginInfo> hd_keypaths;
294 : : std::map<CKeyID, SigPair> partial_sigs;
295 : : std::map<uint160, std::vector<unsigned char>> ripemd160_preimages;
296 : : std::map<uint256, std::vector<unsigned char>> sha256_preimages;
297 : : std::map<uint160, std::vector<unsigned char>> hash160_preimages;
298 : : std::map<uint256, std::vector<unsigned char>> hash256_preimages;
299 : :
300 : : Txid prev_txid;
301 : : uint32_t prev_out;
302 : : std::optional<uint32_t> sequence;
303 : : std::optional<uint32_t> time_locktime;
304 : : std::optional<uint32_t> height_locktime;
305 : :
306 : : // Taproot fields
307 : : std::vector<unsigned char> m_tap_key_sig;
308 : : std::map<std::pair<XOnlyPubKey, uint256>, std::vector<unsigned char>> m_tap_script_sigs;
309 : : std::map<std::pair<std::vector<unsigned char>, int>, std::set<std::vector<unsigned char>, ShortestVectorFirstComparator>> m_tap_scripts;
310 : : std::map<XOnlyPubKey, std::pair<std::set<uint256>, KeyOriginInfo>> m_tap_bip32_paths;
311 : : XOnlyPubKey m_tap_internal_key;
312 : : uint256 m_tap_merkle_root;
313 : :
314 : : // MuSig2 fields
315 : : std::map<CPubKey, std::vector<CPubKey>> m_musig2_participants;
316 : : // Key is the aggregate pubkey and the script leaf hash, value is a map of participant pubkey to pubnonce
317 : : std::map<std::pair<CPubKey, uint256>, std::map<CPubKey, std::vector<uint8_t>>> m_musig2_pubnonces;
318 : : // Key is the aggregate pubkey and the script leaf hash, value is a map of participant pubkey to partial_sig
319 : : std::map<std::pair<CPubKey, uint256>, std::map<CPubKey, uint256>> m_musig2_partial_sigs;
320 : :
321 : : std::map<std::vector<unsigned char>, std::vector<unsigned char>> unknown;
322 : : std::set<PSBTProprietary> m_proprietary;
323 : : std::optional<int> sighash_type;
324 : :
325 : : void FillSignatureData(SignatureData& sigdata) const;
326 : : void FromSignatureData(const SignatureData& sigdata);
327 : : void Merge(const PSBTInput& input);
328 : 15 : uint32_t GetVersion() const { return m_psbt_version; }
329 : : COutPoint GetOutPoint() const;
330 : : /**
331 : : * Retrieves the UTXO for this input
332 : : *
333 : : * @param[out] utxo The UTXO of this input
334 : : * @return Whether the UTXO could be retrieved
335 : : */
336 : : bool GetUTXO(CTxOut& utxo) const;
337 : : bool HasSignatures() const;
338 : :
339 : 19 : explicit PSBTInput(uint32_t psbt_version, const Txid& prev_txid, uint32_t prev_out, std::optional<uint32_t> sequence = std::nullopt)
340 : 19 : : m_psbt_version(psbt_version),
341 : 19 : prev_txid(prev_txid),
342 [ - + ]: 19 : prev_out(prev_out),
343 [ - + ]: 19 : sequence(sequence)
344 : : {
345 [ - + ]: 19 : assert(m_psbt_version == 0 || m_psbt_version == 2);
346 : 19 : }
347 : :
348 : : // Construct a PSBTInput when the previous txid and output index are expected to be serialized
349 : : template <typename Stream>
350 : 21 : explicit PSBTInput(deserialize_type, Stream& s, uint32_t psbt_version)
351 [ - + ]: 21 : : m_psbt_version(psbt_version)
352 : : {
353 [ - + ]: 21 : assert(m_psbt_version == 2);
354 [ + - ]: 21 : Unserialize(s);
355 [ - - ]: 21 : }
356 : :
357 : : bool operator==(const PSBTInput&) const = default;
358 : :
359 : : template <typename Stream>
360 : 2 : inline void Serialize(Stream& s) const {
361 : : // Write the utxo
362 [ + - ]: 2 : if (non_witness_utxo) {
363 : 2 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_NON_WITNESS_UTXO));
364 : 2 : SerializeToVector(s, TX_NO_WITNESS(non_witness_utxo));
365 : : }
366 [ + + ]: 2 : if (!witness_utxo.IsNull()) {
367 : 1 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_WITNESS_UTXO));
368 : 1 : SerializeToVector(s, witness_utxo);
369 : : }
370 : :
371 [ - + + - : 2 : if (final_script_sig.empty() && final_script_witness.IsNull()) {
+ - ]
372 : : // Write any partial signatures
373 [ - + ]: 2 : for (const auto& sig_pair : partial_sigs) {
374 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_PARTIAL_SIG), std::span{sig_pair.second.first});
375 : 0 : s << sig_pair.second.second;
376 : : }
377 : :
378 : : // Write the sighash type
379 [ - + ]: 2 : if (sighash_type != std::nullopt) {
380 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_SIGHASH));
381 : 0 : SerializeToVector(s, *sighash_type);
382 : : }
383 : :
384 : : // Write the redeem script
385 [ + + + - ]: 3 : if (!redeem_script.empty()) {
386 : 2 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_REDEEMSCRIPT));
387 : 2 : s << redeem_script;
388 : : }
389 : :
390 : : // Write the witness script
391 [ + + + + ]: 3 : if (!witness_script.empty()) {
392 : 1 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_WITNESSSCRIPT));
393 : 1 : s << witness_script;
394 : : }
395 : :
396 : : // Write any hd keypaths
397 : 2 : SerializeHDKeypaths(s, hd_keypaths, CompactSizeWriter(PSBT_IN_BIP32_DERIVATION));
398 : :
399 : : // Write any ripemd160 preimage
400 [ - + ]: 2 : for (const auto& [hash, preimage] : ripemd160_preimages) {
401 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_RIPEMD160), std::span{hash});
402 : 0 : s << preimage;
403 : : }
404 : :
405 : : // Write any sha256 preimage
406 [ - + ]: 2 : for (const auto& [hash, preimage] : sha256_preimages) {
407 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_SHA256), std::span{hash});
408 : 0 : s << preimage;
409 : : }
410 : :
411 : : // Write any hash160 preimage
412 [ - + ]: 2 : for (const auto& [hash, preimage] : hash160_preimages) {
413 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_HASH160), std::span{hash});
414 : 0 : s << preimage;
415 : : }
416 : :
417 : : // Write any hash256 preimage
418 [ - + ]: 2 : for (const auto& [hash, preimage] : hash256_preimages) {
419 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_HASH256), std::span{hash});
420 : 0 : s << preimage;
421 : : }
422 : :
423 : : // Write taproot key sig
424 [ - + ]: 2 : if (!m_tap_key_sig.empty()) {
425 : 0 : SerializeToVector(s, PSBT_IN_TAP_KEY_SIG);
426 : 0 : s << m_tap_key_sig;
427 : : }
428 : :
429 : : // Write taproot script sigs
430 [ - + ]: 2 : for (const auto& [pubkey_leaf, sig] : m_tap_script_sigs) {
431 : 0 : const auto& [xonly, leaf_hash] = pubkey_leaf;
432 : 0 : SerializeToVector(s, PSBT_IN_TAP_SCRIPT_SIG, xonly, leaf_hash);
433 : 0 : s << sig;
434 : : }
435 : :
436 : : // Write taproot leaf scripts
437 [ - + ]: 2 : for (const auto& [leaf, control_blocks] : m_tap_scripts) {
438 : 0 : const auto& [script, leaf_ver] = leaf;
439 [ # # # # ]: 0 : for (const auto& control_block : control_blocks) {
440 : 0 : SerializeToVector(s, PSBT_IN_TAP_LEAF_SCRIPT, std::span{control_block});
441 : 0 : std::vector<unsigned char> value_v(script.begin(), script.end());
442 [ # # # # ]: 0 : value_v.push_back((uint8_t)leaf_ver);
443 : 0 : s << value_v;
444 : : }
445 : : }
446 : :
447 : : // Write taproot bip32 keypaths
448 [ - + ]: 2 : for (const auto& [xonly, leaf_origin] : m_tap_bip32_paths) {
449 : 0 : const auto& [leaf_hashes, origin] = leaf_origin;
450 : 0 : SerializeToVector(s, PSBT_IN_TAP_BIP32_DERIVATION, xonly);
451 : 0 : std::vector<unsigned char> value;
452 [ # # ]: 0 : VectorWriter s_value{value, 0};
453 [ # # ]: 0 : s_value << leaf_hashes;
454 [ # # # # ]: 0 : SerializeKeyOrigin(s_value, origin);
455 : 0 : s << value;
456 : : }
457 : :
458 : : // Write taproot internal key
459 [ - + ]: 4 : if (!m_tap_internal_key.IsNull()) {
460 : 0 : SerializeToVector(s, PSBT_IN_TAP_INTERNAL_KEY);
461 [ # # ]: 0 : s << ToByteVector(m_tap_internal_key);
462 : : }
463 : :
464 : : // Write taproot merkle root
465 [ - + ]: 4 : if (!m_tap_merkle_root.IsNull()) {
466 : 0 : SerializeToVector(s, PSBT_IN_TAP_MERKLE_ROOT);
467 : 0 : SerializeToVector(s, m_tap_merkle_root);
468 : : }
469 : :
470 : : // Write MuSig2 Participants
471 [ - + ]: 2 : for (const auto& [agg_pubkey, part_pubs] : m_musig2_participants) {
472 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_MUSIG2_PARTICIPANT_PUBKEYS), std::span{agg_pubkey});
473 : 0 : std::vector<unsigned char> value;
474 [ # # ]: 0 : VectorWriter s_value{value, 0};
475 [ # # # # ]: 0 : for (auto& pk : part_pubs) {
476 [ # # ]: 0 : s_value << std::span{pk};
477 : : }
478 : 0 : s << value;
479 : : }
480 : :
481 : : // Write MuSig2 pubnonces
482 [ - + ]: 2 : for (const auto& [agg_pubkey_leaf_hash, pubnonces] : m_musig2_pubnonces) {
483 : 0 : const auto& [agg_pubkey, leaf_hash] = agg_pubkey_leaf_hash;
484 [ # # ]: 0 : for (const auto& [part_pubkey, pubnonce] : pubnonces) {
485 [ # # ]: 0 : if (leaf_hash.IsNull()) {
486 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_MUSIG2_PUB_NONCE), std::span{part_pubkey}, std::span{agg_pubkey});
487 : : } else {
488 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_MUSIG2_PUB_NONCE), std::span{part_pubkey}, std::span{agg_pubkey}, leaf_hash);
489 : : }
490 : 0 : s << pubnonce;
491 : : }
492 : : }
493 : :
494 : : // Write MuSig2 partial signatures
495 [ - + ]: 2 : for (const auto& [agg_pubkey_leaf_hash, psigs] : m_musig2_partial_sigs) {
496 : 0 : const auto& [agg_pubkey, leaf_hash] = agg_pubkey_leaf_hash;
497 [ # # ]: 0 : for (const auto& [pubkey, psig] : psigs) {
498 [ # # ]: 0 : if (leaf_hash.IsNull()) {
499 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_MUSIG2_PARTIAL_SIG), std::span{pubkey}, std::span{agg_pubkey});
500 : : } else {
501 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_MUSIG2_PARTIAL_SIG), std::span{pubkey}, std::span{agg_pubkey}, leaf_hash);
502 : : }
503 : 0 : SerializeToVector(s, psig);
504 : : }
505 : : }
506 : : }
507 : :
508 : : // Write script sig
509 [ - + - + ]: 2 : if (!final_script_sig.empty()) {
510 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_SCRIPTSIG));
511 : 0 : s << final_script_sig;
512 : : }
513 : : // write script witness
514 [ - + ]: 2 : if (!final_script_witness.IsNull()) {
515 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_SCRIPTWITNESS));
516 : 0 : SerializeToVector(s, final_script_witness.stack);
517 : : }
518 : :
519 : : // Write PSBTv2 fields
520 [ - + ]: 2 : if (m_psbt_version >= 2) {
521 : : // Write prev txid, vout, sequence, and lock times
522 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_PREVIOUS_TXID));
523 : 0 : SerializeToVector(s, prev_txid);
524 : :
525 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_OUTPUT_INDEX));
526 : 0 : SerializeToVector(s, prev_out);
527 : :
528 [ # # ]: 0 : if (sequence != std::nullopt) {
529 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_SEQUENCE));
530 : 0 : SerializeToVector(s, *sequence);
531 : : }
532 [ # # ]: 0 : if (time_locktime != std::nullopt) {
533 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_REQUIRED_TIME_LOCKTIME));
534 : 0 : SerializeToVector(s, *time_locktime);
535 : : }
536 [ # # ]: 0 : if (height_locktime != std::nullopt) {
537 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_IN_REQUIRED_HEIGHT_LOCKTIME));
538 : 0 : SerializeToVector(s, *height_locktime);
539 : : }
540 : : }
541 : :
542 : : // Write proprietary things
543 [ - + ]: 2 : for (const auto& entry : m_proprietary) {
544 : 0 : s << entry.key;
545 : 0 : s << entry.value;
546 : : }
547 : :
548 : : // Write unknown things
549 [ - + ]: 2 : for (auto& entry : unknown) {
550 : 0 : s << entry.first;
551 : 0 : s << entry.second;
552 : : }
553 : :
554 : 2 : s << PSBT_SEPARATOR;
555 : 2 : }
556 : :
557 : :
558 : : template <typename Stream>
559 : 23 : inline void Unserialize(Stream& s) {
560 : : // Used for duplicate key detection
561 : 23 : std::set<std::vector<unsigned char>> key_lookup;
562 : : // Cache whether PSBTv2 required fields were seen
563 : 23 : bool found_prev_txid = false;
564 : 23 : bool found_prev_out = false;
565 : :
566 : : // Read loop
567 : 23 : bool found_sep = false;
568 [ - + + - ]: 86 : while(!s.empty()) {
[ + - ]
569 : : // Read the key of format "<keylen><keytype><keydata>" after which
570 : : // "key" will contain "<keytype><keydata>"
571 [ + - ]: 86 : std::vector<unsigned char> key;
572 : 86 : s >> key;
573 : :
574 : : // the key is empty if that was actually a separator byte
575 : : // This is a special case for key lengths 0 as those are not allowed (except for separator)
576 [ + + ]: 86 : if (key.empty()) {
577 : 23 : found_sep = true;
578 : : break;
579 : : }
580 : :
581 : : // Duplicate keys are not permitted
582 [ + - - + ]: 63 : if (!key_lookup.emplace(key).second) {
583 [ # # # # : 0 : throw std::ios_base::failure(tfm::format("Duplicate Key, input key \"%s\" already provided", HexStr(key)));
# # # # ]
584 : : }
585 : :
586 : : // "skey" is used so that "key" is unchanged after reading keytype below
587 : 63 : SpanReader skey{key};
588 : : // keytype is of the format compact size uint at the beginning of "key"
589 [ + - ]: 63 : uint64_t type = ReadCompactSize(skey);
590 : :
591 : : // Do stuff based on keytype "type", i.e., key checks, reading values of the
592 : : // format "<valuelen><valuedata>" from the stream "s", and value checks
593 [ - - - - : 63 : switch(type) {
- - - - -
- - - - +
+ - + + -
- - - - -
- - - -
- ]
594 : 0 : case PSBT_IN_NON_WITNESS_UTXO:
595 : : {
596 [ # # # # ]: 0 : ExpectedKeySize("Input Non-witness UTXO", key, 1);
597 : : // Set the stream to unserialize with witness since this is always a valid network transaction
598 [ # # ]: 0 : UnserializeFromVector(s, TX_WITH_WITNESS(non_witness_utxo));
599 : : break;
600 : : }
601 : 0 : case PSBT_IN_WITNESS_UTXO:
602 [ # # # # ]: 0 : ExpectedKeySize("Input Witness UTXO", key, 1);
603 [ # # ]: 0 : UnserializeFromVector(s, witness_utxo);
604 : : break;
605 [ # # ]: 0 : case PSBT_IN_PARTIAL_SIG:
606 : : {
607 : : // Make sure that the key is the size of pubkey + 1
608 [ # # # # ]: 0 : if (key.size() != CPubKey::SIZE + 1 && key.size() != CPubKey::COMPRESSED_SIZE + 1) {
609 [ # # ]: 0 : throw std::ios_base::failure("Size of key was not the expected size for the type partial signature pubkey");
610 : : }
611 : : // Read in the pubkey from key
612 : 0 : CPubKey pubkey(key.begin() + 1, key.end());
613 [ # # # # ]: 0 : if (!pubkey.IsFullyValid()) {
614 [ # # ]: 0 : throw std::ios_base::failure("Invalid pubkey");
615 : : }
616 : :
617 : : // Read in the signature from value
618 [ # # ]: 0 : std::vector<unsigned char> sig;
619 : 0 : s >> sig;
620 : :
621 : : // Check that the signature is validly encoded
622 [ # # # # : 0 : if (sig.empty() || !CheckSignatureEncoding(sig, SCRIPT_VERIFY_DERSIG | SCRIPT_VERIFY_STRICTENC, nullptr)) {
# # ]
623 [ # # ]: 0 : throw std::ios_base::failure("Signature is not a valid encoding");
624 : : }
625 : :
626 : : // Add to list
627 [ # # # # ]: 0 : partial_sigs.emplace(pubkey.GetID(), SigPair(pubkey, std::move(sig)));
628 : : break;
629 : 0 : }
630 : 0 : case PSBT_IN_SIGHASH:
631 [ # # # # ]: 0 : ExpectedKeySize("Input Sighash Type", key, 1);
632 : : int sighash;
633 [ # # ]: 0 : UnserializeFromVector(s, sighash);
634 : 0 : sighash_type = sighash;
635 : 0 : break;
636 : 0 : case PSBT_IN_REDEEMSCRIPT:
637 : : {
638 [ # # # # ]: 0 : ExpectedKeySize("Input redeemScript", key, 1);
639 [ # # ]: 0 : s >> redeem_script;
640 : : break;
641 : : }
642 : 0 : case PSBT_IN_WITNESSSCRIPT:
643 : : {
644 [ # # # # ]: 0 : ExpectedKeySize("Input witnessScript", key, 1);
645 [ # # ]: 0 : s >> witness_script;
646 : : break;
647 : : }
648 : 0 : case PSBT_IN_BIP32_DERIVATION:
649 : : {
650 [ # # ]: 0 : DeserializeHDKeypaths(s, key, hd_keypaths);
651 : : break;
652 : : }
653 : 0 : case PSBT_IN_SCRIPTSIG:
654 : : {
655 [ # # # # ]: 0 : ExpectedKeySize("Input Final scriptSig", key, 1);
656 [ - - ]: 63 : s >> final_script_sig;
657 : : break;
658 : : }
659 : 0 : case PSBT_IN_SCRIPTWITNESS:
660 : : {
661 [ # # # # ]: 0 : ExpectedKeySize("Input Final scriptWitness", key, 1);
662 [ # # ]: 0 : UnserializeFromVector(s, final_script_witness.stack);
663 : : break;
664 : : }
665 : 0 : case PSBT_IN_RIPEMD160:
666 : : {
667 [ # # # # : 0 : ExpectedKeySize("Input RIPEMD160 Preimage", key, CRIPEMD160::OUTPUT_SIZE + 1);
# # ]
668 : : // Read in the hash from key
669 [ # # ]: 0 : std::vector<unsigned char> hash_vec(key.begin() + 1, key.end());
670 : 0 : uint160 hash(hash_vec);
671 : :
672 : : // Read in the preimage from value
673 [ # # ]: 0 : std::vector<unsigned char> preimage;
674 : 0 : s >> preimage;
675 : :
676 : : // Add to preimages list
677 [ # # ]: 0 : ripemd160_preimages.emplace(hash, std::move(preimage));
678 : : break;
679 : 0 : }
680 : 0 : case PSBT_IN_SHA256:
681 : : {
682 [ # # # # : 0 : ExpectedKeySize("Input SHA256 Preimage", key, CSHA256::OUTPUT_SIZE + 1);
# # ]
683 : : // Read in the hash from key
684 [ # # ]: 0 : std::vector<unsigned char> hash_vec(key.begin() + 1, key.end());
685 : 0 : uint256 hash(hash_vec);
686 : :
687 : : // Read in the preimage from value
688 [ # # ]: 0 : std::vector<unsigned char> preimage;
689 : 0 : s >> preimage;
690 : :
691 : : // Add to preimages list
692 [ # # ]: 0 : sha256_preimages.emplace(hash, std::move(preimage));
693 : : break;
694 : 0 : }
695 : 0 : case PSBT_IN_HASH160:
696 : : {
697 [ # # # # : 0 : ExpectedKeySize("Input Hash160 Preimage", key, CHash160::OUTPUT_SIZE + 1);
# # ]
698 : : // Read in the hash from key
699 [ # # ]: 0 : std::vector<unsigned char> hash_vec(key.begin() + 1, key.end());
700 : 0 : uint160 hash(hash_vec);
701 : :
702 : : // Read in the preimage from value
703 [ # # ]: 0 : std::vector<unsigned char> preimage;
704 : 0 : s >> preimage;
705 : :
706 : : // Add to preimages list
707 [ # # ]: 0 : hash160_preimages.emplace(hash, std::move(preimage));
708 : : break;
709 : 0 : }
710 : 0 : case PSBT_IN_HASH256:
711 : : {
712 [ # # # # : 0 : ExpectedKeySize("Input Hash256 Preimage", key, CHash256::OUTPUT_SIZE + 1);
# # ]
713 : : // Read in the hash from key
714 [ # # ]: 0 : std::vector<unsigned char> hash_vec(key.begin() + 1, key.end());
715 : 0 : uint256 hash(hash_vec);
716 : :
717 : : // Read in the preimage from value
718 [ # # ]: 0 : std::vector<unsigned char> preimage;
719 : 0 : s >> preimage;
720 : :
721 : : // Add to preimages list
722 [ # # ]: 0 : hash256_preimages.emplace(hash, std::move(preimage));
723 : : break;
724 : 0 : }
725 : 21 : case PSBT_IN_PREVIOUS_TXID:
726 : : {
727 [ + - + - ]: 21 : ExpectedKeySize("Input Previous TXID", key, 1);
728 [ - + ]: 21 : if (m_psbt_version < 2) {
729 [ # # ]: 0 : throw std::ios_base::failure("Previous txid is not allowed in PSBTv0");
730 : : }
731 [ + - ]: 21 : UnserializeFromVector(s, prev_txid);
732 : : found_prev_txid = true;
733 : : break;
734 : : }
735 : 21 : case PSBT_IN_OUTPUT_INDEX:
736 : : {
737 [ + - + - ]: 21 : ExpectedKeySize("Input Previous Output's Index", key, 1);
738 [ - + ]: 21 : if (m_psbt_version < 2) {
739 [ # # ]: 0 : throw std::ios_base::failure("Previous output's index is not allowed in PSBTv0");
740 : : }
741 [ + - ]: 21 : UnserializeFromVector(s, prev_out);
742 : : found_prev_out = true;
743 : : break;
744 : : }
745 : 0 : case PSBT_IN_SEQUENCE:
746 : : {
747 [ # # # # ]: 0 : ExpectedKeySize("Input Sequence", key, 1);
748 [ # # ]: 0 : if (m_psbt_version < 2) {
749 [ # # ]: 0 : throw std::ios_base::failure("Sequence is not allowed in PSBTv0");
750 : : }
751 [ # # ]: 0 : sequence.emplace();
752 [ # # ]: 0 : UnserializeFromVector(s, *sequence);
753 : : break;
754 : : }
755 : 10 : case PSBT_IN_REQUIRED_TIME_LOCKTIME:
756 : : {
757 [ + - + - ]: 10 : ExpectedKeySize("Input Required Time Based Locktime", key, 1);
758 [ - + ]: 10 : if (m_psbt_version < 2) {
759 [ # # ]: 0 : throw std::ios_base::failure("Required time based locktime is not allowed in PSBTv0");
760 : : }
761 [ - + ]: 10 : time_locktime.emplace();
762 [ + - ]: 10 : UnserializeFromVector(s, *time_locktime);
763 [ - + ]: 10 : if (*time_locktime < LOCKTIME_THRESHOLD) {
764 [ # # ]: 0 : throw std::ios_base::failure("Required time based locktime is invalid (less than 500000000)");
765 : : }
766 : : break;
767 : : }
768 : 11 : case PSBT_IN_REQUIRED_HEIGHT_LOCKTIME:
769 : : {
770 [ + - + - ]: 11 : ExpectedKeySize("Input Required Height Based Locktime", key, 1);
771 [ - + ]: 11 : if (m_psbt_version < 2) {
772 [ # # ]: 0 : throw std::ios_base::failure("Required height based locktime is not allowed in PSBTv0");
773 : : }
774 [ - + ]: 11 : height_locktime.emplace();
775 [ + - ]: 11 : UnserializeFromVector(s, *height_locktime);
776 [ - + ]: 11 : if (*height_locktime >= LOCKTIME_THRESHOLD) {
777 [ # # ]: 0 : throw std::ios_base::failure("Required height based locktime is invalid (greater than or equal to 500000000)");
778 [ - + ]: 11 : } else if (*height_locktime == 0) {
779 [ # # ]: 0 : throw std::ios_base::failure("Required height based locktime is invalid (0)");
780 : : }
781 : : break;
782 : : }
783 : 0 : case PSBT_IN_TAP_KEY_SIG:
784 : : {
785 [ # # # # ]: 0 : ExpectedKeySize("Input Taproot Key Path Signature", key, 1);
786 [ # # ]: 0 : s >> m_tap_key_sig;
787 [ # # # # ]: 0 : if (m_tap_key_sig.size() < 64) {
788 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot key path signature is shorter than 64 bytes");
789 [ # # ]: 0 : } else if (m_tap_key_sig.size() > 65) {
790 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot key path signature is longer than 65 bytes");
791 : : }
792 : : break;
793 : : }
794 : 0 : case PSBT_IN_TAP_SCRIPT_SIG:
795 : : {
796 [ # # # # : 0 : ExpectedKeySize("Input Taproot Script Path Signature", key, 65);
# # ]
797 : 0 : SpanReader s_key{std::span{key}.subspan(1)};
798 : 0 : XOnlyPubKey xonly;
799 [ # # ]: 0 : uint256 hash;
800 [ # # ]: 0 : s_key >> xonly;
801 : 0 : s_key >> hash;
802 [ # # ]: 0 : std::vector<unsigned char> sig;
803 [ # # ]: 0 : s >> sig;
804 [ # # ]: 0 : if (sig.size() < 64) {
805 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot script path signature is shorter than 64 bytes");
806 [ # # ]: 0 : } else if (sig.size() > 65) {
807 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot script path signature is longer than 65 bytes");
808 : : }
809 [ # # ]: 0 : m_tap_script_sigs.emplace(std::make_pair(xonly, hash), sig);
810 : : break;
811 : 0 : }
812 [ # # ]: 0 : case PSBT_IN_TAP_LEAF_SCRIPT:
813 : : {
814 [ # # ]: 0 : if (key.size() < 34) {
815 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot leaf script key is not at least 34 bytes");
816 [ # # ]: 0 : } else if ((key.size() - 2) % 32 != 0) {
817 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot leaf script key's control block size is not valid");
818 : : }
819 [ # # ]: 0 : std::vector<unsigned char> script_v;
820 : 0 : s >> script_v;
821 [ # # ]: 0 : if (script_v.empty()) {
822 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot leaf script must be at least 1 byte");
823 : : }
824 [ # # ]: 0 : uint8_t leaf_ver = script_v.back();
825 : 0 : script_v.pop_back();
826 [ # # ]: 0 : const auto leaf_script = std::make_pair(script_v, (int)leaf_ver);
827 [ # # # # : 0 : m_tap_scripts[leaf_script].insert(std::vector<unsigned char>(key.begin() + 1, key.end()));
# # ]
828 : : break;
829 : 0 : }
830 : 0 : case PSBT_IN_TAP_BIP32_DERIVATION:
831 : : {
832 [ # # # # : 0 : ExpectedKeySize("Input Taproot BIP32 Keypath", key, 33);
# # ]
833 : 0 : SpanReader s_key{std::span{key}.subspan(1)};
834 [ # # ]: 0 : XOnlyPubKey xonly;
835 [ # # ]: 0 : s_key >> xonly;
836 : 0 : std::set<uint256> leaf_hashes;
837 [ # # # # ]: 0 : uint64_t value_len = ReadCompactSize(s);
838 [ # # ]: 0 : size_t before_hashes = s.size();
839 [ # # ]: 0 : s >> leaf_hashes;
840 : 0 : size_t after_hashes = s.size();
841 : 0 : size_t hashes_len = before_hashes - after_hashes;
842 [ # # ]: 0 : if (hashes_len > value_len) {
843 [ # # ]: 0 : throw std::ios_base::failure("Input Taproot BIP32 keypath has an invalid length");
844 : : }
845 : 0 : size_t origin_len = value_len - hashes_len;
846 [ # # # # ]: 0 : m_tap_bip32_paths.emplace(xonly, std::make_pair(leaf_hashes, DeserializeKeyOrigin(s, origin_len)));
847 : : break;
848 : 0 : }
849 : 0 : case PSBT_IN_TAP_INTERNAL_KEY:
850 : : {
851 [ # # # # ]: 0 : ExpectedKeySize("Input Taproot Internal Key", key, 1);
852 [ # # ]: 0 : UnserializeFromVector(s, m_tap_internal_key);
853 : : break;
854 : : }
855 : 0 : case PSBT_IN_TAP_MERKLE_ROOT:
856 : : {
857 [ # # # # ]: 0 : ExpectedKeySize("Input Taproot Merkle Root", key, 1);
858 [ # # ]: 0 : UnserializeFromVector(s, m_tap_merkle_root);
859 : : break;
860 : : }
861 : 0 : case PSBT_IN_MUSIG2_PARTICIPANT_PUBKEYS:
862 : : {
863 [ # # # # ]: 0 : ExpectedKeySize("Input MuSig2 Participants Pubkeys", key, CPubKey::COMPRESSED_SIZE + 1);
864 [ # # # # ]: 0 : DeserializeMuSig2ParticipantPubkeys(s, skey, m_musig2_participants, std::string{"Input"});
865 : : break;
866 : : }
867 [ # # ]: 0 : case PSBT_IN_MUSIG2_PUB_NONCE:
868 : : {
869 [ # # # # ]: 0 : if (key.size() != 2 * CPubKey::COMPRESSED_SIZE + 1 && key.size() != 2 * CPubKey::COMPRESSED_SIZE + CSHA256::OUTPUT_SIZE + 1) {
870 [ # # ]: 0 : throw std::ios_base::failure("Input musig2 pubnonce key is not expected size of 67 or 99 bytes");
871 : : }
872 : 0 : CPubKey agg_pub, part_pub;
873 : 0 : uint256 leaf_hash;
874 [ # # ]: 0 : DeserializeMuSig2ParticipantDataIdentifier(skey, agg_pub, part_pub, leaf_hash);
875 : :
876 [ # # ]: 0 : std::vector<uint8_t> pubnonce;
877 [ # # ]: 0 : s >> pubnonce;
878 [ # # ]: 0 : if (pubnonce.size() != MUSIG2_PUBNONCE_SIZE) {
879 [ # # ]: 0 : throw std::ios_base::failure("Input musig2 pubnonce value is not 66 bytes");
880 : : }
881 : :
882 [ # # # # ]: 0 : m_musig2_pubnonces[std::make_pair(agg_pub, leaf_hash)].emplace(part_pub, pubnonce);
883 : : break;
884 : 0 : }
885 [ # # ]: 0 : case PSBT_IN_MUSIG2_PARTIAL_SIG:
886 : : {
887 [ # # # # ]: 0 : if (key.size() != 2 * CPubKey::COMPRESSED_SIZE + 1 && key.size() != 2 * CPubKey::COMPRESSED_SIZE + CSHA256::OUTPUT_SIZE + 1) {
888 [ # # ]: 0 : throw std::ios_base::failure("Input musig2 partial sig key is not expected size of 67 or 99 bytes");
889 : : }
890 : 0 : CPubKey agg_pub, part_pub;
891 : 0 : uint256 leaf_hash;
892 [ # # ]: 0 : DeserializeMuSig2ParticipantDataIdentifier(skey, agg_pub, part_pub, leaf_hash);
893 : :
894 : 0 : uint256 partial_sig;
895 [ # # ]: 0 : UnserializeFromVector(s, partial_sig);
896 : :
897 [ # # # # ]: 0 : m_musig2_partial_sigs[std::make_pair(agg_pub, leaf_hash)].emplace(part_pub, partial_sig);
898 : : break;
899 : : }
900 [ # # ]: 0 : case PSBT_IN_PROPRIETARY:
901 : : {
902 [ # # ]: 0 : PSBTProprietary this_prop;
903 : 0 : skey >> this_prop.identifier;
904 [ # # ]: 0 : this_prop.subtype = ReadCompactSize(skey);
905 [ # # ]: 0 : this_prop.key = key;
906 : :
907 : 0 : s >> this_prop.value;
908 [ # # ]: 0 : m_proprietary.insert(this_prop);
909 : : break;
910 : 0 : }
911 : : // Unknown stuff
912 : 0 : default:
913 : : // Read in the value
914 [ # # ]: 0 : std::vector<unsigned char> val_bytes;
915 : 0 : s >> val_bytes;
916 [ # # ]: 0 : unknown.emplace(std::move(key), std::move(val_bytes));
917 : : break;
918 : 0 : }
919 : : }
920 : :
921 : : if (!found_sep) {
922 [ # # ]: 0 : throw std::ios_base::failure("Separator is missing at the end of an input map");
923 : : }
924 : :
925 : : // Make sure required PSBTv2 fields are present
926 [ + + ]: 23 : if (m_psbt_version >= 2) {
927 [ - + ]: 21 : if (!found_prev_txid) {
928 [ # # ]: 0 : throw std::ios_base::failure("Previous TXID is required in PSBTv2");
929 : : }
930 [ - + ]: 21 : if (!found_prev_out) {
931 [ # # ]: 0 : throw std::ios_base::failure("Previous output's index is required in PSBTv2");
932 : : }
933 : : }
934 : 23 : }
935 : : };
936 : :
937 : : /** A structure for PSBTs which contains per output information */
938 : : class PSBTOutput
939 : : {
940 : : private:
941 : : uint32_t m_psbt_version;
942 : :
943 : : public:
944 : : CScript redeem_script;
945 : : CScript witness_script;
946 : : std::map<CPubKey, KeyOriginInfo> hd_keypaths;
947 : :
948 : : XOnlyPubKey m_tap_internal_key;
949 : : std::vector<std::tuple<uint8_t, uint8_t, std::vector<unsigned char>>> m_tap_tree;
950 : : std::map<XOnlyPubKey, std::pair<std::set<uint256>, KeyOriginInfo>> m_tap_bip32_paths;
951 : : std::map<CPubKey, std::vector<CPubKey>> m_musig2_participants;
952 : :
953 : : std::map<std::vector<unsigned char>, std::vector<unsigned char>> unknown;
954 : : std::set<PSBTProprietary> m_proprietary;
955 : :
956 : : CAmount amount;
957 : : CScript script;
958 : :
959 : : void FillSignatureData(SignatureData& sigdata) const;
960 : : void FromSignatureData(const SignatureData& sigdata);
961 : : void Merge(const PSBTOutput& output);
962 : 4 : uint32_t GetVersion() const { return m_psbt_version; }
963 : :
964 : 20 : explicit PSBTOutput(uint32_t psbt_version, CAmount amount, const CScript& script)
965 : 20 : : m_psbt_version(psbt_version),
966 : 20 : amount(amount),
967 : 20 : script(script)
968 : : {
969 [ - + ]: 20 : assert(m_psbt_version == 0 || m_psbt_version == 2);
970 : 20 : }
971 : :
972 : : // Construct a PSBTOutput when the amount and script are expected to be serialized
973 : : template <typename Stream>
974 : 12 : explicit PSBTOutput(deserialize_type, Stream& s, uint32_t psbt_version)
975 [ - + ]: 12 : : m_psbt_version(psbt_version)
976 : : {
977 [ - + ]: 12 : assert(m_psbt_version == 2);
978 [ + - ]: 12 : Unserialize(s);
979 : 12 : }
980 : :
981 : : bool operator==(const PSBTOutput&) const = default;
982 : :
983 : : template <typename Stream>
984 : 2 : inline void Serialize(Stream& s) const {
985 : : // Write the redeem script
986 [ - + - + ]: 2 : if (!redeem_script.empty()) {
987 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_OUT_REDEEMSCRIPT));
988 : 0 : s << redeem_script;
989 : : }
990 : :
991 : : // Write the witness script
992 [ - + - + ]: 2 : if (!witness_script.empty()) {
993 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_OUT_WITNESSSCRIPT));
994 : 0 : s << witness_script;
995 : : }
996 : :
997 : : // Write any hd keypaths
998 : 2 : SerializeHDKeypaths(s, hd_keypaths, CompactSizeWriter(PSBT_OUT_BIP32_DERIVATION));
999 : :
1000 [ - + ]: 2 : if (m_psbt_version >= 2) {
1001 : : // Write amount and spk
1002 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_OUT_AMOUNT));
1003 : 0 : SerializeToVector(s, amount);
1004 : :
1005 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_OUT_SCRIPT));
1006 : 0 : s << script;
1007 : : }
1008 : :
1009 : : // Write proprietary things
1010 [ - + ]: 2 : for (const auto& entry : m_proprietary) {
1011 : 0 : s << entry.key;
1012 : 0 : s << entry.value;
1013 : : }
1014 : :
1015 : : // Write taproot internal key
1016 [ - + ]: 4 : if (!m_tap_internal_key.IsNull()) {
1017 : 0 : SerializeToVector(s, PSBT_OUT_TAP_INTERNAL_KEY);
1018 [ # # ]: 0 : s << ToByteVector(m_tap_internal_key);
1019 : : }
1020 : :
1021 : : // Write taproot tree
1022 [ - + ]: 2 : if (!m_tap_tree.empty()) {
1023 : 0 : SerializeToVector(s, PSBT_OUT_TAP_TREE);
1024 : 0 : std::vector<unsigned char> value;
1025 [ # # ]: 0 : VectorWriter s_value{value, 0};
1026 [ # # # # ]: 0 : for (const auto& [depth, leaf_ver, script] : m_tap_tree) {
1027 [ # # ]: 0 : s_value << depth;
1028 [ # # ]: 0 : s_value << leaf_ver;
1029 : 0 : s_value << script;
1030 : : }
1031 : 0 : s << value;
1032 : 0 : }
1033 : :
1034 : : // Write taproot bip32 keypaths
1035 [ - + ]: 2 : for (const auto& [xonly, leaf] : m_tap_bip32_paths) {
1036 : 0 : const auto& [leaf_hashes, origin] = leaf;
1037 : 0 : SerializeToVector(s, PSBT_OUT_TAP_BIP32_DERIVATION, xonly);
1038 : 0 : std::vector<unsigned char> value;
1039 [ # # ]: 0 : VectorWriter s_value{value, 0};
1040 [ # # ]: 0 : s_value << leaf_hashes;
1041 [ # # # # ]: 0 : SerializeKeyOrigin(s_value, origin);
1042 : 0 : s << value;
1043 : : }
1044 : :
1045 : : // Write MuSig2 Participants
1046 [ - + ]: 2 : for (const auto& [agg_pubkey, part_pubs] : m_musig2_participants) {
1047 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_OUT_MUSIG2_PARTICIPANT_PUBKEYS), std::span{agg_pubkey});
1048 : 0 : std::vector<unsigned char> value;
1049 [ # # ]: 0 : VectorWriter s_value{value, 0};
1050 [ # # # # ]: 0 : for (auto& pk : part_pubs) {
1051 [ # # ]: 0 : s_value << std::span{pk};
1052 : : }
1053 : 0 : s << value;
1054 : : }
1055 : :
1056 : : // Write unknown things
1057 [ - + ]: 2 : for (auto& entry : unknown) {
1058 : 0 : s << entry.first;
1059 : 0 : s << entry.second;
1060 : : }
1061 : :
1062 : 2 : s << PSBT_SEPARATOR;
1063 : 2 : }
1064 : :
1065 : :
1066 : : template <typename Stream>
1067 : 14 : inline void Unserialize(Stream& s) {
1068 : : // Used for duplicate key detection
1069 : 14 : std::set<std::vector<unsigned char>> key_lookup;
1070 : : // Cache whether PSBTv2 required fields are found
1071 : 14 : bool found_amount = false;
1072 : 14 : bool found_script = false;
1073 : :
1074 : : // Read loop
1075 : 14 : bool found_sep = false;
1076 [ - + + - ]: 38 : while(!s.empty()) {
[ + - ]
1077 : : // Read the key of format "<keylen><keytype><keydata>" after which
1078 : : // "key" will contain "<keytype><keydata>"
1079 [ + - ]: 38 : std::vector<unsigned char> key;
1080 : 38 : s >> key;
1081 : :
1082 : : // the key is empty if that was actually a separator byte
1083 : : // This is a special case for key lengths 0 as those are not allowed (except for separator)
1084 [ + + ]: 38 : if (key.empty()) {
1085 : 14 : found_sep = true;
1086 : : break;
1087 : : }
1088 : :
1089 : : // Duplicate keys are not permitted
1090 [ + - - + ]: 24 : if (!key_lookup.emplace(key).second) {
1091 [ # # # # : 0 : throw std::ios_base::failure(tfm::format("Duplicate Key, output key \"%s\" already provided", HexStr(key)));
# # # # ]
1092 : : }
1093 : :
1094 : : // "skey" is used so that "key" is unchanged after reading keytype below
1095 : 24 : SpanReader skey{key};
1096 : : // keytype is of the format compact size uint at the beginning of "key"
1097 [ + - ]: 24 : uint64_t type = ReadCompactSize(skey);
1098 : :
1099 : : // Do stuff based on keytype "type", i.e., key checks, reading values of the
1100 : : // format "<valuelen><valuedata>" from the stream "s", and value checks
1101 [ - - - + : 24 : switch(type) {
+ - - - -
- - ]
1102 : 0 : case PSBT_OUT_REDEEMSCRIPT:
1103 : : {
1104 [ # # # # ]: 0 : ExpectedKeySize("Output redeemScript", key, 1);
1105 [ # # ]: 0 : s >> redeem_script;
1106 : : break;
1107 : : }
1108 : 0 : case PSBT_OUT_WITNESSSCRIPT:
1109 : : {
1110 [ # # # # ]: 0 : ExpectedKeySize("Output witnessScript", key, 1);
1111 [ # # ]: 0 : s >> witness_script;
1112 : : break;
1113 : : }
1114 : 0 : case PSBT_OUT_BIP32_DERIVATION:
1115 : : {
1116 [ # # ]: 0 : DeserializeHDKeypaths(s, key, hd_keypaths);
1117 : : break;
1118 : : }
1119 : 12 : case PSBT_OUT_AMOUNT:
1120 : : {
1121 [ + - + - ]: 12 : ExpectedKeySize("Output Amount", key, 1);
1122 [ - + ]: 12 : if (m_psbt_version < 2) {
1123 [ # # ]: 0 : throw std::ios_base::failure("Output amount is not allowed in PSBTv0");
1124 : : }
1125 [ + - ]: 12 : UnserializeFromVector(s, amount);
1126 : : found_amount = true;
1127 : : break;
1128 : : }
1129 : 12 : case PSBT_OUT_SCRIPT:
1130 : : {
1131 [ + - + - ]: 12 : ExpectedKeySize("Output Script", key, 1);
1132 [ - + ]: 12 : if (m_psbt_version < 2) {
1133 [ # # ]: 0 : throw std::ios_base::failure("Output script is not allowed in PSBTv0");
1134 : : }
1135 [ + - ]: 36 : s >> script;
1136 : : found_script = true;
1137 : : break;
1138 : : }
1139 : 0 : case PSBT_OUT_TAP_INTERNAL_KEY:
1140 : : {
1141 [ # # # # ]: 0 : ExpectedKeySize("Output Taproot Internal Key", key, 1);
1142 [ # # ]: 0 : UnserializeFromVector(s, m_tap_internal_key);
1143 : : break;
1144 : : }
1145 : 0 : case PSBT_OUT_TAP_TREE:
1146 : : {
1147 [ # # # # ]: 0 : ExpectedKeySize("Output Taproot Tree Key", key, 1);
1148 [ # # ]: 0 : std::vector<unsigned char> tree_v;
1149 [ # # ]: 0 : s >> tree_v;
1150 [ # # ]: 0 : SpanReader s_tree{tree_v};
1151 [ # # ]: 0 : if (s_tree.empty()) {
1152 [ # # ]: 0 : throw std::ios_base::failure("Output Taproot tree must not be empty");
1153 : : }
1154 : 0 : TaprootBuilder builder;
1155 [ # # ]: 0 : while (!s_tree.empty()) {
1156 : : uint8_t depth;
1157 : : uint8_t leaf_ver;
1158 [ # # ]: 0 : std::vector<unsigned char> script;
1159 [ # # ]: 0 : s_tree >> depth;
1160 [ # # ]: 0 : s_tree >> leaf_ver;
1161 : 0 : s_tree >> script;
1162 [ # # ]: 0 : if (depth > TAPROOT_CONTROL_MAX_NODE_COUNT) {
1163 [ # # ]: 0 : throw std::ios_base::failure("Output Taproot tree has as leaf greater than Taproot maximum depth");
1164 : : }
1165 [ # # ]: 0 : if ((leaf_ver & ~TAPROOT_LEAF_MASK) != 0) {
1166 [ # # ]: 0 : throw std::ios_base::failure("Output Taproot tree has a leaf with an invalid leaf version");
1167 : : }
1168 [ # # ]: 0 : m_tap_tree.emplace_back(depth, leaf_ver, script);
1169 [ # # # # ]: 0 : builder.Add((int)depth, script, (int)leaf_ver, /*track=*/true);
1170 : : }
1171 [ # # ]: 0 : if (!builder.IsComplete()) {
1172 [ # # ]: 0 : throw std::ios_base::failure("Output Taproot tree is malformed");
1173 : : }
1174 : : break;
1175 : 0 : }
1176 : 0 : case PSBT_OUT_TAP_BIP32_DERIVATION:
1177 : : {
1178 [ # # # # : 0 : ExpectedKeySize("Output Taproot BIP32 Keypath", key, 33);
# # ]
1179 [ # # ]: 0 : XOnlyPubKey xonly(uint256(std::span<uint8_t>(key).last(32)));
1180 : 0 : std::set<uint256> leaf_hashes;
1181 [ # # # # ]: 0 : uint64_t value_len = ReadCompactSize(s);
1182 [ # # ]: 0 : size_t before_hashes = s.size();
1183 [ # # ]: 0 : s >> leaf_hashes;
1184 : 0 : size_t after_hashes = s.size();
1185 : 0 : size_t hashes_len = before_hashes - after_hashes;
1186 [ # # ]: 0 : if (hashes_len > value_len) {
1187 [ # # ]: 0 : throw std::ios_base::failure("Output Taproot BIP32 keypath has an invalid length");
1188 : : }
1189 : 0 : size_t origin_len = value_len - hashes_len;
1190 [ # # # # ]: 0 : m_tap_bip32_paths.emplace(xonly, std::make_pair(leaf_hashes, DeserializeKeyOrigin(s, origin_len)));
1191 : : break;
1192 : 0 : }
1193 : 0 : case PSBT_OUT_MUSIG2_PARTICIPANT_PUBKEYS:
1194 : : {
1195 [ # # # # ]: 0 : ExpectedKeySize("Output MuSig2 Participants Pubkeys", key, CPubKey::COMPRESSED_SIZE + 1);
1196 [ # # # # ]: 0 : DeserializeMuSig2ParticipantPubkeys(s, skey, m_musig2_participants, std::string{"Output"});
1197 : : break;
1198 : : }
1199 [ # # ]: 0 : case PSBT_OUT_PROPRIETARY:
1200 : : {
1201 [ # # ]: 0 : PSBTProprietary this_prop;
1202 : 0 : skey >> this_prop.identifier;
1203 [ # # ]: 0 : this_prop.subtype = ReadCompactSize(skey);
1204 [ # # ]: 0 : this_prop.key = key;
1205 : :
1206 : 0 : s >> this_prop.value;
1207 [ # # ]: 0 : m_proprietary.insert(this_prop);
1208 : : break;
1209 : 0 : }
1210 : : // Unknown stuff
1211 : 0 : default: {
1212 : : // Read in the value
1213 [ # # ]: 0 : std::vector<unsigned char> val_bytes;
1214 : 0 : s >> val_bytes;
1215 [ # # ]: 0 : unknown.emplace(std::move(key), std::move(val_bytes));
1216 : : break;
1217 : 0 : }
1218 : : }
1219 : : }
1220 : :
1221 : : if (!found_sep) {
1222 [ # # ]: 0 : throw std::ios_base::failure("Separator is missing at the end of an output map");
1223 : : }
1224 : :
1225 : : // Make sure required PSBTv2 fields are present
1226 [ + + ]: 14 : if (m_psbt_version >= 2) {
1227 [ - + ]: 12 : if (!found_amount) {
1228 [ # # ]: 0 : throw std::ios_base::failure("Output amount is required in PSBTv2");
1229 : : }
1230 [ - + ]: 12 : if (!found_script) {
1231 [ # # ]: 0 : throw std::ios_base::failure("Output script is required in PSBTv2");
1232 : : }
1233 : : }
1234 : 14 : }
1235 : : };
1236 : :
1237 : : /** A version of CTransaction with the PSBT format*/
1238 : : class PartiallySignedTransaction
1239 : : {
1240 : : private:
1241 : : std::optional<uint32_t> m_version;
1242 : :
1243 : : public:
1244 : : // We use a vector of CExtPubKey in the event that there happens to be the same KeyOriginInfos for different CExtPubKeys
1245 : : // Note that this map swaps the key and values from the serialization
1246 : : std::map<KeyOriginInfo, std::set<CExtPubKey>> m_xpubs;
1247 : : std::optional<std::bitset<8>> m_tx_modifiable;
1248 : : std::vector<PSBTInput> inputs;
1249 : : std::vector<PSBTOutput> outputs;
1250 : : std::map<std::vector<unsigned char>, std::vector<unsigned char>> unknown;
1251 : : std::set<PSBTProprietary> m_proprietary;
1252 : :
1253 : : uint32_t tx_version;
1254 : : std::optional<uint32_t> fallback_locktime;
1255 : :
1256 : : uint32_t GetVersion() const;
1257 : :
1258 : : /** Merge psbt into this. The two psbts must have the same underlying CTransaction (i.e. the
1259 : : * same actual Bitcoin transaction.) Returns true if the merge succeeded, false otherwise. */
1260 : : [[nodiscard]] bool Merge(const PartiallySignedTransaction& psbt);
1261 : : /** Merge the global xpubs of psbt into this, keeping the existing origin for an xpub
1262 : : * seen again with a different one, as the serialized records are keyed by xpub. */
1263 : : void MergeGlobalXPubs(const PartiallySignedTransaction& psbt);
1264 : : bool AddInput(const PSBTInput& psbtin);
1265 : : bool AddOutput(const PSBTOutput& psbtout);
1266 : : std::optional<uint32_t> ComputeTimeLock() const;
1267 : : std::optional<CMutableTransaction> GetUnsignedTx() const;
1268 : : std::optional<Txid> GetUniqueID() const;
1269 : : explicit PartiallySignedTransaction(const CMutableTransaction& tx, uint32_t version = 2);
1270 : :
1271 : : template <typename Stream>
1272 : 1 : inline void Serialize(Stream& s) const {
1273 : :
1274 : : // magic bytes
1275 : 1 : s << PSBT_MAGIC_BYTES;
1276 : :
1277 [ + - ]: 1 : if (GetVersion() < 2) {
1278 : : // unsigned tx flag
1279 : 1 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_UNSIGNED_TX));
1280 : :
1281 : : // Write serialized tx to a stream
1282 [ + - ]: 2 : SerializeToVector(s, TX_NO_WITNESS(*GetUnsignedTx()));
1283 : : }
1284 : :
1285 : : // Write xpubs
1286 [ - + ]: 1 : for (const auto& xpub_pair : m_xpubs) {
1287 [ # # ]: 0 : for (const auto& xpub : xpub_pair.second) {
1288 : : // Note that the serialization swaps the key and value
1289 : : // The xpub is the key (for uniqueness) while the path is the value
1290 : 0 : SerializeToVector(s, PSBT_GLOBAL_XPUB, xpub.version, xpub);
1291 [ # # ]: 0 : SerializeHDKeypath(s, xpub_pair.first);
1292 : : }
1293 : : }
1294 : :
1295 [ - + ]: 1 : if (GetVersion() >= 2) {
1296 : : // Write PSBTv2 tx version, locktime, counts, etc.
1297 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_TX_VERSION));
1298 : 0 : SerializeToVector(s, tx_version);
1299 [ # # ]: 0 : if (fallback_locktime != std::nullopt) {
1300 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_FALLBACK_LOCKTIME));
1301 : 0 : SerializeToVector(s, *fallback_locktime);
1302 : : }
1303 : :
1304 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_INPUT_COUNT));
1305 [ # # ]: 0 : SerializeToVector(s, CompactSizeWriter(inputs.size()));
1306 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_OUTPUT_COUNT));
1307 [ # # ]: 0 : SerializeToVector(s, CompactSizeWriter(outputs.size()));
1308 : :
1309 [ # # ]: 0 : if (m_tx_modifiable != std::nullopt) {
1310 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_TX_MODIFIABLE));
1311 : 0 : SerializeToVector(s, static_cast<uint8_t>(m_tx_modifiable->to_ulong()));
1312 : : }
1313 : : }
1314 : :
1315 : : // PSBT version
1316 [ - + ]: 1 : if (GetVersion() > 0) {
1317 : 0 : SerializeToVector(s, CompactSizeWriter(PSBT_GLOBAL_VERSION));
1318 : 0 : SerializeToVector(s, *m_version);
1319 : : }
1320 : :
1321 : : // Write proprietary things
1322 [ - + ]: 1 : for (const auto& entry : m_proprietary) {
1323 : 0 : s << entry.key;
1324 : 0 : s << entry.value;
1325 : : }
1326 : :
1327 : : // Write the unknown things
1328 [ - + ]: 1 : for (auto& entry : unknown) {
1329 : 0 : s << entry.first;
1330 : 0 : s << entry.second;
1331 : : }
1332 : :
1333 : : // Separator
1334 : 1 : s << PSBT_SEPARATOR;
1335 : :
1336 : : // Write inputs
1337 [ + + ]: 3 : for (const PSBTInput& input : inputs) {
1338 : 2 : s << input;
1339 : : }
1340 : : // Write outputs
1341 [ + + ]: 3 : for (const PSBTOutput& output : outputs) {
1342 : 2 : s << output;
1343 : : }
1344 : 1 : }
1345 : :
1346 : :
1347 : : template <typename Stream>
1348 : 12 : inline void Unserialize(Stream& s) {
1349 : : // Read the magic bytes
1350 : : uint8_t magic[5];
1351 : 12 : s >> magic;
1352 [ - + ]: 12 : if (!std::equal(magic, magic + 5, PSBT_MAGIC_BYTES)) {
1353 [ # # ]: 0 : throw std::ios_base::failure("Invalid PSBT magic bytes");
1354 : : }
1355 : :
1356 : : // Used for duplicate key detection
1357 : 12 : std::set<std::vector<unsigned char>> key_lookup;
1358 : :
1359 : : // Read global data
1360 : 12 : bool found_sep = false;
1361 : 12 : std::optional<CMutableTransaction> tx;
1362 : 12 : uint64_t input_count = 0;
1363 : 12 : uint64_t output_count = 0;
1364 : 12 : bool found_input_count = false;
1365 : 12 : bool found_output_count = false;
1366 : 12 : bool found_tx_version = false;
1367 : 12 : bool found_fallback_locktime = false;
1368 [ - + + - ]: 67 : while(!s.empty()) {
[ + - ]
1369 : : // Read the key of format "<keylen><keytype><keydata>" after which
1370 : : // "key" will contain "<keytype><keydata>"
1371 [ + - ]: 67 : std::vector<unsigned char> key;
1372 : 67 : s >> key;
1373 : :
1374 : : // the key is empty if that was actually a separator byte
1375 : : // This is a special case for key lengths 0 as those are not allowed (except for separator)
1376 [ + + ]: 67 : if (key.empty()) {
1377 : 12 : found_sep = true;
1378 : : break;
1379 : : }
1380 : :
1381 : : // Duplicate keys are not permitted
1382 [ + - - + ]: 55 : if (!key_lookup.emplace(key).second) {
1383 [ # # # # : 0 : throw std::ios_base::failure(tfm::format("Duplicate Key, global key \"%s\" already provided", HexStr(key)));
# # # # ]
1384 : : }
1385 : :
1386 : : // "skey" is used so that "key" is unchanged after reading keytype below
1387 : 55 : SpanReader skey{key};
1388 : : // keytype is of the format compact size uint at the beginning of "key"
1389 [ + - ]: 55 : uint64_t type = ReadCompactSize(skey);
1390 : :
1391 : : // Do stuff based on keytype "type", i.e., key checks, reading values of the
1392 : : // format "<valuelen><valuedata>" from the stream "s", and value checks
1393 [ + + + + : 55 : switch(type) {
+ - - + -
- ]
1394 : 1 : case PSBT_GLOBAL_UNSIGNED_TX:
1395 : : {
1396 [ + - + - ]: 1 : ExpectedKeySize("Global Unsigned TX", key, 1);
1397 : : // Set the stream to serialize with non-witness since this should always be non-witness
1398 [ + - ]: 1 : tx.emplace();
1399 [ + - ]: 1 : UnserializeFromVector(s, TX_NO_WITNESS(*tx));
1400 : : // Make sure that all scriptSigs and scriptWitnesses are empty
1401 [ + + ]: 3 : for (const CTxIn& txin : tx->vin) {
1402 [ - + + - : 2 : if (!txin.scriptSig.empty() || !txin.scriptWitness.IsNull()) {
- + ]
1403 [ # # ]: 0 : throw std::ios_base::failure("Unsigned tx does not have empty scriptSigs and scriptWitnesses.");
1404 : : }
1405 : : }
1406 : 1 : tx_version = tx->version;
1407 [ - + ]: 1 : fallback_locktime = tx->nLockTime;
1408 : : // Set the input and output counts
1409 [ - + - + ]: 1 : input_count = tx->vin.size();
1410 [ - + ]: 1 : output_count = tx->vout.size();
1411 : 1 : break;
1412 : : }
1413 : 11 : case PSBT_GLOBAL_TX_VERSION:
1414 : : {
1415 [ + - + - ]: 11 : ExpectedKeySize("Global Transaction Version", key, 1);
1416 [ + - ]: 11 : UnserializeFromVector(s, tx_version);
1417 : : found_tx_version = true;
1418 : : break;
1419 : : }
1420 : 10 : case PSBT_GLOBAL_FALLBACK_LOCKTIME:
1421 : : {
1422 [ + - + - ]: 10 : ExpectedKeySize("Global Fallback Locktime", key, 1);
1423 [ - + ]: 10 : fallback_locktime.emplace();
1424 [ + - ]: 10 : UnserializeFromVector(s, *fallback_locktime);
1425 : : found_fallback_locktime = true;
1426 : : break;
1427 : : }
1428 : 11 : case PSBT_GLOBAL_INPUT_COUNT:
1429 : : {
1430 [ + - + - : 22 : ExpectedKeySize("Global Input Count", key, 1);
+ - ]
1431 : 11 : CompactSizeReader reader(input_count);
1432 [ + - ]: 11 : UnserializeFromVector(s, reader);
1433 : : found_input_count = true;
1434 : : break;
1435 : : }
1436 : 11 : case PSBT_GLOBAL_OUTPUT_COUNT:
1437 : : {
1438 [ + - + - : 22 : ExpectedKeySize("Global Output Count", key, 1);
+ - ]
1439 : 11 : CompactSizeReader reader(output_count);
1440 [ + - ]: 11 : UnserializeFromVector(s, reader);
1441 : : found_output_count = true;
1442 : : break;
1443 : : }
1444 : 0 : case PSBT_GLOBAL_TX_MODIFIABLE:
1445 : : {
1446 [ # # # # ]: 0 : ExpectedKeySize("Global TX Modifiable Flags", key, 1);
1447 : : uint8_t tx_mod;
1448 [ # # ]: 0 : UnserializeFromVector(s, tx_mod);
1449 [ # # ]: 0 : m_tx_modifiable.emplace(tx_mod);
1450 : : break;
1451 : : }
1452 : 0 : case PSBT_GLOBAL_XPUB:
1453 : : {
1454 [ # # # # : 0 : ExpectedKeySize("Global XPUB", key, BIP32_EXTKEY_WITH_VERSION_SIZE + 1);
# # ]
1455 : : // Read in the xpub from key
1456 [ # # ]: 0 : CExtPubKey xpub;
1457 [ # # # # ]: 0 : SpanReader{std::span{key}.subspan(1)} >> xpub.version >> xpub;
1458 [ # # # # ]: 0 : if (!xpub.pubkey.IsFullyValid()) {
1459 [ # # ]: 0 : throw std::ios_base::failure("Invalid pubkey");
1460 : : }
1461 : : // Read in the keypath from stream
1462 : 0 : KeyOriginInfo keypath;
1463 [ # # ]: 0 : DeserializeHDKeypath(s, keypath);
1464 : :
1465 : : // Note that we store these swapped to make searches faster.
1466 : : // Serialization uses xpub -> keypath to enqure key uniqueness
1467 [ # # ]: 0 : if (!m_xpubs.contains(keypath)) {
1468 : : // Make a new set to put the xpub in
1469 [ # # # # : 0 : m_xpubs[keypath] = {xpub};
# # ]
1470 : : } else {
1471 : : // Insert xpub into existing set
1472 [ # # # # ]: 0 : m_xpubs[keypath].insert(xpub);
1473 : : }
1474 : : break;
1475 : 0 : }
1476 : 11 : case PSBT_GLOBAL_VERSION:
1477 : : {
1478 [ + - + - ]: 11 : ExpectedKeySize("Global PSBT Version", key, 1);
1479 : : uint32_t v;
1480 [ + - ]: 11 : UnserializeFromVector(s, v);
1481 : 11 : m_version = v;
1482 [ - + ]: 11 : if (*m_version > PSBT_HIGHEST_VERSION) {
1483 [ # # ]: 0 : throw std::ios_base::failure("Unsupported version number");
1484 : : }
1485 : : break;
1486 : : }
1487 [ # # ]: 0 : case PSBT_GLOBAL_PROPRIETARY:
1488 : : {
1489 [ # # ]: 0 : PSBTProprietary this_prop;
1490 : 0 : skey >> this_prop.identifier;
1491 [ # # ]: 0 : this_prop.subtype = ReadCompactSize(skey);
1492 [ # # ]: 0 : this_prop.key = key;
1493 : :
1494 : 0 : s >> this_prop.value;
1495 [ # # ]: 0 : m_proprietary.insert(this_prop);
1496 : : break;
1497 : 0 : }
1498 : : // Unknown stuff
1499 : 0 : default: {
1500 : : // Read in the value
1501 [ # # ]: 0 : std::vector<unsigned char> val_bytes;
1502 : 0 : s >> val_bytes;
1503 [ # # ]: 0 : unknown.emplace(std::move(key), std::move(val_bytes));
1504 : 0 : }
1505 : : }
1506 : : }
1507 : :
1508 : : if (!found_sep) {
1509 [ # # ]: 0 : throw std::ios_base::failure("Separator is missing at the end of the global map");
1510 : : }
1511 : :
1512 [ + - ]: 12 : const uint32_t psbt_ver = GetVersion();
1513 : :
1514 : : // Check PSBT version constraints
1515 [ + + ]: 12 : if (psbt_ver == 0) {
1516 : : // Make sure that we got an unsigned tx for PSBTv0
1517 [ - + ]: 1 : if (!tx) {
1518 [ # # ]: 0 : throw std::ios_base::failure("No unsigned transaction was provided");
1519 : : }
1520 : : // Make sure no PSBTv2 fields are present
1521 [ - + ]: 1 : if (found_tx_version) {
1522 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_TX_VERSION is not allowed in PSBTv0");
1523 : : }
1524 [ - + ]: 1 : if (found_fallback_locktime) {
1525 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_FALLBACK_LOCKTIME is not allowed in PSBTv0");
1526 : : }
1527 [ - + ]: 1 : if (found_input_count) {
1528 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_INPUT_COUNT is not allowed in PSBTv0");
1529 : : }
1530 [ - + ]: 1 : if (found_output_count) {
1531 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_OUTPUT_COUNT is not allowed in PSBTv0");
1532 : : }
1533 [ - + ]: 1 : if (m_tx_modifiable != std::nullopt) {
1534 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_TX_MODIFIABLE is not allowed in PSBTv0");
1535 : : }
1536 : : }
1537 : : // Disallow v1
1538 [ - + ]: 12 : if (psbt_ver == 1) {
1539 [ # # ]: 0 : throw std::ios_base::failure("There is no PSBT version 1");
1540 : : }
1541 [ + + ]: 12 : if (psbt_ver == 2) {
1542 : : // Tx version, input, and output counts are required
1543 [ - + ]: 11 : if (!found_tx_version) {
1544 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_TX_VERSION is required in PSBTv2");
1545 : : }
1546 [ - + ]: 11 : if (!found_input_count) {
1547 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_INPUT_COUNT is required in PSBTv2");
1548 : : }
1549 [ - + ]: 11 : if (!found_output_count) {
1550 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_OUTPUT_COUNT is required in PSBTv2");
1551 : : }
1552 : : // Unsigned tx is disallowed
1553 [ - + ]: 11 : if (tx) {
1554 [ # # ]: 0 : throw std::ios_base::failure("PSBT_GLOBAL_UNSIGNED_TX is not allowed in PSBTv2");
1555 : : }
1556 : : }
1557 [ - + ]: 12 : if (psbt_ver > 2) {
1558 [ # # ]: 0 : throw std::ios_base::failure("Unknown PSBT version");
1559 : : }
1560 : :
1561 : : // Read input data
1562 : : unsigned int i = 0;
1563 [ - + + - : 35 : while (!s.empty() && i < input_count) {
+ + ]
[ + - + + ]
1564 [ + + ]: 23 : if (psbt_ver < 2) {
1565 [ + - ]: 2 : inputs.emplace_back(psbt_ver, tx->vin[i].prevout.hash, tx->vin[i].prevout.n, tx->vin[i].nSequence);
1566 [ + - ]: 2 : s >> inputs.back();
1567 : : } else {
1568 [ + - ]: 21 : inputs.emplace_back(deserialize, s, psbt_ver);
1569 : : }
1570 : :
1571 : : // Make sure the non-witness utxo matches the outpoint
1572 : 23 : const PSBTInput& input = inputs.back();
1573 [ - + ]: 23 : if (input.non_witness_utxo) {
1574 [ # # ]: 0 : if (psbt_ver < 2) {
1575 [ # # # # ]: 0 : if (input.non_witness_utxo->GetHash() != tx->vin[i].prevout.hash) {
1576 [ # # ]: 0 : throw std::ios_base::failure("Non-witness UTXO does not match outpoint hash");
1577 : : }
1578 [ # # # # ]: 0 : if (tx->vin[i].prevout.n >= input.non_witness_utxo->vout.size()) {
1579 [ # # ]: 0 : throw std::ios_base::failure("Input specifies output index that does not exist");
1580 : : }
1581 : : } else {
1582 [ # # ]: 0 : if (input.non_witness_utxo->GetHash() != input.prev_txid) {
1583 [ # # ]: 0 : throw std::ios_base::failure("Non-witness UTXO does not match outpoint hash");
1584 : : }
1585 [ # # # # ]: 0 : if (input.prev_out >= input.non_witness_utxo->vout.size()) {
1586 [ # # ]: 0 : throw std::ios_base::failure("Input specifies output index that does not exist");
1587 : : }
1588 : : }
1589 : : }
1590 : 23 : ++i;
1591 : : }
1592 : : // Make sure that the number of inputs matches the number of inputs in the transaction
1593 [ - + - + ]: 12 : if (inputs.size() != input_count) {
1594 [ # # ]: 0 : throw std::ios_base::failure("Inputs provided does not match the number of inputs in transaction.");
1595 : : }
1596 : :
1597 : : // Read output data
1598 : : i = 0;
1599 [ - + + + : 26 : while (!s.empty() && i < output_count) {
- + ]
[ + + - + ]
1600 [ + + ]: 14 : if (psbt_ver < 2) {
1601 [ + - ]: 2 : outputs.emplace_back(psbt_ver, tx->vout[i].nValue, tx->vout[i].scriptPubKey);
1602 [ + - ]: 2 : s >> outputs.back();
1603 : : } else {
1604 [ + - ]: 12 : outputs.emplace_back(deserialize, s, psbt_ver);
1605 : : }
1606 : 14 : ++i;
1607 : : }
1608 : : // Make sure that the number of outputs matches the number of outputs in the transaction
1609 [ - + - + ]: 12 : if (outputs.size() != output_count) {
1610 [ # # ]: 0 : throw std::ios_base::failure("Outputs provided does not match the number of outputs in transaction.");
1611 : : }
1612 [ - - ]: 12 : }
1613 : :
1614 : : template <typename Stream>
1615 [ + - ]: 12 : PartiallySignedTransaction(deserialize_type, Stream& s) {
1616 [ + - ]: 12 : Unserialize(s);
1617 : 12 : }
1618 : : };
1619 : :
1620 : : enum class PSBTRole {
1621 : : CREATOR,
1622 : : UPDATER,
1623 : : SIGNER,
1624 : : FINALIZER,
1625 : : EXTRACTOR
1626 : : };
1627 : :
1628 : : std::string PSBTRoleName(PSBTRole role);
1629 : :
1630 : : /** Compute a PrecomputedTransactionData object from a psbt. */
1631 : : std::optional<PrecomputedTransactionData> PrecomputePSBTData(const PartiallySignedTransaction& psbt);
1632 : :
1633 : : /** Checks whether a PSBTInput is already signed by checking for non-null finalized fields. */
1634 : : bool PSBTInputSigned(const PSBTInput& input);
1635 : :
1636 : : /** Checks whether a PSBTInput is already signed by doing script verification using final fields. */
1637 : : bool PSBTInputSignedAndVerified(const PartiallySignedTransaction& psbt, unsigned int input_index, const PrecomputedTransactionData* txdata);
1638 : :
1639 : : /** Signs a PSBTInput, verifying that all provided data matches what is being signed.
1640 : : *
1641 : : * txdata should be the output of PrecomputePSBTData (which can be shared across
1642 : : * multiple SignPSBTInput calls). If it is nullptr, a dummy signature will be created.
1643 : : **/
1644 : : [[nodiscard]] util::Expected<void, PSBTError> SignPSBTInput(const SigningProvider& provider, PartiallySignedTransaction& psbt, int index, const PrecomputedTransactionData* txdata, const common::PSBTFillOptions& options, SignatureData* out_sigdata = nullptr);
1645 : :
1646 : : /** 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. */
1647 : : void RemoveUnnecessaryTransactions(PartiallySignedTransaction& psbtx);
1648 : :
1649 : : /** Counts the unsigned inputs of a PSBT. */
1650 : : size_t CountPSBTUnsignedInputs(const PartiallySignedTransaction& psbt);
1651 : :
1652 : : /** Updates a PSBTOutput with information from provider.
1653 : : *
1654 : : * This fills in the redeem_script, witness_script, and hd_keypaths where possible.
1655 : : */
1656 : : void UpdatePSBTOutput(const SigningProvider& provider, PartiallySignedTransaction& psbt, int index);
1657 : :
1658 : : /**
1659 : : * Finalizes a PSBT if possible, combining partial signatures.
1660 : : *
1661 : : * @param[in,out] psbtx PartiallySignedTransaction to finalize
1662 : : * return True if the PSBT is now complete, false otherwise
1663 : : */
1664 : : bool FinalizePSBT(PartiallySignedTransaction& psbtx);
1665 : :
1666 : : /**
1667 : : * Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized.
1668 : : *
1669 : : * @param[in] psbtx PartiallySignedTransaction
1670 : : * @param[out] result CMutableTransaction representing the complete transaction, if successful
1671 : : * @return True if we successfully extracted the transaction, false otherwise
1672 : : */
1673 : : bool FinalizeAndExtractPSBT(PartiallySignedTransaction& psbtx, CMutableTransaction& result);
1674 : :
1675 : : /**
1676 : : * Combines PSBTs with the same underlying transaction, resulting in a single PSBT with all partial signatures from each input.
1677 : : *
1678 : : * @param[in] psbtxs the PSBTs to combine
1679 : : * @return The combined PSBT or std::nullopt if the PSBTs cannot be combined
1680 : : */
1681 : : [[nodiscard]] std::optional<PartiallySignedTransaction> CombinePSBTs(const std::vector<PartiallySignedTransaction>& psbtxs);
1682 : :
1683 : : //! Decode a base64ed PSBT into a PartiallySignedTransaction
1684 : : [[nodiscard]] util::Result<PartiallySignedTransaction> DecodeBase64PSBT(const std::string& base64_tx);
1685 : : //! Decode a raw (binary blob) PSBT into a PartiallySignedTransaction
1686 : : [[nodiscard]] util::Result<PartiallySignedTransaction> DecodeRawPSBT(std::span<const std::byte> tx_data);
1687 : :
1688 : : #endif // BITCOIN_PSBT_H
|
