feat: add borrow action command (#353)

Author: juangm

.changeset/tasty-regions-tell.md

@@ -0,0 +1,5 @@
+---
+"@aave/cli": patch
+---
+
+**feat:** add borrow action command

packages/cli/package.json

@@ -53,6 +53,9 @@
     "commands": "./dist/commands",
     "topicSeparator": " ",
     "topics": {
+      "action": {
+        "description": "Actions to perform in the Aave v4 protocol"
+      },
       "hubs": {
         "description": "List available liquidity hubs"
       },

packages/cli/src/commands/action/borrow.ts

@@ -0,0 +1,129 @@
+import {
+  type BorrowRequest,
+  bigDecimal,
+  evmAddress,
+  InvariantError,
+  invariant,
+  ok,
+  type Reserve,
+  ResultAsync,
+  reserveId,
+  type SendWithError,
+  type TimeoutError,
+  type TransactionReceipt,
+  type UnexpectedError,
+} from '@aave/client';
+import { borrow, reserve } from '@aave/client/actions';
+import { sendWith, toViemChain } from '@aave/client/viem';
+import { Flags } from '@oclif/core';
+import { createWalletClient, http } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+
+import * as common from '../../common.js';
+
+export default class ActionBorrow extends common.V4Command {
+  static override description = 'Borrow ERC20 tokens from a reserve';
+
+  static override flags = {
+    'reserve-id': Flags.string({
+      required: true,
+      description: 'Reserve ID of the reserve to borrow from',
+    }),
+    amount: Flags.string({
+      required: true,
+      description: 'Amount of the token to borrow',
+    }),
+    'private-key': common.privateKey({
+      required: false,
+    }),
+  };
+
+  private getBorrowRequest(): ResultAsync<
+    {
+      request: BorrowRequest;
+      reserve: Reserve;
+      amount: string;
+      privateKey: `0x${string}`;
+    },
+    InvariantError | UnexpectedError
+  > {
+    return ResultAsync.fromPromise(
+      this.parse(ActionBorrow),
+      (error) => new InvariantError(String(error)),
+    ).andThen(({ flags }) => {
+      const privateKey = (flags['private-key'] ??
+        process.env.PRIVATE_KEY) as `0x${string}`;
+      invariant(
+        privateKey,
+        'Provide --private-key or PRIVATE_KEY environment variable',
+      );
+
+      const parsedReserveId = reserveId(flags['reserve-id']);
+      const amount = flags.amount.trim();
+
+      invariant(amount.length > 0, 'Amount cannot be empty');
+
+      const account = privateKeyToAccount(privateKey);
+      const sender = evmAddress(account.address);
+
+      return reserve(this.client, {
+        query: { reserveId: parsedReserveId },
+        user: sender,
+      }).andThen((reserveData) => {
+        invariant(reserveData, `Reserve not found: ${flags['reserve-id']}`);
+
+        return ok({
+          request: {
+            reserve: reserveData.id,
+            amount: {
+              erc20: {
+                value: bigDecimal(amount),
+              },
+            },
+            sender,
+          },
+          reserve: reserveData,
+          amount,
+          privateKey,
+        });
+      });
+    });
+  }
+
+  async run(): Promise<
+    TransactionReceipt | InvariantError | SendWithError | TimeoutError
+  > {
+    const result = await this.getBorrowRequest().andThen(
+      ({ request, reserve, amount, privateKey }) => {
+        const wallet = createWalletClient({
+          account: privateKeyToAccount(privateKey),
+          chain: toViemChain(reserve.chain),
+          transport: http(reserve.chain.rpcUrl),
+        });
+
+        return borrow(this.client, request)
+          .andThen(sendWith(wallet))
+          .andTee((txResult) =>
+            this.log(`Borrow transaction sent with hash: ${txResult.txHash}`),
+          )
+          .andThen(this.client.waitForTransaction)
+          .map((txResult) => {
+            this.display([
+              ['Reserve ID', reserve.id],
+              ['Amount', `${amount} - ${reserve.asset.underlying.info.symbol}`],
+              ['Transaction Hash', txResult.txHash],
+              ['Url', `${reserve.chain.explorerUrl}/tx/${txResult.txHash}`],
+            ]);
+
+            return txResult;
+          });
+      },
+    );
+
+    if (result.isErr()) {
+      this.error(result.error);
+    }
+
+    return result.value;
+  }
+}

packages/cli/src/commands/action/supply.ts

@@ -113,6 +113,9 @@ export default class ActionSupply extends common.V4Command {
 
         return supply(this.client, request)
           .andThen(sendWith(wallet))
+          .andTee((txResult) =>
+            this.log(`Supply transaction sent with hash: ${txResult.txHash}`),
+          )
           .andThen(this.client.waitForTransaction)
           .map((txResult) => {
             this.display([