1// Copyright (c) 2017-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_RPC_RAWTRANSACTION_UTIL_H
6#define BITCOIN_RPC_RAWTRANSACTION_UTIL_H
7
8#include <addresstype.h>
9#include <consensus/amount.h>
10#include <rpc/util.h>
11
12#include <cstdint>
13#include <map>
14#include <optional>
15#include <string>
16#include <utility>
17#include <vector>
18
19struct bilingual_str;
20struct FlatSigningProvider;
21class UniValue;
22struct CMutableTransaction;
23class Coin;
24class COutPoint;
25class SigningProvider;
26
27/**
28 * Sign a transaction with the given keystore and previous transactions
29 *
30 * @param  mtx           The transaction to-be-signed
31 * @param  keystore      Temporary keystore containing signing keys
32 * @param  coins         Map of unspent outputs
33 * @param  hashType      The signature hash type
34 * @param result         JSON object where signed transaction results accumulate
35 */
36void SignTransaction(CMutableTransaction& mtx, const SigningProvider* keystore, const std::map<COutPoint, Coin>& coins, const UniValue& hashType, UniValue& result);
37void SignTransactionResultToJSON(CMutableTransaction& mtx, bool complete, const std::map<COutPoint, Coin>& coins, const std::map<int, bilingual_str>& input_errors, UniValue& result);
38
39/**
40  * Parse a prevtxs UniValue array and get the map of coins from it
41  *
42  * @param  prevTxsUnival Array of previous txns outputs that tx depends on but may not yet be in the block chain
43  * @param  keystore      A pointer to the temporary keystore if there is one
44  * @param  coins         Map of unspent outputs - coins in mempool and current chain UTXO set, may be extended by previous txns outputs after call
45  */
46void ParsePrevouts(const UniValue& prevTxsUnival, FlatSigningProvider* keystore, std::map<COutPoint, Coin>& coins);
47
48/** Normalize univalue-represented inputs and add them to the transaction */
49void AddInputs(CMutableTransaction& rawTx, const UniValue& inputs_in, bool rbf);
50
51/** Normalize univalue-represented outputs */
52UniValue NormalizeOutputs(const UniValue& outputs_in);
53
54/** Parse normalized outputs into destination, amount tuples */
55std::vector<std::pair<CTxDestination, CAmount>> ParseOutputs(const UniValue& outputs);
56
57/** Normalize, parse, and add outputs to the transaction */
58void AddOutputs(CMutableTransaction& rawTx, const UniValue& outputs_in);
59
60/** Create a transaction from univalue parameters */
61CMutableTransaction ConstructTransaction(const UniValue& inputs_in, const UniValue& outputs_in, const UniValue& locktime, std::optional<bool> rbf, uint32_t version);
62
63enum class ElisionMode {
64    None,        ///< no elision, all top-level fields rendered normally
65    WithSummary, ///< first field carries elision_summary as "...", rest skipped
66    Silent,      ///< all top-level fields skipped silently (no "..." line)
67};
68
69struct TxDocOptions {
70    /// The description of the txid field
71    std::string txid_field_doc{"The transaction id"};
72    /// Include wallet-related fields (e.g. ischange on outputs)
73    bool wallet{false};
74    /// Controls top-level field elision in the help
75    ElisionMode elision_mode{ElisionMode::None};
76    /// Summary text shown as "..." required for elision_mode == WithSummary
77    std::optional<std::string> elision_summary{};
78    /// Include prevout field
79    bool prevout{false};
80    /// Mark prevout field as optional (omitted when undo data unavailable)
81    bool prevout_optional{false};
82    /// Include fee field
83    bool fee{false};
84    /// Include hex field
85    bool hex{false};
86    /// Customize the vin item object's description (only meaningful when vin_inner_elision is set)
87    std::optional<std::string> vin_item_doc{};
88    /// Customize the prevout field's description (only meaningful when prevout is true)
89    std::optional<std::string> prevout_doc{};
90    /// Customize the fee field's description (only meaningful when fee is true)
91    std::optional<std::string> fee_doc{};
92    /// Elide vin inner fields but keep vin array with prevout expanded.
93    std::optional<std::string> vin_inner_elision{};
94};
95/** Explain the UniValue "decoded" transaction object, may include extra fields if processed by wallet **/
96std::vector<RPCResult> TxDoc(const TxDocOptions& opts = {});
97
98#endif // BITCOIN_RPC_RAWTRANSACTION_UTIL_H
99