foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-12 11:19:08 -05:00
Code Issues Activity

Merge bitcoin/bitcoin#27829: rpc: fix data optionality for RPC calls.

Browse source 
27b168b81f Update help text for spend and rawtransaction rpcs (Michael Tidwell)

Pull request description:

  The "data" field without outputs was marked as "required" in the help docs when using bitcoin-cli. This field when left off worked as an intended optional OP_RETURN. closes #27828.

  Motivation: It is hard to understand that "data" is actually optional for commands like `createpsbt` and `walletcreatefundedpsbt`.

ACKs for top commit:
  achow101:
    ACK 27b168b81f
  Sjors:
    tACK 27b168b81f

Tree-SHA512: 235e7ed4af69880880c04015b3f7de72c8f31ae035485c4c64c483e282948f3ea3f1eef16f15e260a1aaf21114150713516ba6a99967ccad9ecd91ff67cb0450
This commit is contained in:
Andrew Chow 2023-08-23 16:27:27 -04:00
commit 23f3f402fc
No known key found for this signature in database
GPG key ID: 17565732E08E5E41
2 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/rpc/rawtransaction.cpp
View file

@ -147,8 +147,9 @@ static std::vector<RPCArg> CreateTxDoc()
}, },
}, },
}, },
{"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs (key-value pairs), where none of the keys are duplicated.\n" {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
"That is, each address can only appear once and there can only be one 'data' object.\n" "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
"At least one output of either type must be specified.\n"
"For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n" "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
" accepted as second parameter.", " accepted as second parameter.",
{ {

16
src/wallet/rpc/spend.cpp
View file

@ -1014,9 +1014,9 @@ static RPCHelpMan bumpfee_helper(std::string method_name)
"are replaceable).\n"}, "are replaceable).\n"},
{"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n" {"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
"\"" + FeeModes("\"\n\"") + "\""}, "\"" + FeeModes("\"\n\"") + "\""},
{"outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "New outputs (key-value pairs) which will replace\n" {"outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The outputs specified as key-value pairs.\n"
"the original ones, if provided. Each address can only appear once and there can\n" "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
"only be one \"data\" object.\n" "At least one output of either type must be specified.\n"
"Cannot be provided if 'reduce_output' is specified.", "Cannot be provided if 'reduce_output' is specified.",
OutputsDoc(), OutputsDoc(),
RPCArgOptions{.skip_type_check = true}}, RPCArgOptions{.skip_type_check = true}},
@ -1188,8 +1188,9 @@ RPCHelpMan send()
"\nEXPERIMENTAL warning: this call may be changed in future releases.\n" "\nEXPERIMENTAL warning: this call may be changed in future releases.\n"
"\nSend a transaction.\n", "\nSend a transaction.\n",
{ {
{"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs (key-value pairs), where none of the keys are duplicated.\n" {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
"That is, each address can only appear once and there can only be one 'data' object.\n" "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
"At least one output of either type must be specified.\n"
"For convenience, a dictionary, which holds the key-value pairs directly, is also accepted.", "For convenience, a dictionary, which holds the key-value pairs directly, is also accepted.",
OutputsDoc(), OutputsDoc(),
RPCArgOptions{.skip_type_check = true}}, RPCArgOptions{.skip_type_check = true}},
@ -1638,8 +1639,9 @@ RPCHelpMan walletcreatefundedpsbt()
}, },
}, },
}, },
{"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs (key-value pairs), where none of the keys are duplicated.\n" {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\n"
"That is, each address can only appear once and there can only be one 'data' object.\n" "Each key may only appear once, i.e. there can only be one 'data' output, and no address may be duplicated.\n"
"At least one output of either type must be specified.\n"
"For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n" "For compatibility reasons, a dictionary, which holds the key-value pairs directly, is also\n"
"accepted as second parameter.", "accepted as second parameter.",
OutputsDoc(), OutputsDoc(),