Skip to content

Commit f04fce2

Browse files
committed
docs(SUI): 更新README文档添加资源和安装指南
添加了Move Book和Polymedia Explorer资源链接 补充了SUI安装、本地网络设置和启动的详细指南 包括环境变量设置、命令参数解释和状态保留说明
1 parent 11a298b commit f04fce2

File tree

1 file changed

+139
-0
lines changed
  • docs/02-开发/03-软件/区块链/04-SUI

1 file changed

+139
-0
lines changed

docs/02-开发/03-软件/区块链/04-SUI/README.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,143 @@ SUI 使用 Move 编程语言进行智能合约开发,特别适合处理数字
77

88
[官方网站](https://sui.io/)
99
| [官方文档](https://docs.sui.io/)
10+
| [Move Book](https://move-book.com/)
11+
| [Polymedia Explorer](https://explorer.polymedia.app/)
12+
:::
13+
14+
## 安装
15+
16+
参考 [SUI 安装](https://docs.sui.io/guides/developer/getting-started/sui-install)
17+
18+
### 设置本地网络账户
19+
20+
```text heighline={1,3,5,7,9}
21+
PS C:\Users\YuePlus\Desktop> sui client
22+
Config file ["C:\\Users\\YuePlus\\.sui\\sui_config\\client.yaml"] doesn't exist, do you want to connect to a Sui Full node server [y/N]?
23+
> y
24+
Sui Full node server URL (Defaults to Sui Testnet if not specified) :
25+
> http://127.0.0.1:9000
26+
Environment alias for [http://127.0.0.1:9000] :
27+
> localnet
28+
Select key scheme to generate keypair (0 for ed25519, 1 for secp256k1, 2: for secp256r1):
29+
> 0
30+
Generated new keypair and alias for address with scheme "ed25519" [beautiful-hiddenite: 0x8a6e22d2e910587406f0ebaa110df3279ef9e8aca12f181f8774e5a3044cfe03]
31+
Secret Recovery Phrase : [_____ ____ ____ ___ ____ _____ ____ ____ ____ ___ ____ ____ ]
32+
Client for interacting with the Sui network
33+
```
34+
35+
检查当前环境:
36+
37+
```text
38+
PS C:\Users\YuePlus\Desktop> sui client envs
39+
╭──────────┬───────────────────────┬────────╮
40+
│ alias │ url │ active │
41+
├──────────┼───────────────────────┼────────┤
42+
│ localnet │ http://127.0.0.1:9000 │ * │
43+
╰──────────┴───────────────────────┴────────╯
44+
PS C:\Users\YuePlus\Desktop> sui client active-env
45+
localnet
46+
```
47+
48+
检查当前活动地址:
49+
50+
```
51+
sui client active-address
52+
```
53+
54+
该命令将输出帐户地址,以 `0x` 开头,后跟 64 个字符。
55+
56+
### 启动本地网络
57+
58+
```powershell title="PowerShell"
59+
$env:RUST_LOG="off,sui_node=info"; sui start --with-faucet --force-regenesis
60+
```
61+
62+
在以上命令中:
63+
64+
- `$env:`
65+
用于在 PowerShell 中设置临时环境变量(仅在当前会话有效)。
66+
- `RUST_LOG="off,sui_node=info"`
67+
标志来设置特定的日志记录,这将关闭除 `sui-node` 之外的所有组件的日志记录。
68+
如果需要查看更详细的日志,可以从命令中删除这部分。
69+
- `;` 用于在同一行中分隔多个命令。
70+
- `sui start` 用于启动 SUI 节点。
71+
- `--with-faucet` 开启水龙头服务。
72+
- `--force-regenesis` 强制重新生成创世块。
73+
74+
<details>
75+
<summary>`sui start --help`</summary>
76+
77+
```text
78+
--network.config <CONFIG_DIR>
79+
用于存储网络配置、节点数据库、密钥库的配置目录。
80+
`sui genesis -f --with-faucet` 会生成一个可用于启动该进程的创世配置。
81+
请谨慎使用 `-f` 参数,因为它会覆盖已有的配置目录。
82+
我们可以使用任意由 `sui genesis` 生成的配置目录。
83+
84+
--force-regenesis
85+
每次使用该参数时都会创建一个新的创世块,并且运行之间不会保留状态。
86+
仅在你希望每次运行时都从零开始启动网络时使用此参数。
87+
88+
--with-graphql[=<WITH_GRAPHQL>]
89+
在本地主机启动一个 GraphQL 服务器,默认端口为 127.0.0.1:9125,
90+
或者在指定的端口启动。
91+
当提供特定端口时,请使用等号连接参数和值,例如:`--with-graphql=6125`。
92+
注意:GraphQL 需要有正在运行的 Indexer。
93+
94+
--with-faucet[=<WITH_FAUCET>]
95+
启动一个水龙头服务(faucet),默认地址和端口为 127.0.0.1:9123,
96+
或者在指定的端口启动。
97+
当提供特定端口时,请使用等号连接参数和值,例如:`--with-faucet=6123`。
98+
99+
--with-indexer[=<WITH_INDEXER>]
100+
启动一个 Indexer,默认地址和端口为 0.0.0.0:9124,
101+
或者在指定的端口启动。
102+
当提供特定端口时,请使用等号连接参数和值,例如:`--with-indexer=6124`。
103+
Indexer 会以写入模式和读取模式启动。
104+
105+
--fullnode-rpc-port <FULLNODE_RPC_PORT>
106+
启动 Fullnode RPC 服务器的端口。默认端口是 9000。
107+
108+
--pg-port <PG_PORT>
109+
Indexer 使用的 Postgres 数据库端口。默认端口是 5432。
110+
111+
--pg-host <PG_HOST>
112+
Indexer 使用的 Postgres 数据库主机名。默认主机是 localhost。
113+
114+
--pg-db-name <PG_DB_NAME>
115+
Indexer 使用的 Postgres 数据库名称。默认数据库名称是 sui_indexer。
116+
117+
--pg-user <PG_USER>
118+
Indexer 使用的 Postgres 数据库用户名。默认用户名是 postgres。
119+
120+
--pg-password <PG_PASSWORD>
121+
Indexer 使用的 Postgres 数据库密码。默认密码是 postgrespw。
122+
123+
--epoch-duration-ms <EPOCH_DURATION_MS>
124+
设置 epoch 的持续时间。仅当同时传入 `--force-regenesis` 参数,
125+
或者没有现有创世配置(系统会自动生成)时才能使用此参数。
126+
当未设置该参数但传入了 `--force-regenesis` 时,epoch 持续时间将默认为 60 秒。
127+
128+
--no-full-node
129+
启动网络时不包含 fullnode。
130+
131+
-h, --help
132+
打印帮助信息(查看更多请使用 `--help`)。
133+
```
134+
135+
</details>
136+
137+
### 保留本地网络状态
138+
139+
140+
默认情况下,当使用 `sui start` 命令时,如果 `~/.sui/sui_config` 文件夹存在并包含 `genesis.blob` 文件,该命令将使用现有的创世配置和网络配置。
141+
如果该文件夹不存在,命令会创建文件夹并生成新的创世配置。
142+
如果你传入 `--network.config` 参数,命令会检查网络配置文件并尝试根据网络配置文件加载创世块。
143+
144+
当你在不使用 `--force-regenesis` 标志的情况下停止并重新启动网络时,所有历史记录都会被保留并可访问。
145+
146+
:::info
147+
要生成自定义创世配置,请使用 `sui genesis` 命令并传入所需的自定义值。
148+
有关可能的标志和选项的更多信息,请运行 `sui genesis --help`
10149
:::

0 commit comments

Comments
 (0)