From e090423dc9cf392b85f9479df6db590048ad8bd3 Mon Sep 17 00:00:00 2001 From: thephez Date: Wed, 10 Apr 2019 11:46:07 -0400 Subject: [PATCH] RPC - Add quorum dkgstatus detail level 1 and 2 info --- .../devdoc/dash-core/rpcs/rpcs/quorum.md | 168 +++++++++++++++++- 1 file changed, 167 insertions(+), 1 deletion(-) diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md b/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md index 2635a111..eab7f3cd 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/quorum.md @@ -253,7 +253,7 @@ The `quorum list` RPC displays a list of on-chain quorums. - n: "`detail_level`" t: "number" p: "Required
(exactly 1)" - d: "Detail level of output:
`0` - Only show counts (_default_)
`1` - Show member indexes
`2` - Show member's ProTxHashes" + d: "Detail level of output:
`0` - Only show counts (_default_)
`1` - Show member indexes
`2` - Show member's ProTxHashes" {% enditemplate %} *Result (if detail level was 0 or omitted)---JSON DKG details* @@ -368,7 +368,173 @@ The `quorum list` RPC displays a list of on-chain quorums. t: "object" p: "Required
(exactly 1)" d: "Object containing minable commitments" +{% enditemplate %} +*Result (if detail level was 1)---JSON DKG details including member index* + +Note: detail level 1 includes all level 0 fields and expands the following fields. + +{% itemplate ntpd1 %} +- n: "→ → →
`badMembers`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each bad member" + +- n: "→ → →
`weComplain`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each complaint sent" + +- n: "→ → →
`receivedContributions`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each contribution received" + +- n: "→ → →
`receivedComplaints`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each complaint received" + +- n: "→ → →
`receivedJustifications`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each justification received" + +- n: "→ → →
`receivedPrematureCommitments`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the member index for each commitment received" +{% enditemplate %} + +*Result (if detail level was 2)---JSON DKG details including member index and ProTx hash* + +Note: detail level 2 includes all level 0 fields, adds the `allMembers` field, and expands several fields. + +{% itemplate ntpd1 %} +- n: "→ → →
`badMembers`" + t: "array" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a bad member" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`weComplain`" + t: "object" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a member being complained about" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`receivedContributions`" + t: "object" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a member a contribution was received from" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`receivedComplaints`" + t: "object" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a member a complaint was received from" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`receivedJustifications`" + t: "object" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a member a justification was received from" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`receivedPrematureCommitments`" + t: "object" + p: "Required
(exactly 1)" + d: "An array of objects with each object containing the member index and ProTx hash for a member a premature commitment was received from" + +- n: "→ → → →
Member" + t: "object" + p: "Required
(0 or more)" + d: "An object describing quorum member details" + +- n: "→ → → → →
`memberIndex`" + t: "number" + p: "Required
(exactly 1)" + d: "The quorum member's index" + +- n: "→ → → → →
`proTxHash`" + t: "string (hex)" + p: "Required
(exactly 1)" + d: "The hash of the quorum member's provider registration transaction as hex in RPC byte order" + +- n: "→ → →
`allMembers`" + t: "array" + p: "Required
(exactly 1)" + d: "Array containing the provider registration transaction hash for all quorum members" {% enditemplate %} *Example from Dash Core 0.14.0*