aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAndrew Chow <github@achow101.com>2023-08-23 16:27:27 -0400
committerAndrew Chow <github@achow101.com>2023-08-23 16:37:28 -0400
commit23f3f402fca346302fe424427ae4077d8a458cbb (patch)
tree3e9a5732b63427169f9e948c9426c3dcde755eab /src
parent8ff90d9dcfee12090421675c9c421ee611e5ec8b (diff)
parent27b168b81f3959f5376a4176673187a71c7b25e1 (diff)
downloadbitcoin-23f3f402fca346302fe424427ae4077d8a458cbb.tar.xz
Merge bitcoin/bitcoin#27829: rpc: fix data optionality for RPC calls.
27b168b81f3959f5376a4176673187a71c7b25e1 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 27b168b81f3959f5376a4176673187a71c7b25e1 Sjors: tACK 27b168b81f3959f5376a4176673187a71c7b25e1 Tree-SHA512: 235e7ed4af69880880c04015b3f7de72c8f31ae035485c4c64c483e282948f3ea3f1eef16f15e260a1aaf21114150713516ba6a99967ccad9ecd91ff67cb0450
Diffstat (limited to 'src')
-rw-r--r--src/rpc/rawtransaction.cpp5
-rw-r--r--src/wallet/rpc/spend.cpp16
2 files changed, 12 insertions, 9 deletions
diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp
index 9198529378..fa5dd281a1 100644
--- a/src/rpc/rawtransaction.cpp
+++ b/src/rpc/rawtransaction.cpp
@@ -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"
- "That is, each address can only appear once and there can only be one 'data' object.\n"
+ {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\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"
" accepted as second parameter.",
{
diff --git a/src/wallet/rpc/spend.cpp b/src/wallet/rpc/spend.cpp
index 0e3f10dc76..0c2be26ddf 100644
--- a/src/wallet/rpc/spend.cpp
+++ b/src/wallet/rpc/spend.cpp
@@ -1014,9 +1014,9 @@ static RPCHelpMan bumpfee_helper(std::string method_name)
"are replaceable).\n"},
{"estimate_mode", RPCArg::Type::STR, RPCArg::Default{"unset"}, "The fee estimate mode, must be one of (case insensitive):\n"
"\"" + FeeModes("\"\n\"") + "\""},
- {"outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "New outputs (key-value pairs) which will replace\n"
- "the original ones, if provided. Each address can only appear once and there can\n"
- "only be one \"data\" object.\n"
+ {"outputs", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The outputs specified as key-value pairs.\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"
"Cannot be provided if 'reduce_output' is specified.",
OutputsDoc(),
RPCArgOptions{.skip_type_check = true}},
@@ -1188,8 +1188,9 @@ RPCHelpMan send()
"\nEXPERIMENTAL warning: this call may be changed in future releases.\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"
- "That is, each address can only appear once and there can only be one 'data' object.\n"
+ {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\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.",
OutputsDoc(),
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"
- "That is, each address can only appear once and there can only be one 'data' object.\n"
+ {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The outputs specified as key-value pairs.\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"
"accepted as second parameter.",
OutputsDoc(),