LBRYCommunity/lbcwallet
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 14 Packages Wiki Activity
lbcwallet/internal/rpchelp/helpdescs_en_US.go

416 lines
28 KiB
Go
Raw Normal View History

Relicense to the btcsuite developers.
2015-05-01 19:10:23 +02:00
// Copyright (c) 2015 The btcsuite developers
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//+build !generate
package rpchelp
var helpDescsEnUS = map[string]string{
// AddMultisigAddressCmd help.
"addmultisigaddress--synopsis": "Generates and imports a multisig address and redeeming script to the 'imported' account.",
"addmultisigaddress-account": "DEPRECATED -- Unused (all imported addresses belong to the imported account)",
"addmultisigaddress-keys": "Pubkeys and/or pay-to-pubkey-hash addresses to partially control the multisig address",
"addmultisigaddress-nrequired": "The number of signatures required to redeem outputs paid to this address",
"addmultisigaddress--result0": "The imported pay-to-script-hash address",
// CreateMultisigCmd help.
"createmultisig--synopsis": "Generate a multisig address and redeem script.",
"createmultisig-keys": "Pubkeys and/or pay-to-pubkey-hash addresses to partially control the multisig address",
"createmultisig-nrequired": "The number of signatures required to redeem outputs paid to this address",
// CreateMultisigResult help.
"createmultisigresult-address": "The generated pay-to-script-hash address",
"createmultisigresult-redeemScript": "The script required to redeem outputs paid to the multisig address",
// DumpPrivKeyCmd help.
"dumpprivkey--synopsis": "Returns the private key in WIF encoding that controls some wallet address.",
"dumpprivkey-address": "The address to return a private key for",
"dumpprivkey--result0": "The WIF-encoded private key",
// GetAccountCmd help.
"getaccount--synopsis": "DEPRECATED -- Lookup the account name that some wallet address belongs to.",
"getaccount-address": "The address to query the account for",
"getaccount--result0": "The name of the account that 'address' belongs to",
// GetAccountAddressCmd help.
"getaccountaddress--synopsis": "DEPRECATED -- Returns the most recent external payment address for an account that has not been seen publicly.\n" +
"A new address is generated for the account if the most recently generated address has been seen on the blockchain or in mempool.",
"getaccountaddress-account": "The account of the returned address",
"getaccountaddress--result0": "The unused address for 'account'",
// GetAddressesByAccountCmd help.
"getaddressesbyaccount--synopsis": "DEPRECATED -- Returns all addresses strings controlled by a single account.",
"getaddressesbyaccount-account": "Account name to fetch addresses for",
"getaddressesbyaccount--result0": "All addresses controlled by 'account'",
// GetBalanceCmd help.
"getbalance--synopsis": "Calculates and returns the balance of one or all accounts.",
"getbalance-minconf": "Minimum number of block confirmations required before an unspent output's value is included in the balance",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"getbalance-account": "DEPRECATED -- The account name to query the balance for, or \"*\" to consider all accounts (default=\"*\")",
"getbalance--condition0": "account != \"*\"",
"getbalance--condition1": "account = \"*\"",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"getbalance--result0": "The balance of 'account' valued in bitcoin",
"getbalance--result1": "The balance of all accounts valued in bitcoin",
// GetBestBlockHashCmd help.
"getbestblockhash--synopsis": "Returns the hash of the newest block in the best chain that wallet has finished syncing with.",
"getbestblockhash--result0": "The hash of the most recent synced-to block",
// GetBlockCountCmd help.
"getblockcount--synopsis": "Returns the blockchain height of the newest block in the best chain that wallet has finished syncing with.",
"getblockcount--result0": "The blockchain height of the most recent synced-to block",
// GetInfoCmd help.
"getinfo--synopsis": "Returns a JSON object containing various state info.",
// InfoWalletResult help.
"infowalletresult-version": "The version of the server",
"infowalletresult-protocolversion": "The latest supported protocol version",
"infowalletresult-blocks": "The number of blocks processed",
"infowalletresult-timeoffset": "The time offset",
"infowalletresult-connections": "The number of connected peers",
"infowalletresult-proxy": "The proxy used by the server",
"infowalletresult-difficulty": "The current target difficulty",
"infowalletresult-testnet": "Whether or not server is using testnet",
"infowalletresult-relayfee": "The minimum relay fee for non-free transactions in BTC/KB",
"infowalletresult-errors": "Any current errors",
"infowalletresult-paytxfee": "The increment used each time more fee is required for an authored transaction",
"infowalletresult-balance": "The balance of all accounts calculated with one block confirmation",
"infowalletresult-walletversion": "The version of the address manager database",
"infowalletresult-unlocked_until": "Unset",
"infowalletresult-keypoolsize": "Unset",
"infowalletresult-keypoololdest": "Unset",
// GetNewAddressCmd help.
"getnewaddress--synopsis": "Generates and returns a new payment address.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"getnewaddress-account": "DEPRECATED -- Account name the new address will belong to (default=\"default\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"getnewaddress--result0": "The payment address",
// GetRawChangeAddressCmd help.
"getrawchangeaddress--synopsis": "Generates and returns a new internal payment address for use as a change address in raw transactions.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"getrawchangeaddress-account": "Account name the new internal address will belong to (default=\"default\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"getrawchangeaddress--result0": "The internal payment address",
// GetReceivedByAccountCmd help.
"getreceivedbyaccount--synopsis": "DEPRECATED -- Returns the total amount received by addresses of some account, including spent outputs.",
"getreceivedbyaccount-account": "Account name to query total received amount for",
"getreceivedbyaccount-minconf": "Minimum number of block confirmations required before an output's value is included in the total",
"getreceivedbyaccount--result0": "The total received amount valued in bitcoin",
// GetReceivedByAddressCmd help.
"getreceivedbyaddress--synopsis": "Returns the total amount received by a single address, including spent outputs.",
"getreceivedbyaddress-address": "Payment address which received outputs to include in total",
"getreceivedbyaddress-minconf": "Minimum number of block confirmations required before an output's value is included in the total",
"getreceivedbyaddress--result0": "The total received amount valued in bitcoin",
// GetTransactionCmd help.
"gettransaction--synopsis": "Returns a JSON object with details regarding a transaction relevant to this wallet.",
"gettransaction-txid": "Hash of the transaction to query",
"gettransaction-includewatchonly": "Also consider transactions involving watched addresses",
// HelpCmd help.
"help--synopsis": "Returns a list of all commands or help for a specified command.",
"help-command": "The command to retrieve help for",
"help--condition0": "no command provided",
"help--condition1": "command specified",
"help--result0": "List of commands",
"help--result1": "Help for specified command",
// GetTransactionResult help.
"gettransactionresult-amount": "The total amount this transaction credits to the wallet, valued in bitcoin",
"gettransactionresult-fee": "The total input value minus the total output value, or 0 if 'txid' is not a sent transaction",
"gettransactionresult-confirmations": "The number of block confirmations of the transaction",
"gettransactionresult-blockhash": "The hash of the block this transaction is mined in, or the empty string if unmined",
"gettransactionresult-blockindex": "Unset",
"gettransactionresult-blocktime": "The Unix time of the block header this transaction is mined in, or 0 if unmined",
"gettransactionresult-txid": "The transaction hash",
"gettransactionresult-walletconflicts": "Unset",
"gettransactionresult-time": "The earliest Unix time this transaction was known to exist",
"gettransactionresult-timereceived": "The earliest Unix time this transaction was known to exist",
"gettransactionresult-details": "Additional details for each recorded wallet credit and debit",
"gettransactionresult-hex": "The transaction encoded as a hexadecimal string",
// GetTransactionDetailsResult help.
Updates for btcjson type changes. To increase compatibility with Bitcoin Core Wallet, additional fields were added to and other fields made optional for the listtransactions and gettransaction results structs. For both, fee was changed to be optional (including the zero value is allowed).
2015-05-06 17:48:05 +02:00
"gettransactiondetailsresult-account": "DEPRECATED -- Unset",
"gettransactiondetailsresult-address": "The address an output was paid to, or the empty string if the output is nonstandard or this detail is regarding a transaction input",
"gettransactiondetailsresult-category": `The kind of detail: "send" for sent transactions, "immature" for immature coinbase outputs, "generate" for mature coinbase outputs, or "recv" for all other received outputs`,
"gettransactiondetailsresult-amount": "The amount of a received output",
"gettransactiondetailsresult-fee": "The included fee for a sent transaction",
"gettransactiondetailsresult-vout": "The transaction output index",
"gettransactiondetailsresult-involveswatchonly": "Unset",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// ImportPrivKeyCmd help.
"importprivkey--synopsis": "Imports a WIF-encoded private key to the 'imported' account.",
"importprivkey-privkey": "The WIF-encoded private key",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"importprivkey-label": "Unused (must be unset or 'imported')",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"importprivkey-rescan": "Rescan the blockchain (since the genesis block) for outputs controlled by the imported key",
// KeypoolRefillCmd help.
"keypoolrefill--synopsis": "DEPRECATED -- This request does nothing since no keypool is maintained.",
"keypoolrefill-newsize": "Unused",
// ListAccountsCmd help.
"listaccounts--synopsis": "DEPRECATED -- Returns a JSON object of all accounts and their balances.",
"listaccounts-minconf": "Minimum number of block confirmations required before an unspent output's value is included in the balance",
"listaccounts--result0--desc": "JSON object with account names as keys and bitcoin amounts as values",
"listaccounts--result0--key": "The account name",
"listaccounts--result0--value": "The account balance valued in bitcoin",
// ListLockUnspentCmd help.
"listlockunspent--synopsis": "Returns a JSON array of outpoints marked as locked (with lockunspent) for this wallet session.",
// TransactionInput help.
"transactioninput-txid": "The transaction hash of the referenced output",
"transactioninput-vout": "The output index of the referenced output",
// ListReceivedByAccountCmd help.
"listreceivedbyaccount--synopsis": "DEPRECATED -- Returns a JSON array of objects listing all accounts and the total amount received by each account.",
"listreceivedbyaccount-minconf": "Minimum number of block confirmations required before a transaction is considered",
"listreceivedbyaccount-includeempty": "Unused",
"listreceivedbyaccount-includewatchonly": "Unused",
// ListReceivedByAccountResult help.
"listreceivedbyaccountresult-account": "The name of the account",
"listreceivedbyaccountresult-amount": "Total amount received by payment addresses of the account valued in bitcoin",
"listreceivedbyaccountresult-confirmations": "Number of block confirmations of the most recent transaction relevant to the account",
// ListReceivedByAddressCmd help.
"listreceivedbyaddress--synopsis": "Returns a JSON array of objects listing wallet payment addresses and their total received amounts.",
"listreceivedbyaddress-minconf": "Minimum number of block confirmations required before a transaction is considered",
"listreceivedbyaddress-includeempty": "Unused",
"listreceivedbyaddress-includewatchonly": "Unused",
// ListReceivedByAddressResult help.
"listreceivedbyaddressresult-account": "DEPRECATED -- Unset",
"listreceivedbyaddressresult-address": "The payment address",
"listreceivedbyaddressresult-amount": "Total amount received by the payment address valued in bitcoin",
"listreceivedbyaddressresult-confirmations": "Number of block confirmations of the most recent transaction relevant to the address",
"listreceivedbyaddressresult-txids": "Transaction hashes of all transactions involving this address",
"listreceivedbyaddressresult-involvesWatchonly": "Unset",
// ListSinceBlockCmd help.
Remove target conf limit on listsinceblock txs. All transactions since the specified block (or the genesis block if left unspecified) should be included in the result array Along with this fix, update the help descriptions to mention that the target confirmations parameter is not considered when including transactions in the result object. That is, transactions with a height greater than the height of the lastblock in the result object are still included. Fixes #263.
2015-05-06 22:32:39 +02:00
"listsinceblock--synopsis": "Returns a JSON array of objects listing details of all wallet transactions after some block.",
"listsinceblock-blockhash": "Hash of the parent block of the first block to consider transactions from, or unset to list all transactions",
"listsinceblock-targetconfirmations": "Minimum number of block confirmations of the last block in the result object. Must be 1 or greater. Note: The transactions array in the result object is not affected by this parameter",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"listsinceblock-includewatchonly": "Unused",
Remove target conf limit on listsinceblock txs. All transactions since the specified block (or the genesis block if left unspecified) should be included in the result array Along with this fix, update the help descriptions to mention that the target confirmations parameter is not considered when including transactions in the result object. That is, transactions with a height greater than the height of the lastblock in the result object are still included. Fixes #263.
2015-05-06 22:32:39 +02:00
"listsinceblock--condition0": "blockhash specified",
"listsinceblock--condition1": "no blockhash specified",
"listsinceblock--result0": "Lists all transactions, including unmined transactions, since the specified block",
"listsinceblock--result1": "Lists all transactions since the genesis block",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// ListSinceBlockResult help.
"listsinceblockresult-transactions": "JSON array of objects containing verbose details of the each transaction",
"listsinceblockresult-lastblock": "Hash of the latest-synced block to be used in later calls to listsinceblock",
// ListTransactionsResult help.
Updates for btcjson type changes. To increase compatibility with Bitcoin Core Wallet, additional fields were added to and other fields made optional for the listtransactions and gettransaction results structs. For both, fee was changed to be optional (including the zero value is allowed).
2015-05-06 17:48:05 +02:00
"listtransactionsresult-account": "DEPRECATED -- Unset",
"listtransactionsresult-address": "Payment address for a transaction output",
"listtransactionsresult-category": `The kind of transaction: "send" for sent transactions, "immature" for immature coinbase outputs, "generate" for mature coinbase outputs, or "recv" for all other received outputs. Note: A single output may be included multiple times under different categories`,
"listtransactionsresult-amount": "The value of the transaction output valued in bitcoin",
"listtransactionsresult-fee": "The total input value minus the total output value for sent transactions",
"listtransactionsresult-confirmations": "The number of block confirmations of the transaction",
"listtransactionsresult-generated": "Whether the transaction output is a coinbase output",
"listtransactionsresult-blockhash": "The hash of the block this transaction is mined in, or the empty string if unmined",
"listtransactionsresult-blockindex": "Unset",
"listtransactionsresult-blocktime": "The Unix time of the block header this transaction is mined in, or 0 if unmined",
"listtransactionsresult-txid": "The hash of the transaction",
"listtransactionsresult-vout": "The transaction output index",
"listtransactionsresult-walletconflicts": "Unset",
"listtransactionsresult-time": "The earliest Unix time this transaction was known to exist",
"listtransactionsresult-timereceived": "The earliest Unix time this transaction was known to exist",
"listtransactionsresult-involveswatchonly": "Unset",
"listtransactionsresult-comment": "Unset",
"listtransactionsresult-otheraccount": "Unset",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// ListTransactionsCmd help.
"listtransactions--synopsis": "Returns a JSON array of objects containing verbose details for wallet transactions.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"listtransactions-account": "DEPRECATED -- Unused (must be unset or \"*\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"listtransactions-count": "Maximum number of transactions to create results from",
"listtransactions-from": "Number of transactions to skip before results are created",
"listtransactions-includewatchonly": "Unused",
// ListUnspentCmd help.
"listunspent--synopsis": "Returns a JSON array of objects representing unlocked unspent outputs controlled by wallet keys.",
"listunspent-minconf": "Minimum number of block confirmations required before a transaction output is considered",
"listunspent-maxconf": "Maximum number of block confirmations required before a transaction output is excluded",
"listunspent-addresses": "If set, limits the returned details to unspent outputs received by any of these payment addresses",
// ListUnspentResult help.
"listunspentresult-txid": "The transaction hash of the referenced output",
"listunspentresult-vout": "The output index of the referenced output",
"listunspentresult-address": "The payment address that received the output",
"listunspentresult-account": "The account associated with the receiving payment address",
"listunspentresult-scriptPubKey": "The output script encoded as a hexadecimal string",
"listunspentresult-redeemScript": "Unset",
"listunspentresult-amount": "The amount of the output valued in bitcoin",
"listunspentresult-confirmations": "The number of block confirmations of the transaction",
// LockUnspentCmd help.
"lockunspent--synopsis": "Locks or unlocks an unspent output.\n" +
"Locked outputs are not chosen for transaction inputs of authored transactions and are not included in 'listunspent' results.\n" +
"Locked outputs are volatile and are not saved across wallet restarts.\n" +
"If unlock is true and no transaction outputs are specified, all locked outputs are marked unlocked.",
"lockunspent-unlock": "True to unlock outputs, false to lock",
"lockunspent-transactions": "Transaction outputs to lock or unlock",
"lockunspent--result0": "The boolean 'true'",
// SendFromCmd help.
"sendfrom--synopsis": "DEPRECATED -- Authors, signs, and sends a transaction that outputs some amount to a payment address.\n" +
"A change output is automatically included to send extra output value back to the original account.",
"sendfrom-fromaccount": "Account to pick unspent outputs from",
"sendfrom-toaddress": "Address to pay",
"sendfrom-amount": "Amount to send to the payment address valued in bitcoin",
"sendfrom-minconf": "Minimum number of block confirmations required before a transaction output is eligible to be spent",
"sendfrom-comment": "Unused",
"sendfrom-commentto": "Unused",
"sendfrom--result0": "The transaction hash of the sent transaction",
// SendManyCmd help.
"sendmany--synopsis": "Authors, signs, and sends a transaction that outputs to many payment addresses.\n" +
"A change output is automatically included to send extra output value back to the original account.",
"sendmany-fromaccount": "DEPRECATED -- Account to pick unspent outputs from",
"sendmany-amounts": "Pairs of payment addresses and the output amount to pay each",
"sendmany-amounts--desc": "JSON object using payment addresses as keys and output amounts valued in bitcoin to send to each address",
"sendmany-amounts--key": "Address to pay",
"sendmany-amounts--value": "Amount to send to the payment address valued in bitcoin",
"sendmany-minconf": "Minimum number of block confirmations required before a transaction output is eligible to be spent",
"sendmany-comment": "Unused",
"sendmany--result0": "The transaction hash of the sent transaction",
// SendToAddressCmd help.
"sendtoaddress--synopsis": "Authors, signs, and sends a transaction that outputs some amount to a payment address.\n" +
"Unlike sendfrom, outputs are always chosen from the default account.\n" +
"A change output is automatically included to send extra output value back to the original account.",
"sendtoaddress-address": "Address to pay",
"sendtoaddress-amount": "Amount to send to the payment address valued in bitcoin",
"sendtoaddress-comment": "Unused",
"sendtoaddress-commentto": "Unused",
"sendtoaddress--result0": "The transaction hash of the sent transaction",
// SetTxFeeCmd help.
"settxfee--synopsis": "Modify the increment used each time more fee is required for an authored transaction.",
"settxfee-amount": "The new fee increment valued in bitcoin",
"settxfee--result0": "The boolean 'true'",
// SignMessageCmd help.
"signmessage--synopsis": "Signs a message using the private key of a payment address.",
"signmessage-address": "Payment address of private key used to sign the message with",
"signmessage-message": "Message to sign",
"signmessage--result0": "The signed message encoded as a base64 string",
// SignRawTransactionCmd help.
"signrawtransaction--synopsis": "Signs transaction inputs using private keys from this wallet and request.\n" +
"The valid flags options are ALL, NONE, SINGLE, ALL|ANYONECANPAY, NONE|ANYONECANPAY, and SINGLE|ANYONECANPAY.",
"signrawtransaction-rawtx": "Unsigned or partially unsigned transaction to sign encoded as a hexadecimal string",
"signrawtransaction-inputs": "Additional data regarding inputs that this wallet may not be tracking",
"signrawtransaction-privkeys": "Additional WIF-encoded private keys to use when creating signatures",
"signrawtransaction-flags": "Sighash flags",
// SignRawTransactionResult help.
"signrawtransactionresult-hex": "The resulting transaction encoded as a hexadecimal string",
"signrawtransactionresult-complete": "Whether all input signatures have been created",
Add script verification errors to signrawtransaction result. This mimics Bitcoin Core commit 8ac2a4e1788426329b842eea7121b8eac7875c76
2015-05-07 18:28:25 +02:00
"signrawtransactionresult-errors": "Script verification errors (if exists)",
// SignRawTransactionError help.
"signrawtransactionerror-error": "Verification or signing error related to the input",
"signrawtransactionerror-sequence": "Script sequence number",
"signrawtransactionerror-scriptSig": "The hex-encoded signature script",
"signrawtransactionerror-txid": "The transaction hash of the referenced previous output",
"signrawtransactionerror-vout": "The output index of the referenced previous output",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// ValidateAddressCmd help.
"validateaddress--synopsis": "Verify that an address is valid.\n" +
"Extra details are returned if the address is controlled by this wallet.\n" +
"The following fields are valid only when the address is controlled by this wallet (ismine=true): isscript, pubkey, iscompressed, account, addresses, hex, script, and sigsrequired.\n" +
"The following fields are only valid when address has an associated public key: pubkey, iscompressed.\n" +
"The following fields are only valid when address is a pay-to-script-hash address: addresses, hex, and script.\n" +
"If the address is a multisig address controlled by this wallet, the multisig fields will be left unset if the wallet is locked since the redeem script cannot be decrypted.",
"validateaddress-address": "Address to validate",
// ValidateAddressWalletResult help.
"validateaddresswalletresult-isvalid": "Whether or not the address is valid",
"validateaddresswalletresult-address": "The payment address (only when isvalid is true)",
"validateaddresswalletresult-ismine": "Whether this address is controlled by the wallet (only when isvalid is true)",
"validateaddresswalletresult-iswatchonly": "Unset",
"validateaddresswalletresult-isscript": "Whether the payment address is a pay-to-script-hash address (only when isvalid is true)",
"validateaddresswalletresult-pubkey": "The associated public key of the payment address, if any (only when isvalid is true)",
"validateaddresswalletresult-iscompressed": "Whether the address was created by hashing a compressed public key, if any (only when isvalid is true)",
"validateaddresswalletresult-account": "The account this payment address belongs to (only when isvalid is true)",
"validateaddresswalletresult-addresses": "All associated payment addresses of the script if address is a multisig address (only when isvalid is true)",
"validateaddresswalletresult-hex": "The redeem script ",
"validateaddresswalletresult-script": "The class of redeem script for a multisig address",
"validateaddresswalletresult-sigsrequired": "The number of required signatures to redeem outputs to the multisig address",
// VerifyMessageCmd help.
"verifymessage--synopsis": "Verify a message was signed with the associated private key of some address.",
"verifymessage-address": "Address used to sign message",
"verifymessage-signature": "The signature to verify",
"verifymessage-message": "The message to verify",
"verifymessage--result0": "Whether the message was signed with the private key of 'address'",
// WalletLockCmd help.
"walletlock--synopsis": "Lock the wallet.",
// WalletPassphraseCmd help.
"walletpassphrase--synopsis": "Unlock the wallet.",
"walletpassphrase-passphrase": "The wallet passphrase",
"walletpassphrase-timeout": "The number of seconds to wait before the wallet automatically locks",
// WalletPassphraseChangeCmd help.
"walletpassphrasechange--synopsis": "Change the wallet passphrase.",
"walletpassphrasechange-oldpassphrase": "The old wallet passphrase",
"walletpassphrasechange-newpassphrase": "The new wallet passphrase",
// CreateNewAccountCmd help.
"createnewaccount--synopsis": "Creates a new account.\n" +
"The wallet must be unlocked for this request to succeed.",
"createnewaccount-account": "Name of the new account",
// ExportWatchingWalletCmd help.
"exportwatchingwallet--synopsis": "Creates and returns a duplicate of the wallet database without any private keys to be used as a watching-only wallet.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"exportwatchingwallet-account": "Unused (must be unset or \"*\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"exportwatchingwallet-download": "Unused",
"exportwatchingwallet--result0": "The watching-only database encoded as a base64 string",
// GetBestBlockCmd help.
"getbestblock--synopsis": "Returns the hash and height of the newest block in the best chain that wallet has finished syncing with.",
// GetBestBlockResult help.
"getbestblockresult-hash": "The hash of the block",
"getbestblockresult-height": "The blockchain height of the block",
// GetUnconfirmedBalanceCmd help.
"getunconfirmedbalance--synopsis": "Calculates the unspent output value of all unmined transaction outputs for an account.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"getunconfirmedbalance-account": "The account to query the unconfirmed balance for (default=\"default\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
"getunconfirmedbalance--result0": "Total amount of all unmined unspent outputs of the account valued in bitcoin.",
// ListAddressTransactionsCmd help.
"listaddresstransactions--synopsis": "Returns a JSON array of objects containing verbose details for wallet transactions pertaining some addresses.",
"listaddresstransactions-addresses": "Addresses to filter transaction results by",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"listaddresstransactions-account": "Unused (must be unset or \"*\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// ListAllTransactionsCmd help.
"listalltransactions--synopsis": "Returns a JSON array of objects in the same format as 'listtransactions' without limiting the number of returned objects.",
Modify default account naming policy. Rather than disallowing the default account to be renamed as was proposed in #245 (and implemented in #246), the default account name is no longer considered a reserved name by the address manager. Instead, it is simply the initial name used for the first initial account. A database upgrade removes any additional aliases for the default account in the database. This prevents a lookup for some name which is not an account name from mapping to the default account unexpectedly (potentially preventing incorrect account usage from the RPC server due to bad iteraction with default parameters). All unset account names in a JSON-RPC request are expected to be set nil by btcjson. This behavior depends on btcsuite/btcd#399. Additionally, the manager no longer considers the wildcard * to be a reserved account name. Due to poor API decisions, the RPC server overloads the meaning of account fields to optionally allow referring to all accounts at a time, or a single account. This is not a address manager responsibility, though, as a future cleaner API should not use multiple differet meanings for the same field across multiple requests. Therefore, don't burden down future APIs with this quirk and prevent incorrect wildcard usage from the RPC server. Closes #245.
2015-04-16 18:54:56 +02:00
"listalltransactions-account": "Unused (must be unset or \"*\")",
Convert RPC server to btcjson v2. Closes #227.
2015-04-17 22:05:38 +02:00
// RenameAccountCmd help.
"renameaccount--synopsis": "Renames an account.",
"renameaccount-oldaccount": "The old account name to rename",
"renameaccount-newaccount": "The new name for the account",
// WalletIsLockedCmd help.
"walletislocked--synopsis": "Returns whether or not the wallet is locked.",
"walletislocked--result0": "Whether the wallet is locked",
}
Reference in a new issue Copy permalink