@gearbox-protocol/sdk 8.6.1 → 8.6.3

package/dist/cjs/dev/AccountOpener.js

@@ -28,6 +28,7 @@ var import_iERC20 = require("../abi/iERC20.js");
 var import_v300 = require("../abi/v300.js");
 var import_sdk = require("../sdk/index.js");
 var import_abi = require("./abi.js");
+var import_claimFromFaucet = require("./claimFromFaucet.js");
 var import_createAnvilClient = require("./createAnvilClient.js");
 class OpenTxRevertedError extends import_viem.BaseError {
   txHash;
@@ -68,7 +69,7 @@ class AccountOpener extends import_sdk.SDKConstruct {
   /**
    * Tries to open account with underlying only in each CM
    */
-  async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet = true) {
+  async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet2 = true) {
     if (depositIntoPools) {
       try {
         await this.#depositIntoPools(targets);
@@ -76,7 +77,7 @@ class AccountOpener extends import_sdk.SDKConstruct {
         this.#logger?.warn(`failed to deposit into pools: ${e}`);
       }
     }
-    if (claimFromFaucet) {
+    if (claimFromFaucet2) {
       await this.#prepareBorrower(targets);
     }
     const toApprove = new import_sdk.AddressMap();
@@ -386,41 +387,15 @@ class AccountOpener extends import_sdk.SDKConstruct {
     return borrower;
   }
   async #claimFromFaucet(claimer, role, amountUSD) {
-    const [usr, amnt] = [claimer.address, (0, import_sdk.formatBN)(amountUSD, 8)];
-    this.#logger?.debug(`${role} ${usr} claiming ${amnt} USD from faucet`);
-    if (amountUSD === 0n) {
-      this.#logger?.debug("amount is 0, skipping claim");
-      return;
-    }
-    const hash = await this.#anvil.writeContract({
-      account: claimer,
-      address: this.faucet,
-      abi: [
-        {
-          type: "function",
-          inputs: [
-            { name: "amountUSD", internalType: "uint256", type: "uint256" }
-          ],
-          name: "claim",
-          outputs: [],
-          stateMutability: "nonpayable"
-        }
-      ],
-      functionName: "claim",
-      args: [amountUSD],
-      chain: this.#anvil.chain
-    });
-    const receipt = await this.#anvil.waitForTransactionReceipt({
-      hash
+    await (0, import_claimFromFaucet.claimFromFaucet)({
+      publicClient: this.#anvil,
+      wallet: this.#anvil,
+      faucet: this.faucet,
+      claimer,
+      role,
+      amountUSD,
+      logger: this.#logger
     });
-    if (receipt.status === "reverted") {
-      throw new Error(
-        `${role} ${usr} failed to claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
-      );
-    }
-    this.#logger?.debug(
-      `${role} ${usr} claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
-    );
   }
   async #approve(token, cm) {
     const borrower = await this.#getBorrower();

package/dist/cjs/dev/claimFromFaucet.js

@@ -0,0 +1,95 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var claimFromFaucet_exports = {};
+__export(claimFromFaucet_exports, {
+  claimFromFaucet: () => claimFromFaucet
+});
+module.exports = __toCommonJS(claimFromFaucet_exports);
+var import_viem = require("viem");
+var import_actions = require("viem/actions");
+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"
+]);
+async function claimFromFaucet(opts) {
+  const {
+    publicClient,
+    wallet,
+    faucet,
+    claimer,
+    role,
+    amountUSD,
+    logger,
+    gasMultiplier = 10n
+  } = opts;
+  let toClaimUSD;
+  if (typeof amountUSD === "bigint") {
+    toClaimUSD = amountUSD;
+  } else if (typeof amountUSD === "function") {
+    toClaimUSD = await (0, import_actions.readContract)(publicClient, {
+      address: faucet,
+      abi: faucetAbi,
+      functionName: "minAmountUSD"
+    });
+    logger?.debug(`faucet min amount USD: ${toClaimUSD}`);
+    toClaimUSD = amountUSD(toClaimUSD);
+  }
+  if (toClaimUSD === 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 gas = await publicClient.estimateContractGas({
+    account: claimer,
+    address: faucet,
+    abi: faucetAbi,
+    functionName: "claim",
+    args: toClaimUSD ? [toClaimUSD] : []
+  });
+  const hash = await wallet.writeContract({
+    account: claimer,
+    address: faucet,
+    abi: faucetAbi,
+    functionName: "claim",
+    args: toClaimUSD ? [toClaimUSD] : [],
+    chain: wallet.chain,
+    gas: gas * gasMultiplier
+  });
+  const receipt = await publicClient.waitForTransactionReceipt({
+    hash
+  });
+  if (receipt.status === "reverted") {
+    throw new Error(
+      `${usr} failed to claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
+    );
+  }
+  logger?.debug(
+    `${usr} claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  claimFromFaucet
+});

package/dist/cjs/dev/index.js

@@ -18,6 +18,7 @@ module.exports = __toCommonJS(dev_exports);
 __reExport(dev_exports, require("./AccountOpener.js"), module.exports);
 __reExport(dev_exports, require("./CachedStateSubscriber.js"), module.exports);
 __reExport(dev_exports, require("./calcLiquidatableLTs.js"), module.exports);
+__reExport(dev_exports, require("./claimFromFaucet.js"), module.exports);
 __reExport(dev_exports, require("./create2.js"), module.exports);
 __reExport(dev_exports, require("./createAnvilClient.js"), module.exports);
 __reExport(dev_exports, require("./createTransport.js"), module.exports);
@@ -29,6 +30,7 @@ __reExport(dev_exports, require("./migrateFaucet.js"), module.exports);
   ...require("./AccountOpener.js"),
   ...require("./CachedStateSubscriber.js"),
   ...require("./calcLiquidatableLTs.js"),
+  ...require("./claimFromFaucet.js"),
   ...require("./create2.js"),
   ...require("./createAnvilClient.js"),
   ...require("./createTransport.js"),

package/dist/esm/dev/AccountOpener.js

@@ -13,6 +13,7 @@ import {
   sendRawTx
 } from "../sdk/index.js";
 import { iDegenNftv2Abi } from "./abi.js";
+import { claimFromFaucet } from "./claimFromFaucet.js";
 import { createAnvilClient } from "./createAnvilClient.js";
 class OpenTxRevertedError extends BaseError {
   txHash;
@@ -53,7 +54,7 @@ class AccountOpener extends SDKConstruct {
   /**
    * Tries to open account with underlying only in each CM
    */
-  async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet = true) {
+  async openCreditAccounts(targets, depositIntoPools = true, claimFromFaucet2 = true) {
     if (depositIntoPools) {
       try {
         await this.#depositIntoPools(targets);
@@ -61,7 +62,7 @@ class AccountOpener extends SDKConstruct {
         this.#logger?.warn(`failed to deposit into pools: ${e}`);
       }
     }
-    if (claimFromFaucet) {
+    if (claimFromFaucet2) {
       await this.#prepareBorrower(targets);
     }
     const toApprove = new AddressMap();
@@ -371,41 +372,15 @@ class AccountOpener extends SDKConstruct {
     return borrower;
   }
   async #claimFromFaucet(claimer, role, amountUSD) {
-    const [usr, amnt] = [claimer.address, formatBN(amountUSD, 8)];
-    this.#logger?.debug(`${role} ${usr} claiming ${amnt} USD from faucet`);
-    if (amountUSD === 0n) {
-      this.#logger?.debug("amount is 0, skipping claim");
-      return;
-    }
-    const hash = await this.#anvil.writeContract({
-      account: claimer,
-      address: this.faucet,
-      abi: [
-        {
-          type: "function",
-          inputs: [
-            { name: "amountUSD", internalType: "uint256", type: "uint256" }
-          ],
-          name: "claim",
-          outputs: [],
-          stateMutability: "nonpayable"
-        }
-      ],
-      functionName: "claim",
-      args: [amountUSD],
-      chain: this.#anvil.chain
-    });
-    const receipt = await this.#anvil.waitForTransactionReceipt({
-      hash
+    await claimFromFaucet({
+      publicClient: this.#anvil,
+      wallet: this.#anvil,
+      faucet: this.faucet,
+      claimer,
+      role,
+      amountUSD,
+      logger: this.#logger
     });
-    if (receipt.status === "reverted") {
-      throw new Error(
-        `${role} ${usr} failed to claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
-      );
-    }
-    this.#logger?.debug(
-      `${role} ${usr} claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
-    );
   }
   async #approve(token, cm) {
     const borrower = await this.#getBorrower();

package/dist/esm/dev/claimFromFaucet.js

@@ -0,0 +1,73 @@
+import {
+  parseAbi
+} from "viem";
+import { readContract } from "viem/actions";
+import { formatBN } from "../sdk/index.js";
+const faucetAbi = parseAbi([
+  "function minAmountUSD() external view returns (uint256)",
+  "function claim() external",
+  "function claim(uint256 amountUSD) external"
+]);
+async function claimFromFaucet(opts) {
+  const {
+    publicClient,
+    wallet,
+    faucet,
+    claimer,
+    role,
+    amountUSD,
+    logger,
+    gasMultiplier = 10n
+  } = opts;
+  let toClaimUSD;
+  if (typeof amountUSD === "bigint") {
+    toClaimUSD = amountUSD;
+  } else if (typeof amountUSD === "function") {
+    toClaimUSD = await readContract(publicClient, {
+      address: faucet,
+      abi: faucetAbi,
+      functionName: "minAmountUSD"
+    });
+    logger?.debug(`faucet min amount USD: ${toClaimUSD}`);
+    toClaimUSD = amountUSD(toClaimUSD);
+  }
+  if (toClaimUSD === 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 gas = await publicClient.estimateContractGas({
+    account: claimer,
+    address: faucet,
+    abi: faucetAbi,
+    functionName: "claim",
+    args: toClaimUSD ? [toClaimUSD] : []
+  });
+  const hash = await wallet.writeContract({
+    account: claimer,
+    address: faucet,
+    abi: faucetAbi,
+    functionName: "claim",
+    args: toClaimUSD ? [toClaimUSD] : [],
+    chain: wallet.chain,
+    gas: gas * gasMultiplier
+  });
+  const receipt = await publicClient.waitForTransactionReceipt({
+    hash
+  });
+  if (receipt.status === "reverted") {
+    throw new Error(
+      `${usr} failed to claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
+    );
+  }
+  logger?.debug(
+    `${usr} claimed equivalent of ${amnt} USD from faucet, tx: ${hash}`
+  );
+}
+export {
+  claimFromFaucet
+};

package/dist/esm/dev/index.js

@@ -1,6 +1,7 @@
 export * from "./AccountOpener.js";
 export * from "./CachedStateSubscriber.js";
 export * from "./calcLiquidatableLTs.js";
+export * from "./claimFromFaucet.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";
 export * from "./createTransport.js";

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

@@ -0,0 +1,14 @@
+import { type Address, type PrivateKeyAccount, type PublicClient, type WalletClient } from "viem";
+import { type ILogger } from "../sdk/index.js";
+interface ClaimFromFaucetOptions {
+    publicClient: PublicClient;
+    wallet: WalletClient;
+    faucet: Address;
+    claimer: PrivateKeyAccount;
+    role?: string;
+    amountUSD?: bigint | ((minAmountUSD: bigint) => bigint);
+    gasMultiplier?: bigint;
+    logger?: ILogger;
+}
+export declare function claimFromFaucet(opts: ClaimFromFaucetOptions): Promise<void>;
+export {};

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

@@ -1,6 +1,7 @@
 export * from "./AccountOpener.js";
 export * from "./CachedStateSubscriber.js";
 export * from "./calcLiquidatableLTs.js";
+export * from "./claimFromFaucet.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";
 export * from "./createTransport.js";

package/package.json

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