Add useEvents hook

Author: GhostWalker562

.changeset/spotty-brooms-design.md

@@ -0,0 +1,6 @@
+---
+"@aptos-labs/js-pro": patch
+"@aptos-labs/react": patch
+---
+
+Add `useEvents` hook

packages/js-pro/src/client.ts

@@ -30,6 +30,9 @@ import {
   fetchAccountCollections,
   fetchViewModule,
   fetchLedgerInfo,
+  fetchEvents,
+  fetchAccountTransactions,
+  fetchAccountTokens,
 } from "./queries/index.js";
 import {
   buildTransaction,
@@ -39,8 +42,6 @@ import {
   submitTransaction,
   waitForTransaction,
 } from "./mutations/index.js";
-import { fetchAccountTokens } from "./queries/fetchAccountTokens.js";
-import { fetchAccountTransactions } from "./queries/fetchAccountTransactions.js";
 
 type IndexerClientOptions = ConstructorParameters<typeof GraphQLClient>[1];
 
@@ -308,6 +309,8 @@ export class AptosJSProClient {
 
   fetchViewModule = fetchViewModule;
 
+  fetchEvents = fetchEvents;
+
   //* Client Mutations
 
   submitTransaction = submitTransaction;

packages/js-pro/src/queries/fetchEvents.ts

@@ -0,0 +1,23 @@
+// Copyright © Aptos
+// SPDX-License-Identifier: Apache-2.0
+
+import { Aptos, GetEventsResponse, MoveResource } from "@aptos-labs/ts-sdk";
+import { AptosJSProClient } from "../client.js";
+import { WithNetwork } from "../types/parameters.js";
+
+export type FetchEventsParameters = WithNetwork<
+  Parameters<Aptos["getEvents"]>[0]
+>;
+
+export type FetchEventsResult = GetEventsResponse;
+
+export async function fetchEvents(
+  this: AptosJSProClient,
+  { network, ...params }: FetchEventsParameters
+): Promise<FetchEventsResult> {
+  const { aptos } = this.getClients({ network });
+
+  const result = await aptos.getEvents(params);
+
+  return result;
+}

packages/js-pro/src/queries/index.ts

@@ -19,3 +19,4 @@ export * from "./fetchViewModule.js";
 export * from "./fetchFungibleAssetMetadata.js";
 export * from "./fetchAccountTransactions.js";
 export * from "./fetchAccountTokens.js";
+export * from "./fetchEvents.js";

packages/js-pro/src/types/index.ts

@@ -8,4 +8,4 @@ export * from "./resources.js";
 export * from "./tokens.js";
 export * from "./fungibleAssets.js";
 export * from "./transactions.js";
-export * from "./activities.js";
+export * from "./activities.js";``

packages/react/src/queries/index.ts

@@ -23,3 +23,4 @@ export * from "./useTokenData.js";
 export * from "./useTransaction.js";
 export * from "./useViewModule.js";
 export * from "./useWaitForTransaction.js";
+export * from "./useEvents.js";

packages/react/src/queries/useEvents.ts

@@ -0,0 +1,39 @@
+// Copyright © Aptos
+// SPDX-License-Identifier: Apache-2.0
+
+import { useQuery } from "@tanstack/react-query";
+import { useAptosCore } from "../AptosJSCoreProvider.js";
+import { FetchEventsParameters, FetchEventsResult } from "@aptos-labs/js-pro";
+import { AnyNumber } from "@aptos-labs/ts-sdk";
+import { UseQueryOptions } from "../types/queries.js";
+
+export const getUseEventsQueryKey = (params: {
+  network: string;
+  minimumLedgerVersion?: AnyNumber;
+  options?: FetchEventsParameters["options"];
+}) => ["events", params.network, params.minimumLedgerVersion, params.options];
+
+export type UseEventsQueryParameters = FetchEventsParameters &
+  UseQueryOptions<FetchEventsResult>;
+
+export function useEvents({
+  network,
+  minimumLedgerVersion,
+  options,
+  ...queryOptions
+}: UseEventsQueryParameters) {
+  const core = useAptosCore();
+
+  const activeNetwork = network ?? core.network;
+
+  return useQuery({
+    queryKey: getUseEventsQueryKey({
+      network: activeNetwork.network,
+      minimumLedgerVersion,
+      options,
+    }),
+    queryFn: () =>
+      core.client.fetchEvents({ network, minimumLedgerVersion, options }),
+    ...queryOptions,
+  });
+}