Sui RPC 端点文档 - ERPC

Sui RPC 端点文档

将 ERPC 用作您的 Sui RPC 端点,处理 unary gRPC-web 请求。Sui RPC 是 ERPC 在 Global Edge Blockchain Infrastructure 中提供的 RPC APIs 之一,API key 可以在 ERPC Web Dashboard 中管理。
您可以直接使用与 Solana、Ethereum 和 Avalanche 相同的 RPC key。
请以 Authorization: Bearer <YOUR_API_KEY> 发送 API key。Sui SDK 会在 base URL 后追加服务路径,因此 key 需放在请求头中,而不是 api-key 查询参数中。

端点

使用以下任一 base URL 作为 gRPC-web transport 的 baseUrl:
text
https://edge.erpc.global/sui
text
https://sui.erpc.global
请求为发往 /sui.rpc.v2.<Service>/<Method> 的二进制 gRPC-web(application/grpc-web+proto)POST,每次 unary 调用对应一个未压缩的 protobuf 帧。

示例

以下是 transport 配置示例。
typescript
import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport'

const transport = new GrpcWebFetchTransport({
  baseUrl: 'https://sui.erpc.global', // or https://edge.erpc.global/sui
  format: 'binary',
  meta: { Authorization: 'Bearer <YOUR_API_KEY>' },
})
将该 transport 传给为 Sui gRPC API 生成的 unary 服务客户端。
您可以在 ERPC Web Dashboard 获取和查看 API key。

批量请求

Sui 没有批量请求。每个 HTTP 请求承载一次 unary 调用,并计为一次调用。请求体最大为 1 MiB。

用量计量

用量以 token 计量,token 费率可能因方法而异。每次 unary 调用计为一次调用。

Free 方案限制

在 Free 方案中,您的账户每 10 秒可以发送一个请求。该限制按账户计算,而不是按端点计算,因此发往另一条链的请求也可能计入该限制。过早发送的请求会收到 HTTP 429 响应,retry-after 响应头给出以秒为单位的等待时间。

支持的方法

该端点提供以下 19 个 unary gRPC-web 方法。每个方法都通过 /sui.rpc.v2.<Service>/<Method> 调用,且大小写必须完全一致。
  • LedgerService (5): GetServiceInfo, GetCheckpoint, GetObject, GetTransaction, GetEpoch
  • MovePackageService (4): GetPackage, GetDatatype, GetFunction, ListPackageVersions
  • NameService (2): LookupName, ReverseLookupName
  • SignatureVerificationService (1): VerifySignature
  • StateService (5): GetCoinInfo, GetBalance, ListBalances, ListDynamicFields, ListOwnedObjects
  • TransactionExecutionService (2): ExecuteTransaction, SimulateTransaction
未列出的路径会收到 HTTP 400 响应。不支持原生 gRPC、文本格式的 gRPC-web、流式传输以及 BatchGet* 调用。

响应状态码

HTTP 状态码含义
200unary 调用成功。响应体为 application/grpc-web+proto
400不在“支持的方法”列表中的路径、不是单个未压缩二进制 gRPC-web 帧的请求体,或超过 1 MiB 的请求体
401缺少 API key 或 API key 无效,或不满足该 key 的 IP 或 Origin 限制
405使用了 POST 以外的请求方法
426请求了 WebSocket Upgrade。该端点仅支持 HTTP
429已被限速,包括 Free 方案每 10 秒一个请求的限制。如有 retry-after 响应头,请等待其指定的秒数
502上游调用无法完成:上游响应失败、响应超过 8 MiB、30 秒内未响应,或 grpc-status 不为 0
503服务暂时不可用

Sui RPC 方法和文档

有关标准方法、参数和规范的完整列表,请参阅官方文档。