From a1b7d1e5329a008c23c5d84c926fb17149d6eb8f Mon Sep 17 00:00:00 2001 From: "David A. Harding" Date: Sun, 1 Feb 2015 18:21:51 -0500 Subject: [PATCH] Dev Docs: Put summary_ variables in alphabetical order * Simply ran `make manual-updates` using previously-commited sort patch --- _includes/helpers/summaries.md | 136 ++++++++++++++++----------------- 1 file changed, 68 insertions(+), 68 deletions(-) diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index 67c243b60e..16e6bea3a0 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -1,86 +1,86 @@ {%comment%}AUTOMATICALLY-GENERATED FILE: DO NOT EDIT THIS FILE This file is licensed under the terms of its source texts{%endcomment%} -{% assign summary_getBlockChainInfo="provides information about the current state of the block chain." %} -{% 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_getGenerate="returns true if the node is set to generate blocks using its CPU." %} -{% 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_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_verifyMessage="verifies a signed message." %} -{% assign summary_getHashesPerSec="returns a recent hashes per second performance measurement when the node is generating blocks." %} +{% 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_backupWallet="safely copies `wallet.dat` to the specified file, which can be a directory or a path with filename." %} {% 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_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_getWork="was removed in Bitcoin Core 0.10.0." %} -{% 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_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_listAccounts="lists accounts and their balances." %} -{% assign summary_setGenerate="enables or disables hashing to attempt to find the next block." %} -{% assign summary_getTxOut="returns details about a transaction output. Only unspent transaction outputs (UTXOs) are guaranteed to be available." %} -{% 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_getRawChangeAddress="returns a new Bitcoin address for receiving change. This is for use with raw transactions, not normal use." %} -{% 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_getInfo="prints various information about the node and the network." %} -{% 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_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_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_getAccount="returns the name of the account associated with the given 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_getAddressesByAccount="returns a list of every address assigned to a particular account." %} +{% assign summary_getBalance="gets the balance in decimal bitcoins 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_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_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_sendFrom="spends an amount from a local account to a bitcoin address." %} -{% 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." %} -{% assign summary_listUnspent="returns an array of unspent transaction outputs belonging to this wallet." %} +{% assign summary_getBlockHash="returns the header hash of a block at the given height in the local best block chain." %} +{% 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_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_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_decodeRawTransaction="decodes a serialized transaction hex string into a JSON object describing the transaction." %} +{% 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="returns a recent hashes per second performance measurement when the node is generating blocks." %} +{% assign summary_getInfo="prints various information about the node and the network." %} {% assign summary_getMemPoolInfo="returns information about the node's current transaction memory pool." %} -{% assign summary_getBlockCount="returns the number of blocks in the local best block chain." %} -{% assign summary_setAccount="puts the specified address in the given account." %} -{% assign summary_backupWallet="safely copies `wallet.dat` to the specified file, which can be a directory or a path with filename." %} -{% assign summary_getBestBlockHash="returns the header hash of the most recent block on the best block chain." %} -{% assign summary_validateAddress="returns information about the given Bitcoin address." %} -{% assign summary_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %} -{% assign summary_getPeerInfo="returns data about each connected network node." %} -{% assign summary_setTxFee="sets the transaction fee per kilobyte paid by transactions created by this wallet." %} -{% assign summary_sendRawTransaction="validates a transaction and broadcasts it to the peer-to-peer network." %} -{% assign summary_getAccount="returns the name of the account associated with the given address." %} +{% 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_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_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_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_keyPoolRefill="fills the cache of unused pre-generated keys (the keypool)." %} -{% assign summary_listReceivedByAccount="lists the total number of bitcoins received by each account." %} -{% assign summary_verifyChain="verifies each entry in the local block chain database." %} +{% assign summary_getNetworkHashPS="returns the estimated current or historical 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 Bitcoin 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_getRawChangeAddress="returns a new Bitcoin 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, Bitcoin 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 Bitcoin 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_getTransaction="gets detailed information about an in-wallet transaction." %} +{% assign summary_getTxOut="returns details about a transaction output. Only unspent transaction outputs (UTXOs) are guaranteed to be available." %} +{% 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." %} +{% 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_dumpPrivKey="returns the wallet-import-format (WIP) private key corresponding to an address. (But does not remove it from the wallet.)" %} -{% assign summary_getConnectionCount="returns the number of connections to other nodes." %} +{% 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_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." %} {% 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_lockUnspent="temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending bitcoins. 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_getNetworkHashPS="returns the estimated current or historical network hashes per second based on the last *n* blocks." %} -{% assign summary_stop="safely shuts down the Bitcoin Core server." %} -{% assign summary_getRawTransaction="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 the RPC may fail on historic transactions unless you use the non-default `txindex=1` in your Bitcoin Core startup settings." %} -{% 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_getDifficultly="returns the proof-of-work difficulty as a multiple of the minimum difficulty." %} -{% assign summary_getWalletInfo="provides information about the wallet." %} -{% assign summary_sendMany="creates and broadcasts a transaction which sends outputs to multiple addresses." %} -{% assign summary_getBlockTemplate="gets a block template or proposal for use with mining software." %} +{% assign summary_listLockUnspent="returns a list of temporarily unspendable (locked) outputs." %} +{% assign summary_listReceivedByAccount="lists the total number of bitcoins received by each account." %} {% assign summary_listReceivedByAddress="lists the total number of bitcoins received by each address." %} -{% assign summary_sendToAddress="spends an amount to a given address." %} -{% assign summary_listTransactions="returns the most recent transactions that affect the wallet." %} -{% assign summary_walletPassphraseChange="changes the wallet passphrase from 'old passphrase' to 'new passphrase'." %} -{% assign summary_getAddressesByAccount="returns a list of every address assigned to a particular account." %} {% 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_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_signMessage="signs a message with the private key of an address." %} -{% assign summary_getNewAddress="returns a new Bitcoin address for receiving payments. If an account is specified, payments received with the address will be credited to that account." %} -{% 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_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_decodeScript="decodes a hex-encoded P2SH redeem script." %} -{% assign summary_getNetworkInfo="returns information about the node's connection to the network." %} -{% assign summary_getBalance="gets the balance in decimal bitcoins across all accounts or for a particular account." %} -{% assign summary_getBlockHash="returns the header hash of a block at the given height in the local best block chain." %} -{% 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_addMultiSigAddress="adds a P2SH multisig address to the wallet." %} -{% 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_getMiningInfo="returns various mining-related information." %} +{% 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_lockUnspent="temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending bitcoins. 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_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_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_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_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." %} +{% assign summary_sendFrom="spends an amount from a local account to a bitcoin 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_setAccount="puts the specified address in the given account." %} +{% assign summary_setGenerate="enables or disables hashing to attempt to find the next block." %} +{% 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_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." %} +{% assign summary_validateAddress="returns information about the given Bitcoin address." %} +{% assign summary_verifyChain="verifies each entry in the local block chain database." %} +{% assign summary_verifyMessage="verifies a signed message." %} +{% 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_walletPassphraseChange="changes the wallet passphrase from 'old passphrase' to 'new passphrase'." %} +{% 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." %}