joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 09:46:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Devdoc RPC calls up-to-date as of 0.13.1

Browse source
This commit is contained in:
Michael Rotarius 2016-12-07 18:42:14 +01:00
parent 5e54a9c164
commit 3285ca7dc9
42 changed files with 1535 additions and 335 deletions
Download patch file Download diff file Expand all files Collapse all files

22
_includes/helpers/summaries.md
View file

@ -1,20 +1,24 @@
{%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 respend." %}
{% 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_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 redeemscript known)." %}
{% assign summary_backupWallet="safely copies `wallet.dat`<!--noref--> to the specified file, which can be a directory or a path with filename." %}
{% assign summary_clearBanned="Clears list of banned nodes." %}
{% assign summary_clearBanned="clears list of banned nodes." %}
{% assign summary_createMultiSig="creates a P2SH multi-signature address." %}
{% assign summary_createRawTransaction="creates an unsigned serialized transaction that spends a previous output to a new output with a P2PKH or P2SH address. The transaction is not stored in the wallet or transmitted to the network." %}
{% assign summary_decodeRawTransaction="decodes a serialized transaction hex string into a JSON object describing the transaction." %}
{% assign summary_decodeScript="decodes a hex-encoded P2SH redeem script." %}
{% assign summary_disconnectnode="immediately disconnects from a specified node." %}
{% assign summary_dumpPrivKey="returns the wallet-import-format (WIP) private key corresponding to an address. (But does not remove it from the wallet.)" %}
{% assign summary_dumpWallet="creates or overwrites a file with all wallet keys in a human-readable format." %}
{% assign summary_encryptWallet="encrypts the wallet with a passphrase. This is only to enable encryption for the first time. After encryption is enabled, you will need to enter the passphrase to use private keys." %}
{% assign summary_estimateFee="estimates the transaction fee per kilobyte that needs to be paid for a transaction to be included within a certain number of blocks." %}
{% assign summary_estimatePriority="estimates the priority that a transaction needs in order to be included within a certain number of blocks as a free high-priority transaction." %}
{% assign summary_generate="nearly instantly generates blocks (in regtest mode only)" %}
{% assign summary_fundRawTransaction="adds inputs to a transaction until it has enough in value to meet its out value." %}
{% assign summary_generate="nearly instantly generates blocks." %}
{% assign summary_generateToAddress="mines blocks immediately to a specified address." %}
{% assign summary_getAccount="returns the name of the account associated with the given address." %}
{% assign summary_getAccountAddress="returns the current Bitcoin address for receiving payments to this account. If the account doesn't exist, it creates both the account and a new address for receiving payment. Once a payment has been received to an address, future calls to this RPC for the same account will return a different address." %}
{% assign summary_getAddedNodeInfo="returns information about the given added node, or all added nodes (except onetry nodes). Only nodes which have been manually added using the `addnode` RPC will have their information displayed." %}
@ -30,9 +34,12 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_getChainTips="returns information about the highest-height block (tip) of each local block chain." %}
{% assign summary_getConnectionCount="returns the number of connections to other nodes." %}
{% assign summary_getDifficultly="returns the proof-of-work difficulty as a multiple of the minimum difficulty." %}
{% assign summary_getGenerate="returns true if the node is set to generate blocks using its CPU." %}
{% assign summary_getHashesPerSec="was removed in Bitcoin Core master (unreleased). It returned a recent hashes per second performance measurement when the node was generating blocks." %}
{% assign summary_getGenerate="was removed in Bitcoin Core 0.13.0." %}
{% assign summary_getHashesPerSec="was removed in Bitcoin Core 0.11.0." %}
{% assign summary_getInfo="prints various information about the node and the network." %}
{% assign summary_getMemPoolAncestors="returns all in-mempool ancestors for a transaction in the mempool." %}
{% assign summary_getMemPoolDescendants="returns all in-mempool descendants for a transaction in the mempool." %}
{% assign summary_getMemPoolEntry="returns mempool data for given transaction (must be in mempool)." %}
{% assign summary_getMemPoolInfo="returns information about the node's current transaction memory pool." %}
{% assign summary_getMiningInfo="returns various mining-related information." %}
{% assign summary_getNetTotals="returns information about network traffic, including bytes in, bytes out, and the current time." %}
@ -55,6 +62,7 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_help="lists all available public RPC commands, or gets help for the specified RPC. Commands which are unavailable will not be listed, such as wallet RPCs if wallet support is disabled." %}
{% assign summary_importAddress="adds an address or pubkey script to the wallet without the associated private key, allowing you to watch for transactions affecting that address or pubkey script without being able to spend any of its outputs." %}
{% assign summary_importPrivKey="adds a private key to your wallet. The key should be formatted in the wallet import format created by the `dumpprivkey` RPC." %}
{% assign summary_importPrunedFunds="imports funds without the need of a rescan. Meant for use with pruned wallets." %}
{% assign summary_importWallet="imports private keys from a file in wallet dump file format (see the `dumpwallet` RPC). These keys will be added to the keys currently in the wallet. This call may need to rescan all or parts of the block chain for transactions affecting the newly-added keys, which may take several minutes." %}
{% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %}
{% assign summary_listAccounts="lists accounts and their balances." %}
@ -70,6 +78,7 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_move="moves a specified amount from one account in your wallet to another using an off-block-chain transaction." %}
{% assign summary_ping-rpc="sends a P2P ping message to all connected nodes to measure ping time. Results are provided by the `getpeerinfo` RPC pingtime and pingwait fields as decimal seconds. The P2P `ping` message is handled in a queue with all other commands, so it measures processing backlog, not just network ping." %}
{% assign summary_prioritiseTransaction="adds virtual priority or fee to a transaction, allowing it to be accepted into blocks mined by this node (or miners which use this node) with a lower priority or fee. (It can also remove virtual priority or fee, requiring the transaction have a higher priority or fee to be accepted into a locally-mined block.)" %}
{% assign summary_removePrunedFunds="deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds." %}
{% assign summary_restGetBlock-noTxDetails="gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block. The JSON object includes TXIDs for transactions within the block rather than the complete transactions [GET block][rest get block] returns." %}
{% assign summary_restGetBlock="gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block." %}
{% assign summary_restGetTx="gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Bitcoin Core only stores complete transaction data for UTXOs and your own transactions, so this method may fail on historic transactions unless you use the non-default `txindex=1` in your Bitcoin Core startup settings." %}
@ -79,9 +88,10 @@ This file is licensed under the terms of its source texts{%endcomment%}
{% assign summary_sendToAddress="spends an amount to a given address." %}
{% assign summary_setAccount="puts the specified address in the given account." %}
{% assign summary_setBan="attempts add or remove a IP/Subnet from the banned list." %}
{% assign summary_setGenerate="enables or disables hashing to attempt to find the next block." %}
{% assign summary_setGenerate="was removed in Bitcoin Core 0.13.0." %}
{% 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." %}
{% assign summary_signRawTransaction="signs a transaction in the serialized transaction format using private keys stored in the wallet or provided in the call." %}
{% assign summary_stop="safely shuts down the Bitcoin Core server." %}
{% assign summary_submitBlock="accepts a block, verifies it is a valid addition to the block chain, and broadcasts it to the network. Extra parameters are ignored by Bitcoin Core but may be used by mining pools or other programs." %}