Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix Chinese paragraph rendering #198

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/03-move/02-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ If it is forcibly copied, modified or discarded, the code compilation will go wr
For more information, please refer to the [Understanding Ability](./04-understanding-ability.md) chapter.
:::

Generally speaking, we believe that **the structure with `key` ability is resources**.
Generally speaking, we believe that **the structure with `key` and `store` abilities is resources**.

We modify the code and follow the prompts to add `key` ability.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# 如何使用 Starcoin CLI

`starcoin` 命令可以用来启动节点,运行本地网络,加入测试网络或者主网络,也可以直接连接到远程节点的接口上,纯粹作为命令行客户端工具使用。
运行本地网络或者加入测试网络可以方便地测试用户的智能合约代码,`starcoin` 的子命令 `dev` 可以编译,执行和发布智能合约。
`starcoin` 命令可以用来启动节点,运行本地网络,加入测试网络或者主网络,也可以直接连接到远程节点的接口上,纯粹作为命令行客户端工具使用。运行本地网络或者加入测试网络可以方便地测试用户的智能合约代码,`starcoin` 的子命令 `dev` 可以编译,执行和发布智能合约。

当你按照前面的教程安装好 `starcoin` 后,可以运行 `starcoin -h` 查看帮助。

Expand Down Expand Up @@ -34,16 +33,16 @@ $ starcoin -n dev
Waiting SIGINT or SIGTERM ...
```

此时在上面的控制台输出中可以看到节点的四种 RPC 访问方式
此时在上面的控制台输出中可以看到节点的四种 RPC 访问方式:

* IPC 文件在 .../dev/starcoin.ipc
* HTTP 服务默认运行在 0.0.0.0:9850
* TCP 服务默认运行在 0.0.0.0:9860
* WebSocket 服务默认运行在 0.0.0.0:9870

### 查看链的信息

本地的 dev 模式默认使用一个临时目录,每次重启都会重置数据。
dev 节点启动后,会在日志中打印 IPC 文件路径,我们通过 IPC(进程间通信)文件可以连接到节点执行命令,比如:
本地的 dev 模式默认使用一个临时目录,每次重启都会重置数据。dev 节点启动后,会在日志中打印 IPC 文件路径,我们通过 IPC(进程间通信)文件可以连接到节点执行命令,比如:

```bash
$ starcoin -c /var/folders/_4/1ghtd3z15qjcw8yj905dcql40000gn/T/.tmph3EJ8S/dev/starcoin.ipc chain info
Expand Down Expand Up @@ -156,8 +155,7 @@ starcoin% chain info
}
```

像上面这样进入控制台,如果发现当前尚未启动 Starcoin 节点,则会自动在后台启动一个节点,控制台和节点在进程内通信。
这样的节点生命周期和控制台的生命周期绑定,从控制台退出后,节点也会自动退出。
像上面这样进入控制台,如果发现当前尚未启动 Starcoin 节点,则会自动在后台启动一个节点,控制台和节点在进程内通信。这样的节点生命周期和控制台的生命周期绑定,从控制台退出后,节点也会自动退出。

当然也可以通过 IPC 或者 WebSocket RPC 的方式连接,然后进入控制台。

Expand Down Expand Up @@ -185,9 +183,7 @@ starcoin -c ws://main.seed.starcoin.org:9870 chain info|jq '.ok.head.number'

### Node exit for an unexpected error: file limit the maximum number of open file descriptors is too small, got xxxx, expect greater or equal to 45056

出现这个错误的原因是因为ubuntu系统默认的可打开的最大数量文件描述符不够。
通过一下步骤,将系统的可打开的最大数量文件描述设置为65536即可。
首先,将`DefaultLimitNOFILE=65536`添加到文件`/etc/systemd/system.conf` 和 `/etc/systemd/user.conf`的最末段,然后重启系统即可,最后可以通过`ulimit -n`命令来检查可打开的最大数量文件描述符限制
出现这个错误的原因是因为ubuntu系统默认的可打开的最大数量文件描述符不够。通过一下步骤,将系统的可打开的最大数量文件描述设置为65536即可。首先,将`DefaultLimitNOFILE=65536`添加到文件`/etc/systemd/system.conf` 和 `/etc/systemd/user.conf`的最末段,然后重启系统即可,最后可以通过`ulimit -n`命令来检查可打开的最大数量文件描述符限制

## 选项说明

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

在节点启动的时候进入控制台。

注意:如果不指定存放数据的目录,以这种方式直接进入交互式控制台,会在 `/tmp` 目录下随机生成一个用于存放当前进程的数据目录。
退出交互式控制台,进程结束,存放数据的目录也会立即被删除。
注意:如果不指定存放数据的目录,以这种方式直接进入交互式控制台,会在 `/tmp` 目录下随机生成一个用于存放当前进程的数据目录。退出交互式控制台,进程结束,存放数据的目录也会立即被删除。

```shell
starcoin -n dev console
Expand Down Expand Up @@ -99,8 +98,7 @@ starcoin -c /path/to/starcoin.ipc console
starcoin.exe -c \\.\pipe\starcoin\dev\starcoin.ipc console
```

此时,`starcoin console` 连接到了 IPC 文件对应节点的网络。
可以是 dev、主网、测试网等,取决于启动的节点加入的网络。
此时,`starcoin console` 连接到了 IPC 文件对应节点的网络。可以是 dev、主网、测试网等,取决于启动的节点加入的网络。

### 通过 WebSocket

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ starcoin -c starcoin.ipc dev get-coin -v 100STC

## 工作方式

*dev* 网络的出块模式跟主网和测试网不一样,*dev* 网络是按需出块,没有交易就不出块。
*dev* 网络上的时间不自动流逝,需要通过出块的方式让时间变化。如果想快速跳过时间,进行测试,可以用 `sleep` 命令。
*dev* 网络的出块模式跟主网和测试网不一样,*dev* 网络是按需出块,没有交易就不出块。*dev* 网络上的时间不自动流逝,需要通过出块的方式让时间变化。如果想快速跳过时间,进行测试,可以用 `sleep` 命令。

## 技巧

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ cd starcoin-artifacts/

## 同步区块数据

如果启动一个新的全节点,通常是下载其他节点的主网区块数据到新节点,并以下载的区块数据启动节点。
下载(导出)的区块数据存储在 CSV 文件上,方便数据交换和存储。
如果启动一个新的全节点,通常是下载其他节点的主网区块数据到新节点,并以下载的区块数据启动节点。下载(导出)的区块数据存储在 CSV 文件上,方便数据交换和存储。

### 导出块

Expand Down Expand Up @@ -62,18 +61,15 @@ mkdir ~/bak

### 使用脚本导入区块数据(推荐)

`starcoin` 的仓库中提供了 [`import_block.sh`](https://github.com/starcoinorg/starcoin/blob/master/scripts/import_block.sh) 脚本,预编译版本也打包有相应的脚本。
使用脚本导入区块数据会更加便利,而不必手动导出和导入。
`starcoin` 的仓库中提供了 [`import_block.sh`](https://github.com/starcoinorg/starcoin/blob/master/scripts/import_block.sh) 脚本,预编译版本也打包有相应的脚本。使用脚本导入区块数据会更加便利,而不必手动导出和导入。

```shell
./import_block.sh main ~/.starcoin/main
```

这个脚本接收两个参数,参数1指定网络名称,例如 `main`, `barnard`, `proxima` 或 `halley`,参数2指定数据存储的目录,例如 `~/.starcoin/main` 或任意自定义的路径。
这个脚本会跳过已经有的区块,每获取一个区块都会自动更新进度,中断脚本后再执行会接着原来的高度继续导入。
这个脚本接收两个参数,参数1指定网络名称,例如 `main`, `barnard`, `proxima` 或 `halley`,参数2指定数据存储的目录,例如 `~/.starcoin/main` 或任意自定义的路径。这个脚本会跳过已经有的区块,每获取一个区块都会自动更新进度,中断脚本后再执行会接着原来的高度继续导入。

执行脚本后,就会自动下载主网区块数据到 `~/.starcoin/main` 目录并导入。
等待下载并导入完成,就可以使用这些区块数据运行新的节点了。
执行脚本后,就会自动下载主网区块数据到 `~/.starcoin/main` 目录并导入。等待下载并导入完成,就可以使用这些区块数据运行新的节点了。

注意:使用这个脚本必须保证 `starcoin_db_exporter` 和 `import_block.sh` 在同一路径下。

Expand Down Expand Up @@ -105,9 +101,7 @@ mkdir ~/snapshot
./starcoin_db_exporter export-snapshot -i ~/.starcoin/main -n main -o ~/snapshot -t true
```

通过 `-t` 选项指定是否使用增量导出,`true` 启用,`false` 禁用。
如果要使用增量导出,需要保证 `~/snapshot` 目录下有旧的快照,比如原来 `~/snapshot` 目录下的快照高度为 `1-400w`,现在需要导 `1-500w` 高度的快照。
如果使用了增量导出,则先会把后面 `400w-500w` 高度的快照导出,再与原来的快照合并,以此来节省时间。
通过 `-t` 选项指定是否使用增量导出,`true` 启用,`false` 禁用。如果要使用增量导出,需要保证 `~/snapshot` 目录下有旧的快照,比如原来 `~/snapshot` 目录下的快照高度为 `1-400w`,现在需要导 `1-500w` 高度的快照。如果使用了增量导出,则先会把后面 `400w-500w` 高度的快照导出,再与原来的快照合并,以此来节省时间。

### 导入快照

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## 简介

2021年5月18日,Starcoin 举行全球发布会,在聚光灯的照耀下,宣布启动主网。
这是一个里程碑时刻,意味着 Starcoin 这艘船舶,在区块链的蓝海里,正式扬帆起航。
2021年5月18日,Starcoin 举行全球发布会,在聚光灯的照耀下,宣布启动主网。这是一个里程碑时刻,意味着 Starcoin 这艘船舶,在区块链的蓝海里,正式扬帆起航。

## Windows 加入主网络

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ starcoin_generator -n <CHAIN_NAME>:<CHAIN_ID> --genesis-config <GENESIS_CONFIG>
starcoin_generator -n my_chain:123 --genesis-config halley genesis_config
```

该命令将内置的 `halley` 网络配置作为模板,生成一个名为 `genesis_config.json` 配置文件在 `~/.starcoin/my_chain` 目录下。
可以用编辑器修改 `~/.starcoin/my_chain/genesis_config.json` 文件中的参数。
该命令将内置的 `halley` 网络配置作为模板,生成一个名为 `genesis_config.json` 配置文件在 `~/.starcoin/my_chain` 目录下。可以用编辑器修改 `~/.starcoin/my_chain/genesis_config.json` 文件中的参数。

注:如果不想配置文件生成在默认的 `~/.starcoin/<CHAIN_NAME>` 目录下,也可以通过 `-d` 选项指定目录。

Expand All @@ -47,8 +46,7 @@ starcoin_generator -n my_chain:123 genesis

该命令根据前面生成的创世配置文件来生成创世区块。

上面例子中的创世配置文件是 `~/.starcoin/my_chain/genesis_config.json`。
当然,也可以将 `genesis_config.json` 文件放置在其他位置,然后通过绝对路径指定,比如:
上面例子中的创世配置文件是 `~/.starcoin/my_chain/genesis_config.json`。当然,也可以将 `genesis_config.json` 文件放置在其他位置,然后通过绝对路径指定,比如:

```shell
starcoin_generator -n my_chain:123 --genesis-config /data/conf/my_chain/genesis_config.json genesis
Expand Down
Loading