cloud-cli

CITA-Cloud命令行工具。

安装

有几种不同的安装方法。

直接下载预编译的二进制文件

cldi有预编译好的二进制可执行文件，可以根据使用环境下载对应的文件。 https://github.com/cita-cloud/cloud-cli/releases

如果你不知道如何选择，那么一般来说:

cldi-x86_64-pc-windows-msvc.zip，如果你是在Windows下
cldi-x86_64-unknown-linux-gnu.tar.gz，如果你是在Linux下
cldi-x86_64-apple-darwin.tar.gz，如果你是在MacOS下（非M1）
cldi-aarch64-apple-darwin.tar.gz，如果你是在MacOS下（M1）

如果出现libc相关问题，可以使用musl版。

如果在ARM上，使用aarch64版。

从源码编译

1. 安装Rust

如果你没有Rust环境，可以执行以下命令，通过rustup安装。

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. 编译并安装cloud-cli

更新Rust版本。

# cloud-cli requires rust 1.58 or above
$ rustup update

可以通过GitHub安装。

$ cargo install --git https://github.com/cita-cloud/cloud-cli --branch main

也可以先把项目clone到本地。

$ git clone https://github.com/cita-cloud/cloud-cli
$ cargo install --path cloud-cli

验证安装

$ cldi --version
cldi 0.5.5

快速入门

配置

1. controller和executor的地址

想要与链交互，首先要知道如何访问链。

CITA-Cloud有两个rpc地址，分别是controller和executor微服务。

假设controller的地址为"localhost:50004", executor的地址为"localhost:50002"。

那么我们可以通过-r和-e来告诉cldi如何访问链：

# 注意-r和-e必须在子命令之前
$ cldi -r localhost:50004 -e localhost:50002 get block-number

2. 账户名称

发送交易的命令需要对交易进行签名，我们需要指定签名所使用的账户。 cldi在第一次使用的时候会创建一个名为default的默认账户，用户可以通过-u来指定账户：

# 同样地，-u必须在子命令之前
$ cldi -u Alice send --to <to> --value <value> --data <data>

创建和导入账户相关的命令请参见account。

使用Context管理配置

每次都指定微服务的访问地址和使用的账户名称不太方便，我们可以通过context命令来管理这些配置。

# 创建一个Context
$ cldi -r localhost:50004 -e localhost:50002 -u Alice context save Wonderland
# 将这个Context设为默认
$ cldi context default Wonderland
# 也可以使用-c来切换Context，-c也必须在子命令之前
$ cldi -c Wonderland get block-number
# 列出当前Context信息和已保存的Context
$ cldi context list

交互模式

cldi提供了命令行模式和交互模式，在未传入子命令的时候cldi会进入交互模式。

交互模式与命令行模式的命令是等价的，例如：

$ cldi get block-number

等价于

$ cldi
cldi> get block-number

在交互模式下，用户可以通过-c, -r -e来改变当前会话的Context配置。

# 修改当前会话的全局配置
cldi> -r localhost:50004
# 仅针对这条命令应用这个配置
cldi> -r localhost:50004 get block-number

Q: How to quit cldi?
~~A: :q~~
A: CTRL-D

缩写

cldi提供了很多命令的缩写，这里列举一些：

cldi> get block-number
cldi> get bn

cldi> get system-config
cldi> get sc

cldi> context list
cldi> ctx ls
cldi> ctx l

cldi> account generate --name Alice
cldi> account gen --name Alice
cldi> account g --name Alice
cldi> a g --name Alice

cldi> bench send
cldi> b send

cldi> watch
cldi> w

这些缩写仅为方便用户操作，不作稳定性保证，不建议在脚本中使用。

命令行模式下的补全

cldi completions <shell-name>命令会输出补全脚本，需要添加到, 例如.profile, .bashrc里才能生效。目前支持的shell有：bash, zsh, powershell, fish, elvish。

以bash为例，将下列脚本添加到.bashrc里即可。

source <(cldi completions bash)

使用示例

1.生成账户

如果需要更好的安全性，请加上-p <password>为私钥进行加密。有密码的账户在硬盘上会进行加密存储，并且不会在生成时显示明文私钥。加密后的账户需要经过-p <password>解密才能使用。

cldi> account generate --name Alice
{
  "crypto_type": "SM",
  "address": "0xb7768b2f989eeb9a1c7315aa38fb5fbd68333b8a",
  "public_key": "0x325ef60c3d8a94dd363a83f8b9a1ecbe3583b41aa204709eb0d2a19e7e323571d6d4015e5a049bfd04d3ff661385c36fe2066f9aaf72c943ff4ad1fc15e03e73",
  "secret_key": "0x9d08b671a8f12141c45edbd59e81eaf282a2534505ad0545bb46bf64d642b071"
}

2.创建环境配置

cldi> -r localhost:50004 -e localhost:50002 -u Alice context save Wonderland
# 设为默认环境
cldi> context default Wonderland

3.查询块高

cldi> get block-number
406030

4.查询系统配置

cldi> get system-config
{
  "admin": "0x29222738252b748e4d20a20073d05cd26e87cc00",
  "admin_pre_hash": "0x000000000000000000000000000000000000000000000000000000000000000000",
  "block_interval": 4,
  "block_interval_pre_hash": "0xe010952e2bf9a2da305af49c2598230e0ecbb37c7ece7dbef55031b775dba64f",
  "chain_id": "0x204c9a3301e7e698c45febb5e177ef35a656bb8feb355b6aca85beef5d248c14",
  "chain_id_pre_hash": "0x000000000000000000000000000000000000000000000000000000000000000000",
  "emergency_brake": false,
  "emergency_brake_pre_hash": "0x000000000000000000000000000000000000000000000000000000000000000000",
  "validators": [
    "0x43a8f6a2abd2782e06506695a19693589a53e38a",
    "0x4025800dc70684abd1e3eb89086d21d94f1dbfd8",
    "0x3b0829e9f547cfecfae7fb3d527e8405d4304222"
  ],
  "validators_pre_hash": "0x000000000000000000000000000000000000000000000000000000000000000000",
  "version": 0,
  "version_pre_hash": "0x000000000000000000000000000000000000000000000000000000000000000000"
}

5.创建合约

我们通过cldi create <data>发送创建合约交易。其中<data>是合约的数据，这里以一个计数器合约为例。返回结果为这个创建合约交易的哈希。

cldi> create 0x608060405234801561001057600080fd5b5060f58061001f6000396000f3006080604052600436106053576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff16806306661abd1460585780634f2be91f146080578063d826f88f146094575b600080fd5b348015606357600080fd5b50606a60a8565b6040518082815260200191505060405180910390f35b348015608b57600080fd5b50609260ae565b005b348015609f57600080fd5b5060a660c0565b005b60005481565b60016000808282540192505081905550565b600080819055505600a165627a7a72305820faa1d1f51d7b5ca2b200e0f6cdef4f2d7e44ee686209e300beb1146f40d32dee0029
0xbdeabf94a31c503deb4400fc63aee2a89e8f43d6570ed7ad5cd4f6f2898be0a2

等待交易上链后，通过cldi get receipt <tx-hash>获取交易回执，在交易回执中的contract_addr项查看创建出来的合约的地址。这里为0xf064e32407b6cc412fe33f6ba55f578ac413ecdc

cldi> get receipt 0xbdeabf94a31c503deb4400fc63aee2a89e8f43d6570ed7ad5cd4f6f2898be0a2
{
  "block_number": 406069,
  "contract_addr": "0xf064e32407b6cc412fe33f6ba55f578ac413ecdc",
  "cumulative_quota_used": "0x0000000000000000000000000000000000000000000000000000000000018ed3",
  "error_msg": "",
  "legacy_cita_block_hash": "0x265386a6afc6072f0acb5d32e0fe079e101129041dbfed2bee8872a849e8f7a3",
  "logs": [],
  "logs_bloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
  "quota_used": "0x0000000000000000000000000000000000000000000000000000000000018ed3",
  "state_root": "0x96899ff87f9bed55fd880750c2c51661ee24e14f672a1c9d7ac9573536b8c3f0",
  "tx_hash": "0xbdeabf94a31c503deb4400fc63aee2a89e8f43d6570ed7ad5cd4f6f2898be0a2",
  "tx_index": 0
}

6.调用合约

查询合约数据。当前计数器的值为0。

cldi> call 0xf064e32407b6cc412fe33f6ba55f578ac413ecdc 0x06661abd
0x0000000000000000000000000000000000000000000000000000000000000000

发送交易，使得计数器加一。

cldi> send 0xf064e32407b6cc412fe33f6ba55f578ac413ecdc 0x4f2be91f
0x99e57fdfed555059fa143ad0bc4d8ddc8764f8024fb3b28e880a84667414dec5

等待交易上链后，再次查询，可以看到结果为一，符合预期。

cldi> call 0xf064e32407b6cc412fe33f6ba55f578ac413ecdc 0x06661abd
0x0000000000000000000000000000000000000000000000000000000000000001

更详细的文档参见cloud-cli book。

Name		Name	Last commit message	Last commit date
Latest commit History 439 Commits
.github/workflows		.github/workflows
book		book
src		src
test		test
.dockerignore		.dockerignore
.gitignore		.gitignore
Cargo.toml		Cargo.toml
Cross.toml		Cross.toml
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

cloud-cli

安装

直接下载预编译的二进制文件

从源码编译

1. 安装Rust

2. 编译并安装cloud-cli

验证安装

快速入门

配置

1. controller和executor的地址

2. 账户名称

使用Context管理配置

交互模式

缩写

命令行模式下的补全

使用示例

1.生成账户

2.创建环境配置

3.查询块高

4.查询系统配置

5.创建合约

6.调用合约

About

Releases 16

Packages

Contributors 7

Languages

License

cita-cloud/cloud-cli

Folders and files

Latest commit

History

Repository files navigation

cloud-cli

安装

直接下载预编译的二进制文件

从源码编译

1. 安装Rust

2. 编译并安装cloud-cli

验证安装

快速入门

配置

1. controller和executor的地址

2. 账户名称

使用Context管理配置

交互模式

缩写

命令行模式下的补全

使用示例

1.生成账户

2.创建环境配置

3.查询块高

4.查询系统配置

5.创建合约

6.调用合约

About

Resources

License

Stars

Watchers

Forks

Releases 16

Packages 0

Contributors 7

Languages

Packages