gRPCSubscribeCheckpoints
sui-mainnet.nodit.io:443 sui.rpc.v2.SubscriptionService/SubscribeCheckpointsserver streamingSubscribes to the stream of checkpoints. When a subscription is initialized, the stream begins with the latest executed checkpoint as seen by the server, and responses are guaranteed to be returned in order without gaps.
Request and response messages are identical for both transports. Only the wire protocol, headers, and client library differ.
- Protocol
- Native gRPC over HTTP/2 with TLS. Suited to server-side clients and grpcurl.
- Content-Type
application/grpc- Headers
x-api-key- Streaming
- Server, client, and bidirectional streaming are all supported. This method returns a server-streaming response.
- Errors
- grpc-status and grpc-message are delivered as HTTP/2 trailers.
The set of field mask paths (e.g. "object_id", "version", "digest").
Required. The checkpoint sequence number — the current cursor value into the checkpoint stream.
The height of this checkpoint.
The digest of this Checkpoint's CheckpointSummary.
The checkpoint summary.
CheckpointSummary serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
The digest of this CheckpointSummary.
Epoch this checkpoint belongs to.
Height of the checkpoint.
Total number of transactions since genesis.
The hash of the CheckpointContents for this checkpoint.
Hash of the previous CheckpointSummary.
Running total of gas costs for the epoch.
Computation cost.
Storage cost.
Storage rebate.
Non-refundable storage fee.
Timestamp in milliseconds from the Unix epoch.
Commitments to checkpoint-specific state.
Kind of the checkpoint commitment.
Digest of the commitment.
Data present only in the final checkpoint of an epoch.
Committee of validators for the next epoch.
The 96-byte Bls12381 public key for this validator.
Voting weight this validator possesses.
Protocol version for the next epoch.
Commitments for the epoch.
Kind of the checkpoint commitment.
Digest of the commitment.
Version-specific data.
Aggregated validator signature over the summary.
The epoch when this signature was produced. This can be used to lookup the ValidatorCommittee from this epoch to verify this signature.
The 48-byte Bls12381 aggregated signature.
Bitmap indicating which members of the committee contributed to this signature.
Committed contents of the checkpoint.
CheckpointContents serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
Digest of the CheckpointContents.
Version of this CheckpointContents.
Set of transactions committed to in this checkpoint.
Digest of the transaction.
Digest of the effects.
Set of user signatures that authorized the transaction.
This signature serialized as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.
The signature scheme of this signature.
Simple signature if scheme is ed25519 | secp256k1 | secp256r1.
The multisig aggregated signature if scheme is MULTISIG.
The zklogin authenticator if scheme is ZKLOGIN.
The passkey authenticator if scheme is PASSKEY.
The AddressAliases object version used to verify the UserSignature at the same position in signatures. Present when CheckpointContents.version >= 2.
Version of the address aliases.
Transactions executed in this checkpoint.
Transaction digest.
The transaction itself.
Transaction serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
Transaction digest.
Version of the transaction structure.
Kind of the transaction.
Kind discriminator.
A programmable (user) transaction.
A change-epoch system transaction.
The genesis transaction.
A consensus commit prologue transaction.
An authenticator state update transaction.
An end-of-epoch transaction.
A randomness state update transaction.
Address of the sender.
Gas payment information.
Set of gas objects to use for payment.
Owner of the gas objects, either the transaction sender or a sponsor.
Gas unit price to use when charging for computation. Must be greater than or equal to the network's current RGP (reference gas price).
Total budget willing to spend for the execution of a transaction.
Transaction expiration (TTL).
Kind of the expiration.
Maximum epoch after which the transaction expires.
Minimum epoch before which the transaction is invalid.
Minimum valid timestamp.
Maximum valid timestamp.
ChainId used for replay protection.
Uniqueness identifier.
Signatures on the transaction.
This signature serialized as BCS. When provided as input this will support both the form that is length prefixed as well as not length prefixed.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
The signature scheme of this signature.
Simple signature if scheme is ed25519 | secp256k1 | secp256r1.
The signature scheme of this signature.
Signature bytes.
Public key bytes.
The multisig aggregated signature if scheme is MULTISIG.
The plain signatures encoded with signature scheme. The signatures must be in the same order as they are listed in the committee.
Bitmap indicating which committee members contributed to the signature.
If present, means this signature's on-chain format uses the old legacy multisig format.
The multisig committee used to validate this signature.
The zklogin authenticator if scheme is ZKLOGIN.
Zklogin proof and inputs required to perform proof verification.
Maximum epoch for which the proof is valid.
The ephemeral signature.
The public identifier (similar to a public key) for this zklogin authenticator.
The id of the JWK used to authorize this zklogin authenticator.
The passkey authenticator if scheme is PASSKEY.
Opaque authenticator data for this passkey signature.
Structured, unparsed JSON for this passkey signature.
A secp256r1 signature.
Effects of the transaction.
Effects serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
Digest of the effects.
Version of the effects structure.
Execution status.
Whether execution succeeded.
Error information if execution failed.
Epoch of execution.
Summary of gas used.
Computation cost.
Storage cost.
Storage rebate.
Non-refundable storage fee.
Digest of the executed transaction.
The gas object after execution.
ObjectId of the changed object.
Input state of the object.
Input version.
Input digest.
Owner before the change.
Output state of the object.
Output version.
Output digest.
Owner after the change.
Accumulator write operation, if any.
ID operation (created/deleted/etc.).
Type of the object.
Digest of the emitted events.
Transactions this transaction depends on.
Lamport version of written objects.
Objects changed during execution.
ObjectId of the changed object.
Input state of the object.
Input version.
Input digest.
Owner before the change.
Output state of the object.
Output version.
Output digest.
Owner after the change.
Accumulator write operation, if any.
ID operation (created/deleted/etc.).
Type of the object.
Consensus objects not changed during execution.
Kind of the unchanged consensus object.
ObjectId of the object.
Version of the object.
Digest of the object.
Type of the object.
Digest of auxiliary data.
Loaded runtime objects that were not changed.
The object id of this object.
The version of this object.
The digest of this object.
Events emitted by the transaction.
TransactionEvents serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
Digest of the TransactionEvents.
Set of events emitted by a transaction.
Package ID of the invoked function.
Module name of the top-level function of a MoveCall command that triggered this event to be emitted.
Address of the transaction sender.
Type of the emitted event.
BCS serialized bytes of the event.
JSON rendering of the event.
Checkpoint including this transaction.
Timestamp of execution.
Balance changes caused by the transaction.
The affected account address.
Coin type.
Balance change amount.
Objects related to the transaction.
Objects, sorted by object_id and version.
This Object serialized as BCS.
ObjectId of the object.
Version of the object.
The digest of this Object.
Owner of the object.
Type of the object.
DEPRECATED. Whether the object has public transfer.
BCS bytes of a Move struct value. Only set for Move structs.
Package data if the object is a package.
Digest of the transaction that created or last mutated this object.
Storage rebate for the object.
JSON rendering of the object.
Current balance if this object is a 0x2::coin::Coin<T>.
Template-based display rendering.
Set of objects either referenced as inputs or produced as outputs by transactions included in this checkpoint. Objects appear here for deduplication; transactions.objects will not be populated.
Objects, sorted by object_id and version.
This Object serialized as BCS.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
ObjectId of the object.
Version of the object.
The digest of this Object.
Owner of the object.
Kind of ownership.
Address or ObjectId of the owner.
The initial_shared_version if kind is SHARED or start_version if kind is CONSENSUS_ADDRESS.
Type of the object.
DEPRECATED. Whether the object has public transfer.
BCS bytes of a Move struct value. Only set for Move structs.
Name that identifies the type of the serialized value.
Bytes of a BCS serialized value.
Package data if the object is a package.
Package ObjectId (storage ID).
ID of the first published version.
Version of the package.
Modules in the package.
Type origins for the package's types.
Transitive dependencies (linkage table).
Digest of the transaction that created or last mutated this object.
Storage rebate for the object.
JSON rendering of the object.
Current balance if this object is a 0x2::coin::Coin<T>.
Template-based display rendering.
Substituted display fields.
Fields that failed to render.