@pendle/core-v2 2.17.7-tradingbot → 2.18.0-tradingbot

package/typechain-types/BotDecisionHelper.ts

@@ -7,6 +7,8 @@ import {
   BigNumberish,
   BytesLike,
   CallOverrides,
+  ContractTransaction,
+  Overrides,
   PopulatedTransaction,
   Signer,
   utils,
@@ -20,28 +22,6 @@ import type {
   OnEvent,
 } from "./common";
 
-export type BotStateStruct = {
-  lpBalance: BigNumberish;
-  ytBalance: BigNumberish;
-  syBalance: BigNumberish;
-};
-
-export type BotStateStructOutput = [BigNumber, BigNumber, BigNumber] & {
-  lpBalance: BigNumber;
-  ytBalance: BigNumber;
-  syBalance: BigNumber;
-};
-
-export type StrategyStateStruct = {
-  iyFlag: BigNumberish;
-  syRatioFlag: BigNumberish;
-};
-
-export type StrategyStateStructOutput = [number, number] & {
-  iyFlag: number;
-  syRatioFlag: number;
-};
-
 export type MarketStateStruct = {
   totalPt: BigNumberish;
   totalSy: BigNumberish;
@@ -110,13 +90,32 @@ export type ApproxParamsStructOutput = [
   eps: BigNumber;
 };
 
+export type BotStateStruct = {
+  lpBalance: BigNumberish;
+  ytBalance: BigNumberish;
+  syBalance: BigNumberish;
+  buyBins: BigNumberish;
+};
+
+export type BotStateStructOutput = [
+  BigNumber,
+  BigNumber,
+  BigNumber,
+  BigNumber
+] & {
+  lpBalance: BigNumber;
+  ytBalance: BigNumber;
+  syBalance: BigNumber;
+  buyBins: BigNumber;
+};
+
 export type LongTradingSpecsStruct = {
-  lowerIyLimit: BigNumberish;
-  upperIyLimit: BigNumberish;
-  floatingSyRatioLimit: BigNumberish;
-  floatingSyRatioTarget: BigNumberish;
-  ytPtRatioLimit: BigNumberish;
-  ytPtRatioTarget: BigNumberish;
+  buyYtIy: BigNumberish;
+  sellYtIy: BigNumberish;
+  targetSyRatio: BigNumberish;
+  maxSyRatio: BigNumberish;
+  minYtPtRatio: BigNumberish;
+  numOfBins: BigNumberish;
 };
 
 export type LongTradingSpecsStructOutput = [
@@ -127,37 +126,72 @@ export type LongTradingSpecsStructOutput = [
   BigNumber,
   BigNumber
 ] & {
-  lowerIyLimit: BigNumber;
-  upperIyLimit: BigNumber;
-  floatingSyRatioLimit: BigNumber;
-  floatingSyRatioTarget: BigNumber;
-  ytPtRatioLimit: BigNumber;
-  ytPtRatioTarget: BigNumber;
+  buyYtIy: BigNumber;
+  sellYtIy: BigNumber;
+  targetSyRatio: BigNumber;
+  maxSyRatio: BigNumber;
+  minYtPtRatio: BigNumber;
+  numOfBins: BigNumber;
+};
+
+export type StrategyDataStruct = {
+  botState: BotStateStruct;
+  marketExt: MarketExtStateStruct;
+  specs: LongTradingSpecsStruct;
 };
 
+export type StrategyDataStructOutput = [
+  BotStateStructOutput,
+  MarketExtStateStructOutput,
+  LongTradingSpecsStructOutput
+] & {
+  botState: BotStateStructOutput;
+  marketExt: MarketExtStateStructOutput;
+  specs: LongTradingSpecsStructOutput;
+};
+
+export declare namespace IBotDecisionHelper {
+  export type ActionToTakeResultStruct = {
+    action: BigNumberish;
+    currentBin: BigNumberish;
+    guessBotParams: BigNumberish;
+    guessIntParams: BigNumberish;
+  };
+
+  export type ActionToTakeResultStructOutput = [
+    number,
+    BigNumber,
+    BigNumber,
+    BigNumber
+  ] & {
+    action: number;
+    currentBin: BigNumber;
+    guessBotParams: BigNumber;
+    guessIntParams: BigNumber;
+  };
+}
+
 export interface BotDecisionHelperInterface extends utils.Interface {
   contractName: "BotDecisionHelper";
   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;
+    "INF()": FunctionFragment;
+    "MINIMAL_EPS()": FunctionFragment;
+    "_searchForIntParam(((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),uint8,uint256,(uint256,uint256,uint256,uint256,uint256))": FunctionFragment;
+    "botExtStats((uint256,uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256))": FunctionFragment;
+    "getActionDetails(address)": FunctionFragment;
+    "getCurrentBin(((uint256,uint256,uint256,uint256),((int256,int256,int256,address,int256,uint256,uint256,uint256,uint256),uint256,uint256),(uint256,uint256,uint256,uint256,uint256,uint256)))": FunctionFragment;
+    "previewAction(((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))": FunctionFragment;
+    "searchForBotParam(((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))": FunctionFragment;
   };
 
+  encodeFunctionData(functionFragment: "INF", values?: undefined): string;
   encodeFunctionData(
-    functionFragment: "actionToTake",
-    values: [BotStateStruct, StrategyStateStruct]
+    functionFragment: "MINIMAL_EPS",
+    values?: undefined
   ): string;
   encodeFunctionData(
-    functionFragment: "botExtStats",
-    values: [BotStateStruct, MarketExtStateStruct]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "previewAction",
+    functionFragment: "_searchForIntParam",
     values: [
-      BotStateStruct,
       MarketExtStateStruct,
       BigNumberish,
       BigNumberish,
@@ -165,32 +199,39 @@ export interface BotDecisionHelperInterface extends utils.Interface {
     ]
   ): string;
   encodeFunctionData(
-    functionFragment: "searchForBotParam",
-    values: [
-      BotStateStruct,
-      MarketExtStateStruct,
-      LongTradingSpecsStruct,
-      BigNumberish,
-      ApproxParamsStruct,
-      ApproxParamsStruct
-    ]
+    functionFragment: "botExtStats",
+    values: [BotStateStruct, MarketExtStateStruct]
   ): string;
   encodeFunctionData(
-    functionFragment: "searchForIntParam",
+    functionFragment: "getActionDetails",
+    values: [string]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "getCurrentBin",
+    values: [StrategyDataStruct]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "previewAction",
+    values: [StrategyDataStruct, BigNumberish, BigNumberish, ApproxParamsStruct]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "searchForBotParam",
     values: [
-      MarketExtStateStruct,
+      StrategyDataStruct,
       BigNumberish,
       BigNumberish,
+      ApproxParamsStruct,
       ApproxParamsStruct
     ]
   ): string;
-  encodeFunctionData(
-    functionFragment: "strategyState",
-    values: [BotStateStruct, MarketExtStateStruct, LongTradingSpecsStruct]
-  ): string;
 
+  decodeFunctionResult(functionFragment: "INF", data: BytesLike): Result;
+  decodeFunctionResult(
+    functionFragment: "MINIMAL_EPS",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
-    functionFragment: "actionToTake",
+    functionFragment: "_searchForIntParam",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
@@ -198,19 +239,19 @@ export interface BotDecisionHelperInterface extends utils.Interface {
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "previewAction",
+    functionFragment: "getActionDetails",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "searchForBotParam",
+    functionFragment: "getCurrentBin",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "searchForIntParam",
+    functionFragment: "previewAction",
     data: BytesLike
   ): Result;
   decodeFunctionResult(
-    functionFragment: "strategyState",
+    functionFragment: "searchForBotParam",
     data: BytesLike
   ): Result;
 
@@ -245,14 +286,20 @@ export interface BotDecisionHelper extends BaseContract {
   removeListener: OnEvent<this>;
 
   functions: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
+    INF(overrides?: CallOverrides): Promise<[BigNumber]>;
+
+    MINIMAL_EPS(overrides?: CallOverrides): Promise<[BigNumber]>;
+
+    _searchForIntParam(
+      marketExt: MarketExtStateStruct,
+      action: BigNumberish,
+      botParam: BigNumberish,
+      intParams: ApproxParamsStruct,
       overrides?: CallOverrides
-    ): Promise<[number]>;
+    ): Promise<[BigNumber]>;
 
     botExtStats(
-      bot: BotStateStruct,
+      botState: BotStateStruct,
       marketExt: MarketExtStateStruct,
       overrides?: CallOverrides
     ): Promise<
@@ -264,9 +311,18 @@ export interface BotDecisionHelper extends BaseContract {
       }
     >;
 
+    getActionDetails(
+      botAddress: string,
+      overrides?: Overrides & { from?: string | Promise<string> }
+    ): Promise<ContractTransaction>;
+
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
+      overrides?: CallOverrides
+    ): Promise<[BigNumber]>;
+
     previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
       botParam: BigNumberish,
       swapApproxParams: ApproxParamsStruct,
@@ -280,41 +336,29 @@ export interface BotDecisionHelper extends BaseContract {
     >;
 
     searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
+      targetIy: BigNumberish,
       botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
-    ): Promise<[BigNumber, number]>;
-
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      intParams: ApproxParamsStruct,
-      overrides?: CallOverrides
     ): Promise<[BigNumber]>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<
-      [StrategyStateStructOutput] & { currentState: StrategyStateStructOutput }
-    >;
   };
 
-  actionToTake(
-    botState: BotStateStruct,
-    currentState: StrategyStateStruct,
+  INF(overrides?: CallOverrides): Promise<BigNumber>;
+
+  MINIMAL_EPS(overrides?: CallOverrides): Promise<BigNumber>;
+
+  _searchForIntParam(
+    marketExt: MarketExtStateStruct,
+    action: BigNumberish,
+    botParam: BigNumberish,
+    intParams: ApproxParamsStruct,
     overrides?: CallOverrides
-  ): Promise<number>;
+  ): Promise<BigNumber>;
 
   botExtStats(
-    bot: BotStateStruct,
+    botState: BotStateStruct,
     marketExt: MarketExtStateStruct,
     overrides?: CallOverrides
   ): Promise<
@@ -326,9 +370,18 @@ export interface BotDecisionHelper extends BaseContract {
     }
   >;
 
+  getActionDetails(
+    botAddress: string,
+    overrides?: Overrides & { from?: string | Promise<string> }
+  ): Promise<ContractTransaction>;
+
+  getCurrentBin(
+    strategyData: StrategyDataStruct,
+    overrides?: CallOverrides
+  ): Promise<BigNumber>;
+
   previewAction(
-    botData: BotStateStruct,
-    marketExtData: MarketExtStateStruct,
+    strategyData: StrategyDataStruct,
     action: BigNumberish,
     botParam: BigNumberish,
     swapApproxParams: ApproxParamsStruct,
@@ -342,39 +395,29 @@ export interface BotDecisionHelper extends BaseContract {
   >;
 
   searchForBotParam(
-    bot: BotStateStruct,
-    marketExt: MarketExtStateStruct,
-    specs: LongTradingSpecsStruct,
+    strategyData: StrategyDataStruct,
     action: BigNumberish,
+    targetIy: BigNumberish,
     botParams: ApproxParamsStruct,
     intParams: ApproxParamsStruct,
     overrides?: CallOverrides
-  ): Promise<[BigNumber, number]>;
-
-  searchForIntParam(
-    marketExt: MarketExtStateStruct,
-    action: BigNumberish,
-    botParam: BigNumberish,
-    intParams: ApproxParamsStruct,
-    overrides?: CallOverrides
   ): Promise<BigNumber>;
 
-  strategyState(
-    bot: BotStateStruct,
-    marketExt: MarketExtStateStruct,
-    specs: LongTradingSpecsStruct,
-    overrides?: CallOverrides
-  ): Promise<StrategyStateStructOutput>;
-
   callStatic: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
+    INF(overrides?: CallOverrides): Promise<BigNumber>;
+
+    MINIMAL_EPS(overrides?: CallOverrides): Promise<BigNumber>;
+
+    _searchForIntParam(
+      marketExt: MarketExtStateStruct,
+      action: BigNumberish,
+      botParam: BigNumberish,
+      intParams: ApproxParamsStruct,
       overrides?: CallOverrides
-    ): Promise<number>;
+    ): Promise<BigNumber>;
 
     botExtStats(
-      bot: BotStateStruct,
+      botState: BotStateStruct,
       marketExt: MarketExtStateStruct,
       overrides?: CallOverrides
     ): Promise<
@@ -386,9 +429,18 @@ export interface BotDecisionHelper extends BaseContract {
       }
     >;
 
+    getActionDetails(
+      botAddress: string,
+      overrides?: CallOverrides
+    ): Promise<IBotDecisionHelper.ActionToTakeResultStructOutput>;
+
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
+      overrides?: CallOverrides
+    ): Promise<BigNumber>;
+
     previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
       botParam: BigNumberish,
       swapApproxParams: ApproxParamsStruct,
@@ -402,16 +454,23 @@ export interface BotDecisionHelper extends BaseContract {
     >;
 
     searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
+      targetIy: BigNumberish,
       botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
-    ): Promise<[BigNumber, number]>;
+    ): Promise<BigNumber>;
+  };
+
+  filters: {};
+
+  estimateGas: {
+    INF(overrides?: CallOverrides): Promise<BigNumber>;
+
+    MINIMAL_EPS(overrides?: CallOverrides): Promise<BigNumber>;
 
-    searchForIntParam(
+    _searchForIntParam(
       marketExt: MarketExtStateStruct,
       action: BigNumberish,
       botParam: BigNumberish,
@@ -419,32 +478,24 @@ export interface BotDecisionHelper extends BaseContract {
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    strategyState(
-      bot: BotStateStruct,
+    botExtStats(
+      botState: BotStateStruct,
       marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
       overrides?: CallOverrides
-    ): Promise<StrategyStateStructOutput>;
-  };
-
-  filters: {};
+    ): Promise<BigNumber>;
 
-  estimateGas: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
-      overrides?: CallOverrides
+    getActionDetails(
+      botAddress: string,
+      overrides?: Overrides & { from?: string | Promise<string> }
     ): Promise<BigNumber>;
 
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
     previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
       botParam: BigNumberish,
       swapApproxParams: ApproxParamsStruct,
@@ -452,47 +503,46 @@ export interface BotDecisionHelper extends BaseContract {
     ): Promise<BigNumber>;
 
     searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
+      targetIy: BigNumberish,
       botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<BigNumber>;
+  };
+
+  populateTransaction: {
+    INF(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
-    searchForIntParam(
+    MINIMAL_EPS(overrides?: CallOverrides): Promise<PopulatedTransaction>;
+
+    _searchForIntParam(
       marketExt: MarketExtStateStruct,
       action: BigNumberish,
       botParam: BigNumberish,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
-    ): Promise<BigNumber>;
+    ): Promise<PopulatedTransaction>;
 
-    strategyState(
-      bot: BotStateStruct,
+    botExtStats(
+      botState: BotStateStruct,
       marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
       overrides?: CallOverrides
-    ): Promise<BigNumber>;
-  };
+    ): Promise<PopulatedTransaction>;
 
-  populateTransaction: {
-    actionToTake(
-      botState: BotStateStruct,
-      currentState: StrategyStateStruct,
-      overrides?: CallOverrides
+    getActionDetails(
+      botAddress: string,
+      overrides?: Overrides & { from?: string | Promise<string> }
     ): Promise<PopulatedTransaction>;
 
-    botExtStats(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
+    getCurrentBin(
+      strategyData: StrategyDataStruct,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
     previewAction(
-      botData: BotStateStruct,
-      marketExtData: MarketExtStateStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
       botParam: BigNumberish,
       swapApproxParams: ApproxParamsStruct,
@@ -500,28 +550,12 @@ export interface BotDecisionHelper extends BaseContract {
     ): Promise<PopulatedTransaction>;
 
     searchForBotParam(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
+      strategyData: StrategyDataStruct,
       action: BigNumberish,
+      targetIy: BigNumberish,
       botParams: ApproxParamsStruct,
       intParams: ApproxParamsStruct,
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
-
-    searchForIntParam(
-      marketExt: MarketExtStateStruct,
-      action: BigNumberish,
-      botParam: BigNumberish,
-      intParams: ApproxParamsStruct,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    strategyState(
-      bot: BotStateStruct,
-      marketExt: MarketExtStateStruct,
-      specs: LongTradingSpecsStruct,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
   };
 }