From 233eae74282c3ac46844abc0e52dcca65ab73441 Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 13 Mar 2018 13:42:54 -0400 Subject: [PATCH] [Content] - RPC - Add new ListAddressBalances RPC --- _autocrossref.yaml | 2 + _config.yml | 3 +- .../devdoc/dash-core/rpcs/quick-reference.md | 1 + .../rpcs/rpcs/listaddressbalances.md | 63 +++++++++++++++++++ .../rpcs/rpcs/listaddressgroupings.md | 1 + _includes/helpers/summaries.md | 1 + _includes/layout/base/rpc-table.html | 6 ++ _includes/references.md | 1 + en/developer-reference.md | 2 + 9 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/listaddressbalances.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index a4b23685..60a8a4dc 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -414,6 +414,8 @@ CVE-2012-2459: '`keypoolrefill` RPC': rpc keypoolrefill '`listaccounts`': rpc listaccounts '`listaccounts` RPC': rpc listaccounts +'`listaddressbalances`': rpc listaddressbalances +'`listaddressbalances` RPC': rpc listaddressbalances '`listaddressgroupings`': rpc listaddressgroupings '`listaddressgroupings` RPC': rpc listaddressgroupings '`listbanned`': rpc listbanned diff --git a/_config.yml b/_config.yml index 9667c3b7..194baadc 100644 --- a/_config.yml +++ b/_config.yml @@ -271,6 +271,7 @@ devsearches: - 'KeePass': "/en/developer-reference#keepass" - 'KeypoolRefill': "/en/developer-reference#keypoolrefill" - 'ListAccounts': "/en/developer-reference#listaccounts" + - 'ListAddressBalances': "/en/developer-reference#listaddressbalances" - 'ListAddressGroupings': "/en/developer-reference#listaddressgroupings" - 'ListBanned': "/en/developer-reference#listbanned" - 'ListLockUnspent': "/en/developer-reference#listlockunspent" @@ -297,7 +298,7 @@ devsearches: - 'SendToAddress': "/en/developer-reference#sendtoaddress" - 'SetAccount': "/en/developer-reference#setaccount" - 'SetBan': "/en/developer-reference#setban" - - 'SetBIP69Enabled': "/en/developer-reference#setbip69enabled" + - 'SetBIP69Enabled': "/en/developer-reference#setbip69enabled" - 'SetGenerate': "/en/developer-reference#setgenerate" - 'SetNetworkActive': "/en/developer-reference#setnetworkactive" - 'SetTxFee': "/en/developer-reference#settxfee" diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index 2aa3a143..07d29aba 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -276,6 +276,7 @@ default. * [KeePass][rpc keepass]: {{summary_keepass}} {{DARKCOIN_NEW0_11_0}} * [KeyPoolRefill][rpc keypoolrefill]: {{summary_keyPoolRefill}} * [ListAccounts][rpc listaccounts]: {{summary_listAccounts}} {{DEPRECATED}} +* [ListAddressBalances][rpc listaddressbalances]: {{summary_listAddressBalances}} {{DASH_NEW0_12_3}} * [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}} * [ListLockUnspent][rpc listlockunspent]: {{summary_listLockUnspent}} * [ListReceivedByAccount][rpc listreceivedbyaccount]: {{summary_listReceivedByAccount}} {{DEPRECATED}} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/listaddressbalances.md b/_includes/devdoc/dash-core/rpcs/rpcs/listaddressbalances.md new file mode 100644 index 00000000..6deed894 --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/listaddressbalances.md @@ -0,0 +1,63 @@ +{% comment %} +This file is licensed under the MIT License (MIT) available on +http://opensource.org/licenses/MIT. +{% endcomment %} +{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/listaddressbalances.md" %} + +##### ListAddressBalances +{% include helpers/subhead-links.md %} + +{% assign summary_listAddressBalances="lists addresses of this wallet and their balances" %} + + + +{% autocrossref %} + +The `listaddressbalances` RPC {{summary_listAddressBalances}} + +*Parameter #1---Minimum Amount* + +{% itemplate ntpd1 %} +- n: "Minimum Amount" + t: "numeric (int)" + p: "Optional
(0 or 1)" + d: "Minimum balance in DASH an address should have to be shown in the list (default=0)" + +{% enditemplate %} + +*Result---an object containing the addresses and their balances* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "object" + p: "Required
(exactly 1)" + d: "An object containing key/value pairs corresponding to the addresses with balances > the minimum amount. May be empty" + +- n: "→
Address/Amount" + t: "string (base58):
number (DASH)" + p: "Optional
(1 or more)" + d: "A key/value pair with a base58check-encoded string containing the address as the key, and an amount of DASH as the value" + +{% enditemplate %} + +*Example from Dash Core 0.12.3* + +{% highlight bash %} +dash-cli -testnet listaddressbalances 25 +{% endhighlight %} + +Result: +{% highlight json %} +{ + "yMQtQkcMBXrAZyqTGZeg7tQHzmbypGEP4w": 299.99990000, + "yRyfgrHm4f5A8GGvqpqTFvbCrCQHJm1L4V": 99.13570000, + "ybePwhPzUbiWzFhkgxPgP6iHnTLTyFH6sU": 123.45600000, + "ycCdPQnjNEVRgrQY8j6mxEx9h7oaQpo5Ge": 500.00000000 +} +{% endhighlight %} + +*See also:* + +* [ListAddressGroupings][rpc listaddressgroupings]: {{summary_listAddressGroupings}} + +{% endautocrossref %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/listaddressgroupings.md b/_includes/devdoc/dash-core/rpcs/rpcs/listaddressgroupings.md index 52aaca26..4d15ba83 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/listaddressgroupings.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/listaddressgroupings.md @@ -91,5 +91,6 @@ Result (edited to only three results): * [GetAddressesByAccount][rpc getaddressesbyaccount]: {{summary_getAddressesByAccount}} * [GetTransaction][rpc gettransaction]: {{summary_getTransaction}} +* [ListAddressBalances][rpc listaddressbalances]: {{summary_listAddressBalances}} {% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index b6bbaa37..67a59ce0 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -89,6 +89,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_keepass="provides commands for configuring and managing KeePass authentication" %} {% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %} {% assign summary_listAccounts="lists accounts and their balances." %} +{% assign summary_listAddressBalances="lists addresses of this wallet and their balances" %} {% assign summary_listAddressGroupings="lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction." %} {% assign summary_listBanned="lists all banned IPs/Subnets." %} {% assign summary_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %} diff --git a/_includes/layout/base/rpc-table.html b/_includes/layout/base/rpc-table.html index f6d74752..05b07b55 100644 --- a/_includes/layout/base/rpc-table.html +++ b/_includes/layout/base/rpc-table.html @@ -715,6 +715,12 @@ th.tg-sort-header::-moz-selection { background:transparent; }th.tg-sort-header:: Y + + Wallet + ListAddressBalances + Y + 0.12.3.0+ + Wallet ListAddressGroupings diff --git a/_includes/references.md b/_includes/references.md index d81aa5f1..af4c4b5d 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -144,6 +144,7 @@ http://opensource.org/licenses/MIT. [rpc keepass]: /en/developer-reference#keepass [rpc keypoolrefill]: /en/developer-reference#keypoolrefill [rpc listaccounts]: /en/developer-reference#listaccounts +[rpc listaddressbalances]: /en/developer-reference#listaddressbalances [rpc listaddressgroupings]: /en/developer-reference#listaddressgroupings [rpc listbanned]: /en/developer-reference#listbanned [rpc listlockunspent]: /en/developer-reference#listlockunspent diff --git a/en/developer-reference.md b/en/developer-reference.md index a17965b5..98d47096 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -248,6 +248,8 @@ untrusted source. {% include devdoc/dash-core/rpcs/rpcs/listaccounts.md %} +{% include devdoc/dash-core/rpcs/rpcs/listaddressbalances.md %} + {% include devdoc/dash-core/rpcs/rpcs/listaddressgroupings.md %} {% include devdoc/dash-core/rpcs/rpcs/listbanned.md %}