ReadMe

Author: MustafaBrandon

README.md

@@ -3,9 +3,11 @@ AssemblyScript based Strategy Template for the Steer Protocol.
 
 Start building on [Steer Protocol](https://steer.finance) with our AssemblyScript template. Expand your smart contract capabilities with off-chain compute! More info can be found here: [Documentation](https://docs.steer.finance/steer-apps/writing-an-app)
 
-## Tip!
+This is a template example of how to make a liquidity provision strategy that acts similarly to a stop loss. The strategist picks a percent and recent candles are passed into the strategy. From the recent price, a position is made with the upper tick set to the current price, and the lower tick at the precent down from the current price, like a stop loss. This would likely not be a great strategy for most assets/situations, be smart if you want to use this strategy.
 
-[Use our one-click in-browser development environment](https://bit.ly/3BsQ3DT)
+## Parameters
+
+This strategy only accepts one parameter from the data connectors: any OHLC type object.
 
 ## Project Structure
 Apps have three external functions that are used by the Steer system. Additional methods, classes, or varaibles can be used in conjunction with these required functions for any desired behavior. For more information please see the app interface. This design means, that as a developer, you only need to implement the methods which are required for the app to work.
@@ -23,12 +25,23 @@ Below are the significant files and folders which you will want to get familiar
 ```
 
 ## Project Setup
-Once the template has been cloned, you will need to install the project dependencies. This can be done via the following command:
+Once the repository has been cloned, you will need to install the project dependencies. This can be done via the following command:
 
 ```yarn install```
 
 INFO
 You will notice that there is a post-install script which will compile the ./assembly source folder and populate the ./build folder. This is done to make it easier to run the tests. We will cover this later.
 
-Once you have set up your project, you can begin defining your app.
+After making chenges to the assemblyscript code, compile and build the wasm files with the command:
+
+```yarn asbuild```
+
+You will find a number of webassembly related files in the ./build folder.
+
+The testing suite can be found the ./tests source folder, unit tests are written in index.test.ts and can be configured there.
+
+To run the testing suite, run:
+
+```yarn test```
 
+For more in depth testing of the strategy and performance try using Steer's backtesting toolkit to simulate realistic conditions.

tests/index.test.ts

@@ -1,34 +1,7 @@
-import { config, prices, config_payload, prices2 } from "./utils";
+import { config, config_payload, prices2 } from "./utils";
 import fs from 'fs';
 import { WasmModule, loadWasm } from "@steerprotocol/app-loader";
 
-// We use untouched so that we can run the un-optimized version of the wasm which will provide better stacktraces
-// const myModule = require("../untouchLoader");
-
-interface DataModel {
-  open: number;
-  high: number;
-  close: number;
-  low: number;
-}
-
-// function generateRandomData(amount: number): DataModel[] {
-//   const data: DataModel[] = [];
-
-//   for (let i = 0; i < amount; i++) {
-//     const open = Math.random() * 1000
-//     const high = Math.random() * 1000
-//     const close = Math.random() * 1000
-//     const low = Math.random() * 1000
-
-//     data.push({ open, high, close, low });
-//   }
-
-//   return data;
-// }
-
-
-
 describe("WASM Module", () => {
   let myModule: WasmModule;
 
@@ -41,29 +14,17 @@ describe("WASM Module", () => {
       const result = myModule.config();
       // Pull the result from memory and parse the result
       const parsedResult = JSON.parse(result);
-
       // The result should match the given config
       expect(parsedResult).toStrictEqual(JSON.parse(config));
     });
 
     test("can run execute", async () => {
-
-
-        
       // The actual strategy instantiation and execution
       myModule.initialize(config_payload);
-      // Here we pin the array to the WASM memory
-      // let priceMemoryRef = myModule.__pin(
-      //   myModule.__newString(JSON.stringify(prices))
-      // );
-
       // Call the config function on the strategy bundle
       const result = myModule["execute(param_1: string)"](JSON.stringify(prices2));
-
-      // console.log(result)
       // Pull the result from memory and parse the result
       const parsedResult = JSON.parse(result);
-
       // The result should match the given config
       expect(JSON.stringify(parsedResult)).toStrictEqual(
         `{\"functionName\":\"tend(uint256,(int24[],int24[],uint16[]),bytes)\",\"typesArray\":[\"uint256\",\"tuple(int24[],int24[],uint16[])\",\"bytes\"],\"valuesArray\":[10000,[[492120],[492720],[100]],\"0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff000000000000000000000000ffffffffffffffffffffffffffffffffffffffff\"]}`
@@ -72,4 +33,3 @@ describe("WASM Module", () => {
   });
 });
 
-// `{"bins":[{"lowerBound":"-276330","upperBound":"-276320","weight":"1"}]}`