diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/debug.md b/_includes/devdoc/dash-core/rpcs/rpcs/debug.md index 674add3e..589c5ea0 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/debug.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/debug.md @@ -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 %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getgovernanceinfo.md b/_includes/devdoc/dash-core/rpcs/rpcs/getgovernanceinfo.md index aafedff2..576e2ece 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/getgovernanceinfo.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/getgovernanceinfo.md @@ -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
(exactly 1)" + d: "Information about the governance system" + +- n: "→
`governanceminquorum`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The absolute minimum number of votes needed to trigger a governance action" + +- n: "→
`masternodewatchdogmaxseconds`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Sentinel watchdog expiration time in seconds" + +- n: "→
`proposalfee`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The collateral transaction fee which must be paid to create a proposal in Dash" + +- n: "→
`superblockcycle`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The number of blocks between superblocks" + +- n: "→
`lastsuperblock`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The block number of the last superblock" + +- n: "→
`nextsuperblock`" + t: "number (int)" + p: "Required
(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 %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getpoolinfo.md b/_includes/devdoc/dash-core/rpcs/rpcs/getpoolinfo.md index bd25c4bd..06209fd1 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/getpoolinfo.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/getpoolinfo.md @@ -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
(exactly 1)" + d: "Information about the mixing pool" + +- n: "→
`state`" + t: "string" + p: "Required
(exactly 1)" + d: "Mixing pool state. Will be one of the following:
• `IDLE`
• `QUEUE`
• `ACCEPTING_ENTRIES`
• `SIGNING`
• `ERROR`
• `SUCCESS`
• `UNKNOWN`
" + +- n: "→
`mixing_mode`" + t: "string" + p: "Required
(exactly 1)" + d: "Mixing mode - will be one of the following:
• `normal`
• `multi-session`
" + +- n: "→
`queue`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "Queue size" + +- n: "→
`entries`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The number of entries" + +- n: "→
`status`" + t: "string" + p: "Required
(exactly 1)" + d: "A more detailed description of the current state" + +- n: "→
`outpoint`" + t: "string (hex)" + p: "Optional
(exactly 1)" + d: "Previous output" + +- n: "→
`addr`" + t: "string" + p: "Optional
(exactly 1)" + d: "Address" + +- n: "→
`keys_left`" + t: "number (int)" + p: "Optional
(exactly 1)" + d: "The number of keys left in the local wallet" + +- n: "→
`warnings`" + t: "number (int)" + p: "Optional
(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:* diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getsuperblockbudget.md b/_includes/devdoc/dash-core/rpcs/rpcs/getsuperblockbudget.md index fe4a89b8..0522bd93 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/getsuperblockbudget.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/getsuperblockbudget.md @@ -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
(exactly 1)" + d: "The superblock index" + +{% enditemplate %} + +*Result---maximum sum of superblock payments* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "number (int)" + p: "Required
(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 %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index ce7c722b..2c8cd6c7 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -44,6 +44,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_getConnectionCount="returns the number of connections to other nodes." %} {% assign summary_getDifficultly="returns the proof-of-work difficulty as a multiple of the minimum difficulty." %} {% assign summary_getGenerate="was removed in Bitcoin Core 0.13.0." %} +{% assign summary_getGovernanceInfo="returns an object containing governance parameters." %} {% assign summary_getHashesPerSec="was removed in Bitcoin Core 0.11.0." %} {% assign summary_getInfo="prints various information about the node and the network." %} {% assign summary_getMemPoolAncestors="returns all in-mempool ancestors for a transaction in the mempool." %} @@ -57,12 +58,14 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_getNetworkInfo="returns information about the node's connection to the network." %} {% 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_getPeerInfo="returns data about each connected network node." %} +{% assign summary_getPoolInfo="returns an object containing mixing pool related information." %} {% assign summary_getRawChangeAddress="returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use." %} {% assign summary_getRawMemPool="returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object." %} {% assign summary_getRawTransaction="gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Bitcoin Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default `txindex=1` in your Bitcoin Core startup settings." %} {% 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." %} {% 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." %} {% assign summary_getSpentInfo="returns the txid and index where an output is spent (requires `spentindex` to be enabled)." %} +{% assign summary_getSuperblockBudget="returns the absolute maximum sum of superblock payments allowed." %} {% assign summary_getTransaction="gets detailed information about an in-wallet transaction." %} {% assign summary_getTxOut="returns details about a transaction output. Only unspent transaction outputs (UTXOs) are guaranteed to be available." %} {% assign summary_getTxOutProof="returns a hex-encoded proof that one or more specified transactions were included in a block." %}