feat: userBorrows, userSupplies actions

Author: cesarenaldi

packages/client/src/actions/index.ts

@@ -1,3 +1,4 @@
 export * from './markets';
 export * from './misc';
 export * from './reserve';
+export * from './user';

packages/client/src/actions/user.ts

@@ -0,0 +1,55 @@
+import {
+  UserBorrowsQuery,
+  type UserBorrowsRequest,
+  type UserReserveBorrowPosition,
+  type UserReserveSupplyPosition,
+  UserSuppliesQuery,
+  type UserSuppliesRequest,
+} from '@aave/graphql';
+import type { ResultAsync } from '@aave/types';
+import type { AaveClient } from '../client';
+import type { UnexpectedError } from '../errors';
+
+/**
+ * Fetches all user supply positions across specified markets.
+ *
+ * ```ts
+ * const result = await userSupplies(client, {
+ *   markets: [evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2')],
+ *   user: evmAddress('0x742d35cc6e5c4ce3b69a2a8c7c8e5f7e9a0b1234'),
+ *   orderBy: { name: OrderDirection.Asc }
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user supplies request parameters.
+ * @returns The list of user supply positions.
+ */
+export function userSupplies(
+  client: AaveClient,
+  request: UserSuppliesRequest,
+): ResultAsync<UserReserveSupplyPosition[], UnexpectedError> {
+  return client.query(UserSuppliesQuery, { request });
+}
+
+/**
+ * Fetches all user borrow positions across specified markets.
+ *
+ * ```ts
+ * const result = await userBorrows(client, {
+ *   markets: [evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2')],
+ *   user: evmAddress('0x742d35cc6e5c4ce3b69a2a8c7c8e5f7e9a0b1234'),
+ *   orderBy: { name: OrderDirection.Asc }
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The user borrows request parameters.
+ * @returns The list of user borrow positions.
+ */
+export function userBorrows(
+  client: AaveClient,
+  request: UserBorrowsRequest,
+): ResultAsync<UserReserveBorrowPosition[], UnexpectedError> {
+  return client.query(UserBorrowsQuery, { request });
+}

packages/graphql/src/enums.ts

@@ -1 +1,7 @@
-export {};
+/**
+ * The order direction for sorting results.
+ */
+export enum OrderDirection {
+  Asc = 'ASC',
+  Desc = 'DESC',
+}

packages/graphql/src/fragments/index.ts

@@ -1,4 +1,5 @@
 export * from './chain';
 export * from './common';
 export * from './market';
+export * from './positions';
 export * from './reserve';

packages/graphql/src/fragments/positions.ts

@@ -0,0 +1,40 @@
+import type { FragmentOf } from 'gql.tada';
+import { graphql } from '../graphql';
+import { CurrencyFragment, DecimalValueFragment } from './common';
+
+export const UserReserveBorrowPositionFragment = graphql(
+  `fragment UserReserveBorrowPosition on UserReserveBorrowPosition {
+    __typename
+    market
+    currency {
+      ...Currency
+    }
+    debt {
+      ...DecimalValue
+    }
+    apy {
+      ...DecimalValue
+    }
+  }`,
+  [CurrencyFragment, DecimalValueFragment],
+);
+export type UserReserveBorrowPosition = FragmentOf<typeof UserReserveBorrowPositionFragment>;
+
+export const UserReserveSupplyPositionFragment = graphql(
+  `fragment UserReserveSupplyPosition on UserReserveSupplyPosition {
+    __typename
+    market
+    currency {
+      ...Currency
+    }
+    balance {
+      ...DecimalValue
+    }
+    apy {
+      ...DecimalValue
+    }
+    collateral
+  }`,
+  [CurrencyFragment, DecimalValueFragment],
+);
+export type UserReserveSupplyPosition = FragmentOf<typeof UserReserveSupplyPositionFragment>;

packages/graphql/src/graphql.ts

@@ -18,6 +18,7 @@ import {
   type TadaDocumentNode,
 } from 'gql.tada';
 import type { StandardData } from './common';
+import type { OrderDirection } from './enums';
 import type { introspection } from './graphql-env';
 
 export type { FragmentOf } from 'gql.tada';
@@ -37,6 +38,7 @@ export const graphql = initGraphQLTada<{
     Float: number;
     ID: ID;
     Int: number;
+    OrderDirection: OrderDirection;
     Signature: Signature;
     String: string;
     TxHash: TxHash;

packages/graphql/src/index.ts

@@ -5,3 +5,4 @@ export * from './graphql';
 export * from './markets';
 export * from './misc';
 export * from './reserves';
+export * from './user';

packages/graphql/src/markets.ts

@@ -1,6 +1,9 @@
 import { MarketFragment } from './fragments';
 import { graphql, type RequestOf } from './graphql';
 
+/**
+ * @internal
+ */
 export const MarketsQuery = graphql(
   `query Markets($request: MarketsRequest!) {
     value: markets(request: $request) {
@@ -11,6 +14,9 @@ export const MarketsQuery = graphql(
 );
 export type MarketsRequest = RequestOf<typeof MarketsQuery>;
 
+/**
+ * @internal
+ */
 export const MarketQuery = graphql(
   `query Market($request: MarketRequest!) {
     value: market(request: $request) {

packages/graphql/src/misc.ts

@@ -1,12 +1,18 @@
 import { ChainFragment } from './fragments';
 import { graphql } from './graphql';
 
+/**
+ * @internal
+ */
 export const HealthQuery = graphql(
   `query Health {
     value: health
   }`,
 );
 
+/**
+ * @internal
+ */
 export const ChainsQuery = graphql(
   `query Chains {
     value: chains {

packages/graphql/src/reserves.ts

@@ -1,6 +1,9 @@
 import { ReserveFragment } from './fragments';
 import { graphql, type RequestOf } from './graphql';
 
+/**
+ * @internal
+ */
 export const ReserveQuery = graphql(
   `query Reserve($request: ReserveRequest!) {
     value: reserve(request: $request) {