@gearbox-protocol/sdk 3.0.0-next.37 → 3.0.0-next.39

package/contracts/index.sol

@@ -15,6 +15,8 @@ import {ICreditConfiguratorV2} from "@gearbox-protocol/core-v2/contracts/interfa
 import {IWERC20Zapper} from "@gearbox-protocol/integrations-v3/contracts/interfaces/zappers/IWERC20Zapper.sol";
 import {IWETHZapper} from "@gearbox-protocol/integrations-v3/contracts/interfaces/zappers/IWETHZapper.sol";
 
+import {IGearStakingV3} from "@gearbox-protocol/core-v3/contracts/interfaces/IGearStakingV3.sol";
+
 // Adapters
 import {ILidoV1Adapter} from "@gearbox-protocol/integrations-v3/contracts/interfaces/lido/ILidoV1Adapter.sol";
 import {IBaseRewardPool} from "@gearbox-protocol/integrations-v3/contracts/integrations/convex/IBaseRewardPool.sol";
@@ -48,4 +50,4 @@ import {ICurveV1_4AssetsAdapter} from
 import {IRouter} from
     "@gearbox-protocol/router-v3/contracts/interfaces/IRouter.sol";
 
-import {IOffchainOracle} from "./IOffchainOracle.sol";
+ 

package/lib/core/creditManager.d.ts

@@ -1,7 +1,7 @@
 import { MultiCall } from "../pathfinder/core";
 import { ChartsCreditManagerPayload, CreditManagerDataPayload, QuotaInfo } from "../payload/creditManager";
 import { LinearModel } from "../payload/pool";
-type PoolType = "universal" | "trade" | "farm";
+import { PoolType } from "./pool";
 export declare class CreditManagerData {
     readonly address: string;
     readonly type: PoolType;
@@ -35,7 +35,6 @@ export declare class CreditManagerData {
     readonly interestModel: LinearModel;
     constructor(payload: CreditManagerDataPayload);
     get id(): string;
-    static getCMType(name: string): PoolType;
     isQuoted(token: string): boolean;
     encodeAddCollateralV2(tokenAddress: string, amount: bigint): MultiCall;
     encodeAddCollateralV3(tokenAddress: string, amount: bigint): MultiCall;
@@ -93,4 +92,3 @@ export declare class ChartsCreditManagerData {
     readonly liquidationThresholds: Record<string, bigint>;
     constructor(payload: ChartsCreditManagerPayload);
 }
-export {};

package/lib/core/creditManager.js

@@ -4,6 +4,7 @@ exports.ChartsCreditManagerData = exports.CreditManagerData = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
 const txParser_1 = require("../parsers/txParser");
 const types_1 = require("../types");
+const pool_1 = require("./pool");
 class CreditManagerData {
     address;
     type;
@@ -38,7 +39,7 @@ class CreditManagerData {
     constructor(payload) {
         this.address = payload.addr.toLowerCase();
         this.underlyingToken = payload.underlying.toLowerCase();
-        this.type = CreditManagerData.getCMType(payload.name || "");
+        this.type = pool_1.PoolData.getPoolType(payload.name || "");
         this.name = payload.name;
         this.pool = payload.pool.toLowerCase();
         this.creditFacade = payload.creditFacade.toLowerCase();
@@ -112,15 +113,6 @@ class CreditManagerData {
     get id() {
         return this.address;
     }
-    static getCMType(name) {
-        const [identity = ""] = name.split(" ") || [];
-        const lc = identity.toLowerCase();
-        if (lc === "farm")
-            return "farm";
-        if (lc === "trade")
-            return "trade";
-        return "universal";
-    }
     isQuoted(token) {
         return !!this.quotas[token];
     }

package/lib/core/gauge.d.ts

@@ -1,4 +1,5 @@
-import { GaugeDataPayload, GaugeQuotaParams } from "../payload/gauge";
+import { GaugeDataPayload, GaugeQuotaParams, GaugeStakingDataPayload } from "../payload/gauge";
+import { BigintifyProps } from "../utils/types";
 export declare class GaugeData {
     readonly address: string;
     readonly pool: string;
@@ -9,3 +10,12 @@ export declare class GaugeData {
     readonly quotaParams: Record<string, GaugeQuotaParams>;
     constructor(payload: GaugeDataPayload);
 }
+export declare class GaugeStakingData {
+    readonly availableBalance: bigint;
+    readonly totalBalance: bigint;
+    readonly epoch: number;
+    readonly withdrawableNow: bigint;
+    readonly withdrawableInEpochsTotal: bigint;
+    readonly withdrawableInEpochs: BigintifyProps<GaugeStakingDataPayload["withdrawableAmounts"]["withdrawableInEpochs"]>;
+    constructor(payload: GaugeStakingDataPayload);
+}

package/lib/core/gauge.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GaugeData = void 0;
+exports.GaugeStakingData = exports.GaugeData = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
 class GaugeData {
     address;
@@ -37,3 +37,26 @@ class GaugeData {
     }
 }
 exports.GaugeData = GaugeData;
+class GaugeStakingData {
+    availableBalance;
+    totalBalance;
+    epoch;
+    withdrawableNow;
+    withdrawableInEpochsTotal;
+    withdrawableInEpochs;
+    constructor(payload) {
+        this.availableBalance = (0, sdk_gov_1.toBigInt)(payload.availableBalance);
+        this.totalBalance = (0, sdk_gov_1.toBigInt)(payload.totalBalance);
+        this.epoch = payload.epoch;
+        this.withdrawableNow = (0, sdk_gov_1.toBigInt)(payload.withdrawableAmounts.withdrawableNow);
+        const { total, list } = payload.withdrawableAmounts.withdrawableInEpochs.reduce(({ total, list }, a) => {
+            const bn = (0, sdk_gov_1.toBigInt)(a);
+            list.push(bn);
+            return { total: total + bn, list };
+        }, { total: 0n, list: [] });
+        this.withdrawableInEpochsTotal = total;
+        this.withdrawableInEpochs =
+            list;
+    }
+}
+exports.GaugeStakingData = GaugeStakingData;

package/lib/core/pool.d.ts

@@ -2,8 +2,10 @@ import { providers, Signer } from "ethers";
 import { CreditManagerDebtParams, QuotaInfo } from "../payload/creditManager";
 import { ChartsPoolDataPayload, LinearModel, PoolDataPayload, PoolZapper, UserPoolPayload } from "../payload/pool";
 import { IPoolService, IPoolV3 } from "../types";
+export type PoolType = "universal" | "trade" | "farm";
 export declare class PoolData {
     readonly address: string;
+    readonly type: PoolType;
     readonly underlyingToken: string;
     readonly dieselToken: string;
     readonly isPaused: boolean;
@@ -35,6 +37,7 @@ export declare class PoolData {
     getPoolContractV1(signer: Signer): IPoolService;
     getPoolContractV3(signer: Signer): IPoolV3;
     calculateBorrowRate({ provider, expectedLiquidity, availableLiquidity, }: CalculateBorrowRateProps): Promise<import("ethers").BigNumber>;
+    static getPoolType(name: string): PoolType;
 }
 interface CalculateBorrowRateProps {
     provider: providers.Provider;

package/lib/core/pool.js

@@ -6,6 +6,7 @@ const types_1 = require("../types");
 const formatter_1 = require("../utils/formatter");
 class PoolData {
     address;
+    type;
     underlyingToken;
     dieselToken;
     isPaused;
@@ -36,6 +37,7 @@ class PoolData {
     lastBaseInterestUpdate;
     constructor(payload) {
         this.address = payload.addr.toLowerCase();
+        this.type = PoolData.getPoolType(payload.name || "");
         this.underlyingToken = payload.underlying.toLowerCase();
         this.dieselToken = payload.dieselToken.toLowerCase();
         this.isPaused = payload.isPaused;
@@ -120,6 +122,15 @@ class PoolData {
         const model = types_1.IInterestRateModel__factory.connect(this.interestModel.interestModel, provider);
         return model.calcBorrowRate(expectedLiquidity, availableLiquidity);
     }
+    static getPoolType(name) {
+        const [identity = ""] = name.split(" ") || [];
+        const lc = identity.toLowerCase();
+        if (lc === "farm")
+            return "farm";
+        if (lc === "trade")
+            return "trade";
+        return "universal";
+    }
 }
 exports.PoolData = PoolData;
 class ChartsPoolData {

package/lib/core/transactions.d.ts

@@ -2,7 +2,7 @@ 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" | "TxUpdateQuota";
+    type: "TxAddLiquidity" | "TxRemoveLiquidity" | "TxSwap" | "TxAddCollateral" | "TxIncreaseBorrowAmount" | "TxDecreaseBorrowAmount" | "TxOpenAccount" | "TxRepayAccount" | "TxCloseAccount" | "TxApprove" | "TxOpenMultitokenAccount" | "TxClaimReward" | "TxClaimNFT" | "TxClaimGearRewards" | "TxEnableTokens" | "TxUpdateQuota" | "TxGaugeStake" | "TxGaugeUnstake" | "TxGaugeClaim";
     content: string;
 }
 export declare class TxSerializer {
@@ -134,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;
 }
@@ -204,4 +202,26 @@ export declare class TxUpdateQuota extends EVMTx {
     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;
+}
 export {};

package/lib/core/transactions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TxUpdateQuota = exports.TxEnableTokens = exports.TxApprove = exports.TxCloseAccount = exports.TxRepayAccount = exports.TxClaimGearRewards = 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.TxGaugeClaim = exports.TxGaugeUnstake = exports.TxGaugeStake = exports.TxUpdateQuota = exports.TxEnableTokens = exports.TxApprove = exports.TxCloseAccount = exports.TxRepayAccount = exports.TxClaimGearRewards = 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");
@@ -45,6 +45,12 @@ class TxSerializer {
                     return new TxEnableTokens(params);
                 case "TxUpdateQuota":
                     return new TxUpdateQuota(params);
+                case "TxGaugeStake":
+                    return new TxGaugeStake(params);
+                case "TxGaugeUnstake":
+                    return new TxGaugeUnstake(params);
+                case "TxGaugeClaim":
+                    return new TxGaugeClaim(params);
                 default:
                     throw new Error(`Unknown transaction for parsing: ${e.type}`);
             }
@@ -57,12 +63,7 @@ class TxAddLiquidity extends eventOrTx_1.EVMTx {
     underlyingToken;
     pool;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.underlyingToken = opts.underlyingToken;
         this.pool = opts.pool;
@@ -84,12 +85,7 @@ class TxRemoveLiquidity extends eventOrTx_1.EVMTx {
     dieselToken;
     pool;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.dieselToken = opts.dieselToken;
         this.pool = opts.pool;
@@ -115,12 +111,7 @@ class TXSwap extends eventOrTx_1.EVMTx {
     tokenTo;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.protocol = opts.protocol;
         this.operation = opts.operation;
         this.amountFrom = opts.amountFrom;
@@ -151,12 +142,7 @@ class TxAddCollateral extends eventOrTx_1.EVMTx {
     addedToken;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.addedToken = opts.addedToken;
         this.creditManager = opts.creditManager;
@@ -178,12 +164,7 @@ class TxIncreaseBorrowAmount extends eventOrTx_1.EVMTx {
     underlyingToken;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.underlyingToken = opts.underlyingToken;
         this.creditManager = opts.creditManager;
@@ -205,12 +186,7 @@ class TxDecreaseBorrowAmount extends eventOrTx_1.EVMTx {
     underlyingToken;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.underlyingToken = opts.underlyingToken;
         this.creditManager = opts.creditManager;
@@ -233,12 +209,7 @@ class TxOpenAccount extends eventOrTx_1.EVMTx {
     leverage;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.underlyingToken = opts.underlyingToken;
         this.leverage = opts.leverage;
@@ -265,12 +236,7 @@ class TxOpenMultitokenAccount extends eventOrTx_1.EVMTx {
     underlyingToken;
     assets;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.borrowedAmount = opts.borrowedAmount;
         this.underlyingToken = opts.underlyingToken;
         this.creditManager = opts.creditManager;
@@ -297,12 +263,7 @@ exports.TxOpenMultitokenAccount = TxOpenMultitokenAccount;
 class TxClaimReward extends eventOrTx_1.EVMTx {
     contracts;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.contracts = opts.contracts;
     }
     toString() {
@@ -321,14 +282,6 @@ class TxClaimReward extends eventOrTx_1.EVMTx {
 }
 exports.TxClaimReward = TxClaimReward;
 class TxClaimNFT extends eventOrTx_1.EVMTx {
-    constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
-    }
     toString() {
         return `NFT claimed`;
     }
@@ -344,12 +297,7 @@ class TxClaimGearRewards extends eventOrTx_1.EVMTx {
     token;
     amount;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.amount = opts.amount;
         this.token = opts.token;
     }
@@ -368,12 +316,7 @@ exports.TxClaimGearRewards = TxClaimGearRewards;
 class TxRepayAccount extends eventOrTx_1.EVMTx {
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.creditManager = opts.creditManager;
     }
     toString() {
@@ -390,12 +333,7 @@ exports.TxRepayAccount = TxRepayAccount;
 class TxCloseAccount extends eventOrTx_1.EVMTx {
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.creditManager = opts.creditManager;
     }
     toString() {
@@ -412,12 +350,7 @@ exports.TxCloseAccount = TxCloseAccount;
 class TxApprove extends eventOrTx_1.EVMTx {
     token;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.token = opts.token;
     }
     toString() {
@@ -437,12 +370,7 @@ class TxEnableTokens extends eventOrTx_1.EVMTx {
     disabledTokens;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.enabledTokens = opts.enabledTokens;
         this.disabledTokens = opts.disabledTokens;
         this.creditManager = opts.creditManager;
@@ -477,12 +405,7 @@ class TxUpdateQuota extends eventOrTx_1.EVMTx {
     underlyingToken;
     creditManager;
     constructor(opts) {
-        super({
-            block: opts.block,
-            txHash: opts.txHash,
-            txStatus: opts.txStatus,
-            timestamp: opts.timestamp,
-        });
+        super(opts);
         this.updatedQuotas = opts.updatedQuotas;
         this.creditManager = opts.creditManager;
         this.underlyingToken = opts.underlyingToken;
@@ -499,9 +422,59 @@ class TxUpdateQuota extends eventOrTx_1.EVMTx {
     }
     serialize() {
         return {
-            type: "TxEnableTokens",
+            type: "TxUpdateQuota",
             content: JSON.stringify(this),
         };
     }
 }
 exports.TxUpdateQuota = TxUpdateQuota;
+class TxGaugeStake extends eventOrTx_1.EVMTx {
+    amount;
+    constructor(opts) {
+        super(opts);
+        this.amount = opts.amount;
+    }
+    toString() {
+        const tokenDecimals = sdk_gov_1.decimals.GEAR;
+        const amountString = (0, sdk_gov_1.formatBN)(math_1.BigIntMath.abs(this.amount), tokenDecimals);
+        return `Gauge: staked ${amountString} GEAR`;
+    }
+    serialize() {
+        return {
+            type: "TxGaugeStake",
+            content: JSON.stringify(this),
+        };
+    }
+}
+exports.TxGaugeStake = TxGaugeStake;
+class TxGaugeUnstake extends eventOrTx_1.EVMTx {
+    amount;
+    constructor(opts) {
+        super(opts);
+        this.amount = opts.amount;
+    }
+    toString() {
+        const tokenDecimals = sdk_gov_1.decimals.GEAR;
+        const amountString = (0, sdk_gov_1.formatBN)(math_1.BigIntMath.abs(this.amount), tokenDecimals);
+        return `Gauge: unstaked ${amountString} GEAR`;
+    }
+    serialize() {
+        return {
+            type: "TxGaugeUnstake",
+            content: JSON.stringify(this),
+        };
+    }
+}
+exports.TxGaugeUnstake = TxGaugeUnstake;
+class TxGaugeClaim extends eventOrTx_1.EVMTx {
+    toString() {
+        return `Gauge: withdrawals claimed`;
+    }
+    serialize() {
+        return {
+            type: "TxGaugeClaim",
+            content: JSON.stringify(this),
+        };
+    }
+}
+exports.TxGaugeClaim = TxGaugeClaim;

package/lib/payload/gauge.d.ts

@@ -1,5 +1,12 @@
-import { ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
+import { AwaitedRes, ExcludeArrayProps } from "@gearbox-protocol/sdk-gov";
+import { IGearStakingV3 } from "../types";
 import { GaugeInfoStructOutput, GaugeQuotaParamsStructOutput } from "../types/IDataCompressorV3_00";
 import { BigintifyProps } from "../utils/types";
 export type GaugeQuotaParams = BigintifyProps<ExcludeArrayProps<GaugeQuotaParamsStructOutput>>;
 export type GaugeDataPayload = ExcludeArrayProps<GaugeInfoStructOutput>;
+export interface GaugeStakingDataPayload {
+    availableBalance: AwaitedRes<IGearStakingV3["availableBalance"]>;
+    totalBalance: AwaitedRes<IGearStakingV3["balanceOf"]>;
+    epoch: AwaitedRes<IGearStakingV3["getCurrentEpoch"]>;
+    withdrawableAmounts: AwaitedRes<IGearStakingV3["getWithdrawableAmounts"]>;
+}