From 7eca46f449dd65597a3b93444301083e84a1aa68 Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 8 Apr 2019 17:17:22 -0400 Subject: [PATCH] RPC - Start adding quorum RPCs --- _autocrossref.yaml | 2 + _config.yml | 1 + .../devdoc/dash-core/rpcs/quick-reference.md | 1 + .../devdoc/dash-core/rpcs/rpcs/quorum.md | 95 +++++++++++++++++++ _includes/helpers/summaries.md | 1 + _includes/layout/base/rpc-table.html | 6 ++ _includes/references.md | 1 + en/developer-reference.md | 2 + 8 files changed, 109 insertions(+) create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/quorum.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index e8d501d3..22751ece 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -516,6 +516,8 @@ DIP1: '`privatesend` RPC': rpc privatesend '`pruneblockchain`': rpc pruneblockchain '`pruneblockchain` RPC': rpc pruneblockchain +'`quorum`': rpc quorum +'`quorum` RPC': rpc quorum '`removeprunedfunds`': rpc removeprunedfunds '`removeprunedfunds` RPC': rpc removeprunedfunds '`sendfrom`': rpc sendfrom diff --git a/_config.yml b/_config.yml index c2692a4f..58cf2ff6 100644 --- a/_config.yml +++ b/_config.yml @@ -294,6 +294,7 @@ devsearches: - 'PrioritiseTransaction': "/en/developer-reference#prioritisetransaction" - 'PrivateSend': "/en/developer-reference#privatesend" - 'PruneBlockChain': "/en/developer-reference#pruneblockchain" + - 'Quorum': "/en/developer-reference#quorum" - 'RemovePrunedFunds': "/en/developer-reference#removeprunedfunds" - 'SendFrom': "/en/developer-reference#sendfrom" - 'SendMany': "/en/developer-reference#sendmany" diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index d078ab61..6bcee4c2 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -180,6 +180,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core * [BLS][rpc bls]: {{summary_bls}} {{DASH_UPDATED0_14_0}} * [ProTx][rpc protx]: {{summary_proTx}} {{DASH_UPDATED0_14_0}} +* [Quorum][rpc quorum]: {{summary_quorum}} {{DASH_NEW0_14_0}} {% endautocrossref %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md b/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md new file mode 100644 index 00000000..7d2b3d8e --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md @@ -0,0 +1,95 @@ +{% comment %} +This file is licensed under the MIT License (MIT) available on +http://opensource.org/licenses/MIT. +{% endcomment %} +{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/quorum.md" %} + +##### Quorum +{% include helpers/subhead-links.md %} + + + +{% assign summary_quorum="provides a set of commands for quorums (LLMQs)." %} + +{% autocrossref %} + +*Added in Dash Core 0.14.0* + +The `quorum` RPC {{summary_quorum}} + +{% endautocrossref %} + +###### Quorum List + + +{% autocrossref %} + +The `quorum list` RPC displays a list of on-chain quorums. + +*Parameter #1---quorum count* + +{% itemplate ntpd1 %} +- n: "`count`" + t: "number" + p: "Optional
(0 or 1)" + d: "Number of quorums to list" +{% enditemplate %} + +*Result---a secret/public key pair* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "object" + p: "Required
(exactly 1)" + d: "Quorum list" + +- n: "→
Quorum" + t: "array" + p: "Required
(1 or more)" + d: "Array of quorum details" + +- n: "→ →
Quorum Hash" + t: "string (hex)" + p: "Optional
(0 or more)" + d: "A quorum hash" +{% enditemplate %} + +*Example from Dash Core 0.14.0* + +{% highlight bash %} +dash-cli -testnet quorum list +{% endhighlight %} + +Result: +{% highlight json %} +{ + "llmq_50_60": [ + "00000000023cc6dde69bed898c83fe2328ef38b1ea9da14a599efa14caef0b7d", + "000000002b968fb3b2fc2ff18d6e89611e366b4d38a6d0437e99bd7c37f2fd83", + "000000000301054c038b07b5b51493d5efc3f078e3aede6eb603c47943d1cc78", + "000000000e901278c00c896754a06f8d45d0268c6aff6e72ffb3007d07c10e73", + "000000001bc592f2a8676203835bc6ad442abeadb9c22b8d6a2999db07354b01", + "000000000896c37ef8a32318ee871589394f1578473b8825275b610690e47db0", + "00000000133b192b2319a0716ad18e5788981fff51856f61205af5d6a634ba41", + "0000000004946f3f9f82a298985f73080d62627d51f6f4ba77f3cd8c6788b3d0", + "0000000005cb014d3df9bac0ba379f1d5b8b75f0e6d7c408d43ac1db330ec641", + "0000000006c1653c7ee747f140dd7daa1da23a541e67a0fc0dc88db3482ec4d5" + ], + "llmq_400_60": [ + "0000000007697fd69a799bfa26576a177e817bc0e45b9fcfbf48b362b05aeff2" + ], + "llmq_400_85": [ + ] +} +{% endhighlight %} + +{% endautocrossref %} + + + + +{% autocrossref %} + +*See also:* + +{% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index e7e0ed55..f09fbb1a 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -112,6 +112,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_privateSend="controls the mixing process." %} {% assign summary_proTx="provides a set of commands to execute ProTx related actions." %} {% assign summary_pruneBlockChain="prunes the blockchain up to a specified height or timestamp." %} +{% assign summary_quorum="provides a set of commands for quorums (LLMQs)." %} {% assign summary_removePrunedFunds="deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds." %} {% assign summary_restGetBlock-noTxDetails="gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block. The JSON object includes TXIDs for transactions within the block rather than the complete transactions [GET block][rest get block] returns." %} {% assign summary_restGetBlock="gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block." %} diff --git a/_includes/layout/base/rpc-table.html b/_includes/layout/base/rpc-table.html index ce69cde8..9625857f 100644 --- a/_includes/layout/base/rpc-table.html +++ b/_includes/layout/base/rpc-table.html @@ -313,6 +313,12 @@ th.tg-sort-header::-moz-selection { background:transparent; }th.tg-sort-header:: Y Updated in 0.14.0 + + Evolution + Quorum + Y + Added in 0.14.0 + Generating Generate diff --git a/_includes/references.md b/_includes/references.md index 55ca041c..83022c0a 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -180,6 +180,7 @@ http://opensource.org/licenses/MIT. [rpc pruneblockchain]: /en/developer-reference#pruneblockchain [rpc prioritisetransaction]: /en/developer-reference#prioritisetransaction [rpc privatesend]: /en/developer-reference#privatesend +[rpc quorum]: /en/developer-reference#quorum [rpc removeprunedfunds]: /en/developer-reference#removeprunedfunds [rpc sendfrom]: /en/developer-reference#sendfrom [rpc sendmany]: /en/developer-reference#sendmany diff --git a/en/developer-reference.md b/en/developer-reference.md index 4ed0585e..3fb85fb0 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -294,6 +294,8 @@ untrusted source. {% include devdoc/dash-core/rpcs/rpcs/pruneblockchain.md %} +{% include devdoc/dash-core/rpcs/rpcs/quorum.md %} + {% include devdoc/dash-core/rpcs/rpcs/removeprunedfunds.md %} {% include devdoc/dash-core/rpcs/rpcs/sendfrom.md %}