From af714fc4456ed5507a27189203af2ed40ad6c31e Mon Sep 17 00:00:00 2001 From: thephez Date: Tue, 23 Oct 2018 13:13:11 -0400 Subject: [PATCH] Content - RPC - Add PS amount and round - Related to dashpay/dash#2230 --- _autocrossref.yaml | 4 ++ _config.yml | 2 + .../devdoc/dash-core/rpcs/quick-reference.md | 2 + .../rpcs/rpcs/setprivatesendamount.md | 42 +++++++++++++++++++ .../rpcs/rpcs/setprivatesendrounds.md | 42 +++++++++++++++++++ _includes/helpers/summaries.md | 2 + _includes/layout/base/rpc-table.html | 12 ++++++ _includes/references.md | 2 + en/developer-reference.md | 4 ++ 9 files changed, 112 insertions(+) create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/setprivatesendamount.md create mode 100644 _includes/devdoc/dash-core/rpcs/rpcs/setprivatesendrounds.md diff --git a/_autocrossref.yaml b/_autocrossref.yaml index ac1ba50c..9ad61b3c 100644 --- a/_autocrossref.yaml +++ b/_autocrossref.yaml @@ -491,6 +491,10 @@ DIP1: '`setgenerate` RPC': rpc setgenerate '`setnetworkactive`': rpc setnetworkactive '`setnetworkactive` RPC': rpc setnetworkactive +'`setprivatesendamount`': rpc setprivatesendamount +'`setprivatesendamount` RPC': rpc setprivatesendamount +'`setprivatesendrounds`': rpc setprivatesendrounds +'`setprivatesendrounds` RPC': rpc setprivatesendrounds '`settxfee`': rpc settxfee '`settxfee` RPC': rpc settxfee '`signmessage`': rpc signmessage diff --git a/_config.yml b/_config.yml index e7d13310..5bc0b793 100644 --- a/_config.yml +++ b/_config.yml @@ -301,6 +301,8 @@ devsearches: - 'SetBIP69Enabled': "/en/developer-reference#setbip69enabled" - 'SetGenerate': "/en/developer-reference#setgenerate" - 'SetNetworkActive': "/en/developer-reference#setnetworkactive" + - 'SetPrivateSendAmount': "/en/developer-reference#setprivatesendamount" + - 'SetPrivateSendRounds': "/en/developer-reference#setprivatesendrounds" - 'SetTxFee': "/en/developer-reference#settxfee" - 'SignMessage': "/en/developer-reference#signmessage" - 'SignMessageWithPrivKey': "/en/developer-reference#signmessagewithprivkey" diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index 8275d351..bbb309dd 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -291,6 +291,8 @@ default. * [SendMany][rpc sendmany]: {{summary_sendMany}} * [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}} * [SetAccount][rpc setaccount]: {{summary_setAccount}} {{DEPRECATED}} +* [SetPrivateSendAmount][rpc setprivatesendamount]: {{summary_setPrivateSendAmount}} +* [SetPrivateSendRounds][rpc setprivatesendrounds]: {{summary_setPrivateSendRounds}} * [SetTxFee][rpc settxfee]: {{summary_setTxFee}} * [SignMessage][rpc signmessage]: {{summary_signMessage}} * [WalletLock][rpc walletlock]: {{summary_walletLock}} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendamount.md b/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendamount.md new file mode 100644 index 00000000..b5280eca --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendamount.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/setprivatesendamount.md" %} + +##### SetPrivateSendAmount +{% include helpers/subhead-links.md %} + +{% assign summary_setPrivateSendAmount="sets the amount of DASH to be mixed with PrivateSend" %} + + + +{% autocrossref %} + +The `setprivatesendamount` RPC {{summary_setPrivateSendAmount}} + +*Parameter #1---amount to mix* + +{% itemplate ntpd1 %} +- n: "Amount" + t: "int" + p: "Required
(exactly 1)" + d: "The number of DASH to mix (minimum: 2, maximum: 21,000,000)" + +{% enditemplate %} + +*Result---`null` on success* + +*Example from Dash Core 0.12.4* + +{% highlight bash %} +dash-cli -testnet setprivatesendamount 2000 +{% endhighlight %} + +(Success: no result displayed.) + +*See also:* + +* [SetPrivateSendRounds][rpc setprivatesendrounds]: {{summary_setPrivateSendRounds}} + +{% endautocrossref %} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendrounds.md b/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendrounds.md new file mode 100644 index 00000000..f40852ad --- /dev/null +++ b/_includes/devdoc/dash-core/rpcs/rpcs/setprivatesendrounds.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/setprivatesendrounds.md" %} + +##### SetPrivateSendRounds +{% include helpers/subhead-links.md %} + +{% assign summary_setPrivateSendRounds="sets the number of PrivateSend mixing rounds to use" %} + + + +{% autocrossref %} + +The `setprivatesendrounds` RPC {{summary_setPrivateSendRounds}} + +*Parameter #1---number of mixing rounds to use* + +{% itemplate ntpd1 %} +- n: "Rounds" + t: "int" + p: "Required
(exactly 1)" + d: "The number of mixing rounds to use (minimum: 1, maximum: 16)" + +{% enditemplate %} + +*Result---`null` on success* + +*Example from Dash Core 0.12.4* + +{% highlight bash %} +dash-cli -testnet setprivatesendrounds 4 +{% endhighlight %} + +(Success: no result displayed.) + +*See also:* + +* [SetPrivateSendAmount][rpc setprivatesendamount]: {{summary_setPrivateSendAmount}} + +{% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index 67a59ce0..a26c2867 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -128,6 +128,8 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_setBan="attempts add or remove a IP/Subnet from the banned list." %} {% assign summary_setGenerate="was removed in Dash Core 0.12.3." %} {% assign summary_setNetworkActive="disables/enables all P2P network activity." %} +{% assign summary_setPrivateSendAmount="sets the amount of DASH to be mixed with PrivateSend" %} +{% assign summary_setPrivateSendRounds="sets the number of PrivateSend mixing rounds to use" %} {% assign summary_setTxFee="sets the transaction fee per kilobyte paid by transactions created by this wallet." %} {% assign summary_signMessage="signs a message with the private key of an address." %} {% assign summary_signMessageWithPrivKey="signs a message with a given private key." %} diff --git a/_includes/layout/base/rpc-table.html b/_includes/layout/base/rpc-table.html index 31259e49..9711f8e7 100644 --- a/_includes/layout/base/rpc-table.html +++ b/_includes/layout/base/rpc-table.html @@ -805,6 +805,18 @@ th.tg-sort-header::-moz-selection { background:transparent; }th.tg-sort-header:: Y + + Wallet + SetPrivateSendAmount + Y + Added in 0.12.4.0 + + + Wallet + SetPrivateSendRounds + Y + Added in 0.12.4.0 + Wallet SetTxFee diff --git a/_includes/references.md b/_includes/references.md index ddceabdd..f3204433 100644 --- a/_includes/references.md +++ b/_includes/references.md @@ -179,6 +179,8 @@ http://opensource.org/licenses/MIT. [rpc setbip69enabled]: /en/developer-reference#setbip69enabled [rpc setgenerate]: /en/developer-reference#setgenerate [rpc setnetworkactive]: /en/developer-reference#setnetworkactive +[rpc setprivatesendamount]: /en/developer-reference#setprivatesendamount +[rpc setprivatesendrounds]: /en/developer-reference#setprivatesendrounds [rpc settxfee]: /en/developer-reference#settxfee [rpc signmessage]: /en/developer-reference#signmessage [rpc signmessagewithprivkey]: /en/developer-reference#signmessagewithprivkey diff --git a/en/developer-reference.md b/en/developer-reference.md index 98d47096..a52124f3 100644 --- a/en/developer-reference.md +++ b/en/developer-reference.md @@ -308,6 +308,10 @@ untrusted source. {% include devdoc/dash-core/rpcs/rpcs/setnetworkactive.md %} +{% include devdoc/dash-core/rpcs/rpcs/setprivatesendamount.md %} + +{% include devdoc/dash-core/rpcs/rpcs/setprivatesendrounds.md %} + {% include devdoc/dash-core/rpcs/rpcs/settxfee.md %} {% include devdoc/dash-core/rpcs/rpcs/signmessage.md %}