@pendle/core-v2 2.20.0 → 2.21.0-tradingbot

package/typechain-types/IBotDecisionHelper.ts

@@ -23,23 +23,23 @@ import type {
 export type BotStateStruct = {
   lpBalance: BigNumberish;
   ytBalance: BigNumberish;
+  ptBalance: BigNumberish;
   syBalance: BigNumberish;
+  buyBins: BigNumberish;
 };
 
-export type BotStateStructOutput = [BigNumber, BigNumber, BigNumber] & {
+export type BotStateStructOutput = [
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber
+] & {
   lpBalance: BigNumber;
   ytBalance: BigNumber;
+  ptBalance: BigNumber;
   syBalance: BigNumber;
-};
-
-export type StrategyStateStruct = {
-  iyFlag: BigNumberish;
-  syRatioFlag: BigNumberish;
-};
-
-export type StrategyStateStructOutput = [number, number] & {
-  iyFlag: number;
-  syRatioFlag: number;
+  buyBins: BigNumber;
 };
 
 export type MarketStateStruct = {
@@ -88,6 +88,47 @@ export type MarketExtStateStructOutput = [
   BigNumber
 ] & { state: MarketStateStructOutput; index: BigNumber; blockTime: BigNumber };
 
+export type TradingSpecsStruct = {
+  buyYtIy: BigNumberish;
+  sellYtIy: BigNumberish;
+  targetSyRatio: BigNumberish;
+  bufferSyRatio: BigNumberish;
+  minYtPtRatio: BigNumberish;
+  numOfBins: BigNumberish;
+};
+
+export type TradingSpecsStructOutput = [
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber
+] & {
+  buyYtIy: BigNumber;
+  sellYtIy: BigNumber;
+  targetSyRatio: BigNumber;
+  bufferSyRatio: BigNumber;
+  minYtPtRatio: BigNumber;
+  numOfBins: BigNumber;
+};
+
+export type StrategyDataStruct = {
+  botState: BotStateStruct;
+  marketExt: MarketExtStateStruct;
+  specs: TradingSpecsStruct;
+};
+
+export type StrategyDataStructOutput = [
+  BotStateStructOutput,
+  MarketExtStateStructOutput,
+  TradingSpecsStructOutput
+] & {
+  botState: BotStateStructOutput;
+  marketExt: MarketExtStateStructOutput;
+  specs: TradingSpecsStructOutput;
+};
+
 export type ApproxParamsStruct = {
   guessMin: BigNumberish;
   guessMax: BigNumberish;
@@ -110,107 +151,108 @@ export type ApproxParamsStructOutput = [
   eps: BigNumber;
 };
 
-export type LongTradingSpecsStruct = {
-  lowerIyLimit: BigNumberish;
-  upperIyLimit: BigNumberish;
-  floatingSyRatioLimit: BigNumberish;
-  floatingSyRatioTarget: BigNumberish;
-  ytPtRatioLimit: BigNumberish;
-  ytPtRatioTarget: BigNumberish;
-};
+export declare namespace IBotDecisionHelper {
+  export type RebalanceOutputStruct = {
+    rebalanceType: BigNumberish;
+    amountIn: BigNumberish;
+    amountOut: BigNumberish;
+    amountOut2: BigNumberish;
+  };
 
-export type LongTradingSpecsStructOutput = [
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber
-] & {
-  lowerIyLimit: BigNumber;
-  upperIyLimit: BigNumber;
-  floatingSyRatioLimit: BigNumber;
-  floatingSyRatioTarget: BigNumber;
-  ytPtRatioLimit: BigNumber;
-  ytPtRatioTarget: BigNumber;
-};
+  export type RebalanceOutputStructOutput = [
+    number,
+    BigNumber,
+    BigNumber,
+    BigNumber
+  ] & {
+    rebalanceType: number;
+    amountIn: BigNumber;
+    amountOut: BigNumber;
+    amountOut2: BigNumber;
+  };
+
+  export type TradeResultStruct = {
+    action: BigNumberish;
+    currentBin: BigNumberish;
+    targetIy: BigNumberish;
+    guessBotParams: BigNumberish;
+    guessIntParams: BigNumberish;
+    amountOut: BigNumberish;
+  };
+
+  export type TradeResultStructOutput = [
+    number,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber,
+    BigNumber
+  ] & {
+    action: number;
+    currentBin: BigNumber;
+    targetIy: BigNumber;
+    guessBotParams: BigNumber;
+    guessIntParams: BigNumber;
+    amountOut: BigNumber;
+  };
+}
 
 export interface IBotDecisionHelperInterface extends utils.Interface {
   contractName: "IBotDecisionHelper";
   functions: {
-    "actionToTake((uint256,uint256,uint256),(uint8,uint8))": FunctionFragment;
-    "botExtStats((uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256))": FunctionFragment;
-    "previewAction((uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),uint8,uint256,(uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
-    "searchForBotParam((uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),(uint256,uint256,uint256,uint256,uint256,uint256),uint8,(uint256,uint256,uint256,uint256,uint256),(uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
-    "searchForIntParam(((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),uint8,uint256,(uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
-    "strategyState((uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),(uint256,uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
+    "getBotPosition(address)": FunctionFragment;
+    "getCurrentBin(((uint256,uint256,uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),(uint256,uint256,uint256,uint256,uint256,uint256)))": FunctionFragment;
+    "getRebalanceAction(address)": FunctionFragment;
+    "getTradeAction(address)": FunctionFragment;
+    "searchForBotParam(((uint256,uint256,uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),(uint256,uint256,uint256,uint256,uint256,uint256)),uint8,uint256,uint256,(uint256,uint256,uint256,uint256,uint256),(uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
   };
 
   encodeFunctionData(
-    functionFragment: "actionToTake",
-    values: [BotStateStruct, StrategyStateStruct]
+    functionFragment: "getBotPosition",
+    values: [string]
   ): string;
   encodeFunctionData(
-    functionFragment: "botExtStats",
-    values: [BotStateStruct, MarketExtStateStruct]
+    functionFragment: "getCurrentBin",
+    values: [StrategyDataStruct]
   ): string;
   encodeFunctionData(
-    functionFragment: "previewAction",
-    values: [
-      BotStateStruct,
-      MarketExtStateStruct,
-      BigNumberish,
-      BigNumberish,
-      ApproxParamsStruct
-    ]
+    functionFragment: "getRebalanceAction",
+    values: [string]
   ): string;
   encodeFunctionData(
-    functionFragment: "searchForBotParam",
-    values: [
-      BotStateStruct,
-      MarketExtStateStruct,
-      LongTradingSpecsStruct,
-      BigNumberish,
-      ApproxParamsStruct,
-      ApproxParamsStruct
-    ]
+    functionFragment: "getTradeAction",
+    values: [string]
   ): string;
   encodeFunctionData(
-    functionFragment: "searchForIntParam",
+    functionFragment: "searchForBotParam",
     values: [
-      MarketExtStateStruct,
+      StrategyDataStruct,
       BigNumberish,
       BigNumberish,
+      BigNumberish,
+      ApproxParamsStruct,
       ApproxParamsStruct
     ]
   ): string;
-  encodeFunctionData(
-    functionFragment: "strategyState",
-    values: [BotStateStruct, MarketExtStateStruct, LongTradingSpecsStruct]
-  ): string;
 
   decodeFunctionResult(
-    functionFragment: "actionToTake",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "botExtStats",
+    functionFragment: "getBotPosition",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "previewAction",
+    functionFragment: "getCurrentBin",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "searchForBotParam",
+    functionFragment: "getRebalanceAction",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "searchForIntParam",
+    functionFragment: "getTradeAction",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "strategyState",
+    functionFragment: "searchForBotParam",
     data: BytesLike
   ): Result;
 
@@ -245,18 +287,12 @@ export interface IBotDecisionHelper extends BaseContract {
   removeListener: OnEvent<this>;
 
   functions: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
-      overrides?: CallOverrides
-    ): Promise<[number]>;
-
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getBotPosition(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, BigNumber] & {
+      [StrategyDataStructOutput, BigNumber, BigNumber, BigNumber, BigNumber] & {
+        strategyData: StrategyDataStructOutput;
         tvlInSy: BigNumber;
         iy: BigNumber;
         currentSyRatio: BigNumber;
@@ -264,53 +300,42 @@ export interface IBotDecisionHelper extends BaseContract {
       }
     >;
 
-    previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      swapApproxParams: ApproxParamsStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
-    ): Promise<[boolean, BotStateStructOutput, MarketExtStateStructOutput]>;
+    ): Promise<[BigNumber]>;
 
-    searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      action: BigNumberish,
-      botParams: ApproxParamsStruct,
-      intParams: ApproxParamsStruct,
+    getRebalanceAction(
+      botAddress: string,
+      overrides?: CallOverrides
+    ): Promise<[IBotDecisionHelper.RebalanceOutputStructOutput]>;
+
+    getTradeAction(
+      botAddress: string,
       overrides?: CallOverrides
-    ): Promise<[BigNumber, number]>;
+    ): Promise<
+      [IBotDecisionHelper.TradeResultStructOutput] & {
+        res: IBotDecisionHelper.TradeResultStructOutput;
+      }
+    >;
 
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
+    searchForBotParam(
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
-      botParam: BigNumberish,
+      targetIy: BigNumberish,
+      rebalanceAdditionalCheck: BigNumberish,
+      botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<[BigNumber]>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<[StrategyStateStructOutput]>;
   };
 
-  actionToTake(
-    botState: BotStateStruct,
-    currentState: StrategyStateStruct,
-    overrides?: CallOverrides
-  ): Promise<number>;
-
-  botExtStats(
-    bot: BotStateStruct,
-    marketExt: MarketExtStateStruct,
+  getBotPosition(
+    botAddress: string,
     overrides?: CallOverrides
   ): Promise<
-    [BigNumber, BigNumber, BigNumber, BigNumber] & {
+    [StrategyDataStructOutput, BigNumber, BigNumber, BigNumber, BigNumber] & {
+      strategyData: StrategyDataStructOutput;
       tvlInSy: BigNumber;
       iy: BigNumber;
       currentSyRatio: BigNumber;
@@ -318,53 +343,38 @@ export interface IBotDecisionHelper extends BaseContract {
     }
   >;
 
-  previewAction(
-    botData: BotStateStruct,
-    marketExtData: MarketExtStateStruct,
-    action: BigNumberish,
-    botParam: BigNumberish,
-    swapApproxParams: ApproxParamsStruct,
+  getCurrentBin(
+    strategyData: StrategyDataStruct,
     overrides?: CallOverrides
-  ): Promise<[boolean, BotStateStructOutput, MarketExtStateStructOutput]>;
+  ): Promise<BigNumber>;
 
-  searchForBotParam(
-    bot: BotStateStruct,
-    marketExt: MarketExtStateStruct,
-    specs: LongTradingSpecsStruct,
-    action: BigNumberish,
-    botParams: ApproxParamsStruct,
-    intParams: ApproxParamsStruct,
+  getRebalanceAction(
+    botAddress: string,
     overrides?: CallOverrides
-  ): Promise<[BigNumber, number]>;
+  ): Promise<IBotDecisionHelper.RebalanceOutputStructOutput>;
 
-  searchForIntParam(
-    marketExt: MarketExtStateStruct,
+  getTradeAction(
+    botAddress: string,
+    overrides?: CallOverrides
+  ): Promise<IBotDecisionHelper.TradeResultStructOutput>;
+
+  searchForBotParam(
+    strategyData: StrategyDataStruct,
     action: BigNumberish,
-    botParam: BigNumberish,
+    targetIy: BigNumberish,
+    rebalanceAdditionalCheck: BigNumberish,
+    botParams: ApproxParamsStruct,
     intParams: ApproxParamsStruct,
     overrides?: CallOverrides
   ): Promise<BigNumber>;
 
-  strategyState(
-    bot: BotStateStruct,
-    marketExt: MarketExtStateStruct,
-    specs: LongTradingSpecsStruct,
-    overrides?: CallOverrides
-  ): Promise<StrategyStateStructOutput>;
-
   callStatic: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
-      overrides?: CallOverrides
-    ): Promise<number>;
-
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getBotPosition(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<
-      [BigNumber, BigNumber, BigNumber, BigNumber] & {
+      [StrategyDataStructOutput, BigNumber, BigNumber, BigNumber, BigNumber] & {
+        strategyData: StrategyDataStructOutput;
         tvlInSy: BigNumber;
         iy: BigNumber;
         currentSyRatio: BigNumber;
@@ -372,136 +382,95 @@ export interface IBotDecisionHelper extends BaseContract {
       }
     >;
 
-    previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      swapApproxParams: ApproxParamsStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
-    ): Promise<[boolean, BotStateStructOutput, MarketExtStateStructOutput]>;
+    ): Promise<BigNumber>;
 
-    searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      action: BigNumberish,
-      botParams: ApproxParamsStruct,
-      intParams: ApproxParamsStruct,
+    getRebalanceAction(
+      botAddress: string,
+      overrides?: CallOverrides
+    ): Promise<IBotDecisionHelper.RebalanceOutputStructOutput>;
+
+    getTradeAction(
+      botAddress: string,
       overrides?: CallOverrides
-    ): Promise<[BigNumber, number]>;
+    ): Promise<IBotDecisionHelper.TradeResultStructOutput>;
 
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
+    searchForBotParam(
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
-      botParam: BigNumberish,
+      targetIy: BigNumberish,
+      rebalanceAdditionalCheck: BigNumberish,
+      botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<StrategyStateStructOutput>;
   };
 
   filters: {};
 
   estimateGas: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
+    getBotPosition(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      swapApproxParams: ApproxParamsStruct,
+    getRebalanceAction(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      action: BigNumberish,
-      botParams: ApproxParamsStruct,
-      intParams: ApproxParamsStruct,
+    getTradeAction(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
+    searchForBotParam(
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
-      botParam: BigNumberish,
+      targetIy: BigNumberish,
+      rebalanceAdditionalCheck: BigNumberish,
+      botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
   };
 
   populateTransaction: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
+    getBotPosition(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
-    previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      swapApproxParams: ApproxParamsStruct,
+    getRebalanceAction(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
-    searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      action: BigNumberish,
-      botParams: ApproxParamsStruct,
-      intParams: ApproxParamsStruct,
+    getTradeAction(
+      botAddress: string,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
+    searchForBotParam(
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
-      botParam: BigNumberish,
+      targetIy: BigNumberish,
+      rebalanceAdditionalCheck: BigNumberish,
+      botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
   };
 }