ZooBC CLIマニュアル

ZooBCのあらゆるトランザクションを構築・署名・送信する、1つのコマンドラインツールです。シンプルなsend-zbcから、マルチシグ、ノード登録、取引所、オンチェーンストレージ、ガバナンスまで、50のコマンドを備えています。デフォルトでは機械が扱いやすい形式（JSONで入力し、JSONで出力）で動作し、人間向けの対話モードも用意しています。

01入手する

Linux x86_64版をダウンロードし、展開して実行するだけです。インストールも依存関係も不要です。

⬇ zoobc-cliをダウンロード（Linux x86_64）

# unpack and put it on your PATH
tar xzf zoobc-cli-linux-x86_64.tar.gz
sudo mv zoobc-cli /usr/local/bin/

# point it at any node or gateway (default: http://localhost:8080)
# https://zoobc.network is the public TestNet gateway, not MainNet
zoobc-cli list --api https://zoobc.network

他のプラットフォームにも今後対応します。現時点では Ubuntu / Linux x86_64 版のみです。

023つの実行方法

zoobc-cli send-zbc <privkey> ZBC_4HFG43GR_… 100000000 --api $API
→ {"transaction_hash":"a5f1…","amount":100000000, …}

zoobc-cli issue-token --verbose --api $API
Sender private key: … · Symbol: … · Name: … · Decimals: …

echo '{"sender_privkey":"…","recipient":"ZBC_…","amount":"100000000"}' \
  | zoobc-cli send-zbc --json-input --api $API

03送信内容を調べる

2つの組み込みコマンドで必要な情報はすべてわかるため、ソースを読む必要はありません。

zoobc-cli list              # every command, grouped by category
zoobc-cli help multisig     # the JSON fields for ONE command

help <cmd>は、各フィールドのキー、必須かどうか、デフォルト値、そしてすぐに編集できるサンプルのJSONオブジェクトを表示します：

multisig, N-of-M multisig SendZBC (inner tx + participant signatures)  (tx type 5)
  sender_privkey    (required) Sender private key (64 hex)
  participants      (required) comma-separated participant ZBC addresses
  min_signatures    (required) required signatures (N of M)
  nonce             (optional) multisig account nonce  [default: 0]
  signer_privkeys   (required) participant keys that sign now
  recipient         (required) inner SendZBC recipient address
  amount            (required) inner SendZBC amount (atomic units)
  inner_fee         (optional) inner SendZBC fee (atomic)  [default: 10000000]
Sample: {"sender_privkey":"…","participants":"…", …}

04共通フラグと規約

金額と価格はすべてアトミック単位の整数です（ZBCは×1e8、トークン量は×10^decimals、注文価格は×1e8）。アドレスは完全なZBC_…文字列でも16進数でも指定できます。不正な入力でツールがクラッシュすることはなく、JSONのエラーオブジェクトを返します(--verboseではテキストのエラー).

05実例

# transfer a colored token
zoobc-cli transfer-token $KEY ZBC_6FINNB6J_… <token_id> 500 --api $API

# register a validator node (owner signs; node key supplies the pubkey; PoOwnership is built for you)
zoobc-cli register-node $OWNER_KEY $NODE_KEY 100000000000 --api $API

# open an N-of-M multisig and sign with your key (others co-sign later)
zoobc-cli multisig $KEY "ZBC_A…,ZBC_B…,ZBC_C…" 2 0 "$KEY" ZBC_A… 100000000 5000000 --api $API

# schedule a vesting/recurring payment: 1 ZBC per fire, 12 fires, monthly
zoobc-cli scheduled-transfer $KEY ZBC_… 0 100000000 2592000 12 0 0 0 0 --api $API

06全50コマンド

すべてのトランザクションについて、バイト単位で正確なボディレイアウトはトランザクションマニュアルに掲載しています。コマンドのフィールドを確認するにはzoobc-cli help <cmd>を実行してください。