dash-docs/_includes/helpers/summaries.md

{%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 respent." %}
{% assign summary_abortRescan="Stops current wallet rescan" %}
{% 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 redeem script 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_bls="provides a set of commands to execute BLS-related actions." %}
{% assign summary_bumpFee="replaces an unconfirmed wallet transaction that signaled RBF with a new transaction that pays a higher fee." %}
{% 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_debug="changes the debug category from the console." %}
{% 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_dumpHDInfo="returns an object containing sensitive private info about this HD wallet" %}
{% 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 begin confirmation within a certain number of blocks." %}
{% assign summary_estimatePriority="was removed in Dash Core 0.14.0." %}
{% assign summary_estimateSmartFee="estimates the transaction fee per kilobyte that needs to be paid for a transaction to begin confirmation within a certain number of blocks and returns the number of blocks for which the estimate is valid." %}
{% assign summary_estimateSmartPriority="was removed in Dash Core 0.14.0." %}
{% assign summary_fundRawTransaction="adds inputs to a transaction until it has enough in value to meet its out value." %}
{% assign summary_gObject="provides a set of commands for managing governance objects and displaying information about them." %}
{% assign summary_generate="mines blocks immediately (before the RPC call returns)." %}
{% 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 Dash 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." %}
{% assign summary_getAddressBalance="returns the balance for address(es)." %}
{% assign summary_getAddressDeltas="returns all changes for an address." %}
{% assign summary_getAddressMempool="returns all mempool deltas for an address." %}
{% assign summary_getAddressTxids="returns the txids for an address(es)." %}
{% assign summary_getAddressUtxos="returns all unspent outputs for an address." %}
{% assign summary_getAddressesByAccount="returns a list of every address assigned to a particular account." %}
{% assign summary_getBalance="gets the balance in decimal dash across all accounts or for a particular account." %}
{% assign summary_getBestBlockHash="returns the header hash of the most recent block on the best block chain." %}
{% assign summary_getBlock="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_getBlockChainInfo="provides information about the current state of the block chain." %}
{% assign summary_getBlockCount="returns the number of blocks in the local best block chain." %}
{% assign summary_getBlockHash="returns the header hash of a block at the given height in the local best block chain." %}
{% assign summary_getBlockHashes="returns array of hashes of blocks within the timestamp range provided (requires `timestampindex` to be enabled)." %}
{% assign summary_getBlockHeader="gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header." %}
{% assign summary_getBlockHeaders="returns an array of items with information about the requested number of blockheaders starting from the requested hash." %}
{% assign summary_getBlockTemplate="gets a block template or proposal for use with mining software." %}
{% assign summary_getChainTips="returns information about the highest-height block (tip) of each local block chain." %}
{% assign summary_getChainTxStats="compute statistics about the total number and rate of transactions in the chain." %}
{% assign summary_getConnectionCount="returns the number of connections to other nodes." %}
{% assign summary_getDifficulty="returns the proof-of-work difficulty as a multiple of the minimum difficulty." %}
{% assign summary_getGenerate="was removed in Dash Core 0.12.3." %}
{% assign summary_getGovernanceInfo="returns an object containing governance parameters." %}
{% assign summary_getHashesPerSec="was removed in Bitcoin Core 0.11.0 and is not part of Dash." %}
{% 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_getMemoryInfo="returns information about memory usage." %}
{% assign summary_getMerkleBlocks="returns an array of hex-encoded merkleblocks for <count> blocks<!--noref--> starting from <hash> which match <filter>." %}
{% 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." %}
{% assign summary_getNetworkHashPS="returns the estimated network hashes per second based on the last n blocks." %}
{% assign summary_getNetworkInfo="returns information about the node's connection to the network." %}
{% assign summary_getNewAddress="returns a new Dash address for receiving payments. If an account is specified, payments received with the address will be credited to that account." %}
{% assign summary_getPeerInfo="returns data about each connected network node." %}
{% assign summary_getPoolInfo="returns an object containing mixing pool related information." %}
{% assign summary_getRawChangeAddress="returns a new Dash address for receiving change. This is for use with raw transactions, not normal use." %}
{% assign summary_getRawMemPool="returns all transaction identifiers (TXIDs) in the memory pool as a JSON array, or detailed information about each transaction in the memory pool as a JSON object." %}
{% assign summary_getRawTransaction="gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Dash Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default `txindex=1` in your Dash Core startup settings." %}
{% assign summary_getReceivedByAccount="returns the total amount received by addresses in a particular account from transactions with the specified number of confirmations.  It does not count coinbase transactions." %}
{% assign summary_getReceivedByAddress="returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions." %}
{% assign summary_getSpecialTxes="returns an array of special transactions found in the specified block" %}
{% assign summary_getSpentInfo="returns the txid and index where an output is spent (requires `spentindex` to be enabled)." %}
{% assign summary_getSuperblockBudget="returns the absolute maximum sum of superblock payments allowed." %}
{% assign summary_getTransaction="gets detailed information about an in-wallet transaction." %}
{% assign summary_getTxOut="returns details about an unspent transaction output (UTXO)." %}
{% assign summary_getTxOutProof="returns a hex-encoded proof that one or more specified transactions were included in a block." %}
{% assign summary_getTxOutSetInfo="returns statistics about the confirmed unspent transaction output (UTXO) set. Note that this call may take some time and that it only counts outputs from confirmed transactions---it does not count outputs from the memory pool." %}
{% assign summary_getUnconfirmedBalance="returns the wallet's total unconfirmed balance." %}
{% assign summary_getWalletInfo="provides information about the wallet." %}
{% assign summary_getWork="was removed in Bitcoin Core 0.10.0. and is not part of Dash" %}
{% 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_importElectrumWallet="imports keys from an Electrum wallet export file (.csv or .json)" %}
{% assign summary_importMulti="imports addresses or scripts (with private keys, public keys, or P2SH redeem scripts) and optionally performs the minimum necessary rescan for all imports." %}
{% 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_importPubKey="imports a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend" %}
{% 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_keepass="provides commands for configuring and managing KeePass authentication" %}
{% assign summary_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %}
{% assign summary_listAccounts="lists accounts and their balances." %}
{% assign summary_listAddressBalances="lists addresses of this wallet and their balances" %}
{% assign summary_listAddressGroupings="lists groups of addresses that may have had their common ownership made public by common use as inputs in the same transaction or from being used as change from a previous transaction." %}
{% assign summary_listBanned="lists all banned IPs/Subnets." %}
{% assign summary_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %}
{% assign summary_listReceivedByAccount="lists the total number of dash received by each account." %}
{% assign summary_listReceivedByAddress="lists the total number of dash received by each address." %}
{% assign summary_listSinceBlock="gets all transactions affecting the wallet which have occurred since a particular block, plus the header hash of a block at a particular depth." %}
{% assign summary_listTransactions="returns the most recent transactions that affect the wallet." %}
{% assign summary_listUnspent="returns an array of unspent transaction outputs belonging to this wallet." %}
{% assign summary_listWallets="returns a list of currently loaded wallets." %}
{% assign summary_lockUnspent="temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending dash. Locks are stored in memory only, so nodes start with zero locked outputs and the locked output list is always cleared when a node stops or fails." %}
{% assign summary_logging="gets and sets the logging configuration" %}
{% assign summary_masternode="provides a set of commands for managing masternodes and displaying information about them." %}
{% assign summary_masternodeBroadcast="was removed in Dash Core 0.14.0." %}
{% assign summary_masternodeList="returns a list of masternodes in different modes." %}
{% assign summary_mnSync="returns the sync status, updates to the next step or resets it entirely." %}
{% 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<!--noref--> ping." %}
{% assign summary_preciousBlock="treats a block as if it were received before others with the same work." %}
{% 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_privateSend="controls the mixing process." %}
{% assign summary_proTx="provides a set of commands to execute ProTx related actions." %}
{% assign summary_pruneBlockChain="prunes the blockchain up to a specified height or timestamp." %}
{% assign summary_quorum="provides a set of commands for quorums (LLMQs)." %}
{% 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_restGetChainInfo="returns information about the current state of the block chain." %}
{% assign summary_restGetGetUtxos="returns an UTXO set given a set of outpoints." %}
{% assign summary_restGetHeaders="returns a specified amount of block headers in upward direction." %}
{% assign summary_restGetMemPool-contents="returns all transaction in the memory pool with detailed information." %}
{% assign summary_restGetMemPool-info="returns information about the node's current transaction memory pool." %}
{% assign summary_restGetTx="gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Dash 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 Dash Core startup settings." %}
{% assign summary_sendFrom="spends an amount from a local account to a dash address." %}
{% assign summary_sendMany="creates and broadcasts a transaction which sends outputs to multiple addresses." %}
{% assign summary_sendRawTransaction="validates a transaction and broadcasts it to the peer-to-peer network." %}
{% assign summary_sendToAddress="spends an amount to a given address." %}
{% assign summary_sentinelPing="was removed in Dash Core 0.14.0." %}
{% 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="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." %}
{% 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_spork-rpc="reads or updates spork settings on the network." %}
{% assign summary_stop="safely shuts down the Dash 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 Dash Core but may be used by mining pools or other programs." %}
{% assign summary_uptime="returns the total uptime of the server." %}
{% assign summary_validateAddress="returns information about the given Dash address." %}
{% assign summary_verifyChain="verifies each entry in the local block chain database." %}
{% assign summary_verifyMessage="verifies a signed message." %}
{% assign summary_verifyTxOutProof="verifies that a proof points to one or more transactions in a block, returning the transactions the proof commits to and throwing an RPC error if the block is not in our best block chain." %}
{% assign summary_voteRaw="compiles and relays a governance vote with provided external signature instead of signing vote internally" %}
{% assign summary_walletLock="removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call `walletpassphrase` again before being able to call any methods which require the wallet to be unlocked." %}
{% assign summary_walletPassphrase="stores the wallet decryption key in memory for the indicated number of seconds. Issuing the `walletpassphrase` command while the wallet is already unlocked will set a new unlock time that overrides the old one." %}
{% assign summary_walletPassphraseChange="changes the wallet passphrase from 'old passphrase' to 'new passphrase'." %}