Add details for PrivateSend RPC (Dash section)

This commit is contained in:
thephez 2017-10-11 09:44:35 -04:00
parent 09ff5b0ced
commit 0c33d487a6
2 changed files with 76 additions and 6 deletions

View file

@ -4,7 +4,7 @@ http://opensource.org/licenses/MIT.
{% endcomment %} {% endcomment %}
{% assign filename="_includes/devdoc/dash-core/api-intro.md" %} {% assign filename="_includes/devdoc/dash-core/api-intro.md" %}
## Bitcoin Core APIs ## Dash Core APIs
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
### Hash Byte Order ### Hash Byte Order

View file

@ -7,21 +7,91 @@ http://opensource.org/licenses/MIT.
##### PrivateSend ##### PrivateSend
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_privateSend="" %} {% assign summary_privateSend="controls the mixing process." %}
{% autocrossref %} {% autocrossref %}
The `privatesend` RPC {{summary_privateSend}} The `privatesend` RPC {{summary_privateSend}}
{% itemplate ntpd1 %}
- n: "`mode`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The command mode to use:<br>`start` - Start mixing<br>`stop` - Stop mixing<br>`reset` - Reset mixing"
{% enditemplate %}
**Command Mode - `start`**
*Result---start command return status*
{% itemplate ntpd1 %}
- n: "`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Command return status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %} {% highlight bash %}
dash-cli -testnet privatesend dash-cli -testnet privatesend start
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight json %} {% highlight text %}
*INSERT RESULTS HERE* Mixing started successfully
{% endhighlight %} {% endhighlight %}
*See also:*
**Command Mode - `stop`**
*Result---stop command return status*
{% itemplate ntpd1 %}
- n: "`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Command return status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet privatesend stop
{% endhighlight %}
Result:
{% highlight text %}
Mixing was stopped
{% endhighlight %}
**Command Mode - `reset`**
*Result---reset command return status*
{% itemplate ntpd1 %}
- n: "`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "Command return status"
{% enditemplate %}
*Example from Dash Core 0.12.2*
{% highlight bash %}
dash-cli -testnet privatesend reset
{% endhighlight %}
Result:
{% highlight text %}
Mixing was reset
{% endhighlight %}
*See also: none*
{% endautocrossref %} {% endautocrossref %}