Wallet RPC updates

- Convert more existing RPCs to Dash
 - Minimal changes (some InstantSend parameter additions)
This commit is contained in:
thephez 2017-11-28 16:31:03 -05:00
parent ff3508cb25
commit c0e52df028
12 changed files with 164 additions and 77 deletions

View file

@ -249,7 +249,7 @@ default.
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
* [DumpWallet][rpc dumpwallet]: {{summary_dumpWallet}}
* [EncryptWallet][rpc encryptwallet]: {{summary_encryptWallet}}
* [GetAccount][rpc getaccount]: {{summary_getAccount}}
* [GetAccount][rpc getaccount]: {{summary_getAccount}} {{DEPRECATED}}
* [GetAccountAddress][rpc getaccountaddress]: {{summary_getAccountAddress}} {{DEPRECATED}}
* [GetAddressesByAccount][rpc getaddressesbyaccount]: {{summary_getAddressesByAccount}} {{DEPRECATED}}
* [GetBalance][rpc getbalance]: {{summary_getBalance}}

View file

@ -9,6 +9,8 @@ http://opensource.org/licenses/MIT.
{% assign summary_dumpWallet="creates or overwrites a file with all wallet keys in a human-readable format." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support. Requires an unlocked wallet or an unencrypted
@ -36,28 +38,28 @@ The `dumpwallet` RPC {{summary_dumpWallet}}
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Create a wallet dump and then print its first 10 lines.
{% highlight bash %}
bitcoin-cli -testnet dumpwallet /tmp/dump.txt
dash-cli -testnet dumpwallet /tmp/dump.txt
head /tmp/dump.txt
{% endhighlight %}
Results (only showing the first 10 lines):
{% highlight bash %}
# Wallet dump created by Bitcoin v0.9.1.0-g026a939-beta (Tue, 8 Apr 2014 12:04:06 +0200)
# * Created on 2014-04-29T20:46:09Z
# * Best block at time of backup was 227221 (0000000026ede4c10594af8087748507fb06dcd30b8f4f48b9cc463cabc9d767),
# mined on 2014-04-29T21:15:07Z
# Wallet dump created by Dash Core v0.12.2.1 (2017-11-11 10:02:45 +0300)
# * Created on 2017-11-28T19:52:46Z
# * Best block at time of backup was 33750 (0000000005d5d1651f3b52d7a7158e350261519c52a28527c6053a8f5989a5a4),
# mined on 2017-11-28T19:48:05Z
cTtefiUaLfXuyBXJBBywSdg8soTEkBNh9yTi1KgoHxUYxt1xZ2aA 2014-02-05T15:44:03Z label=test1 # addr=mnUbTmdAFD5EAg3348Ejmonub7JcWtrMck
cQNY9v93Gyt8KmwygFR59bDhVs3aRDkuT8pKaCBpop82TZ8ND1tH 2014-02-05T16:58:41Z reserve=1 # addr=mp4MmhTp3au21HPRz5waf6YohGumuNnsqT
cNTEPzZH9mjquFFADXe5S3BweNiHLUKD6PvEKEsHApqjX4ZddeU6 2014-02-05T16:58:41Z reserve=1 # addr=n3pdvsxveMBkktjsGJixfSbxacRUwJ9jQW
cTVNtBK7mBi2yc9syEnwbiUpnpGJKohDWzXMeF4tGKAQ7wvomr95 2014-02-05T16:58:41Z change=1 # addr=moQR7i8XM4rSGoNwEsw3h4YEuduuP6mxw7
cNCD679B4xi17jb4XeLpbRbZCbYUugptD7dCtUTfSU4KPuK2DyKT 2014-02-05T16:58:41Z reserve=1 # addr=mq8fzjxxVbAKxUGPwaSSo3C4WaUxdzfw3C
cQZZ4awQvcXXyES3CmUJqSgeTobQm9t9nyUr337kvUtsWsnvvMyw 2017-11-28T18:21:36Z label=test%20label # addr=ycBuREgSskHHkWLxDa9A5WppCki6PfFycL
cTBRPnJoPjEMh67v1zes437v8Po5bFLDWKgEudTJMhVaLs1ZVGJe 2017-11-28T18:21:37Z reserve=1 # addr=yNsWkgPLN1u7p5dfWYnasYdgirU2J3tjUj
cRkkwrFnQUrih3QiT87sNy1AxyfjzqVYSyVYuL3qnJcSiQfE4QJa 2017-11-28T18:21:37Z reserve=1 # addr=yRkHzRbRKn8gBp5826mbaBvxLuBBNDVQg3
cQM7KoqQjHCCTrDhnfBEY1vpW9W65zRvaQeTb41UbFb6WX8Q8UkQ 2017-11-28T18:21:37Z reserve=1 # addr=yVEdefApUYiDLHApvvWCK5afTtJeQada8Y
cTGSKYaQTQabnjNSwCqpjYXiucVujTXiwp9dzmJV9cNAiayAJusi 2017-11-28T18:21:37Z reserve=1 # addr=ybQYgp21ZyZK8JuMLb2CVwG4TaWrXVXD5M
{% endhighlight %}
*See also*

View file

@ -9,6 +9,8 @@ http://opensource.org/licenses/MIT.
{% assign summary_encryptWallet="encrypts the wallet with a passphrase. This is only to enable encryption for the first time. After encryption is enabled, you will need to enter the passphrase to use private keys." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
@ -42,17 +44,19 @@ the `dumpwallet` RPC.
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
{% highlight bash %}
bitcoin-cli -testnet encryptwallet "test"
dash-cli -testnet encryptwallet "test"
{% endhighlight %}
Result:
{% highlight text %}
wallet encrypted; Bitcoin server stopping, restart to run with encrypted
wallet. The keypool has been flushed, you need to make a new backup.
Wallet encrypted; Dash Core server stopping, restart to run with encrypted wallet.
The keypool has been flushed and a new HD seed was generated (if you are using
HD). You need to make a new backup.
{% endhighlight %}
*See also*

View file

@ -9,19 +9,24 @@ http://opensource.org/licenses/MIT.
{% assign summary_getAccount="returns the name of the account associated with the given address." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
The `getaccount` RPC {{summary_getAccount}}
*Parameter #1---a Bitcoin address*
{{WARNING}} `setaccount` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead.
*Parameter #1---a Dash address*
{% itemplate ntpd1 %}
- n: "Address"
t: "string (base58)"
p: "Required<br>(exactly 1)"
d: "A P2PKH or P2SH Bitcoin address belonging either to a specific account or the default account (\"\")"
d: "A P2PKH or P2SH Dash address belonging either to a specific account or the default account (\"\")"
{% enditemplate %}
@ -35,10 +40,10 @@ The `getaccount` RPC {{summary_getAccount}}
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
{% highlight bash %}
bitcoin-cli -testnet getaccount mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN
dash-cli -testnet getaccount yMTFRnrfJ4NpnYVeidDNHVwT7uuNsVjevq
{% endhighlight %}
Result:

View file

@ -9,13 +9,15 @@ http://opensource.org/licenses/MIT.
{% autocrossref %}
{% 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 Dash 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." %}
*Requires wallet support.*
The `getaccountaddress` RPC {{summary_getAccountAddress}}
{{WARNING}} `getaccountaddress` will be removed in a later version of Bitcoin
{{WARNING}} `getaccountaddress` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead.
*Parameter #1---an account name*
@ -28,7 +30,7 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{% enditemplate %}
*Result---a bitcoin address*
*Result---a Dash address*
{% itemplate ntpd1 %}
- n: "`result`"
@ -38,18 +40,18 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Get an address for the default account:
{% highlight bash %}
bitcoin-cli -testnet getaccountaddress ""
dash-cli -testnet getaccountaddress ""
{% endhighlight %}
Result:
{% highlight text %}
msQyFNYHkFUo4PG3puJBbpesvRCyRQax7r
yNUQ6RzTpNj5GP5ebdRcusJ7K9JJKx6VvV
{% endhighlight %}
*See also*

View file

@ -9,13 +9,15 @@ http://opensource.org/licenses/MIT.
{% assign summary_getAddressesByAccount="returns a list of every address assigned to a particular account." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
The `getaddressesbyaccount` RPC {{summary_getAddressesByAccount}}
{{WARNING}} `getaddressesbyaccount` will be removed in a later version of Bitcoin
{{WARNING}} `getaddressesbyaccount` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead.
*Parameter #1---the account name*
@ -43,21 +45,20 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Get the addresses assigned to the account "doc test":
{% highlight bash %}
bitcoin-cli -testnet getaddressesbyaccount "doc test"
dash-cli -testnet getaddressesbyaccount "doc test"
{% endhighlight %}
Result:
{% highlight json %}
[
"mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN",
"mft61jjkmiEJwJ7Zw3r1h344D6aL1xwhma",
"mmXgiR6KAhZCyQ8ndr2BCfEq1wNG2UnyG6"
"yMTFRnrfJ4NpnYVeidDNHVwT7uuNsVjevq",
"yhT2HS1SxvXkMVdAdf6RNtGPfuVFvwZi35"
]
{% endhighlight %}

View file

@ -7,7 +7,9 @@ http://opensource.org/licenses/MIT.
##### GetBalance
{% include helpers/subhead-links.md %}
{% 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 dash across all accounts or for a particular account." %}
<!-- __ -->
{% autocrossref %}
@ -29,36 +31,61 @@ The `getbalance` RPC {{summary_getBalance}}
{{INCLUDE_CONFIRMATIONS_PARAMETER}}
*Parameter #3---whether to include watch-only addresses*
{{INCLUDE_INCLUDE_WATCH_ONLY_PARAMETER}}
*Result---the balance in bitcoins*
*Parameter #3---whether to add 5 confirmations to transactions locked via InstantSend*
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (bitcoins)"
p: "Required<br>(exactly 1)"
d: "The balance of the account (or all accounts) in bitcoins"
- n: "addlockconf"
t: "bool"
p: "Optional<br>(exactly 1)"
d: "Add the number of InstantSend confirmations to InstantSend locked transactions"
{% enditemplate %}
*Examples from Bitcoin Core 0.10.0*
*Parameter #4---whether to include watch-only addresses*
Get the balance for the "test1" account, including transactions with
at least one confirmation and those spent to watch-only addresses in
that account.
{{INCLUDE_INCLUDE_WATCH_ONLY_PARAMETER}}
*Result---the balance in dash*
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (dash)"
p: "Required<br>(exactly 1)"
d: "The balance of the account (or all accounts) in dash"
{% enditemplate %}
*Examples from Dash Core 0.12.2*
Get the balance for the main ("") account, including transactions with
at least five confirmations and those spent to watch-only addresses in
that account. Do not add the InstantSend confirmations (5) for locked transactions.
{% highlight bash %}
bitcoin-cli -testnet getbalance "test1" 1 true
dash-cli -testnet getbalance "" 3 false true
{% endhighlight %}
Result:
{% highlight json %}
1.99900000
0.00000000
{% endhighlight %}
Get the balance for the main ("") account, including transactions with
at least one confirmation and those spent to watch-only addresses in
that account. Add the InstantSend confirmations (5) for locked transactions.
{% highlight bash %}
dash-cli -testnet getbalance "" 3 true true
{% endhighlight %}
Result:
{% highlight json %}
1.00000000
{% endhighlight %}
*See also*
* [ListAccounts][rpc listaccounts]: {{summary_listAccounts}}

View file

@ -7,7 +7,9 @@ http://opensource.org/licenses/MIT.
##### GetNewAddress
{% include helpers/subhead-links.md %}
{% assign summary_getNewAddress="returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account." %}
{% assign summary_getNewAddress="returns a new Dash address for receiving payments. If an account is specified, payments received with the address will be credited to that account." %}
<!-- __ -->
{% autocrossref %}
@ -25,7 +27,7 @@ The `getnewaddress` RPC {{summary_getNewAddress}}
{% enditemplate %}
*Result---a bitcoin address never previously returned*
*Result---a dash address never previously returned*
{% itemplate ntpd1 %}
- n: "`result`"
@ -35,18 +37,18 @@ The `getnewaddress` RPC {{summary_getNewAddress}}
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Create a new address in the "doc test" account:
{% highlight bash %}
bitcoin-cli -testnet getnewaddress "doc test"
dash-cli -testnet getnewaddress "doc test"
{% endhighlight %}
Result:
{% highlight text %}
mft61jjkmiEJwJ7Zw3r1h344D6aL1xwhma
yPuNTqCGzXtU3eEV5jHvhhJkzEPyJLmVkb
{% endhighlight %}
*See also*

View file

@ -7,7 +7,9 @@ http://opensource.org/licenses/MIT.
##### GetRawChangeAddress
{% include helpers/subhead-links.md %}
{% assign summary_getRawChangeAddress="returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use." %}
{% assign summary_getRawChangeAddress="returns a new Dash address for receiving change. This is for use with raw transactions, not normal use." %}
<!-- __ -->
{% autocrossref %}
@ -27,16 +29,16 @@ The `getrawchangeaddress` RPC {{summary_getRawChangeAddress}}
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
{% highlight bash %}
bitcoin-cli -testnet getrawchangeaddress
dash-cli -testnet getrawchangeaddress
{% endhighlight %}
Result:
{% highlight text %}
mnycUc8FRjJodfKhaj9QBZs2PwxxYoWqaK
yXBr9BiJmugTzHPgByDmvjJMAkvhTmXVJ8
{% endhighlight %}
*See also*

View file

@ -9,13 +9,15 @@ http://opensource.org/licenses/MIT.
{% assign summary_getReceivedByAccount="returns the total amount received by addresses in a particular account from transactions with the specified number of confirmations. It does not count coinbase transactions." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
The `getreceivedbyaccount` RPC {{summary_getReceivedByAccount}}
{{WARNING}} `getreceivedbyaccount` will be removed in a later version of Bitcoin
{{WARNING}} `getreceivedbyaccount` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead.
*Parameter #1---the account name*
@ -32,23 +34,33 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{{INCLUDE_CONFIRMATIONS_PARAMETER}}
*Result---the number of bitcoins received*
*Parameter #3---whether to add 5 confirmations to transactions locked via InstantSend*
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (bitcoins)"
p: "Required<br>(exactly 1)"
d: "The number of bitcoins received by the account. May be `0`"
- n: "addlockconf"
t: "bool"
p: "Optional<br>(exactly 1)"
d: "Add the number of InstantSend confirmations to InstantSend locked transactions (default=false)"
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Result---the number of dash received*
Get the bitcoins received by the "doc test" account with six or more
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (dash)"
p: "Required<br>(exactly 1)"
d: "The number of dash received by the account. May be `0`"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Get the dash received by the "doc test" account with six or more
confirmations:
{% highlight bash %}
bitcoin-cli -testnet getreceivedbyaccount "doc test" 6
dash-cli -testnet getreceivedbyaccount "doc test" 6
{% endhighlight %}
Result:

View file

@ -9,6 +9,8 @@ http://opensource.org/licenses/MIT.
{% assign summary_getReceivedByAddress="returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
@ -29,23 +31,48 @@ The `getreceivedbyaddress` RPC {{summary_getReceivedByAddress}}
{{INCLUDE_CONFIRMATIONS_PARAMETER}}
*Result---the number of bitcoins received*
*Parameter #3---whether to add 5 confirmations to transactions locked via InstantSend*
{% itemplate ntpd1 %}
- n: "addlockconf"
t: "bool"
p: "Optional<br>(exactly 1)"
d: "Add the number of InstantSend confirmations to InstantSend locked transactions"
{% enditemplate %}
*Result---the amount of dash received*
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (bitcoins)"
p: "Required<br>(exactly 1)"
d: "The number of bitcoins received by the address, excluding coinbase transactions. May be `0`"
d: "The amount of dash received by the address, excluding coinbase transactions. May be `0`"
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Get the bitcoins received for a particular address, only counting
transactions with six or more confirmations:
Get the dash received for a particular address, only counting
transactions with six or more confirmations (ignore InstantSend confirmations for
locked InstantSend transactions):
{% highlight bash %}
bitcoin-cli -testnet getreceivedbyaddress mjSk1Ny9spzU2fouzYgLqGUD8U41iR35QN 6
dash-cli -testnet getreceivedbyaddress yYoCWcjbykWsQJ7MVJrTMeQd8TZe5N4Q7g 6
{% endhighlight %}
Result:
{% highlight json %}
0.00000000
{% endhighlight %}
Get the dash received for a particular address, only counting
transactions with six or more confirmations (include InstantSend confirmations for
locked InstantSend transactions):
{% highlight bash %}
dash-cli -testnet getreceivedbyaddress yYoCWcjbykWsQJ7MVJrTMeQd8TZe5N4Q7g 6 true
{% endhighlight %}
Result:
@ -54,6 +81,7 @@ Result:
0.30000000
{% endhighlight %}
*See also*
* [GetReceivedByAccount][rpc getreceivedbyaccount]: {{summary_getReceivedByAccount}}

View file

@ -9,16 +9,18 @@ http://opensource.org/licenses/MIT.
{% assign summary_setAccount="puts the specified address in the given account." %}
<!-- __ -->
{% autocrossref %}
*Requires wallet support.*
The `setaccount` RPC {{summary_setAccount}}
{{WARNING}} `setaccount` will be removed in a later version of Bitcoin
{{WARNING}} `setaccount` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead.
*Parameter #1---a bitcoin address*
*Parameter #1---a dash address*
{% itemplate ntpd1 %}
- n: "Address"
@ -48,13 +50,13 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{% enditemplate %}
*Example from Bitcoin Core 0.10.0*
*Example from Dash Core 0.12.2*
Put the address indicated below in the "doc test" account.
{% highlight bash %}
bitcoin-cli -testnet setaccount \
mmXgiR6KAhZCyQ8ndr2BCfEq1wNG2UnyG6 "doc test"
dash-cli -testnet setaccount \
yMTFRnrfJ4NpnYVeidDNHVwT7uuNsVjevq "doc test"
{% endhighlight %}
(Success: no result displayed.)