Update existing Control RPCs (GetInfo, Help, Stop)

This commit is contained in:
thephez 2017-10-09 16:35:57 -04:00
parent 6b4c2febce
commit 97c84724e8
3 changed files with 47 additions and 40 deletions

View file

@ -13,7 +13,7 @@ http://opensource.org/licenses/MIT.
The `getinfo` RPC {{summary_getInfo}} The `getinfo` RPC {{summary_getInfo}}
{{WARNING}} `getinfo` will be removed in a later version of Bitcoin {{WARNING}} `getinfo` will be removed in a later version of Dash
Core. Use the RPCs listed in the See Also subsection below instead. Core. Use the RPCs listed in the See Also subsection below instead.
*Parameters: none* *Parameters: none*
@ -29,7 +29,7 @@ Core. Use the RPCs listed in the See Also subsection below instead.
- n: "→<br>`version`" - n: "→<br>`version`"
t: "number (int)" t: "number (int)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "This node's version of Bitcoin Core in its internal integer format. For example, Bitcoin Core 0.9.2 has the integer version number 90200" d: "This node's version of Bitcoin Core in its internal integer format. For example, Dash Core 0.12.2 has the integer version number 120200"
- n: "→<br>`protocolversion`" - n: "→<br>`protocolversion`"
t: "number (int)" t: "number (int)"
@ -42,9 +42,14 @@ Core. Use the RPCs listed in the See Also subsection below instead.
d: "The version number of the wallet. Only returned if wallet support is enabled" d: "The version number of the wallet. Only returned if wallet support is enabled"
- n: "→<br>`balance`" - n: "→<br>`balance`"
t: "number (bitcoins)" t: "number (duffs)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The balance of the wallet in bitcoins. Only returned if wallet support is enabled" d: "The total balance of the wallet in duffs. Only returned if wallet support is enabled"
- n: "→<br>`privatesend_balance`"
t: "number (duffs)"
p: "Optional<br>(0 or 1)"
d: "The PrivateSend balance of the wallet in duffs. Only returned if wallet support is enabled (Added in Dash Core 0.11.0)"
- n: "→<br>`blocks`" - n: "→<br>`blocks`"
t: "number (int)" t: "number (int)"
@ -86,21 +91,21 @@ Core. Use the RPCs listed in the See Also subsection below instead.
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The number of keys in the wallet keypool. Only returned if wallet support is enabled" d: "The number of keys in the wallet keypool. Only returned if wallet support is enabled"
- n: "→<br>`paytxfee`"
t: "number (bitcoins)"
p: "Optional<br>(0 or 1)"
d: "The minimum fee to pay per kilobyte of transaction; may be `0`. Only returned if wallet suuport is enabled"
- n: "→<br>`relayfee`"
t: "number (bitcoins)"
p: "Required<br>(exactly 1)"
d: "The minimum fee a low-priority transaction must pay in order for this node to accept it into its memory pool"
- n: "→<br>`unlocked_until`" - n: "→<br>`unlocked_until`"
t: "number (int)" t: "number (int)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The Unix epoch time when the wallet will automatically re-lock. Only displayed if wallet encryption is enabled. Set to `0` if wallet is currently locked" d: "The Unix epoch time when the wallet will automatically re-lock. Only displayed if wallet encryption is enabled. Set to `0` if wallet is currently locked"
- n: "→<br>`paytxfee`"
t: "number (duffs)"
p: "Optional<br>(0 or 1)"
d: "The minimum fee to pay per kilobyte of transaction; may be `0`. Only returned if wallet support is enabled"
- n: "→<br>`relayfee`"
t: "number (duffs)"
p: "Required<br>(exactly 1)"
d: "The minimum fee a low-priority transaction must pay in order for this node to accept it into its memory pool"
- n: "→<br>`errors`" - n: "→<br>`errors`"
t: "string" t: "string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
@ -108,31 +113,33 @@ Core. Use the RPCs listed in the See Also subsection below instead.
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0 with wallet support enabled* *Example from Dash Core 0.12.2 with wallet support enabled*
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet getinfo dash-cli -testnet getinfo
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight json %} {% highlight json %}
{ {
"version" : 100000, "version": 120200,
"protocolversion" : 70002, "protocolversion": 70208,
"walletversion" : 60000, "walletversion": 61000,
"balance" : 1.27007770, "balance": 0.00000000,
"blocks" : 315281, "privatesend_balance": 0.00000000,
"timeoffset" : 0, "blocks": 0,
"connections" : 9, "timeoffset": 0,
"proxy" : "", "connections": 0,
"difficulty" : 1.00000000, "proxy": "",
"testnet" : true, "difficulty": 0.000244140625,
"keypoololdest" : 1418924649, "testnet": true,
"keypoolsize" : 101, "keypoololdest": 1507579068,
"paytxfee" : 0.00000000, "keypoolsize": 617,
"relayfee" : 0.00001000, "unlocked_until": 0,
"errors" : "" "paytxfee": 0.00000000,
"relayfee": 0.00010000,
"errors": ""
} }
{% endhighlight %} {% endhighlight %}

View file

@ -19,7 +19,7 @@ The `help` RPC {{summary_help}}
- n: "RPC" - n: "RPC"
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The name of the RPC to get help for. If omitted, Bitcoin Core 0.9x will display an alphabetical list of commands; Bitcoin Core 0.10.0 will display a categorized list of commands" d: "The name of the RPC to get help for. If omitted, Dash Core 0.10x will display an alphabetical list of commands; Dash Core 0.11.0 will display a categorized list of commands"
{% enditemplate %} {% enditemplate %}
@ -29,16 +29,16 @@ The `help` RPC {{summary_help}}
- n: "`result`" - n: "`result`"
t: "string" t: "string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The help text for the specified RPC or the list of commands. The `bitcoin-cli` command will parse this text and format it as human-readable text" d: "The help text for the specified RPC or the list of commands. The `dash-cli` command will parse this text and format it as human-readable text"
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Dash Core 0.12.2*
Command to get help about the `help` RPC: Command to get help about the `help` RPC:
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet help help dash-cli -testnet help help
{% endhighlight %} {% endhighlight %}
Result: Result:

View file

@ -7,7 +7,7 @@ http://opensource.org/licenses/MIT.
##### Stop ##### Stop
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_stop="safely shuts down the Bitcoin Core server." %} {% assign summary_stop="safely shuts down the Dash Core server." %}
{% autocrossref %} {% autocrossref %}
@ -21,20 +21,20 @@ The `stop` RPC {{summary_stop}}
- n: "`result`" - n: "`result`"
t: "string" t: "string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The string \"Bitcoin server stopping\"" d: "The string \"Dash Core server stopping\""
{% enditemplate %} {% enditemplate %}
*Example from Bitcoin Core 0.10.0* *Example from Dash Core 0.12.2*
{% highlight bash %} {% highlight bash %}
bitcoin-cli -testnet stop dash-cli -testnet stop
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight text %} {% highlight text %}
Bitcoin server stopping Dash Core server stopping
{% endhighlight %} {% endhighlight %}
*See also: none* *See also: none*