npm - @gearbox-protocol/sdk - Versions diffs - 1.17.1 → 1.17.3 - Mend

@gearbox-protocol/sdk 1.17.1 → 1.17.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/lib/apy/convexAPY.js +9 -15
package/lib/core/transactions.d.ts +12 -1
package/lib/core/transactions.js +29 -1
package/lib/tokens/curveLP.d.ts +4 -1
package/lib/tokens/curveLP.js +83 -70
package/lib/utils/formatter.js +1 -1
package/package.json +1 -1

package/lib/apy/convexAPY.js CHANGED Viewed

@@ -56,7 +56,6 @@ function getConvexAPY(_a) {
     var pool = _a.pool, provider = _a.provider, networkType = _a.networkType, getTokenPrice = _a.getTokenPrice, curveAPY = _a.curveAPY;
     return __awaiter(this, void 0, void 0, function () {
         var tokenList, contractsList, poolParams, stakedTokenParams, underlying, basePoolAddress, crvParams, swapPoolAddress, cvxAddress, extraPoolAddresses, _b, basePoolRate, basePoolSupply, vPrice, cvxSupply, extra, cvxPrice, crvPrice, crvPerSecond, virtualSupply, crvPerUnderlying, crvPerYear, cvxPerYear, crvAPY, cvxAPY, extraAPRs, extraAPYTotal, baseApyWAD;
-        var _this = this;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
@@ -88,20 +87,15 @@ function getConvexAPY(_a) {
                     cvxPerYear = getCVXMintAmount(crvPerYear, cvxSupply);
                     crvAPY = crvPerYear.mul(crvPrice).div(constants_1.PRICE_DECIMALS);
                     cvxAPY = cvxPerYear.mul(cvxPrice).div(constants_1.PRICE_DECIMALS);
-                    return [4 /*yield*/, Promise.all(extraPoolAddresses.map(function (_, index) { return __awaiter(_this, void 0, void 0, function () {
-                            var extraRewardSymbol, extraPoolRate, perUnderlying, perYear, extraPrice, extraAPY;
-                            return __generator(this, function (_a) {
-                                extraRewardSymbol = poolParams.extraRewards[index].rewardToken;
-                                extraPoolRate = extra[index];
-                                perUnderlying = extraPoolRate.mul(constants_1.WAD).div(virtualSupply);
-                                perYear = perUnderlying.mul(constants_1.SECONDS_PER_YEAR);
-                                extraPrice = getTokenPrice(tokenList[extraRewardSymbol]);
-                                extraAPY = perYear.mul(extraPrice).div(constants_1.PRICE_DECIMALS);
-                                return [2 /*return*/, extraAPY];
-                            });
-                        }); }))];
-                case 2:
-                    extraAPRs = _c.sent();
+                    extraAPRs = extraPoolAddresses.map(function (_, index) {
+                        var extraRewardSymbol = poolParams.extraRewards[index].rewardToken;
+                        var extraPoolRate = extra[index];
+                        var perUnderlying = extraPoolRate.mul(constants_1.WAD).div(virtualSupply);
+                        var perYear = perUnderlying.mul(constants_1.SECONDS_PER_YEAR);
+                        var extraPrice = getTokenPrice(tokenList[extraRewardSymbol]);
+                        var extraAPY = perYear.mul(extraPrice).div(constants_1.PRICE_DECIMALS);
+                        return extraAPY;
+                    });
                     extraAPYTotal = extraAPRs.reduce(function (acc, apy) { return acc.add(apy); }, ethers_1.BigNumber.from(0));
                     baseApyWAD = curveAPY[underlying];
                     return [2 /*return*/, baseApyWAD.add(crvAPY).add(cvxAPY).add(extraAPYTotal)];

package/lib/core/transactions.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@ import { BigNumber } from "ethers";
 import { SupportedContract } from "../contracts/contracts";
 import { EVMTx, EVMTxProps } from "./eventOrTx";
 export interface TxSerialized {
-    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT";
+    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimGearRewards";
     content: string;
 }
 export declare class TxSerializer {
@@ -127,6 +127,17 @@ export declare class TxClaimNFT extends EVMTx {
     toString(): string;
     serialize(): TxSerialized;
 }
+declare type TxClaimGearRewardsProps = EVMTxProps & {
+    token: string;
+    amount: BigNumber;
+};
+export declare class TxClaimGearRewards extends EVMTx {
+    token: string;
+    amount: BigNumber;
+    constructor(opts: TxClaimGearRewardsProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 interface RepayAccountProps extends EVMTxProps {
     creditManager: string;
 }

package/lib/core/transactions.js CHANGED Viewed

@@ -15,7 +15,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxApprove = exports.TxCloseAccount = exports.TxRepayAccount = exports.TxClaimNFT = exports.TxClaimReward = exports.TxOpenMultitokenAccount = exports.TxOpenAccount = exports.TxIncreaseBorrowAmount = exports.TxAddCollateral = exports.TXSwap = exports.TxRemoveLiquidity = exports.TxAddLiquidity = exports.TxSerializer = void 0;
+exports.TxApprove = exports.TxCloseAccount = exports.TxRepayAccount = exports.TxClaimGearRewards = exports.TxClaimNFT = exports.TxClaimReward = exports.TxOpenMultitokenAccount = exports.TxOpenAccount = exports.TxIncreaseBorrowAmount = exports.TxAddCollateral = exports.TXSwap = exports.TxRemoveLiquidity = exports.TxAddLiquidity = exports.TxSerializer = void 0;
 var ethers_1 = require("ethers");
 var contracts_1 = require("../contracts/contracts");
 var contractsRegister_1 = require("../contracts/contractsRegister");
@@ -57,6 +57,8 @@ var TxSerializer = /** @class */ (function () {
                     return new TxClaimReward(params);
                 case "TxClaimNFT":
                     return new TxClaimNFT(params);
+                case "TxClaimGearRewards":
+                    return new TxClaimGearRewards(params);
                 default:
                     throw new Error("Unknown transaction for parsing: ".concat(e.type));
             }
@@ -323,6 +325,32 @@ var TxClaimNFT = /** @class */ (function (_super) {
     return TxClaimNFT;
 }(eventOrTx_1.EVMTx));
 exports.TxClaimNFT = TxClaimNFT;
+var TxClaimGearRewards = /** @class */ (function (_super) {
+    __extends(TxClaimGearRewards, _super);
+    function TxClaimGearRewards(opts) {
+        var _this = _super.call(this, {
+            block: opts.block,
+            txHash: opts.txHash,
+            txStatus: opts.txStatus,
+            timestamp: opts.timestamp,
+        }) || this;
+        _this.amount = opts.amount;
+        _this.token = opts.token;
+        return _this;
+    }
+    TxClaimGearRewards.prototype.toString = function () {
+        var _a = (0, token_1.extractTokenData)(this.token), symbol = _a[0], decimals = _a[1];
+        return "GEAR Rewards claimed: ".concat((0, formatter_1.formatBN)(this.amount, decimals || 18), " ").concat(symbol, " ");
+    };
+    TxClaimGearRewards.prototype.serialize = function () {
+        return {
+            type: "TxClaimGearRewards",
+            content: JSON.stringify(this),
+        };
+    };
+    return TxClaimGearRewards;
+}(eventOrTx_1.EVMTx));
+exports.TxClaimGearRewards = TxClaimGearRewards;
 var TxRepayAccount = /** @class */ (function (_super) {
     __extends(TxRepayAccount, _super);
     function TxRepayAccount(opts) {

package/lib/tokens/curveLP.d.ts CHANGED Viewed

@@ -4,7 +4,8 @@ import { TradeAction } from "../pathfinder/tradeTypes";
 import { PartialRecord } from "../utils/types";
 import type { SupportedToken, TokenBase } from "./token";
 import { TokenType } from "./tokenType";
-export declare type CurveLPToken = "3Crv" | "steCRV" | "FRAX3CRV" | "LUSD3CRV" | "crvPlain3andSUSD" | "gusd3CRV" | "crvFRAX";
+export declare type CurveMetaTokens = "FRAX3CRV" | "LUSD3CRV" | "gusd3CRV";
+export declare type CurveLPToken = "3Crv" | "steCRV" | "crvPlain3andSUSD" | "crvFRAX" | CurveMetaTokens;
 export declare type CurveLPTokenData = {
     symbol: CurveLPToken;
     type: TokenType.CURVE_LP_TOKEN;
@@ -21,5 +22,7 @@ export declare type MetaCurveLPTokenData = {
     wrapper?: CurvePoolContract;
 } & TokenBase;
 export declare const Curve3CrvUnderlyingTokenIndex: PartialRecord<SupportedToken, BigNumber>;
+export declare const curveMetaTokens: Record<CurveMetaTokens, MetaCurveLPTokenData>;
 export declare const curveTokens: Record<CurveLPToken, CurveLPTokenData | MetaCurveLPTokenData>;
 export declare const isCurveLPToken: (t: unknown) => t is CurveLPToken;
+export declare const isCurveMetaToken: (t: unknown) => t is CurveMetaTokens;

package/lib/tokens/curveLP.js CHANGED Viewed

@@ -1,6 +1,17 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCurveLPToken = exports.curveTokens = exports.Curve3CrvUnderlyingTokenIndex = void 0;
+exports.isCurveMetaToken = exports.isCurveLPToken = exports.curveTokens = exports.curveMetaTokens = exports.Curve3CrvUnderlyingTokenIndex = void 0;
 var ethers_1 = require("ethers");
 var tradeTypes_1 = require("../pathfinder/tradeTypes");
 var tokenType_1 = require("./tokenType");
@@ -9,7 +20,69 @@ exports.Curve3CrvUnderlyingTokenIndex = {
     USDC: ethers_1.BigNumber.from(1),
     USDT: ethers_1.BigNumber.from(2),
 };
-exports.curveTokens = {
+exports.curveMetaTokens = {
+    //  META CURVE LP TOKENS
+    FRAX3CRV: {
+        name: "Curve FRAX3CRV-f",
+        symbol: "FRAX3CRV",
+        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
+        pool: "CURVE_FRAX_POOL",
+        lpActions: [
+            {
+                type: tradeTypes_1.TradeType.CurveWithdrawLP,
+                contract: "CURVE_FRAX_POOL",
+                tokenOut: ["FRAX", "3Crv"],
+            },
+            {
+                type: tradeTypes_1.TradeType.ConvexDepositLP,
+                contract: "CONVEX_BOOSTER",
+                tokenOut: "cvxFRAX3CRV",
+            },
+            {
+                type: tradeTypes_1.TradeType.ConvexDepositLPAndStake,
+                contract: "CONVEX_BOOSTER",
+                tokenOut: "stkcvxFRAX3CRV",
+            },
+        ],
+    },
+    LUSD3CRV: {
+        name: "Curve LUSD3CRV-f",
+        symbol: "LUSD3CRV",
+        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
+        pool: "CURVE_LUSD_POOL",
+        lpActions: [
+            {
+                type: tradeTypes_1.TradeType.CurveWithdrawLP,
+                contract: "CURVE_LUSD_POOL",
+                tokenOut: ["LUSD", "3Crv"],
+            },
+        ],
+    },
+    gusd3CRV: {
+        name: "Curve gusd3CRV",
+        symbol: "gusd3CRV",
+        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
+        pool: "CURVE_GUSD_POOL",
+        lpActions: [
+            {
+                type: tradeTypes_1.TradeType.CurveWithdrawLP,
+                contract: "CURVE_GUSD_POOL",
+                tokenOut: ["GUSD", "3Crv"],
+            },
+            {
+                type: tradeTypes_1.TradeType.ConvexDepositLP,
+                contract: "CONVEX_BOOSTER",
+                tokenOut: "cvxgusd3CRV",
+            },
+            {
+                type: tradeTypes_1.TradeType.ConvexDepositLPAndStake,
+                contract: "CONVEX_BOOSTER",
+                tokenOut: "stkcvxgusd3CRV",
+            },
+        ],
+    },
+};
+exports.curveTokens = __assign({
     // CURVE LP TOKENS
     "3Crv": {
         name: "Curve 3Crv",
@@ -33,8 +106,7 @@ exports.curveTokens = {
                 tokenOut: "stkcvx3Crv",
             },
         ],
-    },
-    crvFRAX: {
+    }, crvFRAX: {
         name: "Curve.fi FRAX/USDC",
         symbol: "crvFRAX",
         type: tokenType_1.TokenType.CURVE_LP_TOKEN,
@@ -56,8 +128,7 @@ exports.curveTokens = {
                 tokenOut: "stkcvxcrvFRAX",
             },
         ],
-    },
-    steCRV: {
+    }, steCRV: {
         name: "Curve steCRV",
         symbol: "steCRV",
         type: tokenType_1.TokenType.CURVE_LP_TOKEN,
@@ -79,8 +150,7 @@ exports.curveTokens = {
                 tokenOut: "stkcvxsteCRV",
             },
         ],
-    },
-    crvPlain3andSUSD: {
+    }, crvPlain3andSUSD: {
         name: "Curve crvPlain3andSUSD",
         symbol: "crvPlain3andSUSD",
         type: tokenType_1.TokenType.CURVE_LP_TOKEN,
@@ -103,69 +173,12 @@ exports.curveTokens = {
                 tokenOut: "stkcvxcrvPlain3andSUSD",
             },
         ],
-    },
-    //  META CURVE LP TOKENS
-    FRAX3CRV: {
-        name: "Curve FRAX3CRV-f",
-        symbol: "FRAX3CRV",
-        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
-        pool: "CURVE_FRAX_POOL",
-        lpActions: [
-            {
-                type: tradeTypes_1.TradeType.CurveWithdrawLP,
-                contract: "CURVE_FRAX_POOL",
-                tokenOut: ["FRAX", "3Crv"],
-            },
-            {
-                type: tradeTypes_1.TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxFRAX3CRV",
-            },
-            {
-                type: tradeTypes_1.TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxFRAX3CRV",
-            },
-        ],
-    },
-    LUSD3CRV: {
-        name: "Curve LUSD3CRV-f",
-        symbol: "LUSD3CRV",
-        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
-        pool: "CURVE_LUSD_POOL",
-        lpActions: [
-            {
-                type: tradeTypes_1.TradeType.CurveWithdrawLP,
-                contract: "CURVE_LUSD_POOL",
-                tokenOut: ["LUSD", "3Crv"],
-            },
-        ],
-    },
-    gusd3CRV: {
-        name: "Curve gusd3CRV",
-        symbol: "gusd3CRV",
-        type: tokenType_1.TokenType.CURVE_LP_TOKEN,
-        pool: "CURVE_GUSD_POOL",
-        lpActions: [
-            {
-                type: tradeTypes_1.TradeType.CurveWithdrawLP,
-                contract: "CURVE_GUSD_POOL",
-                tokenOut: ["GUSD", "3Crv"],
-            },
-            {
-                type: tradeTypes_1.TradeType.ConvexDepositLP,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "cvxgusd3CRV",
-            },
-            {
-                type: tradeTypes_1.TradeType.ConvexDepositLPAndStake,
-                contract: "CONVEX_BOOSTER",
-                tokenOut: "stkcvxgusd3CRV",
-            },
-        ],
-    },
-};
+    } }, exports.curveMetaTokens);
 var isCurveLPToken = function (t) {
     return typeof t === "string" && !!exports.curveTokens[t];
 };
 exports.isCurveLPToken = isCurveLPToken;
+var isCurveMetaToken = function (t) {
+    return typeof t === "string" && !!exports.curveMetaTokens[t];
+};
+exports.isCurveMetaToken = isCurveMetaToken;

package/lib/utils/formatter.js CHANGED Viewed

@@ -57,7 +57,7 @@ exports.formatBN = formatBN;
 function formatBn4dig(num, precision) {
     if (precision === void 0) { precision = 2; }
     if (precision > 6) {
-        throw new Error("Incorrect precision");
+        throw new Error("Precision is too high, try <= 6");
     }
     var numStr = num.toString();
     if (numStr.length < 6) {

package/package.json CHANGED Viewed

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