otomato-sdk 1.2.1 → 1.3.0

package/src/constants/Blocks.ts

@@ -9,11 +9,12 @@ const TRIGGER_TYPE = {
 export const TRIGGERS = {
   "TOKENS": {
     "ERC20": {
-      "CHAINS": [
+      "description": "The most used standard for tokens on ethereum compatible blockchains",
+      "chains": [
         0
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp",
       "TRANSFER": {
-        "id": 1,
         "name": "Transfer token",
         "description": "This block gets triggered when someone transfers the ERC20 configured in the params",
         "type": 0,
@@ -45,10 +46,11 @@ export const TRIGGERS = {
             "description": "The contract address of the ERC20",
             "mandatory": true
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 1,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
       },
       "BALANCE": {
-        "id": 5,
         "name": "ERC20 balance check",
         "description": "Fetches the balance of an ERC20 and checks it against the specified condition.",
         "type": 1,
@@ -85,17 +87,20 @@ export const TRIGGERS = {
             "type": "integer",
             "description": "The waiting time between each polling"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 5,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
       }
     }
   },
   "YIELD": {
     "SPLICE_FI": {
-      "CHAINS": [
+      "description": "Split any yield-bearing asset into separate yield and principal components",
+      "chains": [
         43334
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png",
       "SWAP": {
-        "id": 2,
         "name": "Splice Finance Swap",
         "description": "Swap in Splice Finance",
         "type": 0,
@@ -126,10 +131,11 @@ export const TRIGGERS = {
             "type": "int256",
             "description": "Net SY to account"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 2,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png"
       },
       "LIQUIDITY_REMOVED": {
-        "id": 6,
         "name": "Liquidity Removed",
         "description": "Liquidity removed in Splice Finance",
         "type": 0,
@@ -165,10 +171,11 @@ export const TRIGGERS = {
             "type": "uint256",
             "description": "Net SY out"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 6,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png"
       },
       "MARKET_CREATION": {
-        "id": 7,
         "name": "Market Creation",
         "description": "Market creation in Splice Finance",
         "type": 0,
@@ -199,10 +206,11 @@ export const TRIGGERS = {
             "type": "uint256",
             "description": "LN fee rate root"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 7,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png"
       },
       "INTEREST_RATE_UPDATE": {
-        "id": 9,
         "name": "Interest Rate Update",
         "description": "Interest rate update in Splice Finance",
         "type": 0,
@@ -230,17 +238,20 @@ export const TRIGGERS = {
               "0xbF14932e1A7962C77D0b31be80075936bE1A43D4"
             ]
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 9,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png"
       }
     }
   },
   "LENDING": {
     "ASTARIA": {
-      "CHAINS": [
+      "description": "Astaria is an oracle-less, intent-based, fixed-rate lending protocol supporting unlimited loan durations for any asset",
+      "chains": [
         43334
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/astaria.png",
       "LEND_RECALLED": {
-        "id": 8,
         "name": "Lend Recalled",
         "description": "Lend recalled in Astaria",
         "type": 0,
@@ -261,18 +272,21 @@ export const TRIGGERS = {
             "type": "uint256",
             "description": "End time"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 8,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/astaria.png"
       }
     }
   },
   "DEXES": {
     "ODOS": {
-      "CHAINS": [
+      "description": "Smart Order Routing across multiple blockchain protocols, 700+ Liquidity Sources and thousands of token pairs, delivering ultimate savings to users",
+      "chains": [
         43334,
         1
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/odos.jpg",
       "SWAP": {
-        "id": 4,
         "name": "Odos Swap",
         "description": "Swap on Odos",
         "type": 0,
@@ -309,17 +323,20 @@ export const TRIGGERS = {
             "type": "address",
             "description": "Output token address"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 4,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/odos.jpg"
       }
     }
   },
   "SOCIALS": {
     "MODE_NAME_SERVICE": {
-      "CHAINS": [
+      "description": "Next generation of Mode Mainnet Domains",
+      "chains": [
         43334
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/modens.png",
       "NAME_REGISTERED": {
-        "id": 3,
         "name": "Name Registered",
         "description": "Name registered in Mode Name Service",
         "type": 0,
@@ -340,17 +357,20 @@ export const TRIGGERS = {
             "type": "uint256",
             "description": "Expiration time"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 3,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/modens.png"
       }
     }
   },
   "PRICE_ACTION": {
     "ON_CHAIN_PRICE_MOVEMENT": {
-      "CHAINS": [
+      "description": "Triggers based on the movement of on-chain prices against specified currencies",
+      "chains": [
         0
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/trend-up.png",
       "PRICE_MOVEMENT_AGAINST_CURRENCY": {
-        "id": 10,
         "name": "On-Chain Price Movement Against Fiat Currency",
         "description": "This trigger activates when the on-chain price of an asset moves against a specified currency based on the given condition.",
         "type": 2,
@@ -383,7 +403,9 @@ export const TRIGGERS = {
             "type": "erc20",
             "description": "The asset that you want to track"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 10,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/trend-up.png"
       }
     }
   }
@@ -392,8 +414,9 @@ export const TRIGGERS = {
 export const ACTIONS = {
   "NOTIFICATIONS": {
     "SLACK": {
+      "description": "Slack is a messaging app for businesses that connects people to the information they need.",
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/slack.png",
       "SEND_MESSAGE": {
-        "id": 100002,
         "name": "Send message",
         "type": 0,
         "description": "Notifies you by sending a Slack message to the channel of your choice",
@@ -408,12 +431,15 @@ export const ACTIONS = {
             "type": "paragraph",
             "description": "The text content to send"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 100002,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/slack.png"
       }
     },
     "DISCORD": {
+      "description": "Discord is a communication service to talk with your favorite communities.",
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/discord.png",
       "SEND_MESSAGE": {
-        "id": 100003,
         "name": "Send message",
         "type": 0,
         "description": "Notifies you by sending a Discord message to the channel of your choice",
@@ -428,12 +454,15 @@ export const ACTIONS = {
             "type": "paragraph",
             "description": "The text content to send"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 100003,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/discord.png"
       }
     },
     "TELEGRAM": {
+      "description": "Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.",
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/telegram.jpeg",
       "SEND_MESSAGE": {
-        "id": 100001,
         "name": "Send message",
         "type": 0,
         "description": "Notifies you by sending a Telegram message to the chat of your choice",
@@ -448,17 +477,20 @@ export const ACTIONS = {
             "type": "paragraph",
             "description": "The text content to send"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 100001,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/telegram.jpeg"
       }
     }
   },
   "TOKENS": {
     "ERC20": {
-      "CHAINS": [
+      "description": "The most used standard for tokens on ethereum compatible blockchains",
+      "chains": [
         0
       ],
+      "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp",
       "TRANSFER": {
-        "id": 100004,
         "name": "Transfer token",
         "description": "Transfers an ERC20 token",
         "type": 1,
@@ -484,7 +516,9 @@ export const ACTIONS = {
             "type": "erc20",
             "description": "The contract address of the ERC20"
           },
-        ] as Parameter[]
+        ] as Parameter[],
+        "blockId": 100004,
+        "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
       }
     }
   }

package/src/index.ts

@@ -5,7 +5,7 @@ export * from './constants/tokens.js';
 
 // Exporting models
 export * from './models/Action.js';
-export * from './models/Automation.js';
+export * from './models/Workflow.js';
 export * from './models/Condition.js';
 export * from './models/Parameter.js';
 export * from './models/Trigger.js';

package/src/models/Action.ts

@@ -2,7 +2,7 @@ import { Parameter } from './Parameter.js';
 import { Node, Position } from './Node.js';
 
 export class Action extends Node {
-  constructor(action: { id: number; name: string; description: string; parameters: Parameter[], ref?: string, position?: Position }) {
+  constructor(action: { blockId: number; name: string; description: string; parameters: Parameter[], image: string, ref?: string, position?: Position }) {
     super({ ...action, class: 'action' });
   }
 }

package/src/models/Condition.ts

@@ -1,6 +1,6 @@
 export interface COndition {
-    key: string;
-    type: string;
-    description: string;
-    value: any;
-  }
+  key: string;
+  type: string;
+  description: string;
+  value: any;
+}

package/src/models/Edge.ts

@@ -25,9 +25,15 @@ export class Edge {
 
     toJSON(): { [key: string]: any } {
         return {
-            id: this.id,
             source: this.source.getRef(),
             target: this.target.getRef(),
         };
     }
-}
+
+    static fromJSON(json: { [key: string]: any }): Edge {
+        return new Edge({
+            source: json.source,
+            target: json.target,
+        });
+    }
+}

package/src/models/Node.ts

@@ -1,5 +1,8 @@
+// Assuming you have the ACTIONS constant defined as you provided
+
 import { Parameter } from './Parameter.js';
 import { validateType } from '../utils/typeValidator.js';
+import { ACTIONS, TRIGGERS } from '../constants/Blocks.js';
 
 export interface Position {
   x: number;
@@ -10,23 +13,27 @@ let nodeCounter = 0;
 const generatedRefs = new Set<string>();
 
 export class Node {
-  id: number;
+  id: string | null = null;
+  blockId: number;
   name: string;
   description: string;
   parameters: { [key: string]: Parameter };
   keyMap: { [key: string]: string };
   position?: Position;
   ref: string;
-  class: string;  // Updated to use class instead of type
+  class: string;
+  image: string;
 
-  constructor(node: { id: number; name: string; description: string; parameters: Parameter[], ref?: string, position?: Position, class: string }) {
-    this.id = node.id;
+  constructor(node: { blockId: number; name: string; description: string; parameters: Parameter[], ref?: string, position?: Position, class: string; image: string }) {
+    this.id = null;
+    this.blockId = node.blockId;
     this.name = node.name;
     this.description = node.description;
+    this.image = node.image;
     this.parameters = {};
     this.keyMap = {};
-    this.class = node.class;  // Set class property
-
+    this.class = node.class;
+    
     if (node.ref) {
       this.ref = node.ref;
     } else {
@@ -48,6 +55,10 @@ export class Node {
     }
   }
 
+  setId(id: string): void {
+    this.id = id;
+  }
+
   setChainId(value: number): void {
     this.setParameter('chainId', value);
   }
@@ -109,6 +120,7 @@ export class Node {
     const json: { [key: string]: any } = {
       id: this.id,
       ref: this.ref,
+      blockId: this.blockId,
       type: this.class,
       parameters: this.getParameters(),
     };
@@ -121,4 +133,66 @@ export class Node {
   private getSimplifiedKey(key: string): string {
     return key.replace(/[.\[\]]/g, '_');
   }
+
+  static fromJSON(json: { [key: string]: any }): Node {
+
+    let enriched = findActionByBlockId(json.blockId);
+    if (!enriched) 
+      enriched = findTriggerByBlockId(json.blockId);
+    if (!enriched)
+      enriched = {name: "Unknown", description: "Unknown", image: "Unknown"}
+
+    const parameters = Object.keys(json.parameters).map(key => ({
+      key,
+      type: typeof json.parameters[key], // Assuming type can be derived from the value's type
+      description: '', // Add appropriate description if needed
+      value: json.parameters[key]
+    }));
+    const node = new Node({
+      blockId: json.blockId,
+      name: enriched.name,
+      description: enriched.description,
+      image: enriched.image,
+      parameters,
+      ref: json.ref,
+      position: json.position,
+      class: json.type
+    });
+    node.setId(json.id);
+    return node;
+  }
 }
+
+const findActionByBlockId = (blockId: number): { name: string; description: string; image: string } | null => {
+  for (const category in ACTIONS) {
+    for (const service in (ACTIONS as any)[category]) {
+      for (const actionKey in (ACTIONS as any)[category][service]) {
+        if ((ACTIONS as any)[category][service][actionKey].blockId === blockId) {
+          return {
+            name: (ACTIONS as any)[category][service][actionKey].name,
+            description: (ACTIONS as any)[category][service][actionKey].description,
+            image: (ACTIONS as any)[category][service][actionKey].image,
+          };
+        }
+      }
+    }
+  }
+  return null;
+};
+
+const findTriggerByBlockId = (blockId: number): { name: string; description: string; image: string } | null => {
+  for (const category in TRIGGERS) {
+    for (const service in (TRIGGERS as any)[category]) {
+      for (const triggerKey in (TRIGGERS as any)[category][service]) {
+        if ((TRIGGERS as any)[category][service][triggerKey].blockId === blockId) {
+          return {
+            name: (TRIGGERS as any)[category][service][triggerKey].name,
+            description: (TRIGGERS as any)[category][service][triggerKey].description,
+            image: (TRIGGERS as any)[category][service][triggerKey].image,
+          };
+        }
+      }
+    }
+  }
+  return null;
+};

package/src/models/Parameter.ts

@@ -1,6 +1,6 @@
 export interface Parameter {
-    key: string;
-    type: string;
-    description: string;
-    value?: any;
-  }
+  key: string;
+  type: string;
+  description: string;
+  value?: any;
+}

package/src/models/Trigger.ts

@@ -4,7 +4,7 @@ import { Node, Position } from './Node.js';
 export class Trigger extends Node {
   type: number;
 
-  constructor(trigger: { id: number; name: string; description: string; type: number; parameters: Parameter[], ref?: string, position?: Position }) {
+  constructor(trigger: { blockId: number; name: string; description: string; type: number; parameters: Parameter[], image: string, ref?: string, position?: Position }) {
     super({ ...trigger, class: 'trigger' });
     this.type = trigger.type;
   }

package/src/models/Workflow.ts

@@ -0,0 +1,69 @@
+import { Node } from './Node.js';
+import { Edge } from './Edge.js';
+import { apiServices } from '../services/ApiService.js';
+
+export class Workflow {
+  id: string | null = null;
+  name: string;
+  nodes: Node[];
+  edges: Edge[];
+
+  constructor(name: string = '', nodes: Node[] = [], edges: Edge[] = []) {
+    this.name = name;
+    this.nodes = nodes;
+    this.edges = edges;
+  }
+
+  setName(name: string): void {
+    this.name = name;
+  }
+
+  addNode(node: Node): void {
+    this.nodes.push(node);
+  }
+
+  addNodes(nodes: Node[]): void {
+    this.nodes.push(...nodes);
+  }
+
+  addEdge(edge: Edge): void {
+    this.edges.push(edge);
+  }
+
+  addEdges(edges: Edge[]): void {
+    this.edges.push(...edges);
+  }
+
+  toJSON() {
+    return {
+      id: this.id,
+      name: this.name,
+      nodes: this.nodes.map(node => node.toJSON()),
+      edges: this.edges.map(edge => edge.toJSON()),
+    };
+  }
+
+  async create() {
+    const response = await apiServices.post('/workflows', this.toJSON());
+    this.id = response.id; // Assign the returned ID to the workflow instance
+
+    // Assign IDs to the nodes based on the response
+    response.nodes.forEach((nodeResponse: any) => {
+      const node = this.nodes.find(n => n.getRef() === nodeResponse.ref);
+      if (node) {
+        node.setId(nodeResponse.id);
+      }
+    });
+
+    return response;
+  }
+
+  async load(workflowId: string): Promise<Workflow> {
+    const response = await apiServices.get(`/workflows/${workflowId}`);
+    this.id = response.id;
+    this.name = response.name;
+    this.nodes = response.nodes.map((nodeData: any) => Node.fromJSON(nodeData));
+    this.edges = response.edges.map((edgeData: any) => Edge.fromJSON(edgeData));
+    return this;
+  }
+}

package/src/services/ApiService.ts

@@ -2,30 +2,37 @@
 import axios from 'axios';
 
 const API_CONFIG = {
-  BASE_URL: 'http://localhost:3040/api',
+  BASE_URL: 'https://staging-api.otomato.xyz/api',
   HEADERS: {
-    'Content-Type': 'application/json'
+    'Content-Type': 'application/json',
   }
-}
+};
 
 const axiosInstance = axios.create({
   baseURL: API_CONFIG.BASE_URL,
   headers: API_CONFIG.HEADERS
 });
 
-export const apiServices = {
-  async post(endpoint: string, data: any) {
-    try {
-      const response = await axiosInstance.post(endpoint, data);
-      return response.data;
-    } catch (error) {
-      console.error('Network request failed', error);
-      throw error;
-    }
-  },
-
-  // Add other HTTP methods if needed
-  // async get(endpoint: string) { ... }
-  // async put(endpoint: string, data: any) { ... }
-  // async delete(endpoint: string) { ... }
-};
+class ApiServices {
+  private cookie: string | null = null;
+
+  setCookie(cookie: string) {
+    this.cookie = `token=${cookie}`;
+  }
+
+  async post(url: string, data: any) {
+    const headers = this.cookie ? { 'Cookie': this.cookie } : {};
+    const response = await axiosInstance.post(url, data, { headers });
+    return response.data;
+  }
+
+  async get(url: string) {
+    const headers = this.cookie ? { 'Cookie': this.cookie } : {};
+    const response = await axiosInstance.get(url, { headers });
+    return response.data;
+  }
+
+  // You can add other methods (get, put, delete) similarly
+}
+
+export const apiServices = new ApiServices();

package/test/action.spec.ts

@@ -38,7 +38,7 @@ describe('Action Class', () => {
 
     const json = transferAction.toJSON();
     expect(json).to.deep.equal({
-      id: ACTIONS.TOKENS.ERC20.TRANSFER.id,
+      blockId: ACTIONS.TOKENS.ERC20.TRANSFER.blockId,
       ref: transferAction.getRef(),
       type: 'action',
       parameters: {