Wallet RPC updates

- Comment out detail of non-implemented wallet RPCs
This commit is contained in:
thephez 2017-11-29 17:35:17 -05:00
parent 8c175dfdff
commit 022808165c
7 changed files with 50 additions and 15 deletions

View file

@ -9,10 +9,15 @@ http://opensource.org/licenses/MIT.
{% assign summary_addWitnessAddress="adds a witness address for a script (with pubkey or redeem script known)." %} {% assign summary_addWitnessAddress="adds a witness address for a script (with pubkey or redeem script known)." %}
<!-- __ -->
{% autocrossref %} {% autocrossref %}
*Added in Bitcoin Core 0.13.0* *Added in Bitcoin Core 0.13.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
*Requires wallet support. Requires an unlocked wallet or an unencrypted wallet.* *Requires wallet support. Requires an unlocked wallet or an unencrypted wallet.*
The `addwitnessaddress` RPC {{summary_addWitnessAddress}} The `addwitnessaddress` RPC {{summary_addWitnessAddress}}
@ -57,4 +62,6 @@ The RPC is disabled by default on mainnet as long as Segregated Witness has not
* [BIP-141 - Segregated Witness](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki) * [BIP-141 - Segregated Witness](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki)
* [BIP-142 - Address Format for Segregated Witness](https://github.com/bitcoin/bips/blob/master/bip-0142.mediawiki) * [BIP-142 - Address Format for Segregated Witness](https://github.com/bitcoin/bips/blob/master/bip-0142.mediawiki)
{% endcomment %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -9,13 +9,18 @@ http://opensource.org/licenses/MIT.
{% assign summary_bumpFee="replaces an unconfirmed wallet transaction that signaled RBF with a new transaction that pays a higher fee." %} {% assign summary_bumpFee="replaces an unconfirmed wallet transaction that signaled RBF with a new transaction that pays a higher fee." %}
<!-- __ -->
{% autocrossref %} {% autocrossref %}
*Added in Bitcoin Core 0.14.0* *Added in Bitcoin Core 0.14.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
*Requires wallet support. Wallet must be unlocked.* *Requires wallet support. Wallet must be unlocked.*
The `bumpfee` RPC {{summary_bumpFee}} The increased fee is deducted from the change output. The command fails if the change output is too small to increase the fee or The `bumpfee` RPC {{summary_bumpFee}} The increased fee is deducted from the change output. The command fails if the change output is too small to increase the fee or
if the wallet or mempool contains a transaction that spends one of the transaction's outputs. The `-walletrbf` option needs to be enabled (default is `false`). if the wallet or mempool contains a transaction that spends one of the transaction's outputs. The `-walletrbf` option needs to be enabled (default is `false`).
*Parameter #1---The TXID of the transaction* *Parameter #1---The TXID of the transaction*
@ -40,7 +45,7 @@ if the wallet or mempool contains a transaction that spends one of the transacti
t: "numeric (int)" t: "numeric (int)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The confirmation target in blocks. Based on this value the new fee will be calculated using the same code as the `estimatefee` RPC. If not set, the default target of ´6´ blocks will be used" d: "The confirmation target in blocks. Based on this value the new fee will be calculated using the same code as the `estimatefee` RPC. If not set, the default target of ´6´ blocks will be used"
- n: "→ <br>`totalFee`" - n: "→ <br>`totalFee`"
t: "numeric (satoshis)" t: "numeric (satoshis)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
@ -50,7 +55,7 @@ if the wallet or mempool contains a transaction that spends one of the transacti
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Whether the new transaction should still be BIP 125 replaceable. Even if set to `false` the transaction may still be replacable, for example if it has unconfirmed ancestors which are replaceable. The default is `true`" d: "Whether the new transaction should still be BIP 125 replaceable. Even if set to `false` the transaction may still be replacable, for example if it has unconfirmed ancestors which are replaceable. The default is `true`"
{% enditemplate %} {% enditemplate %}
*Result---information about the new transaction* *Result---information about the new transaction*
@ -75,7 +80,7 @@ if the wallet or mempool contains a transaction that spends one of the transacti
t: "numeric (bitcoins)" t: "numeric (bitcoins)"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "The fee of the new transaction" d: "The fee of the new transaction"
- n: "→ <br>`errors`" - n: "→ <br>`errors`"
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
@ -113,4 +118,6 @@ Result:
* [SendRawTransaction][rpc sendrawtransaction]: {{summary_sendRawTransaction}} * [SendRawTransaction][rpc sendrawtransaction]: {{summary_sendRawTransaction}}
* [Serialized Transaction Format][raw transaction format] * [Serialized Transaction Format][raw transaction format]
{% endcomment %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -13,6 +13,9 @@ http://opensource.org/licenses/MIT.
*Added in Bitcoin Core 0.14.0* *Added in Bitcoin Core 0.14.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
*Requires wallet support. Wallet must be unlocked.* *Requires wallet support. Wallet must be unlocked.*
The `importmulti` RPC {{summary_importMulti}} The `importmulti` RPC {{summary_importMulti}}
@ -49,7 +52,7 @@ The `importmulti` RPC {{summary_importMulti}}
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "A redeem script. Only allowed if either the `address` field is a P2SH address or the `scriptPubKey` field is a P2SH scriptPubKey" d: "A redeem script. Only allowed if either the `address` field is a P2SH address or the `scriptPubKey` field is a P2SH scriptPubKey"
- n: "→ →<br>`pubkeys`" - n: "→ →<br>`pubkeys`"
t: "array" t: "array"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
@ -59,7 +62,7 @@ The `importmulti` RPC {{summary_importMulti}}
t: "array" t: "array"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "Array of strings giving private keys whose corresponding public keys must occur in the scriptPubKey or redeemscript" d: "Array of strings giving private keys whose corresponding public keys must occur in the scriptPubKey or redeemscript"
- n: "→ →<br>`internal`" - n: "→ →<br>`internal`"
t: "bool" t: "bool"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
@ -99,27 +102,27 @@ The `importmulti` RPC {{summary_importMulti}}
t: "array" t: "array"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "An array of JSON objects, with each object describing the execution result of each import" d: "An array of JSON objects, with each object describing the execution result of each import"
- n: "→ Result" - n: "→ Result"
t: "object" t: "object"
p: "Required<br>(1 or more)" p: "Required<br>(1 or more)"
d: "A JSON object describing the execution result of an imported address or script" d: "A JSON object describing the execution result of an imported address or script"
- n: "→ → <br>`success`" - n: "→ → <br>`success`"
t: "string" t: "string"
p: "Required<br>(exactly 1)" p: "Required<br>(exactly 1)"
d: "Displays `true` if the import has been successful or `false` if it failed" d: "Displays `true` if the import has been successful or `false` if it failed"
- n: "→ → <br>`error`" - n: "→ → <br>`error`"
t: "string : object" t: "string : object"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "A JSON object containing details about the error. Only displayed if the import fails" d: "A JSON object containing details about the error. Only displayed if the import fails"
- n: "→ → → <br>`code`" - n: "→ → → <br>`code`"
t: "number (int)" t: "number (int)"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
d: "The error code" d: "The error code"
- n: "→ → → <br>`message`" - n: "→ → → <br>`message`"
t: "string" t: "string"
p: "Optional<br>(0 or 1)" p: "Optional<br>(0 or 1)"
@ -153,7 +156,7 @@ Result (scriptPubKey import failed because `internal` was not set to `true`):
[ [
{ {
"success": true "success": true
}, },
{ {
"success": false, "success": false,
"error": { "error": {
@ -170,4 +173,6 @@ Result (scriptPubKey import failed because `internal` was not set to `true`):
* [ImportAddress][rpc importaddress]: {{summary_importAddress}} * [ImportAddress][rpc importaddress]: {{summary_importAddress}}
* [ImportWallet][rpc importwallet]: {{summary_importWallet}} * [ImportWallet][rpc importwallet]: {{summary_importWallet}}
{% endcomment %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -13,10 +13,13 @@ http://opensource.org/licenses/MIT.
*Added in Bitcoin Core 0.13.0* *Added in Bitcoin Core 0.13.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
*Requires wallet support.* *Requires wallet support.*
The `importprunedfunds` RPC {{summary_importPrunedFunds}} Corresponding address or script must previously be included in wallet. The `importprunedfunds` RPC {{summary_importPrunedFunds}} Corresponding address or script must previously be included in wallet.
The end-user is responsible to import additional transactions that subsequently spend the imported The end-user is responsible to import additional transactions that subsequently spend the imported
outputs or rescan after the point in the blockchain the transaction is included. outputs or rescan after the point in the blockchain the transaction is included.
*Parameter #1---the raw transaction to import* *Parameter #1---the raw transaction to import*
@ -62,4 +65,6 @@ bitcoin-cli importprunedfunds "txhex" "txoutproof"
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}} * [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}} * [RemovePrunedFunds][rpc removeprunedfunds]: {{summary_removePrunedFunds}}
{% endcomment %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -13,6 +13,9 @@ http://opensource.org/licenses/MIT.
*Added in Bitcoin Core 0.13.0* *Added in Bitcoin Core 0.13.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
*Requires wallet support.* *Requires wallet support.*
The `removeprunedfunds` RPC {{summary_removePrunedFunds}} This will effect wallet balances. The `removeprunedfunds` RPC {{summary_removePrunedFunds}} This will effect wallet balances.
@ -51,4 +54,6 @@ ebf46446a512166eae7628734ea0a5
* [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}} * [ImportPrivKey][rpc importprivkey]: {{summary_importPrivKey}}
* [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}} * [ImportPrunedFunds][rpc importprunedfunds]: {{summary_importPrunedFunds}}
{% endcomment %}
{% endautocrossref %} {% endautocrossref %}

View file

@ -13,6 +13,9 @@ http://opensource.org/licenses/MIT.
*Added in Bitcoin Core 0.13.0* *Added in Bitcoin Core 0.13.0*
{{WARNING_ICON}} **_Not implemented in Dash Core (as of 0.12.2)_**
{% comment %}
The `signmessagewithprivkey` RPC {{summary_signMessageWithPrivKey}} The `signmessagewithprivkey` RPC {{summary_signMessageWithPrivKey}}
*Parameter #1---the private key to sign with* *Parameter #1---the private key to sign with*
@ -65,4 +68,6 @@ G+ZauMFgQExAJRKZSldbAVEaZo4i0p2AVivbFASo50PkUnynAMDUiNMVdXDlpYMWvatxCmYmLn8C9zyg
* [SignMessage][rpc signmessage]: {{summary_signMessage}} * [SignMessage][rpc signmessage]: {{summary_signMessage}}
* [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}} * [VerifyMessage][rpc verifymessage]: {{summary_verifyMessage}}
{% endautocrossref %} {% endcomment %}
{% endautocrossref %}

View file

@ -320,5 +320,6 @@ NOT IN DASH
{% endcapture %} {% endcapture %}
{% assign WARNING="![Warning icon](/img/icons/icon_warning.svg) **Warning:**" %} {% assign WARNING="![Warning icon](/img/icons/icon_warning.svg) **Warning:**" %}
{% assign WARNING_ICON="![Warning icon](/img/icons/icon_warning.svg)" %}
{% assign reindexNote="Note: if you begin using `txindex=1` after downloading the block chain, you must rebuild your indexes by starting Bitcoin Core with the option `-reindex`. This may take several hours to complete, during which time your node will not process new blocks or transactions. This reindex only needs to be done once." %} {% assign reindexNote="Note: if you begin using `txindex=1` after downloading the block chain, you must rebuild your indexes by starting Bitcoin Core with the option `-reindex`. This may take several hours to complete, during which time your node will not process new blocks or transactions. This reindex only needs to be done once." %}