Bcoin ships with bcoin-cli as its default HTTP client for command line access.
Examples:
$ export BCOIN_API_KEY=hunter2
$ export BCOIN_NETWORK=main
$ export BCOIN_URI=http://localhost:8332
$ bcoin cli info$ bcoin cli info --api-key=hunter2 --uri=http://localhost$ echo 'api-key: hunter2' > ~/cli.conf
$ bcoin cli info --config=~/cli.conf$ export BCOIN_API_KEY=your-api-key
# View the genesis block
$ bcoin cli block 0
# View the mempool
$ bcoin cli mempool
# View primary wallet
$ bcoin wallet get
# View transaction history
$ bcoin wallet history
# Send a transaction
$ bcoin wallet send [address] 0.01
# View balance
$ bcoin wallet balance
# Derive new address
$ bcoin wallet address
# Create a new account
$ bcoin wallet account create foo
# Send from account
$ bcoin wallet send [address] 0.01 --account=fooRPC examples:
$ bcoin rpc getblockchaininfo
$ bcoin rpc getwalletinfo
$ bcoin rpc getpeerinfo
$ bcoin rpc getbalance
$ bcoin rpc listtransactions
$ bcoin rpc sendtoaddress [address] 0.01bcoin-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.nested: Derive new nested 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.
Bcoin implements nearly all bitcoind calls along with some custom calls.
stophelpgetblockchaininfogetbestblockhashgetblockcountgetblockgetblockhashgetblockheadergetchaintipsgetdifficultygetmempoolancestorsgetmempooldescendantsgetmempoolentrygetmempoolinfogetrawmempoolgettxoutgettxoutsetinfoverifychaininvalidateblockreconsiderblockgetnetworkhashpsgetmininginfoprioritisetransactiongetworkgetworklpgetblocktemplatesubmitblocksetgenerategetgenerategenerategeneratetoaddressestimatefeeestimatepriorityestimatesmartfeeestimatesmartprioritygetinfovalidateaddresscreatemultisigcreatewitnessaddressverifymessagesignmessagewithprivkeysetmocktimegetconnectioncountpinggetpeerinfoaddnodedisconnectnodegetaddednodeinfogetnettotalsgetnetworkinfosetbanlistbannedclearbannedgetrawtransactioncreaterawtransactiondecoderawtransactiondecodescriptsendrawtransactionsignrawtransactiongettxoutproofverifytxoutprooffundrawtransactionresendwallettransactionsabandontransactionaddmultisigaddressaddwitnessaddressbackupwalletdumpprivkeydumpwalletencryptwalletgetaccountaddressgetaccountgetaddressesbyaccountgetbalancegetnewaddressgetrawchangeaddressgetreceivedbyaccountgetreceivedbyaddressgettransactiongetunconfirmedbalancegetwalletinfoimportprivkeyimportwalletimportaddressimportprunedfundsimportpubkeykeypoolrefilllistaccountslistaddressgroupingslistlockunspentlistreceivedbyaccountlistreceivedbyaddresslistsinceblocklisttransactionslistunspentlockunspentmovesendfromsendmanysendtoaddresssetaccountsettxfeesignmessagewalletlockwalletpassphrasechangewalletpassphraseremoveprunedfundsgetmemoryselectwalletsetloglevel