27 std::vector<CRecipient>
CreateRecipients(
const std::vector<std::pair<CTxDestination, CAmount>>& outputs,
const std::set<int>& subtract_fee_outputs)
29 std::vector<CRecipient> recipients;
30 for (
size_t i = 0; i < outputs.size(); ++i) {
31 const auto& [destination, amount] = outputs.at(i);
32 CRecipient recipient{destination, amount, subtract_fee_outputs.contains(i)};
33 recipients.push_back(recipient);
40 if (options.
exists(
"conf_target") || options.
exists(
"estimate_mode")) {
45 options.
pushKV(
"conf_target", conf_target);
46 options.
pushKV(
"estimate_mode", estimate_mode);
48 if (options.
exists(
"fee_rate")) {
53 options.
pushKV(
"fee_rate", fee_rate);
55 if (!options[
"conf_target"].isNull() && (options[
"estimate_mode"].isNull() || (options[
"estimate_mode"].get_str() ==
"unset"))) {
62 std::set<int> sffo_set;
63 if (sffo_instructions.
isNull())
return sffo_set;
64 if (sffo_instructions.
isBool()) {
65 if (sffo_instructions.
get_bool()) sffo_set.insert(0);
68 for (
const auto& sffo : sffo_instructions.
getValues()) {
70 for (
size_t i = 0; i < destinations.size(); ++i) {
71 if (sffo.get_str() == destinations.at(i)) {
78 int pos = sffo.getInt<
int>();
79 if (sffo_set.contains(pos))
83 if (pos >=
int(destinations.size()))
110 const bool psbt_opt_in{options.
exists(
"psbt") && options[
"psbt"].
get_bool()};
111 bool add_to_wallet{options.
exists(
"add_to_wallet") ? options[
"add_to_wallet"].
get_bool() :
true};
112 if (psbt_opt_in || !complete || !add_to_wallet) {
122 result.
pushKV(
"txid", tx->GetHash().GetHex());
123 if (add_to_wallet && !psbt_opt_in) {
124 pwallet->CommitTransaction(tx, {}, {});
126 result.
pushKV(
"hex", hex);
129 result.
pushKV(
"complete", complete);
136 if (options.
exists(
"feeRate")) {
139 if (options.
exists(
"changeAddress")) {
142 if (options.
exists(
"changePosition")) {
145 if (options.
exists(
"includeWatching")) {
148 if (options.
exists(
"lockUnspents")) {
151 if (options.
exists(
"subtractFeeFromOutputs")) {
175 wallet.CommitTransaction(tx, std::move(map_value), {});
178 entry.
pushKV(
"txid", tx->GetHash().GetHex());
182 return tx->GetHash().GetHex();
202 if (!conf_target.
isNull()) {
203 throw JSONRPCError(
RPC_INVALID_PARAMETER,
"Cannot specify both conf_target and fee_rate. Please provide either a confirmation target in blocks for automatic fee estimation, or an explicit fee rate.");
205 if (!estimate_mode.
isNull() && estimate_mode.
get_str() !=
"unset") {
218 if (!conf_target.
isNull()) {
226 "\nSend an amount to a given address." +
232 "This is not part of the transaction, just kept in your wallet."},
234 "to which you're sending the transaction. This is not part of the \n"
235 "transaction, just kept in your wallet."},
237 "The recipient will receive less bitcoins than you enter in the amount field."},
242 {
"avoid_reuse",
RPCArg::Type::BOOL,
RPCArg::Default{
true},
"(only available if avoid_reuse wallet flag is set) Avoid spending from dirty addresses; addresses are considered\n"
243 "dirty if they have previously been used in a transaction. If true, this also activates avoidpartialspends, grouping outputs by their addresses."},
248 RPCResult{
"if verbose is not set or set to false",
262 "\nSend 0.1 BTC with a confirmation target of 6 blocks in economical fee estimate mode using positional arguments\n"
264 "\nSend 0.1 BTC with a fee rate of 1.1 " +
CURRENCY_ATOM +
"/vB, subtract fee from amount, BIP125-replaceable, using positional arguments\n"
266 "\nSend 0.2 BTC with a confirmation target of 6 blocks in economical fee estimate mode using named arguments\n"
268 "\nSend 0.5 BTC with a fee rate of 25 " +
CURRENCY_ATOM +
"/vB using named arguments\n"
270 +
HelpExampleCli(
"-named sendtoaddress",
"address=\"" +
EXAMPLE_ADDRESS[0] +
"\" amount=0.5 fee_rate=25 subtractfeefromamount=false replaceable=true avoid_reuse=true comment=\"2 pizzas\" comment_to=\"jeremy\" verbose=true")
279 pwallet->BlockUntilSyncedToCurrentChain();
281 LOCK(pwallet->cs_wallet);
285 if (!request.params[2].isNull() && !request.params[2].get_str().empty())
286 mapValue[
"comment"] = request.params[2].get_str();
287 if (!request.params[3].isNull() && !request.params[3].get_str().empty())
288 mapValue[
"to"] = request.params[3].get_str();
291 if (!request.params[5].isNull()) {
299 SetFeeEstimateMode(*pwallet, coin_control, request.params[6], request.params[7], request.params[9],
false);
304 const std::string address = request.params[0].get_str();
305 address_amounts.
pushKV(address, request.params[1]);
310 const bool verbose{request.params[10].isNull() ? false : request.params[10].get_bool()};
312 return SendMoney(*pwallet, coin_control, recipients, mapValue, verbose);
320 "Send multiple times. Amounts are double-precision floating point numbers." +
335 "The fee will be equally deducted from the amount of each selected address.\n"
336 "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
337 "If no addresses are specified here, the sender pays the fee.",
350 RPCResult{
"if verbose is not set or set to false",
352 "the number of addresses."
358 "the number of addresses."},
364 "\nSend two amounts to two different addresses:\n"
366 "\nSend two amounts to two different addresses setting the confirmation and comment:\n"
368 "\nSend two amounts to two different addresses, subtract fee from amount:\n"
370 "\nAs a JSON-RPC call\n"
380 pwallet->BlockUntilSyncedToCurrentChain();
382 LOCK(pwallet->cs_wallet);
384 if (!request.params[0].isNull() && !request.params[0].get_str().empty()) {
390 if (!request.params[3].isNull() && !request.params[3].get_str().empty())
391 mapValue[
"comment"] = request.params[3].
get_str();
394 if (!request.params[5].isNull()) {
398 SetFeeEstimateMode(*pwallet, coin_control, request.params[6], request.params[7], request.params[8],
false);
404 const bool verbose{request.params[9].isNull() ? false : request.params[9].get_bool()};
406 return SendMoney(*pwallet, coin_control, recipients, std::move(mapValue), verbose);
414 "\nSet the transaction fee rate in " +
CURRENCY_UNIT +
"/kvB for this wallet. Overrides the global -paytxfee command line parameter.\n"
415 "Can be deactivated by passing 0 as the fee. In that case automatic fee selection will be used by default.\n",
431 LOCK(pwallet->cs_wallet);
434 CFeeRate tx_fee_rate(nAmount, 1000);
435 CFeeRate max_tx_fee_rate(pwallet->m_default_max_tx_fee, 1000);
438 }
else if (tx_fee_rate < pwallet->chain().relayMinFee()) {
440 }
else if (tx_fee_rate < pwallet->m_min_fee) {
442 }
else if (tx_fee_rate > max_tx_fee_rate) {
446 pwallet->m_pay_tx_fee = tx_fee_rate;
454 static std::vector<RPCArg>
FundTxDoc(
bool solving_data =
true)
456 std::vector<RPCArg>
args = {
462 "Allows this transaction to be replaced by a transaction with higher fees"
467 "Used for fee estimation during coin selection.",
500 wallet.BlockUntilSyncedToCurrentChain();
502 std::optional<unsigned int> change_position;
503 bool lockUnspents =
false;
541 if (options.
exists(
"add_inputs")) {
545 if (options.
exists(
"changeAddress") || options.
exists(
"change_address")) {
546 const std::string change_address_str = (options.
exists(
"change_address") ? options[
"change_address"] : options[
"changeAddress"]).get_str();
556 if (options.
exists(
"changePosition") || options.
exists(
"change_position")) {
557 int pos = (options.
exists(
"change_position") ? options[
"change_position"] : options[
"changePosition"]).getInt<int>();
558 if (pos < 0 || (
unsigned int)pos > recipients.size()) {
561 change_position = (
unsigned int)pos;
564 if (options.
exists(
"change_type")) {
565 if (options.
exists(
"changeAddress") || options.
exists(
"change_address")) {
568 if (std::optional<OutputType> parsed =
ParseOutputType(options[
"change_type"].get_str())) {
575 const UniValue include_watching_option = options.
exists(
"include_watching") ? options[
"include_watching"] : options[
"includeWatching"];
578 if (options.
exists(
"lockUnspents") || options.
exists(
"lock_unspents")) {
579 lockUnspents = (options.
exists(
"lock_unspents") ? options[
"lock_unspents"] : options[
"lockUnspents"]).get_bool();
582 if (options.
exists(
"include_unsafe")) {
586 if (options.
exists(
"feeRate")) {
587 if (options.
exists(
"fee_rate")) {
590 if (options.
exists(
"conf_target")) {
591 throw JSONRPCError(
RPC_INVALID_PARAMETER,
"Cannot specify both conf_target and feeRate. Please provide either a confirmation target in blocks for automatic fee estimation, or an explicit fee rate.");
593 if (options.
exists(
"estimate_mode")) {
600 if (options.
exists(
"replaceable")) {
604 if (options.
exists(
"minconf")) {
612 if (options.
exists(
"maxconf")) {
619 SetFeeEstimateMode(
wallet, coinControl, options[
"conf_target"], options[
"estimate_mode"], options[
"fee_rate"], override_min_fee);
626 if (options.
exists(
"solving_data")) {
628 if (solving_data.
exists(
"pubkeys")) {
629 for (
const UniValue& pk_univ : solving_data[
"pubkeys"].get_array().getValues()) {
630 const std::string& pk_str = pk_univ.
get_str();
631 if (!
IsHex(pk_str)) {
634 const std::vector<unsigned char> data(
ParseHex(pk_str));
635 const CPubKey pubkey(data.begin(), data.end());
646 if (solving_data.
exists(
"scripts")) {
647 for (
const UniValue& script_univ : solving_data[
"scripts"].get_array().getValues()) {
648 const std::string& script_str = script_univ.get_str();
649 if (!
IsHex(script_str)) {
652 std::vector<unsigned char> script_data(
ParseHex(script_str));
653 const CScript script(script_data.begin(), script_data.end());
658 if (solving_data.
exists(
"descriptors")) {
659 for (
const UniValue& desc_univ : solving_data[
"descriptors"].get_array().getValues()) {
660 const std::string& desc_str = desc_univ.get_str();
663 std::vector<CScript> scripts_temp;
664 std::unique_ptr<Descriptor> desc =
Parse(desc_str, desc_out, error,
true);
668 desc->Expand(0, desc_out, scripts_temp, desc_out);
674 if (options.
exists(
"input_weights")) {
675 for (
const UniValue& input : options[
"input_weights"].get_array().getValues()) {
679 if (!vout_v.
isNum()) {
682 int vout = vout_v.
getInt<
int>();
688 if (!weight_v.
isNum()) {
691 int64_t weight = weight_v.
getInt<int64_t>();
694 if (weight < min_input_weight) {
695 throw JSONRPCError(
RPC_INVALID_PARAMETER,
"Invalid parameter, weight cannot be less than 165 (41 bytes (size of outpoint + sequence + empty scriptSig) * 4 (witness scaling factor)) + 1 (empty witness)");
705 if (recipients.empty())
717 if (options.
exists(
"input_weights")) {
720 if (inputs.
size() == 0) {
725 if (input.exists(
"weight")) {
729 options.
pushKV(
"input_weights", weights);
735 "\nIf the transaction has no inputs, they will be automatically selected to meet its out value.\n"
736 "It will add at most one change output to the outputs.\n"
737 "No existing outputs will be modified unless \"subtractFeeFromOutputs\" is specified.\n"
738 "Note that inputs which were signed may need to be resigned after completion since in/outputs have been added.\n"
739 "The inputs added will not be signed, use signrawtransactionwithkey\n"
740 "or signrawtransactionwithwallet for that.\n"
741 "All existing inputs must either have their previous output transaction be in the wallet\n"
742 "or be in the UTXO set. Solving data must be provided for non-wallet inputs.\n"
743 "Note that all inputs selected must be of standard form and P2SH scripts must be\n"
744 "in the wallet using importaddress or addmultisigaddress (to calculate fees).\n"
745 "You can see whether this is the case by checking the \"solvable\" field in the listunspent output.\n"
746 "Only pay-to-pubkey, multisig, and P2SH versions thereof are currently supported for watch-only\n",
750 Cat<std::vector<RPCArg>>(
753 {
"include_unsafe",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
754 "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
755 "If that happens, you will need to fund the transaction with different inputs and republish it."},
760 {
"change_type",
RPCArg::Type::STR,
RPCArg::DefaultHint{
"set by -changetype"},
"The output type to use. Only valid if changeAddress is not specified. Options are \"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"."},
762 "Only solvable inputs can be used. Watch-only destinations are solvable if the public key and/or output script was imported,\n"
763 "e.g. with 'importpubkey' or 'importmulti' with the 'pubkeys' or 'desc' field."},
768 "The fee will be equally deducted from the amount of each specified output.\n"
769 "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
770 "If no outputs are specified here, the sender pays the fee.",
782 "including the weight of the outpoint and sequence number. "
783 "Note that serialized signature sizes are not guaranteed to be consistent, "
784 "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
785 "Remember to convert serialized sizes to weight units when necessary."},
794 .oneline_description =
"options",
797 "If iswitness is not present, heuristic tests will be used in decoding.\n"
798 "If true, only witness deserialization will be tried.\n"
799 "If false, only non-witness deserialization will be tried.\n"
800 "This boolean should reflect whether the transaction has inputs\n"
801 "(e.g. fully valid, or on-chain transactions), if known by the caller."
813 "\nCreate a transaction with no inputs\n"
814 +
HelpExampleCli(
"createrawtransaction",
"\"[]\" \"{\\\"myaddress\\\":0.01}\"") +
815 "\nAdd sufficient unsigned inputs to meet the output value\n"
817 "\nSign the transaction\n"
818 +
HelpExampleCli(
"signrawtransactionwithwallet",
"\"fundedtransactionhex\"") +
819 "\nSend the transaction\n"
820 +
HelpExampleCli(
"sendrawtransaction",
"\"signedtransactionhex\"")
829 bool try_witness = request.params[2].isNull() ? true : request.params[2].get_bool();
830 bool try_no_witness = request.params[2].isNull() ? true : !request.params[2].get_bool();
831 if (!
DecodeHexTx(tx, request.params[0].get_str(), try_no_witness, try_witness)) {
834 UniValue options = request.params[1];
835 std::vector<std::pair<CTxDestination, CAmount>> destinations;
836 for (
const auto& tx_out : tx.
vout) {
839 destinations.emplace_back(dest, tx_out.nValue);
841 std::vector<std::string> dummy(destinations.size(),
"dummy");
852 auto txr =
FundTransaction(*pwallet, tx, recipients, options, coin_control,
true);
857 result.
pushKV(
"changepos", txr.change_pos ? (
int)*txr.change_pos : -1);
866 return RPCHelpMan{
"signrawtransactionwithwallet",
867 "\nSign inputs for raw transaction (serialized, hex-encoded).\n"
868 "The second optional argument (may be null) is an array of previous transaction outputs that\n"
869 "this transaction depends on but may not yet be in the block chain." +
892 " \"ALL|ANYONECANPAY\"\n"
893 " \"NONE|ANYONECANPAY\"\n"
894 " \"SINGLE|ANYONECANPAY\""},
928 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
933 LOCK(pwallet->cs_wallet);
937 std::map<COutPoint, Coin> coins;
941 pwallet->chain().findCoins(coins);
949 std::map<int, bilingual_str> input_errors;
951 bool complete = pwallet->SignTransaction(mtx, coins, nHashType, input_errors);
968 "the value (float or string) is the amount in " +
CURRENCY_UNIT +
""},
981 const bool want_psbt = method_name ==
"psbtbumpfee";
985 "\nBumps the fee of an opt-in-RBF transaction T, replacing it with a new transaction B.\n"
986 + std::string(want_psbt ?
"Returns a PSBT instead of creating and signing a new transaction.\n" :
"") +
987 "An opt-in RBF transaction with the given txid must be in the wallet.\n"
988 "The command will pay the additional fee by reducing change outputs or adding inputs when necessary.\n"
989 "It may add a new change output if one does not already exist.\n"
990 "All inputs in the original transaction will be included in the replacement transaction.\n"
991 "The command will fail if the wallet or mempool contains a transaction that spends one of T's outputs.\n"
992 "By default, the new fee will be calculated automatically using the estimatesmartfee RPC.\n"
993 "The user can specify a confirmation target for estimatesmartfee.\n"
994 "Alternatively, the user can specify a fee rate in " +
CURRENCY_ATOM +
"/vB for the new transaction.\n"
995 "At a minimum, the new fee rate must be high enough to pay an additional new relay fee (incrementalfee\n"
996 "returned by getnetworkinfo) to enter the node's mempool.\n"
997 "* WARNING: before version 0.21, fee_rate was in " +
CURRENCY_UNIT +
"/kvB. As of 0.21, fee_rate is in " +
CURRENCY_ATOM +
"/vB. *\n",
1004 "\nSpecify a fee rate in " +
CURRENCY_ATOM +
"/vB instead of relying on the built-in fee estimator.\n"
1005 "Must be at least " + incremental_fee +
" higher than the current transaction fee rate.\n"
1006 "WARNING: before version 0.21, fee_rate was in " +
CURRENCY_UNIT +
"/kvB. As of 0.21, fee_rate is in " +
CURRENCY_ATOM +
"/vB.\n"},
1008 "marked bip-125 replaceable. If true, the sequence numbers in the transaction will\n"
1009 "be left unchanged from the original. If false, any input sequence numbers in the\n"
1010 "original transaction that were less than 0xfffffffe will be increased to 0xfffffffe\n"
1011 "so the new transaction will not be explicitly bip-125 replaceable (though it may\n"
1012 "still be replaceable in practice, for example if it has unconfirmed ancestors which\n"
1013 "are replaceable).\n"},
1017 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1018 "At least one output of either type must be specified.\n"
1019 "Cannot be provided if 'original_change_index' is specified.",
1022 {
"original_change_index",
RPCArg::Type::NUM,
RPCArg::DefaultHint{
"not set, detect change automatically"},
"The 0-based index of the change output on the original transaction. "
1023 "The indicated output will be recycled into the new change output on the bumped transaction. "
1024 "The remainder after paying the recipients and fees will be sent to the output script of the "
1025 "original change output. The change output’s amount can increase if bumping the transaction "
1026 "adds new inputs, otherwise it will decrease. Cannot be used in combination with the 'outputs' option."},
1033 std::vector<RPCResult>{{
RPCResult::Type::STR,
"psbt",
"The base64-encoded unsigned PSBT of the new transaction."}} :
1045 "\nBump the fee, get the new transaction\'s " + std::string(want_psbt ?
"psbt" :
"txid") +
"\n" +
1054 throw JSONRPCError(
RPC_WALLET_ERROR,
"bumpfee is not available with wallets that have private keys disabled. Use psbtbumpfee instead.");
1063 std::vector<CTxOut> outputs;
1065 std::optional<uint32_t> original_change_index;
1067 if (!request.params[1].isNull()) {
1068 UniValue options = request.params[1];
1081 if (options.
exists(
"confTarget") && options.
exists(
"conf_target")) {
1085 auto conf_target = options.
exists(
"confTarget") ? options[
"confTarget"] : options[
"conf_target"];
1087 if (options.
exists(
"replaceable")) {
1090 SetFeeEstimateMode(*pwallet, coin_control, conf_target, options[
"estimate_mode"], options[
"fee_rate"],
false);
1093 if (!options[
"outputs"].isNull()) {
1094 if (options[
"outputs"].isArray() && options[
"outputs"].empty()) {
1099 outputs = tempTx.
vout;
1102 if (options.
exists(
"original_change_index")) {
1103 original_change_index = options[
"original_change_index"].
getInt<uint32_t>();
1109 pwallet->BlockUntilSyncedToCurrentChain();
1111 LOCK(pwallet->cs_wallet);
1116 std::vector<bilingual_str> errors;
1163 bool complete =
false;
1176 result_errors.
push_back(error.original);
1178 result.
pushKV(
"errors", result_errors);
1191 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n"
1192 "\nSend a transaction.\n",
1195 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1196 "At least one output of either type must be specified.\n"
1197 "For convenience, a dictionary, which holds the key-value pairs directly, is also accepted.",
1205 Cat<std::vector<RPCArg>>(
1207 {
"add_inputs",
RPCArg::Type::BOOL,
RPCArg::DefaultHint{
"false when \"inputs\" are specified, true otherwise"},
"Automatically include coins from the wallet to cover the target amount.\n"},
1208 {
"include_unsafe",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
1209 "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
1210 "If that happens, you will need to fund the transaction with different inputs and republish it."},
1213 {
"add_to_wallet",
RPCArg::Type::BOOL,
RPCArg::Default{
true},
"When false, returns a serialized transaction which will not be added to the wallet or broadcast"},
1216 {
"change_type",
RPCArg::Type::STR,
RPCArg::DefaultHint{
"set by -changetype"},
"The output type to use. Only valid if change_address is not specified. Options are \"legacy\", \"p2sh-segwit\", \"bech32\" and \"bech32m\"."},
1219 "Only solvable inputs can be used. Watch-only destinations are solvable if the public key and/or output script was imported,\n"
1220 "e.g. with 'importpubkey' or 'importmulti' with the 'pubkeys' or 'desc' field."},
1227 "including the weight of the outpoint and sequence number. "
1228 "Note that signature sizes are not guaranteed to be consistent, "
1229 "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
1230 "Remember to convert serialized sizes to weight units when necessary."},
1237 "The fee will be equally deducted from the amount of each specified output.\n"
1238 "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
1239 "If no outputs are specified here, the sender pays the fee.",
1252 {
RPCResult::Type::STR_HEX,
"txid",
true,
"The transaction id for the send. Only 1 transaction is created regardless of the number of addresses."},
1253 {
RPCResult::Type::STR_HEX,
"hex",
true,
"If add_to_wallet is false, the hex-encoded raw transaction with signature(s)"},
1254 {
RPCResult::Type::STR,
"psbt",
true,
"If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction"}
1258 "\nSend 0.1 BTC with a confirmation target of 6 blocks in economical fee estimate mode\n"
1260 "Send 0.2 BTC with a fee rate of 1.1 " +
CURRENCY_ATOM +
"/vB using positional arguments\n"
1262 "Send 0.2 BTC with a fee rate of 1 " +
CURRENCY_ATOM +
"/vB using the options argument\n"
1264 "Send 0.3 BTC with a fee rate of 25 " +
CURRENCY_ATOM +
"/vB using named arguments\n"
1266 "Create a transaction that should confirm the next block, with a specific input, and return result without adding to wallet or broadcasting to the network\n"
1267 +
HelpExampleCli(
"send",
"'{\"" +
EXAMPLE_ADDRESS[0] +
"\": 0.1}' 1 economical '{\"add_to_wallet\": false, \"inputs\": [{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\", \"vout\":1}]}'")
1279 bool rbf{options.exists(
"replaceable") ? options[
"replaceable"].get_bool() : pwallet->m_signal_rbf};
1295 auto txr =
FundTransaction(*pwallet, rawTx, recipients, options, coin_control,
false);
1305 "EXPERIMENTAL warning: this call may be changed in future releases.\n"
1306 "\nSpend the value of all (or specific) confirmed UTXOs in the wallet to one or more recipients.\n"
1307 "Unconfirmed inbound UTXOs and locked UTXOs will not be spent. Sendall will respect the avoid_reuse wallet flag.\n"
1308 "If your wallet contains many small inputs, either because it received tiny payments or as a result of accumulating change, consider using `send_max` to exclude inputs that are worth less than the fees needed to spend them.\n",
1311 "Optionally some recipients can be specified with an amount to perform payments, but at least one address must appear without a specified amount.\n",
1327 Cat<std::vector<RPCArg>>(
1332 "Only solvable inputs can be used. Watch-only destinations are solvable if the public key and/or output script was imported,\n"
1333 "e.g. with 'importpubkey' or 'importmulti' with the 'pubkeys' or 'desc' field."},
1348 {
"send_max",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"When true, only use UTXOs that can pay for their own fees to maximize the output amount. When 'false' (default), no UTXO is left behind. send_max is incompatible with providing specific inputs."},
1361 {
RPCResult::Type::STR_HEX,
"txid",
true,
"The transaction id for the send. Only 1 transaction is created regardless of the number of addresses."},
1362 {
RPCResult::Type::STR_HEX,
"hex",
true,
"If add_to_wallet is false, the hex-encoded raw transaction with signature(s)"},
1363 {
RPCResult::Type::STR,
"psbt",
true,
"If more signatures are needed, or if add_to_wallet is false, the base64-encoded (partially) signed transaction"}
1367 "\nSpend all UTXOs from the wallet with a fee rate of 1Â " +
CURRENCY_ATOM +
"/vB using named arguments\n"
1369 "Spend all UTXOs with a fee rate of 1.1 " +
CURRENCY_ATOM +
"/vB using positional arguments\n"
1371 "Spend all UTXOs split into equal amounts to two addresses with a fee rate of 1.5 " +
CURRENCY_ATOM +
"/vB using the options argument\n"
1373 "Leave dust UTXOs in wallet, spend only UTXOs with positive effective value with a fee rate of 10 " +
CURRENCY_ATOM +
"/vB using the options argument\n"
1375 "Spend all UTXOs with a fee rate of 1.3 " +
CURRENCY_ATOM +
"/vB using named arguments and sending a 0.25 " +
CURRENCY_UNIT +
" to another recipient\n"
1384 pwallet->BlockUntilSyncedToCurrentChain();
1391 std::set<std::string> addresses_without_amount;
1393 const UniValue& recipients{request.params[0]};
1394 for (
unsigned int i = 0; i < recipients.size(); ++i) {
1395 const UniValue& recipient{recipients[i]};
1396 if (recipient.isStr()) {
1398 rkvp.
pushKV(recipient.get_str(), 0);
1399 recipient_key_value_pairs.
push_back(rkvp);
1400 addresses_without_amount.insert(recipient.get_str());
1402 recipient_key_value_pairs.
push_back(recipient);
1406 if (addresses_without_amount.size() == 0) {
1412 SetFeeEstimateMode(*pwallet, coin_control, options[
"conf_target"], options[
"estimate_mode"], options[
"fee_rate"],
false);
1416 if (options.exists(
"minconf")) {
1417 if (options[
"minconf"].getInt<int>() < 0)
1422 coin_control.
m_min_depth = options[
"minconf"].getInt<
int>();
1425 if (options.exists(
"maxconf")) {
1426 coin_control.
m_max_depth = options[
"maxconf"].getInt<
int>();
1433 const bool rbf{options.exists(
"replaceable") ? options[
"replaceable"].get_bool() : pwallet->m_signal_rbf};
1448 LOCK(pwallet->cs_wallet);
1451 bool send_max{options.exists(
"send_max") ? options[
"send_max"].get_bool() :
false};
1452 if (options.exists(
"inputs") && options.exists(
"send_max")) {
1454 }
else if (options.exists(
"inputs") && (options.exists(
"minconf") || options.exists(
"maxconf"))) {
1456 }
else if (options.exists(
"inputs")) {
1457 for (
const CTxIn& input : rawTx.vin) {
1458 if (pwallet->IsSpent(input.
prevout)) {
1465 total_input_value += tx->tx->vout[input.
prevout.
n].nValue;
1472 if (send_max && fee_rate.GetFee(output.input_bytes) > output.txout.nValue) {
1476 rawTx.vin.push_back(input);
1477 total_input_value += output.txout.nValue;
1483 const CAmount fee_from_size{fee_rate.GetFee(tx_size.vsize)};
1484 const CAmount effective_value{total_input_value - fee_from_size};
1486 if (fee_from_size > pwallet->m_default_max_tx_fee) {
1490 if (effective_value <= 0) {
1503 CAmount output_amounts_claimed{0};
1505 output_amounts_claimed +=
out.nValue;
1508 if (output_amounts_claimed > total_input_value) {
1512 const CAmount remainder{effective_value - output_amounts_claimed};
1513 if (remainder < 0) {
1517 const CAmount per_output_without_amount{remainder / (long)addresses_without_amount.size()};
1519 bool gave_remaining_to_first{
false};
1524 if (addresses_without_amount.count(addr) > 0) {
1525 out.nValue = per_output_without_amount;
1526 if (!gave_remaining_to_first) {
1527 out.nValue += remainder % addresses_without_amount.size();
1528 gave_remaining_to_first =
true;
1530 if (
IsDust(
out, pwallet->chain().relayDustFee())) {
1535 if (
IsDust(
out, pwallet->chain().relayDustFee())) {
1542 const bool lock_unspents{options.exists(
"lock_unspents") ? options[
"lock_unspents"].get_bool() :
false};
1543 if (lock_unspents) {
1544 for (
const CTxIn& txin : rawTx.vin) {
1545 pwallet->LockCoin(txin.
prevout);
1557 "\nUpdate a PSBT with input information from our wallet and then sign inputs\n"
1558 "that we can sign for." +
1563 {
"sighashtype",
RPCArg::Type::STR,
RPCArg::Default{
"DEFAULT for Taproot, ALL otherwise"},
"The signature hash type to sign with if not specified by the PSBT. Must be one of\n"
1568 " \"ALL|ANYONECANPAY\"\n"
1569 " \"NONE|ANYONECANPAY\"\n"
1570 " \"SINGLE|ANYONECANPAY\""},
1593 wallet.BlockUntilSyncedToCurrentChain();
1606 bool sign = request.params[1].isNull() ? true : request.params[1].get_bool();
1607 bool bip32derivs = request.params[3].isNull() ? true : request.params[3].get_bool();
1608 bool finalize = request.params[4].isNull() ? true : request.params[4].get_bool();
1609 bool complete =
true;
1613 const TransactionError err{
wallet.FillPSBT(psbtx, complete, nHashType, sign, bip32derivs,
nullptr, finalize)};
1622 result.
pushKV(
"complete", complete);
1640 "\nCreates and funds a transaction in the Partially Signed Transaction format.\n"
1641 "Implements the Creator and Updater roles.\n"
1642 "All existing inputs must either have their previous output transaction be in the wallet\n"
1643 "or be in the UTXO set. Solving data must be provided for non-wallet inputs.\n",
1653 "including the weight of the outpoint and sequence number. "
1654 "Note that signature sizes are not guaranteed to be consistent, "
1655 "so the maximum DER signatures size of 73 bytes should be used when considering ECDSA signatures."
1656 "Remember to convert serialized sizes to weight units when necessary."},
1662 "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
1663 "At least one output of either type must be specified.\n"
1664 "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
1665 "accepted as second parameter.",
1670 Cat<std::vector<RPCArg>>(
1672 {
"add_inputs",
RPCArg::Type::BOOL,
RPCArg::DefaultHint{
"false when \"inputs\" are specified, true otherwise"},
"Automatically include coins from the wallet to cover the target amount.\n"},
1673 {
"include_unsafe",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"Include inputs that are not safe to spend (unconfirmed transactions from outside keys and unconfirmed replacement transactions).\n"
1674 "Warning: the resulting transaction may become invalid if one of the unsafe inputs disappears.\n"
1675 "If that happens, you will need to fund the transaction with different inputs and republish it."},
1680 {
"change_type",
RPCArg::Type::STR,
RPCArg::DefaultHint{
"set by -changetype"},
"The output type to use. Only valid if changeAddress is not specified. Options are \"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"."},
1686 "The fee will be equally deducted from the amount of each specified output.\n"
1687 "Those recipients will receive less bitcoins than you enter in their corresponding amount field.\n"
1688 "If no outputs are specified here, the sender pays the fee.",
1707 "\nCreate a transaction with no inputs\n"
1708 +
HelpExampleCli(
"walletcreatefundedpsbt",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")
1718 wallet.BlockUntilSyncedToCurrentChain();
1722 const UniValue &replaceable_arg = options[
"replaceable"];
1745 bool bip32derivs = request.params[4].isNull() ? true : request.params[4].get_bool();
1746 bool complete =
true;
1759 result.
pushKV(
"changepos", txr.change_pos ? (
int)*txr.change_pos : -1);
bool ExtractDestination(const CScript &scriptPubKey, CTxDestination &addressRet)
Parse a scriptPubKey for the destination.
bool IsValidDestination(const CTxDestination &dest)
Check whether a CTxDestination corresponds to one with an address.
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
int64_t CAmount
Amount in satoshis (Can be negative)
static CAmount AmountFromValue(const UniValue &value)
#define CHECK_NONFATAL(condition)
Identity function.
Fee rate in satoshis per kilovirtualbyte: CAmount / kvB.
std::string ToString(const FeeEstimateMode &fee_estimate_mode=FeeEstimateMode::BTC_KVB) const
An outpoint - a combination of a transaction hash and an index n into its vout.
An encapsulated public key.
CKeyID GetID() const
Get the KeyID of this public key (hash of its serialization)
bool IsFullyValid() const
fully validate whether this is a valid public key (more expensive than IsValid())
Serialized script, used inside transaction inputs and outputs.
A reference to a CScript: the Hash160 of its serialization.
The basic transaction that is broadcasted on the network and contained in blocks.
An input of a transaction.
static const uint32_t SEQUENCE_FINAL
Setting nSequence to this value for every input in a transaction disables nLockTime/IsFinalTx().
An output of a transaction.
Double ended buffer combining vector and stream-like interfaces.
void push_back(UniValue val)
const std::string & get_str() const
const UniValue & find_value(std::string_view key) const
const UniValue & get_obj() const
const std::vector< UniValue > & getValues() const
const std::vector< std::string > & getKeys() const
bool exists(const std::string &key) const
void pushKV(std::string key, UniValue val)
std::string GetHex() const
std::string ToString() const
static transaction_identifier FromUint256(const uint256 &id)
FeeEstimateMode m_fee_mode
Fee estimation mode to control arguments to estimateSmartFee.
std::optional< bool > m_signal_bip125_rbf
Override the wallet's m_signal_rbf if set.
std::optional< unsigned int > m_confirm_target
Override the default confirmation target if set.
std::optional< OutputType > m_change_type
Override the default change type if set, ignored if destChange is set.
bool m_avoid_address_reuse
Forbids inclusion of dirty (previously used) addresses.
int m_min_depth
Minimum chain depth value for coin availability.
bool m_allow_other_inputs
If true, the selection process can add extra unselected inputs from the wallet while requires all sel...
int m_max_depth
Maximum chain depth value for coin availability.
bool fOverrideFeeRate
Override automatic min/max checks on fee, m_feerate must be set if true.
void SetInputWeight(const COutPoint &outpoint, int64_t weight)
Set an input's weight.
std::optional< CFeeRate > m_feerate
Override the wallet's m_pay_tx_fee if set.
bool m_include_unsafe_inputs
If false, only safe inputs will be used.
bool m_avoid_partial_spends
Avoid partial use of funds sent to a given address.
bool fAllowWatchOnly
Includes watch only addresses which are solvable.
FlatSigningProvider m_external_provider
SigningProvider that has pubkeys and scripts to do spend size estimation for external inputs.
CTxDestination destChange
Custom change destination, if not set an address is generated.
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
A transaction with a bunch of additional info that only the owner cares about.
static UniValue Parse(std::string_view raw)
Parse string to UniValue or throw runtime_error if string contains invalid JSON.
static int64_t GetTransactionInputWeight(const CTxIn &txin)
std::string EncodeHexTx(const CTransaction &tx)
UniValue ValueFromAmount(const CAmount amount)
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness=false, bool try_witness=true)
bilingual_str TransactionErrorString(const TransactionError err)
const std::string CURRENCY_ATOM
const std::string CURRENCY_UNIT
@ SAT_VB
Use sat/vB fee rate unit.
@ SIGHASH_DEFAULT
Taproot only; implied when sighash byte is missing, and equivalent to SIGHASH_ALL.
CTxDestination DecodeDestination(const std::string &str, std::string &error_msg, std::vector< int > *error_locations)
std::string EncodeDestination(const CTxDestination &dest)
bilingual_str ErrorString(const Result< T > &result)
Result CreateRateBumpTransaction(CWallet &wallet, const uint256 &txid, const CCoinControl &coin_control, std::vector< bilingual_str > &errors, CAmount &old_fee, CAmount &new_fee, CMutableTransaction &mtx, bool require_mine, const std::vector< CTxOut > &outputs, std::optional< uint32_t > original_change_index)
Create bumpfee transaction based on feerate estimates.
Result CommitTransaction(CWallet &wallet, const uint256 &txid, CMutableTransaction &&mtx, std::vector< bilingual_str > &errors, uint256 &bumped_txid)
Commit the bumpfee transaction.
bool SignTransaction(CWallet &wallet, CMutableTransaction &mtx)
Sign the new transaction,.
std::vector< CRecipient > CreateRecipients(const std::vector< std::pair< CTxDestination, CAmount >> &outputs, const std::set< int > &subtract_fee_outputs)
CreatedTransactionResult FundTransaction(CWallet &wallet, const CMutableTransaction &tx, const std::vector< CRecipient > &recipients, const UniValue &options, CCoinControl &coinControl, bool override_min_fee)
std::shared_ptr< CWallet > GetWalletForJSONRPCRequest(const JSONRPCRequest &request)
Figures out what wallet, if any, to use for a JSONRPCRequest.
util::Result< CreatedTransactionResult > CreateTransaction(CWallet &wallet, const std::vector< CRecipient > &vecSend, std::optional< unsigned int > change_pos, const CCoinControl &coin_control, bool sign)
Create a new transaction paying the recipients with a set of coins selected by SelectCoins(); Also cr...
std::set< int > InterpretSubtractFeeFromOutputInstructions(const UniValue &sffo_instructions, const std::vector< std::string > &destinations)
std::map< std::string, std::string > mapValue_t
static RPCHelpMan bumpfee_helper(std::string method_name)
RPCHelpMan walletprocesspsbt()
void EnsureWalletIsUnlocked(const CWallet &wallet)
const std::string HELP_REQUIRING_PASSPHRASE
static void SetFeeEstimateMode(const CWallet &wallet, CCoinControl &cc, const UniValue &conf_target, const UniValue &estimate_mode, const UniValue &fee_rate, bool override_min_fee)
Update coin control with fee estimation based on the given parameters.
RPCHelpMan walletcreatefundedpsbt()
static void InterpretFeeEstimationInstructions(const UniValue &conf_target, const UniValue &estimate_mode, const UniValue &fee_rate, UniValue &options)
static void SetOptionsInputWeights(const UniValue &inputs, UniValue &options)
RPCHelpMan signrawtransactionwithwallet()
CFeeRate GetMinimumFeeRate(const CWallet &wallet, const CCoinControl &coin_control, FeeCalculation *feeCalc)
Estimate the minimum fee rate considering user set parameters and the required fee.
UniValue SendMoney(CWallet &wallet, const CCoinControl &coin_control, std::vector< CRecipient > &recipients, mapValue_t map_value, bool verbose)
static void PreventOutdatedOptions(const UniValue &options)
static UniValue FinishTransaction(const std::shared_ptr< CWallet > pwallet, const UniValue &options, const CMutableTransaction &rawTx)
bool ParseIncludeWatchonly(const UniValue &include_watchonly, const CWallet &wallet)
Used by RPC commands that have an include_watchonly parameter.
bool GetAvoidReuseFlag(const CWallet &wallet, const UniValue ¶m)
static std::vector< RPCArg > OutputsDoc()
RPCHelpMan fundrawtransaction()
TxSize CalculateMaximumSignedTxSize(const CTransaction &tx, const CWallet *wallet, const std::vector< CTxOut > &txouts, const CCoinControl *coin_control)
Calculate the size of the transaction using CoinControl to determine whether to expect signature grin...
static std::vector< RPCArg > FundTxDoc(bool solving_data=true)
@ WALLET_FLAG_EXTERNAL_SIGNER
Indicates that the wallet needs an external signer.
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
RPCHelpMan sendtoaddress()
CoinsResult AvailableCoins(const CWallet &wallet, const CCoinControl *coinControl, std::optional< CFeeRate > feerate, const CoinFilterParams ¶ms)
Populate the CoinsResult struct with vectors of available COutputs, organized by OutputType.
std::optional< OutputType > ParseOutputType(const std::string &type)
bool IsDust(const CTxOut &txout, const CFeeRate &dustRelayFeeIn)
static constexpr unsigned int DEFAULT_INCREMENTAL_RELAY_FEE
Default for -incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or rep...
static constexpr int32_t MAX_STANDARD_TX_WEIGHT
The maximum weight for transactions we're willing to relay/mine.
static constexpr TransactionSerParams TX_WITH_WITNESS
static CTransactionRef MakeTransactionRef(Tx &&txIn)
std::shared_ptr< const CTransaction > CTransactionRef
bool DecodeBase64PSBT(PartiallySignedTransaction &psbt, const std::string &base64_tx, std::string &error)
Decode a base64ed PSBT into a PartiallySignedTransaction.
bool FinalizeAndExtractPSBT(PartiallySignedTransaction &psbtx, CMutableTransaction &result)
Finalizes a PSBT if possible, and extracts it to a CMutableTransaction if it could be finalized.
void SignTransactionResultToJSON(CMutableTransaction &mtx, bool complete, const std::map< COutPoint, Coin > &coins, const std::map< int, bilingual_str > &input_errors, UniValue &result)
CMutableTransaction ConstructTransaction(const UniValue &inputs_in, const UniValue &outputs_in, const UniValue &locktime, std::optional< bool > rbf)
Create a transaction from univalue parameters.
void AddOutputs(CMutableTransaction &rawTx, const UniValue &outputs_in)
Normalize, parse, and add outputs to the transaction.
void ParsePrevouts(const UniValue &prevTxsUnival, FillableSigningProvider *keystore, std::map< COutPoint, Coin > &coins)
Parse a prevtxs UniValue array and get the map of coins from it.
UniValue NormalizeOutputs(const UniValue &outputs_in)
Normalize univalue-represented outputs.
std::vector< std::pair< CTxDestination, CAmount > > ParseOutputs(const UniValue &outputs)
Parse normalized outputs into destination, amount tuples.
UniValue JSONRPCError(int code, const std::string &message)
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_WALLET_INSUFFICIENT_FUNDS
Not enough funds in wallet or account.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_WALLET_ERROR
Wallet errors.
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
@ RPC_INVALID_REQUEST
Standard JSON-RPC 2.0 errors.
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
int ParseSighashString(const UniValue &sighash)
Returns a sighash value corresponding to the passed in argument.
UniValue JSONRPCTransactionError(TransactionError terr, const std::string &err_string)
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
const std::string EXAMPLE_ADDRESS[2]
Example bech32 addresses for the RPCExamples help documentation.
uint256 ParseHashO(const UniValue &o, std::string_view strKey)
unsigned int ParseConfirmTarget(const UniValue &value, unsigned int max_target)
Parse a confirm target option and raise an RPC error if it is invalid.
void RPCTypeCheckObj(const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull, bool fStrict)
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
std::vector< Byte > ParseHex(std::string_view hex_str)
Like TryParseHex, but returns an empty vector on invalid input.
A mutable version of CTransaction.
std::vector< CTxOut > vout
FlatSigningProvider & Merge(FlatSigningProvider &&b) LIFETIMEBOUND
std::map< CKeyID, CPubKey > pubkeys
std::map< CScriptID, CScript > scripts
A version of CTransaction with the PSBT format.
@ OBJ_USER_KEYS
Special type where the user must set the keys e.g. to define multiple addresses; as opposed to e....
@ STR_HEX
Special type that is a STR with only hex chars.
@ AMOUNT
Special type representing a floating point amount (can be either NUM or STR)
@ OBJ_NAMED_PARAMS
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
std::string DefaultHint
Hint for default value.
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
bool also_positional
If set allows a named-parameter field in an OBJ_NAMED_PARAM options object to have the same name as a...
@ STR_HEX
Special string with only hex chars.
@ STR_AMOUNT
Special string to represent a floating point amount.
Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type.
A UTXO under consideration for use in funding a new transaction.
const UniValue NullUniValue
std::string FeeModes(const std::string &delimiter)
std::string InvalidEstimateModeErrorMessage()
bool FeeModeFromString(const std::string &mode_string, FeeEstimateMode &fee_estimate_mode)
std::string StringForFeeReason(FeeReason reason)
static constexpr uint32_t MAX_BIP125_RBF_SEQUENCE
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
std::string EncodeBase64(Span< const unsigned char > input)
bool IsHex(std::string_view str)
V Cat(V v1, V &&v2)
Concatenate two vectors, moving elements.