Skip to content

Commit 8d1ed0c

Browse files
committed
rpc: clarify label vs labels in getaddressinfo RPCHelpman
1 parent 5a0ed85 commit 8d1ed0c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/wallet/rpcwallet.cpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3742,15 +3742,16 @@ UniValue getaddressinfo(const JSONRPCRequest& request)
37423742
" getaddressinfo output fields for the embedded address, excluding metadata (timestamp, hdkeypath,\n"
37433743
" hdseedid) and relation to the wallet (ismine, iswatchonly).\n"
37443744
" \"iscompressed\" : true|false, (boolean, optional) If the pubkey is compressed.\n"
3745-
" \"label\" : \"label\" (string) The label associated with the address. Defaults to \"\".\n"
3745+
" \"label\" : \"label\" (string) The label associated with the address. Defaults to \"\". Equivalent to the name field in the labels array.\n"
37463746
" \"timestamp\" : timestamp, (number, optional) The creation time of the key if available, expressed in seconds since Epoch Time (Jan 1 1970 GMT).\n"
37473747
" \"hdkeypath\" : \"keypath\" (string, optional) The HD keypath, if the key is HD and available.\n"
37483748
" \"hdseedid\" : \"<hash160>\" (string, optional) The Hash160 of the HD seed.\n"
37493749
" \"hdmasterfingerprint\" : \"<hash160>\" (string, optional) The fingerprint of the master key.\n"
3750-
" \"labels\" (object) Array of labels associated with the address.\n"
3750+
" \"labels\" (object) An array of labels associated with the address. Currently limited to one label but returned\n"
3751+
" as an array to keep the API stable if multiple labels are enabled in the future.\n"
37513752
" [\n"
37523753
" { (json object of label data)\n"
3753-
" \"name\": \"label name\" (string) The label.\n"
3754+
" \"name\": \"label name\" (string) The label name. Defaults to \"\". Equivalent to the label field above.\n"
37543755
" \"purpose\": \"purpose\" (string) The purpose of the associated address (send or receive).\n"
37553756
" },...\n"
37563757
" ]\n"

0 commit comments

Comments
 (0)