Skip to main content

Sui gRPC

Sui gRPC is the preferred full node API for backend systems. The Sui gRPC guide describes it as the replacement path for JSON-RPC data access, while the Full Node gRPC protocol defines services such as LedgerService, StateService, TransactionExecutionService, and SubscriptionService.

Service map

ServiceTypical call pathUse case
LedgerServicecheckpoint and transaction readsHealth checks, latest checkpoint, transaction lookup.
StateServiceobject lookupBackend object reads and cache warmup.
TransactionExecutionServicedry-run, execute, submitSimulation and transaction submission pipelines.
SubscriptionServicestreaming checkpoints/eventsIndexers and low-latency processors.
info

Run gRPC on HTTP/2 port 9000 inside your trusted network. If an external team needs access, front it with a gateway that enforces TLS, client identity, quotas, and request logging.

Client behavior

  • Set deadlines on every unary request.
  • Reconnect streaming subscriptions with the last processed checkpoint.
  • Persist submitted transaction digests before waiting for effects.
  • Separate read pools from transaction submission pools so indexer load cannot starve writes.

See gRPC samples and the repository scripts under chains/sui/samples/grpcurl/.