fix: account opener should not claim more then it needs

Author: doomsower

src/dev/AccountOpener.ts

@@ -519,8 +519,8 @@ export class AccountOpener extends SDKConstruct {
       );
     }
 
-    let totalUSD = 0n;
     const deposits: [PoolContract, bigint][] = [];
+    const claims: AddressMap<bigint> = new AddressMap();
     for (const [p, minAvailable] of Object.entries(minAvailableByPool)) {
       const market = this.sdk.marketRegister.findByPool(p as Address);
       const pool = market.pool.pool;
@@ -538,21 +538,19 @@ export class AccountOpener extends SDKConstruct {
       );
       if (diff > 0n) {
         deposits.push([pool, diff]);
-        totalUSD += market.priceOracle.convertToUSD(pool.underlying, diff);
+        let claim = claims.get(pool.underlying) ?? 0n;
+        // pool.available * linearModel.U2 can be borrowed
+        // U2 is currently at 90% in all pools
+        claim += (diff * PERCENTAGE_FACTOR) / 8950n;
+        claims.upsert(pool.underlying, claim);
       }
     }
-    // pool.available * linearModel.U2 can be borrowed
-    // U2 is currently at 90% in all pools
-    totalUSD = (totalUSD * PERCENTAGE_FACTOR) / 8950n;
-    this.#logger?.debug(
-      `total USD to claim from faucet: ${formatBN(totalUSD, 8)}`,
-    );
 
     const depositor = await this.#getDepositor();
     this.#logger?.debug(`depositor: ${depositor.address}`);
 
     try {
-      await this.#claimFromFaucet(depositor, "depositor", totalUSD);
+      await this.#claimFromFaucet(depositor, "depositor", claims);
     } catch (e) {
       if (this.#allowMint) {
         this.#logger?.error(`depositor failed to claim from faucet: ${e}`);
@@ -686,9 +684,9 @@ export class AccountOpener extends SDKConstruct {
     const borrower = await this.#getBorrower();
 
     // each account will have minDebt*minDebtMultiplier in USD, see how much we need to claim from faucet
-    let claimUSD = 0n;
     // collect all degen nfts
     const degenNFTS: Record<Address, number> = {};
+    const claims: AddressMap<bigint> = new AddressMap();
     for (const target of targets) {
       const cm = this.sdk.marketRegister.findCreditManager(
         target.creditManager,
@@ -700,15 +698,16 @@ export class AccountOpener extends SDKConstruct {
       const minDebt =
         (this.#minDebtMultiplier * cm.creditFacade.minDebt) / PERCENTAGE_FACTOR;
 
-      claimUSD += market.priceOracle.convertToUSD(cm.underlying, minDebt);
+      const claim = claims.get(cm.underlying) ?? 0n;
+      // 10% more to be safe
+      claims.upsert(cm.underlying, claim + (minDebt * 11n) / 10n);
 
       if (isAddress(degenNFT) && degenNFT !== ADDRESS_0X0) {
         degenNFTS[degenNFT] = (degenNFTS[degenNFT] ?? 0) + 1;
       }
     }
-    claimUSD = (claimUSD * 11n) / 10n; // 10% more to be safe
 
-    await this.#claimFromFaucet(borrower, "borrower", claimUSD);
+    await this.#claimFromFaucet(borrower, "borrower", claims);
 
     for (const [degenNFT, amount] of Object.entries(degenNFTS)) {
       await this.#mintDegenNft(degenNFT as Address, borrower.address, amount);
@@ -720,15 +719,16 @@ export class AccountOpener extends SDKConstruct {
   async #claimFromFaucet(
     claimer: PrivateKeyAccount,
     role: string,
-    amountUSD: bigint,
+    claims: AddressMap<bigint>,
   ): Promise<void> {
     await claimFromFaucet({
+      sdk: this.sdk,
       publicClient: this.#anvil,
       wallet: this.#anvil,
       faucet: this.faucet,
       claimer,
       role,
-      amountUSD,
+      amount: claims.entries().map(([k, v]) => ({ token: k, amount: v })),
       logger: this.#logger,
     });
   }
@@ -878,6 +878,7 @@ export class AccountOpener extends SDKConstruct {
       value: parseEther("100"),
     });
     await claimFromFaucet({
+      sdk: this.sdk,
       publicClient: this.#anvil,
       wallet: this.#anvil,
       faucet: this.faucet,

src/dev/claimFromFaucet.ts

@@ -1,3 +1,7 @@
+import type {
+  AbiParametersToPrimitiveTypes,
+  ExtractAbiFunction,
+} from "abitype";
 import {
   type Account,
   type Address,
@@ -6,15 +10,28 @@ import {
   type WalletClient,
 } from "viem";
 import { readContract } from "viem/actions";
-import { formatBN, type ILogger } from "../sdk/index.js";
+import { formatBN, type GearboxSDK, type ILogger } from "../sdk/index.js";
+
+interface TokenClaim {
+  token: Address;
+  amount: bigint;
+}
 
 interface ClaimFromFaucetOptions {
+  sdk: GearboxSDK;
   publicClient: PublicClient;
   wallet: WalletClient;
   faucet: Address;
   claimer: Account;
   role?: string;
-  amountUSD?: bigint | ((minAmountUSD: bigint) => bigint);
+  /**
+   * Either:
+   * - List of tokens with exact amounts to claim
+   * - Amount in USD
+   * - Function that returns amount in USD
+   * - Undefined (will claim default amount)
+   */
+  amount?: TokenClaim[] | bigint | ((minAmountUSD: bigint) => bigint);
   gasMultiplier?: bigint;
   logger?: ILogger;
 }
@@ -23,60 +40,77 @@ const faucetAbi = parseAbi([
   "function minAmountUSD() external view returns (uint256)",
   "function claim() external",
   "function claim(uint256 amountUSD) external",
+  "function claim((address token, uint256 amount)[] claims) external",
 ]);
 
 export async function claimFromFaucet(
   opts: ClaimFromFaucetOptions,
 ): Promise<void> {
   const {
+    sdk,
     publicClient,
     wallet,
     faucet,
     claimer,
     role,
-    amountUSD,
+    amount,
     logger,
     gasMultiplier = 10n,
   } = opts;
 
-  let toClaimUSD: bigint | undefined;
-  if (typeof amountUSD === "bigint") {
-    toClaimUSD = amountUSD;
-  } else if (typeof amountUSD === "function") {
-    toClaimUSD = await readContract(publicClient, {
+  let amnt = "default amount";
+  let args: AbiParametersToPrimitiveTypes<
+    ExtractAbiFunction<typeof faucetAbi, "claim">["inputs"]
+  >;
+  if (Array.isArray(amount)) {
+    args = [amount];
+    amnt = amount
+      .map(v => {
+        try {
+          return sdk.tokensMeta.formatBN(v.token, v.amount, { symbol: true });
+        } catch {
+          return `${v.amount} of ${v.token}`;
+        }
+      })
+      .join(", ");
+  } else if (typeof amount === "bigint") {
+    args = [amount];
+    amnt = `${formatBN(args[0], 8)} USD`;
+  } else if (typeof amount === "function") {
+    const minAmountUSD = await readContract(publicClient, {
       address: faucet,
       abi: faucetAbi,
       functionName: "minAmountUSD",
     });
-    logger?.debug(`faucet min amount USD: ${toClaimUSD}`);
-    toClaimUSD = amountUSD(toClaimUSD);
+    logger?.debug(`faucet min amount USD: ${minAmountUSD}`);
+    args = [amount(minAmountUSD)];
+    amnt = `${formatBN(args[0], 8)} USD`;
+  } else {
+    args = [];
   }
 
-  if (toClaimUSD === 0n) {
+  if (args[0] === 0n) {
     logger?.debug("amount is 0, skipping claim");
     return;
   }
 
-  const [usr, amnt] = [
-    [role, claimer.address].filter(Boolean).join(" "),
-    toClaimUSD ? formatBN(toClaimUSD, 8) : "default amount",
-  ];
+  const usr = [role, claimer.address].filter(Boolean).join(" ");
 
-  logger?.debug(`${usr} claiming ${amnt} USD from faucet`);
+  logger?.debug(`${usr} claiming ${amnt} from faucet`);
 
   const gas = await publicClient.estimateContractGas({
     account: claimer,
     address: faucet,
     abi: faucetAbi,
     functionName: "claim",
-    args: toClaimUSD ? [toClaimUSD] : [],
+    args,
   });
   const hash = await wallet.writeContract({
     account: claimer,
     address: faucet,
     abi: faucetAbi,
     functionName: "claim",
-    args: toClaimUSD ? [toClaimUSD] : [],
+    args,
     chain: wallet.chain,
     gas: gas * gasMultiplier,
   });
@@ -85,10 +119,8 @@ export async function claimFromFaucet(
   });
   if (receipt.status === "reverted") {
     throw new Error(
-      `${usr} failed to claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`,
+      `${usr} failed to claimed ${amnt} from faucet, tx: ${hash}`,
     );
   }
-  logger?.debug(
-    `${usr} claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`,
-  );
+  logger?.debug(`${usr} claimed ${amnt} from faucet, tx: ${hash}`);
 }