@gearbox-protocol/sdk 3.0.0-next.184 → 3.0.0-next.185

package/lib/apy/index.d.ts

@@ -1,9 +1,14 @@
 import { LPTokens, PartialRecord, SupportedToken } from "@gearbox-protocol/sdk-gov";
-export type AdditionalTokenWithAPY = Extract<SupportedToken, "STETH" | "weETH" | "osETH" | "rETH" | "wstETH" | "ezETH" | "cbETH" | "sfrxETH" | "USDe" | "rsETH" | "rswETH" | "pufETH">;
-export declare const additionalTokensWithAPY: Record<AdditionalTokenWithAPY, true>;
-export type TokensWithAPY = LPTokens | AdditionalTokenWithAPY;
-export type LpTokensAPY = PartialRecord<TokensWithAPY, number>;
+type AdditionalTokensWithAPY = Extract<SupportedToken, "STETH" | "rETH" | "osETH" | "cbETH" | "wstETH" | "sfrxETH">;
+type AdditionalLPTokens = Extract<SupportedToken, "weETH" | "ezETH" | "sfrxETH" | "USDe" | "rsETH" | "rswETH" | "pufETH">;
+export declare const isAdditionalLPToken: (t: unknown) => t is AdditionalLPTokens;
+export type TokensWithAPY = LPTokens | AdditionalTokensWithAPY;
+export type TokensWithApyRecord = PartialRecord<TokensWithAPY, number>;
+export declare const isAdditionalTokenWithAPY: (t: unknown) => t is AdditionalTokensWithAPY;
+export declare const isExtraFarmToken: (t: unknown) => boolean;
 export declare const isTokenWithAPY: (t: unknown) => t is TokensWithAPY;
+export type AllLPTokens = LPTokens | AdditionalLPTokens | AdditionalTokensWithAPY;
+export declare const isFarmToken: (t: unknown) => t is AllLPTokens;
 export * from "./convexAPY";
 export * from "./curveAPY";
 export * from "./defiLamaAPY";

package/lib/apy/index.js

@@ -14,26 +14,49 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTokenWithAPY = exports.additionalTokensWithAPY = void 0;
+exports.isFarmToken = exports.isTokenWithAPY = exports.isExtraFarmToken = exports.isAdditionalTokenWithAPY = exports.isAdditionalLPToken = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
-exports.additionalTokensWithAPY = {
-    STETH: true,
+const ADDITIONAL_LP_TOKENS = {
     weETH: true,
-    osETH: true,
-    rETH: true,
-    wstETH: true,
     ezETH: true,
-    cbETH: true,
     sfrxETH: true,
     USDe: true,
     rsETH: true,
     rswETH: true,
     pufETH: true,
 };
-const isTokenWithAPY = (t) => typeof t === "string" &&
-    (!!sdk_gov_1.lpTokens[t] ||
-        !!exports.additionalTokensWithAPY[t]);
+const TOKENS_WITH_APY = {
+    STETH: true,
+    osETH: true,
+    rETH: true,
+    wstETH: true,
+    cbETH: true,
+    sfrxETH: true,
+};
+const isAdditionalLPToken = (t) => {
+    if (typeof t !== "string")
+        return false;
+    return !!ADDITIONAL_LP_TOKENS[t];
+};
+exports.isAdditionalLPToken = isAdditionalLPToken;
+const isAdditionalTokenWithAPY = (t) => {
+    if (typeof t !== "string")
+        return false;
+    return !!TOKENS_WITH_APY[t];
+};
+exports.isAdditionalTokenWithAPY = isAdditionalTokenWithAPY;
+const isExtraFarmToken = (t) => (0, exports.isAdditionalLPToken)(t) || (0, exports.isAdditionalTokenWithAPY)(t);
+exports.isExtraFarmToken = isExtraFarmToken;
+const isTokenWithAPY = (t) => {
+    if (typeof t !== "string")
+        return false;
+    return (0, sdk_gov_1.isLPToken)(t) || (0, exports.isAdditionalTokenWithAPY)(t);
+};
 exports.isTokenWithAPY = isTokenWithAPY;
+const isFarmToken = (t) => {
+    return (0, sdk_gov_1.isLPToken)(t) || (0, exports.isExtraFarmToken)(t);
+};
+exports.isFarmToken = isFarmToken;
 __exportStar(require("./convexAPY"), exports);
 __exportStar(require("./curveAPY"), exports);
 __exportStar(require("./defiLamaAPY"), exports);

package/lib/core/creditAccount.d.ts

@@ -1,4 +1,4 @@
-import { LpTokensAPY } from "../apy";
+import { TokensWithApyRecord } from "../apy";
 import { CaTokenBalance, CreditAccountDataPayload } from "../payload/creditAccount";
 import { QuotaInfo } from "../payload/creditManager";
 import { TokenData } from "../tokens/tokenData";
@@ -7,7 +7,7 @@ export declare const MIN_INT96 = -39614081257132168796771975168n;
 export declare const MAX_UINT256 = 115792089237316195423570985008687907853269984665640564039457584007913129639935n;
 export interface CalcOverallAPYProps {
     caAssets: Array<Asset>;
-    lpAPY: LpTokensAPY | undefined;
+    lpAPY: TokensWithApyRecord | undefined;
     quotas: Record<string, Asset>;
     quotaRates: Record<string, Pick<QuotaInfo, "isActive" | "rate">>;
     feeInterest: number;

package/lib/core/strategy.d.ts

@@ -1,9 +1,9 @@
 import { SupportedToken } from "@gearbox-protocol/sdk-gov";
-import { TokensWithAPY } from "../apy";
+import { AllLPTokens } from "../apy";
 import { CreditManagerData } from "./creditManager";
 export interface StrategyPayload {
     name: string;
-    lpTokenSymbol: TokensWithAPY;
+    lpTokenSymbol: AllLPTokens;
     protocolSymbol: string;
     creditManagers: Array<string>;
     collateralTokens: Array<SupportedToken>;
@@ -17,7 +17,7 @@ interface CalculateMaxAPYProps {
 }
 export declare class Strategy {
     readonly name: string;
-    readonly lpTokenSymbol: TokensWithAPY;
+    readonly lpTokenSymbol: AllLPTokens;
     readonly protocolSymbol: string;
     readonly collateralTokens: Array<SupportedToken>;
     readonly liquidationTokens: Array<SupportedToken>;

package/lib/core/transactions.d.ts

@@ -10,7 +10,7 @@ interface PoolEvent {
     readonly poolName?: string;
 }
 export interface TxSerialized {
-    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxDecreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimRewards" | "TxEnableTokens" | "TxUpdateQuota" | "TxGaugeStake" | "TxGaugeUnstake" | "TxGaugeClaim" | "TxGaugeVote" | "TxWithdrawCollateral" | "TxAddBot" | "TxRemoveBot";
+    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxDecreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimRewards" | "TxEnableTokens" | "TxUpdateQuota" | "TxGaugeStake" | "TxGaugeUnstake" | "TxGaugeClaim" | "TxGaugeVote" | "TxWithdrawCollateral" | "TxAddBot" | "TxRemoveBot" | "TxLiquidateAccount";
     content: string;
 }
 export declare class TxSerializer {
@@ -184,6 +184,17 @@ export declare class TxRepayAccount extends EVMTx implements CMEvent {
     toString(): string;
     serialize(): TxSerialized;
 }
+interface LiquidateAccountProps extends EVMTxProps {
+    creditManager: string;
+    creditManagerName?: string;
+}
+export declare class TxLiquidateAccount extends EVMTx implements CMEvent {
+    readonly creditManager: string;
+    readonly creditManagerName?: string;
+    constructor(opts: LiquidateAccountProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 interface CloseAccountProps extends EVMTxProps {
     creditManager: string;
     creditManagerName?: string;

package/lib/core/transactions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxRemoveBot = exports.TxAddBot = exports.TxWithdrawCollateral = exports.TxGaugeVote = exports.TxGaugeClaim = exports.TxGaugeUnstake = exports.TxGaugeStake = exports.TxUpdateQuota = exports.TxEnableTokens = exports.TxApprove = exports.TxCloseAccount = exports.TxRepayAccount = exports.TxClaimRewards = exports.TxClaimNFT = exports.TxClaimReward = exports.TxOpenMultitokenAccount = exports.TxOpenAccount = exports.TxDecreaseBorrowAmount = exports.TxIncreaseBorrowAmount = exports.TxAddCollateral = exports.TXSwap = exports.TxRemoveLiquidity = exports.TxAddLiquidity = exports.TxSerializer = void 0;
+exports.TxRemoveBot = exports.TxAddBot = exports.TxWithdrawCollateral = exports.TxGaugeVote = exports.TxGaugeClaim = exports.TxGaugeUnstake = exports.TxGaugeStake = exports.TxUpdateQuota = exports.TxEnableTokens = exports.TxApprove = exports.TxCloseAccount = exports.TxLiquidateAccount = exports.TxRepayAccount = exports.TxClaimRewards = exports.TxClaimNFT = exports.TxClaimReward = exports.TxOpenMultitokenAccount = exports.TxOpenAccount = exports.TxDecreaseBorrowAmount = exports.TxIncreaseBorrowAmount = exports.TxAddCollateral = exports.TXSwap = exports.TxRemoveLiquidity = exports.TxAddLiquidity = exports.TxSerializer = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
 const contractsRegister_1 = require("../contracts/contractsRegister");
 const math_1 = require("../utils/math");
@@ -59,6 +59,8 @@ class TxSerializer {
                     return new TxAddBot(params);
                 case "TxRemoveBot":
                     return new TxRemoveBot(params);
+                case "TxLiquidateAccount":
+                    return new TxLiquidateAccount(params);
                 default:
                     throw new Error(`Unknown transaction for parsing: ${e.type}`);
             }
@@ -356,6 +358,25 @@ class TxRepayAccount extends eventOrTx_1.EVMTx {
     }
 }
 exports.TxRepayAccount = TxRepayAccount;
+class TxLiquidateAccount extends eventOrTx_1.EVMTx {
+    creditManager;
+    creditManagerName;
+    constructor(opts) {
+        super(opts);
+        this.creditManager = opts.creditManager;
+        this.creditManagerName = opts.creditManagerName;
+    }
+    toString() {
+        return `Credit Account ${this.creditManagerName || (0, contractsRegister_1.getContractName)(this.creditManager)}: Liquidated`;
+    }
+    serialize() {
+        return {
+            type: "TxLiquidateAccount",
+            content: JSON.stringify(this),
+        };
+    }
+}
+exports.TxLiquidateAccount = TxLiquidateAccount;
 class TxCloseAccount extends eventOrTx_1.EVMTx {
     creditManager;
     creditManagerName;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "3.0.0-next.184",
+  "version": "3.0.0-next.185",
   "description": "Gearbox SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",