@gearbox-protocol/sdk 3.0.0-next.8 → 3.0.0-next.81

package/lib/core/strategy.spec.js

@@ -2,23 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
 const chai_1 = require("chai");
-const contractsRegister_1 = require("../contracts/contractsRegister");
 const formatter_1 = require("../utils/formatter");
 const strategy_1 = require("./strategy");
-const lidoPayload = {
-    name: "Lido",
-    lpToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-    apy: 38434,
-    creditManagers: [contractsRegister_1.creditManagerByNetwork.Mainnet.WETH_V2],
-    unleveragableCollateral: [
-        sdk_gov_1.tokenDataByNetwork.Mainnet.USDC,
-        sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
-        sdk_gov_1.tokenDataByNetwork.Mainnet.WBTC,
-    ],
-    leveragableCollateral: [],
-    baseAssets: [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH],
-};
-const lidoStrategy = new strategy_1.Strategy(lidoPayload);
 const pools = {
     "0x1": {
         borrowRate: 27543,
@@ -39,17 +24,82 @@ const liquidationThresholds = {
 };
 describe("Strategy test", () => {
     it("maxAPY calculation is correct", () => {
-        const result = lidoStrategy.maxAPY(53203, 10 * Number(sdk_gov_1.LEVERAGE_DECIMALS), pools["0x1"].borrowRate);
+        const result = strategy_1.Strategy.maxAPY(53203, 10 * Number(sdk_gov_1.LEVERAGE_DECIMALS), pools["0x1"].borrowRate);
         (0, chai_1.expect)(result).to.be.eq(284143);
     });
-    it("liquidationPrice calculation is correct", () => {
+    it("liquidationPrice: calculation is correct", () => {
+        const result = strategy_1.Strategy.liquidationPrice({
+            liquidationThresholds,
+            prices,
+            borrowed: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
+            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            assets: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                },
+            },
+        });
+        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.992");
+    });
+    it("liquidationPrice: zero result when debt is compensated", () => {
+        const result = strategy_1.Strategy.liquidationPrice({
+            liquidationThresholds,
+            prices,
+            borrowed: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
+            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            assets: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                },
+            },
+        });
+        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.000");
+    });
+    it("liquidationPrice: zero result when debt is overcompensated", () => {
         const result = strategy_1.Strategy.liquidationPrice({
             liquidationThresholds,
             prices,
             borrowed: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
             underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-            lpAmount: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
-            lpToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            assets: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("450", sdk_gov_1.decimals.WETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                },
+            },
+        });
+        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.000");
+    });
+    it("liquidationPrice: zero result when debt is not compensated", () => {
+        const result = strategy_1.Strategy.liquidationPrice({
+            liquidationThresholds,
+            prices,
+            borrowed: (0, formatter_1.toBN)("450", sdk_gov_1.decimals.WETH),
+            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            assets: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
+                    balance: (0, formatter_1.toBN)("100", sdk_gov_1.decimals.WETH),
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                },
+            },
         });
         (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.992");
     });

package/lib/core/trade.d.ts

@@ -8,29 +8,30 @@ interface Info {
 }
 export type TradeOperations = "farmWithdraw" | "farmDeposit" | "swap";
 export interface GetTradesProps {
-    from: string;
-    to: string;
+    tokenIn: string;
+    tokenOut: string;
     amount: bigint;
     results: Array<PathFinderResult>;
     creditManager: CreditManagerData;
     currentContracts: Record<SupportedContract, string>;
-    swapType: SwapOperation;
+    swapOperation: SwapOperation;
     swapName: TradeOperations;
 }
 export declare class Trade {
     readonly helper: Info;
     readonly tradePath: PathFinderResult;
-    readonly swapType: SwapOperation;
+    readonly swapOperation: SwapOperation;
     readonly sourceAmount: bigint;
-    readonly expectedAmount: bigint;
+    readonly minExpectedAmount: bigint;
+    readonly averageExpectedAmount: bigint;
     readonly rate: bigint;
-    readonly tokenFrom: string;
-    readonly tokenTo: string;
+    readonly tokenIn: string;
+    readonly tokenOut: string;
     readonly operationName: TradeOperations;
     private constructor();
     getName(): string;
     toString(): string;
-    static getTrades({ from, to, amount, results, creditManager, currentContracts, swapType, swapName, }: GetTradesProps): Trade[];
+    static getTrades({ tokenIn, tokenOut, amount, results, creditManager, currentContracts, swapOperation, swapName, }: GetTradesProps): Trade[];
     static getCallInfo(calls: Array<MultiCall>, creditManager: string, currentContracts: Record<SupportedContract, string>): Info[];
     private static getContractSymbol;
     static sortTrades(trades: Array<Trade>, swapStrategy: string): Trade[];

package/lib/core/trade.js

@@ -4,54 +4,60 @@ exports.Trade = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
 const txParser_1 = require("../parsers/txParser");
 const core_1 = require("../pathfinder/core");
-const formatter_1 = require("../utils/formatter");
 class Trade {
     helper;
     tradePath;
-    swapType;
+    swapOperation;
     sourceAmount;
-    expectedAmount;
+    minExpectedAmount;
+    averageExpectedAmount;
     rate;
-    tokenFrom;
-    tokenTo;
+    tokenIn;
+    tokenOut;
     operationName;
     constructor(props) {
         this.helper = props.adapter;
         this.tradePath = props.tradePath;
-        this.swapType = props.swapType;
+        this.swapOperation = props.swapOperation;
         this.sourceAmount = props.sourceAmount;
-        this.expectedAmount = props.expectedAmount;
-        this.rate = (sdk_gov_1.WAD * props.expectedAmount) / props.sourceAmount;
-        this.tokenFrom = props.tokenFrom;
-        this.tokenTo = props.tokenTo;
+        this.minExpectedAmount = props.minExpectedAmount;
+        this.averageExpectedAmount = props.averageExpectedAmount;
+        this.rate = (sdk_gov_1.WAD * props.minExpectedAmount) / props.sourceAmount;
+        this.tokenIn = props.tokenIn;
+        this.tokenOut = props.tokenOut;
         this.operationName = props.swapName;
     }
     getName() {
         return this.helper.name;
     }
     toString() {
-        const symbolFrom = sdk_gov_1.tokenSymbolByAddress[this.tokenFrom.toLowerCase()];
-        const symbolTo = sdk_gov_1.tokenSymbolByAddress[this.tokenTo.toLowerCase()];
+        const symbolFrom = sdk_gov_1.tokenSymbolByAddress[this.tokenIn.toLowerCase()];
+        const symbolTo = sdk_gov_1.tokenSymbolByAddress[this.tokenOut.toLowerCase()];
         if (!symbolFrom)
-            throw new Error(`Unknown token: ${this.tokenFrom}`);
+            throw new Error(`Unknown token: ${this.tokenIn}`);
         if (!symbolTo)
-            throw new Error(`Unknown token: ${this.tokenTo}`);
+            throw new Error(`Unknown token: ${this.tokenOut}`);
         const decimalsFrom = sdk_gov_1.decimals[symbolFrom];
         const decimalsTo = sdk_gov_1.decimals[symbolTo];
-        return `${this.operationName} ${(0, formatter_1.formatBN)(this.sourceAmount, decimalsFrom)} ${symbolFrom} ⇒ ${(0, formatter_1.formatBN)(this.expectedAmount, decimalsTo)} ${symbolTo} on ${this.helper.name}`;
+        return `${this.operationName} ${(0, sdk_gov_1.formatBN)(this.sourceAmount, decimalsFrom)} ${symbolFrom} ⇒ ${(0, sdk_gov_1.formatBN)(this.minExpectedAmount, decimalsTo)} ${symbolTo} on ${this.helper.name}`;
     }
-    static getTrades({ from, to, amount, results, creditManager, currentContracts, swapType, swapName, }) {
+    static getTrades({ tokenIn, tokenOut, amount, results, creditManager, currentContracts, swapOperation, swapName, }) {
         const trades = results.reduce((acc, tradePath) => {
             const { calls } = tradePath;
             const callInfo = Trade.getCallInfo(calls, creditManager.address, currentContracts);
             const trade = new Trade({
                 tradePath,
-                adapter: callInfo[0],
-                swapType,
+                adapter: callInfo[0] || {
+                    name: "unknown",
+                    contractAddress: calls[0]?.target || "",
+                    creditManager: creditManager.address,
+                },
+                swapOperation,
                 sourceAmount: amount,
-                expectedAmount: tradePath.amount,
-                tokenFrom: from,
-                tokenTo: to,
+                minExpectedAmount: tradePath.minAmount,
+                averageExpectedAmount: tradePath.amount,
+                tokenIn,
+                tokenOut,
                 swapName,
             });
             acc.push(trade);
@@ -62,8 +68,9 @@ class Trade {
     static getCallInfo(calls, creditManager, currentContracts) {
         const callAdapters = calls.reduce((acc, call) => {
             const contractSymbol = this.getContractSymbol(call.target.toLowerCase());
-            if (!(0, sdk_gov_1.isSupportedContract)(contractSymbol))
+            if (!(0, sdk_gov_1.isSupportedContract)(contractSymbol)) {
                 return acc;
+            }
             const { name } = sdk_gov_1.contractParams[contractSymbol];
             const contractAddress = currentContracts[contractSymbol];
             acc.push({
@@ -87,13 +94,13 @@ class Trade {
     static sortTrades(trades, swapStrategy) {
         if (trades.length === 0)
             return [];
-        const { swapType } = trades[0];
+        const { swapOperation } = trades[0];
         const sorted = [...trades].sort((a, b) => {
             const aSelected = a.getName().toLowerCase().search(swapStrategy.toLowerCase()) >= 0;
             const bSelected = b.getName().toLowerCase().search(swapStrategy.toLowerCase()) >= 0;
             if ((aSelected && bSelected) || (!aSelected && !bSelected)) {
-                const sign = a.expectedAmount > b.expectedAmount ? -1 : 1;
-                return swapType === core_1.SwapOperation.EXACT_INPUT ? sign : -sign;
+                const sign = a.minExpectedAmount > b.minExpectedAmount ? -1 : 1;
+                return swapOperation === core_1.SwapOperation.EXACT_INPUT ? sign : -sign;
             }
             return aSelected ? -1 : 1;
         });

package/lib/core/transactions.d.ts

@@ -1,7 +1,8 @@
 import { SupportedContract } from "@gearbox-protocol/sdk-gov";
+import { Asset } from "./assets";
 import { EVMTx, EVMTxProps } from "./eventOrTx";
 export interface TxSerialized {
-    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxDecreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimGearRewards" | "TxEnableTokens";
+    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxDecreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimGearRewards" | "TxEnableTokens" | "TxUpdateQuota" | "TxGaugeStake" | "TxGaugeUnstake" | "TxGaugeClaim" | "TxGaugeVote" | "TxWithdrawCollateral";
     content: string;
 }
 export declare class TxSerializer {
@@ -133,9 +134,7 @@ export declare class TxClaimReward extends EVMTx {
     toString(): string;
     serialize(): TxSerialized;
 }
-type TxClaimNFTProps = EVMTxProps;
 export declare class TxClaimNFT extends EVMTx {
-    constructor(opts: TxClaimNFTProps);
     toString(): string;
     serialize(): TxSerialized;
 }
@@ -190,4 +189,67 @@ export declare class TxEnableTokens extends EVMTx {
     toString(): string;
     serialize(): TxSerialized;
 }
+interface TxUpdateQuotaProps extends EVMTxProps {
+    updatedQuotas: Array<Asset>;
+    underlyingToken: string;
+    creditManager: string;
+}
+export declare class TxUpdateQuota extends EVMTx {
+    readonly updatedQuotas: Array<Asset>;
+    readonly underlyingToken: string;
+    readonly creditManager: string;
+    constructor(opts: TxUpdateQuotaProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface TxGaugeStakeProps extends EVMTxProps {
+    amount: bigint;
+}
+export declare class TxGaugeStake extends EVMTx {
+    readonly amount: bigint;
+    constructor(opts: TxGaugeStakeProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface TxGaugeUnstakeProps extends EVMTxProps {
+    amount: bigint;
+}
+export declare class TxGaugeUnstake extends EVMTx {
+    readonly amount: bigint;
+    constructor(opts: TxGaugeUnstakeProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+export declare class TxGaugeClaim extends EVMTx {
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface TxGaugeVoteProps extends EVMTxProps {
+    tokens: Array<{
+        token: string;
+    }>;
+}
+export declare class TxGaugeVote extends EVMTx {
+    readonly tokens: Array<{
+        token: string;
+    }>;
+    constructor(opts: TxGaugeVoteProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface WithdrawCollateralProps extends EVMTxProps {
+    amount: bigint;
+    token: string;
+    to: string;
+    creditManager: string;
+}
+export declare class TxWithdrawCollateral extends EVMTx {
+    readonly amount: bigint;
+    readonly token: string;
+    readonly to: string;
+    readonly creditManager: string;
+    constructor(opts: WithdrawCollateralProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 export {};