Wallet RPCs

- Add details for DumpHDInfo and InstantSendToAddress (new)
 - Minor updates
This commit is contained in:
thephez 2017-12-04 13:14:12 -05:00
parent a71277cdee
commit 28e8294592
4 changed files with 112 additions and 14 deletions

View file

@ -7,15 +7,41 @@ http://opensource.org/licenses/MIT.
##### DumpHDInfo ##### DumpHDInfo
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_dumpHDInfo="" %} {% assign summary_dumpHDInfo="returns an object containing sensitive private info about this HD wallet" %}
<!-- __ -->
{% autocrossref %} {% autocrossref %}
The `dumphdinfo` RPC {{summary_dumpHDInfo}} The `dumphdinfo` RPC {{summary_dumpHDInfo}}
*Parameter #1---PARAMETER DESCRIPTION* *Parameters: none*
*Result---HD wallet information*
{% itemplate ntpd1 %}
- n: "Result"
t: "object"
p: "Required<br>(exactly 1)"
d: "An object containing sensitive private info about this HD wallet."
- n: "→ <br>`hdseed`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The BIP-32 HD seed (in hex)"
- n: "→ <br>`mnemonic`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The BIP-39 mnemonic for this HD wallet (English words)"
- n: "→ <br>`mnemonicpassphrase`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The BIP-39 mnemonic passphrase for this HD wallet (may be empty)"
{% enditemplate %}
*Result---RESULT DESCRIPTION*
*Example from Dash Core 0.12.2* *Example from Dash Core 0.12.2*
@ -23,11 +49,15 @@ The `dumphdinfo` RPC {{summary_dumpHDInfo}}
dash-cli -testnet dumphdinfo dash-cli -testnet dumphdinfo
{% endhighlight %} {% endhighlight %}
Result: Result (truncated for security reasons):
{% highlight json %} {% highlight json %}
*INSERT RESULTS HERE* {
"hdseed": "20c63c3fb298ebd52de3 ...",
"mnemonic": "cost circle shiver ...",
"mnemonicpassphrase": ""
}
{% endhighlight %} {% endhighlight %}
*See also:* *See also: none*
{% endautocrossref %} {% endautocrossref %}

View file

@ -76,7 +76,7 @@ dash-cli -testnet importprivkey \
* [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}} * [DumpPrivKey][rpc dumpprivkey]: {{summary_dumpPrivKey}}
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} * [ImportAddress][rpc importaddress]: {{summary_importAddress}}
* [ImportPrivKey][rpc importpubkey]: {{summary_importPubKey}} * [ImportPubKey][rpc importpubkey]: {{summary_importPubKey}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}} * [ImportWallet][rpc importwallet]: {{summary_importWallet}}
{% endautocrossref %} {% endautocrossref %}

View file

@ -7,27 +7,95 @@ http://opensource.org/licenses/MIT.
##### InstantSendToAddress ##### InstantSendToAddress
{% include helpers/subhead-links.md %} {% include helpers/subhead-links.md %}
{% assign summary_instantSendToAddress="" %} {% assign summary_instantSendToAddress="InstantSend an amount to a given address." %}
<!-- __ -->
{% autocrossref %} {% autocrossref %}
The `instantsendtoaddress` RPC {{summary_instantSendToAddress}} The `instantsendtoaddress` RPC {{summary_instantSendToAddress}}
*Parameter #1---PARAMETER DESCRIPTION* *Parameter #1---to address*
*Result---RESULT DESCRIPTION* {% itemplate ntpd1 %}
- n: "To Address"
t: "string"
p: "Required<br>(exactly 1)"
d: "A P2PKH or P2SH address to which the dash should be sent"
{% enditemplate %}
*Parameter #2---amount to spend*
{% itemplate ntpd1 %}
- n: "Amount"
t: "number (dash)"
p: "Required<br>(exactly 1)"
d: "The amount to spent in dash"
{% enditemplate %}
*Parameter #3---a comment*
{% itemplate ntpd1 %}
- n: "Comment"
t: "string"
p: "Optional<br>(0 or 1)"
d: "A locally-stored (not broadcast) comment assigned to this transaction. Default is no comment"
{% enditemplate %}
*Parameter #4---a comment about who the payment was sent to*
{% itemplate ntpd1 %}
- n: "Comment To"
t: "string"
p: "Optional<br>(0 or 1)"
d: "A locally-stored (not broadcast) comment assigned to this transaction. Meant to be used for describing who the payment was sent to. Default is no comment"
{% enditemplate %}
*Parameter #5---automatic fee subtraction*
{% itemplate ntpd1 %}
- n: "Subtract Fee From Amount"
t: "boolean"
p: "Optional<br>(0 or 1)"
d: "The fee will be deducted from the amount being sent. The recipient will receive less dash than you enter in the amount field. Default is `false`"
{% enditemplate %}
*Result---a TXID of the sent transaction*
{% itemplate ntpd1 %}
- n: "`result`"
t: "string"
p: "Required<br>(exactly 1)"
d: "The TXID of the sent transaction, encoded as hex in RPC byte order"
{% enditemplate %}
*Example from Dash Core 0.12.2* *Example from Dash Core 0.12.2*
InstantSend 0.1 dash to the address below with the comment "instantsendtoadress
example" and the comment-to "Nemo From Example.com":
{% highlight bash %} {% highlight bash %}
dash-cli -testnet instantsendtoaddress dash-cli -testnet instantsendtoaddress ySutkc49Khpz1HQN8AfWNitVBLwqtyaxvv \
1.0 "instantsendtoadress example" "Nemo From Example.com"
{% endhighlight %} {% endhighlight %}
Result: Result:
{% highlight json %}
*INSERT RESULTS HERE* {% highlight text %}
70e2029d363f0110fe8a0aa2ba7bd771a579453135568b2aa559b2cb30f875aa
{% endhighlight %} {% endhighlight %}
*See also:* *See also:*
* [SendFrom][rpc sendfrom]: {{summary_sendFrom}}
* [SendMany][rpc sendmany]: {{summary_sendMany}}
* [SendToAddress][rpc sendtoaddress]: {{summary_sendToAddress}}
* [Move][rpc move]: {{summary_move}}
{% endautocrossref %} {% endautocrossref %}

View file

@ -164,9 +164,9 @@ ba4bbe29fa06b67d6f3f3a73e381627e66abe22e217ce329aefad41ea72c3922
*See also* *See also*
* [InstantSendToAddress][rpc instantsendtoaddress]: {{summary_instantSendToAddress}}
* [SendFrom][rpc sendfrom]: {{summary_sendFrom}} * [SendFrom][rpc sendfrom]: {{summary_sendFrom}}
* [SendMany][rpc sendmany]: {{summary_sendMany}} * [SendMany][rpc sendmany]: {{summary_sendMany}}
* [Move][rpc move]: {{summary_move}} * [Move][rpc move]: {{summary_move}}
{% endautocrossref %} {% endautocrossref %}