sui namespace.
Methods
getTransactionBlock
Returns transaction details by digest.TransactionDigest
required
The digest of the queried transaction
SuiTransactionBlockResponseOptions
Options for specifying the content to be returned
SuiTransactionBlockResponse
The transaction response object
multiGetTransactionBlocks
Returns an ordered list of transaction responses. Throws an error if input contains duplicates or exceedsQUERY_MAX_RESULT_LIMIT.
TransactionDigest[]
required
A list of transaction digests
SuiTransactionBlockResponseOptions
Config options to control which fields to fetch
SuiTransactionBlockResponse[]
Array of transaction response objects
getObject
Returns object information for a specified object.ObjectID
required
The ID of the queried object
SuiObjectDataOptions
Options for specifying the content to be returned
SuiObjectResponse
The object information
multiGetObjects
Returns object data for a list of objects.ObjectID[]
required
The IDs of the queried objects
SuiObjectDataOptions
Options for specifying the content to be returned
SuiObjectResponse[]
Array of object responses
tryGetPastObject
Returns object information for a specified version. No software-level guarantee that past objects can be retrieved.ObjectID
required
The ID of the queried object
SequenceNumber
required
The version of the queried object
SuiObjectDataOptions
Options for specifying the content to be returned
SuiPastObjectResponse
The past object information
tryMultiGetPastObjects
Returns object information for a list of past objects.SuiGetPastObjectRequest[]
required
A vector of object and versions to be queried
SuiObjectDataOptions
Options for specifying the content to be returned
SuiPastObjectResponse[]
Array of past object responses
getCheckpoint
Returns a checkpoint by sequence number or digest.CheckpointId
required
Checkpoint identifier (digest or sequence number)
Checkpoint
The checkpoint data
getCheckpoints
Returns a paginated list of checkpoints.BigInt<u64>
Optional paging cursor. If provided, query starts from the next item after the cursor
usize
Maximum items returned per page
boolean
required
Query result ordering (false = ascending, oldest first)
CheckpointPage
Paginated checkpoint results
getEvents
Returns transaction events by transaction digest.TransactionDigest
required
The event query criteria
SuiEvent[]
Array of events emitted by the transaction
getTotalTransactionBlocks
Returns the total number of transaction blocks known to the server.BigInt<u64>
Total transaction count
getLatestCheckpointSequenceNumber
Returns the sequence number of the latest checkpoint that has been executed.BigInt<u64>
Latest checkpoint sequence number
getProtocolConfig
Returns the protocol config table for the given version number. If no version is specified, returns the latest protocol config.BigInt<u64>
Optional protocol version specifier
ProtocolConfigResponse
Protocol configuration parameters
getChainIdentifier
Returns the first four bytes of the chain’s genesis checkpoint digest.string
Chain identifier string
verifyZkLoginSignature
Verifies a zkLogin signature for the given bytes, intent scope, and author.string
required
Base64 string of BCS bytes for raw transaction data or personal message
string
required
Base64 string of the zkLogin signature to verify
ZkLoginIntentScope
required
Intent scope: either
TransactionData or PersonalMessageSuiAddress
required
The author of the signature
ZkLoginVerifyResult
Verification result