@gearbox-protocol/sdk 3.0.0-next.25 → 3.0.0-next.251

package/lib/core/events.js

@@ -158,7 +158,7 @@ class EventOpenCreditAccount extends eventOrTx_1.EVMEvent {
     }
     toString() {
         const [symbol, decimals = 18] = (0, sdk_gov_1.extractTokenData)(this.underlyingToken);
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: opened with debt ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: opened with debt ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
     }
 }
 exports.EventOpenCreditAccount = EventOpenCreditAccount;
@@ -171,7 +171,7 @@ class EventCloseCreditAccount extends eventOrTx_1.EVMEvent {
         this.creditManager = opts.creditManager;
     }
     toString() {
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was closed`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was closed`;
     }
 }
 exports.EventCloseCreditAccount = EventCloseCreditAccount;
@@ -187,7 +187,7 @@ class EventLiquidateCreditAccount extends eventOrTx_1.EVMEvent {
     }
     toString() {
         const [symbol, decimals = 18] = (0, sdk_gov_1.extractTokenData)(this.underlyingToken);
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was liquidated. ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol} were paid back as remaining funds`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was liquidated. ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol} were paid back as remaining funds`;
     }
 }
 exports.EventLiquidateCreditAccount = EventLiquidateCreditAccount;
@@ -200,7 +200,7 @@ class EventRepayCreditAccount extends eventOrTx_1.EVMEvent {
         this.creditManager = opts.creditManager;
     }
     toString() {
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was repaid`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: was repaid`;
     }
 }
 exports.EventRepayCreditAccount = EventRepayCreditAccount;
@@ -216,7 +216,7 @@ class EventAddCollateral extends eventOrTx_1.EVMEvent {
     }
     toString() {
         const [symbol, decimals = 18] = (0, sdk_gov_1.extractTokenData)(this.addedToken);
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: added ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol} as collateral`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: added ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol} as collateral`;
     }
 }
 exports.EventAddCollateral = EventAddCollateral;
@@ -232,7 +232,7 @@ class EventIncreaseBorrowAmount extends eventOrTx_1.EVMEvent {
     }
     toString() {
         const [symbol, decimals = 18] = (0, sdk_gov_1.extractTokenData)(this.underlyingToken);
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: borrowed amount was increased for ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: borrowed amount was increased for ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
     }
 }
 exports.EventIncreaseBorrowAmount = EventIncreaseBorrowAmount;
@@ -248,7 +248,7 @@ class EventDecreaseBorrowAmount extends eventOrTx_1.EVMEvent {
     }
     toString() {
         const [symbol, decimals = 18] = (0, sdk_gov_1.extractTokenData)(this.underlyingToken);
-        return `Credit account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: borrowed amount was decreased for ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
+        return `Credit Account ${(0, contractsRegister_1.getContractName)(this.creditManager)}: borrowed amount was decreased for ${(0, sdk_gov_1.formatBN)(this.amount, decimals)} ${symbol}`;
     }
 }
 exports.EventDecreaseBorrowAmount = EventDecreaseBorrowAmount;

package/lib/core/gauge.d.ts

@@ -1,11 +1,40 @@
-import { GaugeDataPayload, GaugeQuotaParams } from "../payload/gauge";
+import { Address } from "viem";
+import { GaugeDataPayload, GaugeStakingDataPayload } from "../payload/gauge";
 export declare class GaugeData {
-    readonly address: string;
-    readonly pool: string;
+    readonly address: Address;
+    readonly pool: Address;
+    readonly poolUnderlying: Address;
     readonly name: string;
     readonly symbol: string;
-    readonly currentEpoch: number;
+    readonly currentEpoch: bigint;
     readonly epochFrozen: boolean;
-    readonly quotaParams: Record<string, GaugeQuotaParams>;
+    readonly quotaParams: Record<Address, {
+        token: Address;
+        minRate: bigint;
+        maxRate: bigint;
+        totalVotesLpSide: bigint;
+        totalVotesCaSide: bigint;
+        rate: bigint;
+        quotaIncreaseFee: bigint;
+        totalQuoted: bigint;
+        limit: bigint;
+        isActive: boolean;
+        stakerVotesLpSide: bigint;
+        stakerVotesCaSide: bigint;
+    }>;
     constructor(payload: GaugeDataPayload);
 }
+interface WithDrawableGaugeItem {
+    amount: bigint;
+    epochsLeft: number;
+}
+export declare class GaugeStakingData {
+    readonly availableBalance: bigint;
+    readonly totalBalance: bigint;
+    readonly epoch: bigint;
+    readonly withdrawableNow: bigint;
+    readonly withdrawableInEpochsTotal: bigint;
+    readonly withdrawableInEpochs: Array<WithDrawableGaugeItem>;
+    constructor(payload: GaugeStakingDataPayload);
+}
+export {};

package/lib/core/gauge.js

@@ -1,10 +1,11 @@
 "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;
     pool;
+    poolUnderlying;
     name;
     symbol;
     currentEpoch;
@@ -13,27 +14,51 @@ class GaugeData {
     constructor(payload) {
         this.address = payload.addr.toLowerCase();
         this.pool = payload.pool.toLowerCase();
+        this.poolUnderlying = payload.underlying.toLowerCase();
         this.name = payload.name;
         this.symbol = payload.symbol;
-        this.currentEpoch = payload.currentEpoch;
+        this.currentEpoch = BigInt(payload.currentEpoch);
         this.epochFrozen = payload.epochFrozen;
-        this.quotaParams = Object.fromEntries(payload.quotaParams.map((q) => [
-            q.token.toLowerCase(),
-            {
-                token: q.token.toLowerCase(),
+        this.quotaParams = payload.quotaParams.reduce((acc, q) => {
+            const tokenLc = q.token.toLowerCase();
+            acc[tokenLc] = {
+                token: tokenLc,
                 isActive: q.isActive,
-                rate: q.rate,
-                minRate: q.minRate,
-                maxRate: q.maxRate,
-                quotaIncreaseFee: q.quotaIncreaseFee,
-                totalQuoted: (0, sdk_gov_1.toBigInt)(q.totalQuoted),
-                limit: (0, sdk_gov_1.toBigInt)(q.limit),
-                totalVotesLpSide: (0, sdk_gov_1.toBigInt)(q.totalVotesLpSide),
-                totalVotesCaSide: (0, sdk_gov_1.toBigInt)(q.totalVotesCaSide),
-                stakerVotesLpSide: (0, sdk_gov_1.toBigInt)(q.stakerVotesLpSide),
-                stakerVotesCaSide: (0, sdk_gov_1.toBigInt)(q.stakerVotesCaSide),
-            },
-        ]));
+                rate: BigInt(q.rate) * sdk_gov_1.PERCENTAGE_DECIMALS,
+                minRate: BigInt(q.minRate) * sdk_gov_1.PERCENTAGE_DECIMALS,
+                maxRate: BigInt(q.maxRate) * sdk_gov_1.PERCENTAGE_DECIMALS,
+                quotaIncreaseFee: BigInt(q.quotaIncreaseFee),
+                totalQuoted: q.totalQuoted,
+                limit: q.limit,
+                totalVotesLpSide: q.totalVotesLpSide,
+                totalVotesCaSide: q.totalVotesCaSide,
+                stakerVotesLpSide: q.stakerVotesLpSide,
+                stakerVotesCaSide: q.stakerVotesCaSide,
+            };
+            return acc;
+        }, {});
     }
 }
 exports.GaugeData = GaugeData;
+class GaugeStakingData {
+    availableBalance;
+    totalBalance;
+    epoch;
+    withdrawableNow;
+    withdrawableInEpochsTotal;
+    withdrawableInEpochs;
+    constructor(payload) {
+        this.availableBalance = payload.availableBalance;
+        this.totalBalance = payload.totalBalance;
+        this.epoch = BigInt(payload.epoch);
+        this.withdrawableNow = payload.withdrawableAmounts.withdrawableNow;
+        const { total, list } = payload.withdrawableAmounts.withdrawableInEpochs.reduce(({ total, list }, a, i) => {
+            const bn = a;
+            list.push({ amount: bn, epochsLeft: i + 1 });
+            return { total: total + bn, list };
+        }, { total: 0n, list: [] });
+        this.withdrawableInEpochsTotal = total;
+        this.withdrawableInEpochs = list;
+    }
+}
+exports.GaugeStakingData = GaugeStakingData;

package/lib/core/gaugeMath.d.ts

@@ -0,0 +1,41 @@
+import { Address } from "viem";
+import { GaugeData } from "./gauge";
+export type BaseVoteType = "raise" | "lower";
+export type VoteType = BaseVoteType | "remove";
+export interface BaseVote {
+    amount: bigint;
+    type: BaseVoteType;
+}
+export interface Vote {
+    amount: bigint;
+    type: VoteType;
+}
+export interface SingleVoteState {
+    available: bigint;
+    vote?: BaseVote;
+    voteCalls: Array<Vote>;
+}
+export interface VoteProps {
+    state: Omit<SingleVoteState, "voteCalls">;
+    change?: Vote;
+}
+interface UnvoteProps {
+    initialVote?: BaseVote;
+    balanceAfter: bigint;
+    nextVoteType: BaseVoteType;
+    voteAfter?: Omit<SingleVoteState, "available">;
+}
+export interface GetGaugeApyProps {
+    quota: Pick<GaugeData["quotaParams"][Address], "totalVotesCaSide" | "totalVotesLpSide" | "stakerVotesCaSide" | "stakerVotesLpSide" | "minRate" | "maxRate"> | undefined;
+    vote?: BaseVote;
+    voteAfter?: Omit<SingleVoteState, "available">;
+}
+export declare class GaugeMath {
+    static vote({ change, ...rest }: VoteProps): SingleVoteState | undefined;
+    private static addVotes;
+    private static removeVotes;
+    static revertVote({ balanceAfter, initialVote, nextVoteType, voteAfter, }: UnvoteProps): bigint | undefined;
+    static getBaseVote: (v: GaugeData["quotaParams"][Address]) => BaseVote | undefined;
+    static getGaugeApy({ quota, voteAfter, vote }: GetGaugeApyProps): bigint | null;
+}
+export {};

package/lib/core/gaugeMath.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GaugeMath = void 0;
+const math_1 = require("../utils/math");
+class GaugeMath {
+    static vote({ change, ...rest }) {
+        if (change?.type === "remove") {
+            return this.removeVotes({ ...rest, change });
+        }
+        if (change) {
+            return this.addVotes({
+                ...rest,
+                change: { ...change, type: change.type },
+            });
+        }
+        return { ...rest.state, voteCalls: [] };
+    }
+    static addVotes({ state, change }) {
+        const { available, vote } = state;
+        if (!vote) {
+            return {
+                available: available - change.amount,
+                vote: change,
+                voteCalls: [change],
+            };
+        }
+        if (vote.type === change.type) {
+            return {
+                available: available - change.amount,
+                vote: { ...change, amount: vote.amount + change.amount },
+                voteCalls: [change],
+            };
+        }
+        const remove = { type: "remove", amount: vote.amount };
+        return {
+            available: available + vote.amount - change.amount,
+            vote: { ...change, amount: change.amount },
+            voteCalls: [remove, change],
+        };
+    }
+    static removeVotes({ state, change }) {
+        const { available, vote } = state;
+        if (!vote)
+            return { ...state, voteCalls: [] };
+        const safeChange = math_1.BigIntMath.min(vote.amount, change.amount);
+        const afterVote = vote.amount - safeChange;
+        return {
+            available: available + safeChange,
+            vote: { ...vote, amount: afterVote },
+            voteCalls: [{ ...change, amount: safeChange }],
+        };
+    }
+    static revertVote({ balanceAfter, initialVote, nextVoteType, voteAfter, }) {
+        // on vote type change unvote previous vote
+        const prevUnvoted = !initialVote || initialVote.type === nextVoteType
+            ? balanceAfter
+            : balanceAfter + initialVote.amount;
+        if (!voteAfter)
+            return prevUnvoted;
+        // change call is always last, remove is always first
+        const [first, last = first] = voteAfter.voteCalls;
+        const removePart = first?.type === "remove" ? first?.amount || 0n : 0n;
+        const addPart = last?.type !== "remove" ? last?.amount || 0n : 0n;
+        // revert current changes
+        return prevUnvoted + addPart - removePart;
+    }
+    static getBaseVote = (v) => {
+        const voteDown = v.stakerVotesCaSide;
+        const voteUp = v.stakerVotesLpSide;
+        if (!voteDown && !voteUp)
+            return undefined;
+        if (voteDown > 0) {
+            return { type: "lower", amount: voteDown };
+        }
+        if (voteUp > 0) {
+            return { type: "raise", amount: voteUp };
+        }
+        return undefined;
+    };
+    // rate = (minRate *(votesFormin + yourvotesformin) +maxRate*(votesFormax +yourvotesformax)/( votesForMin + votesForMax+yourvotes)
+    static getGaugeApy({ quota, voteAfter, vote }) {
+        if (!quota)
+            return null;
+        const first = voteAfter?.voteCalls?.[0];
+        const last = voteAfter?.voteCalls?.[1] || first;
+        const isRemove = first?.type === "remove";
+        const removeCaPart = isRemove && vote?.type === "lower" ? first?.amount || 0n : 0n;
+        const removeLpPart = isRemove && vote?.type === "raise" ? first?.amount || 0n : 0n;
+        const caPart = last?.type === "lower" ? last?.amount || 0n : 0n;
+        const lpPart = last?.type === "raise" ? last?.amount || 0n : 0n;
+        const caImpact = quota.minRate * (quota.totalVotesCaSide + caPart - removeCaPart);
+        const lpImpact = quota.maxRate * (quota.totalVotesLpSide + lpPart - removeLpPart);
+        const total = quota.totalVotesCaSide +
+            quota.totalVotesLpSide +
+            caPart +
+            lpPart -
+            removeCaPart -
+            removeLpPart;
+        if (total === 0n)
+            return quota.minRate;
+        const r = (caImpact + lpImpact) / total;
+        return r;
+    }
+}
+exports.GaugeMath = GaugeMath;