@steerprotocol/strategy-utils 3.0.0 → 3.1.1

package/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [1.2.0-alpha.3](https://github.com/SteerProtocol/strategy-utils-assemblyscript/compare/v1.2.0-alpha.2...v1.2.0-alpha.3) (2023-08-23)
+
+
+### Features
+
+* :art: Move Config to all RJFS for EDT ([eb63008](https://github.com/SteerProtocol/strategy-utils-assemblyscript/commit/eb63008fbd9ca9ed3dee9ab81336cce89de5c482))
+
+
+### Bug Fixes
+
+* :ambulance: Object validation ([74b7a05](https://github.com/SteerProtocol/strategy-utils-assemblyscript/commit/74b7a059f79ea02202e10339c87ebefc5778ffcf))
+* remove type for trigger ([f8c4987](https://github.com/SteerProtocol/strategy-utils-assemblyscript/commit/f8c49877779b82c5265c30c79962947eaa014886))
+
 ## [1.2.0-alpha.2](https://github.com/SteerProtocol/strategy-utils-assemblyscript/compare/v1.2.0-alpha.1...v1.2.0-alpha.2) (2023-08-17)
 
 

package/assembly/utils/index.ts

@@ -5,3 +5,4 @@ export * from './SlidingWindow';
 export * from './console';
 export * from './env';
 export * from './types';
+export * from './triggers'

package/assembly/utils/triggers.ts

@@ -1,4 +1,5 @@
 import { JSON } from "json-as";
+// import { Position } from "@steerprotocol/strategy-utils/assembly";
 import { Position } from "./types";
 
 // NOTE: Trigger functions return true when action should be taken, if false then the strategy can return 'continue' to skip exeuction
@@ -160,10 +161,12 @@ export class TriggerConfigHelper {
     }
 }
 
-export function getTriggerExpectedDataTypes(triggerStyle: TriggerStyle): string[] {
+export function getTriggerExpectedDataTypes(triggerStyle: string): string[] {
+  // get tirggerStyle
+  const style = getTriggerStyle(triggerStyle)
   // currently we use only this list
   const typicalTypes = ["Liquidity Manager Positions", "V3 Pool Current Tick", "Time Since Last Execution"]
-    switch (triggerStyle) {
+    switch (style) {
         case TriggerStyle.DistanceFromCenterOfPositions:
             return typicalTypes;
         case TriggerStyle.PercentageChangeFromPositionRange:
@@ -183,35 +186,6 @@ export function getTriggerExpectedDataTypes(triggerStyle: TriggerStyle): string[
     }
 }
 
-
-export function getExpectedDataTypes(strategyDataConnectors: string[], triggerStyle: string): string {
-  const style = getTriggerStyle(triggerStyle)
-  const triggerDatas = getTriggerExpectedDataTypes(style)
-  const dataList = strategyDataConnectors.concat(triggerDatas)
-  let completeList = '['
-  for (let i: i32 = 0; i < dataList.length; i++) {
-    completeList += (' \"' + dataList[i] + '\"')
-    if (i != dataList.length-1) completeList += ','
-  }
-  completeList += ']'
-  return completeList
-}
-
-// no AS func overloading yet :(
-// export function shouldTriggerExecution_1(triggerStyle: TriggerStyle, triggerOptions: TriggerConfigHelper, dataConnector1: string) : boolean {
-//     // parse options
-//     switch (triggerStyle) {
-//         case TriggerStyle.SpecificPrice:
-//             // parse current tick from dc1
-//             const currentTick = parseInt(dataConnector1)
-//             if (!currentTick) return true
-//             // tick and over
-//             return triggerFromSpecifiedPrice(triggerOptions.tickPriceTrigger, currentTick, triggerOptions.triggerWhenOver)
-//         default:
-//             return true
-//     }
-// }
-
 // currently implemented as :: ulm positions [0], current tick [1], time since last execution [2]
 // as more types are added this logic path with be redone
 export function shouldTriggerExecution(
@@ -296,59 +270,78 @@ function getTriggerName(trigger: TriggerStyle): string {
   }
 }
 
+  function expectedDataTypesHelper(strategyDataConnectors: string[], triggerStyle: string): string[] {
+    // const style = getTriggerStyle(triggerStyle)
+    return strategyDataConnectors.concat(getTriggerExpectedDataTypes(triggerStyle))
+    // return `"expectedDataTypes": {
+    //   "hidden": true,
+    //   "type": "string",
+    //   "default": "${(fullDataTypes).toString()}",
+    //   "const": "${(fullDataTypes).toString()}"
+    // }`
+  }
+
+  @serializable
+  export class TriggerInfo {
+    name: string = '';
+    expectedDataTypes: string[] = [];
+    constructor (_name: string, _expectedDataTypes: string[]) {
+      this.name = _name
+      this.expectedDataTypes = _expectedDataTypes
+    }
+  }
 
-export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
-    const triggerList = [
-        TriggerStyle.DistanceFromCenterOfPositions,
-        TriggerStyle.None,
-        TriggerStyle.PercentageChangeFromPositionRange,
-        TriggerStyle.PositionsInactive,
-        TriggerStyle.PricePastPositions,
+export function triggerPropertyHelper(strategyDataTypes: string[], omit: TriggerStyle[] = []): string {
+    // const triggerList = [
+    //     TriggerStyle.DistanceFromCenterOfPositions,
+    //     TriggerStyle.None,
+    //     TriggerStyle.PercentageChangeFromPositionRange,
+    //     TriggerStyle.PositionsInactive,
+    //     TriggerStyle.PricePastPositions,
+    // ];
+
+    const triggersObjects: TriggerInfo[] = [
+      new TriggerInfo('Current Price set distance from center of positions', expectedDataTypesHelper(strategyDataTypes, 'Current Price set distance from center of positions')),
+      new TriggerInfo('Price leaves active range', expectedDataTypesHelper(strategyDataTypes, 'Price leaves active range')),
+      new TriggerInfo('Price moves percentage of active range away', expectedDataTypesHelper(strategyDataTypes, 'Price moves percentage of active range away')),
+      new TriggerInfo('Price moves one way past positions', expectedDataTypesHelper(strategyDataTypes, 'Price moves one way past positions')),
+      new TriggerInfo('None', expectedDataTypesHelper(strategyDataTypes, 'None')),
     ];
 
-    const filteredTriggers: string[] = [
+    const triggerStrings = [
       'Current Price set distance from center of positions',
       'Price leaves active range',
       'Price moves percentage of active range away',
       'Price moves one way past positions',
       'None'
-    ];
-
+    ]
 
     return `"triggerStyle": {
-      "enum": ${JSON.stringify(filteredTriggers)},
+      "enumNames": ${JSON.stringify(triggerStrings)},
+      "enum": ${JSON.stringify(triggersObjects)},
       "title": "Logic to trigger new positions",
-      "type": "string",
-      "default": "None"
+      "default": ${JSON.stringify(new TriggerInfo('None', expectedDataTypesHelper(strategyDataTypes, 'None')))}
     }`;
   }
 
-  export function allOfTrigger(strategyDataConnectors: string[]): string {
+  export function allOfTrigger(strategyDataTypes: string[]): string {
     return `{
     "if": {
       "properties": {
         "triggerStyle": {
-          "const": "None"
+          "const": ${JSON.stringify(new TriggerInfo('None', expectedDataTypesHelper(strategyDataTypes, 'None')))}
         }
       }
     },
     "then": {
-      "properties": {
-        "expectedDataTypes": {
-          "const": ${getExpectedDataTypes(strategyDataConnectors, "None")},
-          "default": ${getExpectedDataTypes(strategyDataConnectors, "None")},
-          "hidden": true,
-          "type": "string"
-        }
-      },
-      "required": ["expectedDataTypes"]
+      "required": []
     }
   },
   {
     "if": {
       "properties": {
         "triggerStyle": {
-          "const": "Current Price set distance from center of positions"
+          "const": ${JSON.stringify(new TriggerInfo('Current Price set distance from center of positions', expectedDataTypesHelper(strategyDataTypes, 'Current Price set distance from center of positions')))}
         }
       }
     },
@@ -360,12 +353,6 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
             "description": "The number of ticks (basis points) from center price of positions to trigger setting new positions",
             "detailedDescription": "The static number of ticks from the center of the active range to trigger: if our position goes from 0-100, and we have a tick distance of 75, we will go out 75 ticks both ways from the center of our positions (50). This means we will skip execution only if the current tick is between -25 and 125. Future positions will determine where the center of the trigger range is located."
         },
-        "expectedDataTypes": {
-          "const": ${getExpectedDataTypes(strategyDataConnectors, "Current Price set distance from center of positions")},
-          "default": ${getExpectedDataTypes(strategyDataConnectors, "Current Price set distance from center of positions")},
-          "hidden": true,
-          "type": "string"
-        },
         "elapsedTendTime": {
           "type": "number",
           "title": "Max time between tends",
@@ -373,25 +360,19 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
           "default": 1209600
         }
       },
-      "required": ["tickDistanceFromCenter", "expectedDataTypes", "elapsedTendTime"]
+      "required": ["tickDistanceFromCenter", "elapsedTendTime"]
     }
   },
   {
     "if": {
       "properties": {
         "triggerStyle": {
-          "const": "Price leaves active range"
+          "const": ${JSON.stringify(new TriggerInfo('Price leaves active range', expectedDataTypesHelper(strategyDataTypes, 'Price leaves active range')),)}
         }
       }
     },
     "then": {
       "properties": {
-        "expectedDataTypes": {
-          "const": ${getExpectedDataTypes(strategyDataConnectors, "Price leaves active range")},
-          "default": ${getExpectedDataTypes(strategyDataConnectors, "Price leaves active range")},
-          "hidden": true,
-          "type": "string"
-        },
         "elapsedTendTime": {
           "type": "number",
           "title": "Max time between tends",
@@ -399,14 +380,14 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
           "default": 1209600
         }
       },
-      "required": ["expectedDataTypes", "elapsedTendTime"]
+      "required": ["elapsedTendTime"]
     }
   },
   {
     "if": {
       "properties": {
         "triggerStyle": {
-          "const": "Price moves percentage of active range away"
+          "const": ${JSON.stringify(new TriggerInfo('Price moves percentage of active range away', expectedDataTypesHelper(strategyDataTypes, 'Price moves percentage of active range away')))}
         }
       }
     },
@@ -418,12 +399,6 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
             "description": "The percentage of the range away to trigger new positions, 100% or 1 would be at the bounds of the range",
             "detailedDescription": "If you have a simple position ranging from ticks 0 - 100, and you set this value to 1, the trigger range will be the outer bounds. Using 0.5 would make the trigger range 25-75, 2 would make the range -50 - 150."
         },
-        "expectedDataTypes": {
-          "const": ${getExpectedDataTypes(strategyDataConnectors, "Price moves percentage of active range away")},
-          "default": ${getExpectedDataTypes(strategyDataConnectors, "Price moves percentage of active range away")},
-          "hidden": true,
-          "type": "string"
-        },
         "elapsedTendTime": {
           "type": "number",
           "title": "Max time between tends",
@@ -431,14 +406,14 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
           "default": 1209600
         }
       },
-      "required": ["percentageOfPositionRangeToTrigger", "expectedDataTypes", "elapsedTendTime"]
+      "required": ["percentageOfPositionRangeToTrigger", "elapsedTendTime"]
     }
   },
   {
     "if": {
       "properties": {
         "triggerStyle": {
-          "const": "Price moves one way past positions"
+          "const": ${JSON.stringify(new TriggerInfo('Price moves one way past positions', expectedDataTypesHelper(strategyDataTypes, 'Price moves one way past positions')))}
         }
       }
     },
@@ -450,12 +425,6 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
             "description": "True for if the strategy should set new positions when the price (tick) is higher than the current positions, false for lower",
             "detailedDescription": "If our current position ranges from ticks 0 - 100, true will make our bundle execute only when the current tick is higher. Any other case (current tick less than 100) will result in a continue recommendation."
         },
-        "expectedDataTypes": {
-          "const": ${getExpectedDataTypes(strategyDataConnectors, "Price moves one way past positions")},
-          "default": ${getExpectedDataTypes(strategyDataConnectors, "Price moves one way past positions")},
-          "hidden": true,
-          "type": "string"
-        },
         "elapsedTendTime": {
           "type": "number",
           "title": "Max time between tends",
@@ -463,7 +432,7 @@ export function triggerPropertyHelper(omit: TriggerStyle[] = []): string {
           "default": 1209600
         }
       },
-      "required": ["triggerWhenOver", "expectedDataTypes", "elapsedTendTime"]
+      "required": ["triggerWhenOver", "elapsedTendTime"]
     }
   }`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steerprotocol/strategy-utils",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "Strategy utilities library for Steer Protocol strategies",
   "main": "assembly/index.ts",
   "types": "assembly/index.ts",