# 长安链cmc工具(pwk)
## 简介
cmc`(ChainMaker Client)`是ChainMaker提供的命令行工具,用于和ChainMaker链进行交互以及生成证书或者密钥等功能。cmc基于go语言编写,通过使用ChainMaker的go语言sdk(使用grpc协议)达到和ChainMaker链进行交互的目的。
cmc的详细日志请查看`./sdk.log`
## 身份模式
长安链在2.1版本以后支持不同身份模式,详情见[身份权限管理](../tech/身份权限管理.md)的身份模式部分。本篇文章中主要是介绍PermissionedWithKey模式,更多模式的cmc使用文档如下:
* PermissionedWithKey
* [PermissionedWithCert](./命令行工具.md)
* [Public](./命令行工具pk.md)
## 编译&配置
cmc工具的编译&运行方式如下:
> 创建工作目录 $WORKDIR 比如 ~/chainmaker
> 启动测试链 [在工作目录下 使用脚本搭建](../recovery/通过命令行工具启动链.html#runUseScripts)
```sh
# 编译cmc
$ cd $WORKDIR/chainmaker-go/tools/cmc
$ go build
# 配置测试数据
$ cp -rf $WORKDIR/chainmaker-go/build/crypto-config $WORKDIR/chainmaker-go/tools/cmc/testdata/ # 使用chainmaker-cryptogen生成的测试链的密钥
# 查看help
$ cd $WORKDIR/chainmaker-go/tools/cmc
$ ./cmc --help
```
## 自定义配置
cmc 依赖 sdk-go 配置文件。
编译&配置 步骤使用的是 [SDK配置模版](https://git.chainmaker.org.cn/chainmaker/sdk-go/-/blob/master/testdata/sdk_config_pwk.yml)
可通过修改 ~/chainmaker/chainmaker-go/tools/cmc/testdata/sdk_config_pwk.yml 实现自定义配置。
比如 `user-signkey-file-path` 参数可设置为普通用户或admin用户的私钥路径。设置后cmc将会以对应用户身份与链建立连接。
其他详细配置项请参看 ~/chainmaker/chainmaker-go/tools/cmc/testdata/sdk_config_pwk.yml 中的注解。
## 功能
cmc提供功能如下:
- [私钥管理](#keyManage):私钥生成功能
- [交易功能](#sendRequest):主要包括链管理、用户合约发布、升级、吊销、冻结、调用、查询等功能
- [查询链上数据](#queryOnChainData):查询链上block和transaction
- [链配置](#chainConfig):查询及更新链配置
- [归档&恢复功能](#archive):将链上数据转移到独立存储上,归档后的数据具备可查询、可恢复到链上的特性
- [线上多签](#multiSign):通过系统合约实现线上多签的请求发起、投票和查询等功能
- [系统合约开放管理](#manage):管理系统合约的开放权限、查询弃用系统合约列表
- [地址转换](#address):根据证书或公钥生成地址
- [交易池](#txpool):交易池相关查询命令
- [gas管理](#gasManagement):gas管理类命令,包括设置 gas admin、充值 gas 等功能
- [交易ID黑名单管理](#txBlackListManage):开启、关闭、添加、删除、查询等功能。命令[参考cert模式](./命令行工具.html#txBlackListManage)
- [链上权限管理](#permissionManage):链上权限策略的新增、修改等功能
- [共识扩展数据管理](#consensusExtManage):链上共识扩展数据的新增、修改等功能
### 示例
#### 私钥管理
生成私钥, 目前支持的算法有 SM2 ECC_P256 未来将支持更多算法。
**参数说明**:
```sh
$ ./cmc key gen -h
Private key generate
Usage:
cmc key gen [flags]
Flags:
-a, --algo string specify key generate algorithm
-h, --help help for gen
-n, --name string specify storage name
-p, --path string specify storage path
```
**示例:**
`$ ./cmc key gen -a ECC_P256 -n ca.key -p ./`
#### 交易功能
##### 用户合约
cmc的交易功能用来发送交易和链进行交互,主要参数说明如下:
```sh
sdk配置文件flag
--sdk-conf-path:指定cmc使用sdk的配置文件路径
admin签名者flags,此类flag的顺序及个数必须保持一致,且至少传入一个admin
--admin-key-file-paths: admin签名者的tls key文件的路径列表. 单签模式下只需要填写一个即可, 离线多签模式下多个需要用逗号分割
比如 ./wx-org1.chainmaker.org/admin/admin.key,./wx-org2.chainmaker.org/admin/admin.key
--admin-org-ids: 指定admin签名者所属的组织Id, 会覆盖sdk配置文件读取的配置
覆盖sdk配置flags,不传则使用sdk配置,如果想覆盖sdk的配置,则以下三个flag都必填
--org-id: 指定发送交易的用户所属的组织Id, 会覆盖sdk配置文件读取的配置
--chain-id: 指定链Id, 会覆盖sdk配置文件读取的配置
--user-signkey-file-path: 指定发送交易的用户sign私钥路径, 会覆盖sdk配置文件读取的配置
其他flags
--byte-code-path:指定合约的wasm文件路径
--contract-name:指定合约名称
--method:指定调用的合约方法名称
--runtime-type:指定合约执行虚拟机环境,如 WASMER | EVM | DOCKER_GO 等
--version:指定合约的版本号,在发布和升级合约时使用
--sync-result:指定是否同步等待交易执行结果,默认为false,如果设置为true,在发送完交易后会主动查询交易执行结果
--params:指定发布合约或调用合约时的参数信息
--concurrency:指定调用合约并发的go routine,用于压力测试
--total-count-per-goroutine:指定单个go routine发送的交易数量,用于压力测试,和--concurrency配合使用
--block-height:指定区块高度
--tx-id:指定交易Id
--with-rw-set:指定获取区块时是否附带读写集,默认是false
--abi-file-path:调用evm合约时需要指定被调用合约的abi文件路径,如:--abi-file-path=./testdata/balance-evm-demo/ledger_balance.abi
```
- 创建wasm合约
```sh
$ ./cmc client contract user create \
--contract-name=fact \
--runtime-type=WASMER \
--byte-code-path=./testdata/claim-wasm-demo/rust-fact-2.0.0.wasm \
--version=1.0 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true \
--params="{}"
```
- 创建evm合约
```sh
$ ./cmc client contract user create \
--contract-name=balance001 \
--runtime-type=EVM \
--byte-code-path=./testdata/balance-evm-demo/ledger_balance.bin \
--abi-file-path=./testdata/balance-evm-demo/ledger_balance.abi \
--version=1.0 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true
```
- 调用wasm合约
```sh
$ ./cmc client contract user invoke \
--contract-name=fact \
--method=save \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--params="{\"file_name\":\"name007\",\"file_hash\":\"ab3456df5799b87c77e7f88\",\"time\":\"6543234\"}" \
--sync-result=true
```
- 调用evm合约
evm的 –params 是一个数组json格式。如下updateBalance有两个形参第一个是uint256类型,第二个是address类型。
10000对应第一个形参uint256的具体值,0xa166c92f4c8118905ad984919dc683a7bdb295c1对应第二个形参address的具体值。
```sh
$ ./cmc client contract user invoke \
--contract-name=balance001 \
--method=updateBalance \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--params="[{\"uint256\": \"10000\"},{\"address\": \"0xa166c92f4c8118905ad984919dc683a7bdb295c1\"}]" \
--sync-result=true \
--abi-file-path=./testdata/balance-evm-demo/ledger_balance.abi
```
- 查询合约
```sh
$ ./cmc client contract user get \
--contract-name=fact \
--method=find_by_file_hash \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--params="{\"file_hash\":\"ab3456df5799b87c77e7f88\"}"
```
- 升级合约
```sh
$ ./cmc client contract user upgrade \
--contract-name=fact \
--runtime-type=WASMER \
--byte-code-path=./testdata/claim-wasm-demo/rust-fact-2.0.0.wasm \
--version=2.0 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--org-id=wx-org1.chainmaker.org \
--sync-result=true \
--params="{}"
```
- 冻结合约
```sh
$ ./cmc client contract user freeze \
--contract-name=fact \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--org-id=wx-org1.chainmaker.org \
--sync-result=true
```
- 解冻合约
```sh
$ ./cmc client contract user unfreeze \
--contract-name=fact \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--org-id=wx-org1.chainmaker.org \
--sync-result=true
```
- 吊销合约
```sh
$ ./cmc client contract user revoke \
--contract-name=fact \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--org-id=wx-org1.chainmaker.org \
--sync-result=true
```
- 合约名转换成合约地址
> --address-type=0 是长安链地址类型;--address-type=1 是至信链地址类型
```sh
$ ./cmc client contract name-to-addr fact --address-type=0
```
#### 查询链上数据
查询链上block和transaction 主要参数说明如下:
```sh
--sdk-conf-path:指定cmc使用sdk的配置文件路径
--chain-id:指定链Id
```
- 根据区块高度查询链上未归档区块
```sh
如果不传 blockheight 表示查询最高区块
./cmc query block-by-height [blockheight] \
--chain-id=chain1 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 根据区块hash查询链上未归档区块
```sh
./cmc query block-by-hash [blockhash] \
--chain-id=chain1 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 根据txid查询链上未归档区块
```sh
./cmc query block-by-txid [txid] \
--chain-id=chain1 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 根据txid查询链上未归档tx
```sh
./cmc query tx [txid] \
--chain-id=chain1 \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
#### 链配置
查询及更新链配置 主要参数说明如下:
```sh
sdk配置文件flag
--sdk-conf-path:指定cmc使用sdk的配置文件路径
admin签名者flags,此类flag的顺序及个数必须保持一致,且至少传入一个admin
--admin-key-file-paths: admin签名者的tls key文件的路径列表. 单签模式下只需要填写一个即可, 离线多签模式下多个需要用逗号分割
比如 ./wx-org1.chainmaker.org/admin/admin.key,./wx-org2.chainmaker.org/admin/admin.key
--admin-org-ids: 指定admin签名者所属的组织Id
覆盖sdk配置flags,不传则使用sdk配置,如果想覆盖sdk的配置,则以下三个flag都必填
--org-id: 指定发送交易的用户所属的组织Id, 会覆盖sdk配置文件读取的配置
--chain-id: 指定链Id, 会覆盖sdk配置文件读取的配置
--user-signkey-file-path: 指定发送交易的用户sign私钥路径, 会覆盖sdk配置文件读取的配置
--block-interval: 出块时间 单位ms
--tx-parameter-size: 交易参数最大限制 单位:MB
--trust-root-org-id: 增加/删除/更新组织管理员公钥时指定的组织Id
--trust-root-path: 管理员公钥目录
--node-id: 增加/删除/更新共识节点Id时指定的节点Id
--node-ids: 增加/更新共识节点Org时指定的节点Id列表
--node-org-id: 增加/删除/更新共识节点Id,Org时指定节点的组织Id
--key-org-id: 指定添加或删除公钥信息所属的组织Id
```
- 查询链配置
```sh
./cmc client chainconfig query \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 查询链权限列表
```sh
./cmc client chainconfig permission list --sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 更新出块时间
```sh
./cmc client chainconfig block updateblockinterval \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--block-interval 1234
```
- 更新交易参数最大值限制
```sh
./cmc client chainconfig block updatetxparametersize \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--tx-parameter-size 10
```
- 增加组织管理员公钥
```sh
./cmc client chainconfig trustroot add \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--trust-root-org-id=wx-org5.chainmaker.org \
--trust-root-path=./testdata/crypto-config/wx-org1.chainmaker.org/user/admin1/admin1.pem
```
- 删除组织管理员公钥
```sh
./cmc client chainconfig trustroot remove \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--trust-root-org-id=wx-org5.chainmaker.org
```
- 更新组织管理员公钥
```sh
./cmc client chainconfig trustroot update \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--trust-root-org-id=wx-org2.chainmaker.org \
--trust-root-path=./testdata/crypto-config/wx-org1.chainmaker.org/user/admin1/admin1.pem
```
- 共识节点node-id计算
```sh
./cmc cert nid --node-pk-path=./testdata/crypto-config/wx-org1.chainmaker.org/node/common1/common1.pem
```
- 添加共识节点Org
```sh
./cmc client chainconfig consensusnodeorg add \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-ids=QmcQHCuAXaFkbcsPUj7e37hXXfZ9DdN7bozseo5oX4qiC4,QmaWrR72CbT51nFVpNDS8NaqUZjVuD4Ezf8xcHcFW9SJWF \
--node-org-id=wx-org5.chainmaker.org
```
- 删除共识节点Org
```sh
./cmc client chainconfig consensusnodeorg remove \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-org-id=wx-org5.chainmaker.org
```
- 更新共识节点Org
```sh
./cmc client chainconfig consensusnodeorg update \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-ids=QmcQHCuAXaFkbcsPUj7e37hXXfZ9DdN7bozseo5oX4qiC4,QmaWrR72CbT51nFVpNDS8NaqUZjVuD4Ezf8xcHcFW9SJWF \
--node-org-id=wx-org5.chainmaker.org
```
- 添加共识节点Id
```sh
./cmc client chainconfig consensusnodeid add \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-id=QmcQHCuAXaFkbcsPUj7e37hXXfZ9DdN7bozseo5oX4qiC4 \
--node-org-id=wx-org5.chainmaker.org
```
- 删除共识节点Id
```sh
./cmc client chainconfig consensusnodeid remove \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-id=QmcQHCuAXaFkbcsPUj7e37hXXfZ9DdN7bozseo5oX4qiC4 \
--node-org-id=wx-org1.chainmaker.org
```
- 更新共识节点Id
```sh
./cmc client chainconfig consensusnodeid update \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--org-id=wx-org1.chainmaker.org \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--node-id=QmXxeLkNTcvySPKMkv3FUqQgpVZ3t85KMo5E4cmcmrexrC \
--node-id-old=QmcQHCuAXaFkbcsPUj7e37hXXfZ9DdN7bozseo5oX4qiC4 \
--node-org-id=wx-org1.chainmaker.org
```
- 公钥身份添加
```sh
./cmc pubkey add \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--chain-id=chain1 --key-org-id=wx-org1.chainmaker.org --role=client \
--pubkey-file-path=./testdata/crypto-config/wx-org3.chainmaker.org/user/client1/client1.pem \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 公钥身份查询
```sh
./cmc pubkey query \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--chain-id=chain1 \
--pubkey-file-path=./testdata/crypto-config/wx-org3.chainmaker.org/user/client1/client1.pem
```
- 公钥身份删除
```sh
./cmc pubkey del \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--chain-id=chain1 --key-org-id=wx-org1.chainmaker.org \
--pubkey-file-path=./testdata/crypto-config/wx-org3.chainmaker.org/user/client1/client1.pem \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 开启/关闭只允许创建者升级合约功能
v2.3.2新功能
```sh
# 开启
./cmc client contract user invoke \
--contract-name=CHAIN_CONFIG \
--method=ENABLE_ONLY_CREATOR_UPGRADE \
--sdk-conf-path=./testdata/sdk_config_pk.yml \
--params="{}" \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true \
--result-to-string=true
# 关闭
./cmc client contract user invoke \
--contract-name=CHAIN_CONFIG \
--method=DISABLE_ONLY_CREATOR_UPGRADE \
--sdk-conf-path=./testdata/sdk_config_pk.yml \
--params="{}" \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true \
--result-to-string=true
```
#### 归档&恢复功能
cmc的归档功能是指将链上数据转移到独立存储上,归档后的数据具备可查询、可恢复到链上的特性。
为了保持数据一致性和防止误操作,cmc实现了分布式锁,同一时刻只允许一个cmc进程进行转储。
cmc支持增量转储和恢复、断点中继转储和恢复,中途退出不影响数据一致性。
##### Dump(在归档中心和链外mysql中选择一种使用)
dump指令从链节点上查询数据,将数据写入到链外存储(当前支持MySQL和归档中心)
- Dump 到链外数据仓库
> 注意:mysql需要设置好 sql_mode 以root用户执行 set global sql_mode = 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION';
- 链外mysql: sdk_config_pwk.yaml
```yml
archive:
type: "mysql"
dest: "root:123456:localhost:3306"
```
- 链外mysql: 数据表设计说明
- 表信息

- 表字段

- Dump归档中心: sdk_config_pwk.yml(推荐使用)
```yml
archive:
type: "archivecenter" # archivecenter 归档中心, mysql mysql数据库
```
- 注册链到归档中心
```shell
# 获取创世区块
./cmc query block-by-height 0 --chain-id=chain1 --sdk-conf-path=./testdata/sdk_config_pwk.yml
# 根据上面获取的创世区块拿到block_hash(如: PnipOpT7Et8m5sqdHuanYIwibSBZmZaXafhublJowVE=)
./cmc util base64tohex PnipOpT7Et8m5sqdHuanYIwibSBZmZaXafhublJowVE=
(获取返回的创世区块hash的hex格式数据: 3e78a93a94fb12df26e6ca9d1ee6a7608c226d205999969769f86e6e5268c151)
```
- 将上面获得的创世区块hash的hex格式数据放到sdk_config_pwk.yml中
```yml
archive_center_config:
chain_genesis_hash: 3e78a93a94fb12df26e6ca9d1ee6a7608c226d205999969769f86e6e5268c151
```
- dump数据
```shell
# 转存区块到链外存储
./cmc archive dump 100 --sdk-conf-path ./testdata/sdk_config_pwk.yml --mode quick
# 查询归档中心当前已归档数据状态
./cmc archive query archived-status --sdk-conf-path ./testdata/sdk_config_pwk.yml
```
##### 节点归档
archive指令向链节点发送清理区块数据命令
```shell
# 查询链上当前已归档数据状态命令
./cmc archive query chain-archived-status --sdk-conf-path ./testdata/sdk_config_pwk.yml
# 清理链上区块数据命令
./cmc archive archive 10000 --timeout 20 --sdk-conf-path ./testdata/sdk_config_pwk.yml
```
##### 节点数据恢复
restore指令从链外存储(MySQL/归档中心)中查询出区块数据,将区块数据恢复到链节点上
```shell
# 恢复链上区块数据命令,恢复到指定高度
./cmc archive restore 3000 --timeout 20 --sdk-conf-path ./testdata/sdk_config_pwk.yml
```
##### 数据仓库数据查询
```shell
# 查询归档中心当前已归档数据状态命令
./cmc archive query archived-status --sdk-conf-path ./testdata/sdk_config_pwk.yml
# 查询归档中心,根据高度查区块命令
./cmc archive query block-by-height 20 --sdk-conf-path ./testdata/sdk_config_pwk.yml
# 查询归档中心,根据txId查询区块命令
./cmc archive query block-by-txid 17221b132a25209aca52fdfc07218265e4377ef0099d46a49edfd032001fc2be --sdk-conf-path ./testdata/sdk_config_pwk.yml
# 查询归档中心,根据txId查询交易命令
./cmc archive query tx 17221b132a25209aca52fdfc07218265e4377ef0099d46a49edfd032001fc2be --sdk-conf-path ./testdata/sdk_config_pwk.yml
# 查询归档中心,根据block hash查询区块命令
./cmc archive query block-by-hash 17221b132a25209aca52fdfc07218265e4377ef0099d46a49edfd032001fc2be --sdk-conf-path ./testdata/sdk_config_pwk.yml
```
#### 线上多签
当合约调用(目前仅适用合约管理场景)需要多个用户同时签名才能生效时,可使用线上多签功能。
线上多签有两个版本,一个是两段式多签,一个是三段式多签:
- 两段式多签的含义是:用户发起多签请求,当投票人完成投票后,会自动触发多签请求的执行。整个过程分成"多签请求"、"多签投票"两个过程。
- 三段式多签的含义是:用户发起多签请求,当投票人完成投票后,多签请求不会被触发执行,需要请求发起人手动触发"多签请求"的执行,整个过程分成"多签请求"、"多签投票"、"多签执行"三个过程。
长安链运行的是"两段式多签"还是"三段式多签"是通过 enable_manual_run 配置项控制的,enable_manual_run = true 表示当前链是使用的三段式多签,enable_manual_run = false 表示使用的是两段式多签。
enable_manual_run 标志位可以写在 bc1.yml 中,作为链初始化的配置,配置方式如下:
```shell
# Virtual machine related settings
vm:
addr_type: 2
support_list:
- "wasmer"
- "gasm"
- "evm"
- "dockergo"
- "wxvm"
native:
multisign:
enable_manual_run: true
```
也可以在运行过程中,通过 cmc 命令动态调节。
主要参数说明如下:
```sh
--sdk-conf-path:指定cmc使用sdk的配置文件路径
--tx-id:指定交易Id
--params:指定发布合约或调用合约时的参数信息
admin签名者flags,此类flag的顺序及个数必须保持一致,且至少传入一个admin
--admin-key-file-paths: admin签名者的tls key文件的路径列表. 单签模式下只需要填写一个即可, 离线多签模式下多个需要用逗号分割
比如 ./wx-org1.chainmaker.org/admin/admin.key,./wx-org2.chainmaker.org/admin/admin.key
--admin-org-ids: 指定admin签名者所属的组织Id
```
- 发起线上多签请求(以创建一个普通的用户合约为例,当参数需要从文件中读取时设置IsFile的值为true)
```sh
./cmc client contract system multi-sign req \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--params="[{\"key\":\"SYS_CONTRACT_NAME\",\"value\":\"CONTRACT_MANAGE\",\"IsFile\":false},{\"key\":\"SYS_METHOD\",\"value\":\"INIT_CONTRACT\",\"IsFile\":false},{\"key\":\"CONTRACT_NAME\",\"value\":\"contract107\",\"IsFile\":false},{\"key\":\"CONTRACT_VERSION\",\"value\":\"1.0\",\"IsFile\":false},{\"key\":\"CONTRACT_BYTECODE\",\"value\":\"./testdata/claim-wasm-demo/rust-fact-2.0.0.wasm\",\"IsFile\":true},{\"key\":\"CONTRACT_RUNTIME_TYPE\",\"value\":\"WASMER\",\"IsFile\":false}]"
```
- 发起线上多签投票
```sh
./cmc client contract system multi-sign vote \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key \
--tx-id=05a0e329c4c94e909575214b41ca516716bd8c83dea94c4c9616dea0910bf719
```
- 触发多签请求执行
```sh
./cmc client contract system multi-sign trig \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--tx-id=05a0e329c4c94e909575214b41ca516716bd8c83dea94c4c9616dea0910bf719 \
--gas-limit=20000
```
- 根据交易Id查询线上多签交易信息
```sh
./cmc client contract system multi-sign query \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--truncate-value-len=1024 \
--truncate-model=truncate \
--tx-id=05a0e329c4c94e909575214b41ca516716bd8c83dea94c4c9616dea0910bf719
```
注意:truncate-value-len=1024 是截断参数,表示如果返回多签请求的长度超过1024,则按照 truncate-model 指定的模式(truncate|empty|hash)进行字符串截取。
- 设置 enable_manual_run 标志位
```sh
./cmc client chainconfig enable-manual-run \
--multi-sign-enable-manual-run=false \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
```
#### 系统合约开放管理
对系统合约的开放权限进行管理功能
主要参数说明如下:
```sh
--sdk-conf-path:指定cmc使用sdk的配置文件路径
--grant-contract-list:指定需要开放的系统合约列表,以逗号分割合约名称
--revoke-contract-list:指定需要弃用的系统合约列表,以逗号分割合约名称
admin签名者flags,此类flag的顺序及个数必须保持一致,且至少传入一个admin
--admin-key-file-paths: admin签名者的tls key文件的路径列表. 单签模式下只需要填写一个即可, 离线多签模式下多个需要用逗号分割
比如 ./wx-org1.chainmaker.org/admin/admin.key,./wx-org2.chainmaker.org/admin/admin.key
--admin-org-ids: 指定admin签名者所属的组织Id, 会覆盖sdk配置文件读取的配置
```
- 开放系统合约
```sh
./cmc client contract system manage access-grant \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--grant-contract-list=DPOS_ERC20,DPOS_STAKE
```
- 弃用系统合约
```sh
./cmc client contract system manage access-revoke \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--revoke-contract-list=DPOS_ERC20,DPOS_STAKE
```
- 查询弃用的系统合约列表
```sh
./cmc client contract system manage access-query \
--sdk-conf-path=./testdata/sdk_config_pwk.yml
```
#### 地址转换
转换成长安链等类型的地址
```sh
--hash-type: 指定根据公钥计算地址时使用的 Hash 算法类型, 默认为 0 ,即SAH256。所支持的 Hash 类型如下:
0: SHA256
1: SHA3_256
2: SM3
```
- 公钥pem转换成地址
```shell
./cmc address pk-to-addr ./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.pem \
--hash-type=0
```
- public key DER hex转换成地址
```shell
./cmc address hex-to-addr 3059301306072a8648ce3d020106082a811ccf5501822d034200044a4c24cf037b0c7a027e634b994a5fdbcd0faa718ce9053e3f75fcb9a865523a605aff92b5f99e728f51a924d4f18d5819c42f9b626bdf6eea911946efe7442d \
--hash-type=0
```
- 合约名转换成地址
```shell
./cmc address name-to-addr my_cool_contract_name
```
#### 交易池
交易池相关查询命令
```sh
--sdk-conf-path:指定cmc使用sdk的配置文件路径
--type:指定查询的交易类型, 默认值 3 。所支持的类型如下:
配置交易类型: 1
普通交易类型: 2
所有交易类型: 3
--stage: 指定查询的交易阶段, 默认值 3 。所支持的阶段如下:
in queue阶段: 1
in pending阶段: 2
所有阶段: 3
--tx-ids: 指定根据tx ids获取交易池中存在的txs, 可指定多个txid用逗号分开
```
- 查询交易池状态
```sh
./cmc txpool status --sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 查询不同交易类型和阶段中的交易Id列表。
```sh
./cmc txpool txids --sdk-conf-path=./testdata/sdk_config_pwk.yml --type=3 --stage=3
```
- 根据txIds获取交易池中存在的txs,并返回交易池缺失的tx的txIds
```sh
./cmc txpool txs --sdk-conf-path=./testdata/sdk_config_pwk.yml \
--tx-ids="00722edd0da0465fbadaadddcd31be20d24575c42e5246e697a0629b649d20e8,ec366ae0b7024d15a74668846007107284e99f9f2f6544d0bf1a3aee11a50712"
```
#### gas管理
gas管理类命令,包括设置 gas admin、充值 gas 等功能
```sh
--sdk-conf-path:指定cmc使用sdk的配置文件路径
--admin-org-ids:多签时,其他admin的组织id,多个时用逗号分开,需要与admin-key-file-paths顺序一致
--admin-key-file-paths:多签时,其他admin的私钥路径,多个时用逗号分开,需要与admin-org-ids顺序一致
```
- 设置 gas admin
```sh
./cmc gas set-admin [gas账号地址。如果不传则默认设置sender为 gas admin] \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 查询 gas admin
```sh
./cmc gas get-admin --sdk-conf-path=./testdata/sdk_config_pwk.yml
```
- 充值 gas
```sh
./cmc gas recharge \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址 \
--amount=1000000
```
- 查询 gas 余额
```sh
./cmc gas get-balance \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址
```
- 退还 gas
```sh
./cmc gas refund \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址 \
--amount=1
```
- 冻结 gas 账户
```sh
./cmc gas frozen \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址
```
- 解冻 gas 账户
```sh
./cmc gas unfrozen \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址
```
- 查询 gas 账户的状态,true:账户可用,false:账户被冻结
```sh
./cmc gas account-status \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--address=账户地址
```
- 设置合约调用时使用的基础 gas 值
```sh
./cmc gas set-base-gas \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--amount=2 \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true
```
- 设置合约调用时用于计算的 gas 价格
```sh
./cmc gas set-invoke-gas-price \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--price=0.2 \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true
```
- 设置合约安装时使用的基础 gas 值
```sh
./cmc gas set-install-base-gas \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--amount=200000 \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true
```
- 设置合约安装时用于计算的 gas 价格
```sh
./cmc gas set-install-gas-price \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--price=0.1 \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key \
--sync-result=true
```
#### 链上权限管理
- 新增权限策略
```sh
新增对合约方法 myContractFuncName 权限策略
允许任何单一ADMIN或CLIENT签名即可调用myContractFuncName
./cmc client chainconfig permission add \
--permission-resource-name=myContractFuncName \
--permission-resource-policy-roleList=ADMIN,CLIENT \
--permission-resource-policy-rule=ANY \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 更新权限策略
```sh
更新对合约方法 myContractFuncName 权限策略
过半ADMIN签名才能调用myContractFuncName
./cmc client chainconfig permission update \
--permission-resource-name=myContractFuncName \
--permission-resource-policy-roleList=ADMIN \
--permission-resource-policy-rule=MAJORITY \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 删除权限策略
```sh
删除对合约方法 myContractFuncName 的权限策略
./cmc client chainconfig permission delete \
--permission-resource-name=myContractFuncName \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 获取链上权限策略列表
```sh
./cmc client chainconfig permission list --sdk-conf-path=./testdata/sdk_config_pwk.yml
```
#### 共识扩展数据管理
- 新增共识扩展数据
```sh
./cmc client chainconfig consensusextra add \
--extra-config-key=test_key \
--extra-config-value=test_value \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 更新共识扩展数据
```sh
./cmc client chainconfig consensusextra update \
--extra-config-key=test_key \
--extra-config-value=new_test_value \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```
- 删除共识扩展数据
```sh
./cmc client chainconfig consensusextra delete \
--extra-config-key=test_key \
--sdk-conf-path=./testdata/sdk_config_pwk.yml \
--admin-org-ids=wx-org1.chainmaker.org,wx-org2.chainmaker.org,wx-org3.chainmaker.org \
--admin-key-file-paths=./testdata/crypto-config/wx-org1.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org2.chainmaker.org/admin/admin.key,./testdata/crypto-config/wx-org3.chainmaker.org/admin/admin.key
```