Changeset View
Changeset View
Standalone View
Standalone View
src/wallet/rpcwallet.cpp
| Show First 20 Lines • Show All 819 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| "-spendzeroconfchange.\n", | "-spendzeroconfchange.\n", | ||||
| { | { | ||||
| {"dummy", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, | {"dummy", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, | ||||
| "Remains for backward compatibility. Must be excluded or set to " | "Remains for backward compatibility. Must be excluded or set to " | ||||
| "\"*\"."}, | "\"*\"."}, | ||||
| {"minconf", RPCArg::Type::NUM, /* default */ "0", | {"minconf", RPCArg::Type::NUM, /* default */ "0", | ||||
| "Only include transactions confirmed at least this many times."}, | "Only include transactions confirmed at least this many times."}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "false", | /* default */ "true for watch-only wallets, otherwise false", | ||||
| "Also include balance in watch-only addresses (see " | "Also include balance in watch-only addresses (see " | ||||
| "'importaddress')"}, | "'importaddress')"}, | ||||
| {"avoid_reuse", RPCArg::Type::BOOL, | {"avoid_reuse", RPCArg::Type::BOOL, | ||||
| /* default */ "true", | /* default */ "true", | ||||
| "(only available if avoid_reuse wallet flag is set) Do not " | "(only available if avoid_reuse wallet flag is set) Do not " | ||||
| "include balance in dirty outputs; addresses are considered dirty " | "include balance in dirty outputs; addresses are considered dirty " | ||||
| "if they have previously been used in a transaction."}, | "if they have previously been used in a transaction."}, | ||||
| }, | }, | ||||
| ▲ Show 20 Lines • Show All 511 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| "\nList balances by receiving address.\n", | "\nList balances by receiving address.\n", | ||||
| { | { | ||||
| {"minconf", RPCArg::Type::NUM, /* default */ "1", | {"minconf", RPCArg::Type::NUM, /* default */ "1", | ||||
| "The minimum number of confirmations before payments are " | "The minimum number of confirmations before payments are " | ||||
| "included."}, | "included."}, | ||||
| {"include_empty", RPCArg::Type::BOOL, /* default */ "false", | {"include_empty", RPCArg::Type::BOOL, /* default */ "false", | ||||
| "Whether to include addresses that haven't received any " | "Whether to include addresses that haven't received any " | ||||
| "payments."}, | "payments."}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, /* default */ "false", | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "true for watch-only wallets, otherwise false", | |||||
| "Whether to include watch-only addresses (see 'importaddress')."}, | "Whether to include watch-only addresses (see 'importaddress')."}, | ||||
| {"address_filter", RPCArg::Type::STR, | {"address_filter", RPCArg::Type::STR, | ||||
| RPCArg::Optional::OMITTED_NAMED_ARG, | RPCArg::Optional::OMITTED_NAMED_ARG, | ||||
| "If present, only return information on this address."}, | "If present, only return information on this address."}, | ||||
| }, | }, | ||||
| RPCResult{ | RPCResult{ | ||||
| "[\n" | "[\n" | ||||
| " {\n" | " {\n" | ||||
| ▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| "\nList received transactions by label.\n", | "\nList received transactions by label.\n", | ||||
| { | { | ||||
| {"minconf", RPCArg::Type::NUM, /* default */ "1", | {"minconf", RPCArg::Type::NUM, /* default */ "1", | ||||
| "The minimum number of confirmations before payments are " | "The minimum number of confirmations before payments are " | ||||
| "included."}, | "included."}, | ||||
| {"include_empty", RPCArg::Type::BOOL, /* default */ "false", | {"include_empty", RPCArg::Type::BOOL, /* default */ "false", | ||||
| "Whether to include labels that haven't received any payments."}, | "Whether to include labels that haven't received any payments."}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "false", | /* default */ "true for watch-only wallets, otherwise false", | ||||
| "Whether to include watch-only addresses (see 'importaddress')."}, | "Whether to include watch-only addresses (see 'importaddress')."}, | ||||
| }, | }, | ||||
| RPCResult{"[\n" | RPCResult{"[\n" | ||||
| " {\n" | " {\n" | ||||
| " \"involvesWatchonly\" : true, (bool) Only returned if " | " \"involvesWatchonly\" : true, (bool) Only returned if " | ||||
| "imported addresses were involved in transaction\n" | "imported addresses were involved in transaction\n" | ||||
| " \"amount\" : x.xxx, (numeric) The total " | " \"amount\" : x.xxx, (numeric) The total " | ||||
| "amount received by addresses with this label\n" | "amount received by addresses with this label\n" | ||||
| ▲ Show 20 Lines • Show All 136 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| {"label", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, | {"label", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, | ||||
| "If set, should be a valid label name to return only incoming " | "If set, should be a valid label name to return only incoming " | ||||
| "transactions with the specified label, or \"*\" to disable " | "transactions with the specified label, or \"*\" to disable " | ||||
| "filtering and return all transactions."}, | "filtering and return all transactions."}, | ||||
| {"count", RPCArg::Type::NUM, /* default */ "10", | {"count", RPCArg::Type::NUM, /* default */ "10", | ||||
| "The number of transactions to return"}, | "The number of transactions to return"}, | ||||
| {"skip", RPCArg::Type::NUM, /* default */ "0", | {"skip", RPCArg::Type::NUM, /* default */ "0", | ||||
| "The number of transactions to skip"}, | "The number of transactions to skip"}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, /* default */ "false", | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "true for watch-only wallets, otherwise false", | |||||
| "Include transactions to watch-only addresses (see " | "Include transactions to watch-only addresses (see " | ||||
| "'importaddress')"}, | "'importaddress')"}, | ||||
| }, | }, | ||||
| RPCResult{ | RPCResult{ | ||||
| "[\n" | "[\n" | ||||
| " {\n" | " {\n" | ||||
| " \"address\":\"address\", (string) The bitcoin address of " | " \"address\":\"address\", (string) The bitcoin address of " | ||||
| "the transaction.\n" | "the transaction.\n" | ||||
| ▲ Show 20 Lines • Show All 140 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| {"blockhash", RPCArg::Type::STR, | {"blockhash", RPCArg::Type::STR, | ||||
| RPCArg::Optional::OMITTED_NAMED_ARG, | RPCArg::Optional::OMITTED_NAMED_ARG, | ||||
| "If set, the block hash to list transactions since, otherwise " | "If set, the block hash to list transactions since, otherwise " | ||||
| "list all transactions."}, | "list all transactions."}, | ||||
| {"target_confirmations", RPCArg::Type::NUM, /* default */ "1", | {"target_confirmations", RPCArg::Type::NUM, /* default */ "1", | ||||
| "Return the nth block hash from the main chain. e.g. 1 would mean " | "Return the nth block hash from the main chain. e.g. 1 would mean " | ||||
| "the best block hash. Note: this is not used as a filter, but " | "the best block hash. Note: this is not used as a filter, but " | ||||
| "only affects [lastblock] in the return value"}, | "only affects [lastblock] in the return value"}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, /* default */ "false", | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "true for watch-only wallets, otherwise false", | |||||
| "Include transactions to watch-only addresses (see " | "Include transactions to watch-only addresses (see " | ||||
| "'importaddress')"}, | "'importaddress')"}, | ||||
| {"include_removed", RPCArg::Type::BOOL, /* default */ "true", | {"include_removed", RPCArg::Type::BOOL, /* default */ "true", | ||||
| "Show transactions that were removed due to a reorg in the " | "Show transactions that were removed due to a reorg in the " | ||||
| "\"removed\" array\n" | "\"removed\" array\n" | ||||
| " (not " | " (not " | ||||
| "guaranteed to work on pruned nodes)"}, | "guaranteed to work on pruned nodes)"}, | ||||
| }, | }, | ||||
| ▲ Show 20 Lines • Show All 179 Lines • ▼ Show 20 Lines | static UniValue gettransaction(const Config &config, | ||||
| RPCHelpMan{ | RPCHelpMan{ | ||||
| "gettransaction", | "gettransaction", | ||||
| "\nGet detailed information about in-wallet transaction <txid>\n", | "\nGet detailed information about in-wallet transaction <txid>\n", | ||||
| { | { | ||||
| {"txid", RPCArg::Type::STR, RPCArg::Optional::NO, | {"txid", RPCArg::Type::STR, RPCArg::Optional::NO, | ||||
| "The transaction id"}, | "The transaction id"}, | ||||
| {"include_watchonly", RPCArg::Type::BOOL, | {"include_watchonly", RPCArg::Type::BOOL, | ||||
| /* default */ "false", | /* default */ "true for watch-only wallets, otherwise false", | ||||
| "Whether to include watch-only addresses in balance calculation " | "Whether to include watch-only addresses in balance calculation " | ||||
| "and details[]"}, | "and details[]"}, | ||||
| }, | }, | ||||
| RPCResult{ | RPCResult{ | ||||
| "{\n" | "{\n" | ||||
| " \"amount\" : x.xxx, (numeric) The transaction amount " | " \"amount\" : x.xxx, (numeric) The transaction amount " | ||||
| "in " + | "in " + | ||||
| CURRENCY_UNIT + | CURRENCY_UNIT + | ||||
| ▲ Show 20 Lines • Show All 1,728 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| "object will result in {\"includeWatching\":true}", | "object will result in {\"includeWatching\":true}", | ||||
| { | { | ||||
| {"changeAddress", RPCArg::Type::STR, | {"changeAddress", RPCArg::Type::STR, | ||||
| /* default */ "pool address", | /* default */ "pool address", | ||||
| "The bitcoin address to receive the change"}, | "The bitcoin address to receive the change"}, | ||||
| {"changePosition", RPCArg::Type::NUM, /* default */ "", | {"changePosition", RPCArg::Type::NUM, /* default */ "", | ||||
| "The index of the change output"}, | "The index of the change output"}, | ||||
| {"includeWatching", RPCArg::Type::BOOL, | {"includeWatching", RPCArg::Type::BOOL, | ||||
| /* default */ "false", | /* default */ "true for watch-only wallets, otherwise false", | ||||
| "Also select inputs which are watch only"}, | "Also select inputs which are watch only"}, | ||||
| {"lockUnspents", RPCArg::Type::BOOL, /* default */ "false", | {"lockUnspents", RPCArg::Type::BOOL, /* default */ "false", | ||||
| "Lock selected unspent outputs"}, | "Lock selected unspent outputs"}, | ||||
| {"feeRate", RPCArg::Type::AMOUNT, /* default */ | {"feeRate", RPCArg::Type::AMOUNT, /* default */ | ||||
| "not set: makes wallet determine the fee", | "not set: makes wallet determine the fee", | ||||
| "Set a specific fee rate in " + CURRENCY_UNIT + "/kB"}, | "Set a specific fee rate in " + CURRENCY_UNIT + "/kB"}, | ||||
| { | { | ||||
| "subtractFeeFromOutputs", | "subtractFeeFromOutputs", | ||||
| ▲ Show 20 Lines • Show All 926 Lines • ▼ Show 20 Lines | RPCHelpMan{ | ||||
| "", | "", | ||||
| { | { | ||||
| {"changeAddress", RPCArg::Type::STR_HEX, | {"changeAddress", RPCArg::Type::STR_HEX, | ||||
| /* default */ "pool address", | /* default */ "pool address", | ||||
| "The bitcoin address to receive the change"}, | "The bitcoin address to receive the change"}, | ||||
| {"changePosition", RPCArg::Type::NUM, | {"changePosition", RPCArg::Type::NUM, | ||||
| /* default */ "random", "The index of the change output"}, | /* default */ "random", "The index of the change output"}, | ||||
| {"includeWatching", RPCArg::Type::BOOL, | {"includeWatching", RPCArg::Type::BOOL, | ||||
| /* default */ "false", | /* default */ "true for watch-only wallets, otherwise false", | ||||
| "Also select inputs which are watch only"}, | "Also select inputs which are watch only"}, | ||||
| {"lockUnspents", RPCArg::Type::BOOL, /* default */ "false", | {"lockUnspents", RPCArg::Type::BOOL, /* default */ "false", | ||||
| "Lock selected unspent outputs"}, | "Lock selected unspent outputs"}, | ||||
| {"feeRate", RPCArg::Type::AMOUNT, /* default */ | {"feeRate", RPCArg::Type::AMOUNT, /* default */ | ||||
| "not set: makes wallet determine the fee", | "not set: makes wallet determine the fee", | ||||
| "Set a specific fee rate in " + CURRENCY_UNIT + "/kB"}, | "Set a specific fee rate in " + CURRENCY_UNIT + "/kB"}, | ||||
| { | { | ||||
| "subtractFeeFromOutputs", | "subtractFeeFromOutputs", | ||||
| ▲ Show 20 Lines • Show All 139 Lines • Show Last 20 Lines | |||||