Skip to content

Commit 51f9b5c

Browse files
committed
docs(rpc): add quorum platformsign
1 parent d7b0c11 commit 51f9b5c

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/api/remote-procedure-calls-evo.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3742,6 +3742,78 @@ Result:
37423742

37433743
*See also: none*
37443744

3745+
### Quorum PlatformSign
3746+
3747+
:::{versionadded} 21.0.0
3748+
:::
3749+
3750+
The `quorum platformsign` RPC requests threshold-signing for a message. It signs messages only for
3751+
Platform quorums. It is equivalent to `quorum sign <platform LLMQ type>`.
3752+
3753+
*Parameter #1---id*
3754+
3755+
| Name | Type | Presence | Description |
3756+
| ---- | ------------ | ----------------------- | ----------- |
3757+
| `id` | string (hex) | Required<br>(exactly 1) | Signing request ID |
3758+
3759+
*Parameter #2---message hash*
3760+
3761+
| Name | Type | Presence | Description |
3762+
| --------- | ------------ | ----------------------- | -------------------------------- |
3763+
| `msgHash` | string (hex) | Required<br>(exactly 1) | Hash of the message to be signed |
3764+
3765+
*Parameter #3---quorum hash*
3766+
3767+
| Name | Type | Presence | Description |
3768+
| ------------ | ------------ | -------------------- | --------------------- |
3769+
| `quorumHash` | string (hex) | Optional<br>(0 or 1) | The quorum identifier |
3770+
3771+
*Parameter #4---submit*
3772+
3773+
| Name | Type | Presence | Description |
3774+
| -------- | ---- | -------------------- | ----------- |
3775+
| `submit` | bool | Optional<br>(0 or 1) | Submits the signature share to the network if this is `true` (default). Returns an object containing the signature share if this is `false`. |
3776+
3777+
*Result---(if submit = `true`) status*
3778+
3779+
| Name | Type | Presence | Description |
3780+
| ------ | ---- | ----------------------- | ---------------------------------- |
3781+
| result | bool | Required<br>(exactly 1) | True or false depending on success |
3782+
3783+
*Result---(if submit = `false`) signature share JSON object*
3784+
3785+
| Name | Type | Presence | Description |
3786+
| ------------------- | ------------ | ----------------------- | ----------- |
3787+
| result | object | Required<br>(exactly 1) | JSON object containing signature share details |
3788+
| →<br>`llmqType` | number | Required<br>(exactly 1) | [Type of quorum](https://github.com/dashpay/dips/blob/master/dip-0006/llmq-types.md):<br>`4` - LLMQ_100_67 |
3789+
| →<br>`quorumHash` | string (hex) | Required<br>(exactly 1) | The quorum identifier |
3790+
| →<br>`quorumMember` | number | Required<br>(exactly 1) | Which quorum member created this signature share |
3791+
| →<br>`id` | string (hex) | Required<br>(exactly 1) | Signing request ID |
3792+
| →<br>`msgHash` | string (hex) | Required<br>(exactly 1) | Hash of the message that was signed |
3793+
| →<br>`signHash` | string (hex) | Required<br>(exactly 1) | Hash of `llmqType`, `quorumHash`, `id`, and `msgHash` |
3794+
| →<br>`signature` | string (hex) | Required<br>(exactly 1) | Signature share |
3795+
3796+
*Example from Dash Core 21.0.0*
3797+
3798+
Submit signature share to network (default):
3799+
3800+
```bash
3801+
dash-cli -testnet quorum platformsign \
3802+
"abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234" \
3803+
"51c11d287dfa85aef3eebb5420834c8e443e01d15c0b0a8e397d67e2e51aa239"
3804+
```
3805+
3806+
Result:
3807+
3808+
```json
3809+
false
3810+
```
3811+
3812+
_See also_
3813+
3814+
* [Quorum Sign](#quorum-sign): requests threshold-signing for a message.
3815+
* [Quorum Info](#quorum-info): retrieves information about a specific quorum, including its members and the threshold required for signing.
3816+
37453817
### Quorum RotationInfo
37463818

37473819
The `quorum rotationinfo` RPC returns quorum rotation information. The response is a JSON representation of the data that would be returned in a [`qrinfo` message](../reference/p2p-network-data-messages.md#qrinfo).

0 commit comments

Comments
 (0)