fisco-bcos-cli 0.3.0

FISCO BCOS CLI in Rust.
fisco-bcos-cli-0.3.0 is not a library.

fisco-bcos-cli

Rust 版 FISCO BCOS 可交互式命令行工具。

安装

$ cargo install --force fisco-bcos-cli

此 crate 使用了 TASSL 来处理 TLS 连接，在 Linux 或 Macos 下无需做任何额外操作，其他环境下则需要指定以下环境变量：

  • TASSL_LIB_PATH：lib 库加载路径。
  • TASSL_INCLUDE_PATH：头文件检索路径。
  • TASSL_LIB_KIND：lib 库类型，可用值为：static 或 dylib。

在 Linux 或 Macos 下，如果你已经编译好了 TASSL，也可以通过指定以上环境变量来缩短编译时间。

使用

$ fisco-bcos-cli

执行上述命令，你将进入以下交互页面：

Welcome to Command line tool for FISCO BCOS (V0.3.0). Type help to get help
>>

输入 help，获取帮助信息：

>> help

1. Use set_config function to initialize the environment(e.g., set_config ./config/config.json)
2. Use the below functions to interact with the FISCO BCOS Service: ["get_client_version", "get_block_number", "get_pbft_view", "get_sealer_list", "get_observer_list", "get_consensus_status", "get_sync_status", "get_peers", "get_group_peers", "get_node_id_list", "get_group_list", "get_block_by_hash", "get_block_by_number", "get_block_header_by_hash", "get_block_header_by_number", "get_block_hash_by_number", "get_transaction_by_hash", "get_transaction_by_block_hash_and_index", "get_transaction_by_block_number_and_index", "get_transaction_receipt", "get_pending_transactions", "get_pending_tx_size", "get_code", "get_total_transaction_count", "call", "send_raw_transaction", "send_raw_transaction_and_get_proof", "deploy", "compile", "get_system_config_by_key", "get_transaction_by_hash_with_proof", "get_transaction_receipt_by_hash_with_proof", "generate_group", "start_group", "stop_group", "remove_group", "recover_group", "query_group_status", "get_node_info", "get_batch_receipts_by_block_number_and_range", "get_batch_receipts_by_block_hash_and_range", "system_config:set_value_key", "consensus:add_sealer", "consensus:add_observer", "consensus:remove", "cns:insert", "cns:select_by_name", "cns:select_by_name_and_version", "cns:get_contract_address", "permission:insert", "permission:remove", "permission:query_by_name", "permission:grant_write", "permission:revoke_write", "permission:query_permission", "contract_life_cycle:freeze", "contract_life_cycle:unfreeze", "contract_life_cycle:grant_manager", "contract_life_cycle:get_status", "contract_life_cycle:list_manager", "chain_governance_service:grant_committee_member", "chain_governance_service:revoke_committee_member", "chain_governance_service:list_committee_members", "chain_governance_service:query_committee_member_weight", "chain_governance_service:update_committee_member_weight", "chain_governance_service:query_votes_of_member", "chain_governance_service:query_votes_of_threshold", "chain_governance_service:update_threshold", "chain_governance_service:query_threshold", "chain_governance_service:grant_operator", "chain_governance_service:revoke_operator", "chain_governance_service:list_operators", "chain_governance_service:freeze_account", "chain_governance_service:unfreeze_account", "chain_governance_service:get_account_status", "sql"](e.g., get_block_by_number 0x0)
3. Type help to get help
4. Type CTRL-C or CTRL-D to quit
5. Visit https://github.com/kkawakam/rustyline#actions to get more actions

首先调用 set_config 来设置环境信息（配置信息详情参见：服务配置），比如：

>> set_config ./configs/config.json

而后便可调用帮助信息中列出的方法对链上数据进行交互，比如：

>> get_client_version

Object({"Build Time": String("20210201 10:15:37"), "Build Type": String("Darwin/appleclang/RelWithDebInfo"), "Chain Id": String("1"), "FISCO-BCOS Version": String("2.7.2"), "Git Branch": String("HEAD"), "Git Commit Hash": String("4c8a5bbe44c19db8a002017ff9dbb16d3d28e9da"), "Supported Version": String("2.7.2")})

交互方法的参数信息参见：FISCO BCOS Service。

注意事项：

  • 方法名与参数、参数与参数之间以空格分割（比如：call HelloWorldV4 0x62195d0f77f66c445c4878b845f55d266875705d get），如果某个参数内部有空格（或其它更复杂的格式），使用单引号包裹（比如：send_raw_transaction HelloWorldV4 0x62195d0f77f66c445c4878b845f55d266875705d set 'hello world'）。
  • call、send_raw_transaction、send_raw_transaction_and_get_proof、deploy 方法的签名最后一个参数为 Vec<Token>，在调用时直接将其拆分为多个参数，然后以空格分开即可（比如：send_raw_transaction Person 0x62195d0f77f66c445c4878b845f55d266875705d set 12 Tom）。
  • compile 方法签名的最后一个参数（需要链接的 libraries，该参数可不设置）为 HashMap<String, String>，在调用时请以 JSON 字符串的形式传递（比如：compile HelloWorldV4 '{"MyLibrary": "0x123456..."}'）。
  • generate_group 的参数请以 JSON 字符串的形式传递。

License

Apache-2.0