TS SDK - Event Queries

[stella3d]

Add historical event queries

New Methods

all new methods are on the rpc Provider.

• getEventsByTransaction()
• getEventsByTransactionModule()
• getEventsByMoveEventStructName()
• getEventsBySender()
• getEventsByRecipient()
• getEventsByObject()
• getEventsByTimeRange()

Common Parameter Defaults

Parameters shared between many functions have defaults, to allow calling functions without specifying count or time range.

async getEventsBySender(
    sender: SuiAddress,
    count: number = DEFAULT_RESULT_COUNT,
    startTime: number = DEFAULT_START_TIME,
    endTime: number = DEFAULT_END_TIME
  )

allows calling like:

await rpc.getEventsBySender('0x0327d48f4c6e4cd8c7923b5940e3465e8198e9e2');

instead of

await rpc.getEventsBySender('0x0327d48f4c6e4cd8c7923b5940e3465e8198e9e2', 1000, 0, Number.MAX_SAFE_INTEGER);

API Design

The parameters for each method appear exactly as they do in the RPC method, with no abstraction. Initially i had an object that encapsulated a time range & count, but i backed it out in favor of a less opinionated design.

Testing

here's the results of some manual testing.

getEventsByTransaction()

getEventsByObject()

getEventsBySender()

getEventsByRecipient()

getEventsByTimeRange

getEventsByModule

getEventsByMoveEventStructName

[stella3d]

fields should always have been optional, i think. Some transactions turned out to have events without fields, this change unblocked the type guard validation

[stella3d]

this is related to my other comment about making MoveEvent.fields optional.

[666lcz]

Thanks for adding the comprehensive test plan! Overall looks good, requesting changes for some renaming and documentation update(see inline comments). Could you also update the Usage section in https://github.com/MystenLabs/sui/tree/main/sdk/typescript#usage to include the usage of events related API?