BcoinSV ships with bcoin-cli as its default HTTP client for command line access.
Examples:
$ export BCOINSV_API_KEY=hunter2
$ export BCOINSV_NETWORK=main
$ export BCOINSV_URI=http://localhost:8332
$ bcoinsv cli info
$ bcoinsv cli info --api-key=hunter2 --uri=http://localhost
$ echo 'api-key: hunter2' > ~/cli.conf
$ bcoinsv cli info --config=~/cli.conf
$ export BCOINSV_API_KEY=your-api-key
# View the genesis block
$ bcoinsv cli block 0
# View the mempool
$ bcoinsv cli mempool
# View primary wallet
$ bcoinsv wallet get
# View transaction history
$ bcoinsv wallet history
# Send a transaction
$ bcoinsv wallet send [address] 0.01
# View balance
$ bcoinsv wallet balance
# Derive new address
$ bcoinsv wallet address
# Create a new account
$ bcoinsv wallet account create foo
# Send from account
$ bcoinsv wallet send [address] 0.01 --account=foo
RPC examples:
$ bcoinsv rpc getblockchaininfo
$ bcoinsv rpc getwalletinfo
$ bcoinsv rpc getpeerinfo
$ bcoinsv rpc getbalance
$ bcoinsv rpc listtransactions
$ bcoinsv rpc sendtoaddress [address] 0.01
bcoin-cli commands are split into 3 categories: cli, rpc, and wallet.
info
: Get server info.wallets
: List all wallets.wallet create [id]
: Create wallet.broadcast [tx-hex]
: Broadcast transaction.mempool
: Get mempool snapshot.tx [hash/address]
: View transactions.coin [hash+index/address]
: View coins.block [hash/height]
: View block.rescan [height]
: Rescan for transactions.reset [height/hash]
: Reset chain to desired block.resend
: Resend pending transactions.backup [path]
: Backup the wallet db.wallet [command]
: Execute wallet command.rpc [command] [args]
: Execute RPC command.
listen
: Listen for events.get
: View wallet.master
: View wallet master key.shared add [xpubkey]
: Add key to wallet.shared remove [xpubkey]
: Remove key from wallet.balance
: Get wallet balance.history
: View TX history.pending
: View pending TXs.coins
: View wallet coins.account list
: List account names.account create [account-name]
: Create account.account get [account-name]
: Get account details.address
: Derive new receiving address.change
: Derive new change address.retoken
: Create new api key.send [address] [value]
: Send transaction.mktx [address] [value]
: Create transaction.sign [tx-hex]
: Sign transaction.zap [age?]
: Zap pending wallet TXs.tx [hash]
: View transaction details.blocks
: List wallet blocks.block [height]
: View wallet block.view [tx-hex]
: Parse and view transaction.import [wif|hex]
: Import private or public key.watch [address]
: Import an address.key [address]
: Get wallet key by address.dump [address]
: Get wallet key WIF by address.lock
: Lock wallet.unlock [passphrase] [timeout?]
: Unlock wallet.resend
: Resend pending transactions.
BcoinSV implements nearly all bitcoind calls along with some custom calls.
stop
help
getblockchaininfo
getbestblockhash
getblockcount
getblock
getblockhash
getblockheader
getchaintips
getdifficulty
getmempoolancestors
getmempooldescendants
getmempoolentry
getmempoolinfo
getrawmempool
gettxout
gettxoutsetinfo
verifychain
invalidateblock
reconsiderblock
getnetworkhashps
getmininginfo
prioritisetransaction
getwork
getworklp
getblocktemplate
submitblock
setgenerate
getgenerate
generate
generatetoaddress
estimatefee
estimatepriority
estimatesmartfee
estimatesmartpriority
getinfo
validateaddress
createmultisig
verifymessage
signmessagewithprivkey
setmocktime
getconnectioncount
ping
getpeerinfo
addnode
disconnectnode
getaddednodeinfo
getnettotals
getnetworkinfo
setban
listbanned
clearbanned
getrawtransaction
createrawtransaction
decoderawtransaction
decodescript
sendrawtransaction
signrawtransaction
gettxoutproof
verifytxoutproof
fundrawtransaction
resendwallettransactions
abandontransaction
addmultisigaddress
backupwallet
dumpprivkey
dumpwallet
encryptwallet
getaccountaddress
getaccount
getaddressesbyaccount
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaccount
getreceivedbyaddress
gettransaction
getunconfirmedbalance
getwalletinfo
importprivkey
importwallet
importaddress
importprunedfunds
importpubkey
keypoolrefill
listaccounts
listaddressgroupings
listlockunspent
listreceivedbyaccount
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
lockunspent
move
sendfrom
sendmany
sendtoaddress
setaccount
settxfee
signmessage
walletlock
walletpassphrasechange
walletpassphrase
removeprunedfunds
getmemory
selectwallet
setloglevel