Page MenuHomePhabricator
Differential D5517 Diff 17070 src/wallet/rpcwallet.cpp

Changeset View

Standalone View

View Options

src/wallet/rpcwallet.cpp

Show First 20 Lines • Show All 585 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() != 2) {
"\nCreate the signature\n" + "\nCreate the signature\n" +
HelpExampleCli( HelpExampleCli(
"signmessage", "signmessage",
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"my message\"") + "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"my message\"") +
"\nVerify the signature\n" + "\nVerify the signature\n" +
HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4" HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4"
"XX\" \"signature\" \"my " "XX\" \"signature\" \"my "
"message\"") + "message\"") +
"\nAs json rpc\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc( HelpExampleRpc(
"signmessage", "signmessage",
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", \"my message\"")); "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", \"my message\""));
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
▲ Show 20 Lines • Show All 60 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 1 ||
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\"") + "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\"") +
"\nThe amount including unconfirmed transactions, zero " "\nThe amount including unconfirmed transactions, zero "
"confirmations\n" + "confirmations\n" +
HelpExampleCli("getreceivedbyaddress", HelpExampleCli("getreceivedbyaddress",
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" 0") + "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" 0") +
"\nThe amount with at least 6 confirmations\n" + "\nThe amount with at least 6 confirmations\n" +
HelpExampleCli("getreceivedbyaddress", HelpExampleCli("getreceivedbyaddress",
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" 6") + "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" 6") +
"\nAs a json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("getreceivedbyaddress", HelpExampleRpc("getreceivedbyaddress",
"\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", 6")); "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", 6"));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
// the user could have gotten from another RPC command prior to now // the user could have gotten from another RPC command prior to now
pwallet->BlockUntilSyncedToCurrentChain(); pwallet->BlockUntilSyncedToCurrentChain();
▲ Show 20 Lines • Show All 73 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 1 ||
"\nAmount received by the default label with at least 1 " "\nAmount received by the default label with at least 1 "
"confirmation\n" + "confirmation\n" +
HelpExampleCli("getreceivedbylabel", "\"\"") + HelpExampleCli("getreceivedbylabel", "\"\"") +
"\nAmount received at the tabby label including unconfirmed " "\nAmount received at the tabby label including unconfirmed "
"amounts with zero confirmations\n" + "amounts with zero confirmations\n" +
HelpExampleCli("getreceivedbylabel", "\"tabby\" 0") + HelpExampleCli("getreceivedbylabel", "\"tabby\" 0") +
"\nThe amount with at least 6 confirmations\n" + "\nThe amount with at least 6 confirmations\n" +
HelpExampleCli("getreceivedbylabel", "\"tabby\" 6") + HelpExampleCli("getreceivedbylabel", "\"tabby\" 6") +
"\nAs a json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("getreceivedbylabel", "\"tabby\", 6")); HelpExampleRpc("getreceivedbylabel", "\"tabby\", 6"));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
// the user could have gotten from another RPC command prior to now // the user could have gotten from another RPC command prior to now
pwallet->BlockUntilSyncedToCurrentChain(); pwallet->BlockUntilSyncedToCurrentChain();
// Temporary, for ContextualCheckTransactionForCurrentBlock below. Removed // Temporary, for ContextualCheckTransactionForCurrentBlock below. Removed
▲ Show 20 Lines • Show All 66 Lines • ▼ Show 20 Lines if (request.fHelp || (request.params.size() > 3)) {
"\nResult:\n" "\nResult:\n"
"amount (numeric) The total amount in " + "amount (numeric) The total amount in " +
CURRENCY_UNIT + CURRENCY_UNIT +
" received for this wallet.\n" " received for this wallet.\n"
"\nExamples:\n" "\nExamples:\n"
"\nThe total amount in the wallet with 1 or more confirmations\n" + "\nThe total amount in the wallet with 1 or more confirmations\n" +
HelpExampleCli("getbalance", "") + HelpExampleCli("getbalance", "") +
"\nThe total amount in the wallet at least 6 blocks confirmed\n" + "\nThe total amount in the wallet at least 6 blocks confirmed\n" +
HelpExampleCli("getbalance", "\"*\" 6") + "\nAs a json rpc call\n" + HelpExampleCli("getbalance", "\"*\" 6") + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("getbalance", "\"*\", 6")); HelpExampleRpc("getbalance", "\"*\", 6"));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
// the user could have gotten from another RPC command prior to now // the user could have gotten from another RPC command prior to now
pwallet->BlockUntilSyncedToCurrentChain(); pwallet->BlockUntilSyncedToCurrentChain();
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
▲ Show 20 Lines • Show All 111 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 2 ||
"amount:\n" + "amount:\n" +
HelpExampleCli("sendmany", HelpExampleCli("sendmany",
"\"\" " "\"\" "
"\"{\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\":0.01," "\"{\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\":0.01,"
"\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\":0.02}\" " "\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\":0.02}\" "
"1 \"\" " "1 \"\" "
"\"[\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\"," "\"[\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\","
"\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\"]\"") + "\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\"]\"") +
"\nAs a json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("sendmany", HelpExampleRpc("sendmany",
"\"\", " "\"\", "
"\"{\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\":0.01," "\"{\\\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\\\":0.01,"
"\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\":0.02}\"," "\\\"1353tsE8YMTA4EuV7dgUXGjNFf9KpVvKHz\\\":0.02}\","
" 6, \"testing\"")); " 6, \"testing\""));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
▲ Show 20 Lines • Show All 144 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 2 ||
"}\n" "}\n"
"\nExamples:\n" "\nExamples:\n"
"\nAdd a multisig address from 2 addresses\n" + "\nAdd a multisig address from 2 addresses\n" +
HelpExampleCli("addmultisigaddress", HelpExampleCli("addmultisigaddress",
"2 " "2 "
"\"[\\\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\\\"," "\"[\\\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\\\","
"\\\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\\\"]\"") + "\\\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\\\"]\"") +
"\nAs json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("addmultisigaddress", HelpExampleRpc("addmultisigaddress",
"2, " "2, "
"\"[\\\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\\\"," "\"[\\\"16sSauSf5pF2UkUwvKGq4qjNRzBZYqgEL5\\\","
"\\\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\\\"]\""); "\\\"171sgjn4YtPu27adkKGrdDwzRTxnRkBfKV\\\"]\"");
throw std::runtime_error(msg); throw std::runtime_error(msg);
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
▲ Show 20 Lines • Show All 491 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() > 4) {
" }\n" " }\n"
"]\n" "]\n"
"\nExamples:\n" "\nExamples:\n"
"\nList the most recent 10 transactions in the systems\n" + "\nList the most recent 10 transactions in the systems\n" +
HelpExampleCli("listtransactions", "") + HelpExampleCli("listtransactions", "") +
"\nList transactions 100 to 120\n" + "\nList transactions 100 to 120\n" +
HelpExampleCli("listtransactions", "\"*\" 20 100") + HelpExampleCli("listtransactions", "\"*\" 20 100") +
"\nAs a json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("listtransactions", "\"*\", 20, 100")); HelpExampleRpc("listtransactions", "\"*\", 20, 100"));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
// the user could have gotten from another RPC command prior to now // the user could have gotten from another RPC command prior to now
pwallet->BlockUntilSyncedToCurrentChain(); pwallet->BlockUntilSyncedToCurrentChain();
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
▲ Show 20 Lines • Show All 594 Lines • ▼ Show 20 Lines if (pwallet->IsCrypted() && (request.fHelp || request.params.size() != 2)) {
"\nNote:\n" "\nNote:\n"
"Issuing the walletpassphrase command while the wallet is already " "Issuing the walletpassphrase command while the wallet is already "
"unlocked will set a new unlock\n" "unlocked will set a new unlock\n"
"time that overrides the old one.\n" "time that overrides the old one.\n"
"\nExamples:\n" "\nExamples:\n"
"\nUnlock the wallet for 60 seconds\n" + "\nUnlock the wallet for 60 seconds\n" +
HelpExampleCli("walletpassphrase", "\"my pass phrase\" 60") + HelpExampleCli("walletpassphrase", "\"my pass phrase\" 60") +
"\nLock the wallet again (before 60 seconds)\n" + "\nLock the wallet again (before 60 seconds)\n" +
HelpExampleCli("walletlock", "") + "\nAs json rpc call\n" + HelpExampleCli("walletlock", "") + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("walletpassphrase", "\"my pass phrase\", 60")); HelpExampleRpc("walletpassphrase", "\"my pass phrase\", 60"));
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
if (request.fHelp) { if (request.fHelp) {
return true; return true;
▲ Show 20 Lines • Show All 136 Lines • ▼ Show 20 Lines if (pwallet->IsCrypted() && (request.fHelp || request.params.size() != 0)) {
"\nExamples:\n" "\nExamples:\n"
"\nSet the passphrase for 2 minutes to perform a transaction\n" + "\nSet the passphrase for 2 minutes to perform a transaction\n" +
HelpExampleCli("walletpassphrase", "\"my pass phrase\" 120") + HelpExampleCli("walletpassphrase", "\"my pass phrase\" 120") +
"\nPerform a send (requires passphrase set)\n" + "\nPerform a send (requires passphrase set)\n" +
HelpExampleCli("sendtoaddress", HelpExampleCli("sendtoaddress",
"\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 1.0") + "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 1.0") +
"\nClear the passphrase since we are done before 2 minutes is " "\nClear the passphrase since we are done before 2 minutes is "
"up\n" + "up\n" +
HelpExampleCli("walletlock", "") + "\nAs json rpc call\n" + HelpExampleCli("walletlock", "") + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("walletlock", "")); HelpExampleRpc("walletlock", ""));
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
if (request.fHelp) { if (request.fHelp) {
return true; return true;
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Lines if (!pwallet->IsCrypted() &&
"\nEncrypt your wallet\n" + "\nEncrypt your wallet\n" +
HelpExampleCli("encryptwallet", "\"my pass phrase\"") + HelpExampleCli("encryptwallet", "\"my pass phrase\"") +
"\nNow set the passphrase to use the wallet, such as for signing " "\nNow set the passphrase to use the wallet, such as for signing "
"or sending bitcoin\n" + "or sending bitcoin\n" +
HelpExampleCli("walletpassphrase", "\"my pass phrase\"") + HelpExampleCli("walletpassphrase", "\"my pass phrase\"") +
"\nNow we can do something like sign\n" + "\nNow we can do something like sign\n" +
HelpExampleCli("signmessage", "\"address\" \"test message\"") + HelpExampleCli("signmessage", "\"address\" \"test message\"") +
"\nNow lock the wallet again by removing the passphrase\n" + "\nNow lock the wallet again by removing the passphrase\n" +
HelpExampleCli("walletlock", "") + "\nAs a json rpc call\n" + HelpExampleCli("walletlock", "") + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("encryptwallet", "\"my pass phrase\"")); HelpExampleRpc("encryptwallet", "\"my pass phrase\""));
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
if (request.fHelp) { if (request.fHelp) {
return true; return true;
▲ Show 20 Lines • Show All 97 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 1 ||
"\nList the locked transactions\n" + "\nList the locked transactions\n" +
HelpExampleCli("listlockunspent", "") + HelpExampleCli("listlockunspent", "") +
"\nUnlock the transaction again\n" + "\nUnlock the transaction again\n" +
HelpExampleCli("lockunspent", "true " HelpExampleCli("lockunspent", "true "
"\"[{\\\"txid\\\":" "\"[{\\\"txid\\\":"
"\\\"a08e6907dbbd3d809776dbfc5d82e371" "\\\"a08e6907dbbd3d809776dbfc5d82e371"
"b764ed838b5655e72f463568df1aadf0\\\"" "b764ed838b5655e72f463568df1aadf0\\\""
",\\\"vout\\\":1}]\"") + ",\\\"vout\\\":1}]\"") +
"\nAs a json rpc call\n" + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("lockunspent", "false, " HelpExampleRpc("lockunspent", "false, "
"\"[{\\\"txid\\\":" "\"[{\\\"txid\\\":"
"\\\"a08e6907dbbd3d809776dbfc5d82e371" "\\\"a08e6907dbbd3d809776dbfc5d82e371"
"b764ed838b5655e72f463568df1aadf0\\\"" "b764ed838b5655e72f463568df1aadf0\\\""
",\\\"vout\\\":1}]\"")); ",\\\"vout\\\":1}]\""));
} }
// Make sure the results are valid at least up to the most recent block // Make sure the results are valid at least up to the most recent block
▲ Show 20 Lines • Show All 118 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() > 0) {
"\nList the locked transactions\n" + "\nList the locked transactions\n" +
HelpExampleCli("listlockunspent", "") + HelpExampleCli("listlockunspent", "") +
"\nUnlock the transaction again\n" + "\nUnlock the transaction again\n" +
HelpExampleCli("lockunspent", "true " HelpExampleCli("lockunspent", "true "
"\"[{\\\"txid\\\":" "\"[{\\\"txid\\\":"
"\\\"a08e6907dbbd3d809776dbfc5d82e371" "\\\"a08e6907dbbd3d809776dbfc5d82e371"
"b764ed838b5655e72f463568df1aadf0\\\"" "b764ed838b5655e72f463568df1aadf0\\\""
",\\\"vout\\\":1}]\"") + ",\\\"vout\\\":1}]\"") +
"\nAs a json rpc call\n" + HelpExampleRpc("listlockunspent", "")); "\nAs a JSON-RPC call\n" + HelpExampleRpc("listlockunspent", ""));
} }
auto locked_chain = pwallet->chain().lock(); auto locked_chain = pwallet->chain().lock();
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
std::vector<COutPoint> vOutpts; std::vector<COutPoint> vOutpts;
pwallet->ListLockedCoins(vOutpts); pwallet->ListLockedCoins(vOutpts);
▲ Show 20 Lines • Show All 1,279 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() != 1) {
"to be in the wallet.\n" "to be in the wallet.\n"
"\nArguments:\n" "\nArguments:\n"
"1. \"address\" (string, required) The bitcoin " "1. \"address\" (string, required) The bitcoin "
"address to get the information of.\n" "address to get the information of.\n"
"\nResult:\n" "\nResult:\n"
"{\n" "{\n"
" \"address\" : \"address\", (string) The bitcoin address " " \"address\" : \"address\", (string) The bitcoin address "
"validated\n" "validated\n"
" \"scriptPubKey\" : \"hex\", (string) The hex encoded " " \"scriptPubKey\" : \"hex\", (string) The hex-encoded "
"scriptPubKey generated by the address\n" "scriptPubKey generated by the address\n"
" \"ismine\" : true|false, (boolean) If the address is " " \"ismine\" : true|false, (boolean) If the address is "
"yours or not\n" "yours or not\n"
" \"iswatchonly\" : true|false, (boolean) If the address is " " \"iswatchonly\" : true|false, (boolean) If the address is "
"watchonly\n" "watchonly\n"
" \"isscript\" : true|false, (boolean) If the key is a " " \"isscript\" : true|false, (boolean) If the key is a "
"script\n" "script\n"
" \"ischange\" : true|false, (boolean) If the address was " " \"ischange\" : true|false, (boolean) If the address was "
▲ Show 20 Lines • Show All 190 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() > 1) {
" ...\n" " ...\n"
"]\n" "]\n"
"\nExamples:\n" "\nExamples:\n"
"\nList all labels\n" + "\nList all labels\n" +
HelpExampleCli("listlabels", "") + HelpExampleCli("listlabels", "") +
"\nList labels that have receiving addresses\n" + "\nList labels that have receiving addresses\n" +
HelpExampleCli("listlabels", "receive") + HelpExampleCli("listlabels", "receive") +
"\nList labels that have sending addresses\n" + "\nList labels that have sending addresses\n" +
HelpExampleCli("listlabels", "send") + "\nAs json rpc call\n" + HelpExampleCli("listlabels", "send") + "\nAs a JSON-RPC call\n" +
HelpExampleRpc("listlabels", "receive")); HelpExampleRpc("listlabels", "receive"));
} }
LOCK(pwallet->cs_wallet); LOCK(pwallet->cs_wallet);
std::string purpose; std::string purpose;
if (!request.params[0].isNull()) { if (!request.params[0].isNull()) {
purpose = request.params[0].get_str(); purpose = request.params[0].get_str();
▲ Show 20 Lines • Show All 347 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 2 ||
" \"address\": x.xxx, (obj, optional) A key-value pair. " " \"address\": x.xxx, (obj, optional) A key-value pair. "
"The key (string) is the bitcoin address, the value (float or " "The key (string) is the bitcoin address, the value (float or "
"string) is the amount in " + "string) is the amount in " +
CURRENCY_UNIT + CURRENCY_UNIT +
"\n" "\n"
" },\n" " },\n"
" {\n" " {\n"
" \"data\": \"hex\" (obj, optional) A key-value pair. " " \"data\": \"hex\" (obj, optional) A key-value pair. "
"The key must be \"data\", the value is hex encoded data\n" "The key must be \"data\", the value is hex-encoded data\n"
" }\n" " }\n"
" ,... More key-value pairs of the above " " ,... More key-value pairs of the above "
"form. For compatibility reasons, a dictionary, which holds the " "form. 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.\n" " accepted as second parameter.\n"
" ]\n" " ]\n"
"3. locktime (numeric, optional, default=0) Raw " "3. locktime (numeric, optional, default=0) Raw "
"locktime. Non-0 value also locktime-activates inputs\n" "locktime. Non-0 value also locktime-activates inputs\n"
▲ Show 20 Lines • Show All 146 Lines • Show Last 20 Lines