Page MenuHomePhabricator
Differential D8829 Diff 26756 src/wallet/rpcwallet.cpp

Changeset View

Standalone View

View Options

src/wallet/rpcwallet.cpp

Show First 20 Lines • Show All 914 Lines • ▼ Show 20 Lines RPCHelpMan{
HelpRequiringPassphrase(pwallet) + "\n", HelpRequiringPassphrase(pwallet) + "\n",
{ {
{"dummy", RPCArg::Type::STR, RPCArg::Optional::NO, {"dummy", RPCArg::Type::STR, RPCArg::Optional::NO,
"Must be set to \"\" for backwards compatibility.", "\"\""}, "Must be set to \"\" for backwards compatibility.", "\"\""},
{ {
"amounts", "amounts",
RPCArg::Type::OBJ, RPCArg::Type::OBJ,
RPCArg::Optional::NO, RPCArg::Optional::NO,
"A json object with addresses and amounts", "The addresses and amounts",
{ {
{"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, {"address", RPCArg::Type::AMOUNT, RPCArg::Optional::NO,
"The bitcoin address is the key, the numeric amount (can " "The bitcoin address is the key, the numeric amount (can "
"be string) in " + "be string) in " +
CURRENCY_UNIT + " is the value"}, CURRENCY_UNIT + " is the value"},
}, },
}, },
{"minconf", RPCArg::Type::NUM, /* default */ "1", {"minconf", RPCArg::Type::NUM, /* default */ "1",
"Only use the balance confirmed at least this many times."}, "Only use the balance confirmed at least this many times."},
{"comment", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, {"comment", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG,
"A comment"}, "A comment"},
{ {
"subtractfeefrom", "subtractfeefrom",
RPCArg::Type::ARR, RPCArg::Type::ARR,
RPCArg::Optional::OMITTED_NAMED_ARG, RPCArg::Optional::OMITTED_NAMED_ARG,
"A json array with addresses.\n" "The addresses.\n"
" The fee will be equally deducted " " The fee will be equally deducted "
"from the amount of each selected address.\n" "from the amount of each selected address.\n"
" Those recipients will receive less " " Those recipients will receive less "
"bitcoins than you enter in their corresponding amount field.\n" "bitcoins than you enter in their corresponding amount field.\n"
" If no addresses are specified " " If no addresses are specified "
"here, the sender pays the fee.", "here, the sender pays the fee.",
{ {
{"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED, {"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED,
▲ Show 20 Lines • Show All 147 Lines • ▼ Show 20 Lines RPCHelpMan{
{ {
{"nrequired", RPCArg::Type::NUM, RPCArg::Optional::NO, {"nrequired", RPCArg::Type::NUM, RPCArg::Optional::NO,
"The number of required signatures out of the n keys or " "The number of required signatures out of the n keys or "
"addresses."}, "addresses."},
{ {
"keys", "keys",
RPCArg::Type::ARR, RPCArg::Type::ARR,
RPCArg::Optional::NO, RPCArg::Optional::NO,
"A json array of bitcoin addresses or hex-encoded public keys", "The bitcoin addresses or hex-encoded public keys",
{ {
{"key", RPCArg::Type::STR, RPCArg::Optional::OMITTED, {"key", RPCArg::Type::STR, RPCArg::Optional::OMITTED,
"bitcoin address or hex-encoded public key"}, "bitcoin address or hex-encoded public key"},
}, },
}, },
{"label", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG, {"label", RPCArg::Type::STR, RPCArg::Optional::OMITTED_NAMED_ARG,
"A label to assign the addresses to."}, "A label to assign the addresses to."},
}, },
▲ Show 20 Lines • Show All 1,504 Lines • ▼ Show 20 Lines RPCHelpMan{
{ {
{"unlock", RPCArg::Type::BOOL, RPCArg::Optional::NO, {"unlock", RPCArg::Type::BOOL, RPCArg::Optional::NO,
"Whether to unlock (true) or lock (false) the specified " "Whether to unlock (true) or lock (false) the specified "
"transactions"}, "transactions"},
{ {
"transactions", "transactions",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* default */ "empty array", /* default */ "empty array",
"A json array of objects. Each object the txid (string) vout " "The transaction outputs and within each, txid (string) vout "
"(numeric).", "(numeric).",
{ {
{ {
"", "",
RPCArg::Type::OBJ, RPCArg::Type::OBJ,
RPCArg::Optional::OMITTED, RPCArg::Optional::OMITTED,
"", "",
{ {
▲ Show 20 Lines • Show All 829 Lines • ▼ Show 20 Lines RPCHelpMan{
{"minconf", RPCArg::Type::NUM, /* default */ "1", {"minconf", RPCArg::Type::NUM, /* default */ "1",
"The minimum confirmations to filter"}, "The minimum confirmations to filter"},
{"maxconf", RPCArg::Type::NUM, /* default */ "9999999", {"maxconf", RPCArg::Type::NUM, /* default */ "9999999",
"The maximum confirmations to filter"}, "The maximum confirmations to filter"},
{ {
"addresses", "addresses",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* default */ "empty array", /* default */ "empty array",
"A json array of bitcoin addresses to filter", "The bitcoin addresses to filter",
{ {
{"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED, {"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED,
"bitcoin address"}, "bitcoin address"},
}, },
}, },
{"include_unsafe", RPCArg::Type::BOOL, /* default */ "true", {"include_unsafe", RPCArg::Type::BOOL, /* default */ "true",
"Include outputs that are not safe to spend\n" "Include outputs that are not safe to spend\n"
" See description of \"safe\" attribute below."}, " See description of \"safe\" attribute below."},
▲ Show 20 Lines • Show All 406 Lines • ▼ Show 20 Lines RPCHelpMan{
"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",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* default */ "empty array", /* default */ "empty array",
"A json array of integers.\n" "The integers.\n"
" The fee will be equally " " The fee will be equally "
"deducted from the amount of each specified output.\n" "deducted from the amount of each specified output.\n"
" Those recipients will " " Those recipients will "
"receive less bitcoins than you enter in their " "receive less bitcoins than you enter in their "
"corresponding amount field.\n" "corresponding amount field.\n"
" If no outputs are " " If no outputs are "
"specified here, the sender pays the fee.", "specified here, the sender pays the fee.",
{ {
▲ Show 20 Lines • Show All 75 Lines • ▼ Show 20 Lines RPCHelpMan{
HelpRequiringPassphrase(pwallet) + "\n", HelpRequiringPassphrase(pwallet) + "\n",
{ {
{"hexstring", RPCArg::Type::STR, RPCArg::Optional::NO, {"hexstring", RPCArg::Type::STR, RPCArg::Optional::NO,
"The transaction hex string"}, "The transaction hex string"},
{ {
"prevtxs", "prevtxs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
RPCArg::Optional::OMITTED_NAMED_ARG, RPCArg::Optional::OMITTED_NAMED_ARG,
"A json array of previous dependent transaction outputs", "The previous dependent transaction outputs",
{ {
{ {
"", "",
RPCArg::Type::OBJ, RPCArg::Type::OBJ,
RPCArg::Optional::OMITTED, RPCArg::Optional::OMITTED,
"", "",
{ {
{"txid", RPCArg::Type::STR_HEX, {"txid", RPCArg::Type::STR_HEX,
▲ Show 20 Lines • Show All 513 Lines • ▼ Show 20 Lines RPCHelpMan{
{"label", RPCArg::Type::STR, RPCArg::Optional::NO, "The label."}, {"label", RPCArg::Type::STR, RPCArg::Optional::NO, "The label."},
}, },
RPCResult{RPCResult::Type::OBJ_DYN, RPCResult{RPCResult::Type::OBJ_DYN,
"", "",
"json object with addresses as keys", "json object with addresses as keys",
{ {
{RPCResult::Type::OBJ, {RPCResult::Type::OBJ,
"address", "address",
"json object with information about address", "Information about address",
{ {
{RPCResult::Type::STR, "purpose", {RPCResult::Type::STR, "purpose",
"Purpose of address (\"send\" for sending address, " "Purpose of address (\"send\" for sending address, "
"\"receive\" for receiving address)"}, "\"receive\" for receiving address)"},
}}, }},
}}, }},
RPCExamples{HelpExampleCli("getaddressesbylabel", "\"tabby\"") + RPCExamples{HelpExampleCli("getaddressesbylabel", "\"tabby\"") +
HelpExampleRpc("getaddressesbylabel", "\"tabby\"")}, HelpExampleRpc("getaddressesbylabel", "\"tabby\"")},
▲ Show 20 Lines • Show All 318 Lines • ▼ Show 20 Lines RPCHelpMan{
}, },
}, },
}, },
}, },
{ {
"outputs", "outputs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
RPCArg::Optional::NO, RPCArg::Optional::NO,
"a json array with outputs (key-value pairs), where none of " "The outputs (key-value pairs), where none of "
"the keys are duplicated.\n" "the keys are duplicated.\n"
"That is, each address can only appear once and there can only " "That is, each address can only appear once and there can only "
"be one 'data' object.\n" "be one 'data' object.\n"
"For compatibility reasons, a dictionary, which holds the " "For compatibility reasons, a dictionary, which holds the "
"key-value pairs directly, is also\n" "key-value pairs directly, is also\n"
" accepted as second parameter.", " accepted as second parameter.",
{ {
{ {
▲ Show 20 Lines • Show All 49 Lines • ▼ Show 20 Lines RPCHelpMan{
"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",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* default */ "empty array", /* default */ "empty array",
"A json array of integers.\n" "The outputs to subtract the fee from.\n"
" The fee will be equally " " The fee will be equally "
"deducted from the amount of each specified output.\n" "deducted from the amount of each specified output.\n"
" Those recipients will " " Those recipients will "
"receive less bitcoins than you enter in their " "receive less bitcoins than you enter in their "
"corresponding amount field.\n" "corresponding amount field.\n"
" If no outputs are " " If no outputs are "
"specified here, the sender pays the fee.", "specified here, the sender pays the fee.",
{ {
▲ Show 20 Lines • Show All 170 Lines • Show Last 20 Lines