feat: implements useBorrowSwapQuote

Author: cesarenaldi

.changeset/spotty-ideas-brake.md

@@ -0,0 +1,6 @@
+---
+"@aave/graphql": patch
+"@aave/react": patch
+---
+
+**feat:** new `useBorrowSwapQuote` hook.

packages/graphql/src/fragments/swaps.ts

@@ -451,6 +451,21 @@ export const PrepareSupplySwapResultFragment: FragmentDocumentFor<
   [PositionSwapByIntentApprovalsRequiredFragment],
 );
 
+export type PrepareBorrowSwapResult = PositionSwapByIntentApprovalsRequired;
+
+export const PrepareBorrowSwapResultFragment: FragmentDocumentFor<
+  PrepareBorrowSwapResult,
+  'PrepareBorrowSwapResult'
+> = graphql(
+  `fragment PrepareBorrowSwapResult on PrepareBorrowSwapResult {
+    __typename
+    ... on PositionSwapByIntentApprovalsRequired {
+      ...PositionSwapByIntentApprovalsRequired
+    }
+  }`,
+  [PositionSwapByIntentApprovalsRequiredFragment],
+);
+
 export type PreparePositionSwapResult = SwapByIntent;
 
 export const PreparePositionSwapResultFragment: FragmentDocumentFor<

packages/graphql/src/swaps.ts

@@ -1,6 +1,7 @@
 import {
   CancelSwapExecutionPlanFragment,
   PaginatedUserSwapsResultFragment,
+  PrepareBorrowSwapResultFragment,
   PreparePositionSwapResultFragment,
   PrepareSupplySwapResultFragment,
   PrepareSwapCancelResultFragment,
@@ -129,6 +130,19 @@ export const SupplySwapQuoteQuery = graphql(
 );
 export type PrepareSupplySwapRequest = RequestOf<typeof SupplySwapQuoteQuery>;
 
+/**
+ * @internal
+ */
+export const BorrowSwapQuoteQuery = graphql(
+  `query BorrowSwapQuote($request: PrepareBorrowSwapRequest!, $currency: Currency!) {
+    value: borrowSwapQuote(request: $request) {
+      ...PrepareBorrowSwapResult
+    }
+  }`,
+  [PrepareBorrowSwapResultFragment],
+);
+export type PrepareBorrowSwapRequest = RequestOf<typeof BorrowSwapQuoteQuery>;
+
 /**
  * @internal
  */

packages/react/src/swap.ts

@@ -36,8 +36,10 @@ import type {
   UserSwapsRequest,
 } from '@aave/graphql';
 import {
+  BorrowSwapQuoteQuery,
   type ERC20PermitSignature,
   type PositionSwapByIntentApprovalsRequired,
+  type PrepareBorrowSwapRequest,
   type PreparePositionSwapRequest,
   type PrepareTokenSwapRequest,
   SupplySwapQuoteQuery,
@@ -512,6 +514,116 @@ export function useSupplySwapQuote({
 
 // ------------------------------------------------------------
 
+export type UseBorrowSwapQuoteArgs = Prettify<
+  PrepareBorrowSwapRequest & CurrencyQueryOptions
+>;
+
+/**
+ * @experimental
+ * Fetch a quote for a borrow swap operation with the specified parameters.
+ *
+ * This signature supports React Suspense:
+ *
+ * ```tsx
+ * const { data } = useBorrowSwapQuote({
+ *   market: {
+ *     sellPosition: userBorrowItem.id,
+ *     buyReserve: reserve.id,
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc…'),
+ *   },
+ *   suspense: true,
+ * });
+ * ```
+ */
+export function useBorrowSwapQuote(
+  args: UseBorrowSwapQuoteArgs & Suspendable,
+): SuspenseResult<SwapQuote>;
+/**
+ * @experimental
+ * Fetch a quote for a borrow swap operation with the specified parameters.
+ *
+ * Pausable suspense mode.
+ *
+ * ```tsx
+ * const { data } = useBorrowSwapQuote({
+ *   market: {
+ *     sellPosition: userBorrowItem.id,
+ *     buyReserve: reserve.id,
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc…'),
+ *   },
+ *   suspense: true,
+ *   pause: true,
+ * });
+ * ```
+ */
+export function useBorrowSwapQuote(
+  args: Pausable<UseBorrowSwapQuoteArgs> & Suspendable,
+): PausableSuspenseResult<SwapQuote>;
+/**
+ * @experimental
+ * Fetch a quote for a borrow swap operation with the specified parameters.
+ *
+ * ```tsx
+ * const { data, error, loading } = useBorrowSwapQuote({
+ *   market: {
+ *     sellPosition: userBorrowItem.id,
+ *     buyReserve: reserve.id,
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc…'),
+ *   },
+ * });
+ * ```
+ */
+export function useBorrowSwapQuote(
+  args: UseBorrowSwapQuoteArgs,
+): ReadResult<SwapQuote>;
+/**
+ * @experimental
+ * Fetch a quote for a borrow swap operation with the specified parameters.
+ *
+ * Pausable loading state mode.
+ *
+ * ```tsx
+ * const { data, error, loading, paused } = useBorrowSwapQuote({
+ *   market: {
+ *     sellPosition: userBorrowItem.id,
+ *     buyReserve: reserve.id,
+ *     amount: bigDecimal('1000'),
+ *     user: evmAddress('0x742d35cc…'),
+ *   },
+ *   pause: true,
+ * });
+ * ```
+ */
+export function useBorrowSwapQuote(
+  args: Pausable<UseBorrowSwapQuoteArgs>,
+): PausableReadResult<SwapQuote>;
+
+export function useBorrowSwapQuote({
+  suspense = false,
+  pause = false,
+  currency = DEFAULT_QUERY_OPTIONS.currency,
+  ...request
+}: NullishDeep<UseBorrowSwapQuoteArgs> & {
+  suspense?: boolean;
+  pause?: boolean;
+}): SuspendableResult<SwapQuote, UnexpectedError> {
+  return useSuspendableQuery({
+    document: BorrowSwapQuoteQuery,
+    variables: {
+      request,
+      currency,
+    },
+    selector: (data) => data.quote,
+    suspense,
+    pause,
+  });
+}
+
+// ------------------------------------------------------------
+
 export type SwapHandlerOptions = {
   cancel: CancelOperation;
 };