@gearbox-protocol/sdk 9.3.1 → 9.4.0

package/dist/cjs/dev/AccountOpener.js

@@ -162,28 +162,39 @@ class AccountOpener extends import_sdk.SDKConstruct {
     });
     logger?.debug(`opening account #${index}/${total}`);
     const borrower = await this.#getBorrower();
-    const tx = await this.prepareOpen(input);
+    const preview = await this.prepareOpen(input);
+    const humanizedInput = this.#humanizePreview(input, preview);
     let hash;
     try {
       hash = await (0, import_sdk.sendRawTx)(this.#anvil, {
-        tx,
+        tx: preview.tx,
         account: borrower
       });
       logger?.debug(`send transaction ${hash}`);
     } catch (e) {
       return {
         input,
+        humanizedInput,
         error: e,
-        rawTx: tx
+        rawTx: {
+          to: preview.tx.to,
+          callData: preview.tx.callData,
+          value: preview.tx.value
+        }
       };
     }
     const receipt = await this.#anvil.waitForTransactionReceipt({ hash });
     if (receipt.status === "reverted") {
       return {
         input,
+        humanizedInput,
         error: new OpenTxRevertedError(hash),
         txHash: hash,
-        rawTx: tx
+        rawTx: {
+          to: preview.tx.to,
+          callData: preview.tx.callData,
+          value: preview.tx.value
+        }
       };
     }
     logger?.info(`opened credit account ${index}/${total}`);
@@ -208,8 +219,13 @@ class AccountOpener extends import_sdk.SDKConstruct {
     }
     return {
       input,
+      humanizedInput,
       txHash: hash,
-      rawTx: tx,
+      rawTx: {
+        to: preview.tx.to,
+        callData: preview.tx.callData,
+        value: preview.tx.value
+      },
       account
     };
   }
@@ -318,7 +334,14 @@ class AccountOpener extends import_sdk.SDKConstruct {
       );
     }
     logger?.debug("prepared open account transaction");
-    return tx;
+    return {
+      tx,
+      leverage,
+      collateral: { token: underlying, balance: minDebt },
+      minQuota,
+      averageQuota,
+      slippage
+    };
   }
   async getOpenedAccounts() {
     return await this.#service.getCreditAccounts({
@@ -838,6 +861,19 @@ class AccountOpener extends import_sdk.SDKConstruct {
     result = BigInt(Math.floor(Number(result) / 1e3) * 1e3);
     return result;
   }
+  #humanizePreview(input, preview) {
+    return {
+      creditManager: this.sdk.labelAddress(input.creditManager),
+      target: this.sdk.labelAddress(input.target),
+      leverage: Number(preview.leverage),
+      slippage: preview.slippage,
+      collateral: this.sdk.tokensMeta.formatBN(preview.collateral, {
+        symbol: true
+      }),
+      minQuota: preview.minQuota.filter((q) => q.balance > 10n).map((q) => this.sdk.tokensMeta.formatBN(q, { symbol: true })),
+      averageQuota: preview.averageQuota.filter((q) => q.balance > 10n).map((q) => this.sdk.tokensMeta.formatBN(q, { symbol: true }))
+    };
+  }
   get faucet() {
     if (!this.#faucet) {
       throw new Error("faucet not found");

package/dist/cjs/sdk/base/TokensMeta.js

@@ -32,8 +32,10 @@ class TokensMeta extends import_utils.AddressMap {
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
     const amount = typeof arg0 === "object" ? arg0.balance : arg1;
-    const precision = typeof arg0 === "object" ? arg1 : arg2;
-    return (0, import_utils.formatBN)(amount, this.decimals(token), precision);
+    const options = typeof arg0 === "object" ? arg1 : arg2;
+    const { precision, symbol } = options ?? {};
+    const asStr = (0, import_utils.formatBN)(amount, this.decimals(token), precision);
+    return symbol ? `${asStr} ${this.symbol(token)}` : asStr;
   }
   findBySymbol(symbol) {
     return this.values().find((v) => v.symbol === symbol);

package/dist/esm/dev/AccountOpener.js

@@ -155,28 +155,39 @@ class AccountOpener extends SDKConstruct {
     });
     logger?.debug(`opening account #${index}/${total}`);
     const borrower = await this.#getBorrower();
-    const tx = await this.prepareOpen(input);
+    const preview = await this.prepareOpen(input);
+    const humanizedInput = this.#humanizePreview(input, preview);
     let hash;
     try {
       hash = await sendRawTx(this.#anvil, {
-        tx,
+        tx: preview.tx,
         account: borrower
       });
       logger?.debug(`send transaction ${hash}`);
     } catch (e) {
       return {
         input,
+        humanizedInput,
         error: e,
-        rawTx: tx
+        rawTx: {
+          to: preview.tx.to,
+          callData: preview.tx.callData,
+          value: preview.tx.value
+        }
       };
     }
     const receipt = await this.#anvil.waitForTransactionReceipt({ hash });
     if (receipt.status === "reverted") {
       return {
         input,
+        humanizedInput,
         error: new OpenTxRevertedError(hash),
         txHash: hash,
-        rawTx: tx
+        rawTx: {
+          to: preview.tx.to,
+          callData: preview.tx.callData,
+          value: preview.tx.value
+        }
       };
     }
     logger?.info(`opened credit account ${index}/${total}`);
@@ -201,8 +212,13 @@ class AccountOpener extends SDKConstruct {
     }
     return {
       input,
+      humanizedInput,
       txHash: hash,
-      rawTx: tx,
+      rawTx: {
+        to: preview.tx.to,
+        callData: preview.tx.callData,
+        value: preview.tx.value
+      },
       account
     };
   }
@@ -311,7 +327,14 @@ class AccountOpener extends SDKConstruct {
       );
     }
     logger?.debug("prepared open account transaction");
-    return tx;
+    return {
+      tx,
+      leverage,
+      collateral: { token: underlying, balance: minDebt },
+      minQuota,
+      averageQuota,
+      slippage
+    };
   }
   async getOpenedAccounts() {
     return await this.#service.getCreditAccounts({
@@ -831,6 +854,19 @@ class AccountOpener extends SDKConstruct {
     result = BigInt(Math.floor(Number(result) / 1e3) * 1e3);
     return result;
   }
+  #humanizePreview(input, preview) {
+    return {
+      creditManager: this.sdk.labelAddress(input.creditManager),
+      target: this.sdk.labelAddress(input.target),
+      leverage: Number(preview.leverage),
+      slippage: preview.slippage,
+      collateral: this.sdk.tokensMeta.formatBN(preview.collateral, {
+        symbol: true
+      }),
+      minQuota: preview.minQuota.filter((q) => q.balance > 10n).map((q) => this.sdk.tokensMeta.formatBN(q, { symbol: true })),
+      averageQuota: preview.averageQuota.filter((q) => q.balance > 10n).map((q) => this.sdk.tokensMeta.formatBN(q, { symbol: true }))
+    };
+  }
   get faucet() {
     if (!this.#faucet) {
       throw new Error("faucet not found");

package/dist/esm/sdk/base/TokensMeta.js

@@ -9,8 +9,10 @@ class TokensMeta extends AddressMap {
   formatBN(arg0, arg1, arg2) {
     const token = typeof arg0 === "object" ? arg0.token : arg0;
     const amount = typeof arg0 === "object" ? arg0.balance : arg1;
-    const precision = typeof arg0 === "object" ? arg1 : arg2;
-    return formatBN(amount, this.decimals(token), precision);
+    const options = typeof arg0 === "object" ? arg1 : arg2;
+    const { precision, symbol } = options ?? {};
+    const asStr = formatBN(amount, this.decimals(token), precision);
+    return symbol ? `${asStr} ${this.symbol(token)}` : asStr;
   }
   findBySymbol(symbol) {
     return this.values().find((v) => v.symbol === symbol);

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

@@ -1,6 +1,6 @@
 import type { Address, Hash, Hex, PrivateKeyAccount } from "viem";
 import { BaseError } from "viem";
-import type { CreditAccountData, ICreditAccountsService, RawTx } from "../sdk/index.js";
+import type { Asset, CreditAccountData, ICreditAccountsService, RawTx } from "../sdk/index.js";
 import { SDKConstruct } from "../sdk/index.js";
 export declare class OpenTxRevertedError extends BaseError {
     readonly txHash: Hash;
@@ -42,11 +42,35 @@ export interface TargetAccount {
      */
     slippage?: number;
 }
+interface OpenAccountPreview {
+    tx: RawTx;
+    /**
+     * Actual leverage, with percentage factor
+     */
+    leverage: bigint;
+    /**
+     * What user adds as collateral
+     */
+    collateral: Asset;
+    minQuota: Asset[];
+    averageQuota: Asset[];
+    slippage: number;
+}
+export interface OpenAccountHumanizedPreview {
+    creditManager: string;
+    target: string;
+    collateral: string;
+    leverage: number;
+    slippage: number;
+    minQuota: string[];
+    averageQuota: string[];
+}
 export interface OpenAccountResult {
     input: TargetAccount;
+    humanizedInput?: OpenAccountHumanizedPreview;
     error?: Error;
     txHash?: string;
-    rawTx?: RawTx;
+    rawTx?: Pick<RawTx, "to" | "callData" | "value">;
     account?: CreditAccountData;
 }
 export type PoolDepositResult = {
@@ -76,7 +100,8 @@ export declare class AccountOpener extends SDKConstruct {
      * Tries to open account with underlying only in each CM
      */
     openCreditAccounts(targets: TargetAccount[], depositIntoPools?: boolean, claimFromFaucet?: boolean): Promise<OpenAccountsResult>;
-    prepareOpen(input: TargetAccount): Promise<RawTx>;
+    prepareOpen(input: TargetAccount): Promise<OpenAccountPreview>;
     getOpenedAccounts(): Promise<CreditAccountData[]>;
     get faucet(): Address;
 }
+export {};

package/dist/types/sdk/base/TokensMeta.d.ts

@@ -2,11 +2,15 @@ import type { Address } from "viem";
 import type { Asset } from "../router/index.js";
 import { AddressMap } from "../utils/index.js";
 import type { TokenMetaData } from "./types.js";
+export interface FormatBNOptions {
+    precision?: number;
+    symbol?: boolean;
+}
 export declare class TokensMeta extends AddressMap<TokenMetaData> {
     symbol(token: Address): string;
     decimals(token: Address): number;
-    formatBN(asset: Asset, precision?: number): string;
-    formatBN(token: Address, amount: number | bigint | string | undefined, precision?: number): string;
+    formatBN(asset: Asset, options?: FormatBNOptions): string;
+    formatBN(token: Address, amount: number | bigint | string | undefined, options?: FormatBNOptions): string;
     findBySymbol(symbol: string): TokenMetaData | undefined;
     mustFindBySymbol(symbol: string): TokenMetaData;
 }

package/package.json

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