Add details for some Dash RPCs

- GetGovernanceInfo, GetPoolInfo, GetSuperblockBudget
This commit is contained in:
thephez 2017-10-10 13:22:52 -04:00
parent b11343405b
commit b2d004c4d8
5 changed files with 183 additions and 8 deletions

View file

@ -23,6 +23,8 @@ The `debug` RPC {{summary_debug}}
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet debug "net,mempool"
{% endhighlight %}

View file

@ -7,21 +7,74 @@ http://opensource.org/licenses/MIT.
##### GetGovernanceInfo
{% include helpers/subhead-links.md %}
{% assign summary_getGovernanceInfo="" %}
{% assign summary_getGovernanceInfo="returns an object containing governance parameters." %}
{% autocrossref %}
The `getgovernanceinfo` RPC {{summary_getGovernanceInfo}}
*Parameters: none*
*Result---information about the governance system*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Information about the governance system"
- n: "→<br>`governanceminquorum`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The absolute minimum number of votes needed to trigger a governance action"
- n: "→<br>`masternodewatchdogmaxseconds`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Sentinel watchdog expiration time in seconds"
- n: "→<br>`proposalfee`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The collateral transaction fee which must be paid to create a proposal in Dash"
- n: "→<br>`superblockcycle`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The number of blocks between superblocks"
- n: "→<br>`lastsuperblock`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The block number of the last superblock"
- n: "→<br>`nextsuperblock`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The block number of the next superblock"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet getgovernanceinfo
{% endhighlight %}
Result:
{% highlight json %}
*INSERT RESULTS HERE*
{
"governanceminquorum": 1,
"masternodewatchdogmaxseconds": 7200,
"proposalfee": 5.00000000,
"superblockcycle": 24,
"lastsuperblock": 7368,
"nextsuperblock": 7392
}
{% endhighlight %}
*See also:*
* [GObject][rpc gobject]: {{summary_gObject}}
{% endautocrossref %}

View file

@ -7,19 +7,112 @@ http://opensource.org/licenses/MIT.
##### GetPoolInfo
{% include helpers/subhead-links.md %}
{% assign summary_getPoolInfo="" %}
{% assign summary_getPoolInfo="returns an object containing mixing pool related information." %}
{% autocrossref %}
The `getpoolinfo` RPC {{summary_getPoolInfo}}
*Parameters: none*
*Result---information about the mixing pool*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Information about the mixing pool"
- n: "→<br>`state`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Mixing pool state. Will be one of the following:<br>`IDLE` <br>`QUEUE` <br>`ACCEPTING_ENTRIES` <br>`SIGNING` <br>`ERROR` <br>`SUCCESS` <br>`UNKNOWN` <br>"
- n: "→<br>`mixing_mode`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Mixing mode - will be one of the following:<br>`normal` <br>`multi-session` <br> "
- n: "→<br>`queue`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "Queue size"
- n: "→<br>`entries`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The number of entries"
- n: "→<br>`status`"
t: "string"
p: "Required<br>(exactly 1)"
d: "A more detailed description of the current state"
- n: "→<br>`outpoint`"
t: "string (hex)"
p: "Optional<br>(exactly 1)"
d: "Previous output"
- n: "→<br>`addr`"
t: "string"
p: "Optional<br>(exactly 1)"
d: "Address"
- n: "→<br>`keys_left`"
t: "number (int)"
p: "Optional<br>(exactly 1)"
d: "The number of keys left in the local wallet"
- n: "→<br>`warnings`"
t: "number (int)"
p: "Optional<br>(exactly 1)"
d: "Warnings related to local wallet"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet getpoolinfo
{% endhighlight %}
Result:
{% highlight json %}
*INSERT RESULTS HERE*
{
"state": "IDLE",
"mixing_mode": "normal",
"queue": 0,
"entries": 0,
"status": "PrivateSend is idle.",
"keys_left": 617,
"warnings": ""
}
{% endhighlight %}
{% highlight json %}
{
"state": "QUEUE",
"mixing_mode": "normal",
"queue": 1,
"entries": 0,
"status": "Submitted to masternode, waiting in queue .",
"outpoint": "e3a6b7878a7e9413898bb379b323c521676f9d460db17ec3bf42d9ac0c9a432f-1",
"addr": "217.182.229.146:19999",
"keys_left": 571,
"warnings": ""
}
{% endhighlight %}
{% highlight json %}
{
"state": "ERROR",
"mixing_mode": "normal",
"queue": 0,
"entries": 0,
"status": "PrivateSend request incomplete: Session timed out. Will retry...",
"keys_left": 571,
"warnings": ""
}
{% endhighlight %}
*See also:*

View file

@ -7,21 +7,45 @@ http://opensource.org/licenses/MIT.
##### GetSuperblockBudget
{% include helpers/subhead-links.md %}
{% assign summary_getSuperblockBudget="" %}
{% assign summary_getSuperblockBudget="returns the absolute maximum sum of superblock payments allowed." %}
{% autocrossref %}
The `getsuperblockbudget` RPC {{summary_getSuperblockBudget}}
*Parameter #1---block index*
{% itemplate ntpd1 %}
- n: "index"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The superblock index"
{% enditemplate %}
*Result---maximum sum of superblock payments*
{% itemplate ntpd1 %}
- n: "`result`"
t: "number (int)"
p: "Required<br>(exactly 1)"
d: "The absolute maximum sum of superblock payments allowed, in DASH"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet getsuperblockbudget
dash-cli -testnet getsuperblockbudget 7392
{% endhighlight %}
Result:
{% highlight json %}
*INSERT RESULTS HERE*
{% highlight text %}
367.20
{% endhighlight %}
*See also:*
* [GetGovernanceInfo][rpc getgovernanceinfo]: {{summary_getGovernanceInfo}}
{% endautocrossref %}