From 0e6f88e5c44d3ae8f1a7c317ac9595ae3355ff19 Mon Sep 17 00:00:00 2001 From: thephez Date: Wed, 21 Aug 2019 13:11:30 -0400 Subject: [PATCH] RPC - Add new uptime RPC --- _autocrossref.yaml | 2 + _config.yml | 1 + .../devdoc/dash-core/rpcs/quick-reference.md | 1 + .../devdoc/dash-core/rpcs/rpcs/uptime.md | 42 +++++++++++++++++++ _includes/helpers/summaries.md | 1 + _includes/references.md | 1 + en/developer-reference.md | 2 + 7 files changed, 50 insertions(+) create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/uptime.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index ec766121..f5883896 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -560,6 +560,8 @@ DIP8: '`submitblock` RPC': rpc submitblock '`validateaddress`': rpc validateaddress '`validateaddress` RPC': rpc validateaddress +'`uptime`': rpc uptime +'`uptime` RPC': rpc uptime '`verifychain`': rpc verifychain '`verifychain` RPC': rpc verifychain '`verifymessage`': rpc verifymessage diff --git a/_config.yml b/_config.yml index 9a84b6b4..4b47e476 100644 --- a/_config.yml +++ b/_config.yml @@ -299,6 +299,7 @@ devsearches: - 'Spork': "/en/developer-reference#spork-rpc" - 'Stop': "/en/developer-reference#stop" - 'SubmitBlock': "/en/developer-reference#submitblock" + - 'Uptime': "/en/developer-reference#uptime" - 'ValidateAddress': "/en/developer-reference#validateaddress" - 'VerifyChain': "/en/developer-reference#verifychain" - 'VerifyMessage': "/en/developer-reference#verifymessage" diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index 45bd431e..df685b3e 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -155,6 +155,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core * [GetMemoryInfo][rpc getmemoryinfo]: {{summary_getMemoryInfo}} {{DASH_UPDATED0_14_1}} {{NEW_14_0}} * [Help][rpc help]: {{summary_help}} * [Stop][rpc stop]: {{summary_stop}} +* [Uptime][rpc uptime]: {{summary_uptime}} {% endautocrossref %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/uptime.md b/_includes/devdoc/dash-core/rpcs/rpcs/uptime.md new file mode 100644 index 00000000..645ee209 --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/uptime.md @@ -0,0 +1,42 @@ +{% 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/uptime.md" %} + + +##### Uptime +{% include helpers/subhead-links.md %} + +{% assign summary_uptime="returns the total uptime of the server." %} + +{% autocrossref %} + +The `uptime` RPC {{summary_uptime}} + +*Parameters: none* + +*Result* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The number of seconds that the server has been running" + +{% enditemplate %} + +*Example from Dash Core 0.14.1* + +{% highlight bash %} +dash-cli -testnet uptime +{% endhighlight %} + +Result: +{% highlight text %} +5500 +{% endhighlight %} + +*See also: none* + +{% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index f1bbb858..72cf5d20 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -142,6 +142,7 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_spork-rpc="reads or updates spork settings on the network." %} {% assign summary_stop="safely shuts down the Dash Core server." %} {% assign summary_submitBlock="accepts a block, verifies it is a valid addition to the block chain, and broadcasts it to the network. Extra parameters are ignored by Dash Core but may be used by mining pools or other programs." %} +{% assign summary_uptime="returns the total uptime of the server." %} {% assign summary_validateAddress="returns information about the given Dash address." %} {% assign summary_verifyChain="verifies each entry in the local block chain database." %} {% assign summary_verifyMessage="verifies a signed message." %} diff --git a/_includes/references.md b/_includes/references.md index 35dbb3cc..a024ec44 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -202,6 +202,7 @@ http://opensource.org/licenses/MIT. [rpc spork]: /en/developer-reference#spork-rpc [rpc stop]: /en/developer-reference#stop [rpc submitblock]: /en/developer-reference#submitblock +[rpc uptime]: /en/developer-reference#uptime [rpc validateaddress]: /en/developer-reference#validateaddress [rpc verifychain]: /en/developer-reference#verifychain [rpc verifymessage]: /en/developer-reference#verifymessage diff --git a/en/developer-reference.md b/en/developer-reference.md index 37311399..36221f77 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -338,6 +338,8 @@ untrusted source. {% include devdoc/dash-core/rpcs/rpcs/submitblock.md %} +{% include devdoc/dash-core/rpcs/rpcs/uptime.md %} + {% include devdoc/dash-core/rpcs/rpcs/validateaddress.md %} {% include devdoc/dash-core/rpcs/rpcs/verifychain.md %}