ListEvents - Stream Historical Sui Events
Stream filtered historical Sui events over gRPC with checkpoint ranges, event filters, field masks, and cursor pagination.
LedgerService.ListEvents streams matching Move events from the indexed ledger. Each event carries its checkpoint, transaction digest, transaction index, and event index when requested.
Method Signature
- Service:
sui.rpc.v2.LedgerService - Method:
ListEvents - Type: Server-streaming RPC
Use event_type to identify the declared event type. package_id and module identify the top-level Move call that triggered emission and can differ from the event type's package and module.
Related Methods
See the official Sui gRPC schema for the current protobuf definition.
Retention and filters
Replace RECENT_CHECKPOINT with a recent checkpointHeight from GetServiceInfo. A lower bound before retained history returns OUT_OF_RANGE.
See filter syntax and examples before adding a filter. An included filter must contain at least one term.
For recovery and deduplication, include both transaction_digest and event_index in the subscription and replay masks. Different events from one transaction share its digest.
ListTransactions
Stream filtered historical Sui transactions over gRPC with checkpoint bounds, field masks, and resumable cursor pagination.
GetDatatype
Retrieve Move struct and datatype definitions via gRPC including fields and type parameters. Essential for understanding smart contract data structures with Dwellir.