@gearbox-protocol/sdk 3.0.0-next.21 → 3.0.0-next.211

package/lib/core/trade.js

@@ -7,50 +7,58 @@ const core_1 = require("../pathfinder/core");
 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, sdk_gov_1.formatBN)(this.sourceAmount, decimalsFrom)} ${symbolFrom} ⇒ ${(0, sdk_gov_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, swapOperation, swapName, }) {
         const trades = results.reduce((acc, tradePath) => {
             const { calls } = tradePath;
-            const callInfo = Trade.getCallInfo(calls, creditManager.address, currentContracts);
+            const callInfo = Trade.getCallInfo(calls, creditManager.address, creditManager.name);
             const trade = new Trade({
                 tradePath,
-                adapter: callInfo[0],
-                swapType,
+                adapter: callInfo[0] || {
+                    name: "unknown",
+                    contractAddress: calls[0]?.target || "",
+                    creditManager: creditManager.address,
+                    creditManagerName: creditManager.name,
+                },
+                swapOperation,
                 sourceAmount: amount,
-                expectedAmount: tradePath.amount,
-                tokenFrom: from,
-                tokenTo: to,
+                minExpectedAmount: tradePath.minAmount,
+                averageExpectedAmount: tradePath.amount,
+                tokenIn,
+                tokenOut,
                 swapName,
             });
             acc.push(trade);
@@ -58,17 +66,17 @@ class Trade {
         }, []);
         return trades;
     }
-    static getCallInfo(calls, creditManager, currentContracts) {
+    static getCallInfo(calls, creditManager, creditManagerName) {
         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({
                 name,
-                contractAddress,
                 creditManager,
+                creditManagerName,
             });
             return acc;
         }, []);
@@ -86,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,8 +1,17 @@
 import { SupportedContract } from "@gearbox-protocol/sdk-gov";
+import { Address } from "viem";
 import { Asset } from "./assets";
 import { EVMTx, EVMTxProps } from "./eventOrTx";
+interface CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+}
+interface PoolEvent {
+    readonly pool: string;
+    readonly poolName?: string;
+}
 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" | "TxClaimRewards" | "TxEnableTokens" | "TxUpdateQuota" | "TxGaugeStake" | "TxGaugeUnstake" | "TxGaugeClaim" | "TxGaugeVote" | "TxWithdrawCollateral" | "TxAddBot" | "TxRemoveBot" | "TxLiquidateAccount" | "TxStakeDiesel" | "TxUnstakeDiesel";
     content: string;
 }
 export declare class TxSerializer {
@@ -11,116 +20,161 @@ export declare class TxSerializer {
 }
 interface AddLiquidityProps extends EVMTxProps {
     amount: bigint;
-    underlyingToken: string;
-    pool: string;
+    underlyingToken: Address;
+    pool: Address;
+    poolName?: string;
 }
-export declare class TxAddLiquidity extends EVMTx {
+export declare class TxAddLiquidity extends EVMTx implements PoolEvent {
     readonly amount: bigint;
-    readonly underlyingToken: string;
-    readonly pool: string;
+    readonly underlyingToken: Address;
+    readonly pool: Address;
+    readonly poolName?: string;
     constructor(opts: AddLiquidityProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface RemoveLiquidityProps extends EVMTxProps {
     amount: bigint;
-    dieselToken: string;
-    pool: string;
+    dieselToken: Address;
+    pool: Address;
+    poolName?: string;
 }
-export declare class TxRemoveLiquidity extends EVMTx {
+export declare class TxRemoveLiquidity extends EVMTx implements PoolEvent {
     readonly amount: bigint;
-    readonly dieselToken: string;
-    readonly pool: string;
+    readonly dieselToken: Address;
+    readonly pool: Address;
+    readonly poolName?: string;
     constructor(opts: RemoveLiquidityProps);
     toString(): string;
     serialize(): TxSerialized;
 }
+interface TxStakeDieselProps extends EVMTxProps {
+    amount: bigint;
+    from: Address;
+    to: Address;
+    pool: Address;
+    poolName?: string;
+}
+export declare class TxStakeDiesel extends EVMTx implements PoolEvent {
+    readonly amount: bigint;
+    readonly from: Address;
+    readonly to: Address;
+    readonly pool: Address;
+    readonly poolName?: string;
+    constructor(opts: TxStakeDieselProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+export declare class TxUnstakeDiesel extends EVMTx implements PoolEvent {
+    readonly amount: bigint;
+    readonly from: Address;
+    readonly to: Address;
+    readonly pool: Address;
+    readonly poolName?: string;
+    constructor(opts: TxStakeDieselProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 interface SwapProps extends EVMTxProps {
     protocol: string;
     operation: string;
     amountFrom: bigint;
     amountTo?: bigint;
-    tokenFrom: string;
-    tokenTo?: string;
-    creditManager: string;
+    tokenFrom: Address;
+    tokenTo?: Address;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TXSwap extends EVMTx {
+export declare class TXSwap extends EVMTx implements CMEvent {
     readonly protocol: string;
     readonly operation: string;
     readonly amountFrom: bigint;
     readonly amountTo?: bigint;
-    readonly tokenFrom: string;
-    readonly tokenTo?: string;
-    readonly creditManager: string;
+    readonly tokenFrom: Address;
+    readonly tokenTo?: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: SwapProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface AddCollateralProps extends EVMTxProps {
     amount: bigint;
-    addedToken: string;
-    creditManager: string;
+    addedToken: Address;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxAddCollateral extends EVMTx {
+export declare class TxAddCollateral extends EVMTx implements CMEvent {
     readonly amount: bigint;
-    readonly addedToken: string;
-    readonly creditManager: string;
+    readonly addedToken: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: AddCollateralProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface IncreaseBorrowAmountProps extends EVMTxProps {
     amount: bigint;
-    underlyingToken: string;
-    creditManager: string;
+    underlyingToken: Address;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxIncreaseBorrowAmount extends EVMTx {
+export declare class TxIncreaseBorrowAmount extends EVMTx implements CMEvent {
     readonly amount: bigint;
-    readonly underlyingToken: string;
-    readonly creditManager: string;
+    readonly underlyingToken: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: IncreaseBorrowAmountProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface DecreaseBorrowAmountProps extends EVMTxProps {
     amount: bigint;
-    underlyingToken: string;
-    creditManager: string;
+    underlyingToken: Address;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxDecreaseBorrowAmount extends EVMTx {
+export declare class TxDecreaseBorrowAmount extends EVMTx implements CMEvent {
     readonly amount: bigint;
-    readonly underlyingToken: string;
-    readonly creditManager: string;
+    readonly underlyingToken: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: DecreaseBorrowAmountProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface OpenAccountProps extends EVMTxProps {
     amount: bigint;
-    underlyingToken: string;
+    underlyingToken: Address;
     leverage: number;
-    creditManager: string;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxOpenAccount extends EVMTx {
+export declare class TxOpenAccount extends EVMTx implements CMEvent {
     readonly amount: bigint;
-    readonly underlyingToken: string;
+    readonly underlyingToken: Address;
     readonly leverage: number;
-    readonly creditManager: string;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: OpenAccountProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface TxOpenMultitokenAccountProps extends EVMTxProps {
     borrowedAmount: bigint;
-    creditManager: string;
-    underlyingToken: string;
-    assets: Array<string>;
+    creditManager: Address;
+    creditManagerName?: string;
+    underlyingToken: Address;
+    assets: Array<Address>;
+    withdrawDebt: boolean;
 }
-export declare class TxOpenMultitokenAccount extends EVMTx {
+export declare class TxOpenMultitokenAccount extends EVMTx implements CMEvent {
     readonly borrowedAmount: bigint;
-    readonly creditManager: string;
-    readonly underlyingToken: string;
-    readonly assets: Array<string>;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+    readonly underlyingToken: Address;
+    readonly assets: Array<Address>;
+    readonly withdrawDebt: boolean;
     constructor(opts: TxOpenMultitokenAccountProps);
     toString(): string;
     serialize(): TxSerialized;
@@ -134,74 +188,161 @@ 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;
 }
-interface TxClaimGearRewardsProps extends EVMTxProps {
-    token: string;
+interface TxClaimRewardsProps extends EVMTxProps {
+    token: Address;
     amount: bigint;
 }
-export declare class TxClaimGearRewards extends EVMTx {
-    readonly token: string;
+export declare class TxClaimRewards extends EVMTx {
+    readonly token: Address;
     readonly amount: bigint;
-    constructor(opts: TxClaimGearRewardsProps);
+    constructor(opts: TxClaimRewardsProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface RepayAccountProps extends EVMTxProps {
-    creditManager: string;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxRepayAccount extends EVMTx {
-    readonly creditManager: string;
+export declare class TxRepayAccount extends EVMTx implements CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: RepayAccountProps);
     toString(): string;
     serialize(): TxSerialized;
 }
+interface LiquidateAccountProps extends EVMTxProps {
+    creditManager: Address;
+    creditManagerName?: string;
+}
+export declare class TxLiquidateAccount extends EVMTx implements CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+    constructor(opts: LiquidateAccountProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 interface CloseAccountProps extends EVMTxProps {
-    creditManager: string;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxCloseAccount extends EVMTx {
-    readonly creditManager: string;
+export declare class TxCloseAccount extends EVMTx implements CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: CloseAccountProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface ApproveProps extends EVMTxProps {
-    token: string;
+    token: Address;
 }
 export declare class TxApprove extends EVMTx {
-    readonly token: string;
+    readonly token: Address;
     constructor(opts: ApproveProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface TxEnableTokensProps extends EVMTxProps {
-    enabledTokens: Array<string>;
-    disabledTokens: Array<string>;
-    creditManager: string;
-}
-export declare class TxEnableTokens extends EVMTx {
-    readonly enabledTokens: Array<string>;
-    readonly disabledTokens: Array<string>;
-    readonly creditManager: string;
+    enabledTokens: Array<Address>;
+    disabledTokens: Array<Address>;
+    creditManager: Address;
+    creditManagerName?: string;
+}
+export declare class TxEnableTokens extends EVMTx implements CMEvent {
+    readonly enabledTokens: Array<Address>;
+    readonly disabledTokens: Array<Address>;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
     constructor(opts: TxEnableTokensProps);
     toString(): string;
     serialize(): TxSerialized;
 }
 interface TxUpdateQuotaProps extends EVMTxProps {
     updatedQuotas: Array<Asset>;
-    underlyingToken: string;
-    creditManager: string;
+    underlyingToken: Address;
+    creditManager: Address;
+    creditManagerName?: string;
 }
-export declare class TxUpdateQuota extends EVMTx {
+export declare class TxUpdateQuota extends EVMTx implements CMEvent {
     readonly updatedQuotas: Array<Asset>;
-    readonly underlyingToken: string;
-    readonly creditManager: string;
+    readonly underlyingToken: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: 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: Address;
+    }>;
+}
+export declare class TxGaugeVote extends EVMTx {
+    readonly tokens: Array<{
+        token: Address;
+    }>;
+    constructor(opts: TxGaugeVoteProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface WithdrawCollateralProps extends EVMTxProps {
+    amount: bigint;
+    token: Address;
+    to: Address;
+    creditManager: Address;
+    creditManagerName?: string;
+}
+export declare class TxWithdrawCollateral extends EVMTx implements CMEvent {
+    readonly amount: bigint;
+    readonly token: Address;
+    readonly to: Address;
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+    constructor(opts: WithdrawCollateralProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+interface TxAddBotProps extends EVMTxProps {
+    creditManager: Address;
+    creditManagerName?: string;
+}
+export declare class TxAddBot extends EVMTx implements CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+    constructor(opts: TxAddBotProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
+export declare class TxRemoveBot extends EVMTx implements CMEvent {
+    readonly creditManager: Address;
+    readonly creditManagerName?: string;
+    constructor(opts: TxAddBotProps);
+    toString(): string;
+    serialize(): TxSerialized;
+}
 export {};