Skip to content

Commit 5a0ed85

Browse files
jonatackjonatack
committed
rpc: improve getaddressinfo RPCHelpman content
1 parent 70cda34 commit 5a0ed85

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

‎src/wallet/rpcwallet.cpp‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,7 @@ static UniValue addmultisigaddress(const JSONRPCRequest& request)
951951
}
952952

953953
RPCHelpMan{"addmultisigaddress",
954-
"\nAdd a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.\n"
954+
"\nAdd an nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.\n"
955955
"Each key is a Bitcoin address or hex-encoded public key.\n"
956956
"This functionality is only intended for use with non-watchonly addresses.\n"
957957
"See `importaddress` for watchonly p2sh address support.\n"
@@ -3710,48 +3710,48 @@ UniValue getaddressinfo(const JSONRPCRequest& request)
37103710

37113711
RPCHelpMan{"getaddressinfo",
37123712
"\nReturn information about the given bitcoin address.\n"
3713-
"Some information requires the address to be in the wallet.\n",
3713+
"Some of the information will only be present if the address is in the active wallet.\n",
37143714
{
3715-
{"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to get the information of."},
3715+
{"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address for which to get information."},
37163716
},
37173717
RPCResult{
37183718
"{\n"
3719-
" \"address\" : \"address\", (string) The bitcoin address validated\n"
3720-
" \"scriptPubKey\" : \"hex\", (string) The hex-encoded scriptPubKey generated by the address\n"
3721-
" \"ismine\" : true|false, (boolean) If the address is yours or not\n"
3722-
" \"iswatchonly\" : true|false, (boolean) If the address is watchonly\n"
3723-
" \"solvable\" : true|false, (boolean) Whether we know how to spend coins sent to this address, ignoring the possible lack of private keys\n"
3724-
" \"desc\" : \"desc\", (string, optional) A descriptor for spending coins sent to this address (only when solvable)\n"
3725-
" \"isscript\" : true|false, (boolean) If the key is a script\n"
3726-
" \"ischange\" : true|false, (boolean) If the address was used for change output\n"
3727-
" \"iswitness\" : true|false, (boolean) If the address is a witness address\n"
3728-
" \"witness_version\" : version (numeric, optional) The version number of the witness program\n"
3729-
" \"witness_program\" : \"hex\" (string, optional) The hex value of the witness program\n"
3730-
" \"script\" : \"type\" (string, optional) The output script type. Only if \"isscript\" is true and the redeemscript is known. Possible\n"
3719+
" \"address\" : \"address\", (string) The bitcoin address validated.\n"
3720+
" \"scriptPubKey\" : \"hex\", (string) The hex-encoded scriptPubKey generated by the address.\n"
3721+
" \"ismine\" : true|false, (boolean) If the address is yours.\n"
3722+
" \"iswatchonly\" : true|false, (boolean) If the address is watchonly.\n"
3723+
" \"solvable\" : true|false, (boolean) If we know how to spend coins sent to this address, ignoring the possible lack of private keys.\n"
3724+
" \"desc\" : \"desc\", (string, optional) A descriptor for spending coins sent to this address (only when solvable).\n"
3725+
" \"isscript\" : true|false, (boolean) If the key is a script.\n"
3726+
" \"ischange\" : true|false, (boolean) If the address was used for change output.\n"
3727+
" \"iswitness\" : true|false, (boolean) If the address is a witness address.\n"
3728+
" \"witness_version\" : version (numeric, optional) The version number of the witness program.\n"
3729+
" \"witness_program\" : \"hex\" (string, optional) The hex value of the witness program.\n"
3730+
" \"script\" : \"type\" (string, optional) The output script type. Only if isscript is true and the redeemscript is known. Possible\n"
37313731
" types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_keyhash,\n"
3732-
" witness_v0_scripthash, witness_unknown\n"
3733-
" \"hex\" : \"hex\", (string, optional) The redeemscript for the p2sh address\n"
3734-
" \"pubkeys\" (string, optional) Array of pubkeys associated with the known redeemscript (only if \"script\" is \"multisig\")\n"
3732+
" witness_v0_scripthash, witness_unknown.\n"
3733+
" \"hex\" : \"hex\", (string, optional) The redeemscript for the p2sh address.\n"
3734+
" \"pubkeys\" (array, optional) Array of pubkeys associated with the known redeemscript (only if script is multisig).\n"
37353735
" [\n"
3736-
" \"pubkey\"\n"
3736+
" \"pubkey\" (string)\n"
37373737
" ,...\n"
37383738
" ]\n"
3739-
" \"sigsrequired\" : xxxxx (numeric, optional) Number of signatures required to spend multisig output (only if \"script\" is \"multisig\")\n"
3740-
" \"pubkey\" : \"publickeyhex\", (string, optional) The hex value of the raw public key, for single-key addresses (possibly embedded in P2SH or P2WSH)\n"
3741-
" \"embedded\" : {...}, (object, optional) Information about the address embedded in P2SH or P2WSH, if relevant and known. It includes all\n"
3742-
" getaddressinfo output fields for the embedded address, excluding metadata (\"timestamp\", \"hdkeypath\",\n"
3743-
" \"hdseedid\") and relation to the wallet (\"ismine\", \"iswatchonly\").\n"
3744-
" \"iscompressed\" : true|false, (boolean, optional) If the pubkey is compressed\n"
3745-
" \"label\" : \"label\" (string) The label associated with the address, \"\" is the default label\n"
3746-
" \"timestamp\" : timestamp, (number, optional) The creation time of the key if available in seconds since epoch (Jan 1 1970 GMT)\n"
3747-
" \"hdkeypath\" : \"keypath\" (string, optional) The HD keypath if the key is HD and available\n"
3748-
" \"hdseedid\" : \"<hash160>\" (string, optional) The Hash160 of the HD seed\n"
3749-
" \"hdmasterfingerprint\" : \"<hash160>\" (string, optional) The fingperint of the master key.\n"
3739+
" \"sigsrequired\" : xxxxx (numeric, optional) The number of signatures required to spend multisig output (only if script is multisig).\n"
3740+
" \"pubkey\" : \"publickeyhex\", (string, optional) The hex value of the raw public key for single-key addresses (possibly embedded in P2SH or P2WSH).\n"
3741+
" \"embedded\" : {...}, (object, optional) Information about the address embedded in P2SH or P2WSH, if relevant and known. Includes all\n"
3742+
" getaddressinfo output fields for the embedded address, excluding metadata (timestamp, hdkeypath,\n"
3743+
" hdseedid) and relation to the wallet (ismine, iswatchonly).\n"
3744+
" \"iscompressed\" : true|false, (boolean, optional) If the pubkey is compressed.\n"
3745+
" \"label\" : \"label\" (string) The label associated with the address. Defaults to \"\".\n"
3746+
" \"timestamp\" : timestamp, (number, optional) The creation time of the key if available, expressed in seconds since Epoch Time (Jan 1 1970 GMT).\n"
3747+
" \"hdkeypath\" : \"keypath\" (string, optional) The HD keypath, if the key is HD and available.\n"
3748+
" \"hdseedid\" : \"<hash160>\" (string, optional) The Hash160 of the HD seed.\n"
3749+
" \"hdmasterfingerprint\" : \"<hash160>\" (string, optional) The fingerprint of the master key.\n"
37503750
" \"labels\" (object) Array of labels associated with the address.\n"
37513751
" [\n"
37523752
" { (json object of label data)\n"
3753-
" \"name\": \"labelname\" (string) The label\n"
3754-
" \"purpose\": \"string\" (string) Purpose of address (\"send\" for sending address, \"receive\" for receiving address)\n"
3753+
" \"name\": \"label name\" (string) The label.\n"
3754+
" \"purpose\": \"purpose\" (string) The purpose of the associated address (send or receive).\n"
37553755
" },...\n"
37563756
" ]\n"
37573757
"}\n"

0 commit comments

Comments
 (0)