Skip to content

Commit 8f55b36

Browse files
thephezthephez
authored
docs(rpc): v22 rpc updates, 2 (#123)
* docs(rpc): remove protx * _hpmn rpcs Replace by protx *_evo * docs(rpc): add quorum getdata This was missing and was also updated in v22 * docs(rpc): update send rpcs with fee_rate param * docs(rpc): update getpeerinfo * docs(rpc): update addnode * docs(rpc): add masternode connect * docs(rpc): fix link * docs(rpc): update version emphasis on quick ref page
1 parent 6b0fbd9 commit 8f55b36

6 files changed

+244
-98
lines changed

‎docs/api/remote-procedure-call-quick-reference.md‎

Lines changed: 55 additions & 51 deletions
Large diffs are not rendered by default.

‎docs/api/remote-procedure-calls-dash.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1193,6 +1193,44 @@ dash-cli -testnet gobject vote-many \
11931193

11941194
The [`masternode` RPC](#masternode) provides a set of commands for managing masternodes and displaying information about them.
11951195

1196+
### Masternode Connect
1197+
1198+
The [`masternode connect` RPC](#masternode-connect) initiates a connection to a specified masternode address, with optional support for the BIP324 v2 transport protocol.
1199+
1200+
_Parameter #1---the address of the masternode_
1201+
1202+
| Name | Type | Presence | Description |
1203+
| --------- | ------ | ----------------------- | ----------- |
1204+
| address | string | Required<br>(exactly 1) | The IP address and port of the masternode to connect to (e.g., `192.168.1.100:19999`) |
1205+
1206+
_Parameter #2---transport protocol options_
1207+
1208+
| Name | Type | Presence | Description |
1209+
| ------------ | ------- | -------------------- | ----------- |
1210+
| v2transport | bool | Optional<br>(0 or 1) | Set to `true` to attempt connection using the BIP324 v2 transport protocol. Defaults to `false`. |
1211+
1212+
_Result---connection status_
1213+
1214+
| Name | Type | Presence | Description |
1215+
| ------------ | ------- | ----------------------- | ----------- |
1216+
| `result` | string | Required<br>(exactly 1) | Command return status |
1217+
1218+
*Example from Dash Core 22.0.0*
1219+
1220+
Connect to a masternode at address `192.168.1.100` using the default transport protocol:
1221+
1222+
```bash
1223+
dash-cli masternode connect "192.168.1.100:19999"
1224+
```
1225+
1226+
Result:
1227+
1228+
```text
1229+
successfully connected
1230+
```
1231+
1232+
*See also: none*
1233+
11961234
### Masternode Count
11971235

11981236
The `masternode count` RPC prints the number of all known masternodes.

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

Lines changed: 58 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1401,12 +1401,6 @@ ec66f97568727a9e5188acb3ccf680086ae11217236efcccd67b0b72e83c79a043d6c6d064378fdd
14011401
47d9401e0a569a5488728e09542d0545ab56f8249a4b21e03445fa411e
14021402
```
14031403

1404-
### ProTx Register HPMN
1405-
1406-
:::{deprecated} 20.0.0
1407-
The `protx *_hpmn` RPC commands were renamed in Dash Core 20.0.0 and can now be accessed as `protx *_evo` (e.g. `protx register_hpmn` is now `protx register_evo`).
1408-
:::
1409-
14101404
### ProTx Register Fund Evo
14111405

14121406
The `protx register_fund_evo` RPC creates, funds, and sends a ProTx to the network. The resulting transaction will move 4000 Dash to the address specified by `collateralAddress` and will then function as the collateral of your evonode. A few of the limitations you see in the arguments are temporary and might be lifted after DIP3 is fully deployed. Requires the wallet passphrase to be provide with the [`walletpassphrase` RPC](../api/remote-procedure-calls-wallet.md#walletpassphrase) if the wallet is encrypted.
@@ -1536,12 +1530,6 @@ c207ebd525793ccb43f60ce34a5cd5f4011976a9145a375814e9caf5b8575a8221be246457e5c5c2
15361530
8d88ac45084a0f63d6f06767c941ffd5af4ed17ea0e28afa481e46b2bdbadbd8446c8c00\
15371531
```
15381532

1539-
### ProTx Register Fund HPMN
1540-
1541-
:::{deprecated} 20.0.0
1542-
The `protx *_hpmn` RPC commands were renamed in Dash Core 20.0.0 and can now be accessed as `protx *_evo` (e.g. `protx register_hpmn` is now `protx register_evo`).
1543-
:::
1544-
15451533
### ProTx Register Prepare Evo
15461534

15471535
The `protx register_prepare_evo` RPC creates an unsigned ProTx and a message that must be signed externally with the private key that corresponds to `collateralAddress` to prove collateral ownership. The prepared transaction will also contain inputs and outputs to cover fees.
@@ -1648,12 +1636,6 @@ Result:
16481636
}
16491637
```
16501638

1651-
### ProTx Register Prepare HPMN
1652-
1653-
:::{deprecated} 20.0.0
1654-
The `protx *_hpmn` RPC commands were renamed in Dash Core 20.0.0 and can now be accessed as `protx *_evo` (e.g. `protx register_hpmn` is now `protx register_evo`).
1655-
:::
1656-
16571639
### ProTx Update Service Evo
16581640

16591641
The `protx update_service_evo` RPC creates and sends a ProUpServTx to the network. This will update the IP address and the Platform fields of an evonode. If this is done for an evonode that was PoSe-banned, the ProUpServTx will also revive this evonode.
@@ -1728,12 +1710,6 @@ Result:
17281710
5b6cfa1bdd3c8b7e0b9550b9c4e809381f81a410bc7f241d3879dd736fd51270
17291711
```
17301712

1731-
### ProTx Update Service HPMN
1732-
1733-
:::{deprecated} 20.0.0
1734-
The `protx *_hpmn` RPC commands were renamed in Dash Core 20.0.0 and can now be accessed as `protx *_evo` (e.g. `protx register_hpmn` is now `protx register_evo`).
1735-
:::
1736-
17371713
### ProTx Register Submit
17381714

17391715
The `protx register_submit` RPC combines the unsigned ProTx and a signature of the signMessage, signs all inputs which were added to cover fees and submits the resulting transaction to the network. Note: See [`protx register_prepare`](#protx-register-prepare) for more info about creating a ProTx and a message to sign.
@@ -2949,6 +2925,64 @@ Result:
29492925
}
29502926
```
29512927

2928+
### Quorum GetData
2929+
2930+
The [`quorum getdata` RPC](#quorum-getdata) sends a [`qgetdata` message](../reference/p2p-network-quorum-messages.md#qgetdata) to a specified peer, requesting specific quorum-related data from that peer.
2931+
2932+
_Parameter #1---the internal node ID_
2933+
2934+
| Name | Type | Presence | Description |
2935+
|----------|--------|-------------------------|-------------|
2936+
| `nodeId` | number | Required<br>(exactly 1) | The internal nodeId of the peer from which quorum data is requested |
2937+
2938+
_Parameter #2---the LLMQ type_
2939+
2940+
| Name | Type | Presence | Description |
2941+
|-----------|--------|-------------------------|-------------|
2942+
| `llmqType`| number | Required<br>(exactly 1) | The LLMQ type associated with the quorum data being requested |
2943+
2944+
_Parameter #3---the quorum hash_
2945+
2946+
| Name | Type | Presence | Description |
2947+
|--------------|--------|-------------------------|-------------|
2948+
| `quorumHash` | string | Required<br>(exactly 1) | The quorum hash for the quorum data being requested |
2949+
2950+
_Parameter #4---the data mask_
2951+
2952+
| Name | Type | Presence | Description |
2953+
|-------------|--------|-------------------------|-------------|
2954+
| `dataMask` | number | Required<br>(exactly 1) | Specifies the type of data requested. Possible values are:<br>`1` - Quorum verification vector<br>`2` - Encrypted contributions for member specified by `proTxHash` (`proTxHash` must be specified if this option is used)<br>`3` - Both (1 and 2) |
2955+
2956+
_Parameter #5---the ProTxHash_
2957+
2958+
| Name | Type | Presence | Description |
2959+
|------------|--------|---------------------------|-------------|
2960+
| `proTxHash`| string | Optional<br>(default="") | The ProTxHash for the contributions requested. Must be a member of the specified LLMQ. Cannot be specified if `dataMask` is set to `1`. Required if `dataMask` is set to `2`. |
2961+
2962+
_Result---execution result_
2963+
2964+
| Name | Type | Presence | Description |
2965+
|---------------------|-----------------|-------------------------|-------------|
2966+
| `success` | bool | Required<br>(exactly 1) | Displays `true` if the data request was successful or `false` if it failed |
2967+
2968+
_Example from Dash Core 22.0.0_
2969+
2970+
Requesting the quorum verification vector from a peer with node ID `12` for a quorum of type `2`:
2971+
2972+
```bash
2973+
dash-cli quorum getdata 1 2 "000000822d2b1b311af360750b6448917f10d8b92d2ea2a7bbae221e859354f9" 1
2974+
```
2975+
2976+
Result:
2977+
2978+
```text
2979+
true
2980+
```
2981+
2982+
_See also_
2983+
2984+
* [Quorum List](#quorum-list): displays a list of on-chain quorums.
2985+
29522986
### Quorum GetRecSig
29532987

29542988
The `quorum getrecsig` RPC gets the recovered signature for a previous threshold-signing message request.

‎docs/api/remote-procedure-calls-network.md‎

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,26 @@ The [`addnode` RPC](../api/remote-procedure-calls-network.md#addnode) attempts t
1212

1313
*Parameter #1---hostname/IP address and port of node to add or remove*
1414

15-
| Name | Type | Presence | Description |
16-
| ------ | ------ | ----------------------- | ----------------------------------------------------------------- |
15+
| Name | Type | Presence | Description |
16+
| ------ | ------ | ----------------------- | ----------- |
1717
| `node` | string | Required<br>(exactly 1) | The node to add as a string in the form of `<IP address>:<port>`. |
1818

1919
*Parameter #2---whether to add or remove the node, or to try only once to connect*
2020

21-
| Name | Type | Presence | Description |
22-
| --------- | ------ | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| Name | Type | Presence | Description |
22+
| --------- | ------ | ----------------------- | ----------- |
2323
| `command` | string | Required<br>(exactly 1) | What to do with the IP address above. Options are:<br>• `add` to add a node to the addnode list. Up to 8 nodes can be added additional to the default 8 nodes. Not limited by `-maxconnections`<br>• `remove` to remove a node from the list. If currently connected, this will disconnect immediately<br>• `onetry` to immediately attempt connection to the node even if the outgoing connection slots are full; this will only attempt the connection once |
2424

25+
*Parameter #3---v2 transport*
26+
27+
| Name | Type | Presence | Description |
28+
| ------ | ------ | ----------------------- | ----------- |
29+
| `v2transport` | bool | Optional<br>(0 or1) | Attempt to connect using BIP324 v2 transport protocol (ignored for `remove` command). Default=set by `-v2transport` option. |
30+
2531
_Result---`null` plus error on failed remove_
2632

27-
| Name | Type | Presence | Description |
28-
| -------- | ---- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
33+
| Name | Type | Presence | Description |
34+
| -------- | ---- | ----------------------- | ----------- |
2935
| `result` | null | Required<br>(exactly 1) | Always JSON `null` whether the node was added, removed, tried-and-connected, or tried-and-not-connected. The JSON-RPC error field will be set only if you try adding a node that was already added or removing a node that is not on the addnodes list |
3036

3137
*Example from Dash Core 0.12.2*
@@ -564,8 +570,10 @@ The [`getpeerinfo` RPC](../api/remote-procedure-calls-network.md#getpeerinfo) re
564570
| → →<br>`bytesrecv_per_msg` | string : <br>object | Required<br>(exactly 1) | *Added in Bitcoin Core 0.13.0*<br><br>Information about total received bytes aggregated by message type |
565571
| → → →<br>Message Type | number (int) | Required<br>(1 or more) | Total received bytes aggregated by message type. One field for every used message type |
566572
| `connection_type` | string | Required<br>(exactly 1) | **Added in Dash Core 20.1.0**<br>Type of connection:<br>outbound-full-relay, block-relay-only, inbound, manual, addr-fetch, feeler.<br>Describes how the connection was established. Set to `true` if this node was added via the [`addnode` RPC](../api/remote-procedure-calls-network.md#addnode).<br>**Note: This output is subject to change in future releases as connection behaviors are refined.** |
573+
| `transport_protocol_type`| string | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>The transport protocol type:<br>`detecting` - peer could be v1 or v2<br>`v1` - plaintext transport protocol<br>`v2` - BIP324 encrypted transport protocol |
574+
| `session_id` | string | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>The session ID for this connection, or "" if there is none ("v2" transport protocol only). |
567575

568-
*Example from Dash Core 21.0.0*
576+
*Example from Dash Core 22.0.0*
569577

570578
```bash
571579
dash-cli -testnet getpeerinfo
@@ -599,20 +607,20 @@ Result (edited to show only a single entry, with IP addresses changed to
599607
"timeoffset": 0,
600608
"pingtime": 0.105995,
601609
"minping": 0.095181,
602-
"version": 70232,
603-
"subver": "/Dash Core:21.0.0(dcg-masternode-7)/",
610+
"version": 70233,
611+
"subver": "/Dash Core:21.1.0(dcg-masternode-7)/",
604612
"inbound": false,
605613
"bip152_hb_to": false,
606614
"bip152_hb_from": false,
607615
"masternode": false,
608-
"startingheight": 1022323,
609-
"synced_headers": 1022323,
610-
"synced_blocks": 1022323,
616+
"startingheight": 1131692,
617+
"synced_headers": 1131804,
618+
"synced_blocks": 1131804,
611619
"inflight": [
612620
],
613-
"relaytxes": false,
614-
"addr_relay_enabled": false,
615-
"addr_processed": 0,
621+
"relaytxes": true,
622+
"addr_relay_enabled": true,
623+
"addr_processed": 519,
616624
"addr_rate_limited": 0,
617625
"permissions": [
618626
],
@@ -651,7 +659,9 @@ Result (edited to show only a single entry, with IP addresses changed to
651659
"verack": 24,
652660
"version": 180
653661
},
654-
"connection_type": "block-relay-only"
662+
"connection_type": "outbound-full-relay",
663+
"transport_protocol_type": "v1",
664+
"session_id": ""
655665
}
656666
]
657667
```

‎docs/api/remote-procedure-calls-removed.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,45 @@ dash-cli -testnet gobject vote-conf \
6161
}
6262
}
6363
```
64+
65+
## Protx
66+
67+
### ProTx Register HPMN
68+
69+
:::{attention}
70+
Removed in Dash Core 22.0.0
71+
:::
72+
73+
The `protx *_hpmn` RPC commands were renamed and deprecated in Dash Core 20.0.0. They can now be accessed as `protx *_evo` (e.g., `protx register_hpmn` is now [`protx register_evo`](../api/remote-procedure-calls-evo.md#protx-register-evo)).
74+
75+
**All `protx *_hpmn` RPC commands were removed in Dash Core 22.0.0.**
76+
77+
### ProTx Register Fund HPMN
78+
79+
:::{attention}
80+
Removed in Dash Core 22.0.0
81+
:::
82+
83+
The `protx *_hpmn` RPC commands were renamed and deprecated in Dash Core 20.0.0. They can now be accessed as `protx *_evo` (e.g., `protx register_hpmn` is now [`protx register_evo`](../api/remote-procedure-calls-evo.md#protx-register-evo)).
84+
85+
**All `protx *_hpmn` RPC commands were removed in Dash Core 22.0.0.**
86+
87+
### ProTx Register Prepare HPMN
88+
89+
:::{attention}
90+
Removed in Dash Core 22.0.0
91+
:::
92+
93+
The `protx *_hpmn` RPC commands were renamed and deprecated in Dash Core 20.0.0. They can now be accessed as `protx *_evo` (e.g., `protx register_hpmn` is now [`protx register_evo`](../api/remote-procedure-calls-evo.md#protx-register-evo)).
94+
95+
**All `protx *_hpmn` RPC commands were removed in Dash Core 22.0.0.**
96+
97+
### ProTx Update Service HPMN
98+
99+
:::{attention}
100+
Removed in Dash Core 22.0.0
101+
:::
102+
103+
The `protx *_hpmn` RPC commands were renamed and deprecated in Dash Core 20.0.0. They can now be accessed as `protx *_evo` (e.g., `protx register_hpmn` is now [`protx register_evo`](../api/remote-procedure-calls-evo.md#protx-register-evo)).
104+
105+
**All `protx *_hpmn` RPC commands were removed in Dash Core 22.0.0.**

‎docs/api/remote-procedure-calls-wallet.md‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2781,7 +2781,13 @@ _Parameter #3---estimate_mode_
27812781
| -------------- | ------ | -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
27822782
| estimate_mode | string | Optional<br>(0 or 1) | The fee estimate mode. Must be one of: `unset`, `economical`, `conservative`, `DASH/kB`, `duff/B`. Default is `unset`. |
27832783

2784-
_Parameter #4---Options_
2784+
_Parameter #4---Fee rate_
2785+
2786+
| Name | Type | Presence | Description |
2787+
| -------- | ------- | ----------------------- | ----------- |
2788+
| fee_rate | number or string | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>Specify a fee rate in duffs/B (default=not set, fall back to wallet fee estimation). |
2789+
2790+
_Parameter #5---Options_
27852791

27862792
| Name | Type | Presence | Description |
27872793
| --------------------------- | ------------------ | ----------------------- | --------------------------------------------------- |
@@ -2901,10 +2907,16 @@ _Parameter #10---fee estimate mode_
29012907
| ---- | ---- | -------- | ----------- |
29022908
| `estimate_mode` | string | Optional<br>(0 or 1) | The fee estimate mode, must be one of:<br>`unset`<br>`economical`<br>`conservative`<br>`DASH/kB`<br>`duff/B` |
29032909

2904-
_Parameter #11---verbose_
2910+
_Parameter #11---fee rate_
2911+
2912+
| Name | Type | Presence | Description |
2913+
| -------- | ------- | ----------------------- | ----------- |
2914+
| `fee_rate` | number or string | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>Specify a fee rate in duffs/B (default=not set, fall back to wallet fee estimation). |
29052915

2906-
| Name | Type | Presence | Description |
2907-
| ------- | ------- | ----------------------- | ---------------------------------------------------------- |
2916+
_Parameter #12---verbose_
2917+
2918+
| Name | Type | Presence | Description |
2919+
| ------- | ------- | ----------------------- | ----------- |
29082920
| verbose | boolean | Optional<br>(0 or 1) | If `true`, return extra information about the transaction. Default is `false` |
29092921

29102922
_Result---execution result_
@@ -3047,10 +3059,16 @@ _Parameter #10---avoids partial respends_
30473059
| ------------- | ------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
30483060
| `avoid_reuse` | boolean | Optional<br>(0 or 1) | Avoid spending from dirty addresses; addresses are considered dirty if they have previously been used in a transaction. |
30493061

3050-
_Parameter #11---verbose_
3062+
_Parameter #11---fee rate_
3063+
3064+
| Name | Type | Presence | Description |
3065+
| -------- | ------- | ----------------------- | ----------- |
3066+
| `fee_rate` | number or string | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>Specify a fee rate in duffs/B (default=not set, fall back to wallet fee estimation). |
3067+
3068+
_Parameter #12---verbose_
30513069

3052-
| Name | Type | Presence | Description |
3053-
| ------- | ------- | ----------------------- | ---------------------------------------------------------- |
3070+
| Name | Type | Presence | Description |
3071+
| ------- | ------- | ----------------------- | ----------- |
30543072
| verbose | boolean | Optional<br>(0 or 1) | If `true`, return extra information about the transaction. Default is `false` |
30553073

30563074
_Result---execution result_

0 commit comments

Comments
 (0)