mcpField
S
sui-client

sui-client

github.com/mystenlabs开发19356 次安装今天更新
代码仓库

关于 sui-client

面向 Sui 开发者的客户端配置指南,涵盖环境、地址、密钥、代币和交易操作,并提供恢复与排查相关说明。

主要功能

  1. 01配置客户端环境和地址
  2. 02创建并恢复地址
  3. 03查看余额和 Gas 币
  4. 04获取开发网络 SUI
  5. 05使用可编程交易合并币

适用场景

  1. 01首次设置 Sui 命令行客户端
  2. 02切换已配置的 Sui 网络
  3. 03通过助记词恢复地址
  4. 04整理用于 Gas 的币对象

MCP 相关

环境支持时,可查询 Sui 文档 MCP 服务 https://sui.mcp.kapa.ai,以核实指南并补充参考资料未涵盖的信息。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mystenlabs/skills --skill sui-client

安装后在 Claude Code 中输入/sui-client确认已加载。

附带文件evals/evals.json

详细介绍

客户端配置与令牌

MCP 工具: 如果你的环境支持,也请查询 Sui 文档 MCP 服务(https://sui.mcp.kapa.ai),以获取最新解答。使用它进行验证,并了解这些参考文件未涵盖的详细信息。

来源限制: 所有信息均仅来自 docs.sui.io。

配置 Sui 客户端

首次设置

首次运行 sui client 时,系统会提示你创建配置文件。接受默认选项(按 Enter 或输入 Y)。你可以使用 sui client -y 跳过提示。

此操作会生成:

  • 一个新的密钥对和地址
  • 一个 12 个单词的恢复短语(仅显示一次,绝不会保存——请立即保存)
  • 一个 client.yaml 配置文件
配置文件

Sui 将配置存储在:

  • macOS/Linux: ~/.sui/sui_config/client.yaml
  • Windows: %USERPROFILE%\.sui\sui_config\client.yaml

文件包含:

  • 网络环境连接(Mainnet、Testnet、Devnet、Localnet)
  • 当前环境(默认:Testnet)
  • 当前地址
  • 密钥库文件路径
管理环境和地址
命令用途
sui client active-env显示当前网络
sui client active-address显示当前地址
sui client envs列出所有已配置的环境
sui client switch --env devnet切换到其他网络
sui client switch --address <ADDRESS>切换到其他地址
sui client new-address ed25519创建新地址
sui client addresses列出所有本地地址及其别名
sui client balance检查 SUI 令牌余额
sui client gas列出 Gas 币对象
密钥存储

私钥存储在单独的文件中:

  • macOS/Linux: ~/.sui/sui_config/sui.keystore
  • Windows: %USERPROFILE%\.sui\sui_config\sui.keystore

此文件包含以 Base64 编码的私钥。它不同于机器的系统密钥库。

恢复

要通过恢复短语恢复地址:

sui keytool import '<12-WORD-PHRASE>' ed25519

整个短语必须放在单引号内,并按正确顺序输入。

获取 SUI 令牌

在 Testnet 和 Devnet 上进行开发需要 SUI 令牌来支付 Gas。这些网络上的令牌免费且不具有货币价值。

水龙头方式
方式操作
网页水龙头访问 faucet.sui.io,输入地址,选择网络,然后点击 Request SUI
CLI(仅限 Devnet/Localnet)sui client faucet — 仅适用于 Devnet 和 Localnet,不适用于 Testnet
TypeScript SDK使用 @mysten/sui/faucet 中的 requestSuiFromFaucetV2()
Discord加入 Sui Discord,在 #devnet-faucet 或 #testnet-faucet 中使用 !faucet <ADDRESS>
社区水龙头N1Stake 水龙头、SuiLearn 水龙头(速率限制分别计算)

重要:sui client faucet 仅适用于 Devnet 和 Localnet,不适用于 Testnet。要获取 Testnet 令牌,请使用 faucet.sui.io 网页水龙头或上述其他方式。绝不要建议在 Testnet 上使用 sui client faucet。

水龙头设有速率限制。如果达到限制,请等待或尝试使用其他水龙头。

币管理

如果你有许多小额 SUI 币对象,但没有任何单个币的金额足以支付 Gas,请使用 sui client ptb 将它们合并:

# Merge one coin into another
sui client ptb \
  --merge-coins @0xPRIMARY_COIN_ID "[@0xCOIN_TO_MERGE_ID]"

# Merge multiple coins at once
sui client ptb \
  --merge-coins @0xPRIMARY_COIN_ID "[@0xCOIN_A, @0xCOIN_B, @0xCOIN_C]"

从 CLI 执行所有交易操作时,请使用 sui client ptb。避免使用 sui client merge-coin 等旧版辅助命令——它们的组合性较差,并且可能已弃用。更多用法请参阅 ptbs 技能中的 cli.md。

验证余额
sui client balance

也可以使用浏览器:SuiVision(suivision.xyz)或 Suiscan(suiscan.xyz)。

浏览器和数据工具

使用 SuiVision(suivision.xyz)或 Suiscan(suiscan.xyz)检查交易、对象、地址和令牌余额。Sui 为每个网络提供 GraphQL RPC,以便执行丰富的数据查询。使用 sui replay(CLI 内置命令)在本地重新执行过去的交易,以便调试。

规则

  • 写入和读取都提交到同一个 fullnode,以确保一致性。
  • 让钱包管理 gas 预算、gas 价格和币选择。不要在前端硬编码 gas 预算。
  • 对所有 CLI 交易操作使用 sui client ptb,而不要使用旧版单一用途命令(merge-coin、split-coin、transfer 等)。

评论

支持 Markdown