Sui Full Node gRPC Methods
Sui full node gRPC API replaces JSON-RPC on full nodes. JSON-RPC is deprecated.
See also: Message Definitions | Enum and Scalar Types
sui/rpc/v2/subscription_service.proto
Services (subscription_service.proto)
SubscriptionService
SubscriptionService provides filtered, real-time streams of checkpoints, transactions, and events. Each Subscribe API pairs with the LedgerService List API of the same name: requests take the same filter message, and responses carry the same item and watermark shapes with identical cursor semantics. Subscriptions do not support resumption. A new subscription always begins at the current tip of the chain as seen by the server (the latest executed checkpoint). To recover data missed between subscriptions, replay the gap with the paired List API: pass the last received
Watermark.cursor as options.after on the List request (for checkpoints, pass the last received cursor + 1 as start_checkpoint). The List scan reads from the indexed tip, which may trail the subscription's start position; repeat the List call as the index advances until the replay reaches the position established by the subscription's first frame. A subscription behaves like an unbounded ascending scan: every frame carries the subscriber's resume point, and progress advances as checkpoints are fully covered. Two delivery guarantees keep sparse filters live: the first frame on a filtered subscription is a progress-only frame establishing the stream's start position, and progress continues to advance with bounded staleness even when no item matches. Subscription streams have no successful end: they run until cancelled by the client or terminated by the server with a gRPC status.Methods
SubscribeCheckpoints
Subscribe to the stream of checkpoints. The stream begins at the latest executed checkpoint as seen by the server and yields checkpoints matching the filter as they are executed. A checkpoint matches if any transaction it contains satisfies the filter.
SubscribeTransactions
Subscribe to the stream of transactions. The stream begins at the latest executed checkpoint as seen by the server and yields transactions matching the filter as they are executed.
SubscribeEvents
Subscribe to the stream of events. The stream begins at the latest executed checkpoint as seen by the server and yields events matching the filter as they are emitted.
sui/rpc/v2/name_service.proto
Services (name_service.proto)
NameService
Methods
LookupName
ReverseLookupName
sui/rpc/v2/signature_verification_service.proto
Services (signature_verification_service.proto)
SignatureVerificationService
Methods
VerifySignature
Perform signature verification of a UserSignature against the provided message.
sui/rpc/v2/move_package_service.proto
Services (move_package_service.proto)
MovePackageService
Methods
GetPackage
GetDatatype
GetFunction
ListPackageVersions
sui/rpc/v2/ledger_service.proto
Services (ledger_service.proto)
LedgerService
Methods
GetServiceInfo
Query the service for general information about its current state.
GetObject
BatchGetObjects
GetTransaction
BatchGetTransactions
GetCheckpoint
GetEpoch
ListCheckpoints
List checkpoints matching the provided filters. Checkpoints are returned in ascending or descending checkpoint sequence number order according to the query options ordering. A checkpoint matches if any transaction it contains satisfies the filter.
ListTransactions
List transactions matching the provided filters. Transactions are returned in ascending or descending transaction sequence order according to the query options ordering.
ListEvents
List events matching the provided filters. Events are returned in ascending or descending packed event sequence order according to the query options ordering.
sui/rpc/v2/state_service.proto
Services (state_service.proto)
StateService
Methods
ListDynamicFields
ListOwnedObjects
GetCoinInfo
GetBalance
ListBalances
sui/rpc/v2/transaction_execution_service.proto
Services (transaction_execution_service.proto)
TransactionExecutionService
Methods
ExecuteTransaction
SimulateTransaction