useContractEvents

Defined in react-core/src/evm/hooks/async/contracts.ts#L425

Get or subscribe to contract events

function useContractEvents(
  contract: RequiredParam<ValidContractInstance>,
  eventName?: string,
  options: {
    queryFilter?: EventQueryOptions<Record<string, any>>;
    subscribe?: boolean;
  },
): UseQueryResult<ContractEvent<Record<string, any>>[], unknown>;

Example

const { data: contractEvents, isLoading } =
  useContractEvents(contract);

Parameters

Returns

a response object that includes the contract events

type ReturnType = UseQueryResult<
  ContractEvent<Record<string, any>>[],
  unknown
>;