sui-jsonrpc-skill

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Sui JSON-RPC Skill

Sui JSON-RPC 技能

Use this skill to run Sui JSON-RPC operations through

uxc

+ JSON-RPC.

Reuse the

uxc

skill for shared execution and error-handling guidance.

使用本技能可通过

uxc

+ JSON-RPC执行Sui JSON-RPC操作。

复用

uxc

技能以获得通用执行和错误处理指导。

Prerequisites

前提条件

```
uxc
```
is installed and available in
```
PATH
```
.
Network access to
```
https://fullnode.mainnet.sui.io
```
.
No API key is required for the public mainnet fullnode in this skill's default flow.

已安装
```
uxc
```
且其路径已添加至
```
PATH
```
环境变量。
能够访问
```
https://fullnode.mainnet.sui.io
```
网络。
本技能默认流程中的公开主网全节点无需API密钥。

Scope

适用范围

This skill covers a safe read-first Sui JSON-RPC surface:

chain identity and latest checkpoint reads
checkpoint lookup
object lookup
reference gas price reads
latest system state reads
pubsub subscriptions for events and transaction effects

This skill does not cover:

```
unsafe_*
```
transaction-building methods
```
sui_executeTransactionBlock
```
wallet signing flows
custom/private Sui RPC providers with different auth or rate limits

本技能涵盖以只读操作为主的安全Sui JSON-RPC操作范围：

链标识与最新检查点读取
检查点查询
对象查询
参考燃气价格读取
最新系统状态读取
事件与交易结果的pubsub订阅

本技能不涵盖：

```
unsafe_*
```
类交易构建方法
```
sui_executeTransactionBlock
```
钱包签名流程
具有不同认证或速率限制的自定义/私有Sui RPC服务提供商

Endpoint And Discovery

端点与服务发现

This skill targets the public Sui fullnode endpoint:

```
https://fullnode.mainnet.sui.io
```

For pubsub, use a Sui provider WebSocket endpoint that you have verified actually accepts JSON-RPC subscriptions. Do not assume the public HTTPS fullnode host automatically supports the same

wss://

hostname for pubsub.

uxc

JSON-RPC discovery depends on OpenRPC or

rpc.discover

. Sui exposes a discoverable method surface, so help-first flow works directly against the endpoint.

本技能针对公开Sui全节点端点：

```
https://fullnode.mainnet.sui.io
```

对于pubsub，请使用已确认支持JSON-RPC订阅的Sui提供商WebSocket端点。请勿假设公开HTTPS全节点主机自动支持相同的

wss://

主机名用于pubsub。

uxc

的JSON-RPC服务发现依赖于OpenRPC或

rpc.discover

。Sui公开了可发现的方法集，因此“优先帮助”流程可直接作用于该端点。

Authentication

认证

The default public endpoint used by this skill does not require authentication.

If a user later points the same workflow at a private Sui RPC provider, verify its auth model first before reusing this skill unchanged.

本技能使用的默认公开端点无需认证。

如果用户后续将同一工作流指向私有Sui RPC服务提供商，请先验证其认证模型，再复用本技能。

Core Workflow

核心工作流

Use the fixed link command by default:

```
command -v sui-jsonrpc-cli
```

If missing, create it:

uxc link sui-jsonrpc-cli https://fullnode.mainnet.sui.io

```
sui-jsonrpc-cli -h
```

Inspect operation schema first:

sui-jsonrpc-cli sui_getLatestCheckpointSequenceNumber -h

```
sui-jsonrpc-cli sui_getCheckpoint -h
```
```
sui-jsonrpc-cli sui_getObject -h
```

Prefer read/setup validation before any deeper query:

```
sui-jsonrpc-cli sui_getChainIdentifier
```

sui-jsonrpc-cli sui_getLatestCheckpointSequenceNumber

sui-jsonrpc-cli suix_getReferenceGasPrice

Execute with key/value or positional JSON:

key/value:

sui-jsonrpc-cli sui_getCheckpoint id=254502592

positional JSON:

sui-jsonrpc-cli sui_getObject '{"object_id":"0x6"}'

Use

uxc subscribe start

directly for pubsub streams:

uxc subscribe start wss://<verified-sui-rpc-host> suix_subscribeEvent '{"params":[{"Package":"0x2"}]}' --sink file:$HOME/.uxc/subscriptions/sui-events.ndjson

uxc subscribe start wss://<verified-sui-rpc-host> suix_subscribeTransaction '{"params":[{"FromAddress":"0x..."}]}' --sink file:$HOME/.uxc/subscriptions/sui-transactions.ndjson

```
uxc subscribe status <job_id>
```
```
uxc subscribe stop <job_id>
```

默认使用固定链接命令：

```
command -v sui-jsonrpc-cli
```

若不存在，则创建：

uxc link sui-jsonrpc-cli https://fullnode.mainnet.sui.io

```
sui-jsonrpc-cli -h
```

首先检查操作模式：

sui-jsonrpc-cli sui_getLatestCheckpointSequenceNumber -h

```
sui-jsonrpc-cli sui_getCheckpoint -h
```
```
sui-jsonrpc-cli sui_getObject -h
```

在进行深度查询前，优先执行读取/设置验证：

```
sui-jsonrpc-cli sui_getChainIdentifier
```

sui-jsonrpc-cli sui_getLatestCheckpointSequenceNumber

sui-jsonrpc-cli suix_getReferenceGasPrice

使用键值对或位置JSON执行：

键值对：

sui-jsonrpc-cli sui_getCheckpoint id=254502592

位置JSON：

sui-jsonrpc-cli sui_getObject '{"object_id":"0x6"}'

直接使用

uxc subscribe start

处理pubsub流：

uxc subscribe start wss://<verified-sui-rpc-host> suix_subscribeEvent '{"params":[{"Package":"0x2"}]}' --sink file:$HOME/.uxc/subscriptions/sui-events.ndjson

uxc subscribe start wss://<verified-sui-rpc-host> suix_subscribeTransaction '{"params":[{"FromAddress":"0x..."}]}' --sink file:$HOME/.uxc/subscriptions/sui-transactions.ndjson

```
uxc subscribe status <job_id>
```
```
uxc subscribe stop <job_id>
```

Recommended Subscription Operations

Guardrails

防护机制

Keep automation on the JSON output envelope; do not use
```
--text
```
.
Parse stable fields first:
```
ok
```
,
```
kind
```
,
```
protocol
```
,
```
data
```
,
```
error
```
.
Stay on the public read-only method surface by default.
Do not call any
```
unsafe_*
```
methods through this skill without explicit follow-up design and review.
Do not use this skill for write/sign/submit flows; those need separate wallet/auth guidance.
Use
```
uxc subscribe start
```
for pubsub methods; the fixed
```
sui-jsonrpc-cli
```
link is for normal request/response methods.
Subscription jobs should always write to a sink file so events can be inspected and replayed safely.
Before documenting or automating a Sui pubsub host, confirm the specific provider actually exposes JSON-RPC WebSocket subscriptions; public HTTPS endpoints do not guarantee a matching
```
wss://
```
endpoint.
Public RPC availability and rate limits can change over time; if discovery or execution starts failing, re-check the endpoint before assuming a
```
uxc
```
bug.

sui-jsonrpc-cli <operation> ...

is equivalent to

uxc https://fullnode.mainnet.sui.io <operation> ...

自动化操作基于JSON输出格式；请勿使用
```
--text
```
参数。
优先解析稳定字段：
```
ok
```
、
```
kind
```
、
```
protocol
```
、
```
data
```
、
```
error
```
。
默认仅使用公开只读方法集。
在未进行明确的后续设计与审核前，请勿通过本技能调用任何
```
unsafe_*
```
方法。
请勿将本技能用于写入/签名/提交流程；这些流程需要单独的钱包/认证指导。
pubsub方法使用
```
uxc subscribe start
```
；固定的
```
sui-jsonrpc-cli
```
链接用于常规请求/响应方法。
订阅任务应始终写入到输出文件，以便安全地检查和重放事件。
在记录或自动化Sui pubsub主机前，请确认特定提供商确实公开了JSON-RPC WebSocket订阅；公开HTTPS端点不保证存在对应的
```
wss://
```
端点。
公开RPC的可用性和速率限制可能随时间变化；如果服务发现或执行失败，请先重新检查端点，再假设是
```
uxc
```
的问题。

sui-jsonrpc-cli <operation> ...

等同于

uxc https://fullnode.mainnet.sui.io <operation> ...

。

References

参考资料

Usage patterns:
```
references/usage-patterns.md
```
Sui documentation: https://docs.sui.io/

使用模式：
```
references/usage-patterns.md
```
Sui 官方文档：https://docs.sui.io/