Add GetAddressTxids/Utxos details

Update minor formatting, etc. for GetAddressBalance/Deltas/Mempool
Changed reference to Dash Core and updated denominations for Dash
This commit is contained in:
thephez 2017-10-04 16:18:30 -04:00
parent 731a9df442
commit 3564879e58
8 changed files with 205 additions and 39 deletions

View file

@ -7,27 +7,23 @@ required:
title_max_40_characters_no_formatting: Denominations title_max_40_characters_no_formatting: Denominations
summary_max_255_characters_no_formatting: > summary_max_255_characters_no_formatting: >
Denominations of Bitcoin value, usually measured in fractions of Denominations of Dash value, usually measured in fractions of
a bitcoin but sometimes measured in multiples of a satoshi. One a dash but sometimes measured in multiples of a duff. One
bitcoin equals 100,000,000 satoshis. dash equals 100,000,000 duffs.
synonyms_shown_in_glossary_capitalize_first_letter: synonyms_shown_in_glossary_capitalize_first_letter:
- Denomination - Denomination
- Bitcoins #- Bitcoins
- Satoshis - Duffs
optional: optional:
synonyms_and_pluralizations_not_shown_in_glossary: synonyms_and_pluralizations_not_shown_in_glossary:
- denominations - denominations
- millibitcoin - millidash
- millibitcoins #- millibit
- millibit #- millibits
- millibits - microdash
- microbitcoin - duff
- microbitcoins
- microbit
- microbits
- satoshi
## Don't add bitcoin singular, we use bare "Bitcoin" massively often ## Don't add bitcoin singular, we use bare "Bitcoin" massively often
## Don't add bits; the dev docs use [binary] "bits" often ## Don't add bits; the dev docs use [binary] "bits" often

View file

@ -18,10 +18,15 @@ The `getaddressbalance` RPC {{summary_getAddressBalance}}
*Parameter #1---an array of addresses* *Parameter #1---an array of addresses*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Address" - n: "`addresses`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of P2PKH or P2SH Dash address(es)"
- n: "→Address"
t: "string (base58)" t: "string (base58)"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An array of P2PKH or P2SH Dash address(es)." d: "The base58check encoded address"
{% enditemplate %} {% enditemplate %}
@ -55,7 +60,7 @@ dash-cli getaddressbalance '{"addresses": ["yWjoZBvnUKWhpKMbBkVVnnMD8Bzno9j6tQ"]
Result: Result:
{% highlight text %} {% highlight json %}
{ {
"balance": 0, "balance": 0,
"received": 10000100 "received": 10000100

View file

@ -18,19 +18,24 @@ The `getaddressdeltas` RPC {{summary_getAddressDeltas}}
*Parameter #1---an array of addresses* *Parameter #1---an array of addresses*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Address" - n: "`addresses`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of P2PKH or P2SH Dash address(es)"
- n: "→Address"
t: "string (base58)" t: "string (base58)"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An array of P2PKH or P2SH Dash address(es)." d: "The base58check encoded address"
{% enditemplate %} {% enditemplate %}
*Parameter #2---the start block height* *Parameter #2---the start block height*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Block Height" - n: "`start`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Optional<br>(exactly 1)"
d: "The start block height" d: "The start block height"
{% enditemplate %} {% enditemplate %}
@ -38,9 +43,9 @@ The `getaddressdeltas` RPC {{summary_getAddressDeltas}}
*Parameter #3---the end block height* *Parameter #3---the end block height*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Block Height" - n: "`end`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Optional<br>(exactly 1)"
d: "The end block height" d: "The end block height"
{% enditemplate %} {% enditemplate %}
@ -53,7 +58,7 @@ The `getaddressdeltas` RPC {{summary_getAddressDeltas}}
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "An array of JSON objects, with each object describing a transaction involving one of the requested addresses" d: "An array of JSON objects, with each object describing a transaction involving one of the requested addresses"
- n: "→<br>`delta`" - n: "→<br>Delta"
t: "object" t: "object"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An object describing a particular address delta" d: "An object describing a particular address delta"
@ -61,14 +66,14 @@ The `getaddressdeltas` RPC {{summary_getAddressDeltas}}
- n: "→→<br>`satoshis`" - n: "→→<br>`satoshis`"
t: "number" t: "number"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The difference of satoshis" d: "The difference of duffs"
- n: "→→<br>`txid`" - n: "→→<br>`txid`"
t: "string" t: "string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The related txid" d: "The related txid"
- n: "→→<br>`index`" - n: "→→<br>`blockindex`"
t: "number" t: "number"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The related input or output index" d: "The related input or output index"
@ -90,12 +95,12 @@ The `getaddressdeltas` RPC {{summary_getAddressDeltas}}
Get the deltas for an address: Get the deltas for an address:
{% highlight bash %} {% highlight bash %}
dash-cli getaddressdeltas '{"addresses": ["yWjoZBvnUKWhpKMbBkVVnnMD8Bzno9j6tQ"]}' dash-cli getaddressdeltas '{"addresses": ["yWjoZBvnUKWhpKMbBkVVnnMD8Bzno9j6tQ"], "start":5000, "end":7500}'
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight text %} {% highlight json %}
[ [
{ {
"satoshis": 10000100, "satoshis": 10000100,

View file

@ -18,10 +18,15 @@ The `getaddressmempool` RPC {{summary_getAddressMempool}}
*Parameter #1---an array of addresses* *Parameter #1---an array of addresses*
{% itemplate ntpd1 %} {% itemplate ntpd1 %}
- n: "Address" - n: "`addresses`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of P2PKH or P2SH Dash address(es)"
- n: "→Address"
t: "string (base58)" t: "string (base58)"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An array of P2PKH or P2SH Dash address(es)." d: "The base58check encoded address"
{% enditemplate %} {% enditemplate %}
@ -33,7 +38,7 @@ The `getaddressmempool` RPC {{summary_getAddressMempool}}
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "An array of JSON objects, with each object describing a transaction involving one of the requested addresses" d: "An array of JSON objects, with each object describing a transaction involving one of the requested addresses"
- n: "→<br>`mempool deltas`" - n: "→Mempool Deltas"
t: "object" t: "object"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "An object describing a particular mempool address delta" d: "An object describing a particular mempool address delta"
@ -56,7 +61,7 @@ The `getaddressmempool` RPC {{summary_getAddressMempool}}
- n: "→→<br>`satoshis`" - n: "→→<br>`satoshis`"
t: "number" t: "number"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The difference of satoshis" d: "The difference of duffs"
- n: "→→<br>`timestamp`" - n: "→→<br>`timestamp`"
t: "string" t: "string"

View file

@ -9,7 +9,77 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
{% assign summary_getAddressTxids="" %} {% assign summary_getAddressTxids="returns the txids for an address(es) (requires addressindex to be enabled)" %}
*Requires wallet support.*
The `getaddresstxids` RPC {{summary_getAddressTxids}}
*Parameter #1---an array of addresses*
{% itemplate ntpd1 %}
- n: "`addresses`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of P2PKH or P2SH Dash address(es)"
- n: "→Address"
t: "string (base58)"
p: "Required<br>(1 or more)"
d: "The base58check encoded address"
{% enditemplate %}
*Parameter #2---the start block height*
{% itemplate ntpd1 %}
- n: "`start`"
t: "number (int)"
p: "Optional<br>(exactly 1)"
d: "The start block height"
{% enditemplate %}
*Parameter #3---the end block height*
{% itemplate ntpd1 %}
- n: "`end`"
t: "number (int)"
p: "Optional<br>(exactly 1)"
d: "The end block height"
{% enditemplate %}
*Result---information about txids for the address(es)*
{% itemplate ntpd1 %}
- n: "`result`"
t: "array"
p: "Required<br>(exactly 1)"
d: "An array of txids related to the requested address(es)"
- n: "→<br>TXID"
t: "string"
p: "Required<br>(1 or more)"
d: "The transaction id"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Get the deltas for an address:
{% highlight bash %}
dash-cli getaddresstxids '{"addresses": ["yWjoZBvnUKWhpKMbBkVVnnMD8Bzno9j6tQ"], "start":5000, "end":7500}'
{% endhighlight %}
Result:
{% highlight json %}
[
"1fe86e463a9394d4ccd9a5ff1c6b483c95b4350ffdb055b55dc3615111e977de",
"6cb4379eec45cd3bb08b8f4c3a101b8cd89795e24f2cb8288a9941a85fb114cf"
]
{% endhighlight %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -9,7 +9,92 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
{% assign summary_getAddressUtxos="" %} {% assign summary_getAddressUtxos="returns all unspent outputs for an address (requires addressindex to be enabled)" %}
*Requires wallet support.*
The `getaddressutxos` RPC {{summary_getAddressUtxos}}
*Parameter #1---an array of addresses*
{% itemplate ntpd1 %}
- n: "`addresses`"
t: "object"
p: "Required<br>(exactly 1)"
d: "An array of P2PKH or P2SH Dash address(es)"
- n: "→Address"
t: "string (base58)"
p: "Required<br>(1 or more)"
d: "The base58check encoded address"
{% enditemplate %}
*Result---information about unspent outputs for the address(es)*
{% itemplate ntpd1 %}
- n: "`result`"
t: "array"
p: "Required<br>(exactly 1)"
d: "An array of JSON objects, with each object describing a transaction involving one of the requested addresses"
- n: "→Unspent outputs"
t: "object"
p: "Required<br>(1 or more)"
d: "An object describing a particular unspent output for the requested address(es)"
- n: "→→<br>`address`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The base58check encoded address"
- n: "→→<br>`txid`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The output txid"
- n: "→→<br>`outputIndex`"
t: "number"
p: "Required<br>(exactly 1)"
d: "The output index"
- n: "→→<br>`script`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The script hex encoded"
- n: "→→<br>`satoshis`"
t: "number"
p: "Required<br>(exactly 1)"
d: "The number of duffs of the output"
- n: "→→<br>`height`"
t: "number"
p: "Required<br>(exactly 1)"
d: "The block height"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Get the unspent outputs for an address:
{% highlight bash %}
dash-cli getaddressutxos '{"addresses": ["yLeC3F9UxJmFaRaf5yzH7FDc7RdvBasi84"]}'
{% endhighlight %}
Result:
{% highlight json %}
[
{
"address": "yLeC3F9UxJmFaRaf5yzH7FDc7RdvBasi84",
"txid": "ef7bcd083db8c9551ca295698c3b7a6811288fae9944018d2a660a0f939bdb35",
"outputIndex": 0,
"script": "76a914038b8a73338c8f9c22024338198d63ff7c4cb4c088ac",
"satoshis": 1000010000,
"height": 7683
}
]
{% endhighlight %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -24,10 +24,10 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_getAccountAddress="returns the current Bitcoin address for receiving payments to this account. If the account doesn't exist, it creates both the account and a new address for receiving payment. Once a payment has been received to an address, future calls to this RPC for the same account will return a different address." %} {% assign summary_getAccountAddress="returns the current Bitcoin address for receiving payments to this account. If the account doesn't exist, it creates both the account and a new address for receiving payment. Once a payment has been received to an address, future calls to this RPC for the same account will return a different address." %}
{% assign summary_getAddedNodeInfo="returns information about the given added node, or all added nodes (except onetry nodes). Only nodes which have been manually added using the `addnode` RPC will have their information displayed." %} {% assign summary_getAddedNodeInfo="returns information about the given added node, or all added nodes (except onetry nodes). Only nodes which have been manually added using the `addnode` RPC will have their information displayed." %}
{% assign summary_getAddressBalance="returns the balance for address(es) (requires addressindex to be enabled)." %} {% assign summary_getAddressBalance="returns the balance for address(es) (requires addressindex to be enabled)." %}
{% assign summary_getAddressDeltas="" %} {% assign summary_getAddressDeltas="returns all changes for an address (requires addressindex to be enabled)." %}
{% assign summary_getAddressMempool="" %} {% assign summary_getAddressMempool="returns all mempool deltas for an address (requires addressindex to be enabled)." %}
{% assign summary_getAddressTxids="" %} {% assign summary_getAddressTxids="returns the txids for an address(es) (requires addressindex to be enabled)" %}
{% assign summary_getAddressUtxos="" %} {% assign summary_getAddressUtxos="returns all unspent outputs for an address (requires addressindex to be enabled)" %}
{% assign summary_getAddressesByAccount="returns a list of every address assigned to a particular account." %} {% assign summary_getAddressesByAccount="returns a list of every address assigned to a particular account." %}
{% assign summary_getBalance="gets the balance in decimal bitcoins across all accounts or for a particular account." %} {% assign summary_getBalance="gets the balance in decimal bitcoins across all accounts or for a particular account." %}
{% assign summary_getBestBlockHash="returns the header hash of the most recent block on the best block chain." %} {% assign summary_getBestBlockHash="returns the header hash of the most recent block on the best block chain." %}

View file

@ -80,7 +80,7 @@ http://opensource.org/licenses/MIT.
[URI QR Code]: /en/developer-guide#term-uri-qr-code "A QR code containing a bitcoin: URI" [URI QR Code]: /en/developer-guide#term-uri-qr-code "A QR code containing a bitcoin: URI"
[v2 block]: /en/developer-reference#term-v2-block "The current version of Bitcoin blocks" [v2 block]: /en/developer-reference#term-v2-block "The current version of Bitcoin blocks"
[verified payments]: /en/developer-guide#verifying-payment "Payments which the receiver believes won't be double spent" [verified payments]: /en/developer-guide#verifying-payment "Payments which the receiver believes won't be double spent"
[wallet support]: /en/developer-reference#term-wallet-support "A Bitcoin Core ./configure option that enables (default) or disables the wallet" [wallet support]: /en/developer-reference#term-wallet-support "A Dash Core ./configure option that enables (default) or disables the wallet"
{% comment %}<!-- RPCs; alphabetical order -->{% endcomment %} {% comment %}<!-- RPCs; alphabetical order -->{% endcomment %}
[rpc abandontransaction]: /en/developer-reference#abandontransaction [rpc abandontransaction]: /en/developer-reference#abandontransaction