bitcoin-cliのドキュメントをざっと和訳した

bitcoin-cliのコマンド一覧を探したが、英語のサイトしかなく、これらをメモがてら日本語に訳してみる。

不備があったり、いい訳があったらコメントください。

参考にしたサイトは以下

Original Bitcoin client/API calls list

コマンド一覧

各コマンドに対して、その下にあるのは、引数。

必要な引数に関しては、<,>、オプションに関しては、[,]となっている。

また、メソッド名の後にがついているものは、ウォレットのアンロックが必要。

addmultisigaddress

addmultisigaddress <nrequired> <'["key","key"]'> [account]

Add a nrequired-to-sign multisignature address to the wallet. Each key is a bitcoin address or hex-encoded public key. If [account] is specified, assign address to [account]. Returns a string containing the address.

ウォレットに、nrequired-to-sign multisignature addressを追加する。

それぞれのkeyは、ビットコインアドレスかあるいは、hex-encoded public keyである。

もしaccountが指定された場合、そこにアサインされる。

返り値は、アドレスの文字列

addnode

<node> <add/remove/onetry>

Attempts add or remove from the addnode list or try a connection to once.

addnode listからノードを取り除こうとするか、加えようとするかする。

あるいはnodeへの接続を試みる。

backupwallet

<destination>

Safely copies wallet.dat to destination, which can be a directory or a path with filename.

wallet.datdestinationにコピーする。

createmultisig

<nrequired> <'["key,"key"]'>

Creates a multi-signature address and returns a json object

a multi-signature addressを作成し、json objectを返す。

createrawtransaction

[{"txid":txid,"vout":n},...] {address:amount,...}

与えられたインプットから、Raw Transactionsを作成する。

decoderawtransaction

<hex string>

Produces a human-readable JSON object for a Raw Transactions.

人間が読める形のjsonオブジェクトを返す。

dumpprivkey☆

<bitcoinaddress>

Reveals the private key corresponding to

bitcoinaddressから、該当する秘密鍵を表示する。

dumpwallet☆

<filename>

Exports all wallet private keys to file

全てのウォレットの秘密鍵をファイルに出力する。

encryptwallet

<passphrase>

Encrypts the wallet with .

ウォレットをパスフレーズで暗号化する。

getaccount

<bitcoinaddress>

Returns the account associated with the given address.

ビットコインアドレスに紐ついているアカウント名を取得する。

getaccountaddress

<account>

Returns the current bitcoin address for receiving payments to this account. If does not exist, it will be created along with an associated new address that will be returned.

現在の受け取り用に使えるアドレスを返す。

もしアカウントがなかった場合、新しいアドレスとともに、アカウントが作成される。

getaddednodeinfo

<dns> [node]

Returns information about the given added node, or all added nodes (note that onetry addnodes are not listed here) If dns is false, only a list of added nodes will be provided, otherwise connected information will also be available.

the given added node, or all added nodesに関する情報を返す。

もしdnsがなかった場合、added nodesのリストのみが返ってくる。

そうでなければ、connected informationは、利用可能である。

getaddressesbyaccount

<account>

Returns the list of addresses for the given account.

アカウントに対して、アドレスのリストを返す。

getbalance

[account] [minconf=1]

If [account] is not specified, returns the server's total available balance. If [account] is specified, returns the balance in the account.

もしアカウントが指定されていなければ、全ての残高を返す。

指定されていれば、そのアカウントのものを返す。

getbestblockhash

``

Returns the hash of the best (tip) block in the longest block chain.

getblock

<hash>

Returns information about the block with the given hash.

与えられたハッシュから、blockの情報を渡す。

getblockcount

``

Returns the number of blocks in the longest block chain.

blockの長さを返す。

getblockhash

<index>

Returns hash of block in best-block-chain at ; index 0 is the genesis block

与えられたindexから、best-block-chainを返す。

getblocknumber

``

Deprecated. Removed in version 0.7. Use getblockcount.

もうない。

getblocktemplate

[params]

Returns data needed to construct a block to work on. See BIP_0022 for more info on params.

getconnectioncount

``

Returns the number of connections to other nodes.

現在繋がっている他のnodeの数を返す。

getdifficulty

``

Returns the proof-of-work difficulty as a multiple of the minimum difficulty.

現在のdifficultyを返す。

getgenerate

``

Returns true or false whether bitcoind is currently generating hashes

bitcoindがhashを生成しているかどうかをtrue or falseで返す。

gethashespersec

``

Returns a recent hashes per second performance measurement while generating.

getinfo

``

Returns an object containing various state info.

"WARNING: getinfo is deprecated and will be fully removed in 0.16. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo before upgrading to 0.16"

オブジェクトの情報を返すが、もうすぐなくなるから、getblockchaininfo, getnetworkinfo, getwalletinfoを使うように。

getmemorypool

[data]

Replaced in v0.7.0 with getblocktemplate, submitblock, getrawmempool

もうない。

getmininginfo

``

Returns an object containing mining-related information: blocks currentblocksize currentblocktx difficulty errors generate genproclimit hashespersec pooledtx testnet

getnewaddress

[account]

Returns a new bitcoin address for receiving payments. If [account] is specified payments received with the address will be credited to [account].

新しいアドレスを生成する。もし、アカウントが指定されていればそれを紐つける。

getpeerinfo

``

Returns data about each connected node.

接続されたnodeの情報を返す。

getrawchangeaddress

[account]

Returns a new Bitcoin address, for receiving change. This is for use with raw transactions, NOT normal use.

新しいrawなビットコインアドレスを生成する。これは、raw transactionのためにあり、普通は使わない。

getrawmempool

``

Returns all transaction ids in memory pool

メモリプールにある、全てのトランザクションのIDを返す。

getrawtransaction

<txid> [verbose=0]

Returns raw transaction representation for given transaction id.

トランザクションIDから、raw transaction representationを返す。

getreceivedbyaccount

[account] [minconf=1]

Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24)

全てのアカウントのトータルの金額を返す。balanceとなにが違う?

使用済みのものも表示するということ?

getreceivedbyaddress

<bitcoinaddress> [minconf=1]

Returns the amount received by in transactions with at least [minconf] confirmations. It correctly handles the case where someone has sent to the address in multiple transactions. Keep in mind that addresses are only ever used for receiving transactions. Works only for addresses in the local wallet, external addresses will always show 0.

bitcoinaddressを引数に、そのアドレスが受け取ったアドレスの残高を返す。

内部のアドレスにしか使うことはできない。

minconf=1で、confirmationの数を指定できる。

gettransaction

<txid>

Returns an object about the given transaction containing: "amount" : total amount of the transaction "confirmations" : number of confirmations of the transaction "txid" : the transaction ID "time" : time associated with the transaction[1]. "details" - An array of objects containing: "account" "address" "category" "amount" "fee"

トランザクションIDから、そのトランザクションの情報を返す。

gettxout

<txid> <n> [includemempool=true]

Returns details about an unspent transaction output (UTXO)

未使用のトランザクションアウトプットの詳細を返す。

gettxoutsetinfo

``

Returns statistics about the unspent transaction output (UTXO) set

UTXOに対する統計(?)を返す。

getwork

[data]

If [data] is not specified, returns formatted hash data to work on: "midstate" : precomputed hash state after hashing the first half of the data "data" : block data "hash1" : formatted hash buffer for second hash "target" : little endian hash target If [data] is specified, tries to solve the block and returns true if it was successful.

help

[command]

List commands, or get help for a command.

help

importprivkey☆

<bitcoinprivkey> [label] [rescan=true]

Adds a private key (as returned by dumpprivkey) to your wallet. This may take a while, as a rescan is done, looking for existing transactions. Optional [rescan] parameter added in 0.8.0. Note: There's no need to import public key, as in ECDSA (unlike RSA) this can be computed from private key.

秘密鍵をimportする。

invalidateblock

<hash>

Permanently marks a block as invalid, as if it violated a consensus rule.

ある指定されたブロックを信頼しないようにする。

keypoolrefill☆

``

Fills the keypool, requires wallet passphrase to be set.

?

listaccounts

[minconf=1]

Returns Object that has account names as keys, account balances as values.

アカウントのリストと、それが持っている、残高を返す。

listaddressgroupings

``

Returns all addresses in the wallet and info used for coincontrol.

[
    [
        [
            "address",
            残高(int),
            "account"
        ]
    ],
    [
        [
            "address",
            残高(int),
            "account"
        ]
    ]
]

こんな感じで返ってくる。

listreceivedbyaccount

[minconf=1] [includeempty=false]

Returns an array of objects containing: "account" : the account of the receiving addresses "amount" : total amount received by addresses with this account "confirmations" : number of confirmations of the most recent transaction included

[
  {
    "account": "accountname",
    "amount": 残高(int),
    "confirmations": 63
  }
]

こんな感じで返ってくる。

listreceivedbyaddress

[minconf=1] [includeempty=false]

Returns an array of objects containing: "address" : receiving address "account" : the account of the receiving address "amount" : total amount received by the address "confirmations" : number of confirmations of the most recent transaction included To get a list of accounts on the system, execute bitcoind listreceivedbyaddress 0 true

上のと似た感じだが、少し詳し目のが返ってくる。

listsinceblock

[blockhash] [target-confirmations]

Get all transactions in blocks since block [blockhash], or all transactions if omitted. [target-confirmations] intentionally does not affect the list of returned transactions, but only affects the returned "lastblock" value

もっと詳しく返ってくる。

listtransactions

[account] [count=10] [from=0]

Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided it'll return recent transactions from all accounts.

いっぱい返ってくる。

listunspent

[minconf=1] [maxconf=999999]

Returns array of unspent transaction inputs in the wallet.

ウォレットにある、未使用のトランザクションインプットが返ってくる。

ほぼ残高。

listlockunspent

``

Returns list of temporarily unspendable outputs

一時的に、使えないようにした未使用のトランザクションアウトプット一覧が返ってくる。

lockunspent

<unlock?> [array-of-objects]

Updates list of temporarily unspendable outputs

一時的に、UTXOをLOCKする。

move

<fromaccount> <toaccount> <amount> [minconf=1] [comment]

Move from one account in your wallet to another

アドレスのアカウントを、別のアカウントに移動させる。

sendfrom☆

<fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to]

is a real and is rounded to 8 decimal places. Will send the given amount to the given address, ensuring the account has a valid balance using [minconf] confirmations. Returns the transaction ID if successful (not in JSON object).

送金

sendmany☆

<fromaccount> {address:amount,...} [minconf=1] [comment]

amounts are double-precision floating point numbers

?

sendrawtransaction

<hexstring>

version 0.7 Submits raw transaction (serialized, hex-encoded) to local node and network.

raw transactionってなんなんだ

sendtoaddress☆

<bitcoinaddress> <amount> [comment] [comment-to]

is a real and is rounded to 8 decimal places. Returns the transaction ID if successful.

送金その2

setaccount

<bitcoinaddress> <account>

Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account.

与えられたアカウントを、与えられたアドレスと紐づける。

setgenerate

<generate> [genproclimit]

is true or false to turn generation on or off. Generation is limited to [genproclimit] processors, -1 is unlimited.

使わなさそう。

settxfee

<amount>

is a real and is rounded to the nearest 0.00000001

トランザクション手数料をセットする。

signmessage☆

<bitcoinaddress> <message>

Sign a message with the private key of an address.

署名

signrawtransaction☆

<hexstring> [{"txid":txid,"vout":n,"scriptPubKey":hex},...] [<privatekey1>,...]

Adds signatures to a raw transaction and returns the resulting raw transaction.

raw transactionってなんなんだ

stop

``

Stop bitcoin server.

止める。

submitblock

<hex data> [optional-params-obj]

Attempts to submit new block to network.

新しいブロックをネットワークに送るように試みる。マイナー用?

validateaddress

<bitcoinaddress>

Return information about .

与えられたビットコインアドレスに対する情報を返す。

verifymessage

<bitcoinaddress> <signature> <message>

Verify a signed message.

メッセージを検証する。

walletlock

``

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.

ウォレットから、暗号化キーを取り除く。これをやったら色々とやり直しになる。

walletpassphrase

<passphrase> <timeout>

Stores the wallet decryption key in memory for seconds.

復号化キーを保存する。

walletpassphrasechange

<oldpassphrase> <newpassphrase>

Changes the wallet passphrase from to .

ウォレットのパスフレーズを変更する。