@gearbox-protocol/sdk 11.8.4 → 11.8.6

package/dist/cjs/dev/AccountOpener.js

@@ -77,6 +77,18 @@ class AccountOpener extends import_sdk.SDKConstruct {
     this.#poolDepositMultiplier = BigInt(poolDepositMultiplier);
     this.#minDebtMultiplier = BigInt(minDebtMultiplier);
     this.#leverageDelta = BigInt(leverageDelta);
+    this.#logger?.info(
+      {
+        borrower: (0, import_accounts.privateKeyToAccount)(this.borrowerKey).address,
+        depositor: (0, import_accounts.privateKeyToAccount)(this.depositorKey).address,
+        faucet: this.faucet,
+        poolDepositMultiplier: this.#poolDepositMultiplier.toString(),
+        minDebtMultiplier: this.#minDebtMultiplier.toString(),
+        leverageDelta: this.#leverageDelta.toString(),
+        allowMint: this.#allowMint
+      },
+      "account opener options"
+    );
   }
   get borrower() {
     if (!this.#borrower) {
@@ -94,6 +106,14 @@ class AccountOpener extends import_sdk.SDKConstruct {
    * Tries to open account with underlying only in each CM
    */
   async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet2 = true) {
+    this.#logger?.info(
+      {
+        targets,
+        depositIntoPools,
+        claimFromFaucet: claimFromFaucet2
+      },
+      "opening credit accounts"
+    );
     let deposits = [];
     if (depositIntoPools) {
       try {
@@ -364,8 +384,8 @@ class AccountOpener extends import_sdk.SDKConstruct {
         `target #${i + 1} (${this.labelAddress(t.target)}) needs ${this.sdk.tokensMeta.formatBN(cm.underlying, amount, { symbol: true })} in pool (leverage: ${Number(leverage / import_sdk.PERCENTAGE_FACTOR)}%)`
       );
     }
-    let totalUSD = 0n;
     const deposits = [];
+    const claims = new import_sdk.AddressMap();
     for (const [p, minAvailable] of Object.entries(minAvailableByPool)) {
       const market = this.sdk.marketRegister.findByPool(p);
       const pool = market.pool.pool;
@@ -383,17 +403,15 @@ class AccountOpener extends import_sdk.SDKConstruct {
       );
       if (diff > 0n) {
         deposits.push([pool, diff]);
-        totalUSD += market.priceOracle.convertToUSD(pool.underlying, diff);
+        let claim = claims.get(pool.underlying) ?? 0n;
+        claim += diff * import_sdk.PERCENTAGE_FACTOR / 8950n;
+        claims.upsert(pool.underlying, claim);
       }
     }
-    totalUSD = totalUSD * import_sdk.PERCENTAGE_FACTOR / 8950n;
-    this.#logger?.debug(
-      `total USD to claim from faucet: ${(0, import_sdk.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}`);
@@ -510,8 +528,8 @@ class AccountOpener extends import_sdk.SDKConstruct {
    */
   async #prepareBorrower(targets) {
     const borrower = await this.#getBorrower();
-    let claimUSD = 0n;
     const degenNFTS = {};
+    const claims = new import_sdk.AddressMap();
     for (const target of targets) {
       const cm = this.sdk.marketRegister.findCreditManager(
         target.creditManager
@@ -521,27 +539,28 @@ class AccountOpener extends import_sdk.SDKConstruct {
       );
       const { degenNFT } = cm.creditFacade;
       const minDebt = this.#minDebtMultiplier * cm.creditFacade.minDebt / import_sdk.PERCENTAGE_FACTOR;
-      claimUSD += market.priceOracle.convertToUSD(cm.underlying, minDebt);
+      const claim = claims.get(cm.underlying) ?? 0n;
+      claims.upsert(cm.underlying, claim + minDebt * 11n / 10n);
       if ((0, import_viem.isAddress)(degenNFT) && degenNFT !== import_sdk.ADDRESS_0X0) {
         degenNFTS[degenNFT] = (degenNFTS[degenNFT] ?? 0) + 1;
       }
     }
-    claimUSD = claimUSD * 11n / 10n;
-    await this.#claimFromFaucet(borrower, "borrower", claimUSD);
+    await this.#claimFromFaucet(borrower, "borrower", claims);
     for (const [degenNFT, amount] of Object.entries(degenNFTS)) {
       await this.#mintDegenNft(degenNFT, borrower.address, amount);
     }
     this.#logger?.debug("prepared borrower");
     return borrower;
   }
-  async #claimFromFaucet(claimer, role, amountUSD) {
+  async #claimFromFaucet(claimer, role, claims) {
     await (0, import_claimFromFaucet.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
     });
   }
@@ -677,6 +696,7 @@ class AccountOpener extends import_sdk.SDKConstruct {
       value: (0, import_viem.parseEther)("100")
     });
     await (0, import_claimFromFaucet.claimFromFaucet)({
+      sdk: this.sdk,
       publicClient: this.#anvil,
       wallet: this.#anvil,
       faucet: this.faucet,

package/dist/cjs/dev/claimFromFaucet.js

@@ -27,53 +27,66 @@ var import_sdk = require("../sdk/index.js");
 const faucetAbi = (0, import_viem.parseAbi)([
   "function minAmountUSD() external view returns (uint256)",
   "function claim() external",
-  "function claim(uint256 amountUSD) external"
+  "function claim(uint256 amountUSD) external",
+  "function claim((address token, uint256 amount)[] claims) external"
 ]);
 async function claimFromFaucet(opts) {
   const {
+    sdk,
     publicClient,
     wallet,
     faucet,
     claimer,
     role,
-    amountUSD,
+    amount,
     logger,
     gasMultiplier = 10n
   } = opts;
-  let toClaimUSD;
-  if (typeof amountUSD === "bigint") {
-    toClaimUSD = amountUSD;
-  } else if (typeof amountUSD === "function") {
-    toClaimUSD = await (0, import_actions.readContract)(publicClient, {
+  let amnt = "default amount";
+  let args;
+  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 = `${(0, import_sdk.formatBN)(args[0], 8)} USD`;
+  } else if (typeof amount === "function") {
+    const minAmountUSD = await (0, import_actions.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 = `${(0, import_sdk.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 ? (0, import_sdk.formatBN)(toClaimUSD, 8) : "default amount"
-  ];
-  logger?.debug(`${usr} claiming ${amnt} USD from faucet`);
+  const usr = [role, claimer.address].filter(Boolean).join(" ");
+  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
   });
@@ -82,12 +95,10 @@ async function claimFromFaucet(opts) {
   });
   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}`);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/esm/dev/AccountOpener.js

@@ -13,7 +13,6 @@ import {
   AddressMap,
   AddressSet,
   childLogger,
-  formatBN,
   MAX_UINT256,
   PERCENTAGE_FACTOR,
   SDKConstruct,
@@ -69,6 +68,18 @@ class AccountOpener extends SDKConstruct {
     this.#poolDepositMultiplier = BigInt(poolDepositMultiplier);
     this.#minDebtMultiplier = BigInt(minDebtMultiplier);
     this.#leverageDelta = BigInt(leverageDelta);
+    this.#logger?.info(
+      {
+        borrower: privateKeyToAccount(this.borrowerKey).address,
+        depositor: privateKeyToAccount(this.depositorKey).address,
+        faucet: this.faucet,
+        poolDepositMultiplier: this.#poolDepositMultiplier.toString(),
+        minDebtMultiplier: this.#minDebtMultiplier.toString(),
+        leverageDelta: this.#leverageDelta.toString(),
+        allowMint: this.#allowMint
+      },
+      "account opener options"
+    );
   }
   get borrower() {
     if (!this.#borrower) {
@@ -86,6 +97,14 @@ class AccountOpener extends SDKConstruct {
    * Tries to open account with underlying only in each CM
    */
   async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet2 = true) {
+    this.#logger?.info(
+      {
+        targets,
+        depositIntoPools,
+        claimFromFaucet: claimFromFaucet2
+      },
+      "opening credit accounts"
+    );
     let deposits = [];
     if (depositIntoPools) {
       try {
@@ -356,8 +375,8 @@ class AccountOpener extends SDKConstruct {
         `target #${i + 1} (${this.labelAddress(t.target)}) needs ${this.sdk.tokensMeta.formatBN(cm.underlying, amount, { symbol: true })} in pool (leverage: ${Number(leverage / PERCENTAGE_FACTOR)}%)`
       );
     }
-    let totalUSD = 0n;
     const deposits = [];
+    const claims = new AddressMap();
     for (const [p, minAvailable] of Object.entries(minAvailableByPool)) {
       const market = this.sdk.marketRegister.findByPool(p);
       const pool = market.pool.pool;
@@ -375,17 +394,15 @@ 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;
+        claim += diff * PERCENTAGE_FACTOR / 8950n;
+        claims.upsert(pool.underlying, claim);
       }
     }
-    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}`);
@@ -502,8 +519,8 @@ class AccountOpener extends SDKConstruct {
    */
   async #prepareBorrower(targets) {
     const borrower = await this.#getBorrower();
-    let claimUSD = 0n;
     const degenNFTS = {};
+    const claims = new AddressMap();
     for (const target of targets) {
       const cm = this.sdk.marketRegister.findCreditManager(
         target.creditManager
@@ -513,27 +530,28 @@ class AccountOpener extends SDKConstruct {
       );
       const { degenNFT } = cm.creditFacade;
       const minDebt = this.#minDebtMultiplier * cm.creditFacade.minDebt / PERCENTAGE_FACTOR;
-      claimUSD += market.priceOracle.convertToUSD(cm.underlying, minDebt);
+      const claim = claims.get(cm.underlying) ?? 0n;
+      claims.upsert(cm.underlying, claim + minDebt * 11n / 10n);
       if (isAddress(degenNFT) && degenNFT !== ADDRESS_0X0) {
         degenNFTS[degenNFT] = (degenNFTS[degenNFT] ?? 0) + 1;
       }
     }
-    claimUSD = claimUSD * 11n / 10n;
-    await this.#claimFromFaucet(borrower, "borrower", claimUSD);
+    await this.#claimFromFaucet(borrower, "borrower", claims);
     for (const [degenNFT, amount] of Object.entries(degenNFTS)) {
       await this.#mintDegenNft(degenNFT, borrower.address, amount);
     }
     this.#logger?.debug("prepared borrower");
     return borrower;
   }
-  async #claimFromFaucet(claimer, role, amountUSD) {
+  async #claimFromFaucet(claimer, role, claims) {
     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
     });
   }
@@ -669,6 +687,7 @@ class AccountOpener extends SDKConstruct {
       value: parseEther("100")
     });
     await claimFromFaucet({
+      sdk: this.sdk,
       publicClient: this.#anvil,
       wallet: this.#anvil,
       faucet: this.faucet,

package/dist/esm/dev/claimFromFaucet.js

@@ -6,53 +6,66 @@ import { formatBN } from "../sdk/index.js";
 const faucetAbi = parseAbi([
   "function minAmountUSD() external view returns (uint256)",
   "function claim() external",
-  "function claim(uint256 amountUSD) external"
+  "function claim(uint256 amountUSD) external",
+  "function claim((address token, uint256 amount)[] claims) external"
 ]);
 async function claimFromFaucet(opts) {
   const {
+    sdk,
     publicClient,
     wallet,
     faucet,
     claimer,
     role,
-    amountUSD,
+    amount,
     logger,
     gasMultiplier = 10n
   } = opts;
-  let toClaimUSD;
-  if (typeof amountUSD === "bigint") {
-    toClaimUSD = amountUSD;
-  } else if (typeof amountUSD === "function") {
-    toClaimUSD = await readContract(publicClient, {
+  let amnt = "default amount";
+  let args;
+  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"
-  ];
-  logger?.debug(`${usr} claiming ${amnt} USD from faucet`);
+  const usr = [role, claimer.address].filter(Boolean).join(" ");
+  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
   });
@@ -61,12 +74,10 @@ async function claimFromFaucet(opts) {
   });
   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}`);
 }
 export {
   claimFromFaucet

package/dist/types/dev/claimFromFaucet.d.ts

@@ -1,12 +1,24 @@
 import { type Account, type Address, type PublicClient, type WalletClient } from "viem";
-import { type ILogger } from "../sdk/index.js";
+import { 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;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "11.8.4",
+  "version": "11.8.6",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",