2018-03-08 17:34:40 -08:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=1200px, shrink-to-fit=yes" >
< meta name = "description" content = "Bitcoin Core RPC Docs - walletlock" >
< meta name = "author" content = "" >
< title > walletlock - Bitcoin Core RPC Docs< / title >
< link href = "./bootstrap.min.css" rel = "stylesheet" >
< / head >
< style >
.card-body {
font-size:80%;
padding-top: 0.5em;
}
pre {
word-break: break-word;
white-space: pre-wrap;
}
< / style >
< body >
< nav class = "navbar navbar-dark bg-dark " >
< a class = "navbar-brand" href = "/" > Bitcoin Core RPC docs< / a >
< / nav >
< main role = "main" class = "container-fluid" style = "margin-top: 1pc;" >
< div class = "row" >
2018-03-08 18:26:01 -08:00
< div class = "col-8 col-lg-9 col-xl-10" >
2018-03-08 17:34:40 -08:00
< h1 > walletlock - Bitcoin RPC< / h1 >
2018-03-09 04:16:57 -08:00
< pre > walletlock
2018-03-08 17:34:40 -08:00
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.
Examples:
Set the passphrase for 2 minutes to perform a transaction
2018-03-08 17:41:52 -08:00
> bitcoin-cli walletpassphrase " my pass phrase" 120
2018-03-08 17:34:40 -08:00
Perform a send (requires passphrase set)
2018-03-08 17:41:52 -08:00
> bitcoin-cli sendtoaddress " 1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" 1.0
2018-03-08 17:34:40 -08:00
Clear the passphrase since we are done before 2 minutes is up
2018-03-08 17:41:52 -08:00
> bitcoin-cli walletlock
2018-03-08 17:34:40 -08:00
As json rpc call
2018-03-08 17:41:52 -08:00
> curl --user myusername --data-binary ' {" jsonrpc" : " 1.0" , " id" :" curltest" , " method" : " walletlock" , " params" : [] }' -H ' content-type: text/plain;' http://127.0.0.1:8332/
2018-03-08 17:34:40 -08:00
2018-03-09 04:16:57 -08:00
< / pre >
< hr >
2018-03-08 17:34:40 -08:00
< p >
This is a website, created out of frustration with uncomplete and outdated Bitcoin Core RPC documentation online.
< / p >
< p >
It was inspired by < a href = "http://chainquery.com/bitcoin-api" > ChainQuery< / a > , which seems to be abandoned. These docs are even simplier, so they can be regenerated by anyone.
< / p >
< p >
Made by < a href = "https://twitter.com/karel_3d" > @karel_3d< / a > ; license of the docs is MIT (see < a href = "https://github.com/bitcoin/bitcoin/" > bitcoin repo< / a > ), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek) (< a href = "https://github.com/bitcoin-rpc/bitcoin-rpc.github.io" > github repo< / a > )
< / p >
< p >
Bitcoin version: 0.16.0.
< / p >
< p >
Note that the RPC is from a regtest node (for completeness), so it includes some additional calls that a regular node doesn't have.
< / p >
< / div >
2018-03-08 18:26:01 -08:00
< div class = "col-4 col-lg-3 col-xl-2" >
2018-03-09 04:16:57 -08:00
< div class = "card" >
< div class = "card-header" >
Blockchain
< / div >
< div class = "card-body" >
< a href = "getbestblockhash.html" > getbestblockhash< / a >
< br >
< a href = "getblock.html" > getblock< / a >
< br >
< a href = "getblockchaininfo.html" > getblockchaininfo< / a >
< br >
< a href = "getblockcount.html" > getblockcount< / a >
< br >
< a href = "getblockhash.html" > getblockhash< / a >
< br >
< a href = "getblockheader.html" > getblockheader< / a >
< br >
< a href = "getchaintips.html" > getchaintips< / a >
< br >
< a href = "getchaintxstats.html" > getchaintxstats< / a >
< br >
< a href = "getdifficulty.html" > getdifficulty< / a >
< br >
< a href = "getmempoolancestors.html" > getmempoolancestors< / a >
< br >
< a href = "getmempooldescendants.html" > getmempooldescendants< / a >
< br >
< a href = "getmempoolentry.html" > getmempoolentry< / a >
< br >
< a href = "getmempoolinfo.html" > getmempoolinfo< / a >
< br >
< a href = "getrawmempool.html" > getrawmempool< / a >
< br >
< a href = "gettxout.html" > gettxout< / a >
< br >
< a href = "gettxoutproof.html" > gettxoutproof< / a >
< br >
< a href = "gettxoutsetinfo.html" > gettxoutsetinfo< / a >
< br >
< a href = "preciousblock.html" > preciousblock< / a >
< br >
< a href = "pruneblockchain.html" > pruneblockchain< / a >
< br >
< a href = "savemempool.html" > savemempool< / a >
< br >
< a href = "verifychain.html" > verifychain< / a >
< br >
< a href = "verifytxoutproof.html" > verifytxoutproof< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Control
< / div >
< div class = "card-body" >
< a href = "getmemoryinfo.html" > getmemoryinfo< / a >
< br >
< a href = "help.html" > help< / a >
< br >
< a href = "logging.html" > logging< / a >
< br >
< a href = "stop.html" > stop< / a >
< br >
< a href = "uptime.html" > uptime< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Generating
< / div >
< div class = "card-body" >
< a href = "generate.html" > generate< / a >
< br >
< a href = "generatetoaddress.html" > generatetoaddress< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Mining
< / div >
< div class = "card-body" >
< a href = "getblocktemplate.html" > getblocktemplate< / a >
< br >
< a href = "getmininginfo.html" > getmininginfo< / a >
< br >
< a href = "getnetworkhashps.html" > getnetworkhashps< / a >
< br >
< a href = "prioritisetransaction.html" > prioritisetransaction< / a >
< br >
< a href = "submitblock.html" > submitblock< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Network
< / div >
< div class = "card-body" >
< a href = "addnode.html" > addnode< / a >
< br >
< a href = "clearbanned.html" > clearbanned< / a >
< br >
< a href = "disconnectnode.html" > disconnectnode< / a >
< br >
< a href = "getaddednodeinfo.html" > getaddednodeinfo< / a >
< br >
< a href = "getconnectioncount.html" > getconnectioncount< / a >
< br >
< a href = "getnettotals.html" > getnettotals< / a >
< br >
< a href = "getnetworkinfo.html" > getnetworkinfo< / a >
< br >
< a href = "getpeerinfo.html" > getpeerinfo< / a >
< br >
< a href = "listbanned.html" > listbanned< / a >
< br >
< a href = "ping.html" > ping< / a >
< br >
< a href = "setban.html" > setban< / a >
< br >
< a href = "setnetworkactive.html" > setnetworkactive< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Rawtransactions
< / div >
< div class = "card-body" >
< a href = "combinerawtransaction.html" > combinerawtransaction< / a >
< br >
< a href = "createrawtransaction.html" > createrawtransaction< / a >
< br >
< a href = "decoderawtransaction.html" > decoderawtransaction< / a >
< br >
< a href = "decodescript.html" > decodescript< / a >
< br >
< a href = "fundrawtransaction.html" > fundrawtransaction< / a >
< br >
< a href = "getrawtransaction.html" > getrawtransaction< / a >
< br >
< a href = "sendrawtransaction.html" > sendrawtransaction< / a >
< br >
< a href = "signrawtransaction.html" > signrawtransaction< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Util
< / div >
< div class = "card-body" >
< a href = "createmultisig.html" > createmultisig< / a >
< br >
< a href = "estimatefee.html" > estimatefee< / a >
< br >
< a href = "estimatesmartfee.html" > estimatesmartfee< / a >
< br >
< a href = "signmessagewithprivkey.html" > signmessagewithprivkey< / a >
< br >
< a href = "validateaddress.html" > validateaddress< / a >
< br >
< a href = "verifymessage.html" > verifymessage< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Wallet
< / div >
< div class = "card-body" >
< a href = "abandontransaction.html" > abandontransaction< / a >
< br >
< a href = "abortrescan.html" > abortrescan< / a >
< br >
< a href = "addmultisigaddress.html" > addmultisigaddress< / a >
< br >
< a href = "backupwallet.html" > backupwallet< / a >
< br >
< a href = "bumpfee.html" > bumpfee< / a >
< br >
< a href = "dumpprivkey.html" > dumpprivkey< / a >
< br >
< a href = "dumpwallet.html" > dumpwallet< / a >
< br >
< a href = "encryptwallet.html" > encryptwallet< / a >
< br >
< a href = "getaccount.html" > getaccount< / a >
< br >
< a href = "getaccountaddress.html" > getaccountaddress< / a >
< br >
< a href = "getaddressesbyaccount.html" > getaddressesbyaccount< / a >
< br >
< a href = "getbalance.html" > getbalance< / a >
< br >
< a href = "getnewaddress.html" > getnewaddress< / a >
< br >
< a href = "getrawchangeaddress.html" > getrawchangeaddress< / a >
< br >
< a href = "getreceivedbyaccount.html" > getreceivedbyaccount< / a >
< br >
< a href = "getreceivedbyaddress.html" > getreceivedbyaddress< / a >
< br >
< a href = "gettransaction.html" > gettransaction< / a >
< br >
< a href = "getunconfirmedbalance.html" > getunconfirmedbalance< / a >
< br >
< a href = "getwalletinfo.html" > getwalletinfo< / a >
< br >
< a href = "importaddress.html" > importaddress< / a >
< br >
< a href = "importmulti.html" > importmulti< / a >
< br >
< a href = "importprivkey.html" > importprivkey< / a >
< br >
< a href = "importprunedfunds.html" > importprunedfunds< / a >
< br >
< a href = "importpubkey.html" > importpubkey< / a >
< br >
< a href = "importwallet.html" > importwallet< / a >
< br >
< a href = "keypoolrefill.html" > keypoolrefill< / a >
< br >
< a href = "listaccounts.html" > listaccounts< / a >
< br >
< a href = "listaddressgroupings.html" > listaddressgroupings< / a >
< br >
< a href = "listlockunspent.html" > listlockunspent< / a >
< br >
< a href = "listreceivedbyaccount.html" > listreceivedbyaccount< / a >
< br >
< a href = "listreceivedbyaddress.html" > listreceivedbyaddress< / a >
< br >
< a href = "listsinceblock.html" > listsinceblock< / a >
< br >
< a href = "listtransactions.html" > listtransactions< / a >
< br >
< a href = "listunspent.html" > listunspent< / a >
< br >
< a href = "listwallets.html" > listwallets< / a >
< br >
< a href = "lockunspent.html" > lockunspent< / a >
< br >
< a href = "move.html" > move< / a >
< br >
< a href = "removeprunedfunds.html" > removeprunedfunds< / a >
< br >
< a href = "rescanblockchain.html" > rescanblockchain< / a >
< br >
< a href = "sendfrom.html" > sendfrom< / a >
< br >
< a href = "sendmany.html" > sendmany< / a >
< br >
< a href = "sendtoaddress.html" > sendtoaddress< / a >
< br >
< a href = "setaccount.html" > setaccount< / a >
< br >
< a href = "settxfee.html" > settxfee< / a >
< br >
< a href = "signmessage.html" > signmessage< / a >
< br >
< a href = "walletlock.html" > walletlock< / a >
< br >
< a href = "walletpassphrase.html" > walletpassphrase< / a >
< br >
< a href = "walletpassphrasechange.html" > walletpassphrasechange< / a >
< br >
< / div >
< / div >
< br >
< / div >
2018-03-08 17:34:40 -08:00
< / div >
2018-03-09 04:16:57 -08:00
< / main >
2018-03-08 17:34:40 -08:00
< / body >
2018-03-09 04:16:57 -08:00
< / html >
