RPC - masternode

- Move deprecated commands to bottom and remove sub-heading level
This commit is contained in:
thephez 2019-03-20 16:26:49 -04:00
parent dc2357c056
commit eadc4e6ce0
No known key found for this signature in database
GPG key ID: BBC8A06DBE236099

View file

@ -17,62 +17,6 @@ The `masternode` RPC {{summary_masternode}}
{% endautocrossref %}
###### Masternode<!--noref--> Check
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> check` RPC forces a check of all masternodes and removes invalid ones.
*Parameters: none*
*Result---number of removed and total masternodes*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Masternode check results"
- n: "→<br>`removedTotalCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of all masternodes that were removed"
- n: "→<br>`removedEnabledCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of enabled masternodes that were removed"
- n: "→<br>`totalCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of all masternodes"
- n: "→<br>`enabledCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of enabled masternodes"
{% enditemplate %}
*Example from Dash Core 0.13.0*
{% highlight bash %}
dash-cli -testnet masternode check
{% endhighlight %}
Result:
{% highlight bash %}
{
"removedTotalCount": 0,
"removedEnabledCount": 0,
"totalCount": 15,
"enabledCount": 15
}
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Count
<!-- no subhead-links here -->
@ -258,92 +202,6 @@ Result:
}
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Debug
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> debug` RPC prints masternode status.
{{WARNING}} `masternode<!--noref--> debug` was removed in Dash Core 0.12.2.2.
*Parameters: none*
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode debug
{% endhighlight %}
Result:
{% highlight bash %}
Masternode successfully started
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Genkey
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> genkey` RPC generates a new masternodeprivkey.
*Parameter #1---generate compressed key*
{% itemplate ntpd1 %}
- n: "Compressed"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "*Added in Dash Core 0.13.0*<br><br>If set to `true`, generates a compressed private key (default: false)"
{% enditemplate %}
*Result---masternode private key*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode private key"
{% enditemplate %}
*Example from Dash Core 0.13.0*
{% highlight bash %}
dash-cli -testnet masternode genkey
{% endhighlight %}
Result:
{% highlight bash %}
92Mn5DQpnBHjFPbS3ZXcX3EdhuET18u3eXTTtVsdDzdcAMaXqtG
{% endhighlight %}
*Example from Dash Core 0.13.0 (compressed key)*
{% highlight bash %}
dash-cli -testnet masternode genkey true
{% endhighlight %}
Result:
{% highlight bash %}
cUHWQZQQNtrnvyYS3hERYyuzttvFAdw6JkrwS6T2gTZreH3oY6NJ
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Outputs<!--noref-->
@ -385,189 +243,6 @@ Result:
{% endautocrossref %}
###### Masternode<!--noref--> Start
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> start` RPC starts a local hot masternode configure in dash.conf.
{{WARNING}} `masternode<!--noref--> start` was removed in Dash Core 0.12.2.2. Local
masternode support was removed for security reasons.
*Parameters: none*
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode start
{% endhighlight %}
Result:
{% highlight bash %}
Masternode successfully started
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Start-alias
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> start-alias` starts a single remote masternode by assigned alias configured in masternode<!--noref-->.conf.
*Parameter #1---masternode alias*
{% itemplate ntpd1 %}
- n: "Alias"
t: "string"
p: "Required<br>(exactly 1)"
d: "Alias of the masternode to start"
{% enditemplate %}
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode start-alias MN01
{% endhighlight %}
Result:
{% highlight json %}
{
"alias": "MN01",
"result": "successful"
}
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Start-mode
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> start-<mode>` RPC starts remote masternodes configured in
masternode<!--noref-->.conf. Valid modes are: `all`, `missing`, or `disabled`.
*Parameters: none*
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
- n: "→<br>`overall`"
t: "string"
p: "Required<br>(1 or more)"
d: "Reports masternode start successes/failures"
- n: "→<br>`detail`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Start details"
- n: "→ →<br>`status`"
t: "object"
p: "Required<br>(1 or more)"
d: "Name of the masternode alias"
- n: "→ → →<br>`alias`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode alias"
- n: "→ → →<br>`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Start result"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Start all masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-all
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 1 masternodes, failed to start 0, total 1",
"detail": {
"status": {
"alias": "MN01",
"result": "successful"
}
}
}
{% endhighlight %}
Start missing masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-missing
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 0 masternodes, failed to start 0, total 0",
"detail": {
}
}
{% endhighlight %}
Start disabled masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-disabled
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 1 masternodes, failed to start 0, total 1",
"detail": {
"status": {
"alias": "MN01",
"result": "successful"
}
}
}
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Status
<!-- no subhead-links here -->
@ -651,90 +326,6 @@ Result:
{% endautocrossref %}
###### Masternode<!--noref--> List-conf
<!-- no subhead-links here -->
{% autocrossref %}
The `masternode<!--noref--> list-conf` RPC prints masternode<!--noref-->.conf in JSON format.
*Parameters: none*
*Result---masternode info*
{% itemplate ntpd1 %}
- n: "Result"
t: "object"
p: "Required<br>(exactly 1)"
d: "Masternode status info"
- n: "→<br>`masternode`"
t: "object"
p: "Required<br>(1 or more)"
d: "Object containing masternode info"
- n: "→ →<br>`alias`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode alias"
- n: "→ →<br>`address`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The IP address/port of the masternode"
- n: "→ →<br>`privateKey`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode private key"
- n: "→ →<br>`txHash`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "Masternode collateral transaction hash"
- n: "→ →<br>`outputIndex`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Masternode collateral transaction index"
- n: "→ →<br>`status`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The masternode's status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode status
{% endhighlight %}
Result:
{% highlight json %}
{
"masternode": {
"alias": "MN01",
"address": "45.32.237.77:19999",
"privateKey": "92woG282ZQMASn8BAah6H8QmiE5NsPwucv7cu9eTVG1uU63fcfs",
"txHash": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f",
"outputIndex": "1",
"status": "ENABLED"
},
"masternode": {
"alias": "MN02",
"address": "45.32.237.78:19999",
"privateKey": "92woG282ZQMASn8BAah6H8QmiE5NsPwucv7cu9eTVG1uU63fcfs",
"txHash": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f",
"outputIndex": "1",
"status": "ENABLED"
}
}
{% endhighlight %}
{% endautocrossref %}
###### Masternode<!--noref--> Winner
<!-- no subhead-links here -->
@ -914,6 +505,391 @@ Result:
}
{% endhighlight %}
**Masternode<!--noref--> Check**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> check` RPC forces a check of all masternodes and removes invalid ones.
*Parameters: none*
*Result---number of removed and total masternodes*
{% itemplate ntpd1 %}
- n: "`result`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Masternode check results"
- n: "→<br>`removedTotalCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of all masternodes that were removed"
- n: "→<br>`removedEnabledCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of enabled masternodes that were removed"
- n: "→<br>`totalCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of all masternodes"
- n: "→<br>`enabledCount`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Count of enabled masternodes"
{% enditemplate %}
*Example from Dash Core 0.13.0*
{% highlight bash %}
dash-cli -testnet masternode check
{% endhighlight %}
Result:
{% highlight bash %}
{
"removedTotalCount": 0,
"removedEnabledCount": 0,
"totalCount": 15,
"enabledCount": 15
}
{% endhighlight %}
{% endautocrossref %}
** Masternode<!--noref--> Genkey**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> genkey` RPC generates a new masternodeprivkey.
*Parameter #1---generate compressed key*
{% itemplate ntpd1 %}
- n: "Compressed"
t: "bool"
p: "Optional<br>(0 or 1)"
d: "*Added in Dash Core 0.13.0*<br><br>If set to `true`, generates a compressed private key (default: false)"
{% enditemplate %}
*Result---masternode private key*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode private key"
{% enditemplate %}
*Example from Dash Core 0.13.0*
{% highlight bash %}
dash-cli -testnet masternode genkey
{% endhighlight %}
Result:
{% highlight bash %}
92Mn5DQpnBHjFPbS3ZXcX3EdhuET18u3eXTTtVsdDzdcAMaXqtG
{% endhighlight %}
*Example from Dash Core 0.13.0 (compressed key)*
{% highlight bash %}
dash-cli -testnet masternode genkey true
{% endhighlight %}
Result:
{% highlight bash %}
cUHWQZQQNtrnvyYS3hERYyuzttvFAdw6JkrwS6T2gTZreH3oY6NJ
{% endhighlight %}
{% endautocrossref %}
**###### Masternode<!--noref--> Start**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> start` RPC starts a local hot masternode configure in dash.conf.
{{WARNING}} `masternode<!--noref--> start` was removed in Dash Core 0.12.2.2. Local
masternode support was removed for security reasons.
*Parameters: none*
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode start
{% endhighlight %}
Result:
{% highlight bash %}
Masternode successfully started
{% endhighlight %}
{% endautocrossref %}
** Masternode<!--noref--> Start-alias**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> start-alias` starts a single remote masternode by assigned alias configured in masternode<!--noref-->.conf.
*Parameter #1---masternode alias*
{% itemplate ntpd1 %}
- n: "Alias"
t: "string"
p: "Required<br>(exactly 1)"
d: "Alias of the masternode to start"
{% enditemplate %}
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode start-alias MN01
{% endhighlight %}
Result:
{% highlight json %}
{
"alias": "MN01",
"result": "successful"
}
{% endhighlight %}
{% endautocrossref %}
** Masternode<!--noref--> Start-mode**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> start-<mode>` RPC starts remote masternodes configured in
masternode<!--noref-->.conf. Valid modes are: `all`, `missing`, or `disabled`.
*Parameters: none*
*Result---masternode status*
{% itemplate ntpd1 %}
- n: "Result"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode status"
- n: "→<br>`overall`"
t: "string"
p: "Required<br>(1 or more)"
d: "Reports masternode start successes/failures"
- n: "→<br>`detail`"
t: "object"
p: "Required<br>(exactly 1)"
d: "Start details"
- n: "→ →<br>`status`"
t: "object"
p: "Required<br>(1 or more)"
d: "Name of the masternode alias"
- n: "→ → →<br>`alias`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode alias"
- n: "→ → →<br>`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Start result"
{% enditemplate %}
*Example from Dash Core 0.12.2*
Start all masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-all
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 1 masternodes, failed to start 0, total 1",
"detail": {
"status": {
"alias": "MN01",
"result": "successful"
}
}
}
{% endhighlight %}
Start missing masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-missing
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 0 masternodes, failed to start 0, total 0",
"detail": {
}
}
{% endhighlight %}
Start disabled masternodes in masternodes<!--noref-->.conf
{% highlight bash %}
dash-cli -testnet masternode start-disabled
{% endhighlight %}
Result:
{% highlight json %}
{
"overall": "Successfully started 1 masternodes, failed to start 0, total 1",
"detail": {
"status": {
"alias": "MN01",
"result": "successful"
}
}
}
{% endhighlight %}
{% endautocrossref %}
** Masternode<!--noref--> List-conf**
![Warning icon](/img/icons/icon_warning.svg) Deprecated since 0.14.0
{% autocrossref %}
The `masternode<!--noref--> list-conf` RPC prints masternode<!--noref-->.conf in JSON format.
*Parameters: none*
*Result---masternode info*
{% itemplate ntpd1 %}
- n: "Result"
t: "object"
p: "Required<br>(exactly 1)"
d: "Masternode status info"
- n: "→<br>`masternode`"
t: "object"
p: "Required<br>(1 or more)"
d: "Object containing masternode info"
- n: "→ →<br>`alias`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode alias"
- n: "→ →<br>`address`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The IP address/port of the masternode"
- n: "→ →<br>`privateKey`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Masternode private key"
- n: "→ →<br>`txHash`"
t: "string (hex)"
p: "Required<br>(exactly 1)"
d: "Masternode collateral transaction hash"
- n: "→ →<br>`outputIndex`"
t: "int"
p: "Required<br>(exactly 1)"
d: "Masternode collateral transaction index"
- n: "→ →<br>`status`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The masternode's status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet masternode status
{% endhighlight %}
Result:
{% highlight json %}
{
"masternode": {
"alias": "MN01",
"address": "45.32.237.77:19999",
"privateKey": "92woG282ZQMASn8BAah6H8QmiE5NsPwucv7cu9eTVG1uU63fcfs",
"txHash": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f",
"outputIndex": "1",
"status": "ENABLED"
},
"masternode": {
"alias": "MN02",
"address": "45.32.237.78:19999",
"privateKey": "92woG282ZQMASn8BAah6H8QmiE5NsPwucv7cu9eTVG1uU63fcfs",
"txHash": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f",
"outputIndex": "1",
"status": "ENABLED"
}
}
{% endhighlight %}
{% endautocrossref %}
*See also:*
* [MasternodeList][rpc masternodelist]: {{summary_masternodeList}}