feat: borrow action

Author: cesarenaldi

packages/client/src/actions/index.ts

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

packages/client/src/actions/transactions.ts

@@ -0,0 +1,36 @@
+import {
+  BorrowQuery,
+  type BorrowRequest,
+  type Transaction,
+} from '@aave/graphql';
+import type { ResultAsync } from '@aave/types';
+import type { AaveClient } from '../client';
+import type { UnexpectedError } from '../errors';
+
+/**
+ * Creates a transaction to borrow from a market.
+ *
+ * ```ts
+ * const result = await borrow(client, {
+ *   market: evmAddress('0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2'),
+ *   amount: {
+ *     erc20: {
+ *       currency: evmAddress('0xa0b86a33e6441c8c5f0bb9b7e5e1f8bbf5b78b5c'),
+ *       value: '1000'
+ *     }
+ *   },
+ *   borrower: evmAddress('0x742d35cc6e5c4ce3b69a2a8c7c8e5f7e9a0b1234'),
+ *   chainId: chainId(1)
+ * });
+ * ```
+ *
+ * @param client - Aave client.
+ * @param request - The borrow request parameters.
+ * @returns The transaction data, approval requirements, or insufficient balance error.
+ */
+export function borrow(
+  client: AaveClient,
+  request: BorrowRequest,
+): ResultAsync<Transaction, UnexpectedError> {
+  return client.query(BorrowQuery, { request });
+}

packages/graphql/src/fragments/index.ts

@@ -3,3 +3,4 @@ export * from './common';
 export * from './market';
 export * from './positions';
 export * from './reserve';
+export * from './transaction';

packages/graphql/src/fragments/transactions.ts

@@ -0,0 +1,67 @@
+import type { FragmentOf } from 'gql.tada';
+import { graphql } from '../graphql';
+import { DecimalValueFragment } from './common';
+
+export const TransactionRequestFragment = graphql(
+  `fragment TransactionRequest on TransactionRequest {
+    __typename
+    to
+    from
+    data
+    value
+    chainId
+  }`,
+);
+export type TransactionRequest = FragmentOf<typeof TransactionRequestFragment>;
+
+export const ApprovalRequiredFragment = graphql(
+  `fragment ApprovalRequired on ApprovalRequired {
+    __typename
+    approval {
+      ...TransactionRequest
+    }
+    reason
+    requiredAmount {
+      ...DecimalValue
+    }
+    currentAllowance {
+      ...DecimalValue
+    }
+    originalTransaction {
+      ...TransactionRequest
+    }
+  }`,
+  [TransactionRequestFragment, DecimalValueFragment],
+);
+export type ApprovalRequired = FragmentOf<typeof ApprovalRequiredFragment>;
+
+export const InsufficientBalanceErrorFragment = graphql(
+  `fragment InsufficientBalanceError on InsufficientBalanceError {
+    __typename
+    required {
+      ...DecimalValue
+    }
+    available {
+      ...DecimalValue
+    }
+  }`,
+  [DecimalValueFragment],
+);
+export type InsufficientBalanceError = FragmentOf<typeof InsufficientBalanceErrorFragment>;
+
+export const TransactionFragment = graphql(
+  `fragment Transaction on Transaction {
+    __typename
+    ... on TransactionRequest {
+      ...TransactionRequest
+    }
+    ... on ApprovalRequired {
+      ...ApprovalRequired
+    }
+    ... on InsufficientBalanceError {
+      ...InsufficientBalanceError
+    }
+  }`,
+  [TransactionRequestFragment, ApprovalRequiredFragment, InsufficientBalanceErrorFragment],
+);
+export type Transaction = FragmentOf<typeof TransactionFragment>;

packages/graphql/src/index.ts

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

packages/graphql/src/transactions.ts

@@ -0,0 +1,15 @@
+import { TransactionFragment } from './fragments';
+import { graphql, type RequestOf } from './graphql';
+
+/**
+ * @internal
+ */
+export const BorrowQuery = graphql(
+  `query Borrow($request: BorrowRequest!) {
+    value: borrow(request: $request) {
+      ...Transaction
+    }
+  }`,
+  [TransactionFragment],
+);
+export type BorrowRequest = RequestOf<typeof BorrowQuery>;