From 81285914c5db3af676b746f54d86ef2d2f30012c Mon Sep 17 00:00:00 2001 From: thephez Date: Wed, 21 Aug 2019 10:20:45 -0400 Subject: [PATCH] RPC - Add abortrescan --- _autocrossref.yaml | 2 + _config.yml | 1 + .../devdoc/dash-core/rpcs/quick-reference.md | 1 + .../devdoc/dash-core/rpcs/rpcs/abortrescan.md | 45 +++++++++++++++++++ _includes/helpers/summaries.md | 1 + _includes/layout/base/rpc-table.html | 6 +++ _includes/references.md | 1 + en/developer-reference.md | 2 + 8 files changed, 59 insertions(+) create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/abortrescan.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index 3540ca8f..ec766121 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -289,6 +289,8 @@ DIP8: ## RPCs '`abandontransaction`': rpc abandontransaction '`abandontransaction` RPC': rpc abandontransaction +'`abortrescan`': rpc abortrescan +'`abortrescan` RPC': rpc abortrescan '`addmultisigaddress`': rpc addmultisigaddress '`addmultisigaddress` RPC': rpc addmultisigaddress '`addnode`': rpc addnode diff --git a/_config.yml b/_config.yml index fae2577f..9a84b6b4 100644 --- a/_config.yml +++ b/_config.yml @@ -166,6 +166,7 @@ devsearches: ## leading capital) for easier quick scanning "RPCs": - 'AbandonTransaction': "/en/developer-reference#abandontransaction" + - 'AbortRescan': "/en/developer-reference#abortrescan" - 'AddMultiSigAddress': "/en/developer-reference#addmultisigaddress" - 'AddNode': "/en/developer-reference#addnode" - 'AddWitnessAddress': "/en/developer-reference#addwitnessaddress" diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index b331274d..7ccbfa6d 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -278,6 +278,7 @@ with [wallet support][]{:#term-wallet-support}{:.term}, which is the default. * [AbandonTransaction][rpc abandontransaction]: {{summary_abandonTransaction}} {{NEW0_12_0}} +* [AbortRescan][rpc abortrescan]: {{summary_abortrescan}} {{DASH_NEW0_14_1}} * [AddMultiSigAddress][rpc addmultisigaddress]: {{summary_addMultiSigAddress}} * [BackupWallet][rpc backupwallet]: {{summary_backupWallet}} * [DumpHDInfo][rpc dumphdinfo]: {{summary_dumpHDInfo}} {{DASH_NEW0_12_2}} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/abortrescan.md b/_includes/devdoc/dash-core/rpcs/rpcs/abortrescan.md new file mode 100644 index 00000000..409798ca --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/abortrescan.md @@ -0,0 +1,45 @@ +{% 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/abortrescan.md" %} + + +##### AbortRescan +{% include helpers/subhead-links.md %} + +{% assign summary_abortRescan="Stops current wallet rescan" %} + +{% autocrossref %} + +The `abortrescan` RPC {{summary_abortRescan}} + +Stops current wallet rescan triggered e.g. by an `importprivkey` RPC call. + +*Parameters: none* + +*Result---`true` on success* + +{% itemplate ntpd1 %} +- n: "`result`" + t: "null" + p: "Required
(exactly 1)" + d: "`true` when the command was successful or `false` if not successful." +{% enditemplate %} + +*Example from Dash Core 0.14.1* + +Abort the running wallet rescan + +{% highlight bash %} +dash-cli -testnet abortrescan +{% endhighlight %} + +Result: +{% highlight text %} +true +{% endhighlight %} + +*See also: none* + +{% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index f7e61489..f1bbb858 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -1,6 +1,7 @@ {%comment%}AUTOMATICALLY-GENERATED FILE: DO NOT EDIT THIS FILE This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_abandonTransaction="marks an in-wallet transaction and all its in-wallet descendants as abandoned. This allows their inputs to be respent." %} +{% assign summary_abortRescan="Stops current wallet rescan" %} {% assign summary_addMultiSigAddress="adds a P2SH multisig address to the wallet." %} {% assign summary_addNode="attempts to add or remove a node from the addnode list, or to try a connection to a node once." %} {% assign summary_addWitnessAddress="adds a witness address for a script (with pubkey or redeem script known)." %} diff --git a/_includes/layout/base/rpc-table.html b/_includes/layout/base/rpc-table.html index 2c920fd5..17402667 100644 --- a/_includes/layout/base/rpc-table.html +++ b/_includes/layout/base/rpc-table.html @@ -565,6 +565,12 @@ th.tg-sort-header::-moz-selection { background:transparent; }th.tg-sort-header:: Y + + Wallet + AbortRescan + Y + Added in 0.14.1 + Wallet AddMultiSigAddress diff --git a/_includes/references.md b/_includes/references.md index a8a4ea4f..35dbb3cc 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -69,6 +69,7 @@ http://opensource.org/licenses/MIT. {% comment %}{% endcomment %} [rpc abandontransaction]: /en/developer-reference#abandontransaction +[rpc abortrescan]: /en/developer-reference#abortrescan [rpc addmultisigaddress]: /en/developer-reference#addmultisigaddress [rpc addnode]: /en/developer-reference#addnode [rpc addwitnessaddress]: /en/developer-reference#addwitnessaddress diff --git a/en/developer-reference.md b/en/developer-reference.md index da7b7b9c..37311399 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -72,6 +72,8 @@ untrusted source. {% include devdoc/dash-core/rpcs/rpcs/abandontransaction.md %} +{% include devdoc/dash-core/rpcs/rpcs/abortrescan.md %} + {% include devdoc/dash-core/rpcs/rpcs/addmultisigaddress.md %} {% include devdoc/dash-core/rpcs/rpcs/addnode.md %}