本手册是为了帮助理解和使用控制台中命令而编写的。另有 PDF版本 方便下载和在线查看。

比特股X控制台命令应用手册

about

用法	about 回车
效果	显示版本号以及客户端的相关信息。
参数	无
传回值	json_object

batch

用法	batch <命令名称> <参数列表> 回车
效果	接收任何指定的命令以及其参数的列表, 并传回执行结果。范例: batch blockchain_get_blockhash [[参数1], [参数2]]
参数	命令名称 (string, 必填): 所指定的命令参数列表 (parameters_list, 必填): 要对该命令所使用的参数列表, 传回的结果将会列出该命令依照选定的个别参数的执行结果。
传回值	variants

blockchain_export_fork_graph

用法	blockchain_export_fork_graph [起始区块] [结束区块] [档案名称] 回车
效果	将分叉资料以graphviz格式输出成文档
参数	起始区块 (uint32_t, 选填, 默认值为1): 所选定范围的第一个区块数结束区块 (uint32_t, 选填, 默认值为 -1): 所选定范围的最后一个区块数 文档名称 (string, 选填, 默认值为 ""): 要储存的档案名称
传回值	std::string
等效命令	export_forks

blockchain_get_account

用法	blockchain_get_account <帐号>回车
效果	获取指定帐号名称或ID的纪录
参数	帐号 (string, 必填): 要获取纪录的帐号名称, ID, 或公钥
传回值	optional_account_record
等效命令	get_account

blockchain_get_asset

用法	blockchain_get_asset <资产>回车
效果	获取指定的资产代号或ID
参数	资产 (string, 必填): 所要获取的资产代号或ID
传回值	optional_asset_record
等效命令	get_asset

blockchain_get_block

用法	blockchain_get_block <区块>回车
效果	借由区块数或ID来指定区块并获取其区块标头(header)信息
参数	区块 (string, 必填): 所要获取的区块数或是ID
传回值	odigest_block
等效命令	get_block, getblock

blockchain_get_block_count

用法	blockchain_get_block_count 回车
效果	传回最长区块链的目前区块数
参数	无
传回值	uint32_t
等效命令	blockchain_get_blockcount, getblockcount

blockchain_get_block_hash

用法	blockchain_get_block_hash <区块数>回车
效果	以索引值(index)指定区块并传回其在最佳区块链中的哈希值
参数	区块数 (uint32_t, 必填): 区块的索引值(index)
传回值	block_id_type
等效命令	blockchain_get_blockhash, getblockhash

blockchain_get_block_signee

用法	blockchain_get_block_signee <区块数>回车
效果	传回签署指定区块的受托人信息
参数	区块数 (uint32_t, 必填): 要传回签署受托人的区块
传回值	string

blockchain_get_block_transactions

用法	blockchain_get_block_transactions <区块>回车
效果	获取指定区块的详细交易信息
参数	区块 (string, 必填): 所要获得信息的区块值或ID
传回值	blockchain_transaction_record_map

blockchain_get_delegate_slot_records

用法	blockchain_get_delegate_slot_records <受托人名称>回车
效果