Skip to main content

ContractEvents.getEvents() method​

Get Events

Example​

// The name of the event to get logs for
const eventName = "Transfer";

// Optionally pass in options to limit the blocks from which events are retrieved
const options = {
  fromBlock: 0,
  toBlock: 1000000, // can also pass "latest"
  order: "desc",
  // Configure event filters (filter on indexed event parameters)
  filters: {
    from: "0x...",
    to: "0x...",
  },
};

const events = await contract.events.getEvents(eventName, options);
console.log(events[0].eventName);
console.log(events[0].data);

Signature:

getEvents<TEvent extends Record<string, any> = Record<string, any>, TFilter extends Record<string, any> = Record<string, any>>(eventName: string, options?: EventQueryOptions<TFilter>): Promise<ContractEvent<TEvent>[]>;

Parameters​

ParameterTypeDescription
eventNamestringThe name of the event to get logs for
optionsEventQueryOptions<TFilter>(Optional) Specify the from and to block numbers to get events for, defaults to all blocks.

Returns:

Promise<ContractEvent<TEvent>[]>

The requested event objects with event data

Remarks​

Get a list of the events of a specific type emitted from this contract during the specified time period