feat: add react hooks for deposit/withdraw/balance sGHO

Author: juangm

packages/react/src/gho.ts

@@ -0,0 +1,148 @@
+import type { UnexpectedError } from '@aave/client';
+import { savingsGhoDeposit, savingsGhoWithdraw } from '@aave/client/actions';
+import type {
+  ExecutionPlan,
+  SavingsGhoBalanceRequest,
+  SavingsGhoDepositRequest,
+  SavingsGhoWithdrawRequest,
+  TokenAmount,
+  TransactionRequest,
+} from '@aave/graphql';
+import { SavingsGhoBalanceQuery } from '@aave/graphql';
+import { useAaveClient } from './context';
+import type {
+  ReadResult,
+  Suspendable,
+  SuspendableResult,
+  SuspenseResult,
+} from './helpers';
+import {
+  type UseAsyncTask,
+  useAsyncTask,
+  useSuspendableQuery,
+} from './helpers';
+
+export type SavingsGhoBalanceArgs = SavingsGhoBalanceRequest;
+
+/**
+ * Fetches the current sGHO balance for a user.
+ *
+ * This signature supports React Suspense:
+ *
+ * ```tsx
+ * const { data } = useSavingsGhoBalance({
+ *   user: evmAddress('0x742d35cc…'),
+ *   suspense: true,
+ * });
+ * ```
+ */
+export function useSavingsGhoBalance(
+  args: SavingsGhoBalanceArgs & Suspendable,
+): SuspenseResult<TokenAmount>;
+
+/**
+ * Fetches the current sGHO balance for a user.
+ *
+ * ```tsx
+ * const { data, loading } = useSavingsGhoBalance({
+ *   user: evmAddress('0x742d35cc…'),
+ * });
+ * ```
+ */
+export function useSavingsGhoBalance(
+  args: SavingsGhoBalanceArgs,
+): ReadResult<TokenAmount>;
+
+export function useSavingsGhoBalance({
+  suspense = false,
+  ...request
+}: SavingsGhoBalanceArgs & {
+  suspense?: boolean;
+}): SuspendableResult<TokenAmount> {
+  return useSuspendableQuery({
+    document: SavingsGhoBalanceQuery,
+    variables: {
+      request,
+    },
+    suspense,
+  });
+}
+
+/**
+ * A hook that provides a way to withdraw sGHO.
+ *
+ * ```ts
+ * const [withdraw, withdrawing] = useSavingsGhoWithdraw();
+ * const [sendTransaction, sending] = useSendTransaction(wallet);
+ *
+ * const loading = withdrawing.loading && sending.loading;
+ * const error = withdrawing.error || sending.error;
+ *
+ * // …
+ *
+ * const result = await withdraw({ ... })
+ *   .andThen(sendTransaction);
+ *
+ * if (result.isErr()) {
+ *   console.error(result.error);
+ *   return;
+ * }
+ *
+ * console.log('Transaction sent with hash:', result.value);
+ * ```
+ */
+export function useSavingsGhoWithdraw(): UseAsyncTask<
+  SavingsGhoWithdrawRequest,
+  TransactionRequest,
+  UnexpectedError
+> {
+  const client = useAaveClient();
+
+  return useAsyncTask((request: SavingsGhoWithdrawRequest) =>
+    savingsGhoWithdraw(client, request),
+  );
+}
+
+/**
+ * A hook that provides a way to deposit GHO into sGHO.
+ *
+ * ```ts
+ * const [deposit, depositing] = useSavingsGhoDeposit();
+ * const [sendTransaction, sending] = useSendTransaction(wallet);
+ *
+ * const loading = depositing.loading && sending.loading;
+ * const error = depositing.error || sending.error;
+ *
+ * // …
+ *
+ * const result = await deposit({ ... })
+ *   .andThen((plan) => {
+ *     switch (plan.__typename) {
+ *       case 'TransactionRequest':
+ *         return sendTransaction(plan);
+ *
+ *       case 'ApprovalRequired':
+ *         return sendTransaction(plan.approval)
+ *           .andThen(() => sendTransaction(plan.originalTransaction));
+ *     }
+ *   });
+ *
+ * if (result.isErr()) {
+ *   console.error(result.error);
+ *   return;
+ * }
+ *
+ * console.log('Transaction sent with hash:', result.value);
+ * ```
+ */
+export function useSavingsGhoDeposit(): UseAsyncTask<
+  SavingsGhoDepositRequest,
+  ExecutionPlan,
+  UnexpectedError
+> {
+  const client = useAaveClient();
+
+  return useAsyncTask((request: SavingsGhoDepositRequest) =>
+    savingsGhoDeposit(client, request),
+  );
+}

packages/react/src/incentives.ts

@@ -1,8 +1,5 @@
-import type {
-  MeritClaimRewardsRequest,
-  MeritClaimRewardsTransaction,
-} from '@aave/graphql';
-import { MeritClaimRewardsQuery } from '@aave/graphql';
+import type { UserMeritRewards, UserMeritRewardsRequest } from '@aave/graphql';
+import { UserMeritRewardsQuery } from '@aave/graphql';
 import type {
   ReadResult,
   Suspendable,
@@ -11,7 +8,7 @@ import type {
 } from './helpers';
 import { useSuspendableQuery } from './helpers';
 
-export type UseMeritClaimRewardsArgs = MeritClaimRewardsRequest;
+export type UserMeritRewardsArgs = UserMeritRewardsRequest;
 
 /**
  * Fetches Merit claim rewards for a user with the transaction request to claim them.
@@ -27,8 +24,8 @@ export type UseMeritClaimRewardsArgs = MeritClaimRewardsRequest;
  * ```
  */
 export function useMeritClaimRewards(
-  args: UseMeritClaimRewardsArgs & Suspendable,
-): SuspenseResult<MeritClaimRewardsTransaction | null>;
+  args: UserMeritRewardsArgs & Suspendable,
+): SuspenseResult<UserMeritRewards | null>;
 
 /**
  * Fetches Merit claim rewards for a user with the transaction request to claim them.
@@ -41,17 +38,17 @@ export function useMeritClaimRewards(
  * ```
  */
 export function useMeritClaimRewards(
-  args: UseMeritClaimRewardsArgs,
-): ReadResult<MeritClaimRewardsTransaction | null>;
+  args: UserMeritRewardsArgs,
+): ReadResult<UserMeritRewards | null>;
 
 export function useMeritClaimRewards({
   suspense = false,
   ...request
-}: UseMeritClaimRewardsArgs & {
+}: UserMeritRewardsArgs & {
   suspense?: boolean;
-}): SuspendableResult<MeritClaimRewardsTransaction | null> {
+}): SuspendableResult<UserMeritRewards | null> {
   return useSuspendableQuery({
-    document: MeritClaimRewardsQuery,
+    document: UserMeritRewardsQuery,
     variables: {
       request,
     },

packages/react/src/index.ts

@@ -2,6 +2,7 @@ export * from '@aave/client';
 
 export * from './AaveProvider';
 export { useAaveClient } from './context';
+export * from './gho';
 export * from './incentives';
 export * from './markets';
 export * from './misc';