Retropex/bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/bitcoin.git synced 2025-06-01 06:52:35 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Document optional result fields in validateaddress

Browse Source 
Can be reviewed with --ignore-all-space --word-diff-regex=.
This commit is contained in:
MarcoFalke 2021-12-02 19:23:29 +01:00
parent faee2656a8
commit fab6c43b40
No known key found for this signature in database
GPG Key ID: CE2B75697E69A548
1 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/rpc/misc.cpp
View File

@ -36,7 +36,8 @@
static RPCHelpMan validateaddress() static RPCHelpMan validateaddress()
{ {
return RPCHelpMan{"validateaddress", return RPCHelpMan{
"validateaddress",
"\nReturn information about the given bitcoin address.\n", "\nReturn information about the given bitcoin address.\n",
{ {
{"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to validate"}, {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to validate"},
@ -52,7 +53,7 @@ static RPCHelpMan validateaddress()
{RPCResult::Type::NUM, "witness_version", /* optional */ true, "The version number of the witness program"}, {RPCResult::Type::NUM, "witness_version", /* optional */ true, "The version number of the witness program"},
{RPCResult::Type::STR_HEX, "witness_program", /* optional */ true, "The hex value of the witness program"}, {RPCResult::Type::STR_HEX, "witness_program", /* optional */ true, "The hex value of the witness program"},
{RPCResult::Type::STR, "error", /* optional */ true, "Error message, if any"}, {RPCResult::Type::STR, "error", /* optional */ true, "Error message, if any"},
{RPCResult::Type::ARR, "error_locations", "Indices of likely error locations in address, if known (e.g. Bech32 errors)", {RPCResult::Type::ARR, "error_locations", /*optional=*/true, "Indices of likely error locations in address, if known (e.g. Bech32 errors)",
{ {
{RPCResult::Type::NUM, "index", "index of a potential error"}, {RPCResult::Type::NUM, "index", "index of a potential error"},
}}, }},