otomato-sdk 1.0.1 → 1.2.0

package/dist/types/src/constants/Blocks.d.ts

@@ -0,0 +1,118 @@
+import { Parameter } from '../models/Parameter.js';
+export declare const TRIGGERS: {
+    TOKENS: {
+        ERC20: {
+            CHAINS: number[];
+            TRANSFER: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+            BALANCE: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+        };
+    };
+    YIELD: {
+        SPLICE_FI: {
+            CHAINS: number[];
+            SWAP: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+            LIQUIDITY_REMOVED: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+            MARKET_CREATION: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+            INTEREST_RATE_UPDATE: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+        };
+    };
+    LENDING: {
+        ASTARIA: {
+            CHAINS: number[];
+            LEND_RECALLED: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+        };
+    };
+    DEXES: {
+        ODOS: {
+            CHAINS: number[];
+            SWAP: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+        };
+    };
+    SOCIALS: {
+        MODE_NAME_SERVICE: {
+            CHAINS: number[];
+            NAME_REGISTERED: {
+                id: number;
+                name: string;
+                description: string;
+                type: number;
+                parameters: Parameter[];
+            };
+        };
+    };
+};
+export declare const ACTIONS: {
+    TOKENS: {
+        ERC20: {
+            CHAINS: number[];
+            TRANSFER: {
+                id: number;
+                name: string;
+                description: string;
+                parameters: Parameter[];
+            };
+        };
+    };
+    NOTIFICATIONS: {
+        SMS: {
+            id: number;
+            name: string;
+            description: string;
+            parameters: Parameter[];
+        };
+        SLACK: {
+            id: number;
+            name: string;
+            description: string;
+            parameters: Parameter[];
+        };
+    };
+};

package/dist/types/src/constants/tokens.d.ts

@@ -8,4 +8,13 @@ export interface Tokens {
     [key: number]: Token[];
 }
 export declare const TOKENS: Tokens;
+export interface NFT {
+    contractAddress: string;
+    name: string;
+}
+export interface NFTs {
+    [key: number]: NFT[];
+}
+export declare const NFTS: NFTs;
 export declare function getToken(chain: number, symbol: string): Token;
+export declare function getNFT(chain: number, name: string): NFT;

package/dist/types/src/index.d.ts

@@ -1,4 +1,4 @@
-export * from './constants/ActionBlocks.js';
+export * from './constants/Blocks.js';
 export * from './constants/chains.js';
 export * from './constants/tokens.js';
 export * from './models/Action.js';
@@ -6,5 +6,6 @@ export * from './models/Automation.js';
 export * from './models/Condition.js';
 export * from './models/Parameter.js';
 export * from './models/Trigger.js';
+export * from './models/Node.js';
+export * from './models/Edge.js';
 export * from './services/ApiService.js';
-export * from './services/AutomationService.js';

package/dist/types/src/models/Action.d.ts

@@ -1,6 +1,12 @@
-export interface Action {
-    key: string;
-    type: string;
-    description: string;
-    value: any;
+import { Parameter } from './Parameter.js';
+import { Node, Position } from './Node.js';
+export declare class Action extends Node {
+    constructor(action: {
+        id: number;
+        name: string;
+        description: string;
+        parameters: Parameter[];
+        ref?: string;
+        position?: Position;
+    });
 }

package/dist/types/src/models/Automation.d.ts

@@ -1,6 +1,23 @@
-export interface Automation {
-    key: string;
-    type: string;
-    description: string;
-    value: any;
+import { Node } from './Node.js';
+import { Edge } from './Edge.js';
+export declare class Automation {
+    name: string;
+    nodes: Node[];
+    edges: Edge[];
+    constructor(name: string, nodes?: Node[], edges?: Edge[]);
+    setName(name: string): void;
+    addNode(node: Node): void;
+    addNodes(nodes: Node[]): void;
+    addEdge(edge: Edge): void;
+    addEdges(edges: Edge[]): void;
+    toJSON(): {
+        name: string;
+        nodes: {
+            [key: string]: any;
+        }[];
+        edges: {
+            [key: string]: any;
+        }[];
+    };
+    save(): Promise<any>;
 }

package/dist/types/src/models/Edge.d.ts

@@ -0,0 +1,14 @@
+import { Node } from './Node.js';
+export declare class Edge {
+    id: string;
+    source: Node;
+    target: Node;
+    constructor(edge: {
+        id?: string;
+        source: Node;
+        target: Node;
+    });
+    toJSON(): {
+        [key: string]: any;
+    };
+}

package/dist/types/src/models/Node.d.ts

@@ -0,0 +1,42 @@
+import { Parameter } from './Parameter.js';
+export interface Position {
+    x: number;
+    y: number;
+}
+export declare class Node {
+    id: number;
+    name: string;
+    description: string;
+    parameters: {
+        [key: string]: Parameter;
+    };
+    keyMap: {
+        [key: string]: string;
+    };
+    position?: Position;
+    ref: string;
+    class: string;
+    constructor(node: {
+        id: number;
+        name: string;
+        description: string;
+        parameters: Parameter[];
+        ref?: string;
+        position?: Position;
+        class: string;
+    });
+    setChainId(value: number): void;
+    setContractAddress(value: string): void;
+    setParams(key: string, value: any): void;
+    setPosition(x: number, y: number): void;
+    getRef(): string;
+    protected setParameter(key: string, value: any): void;
+    getParameter(key: string): any;
+    getParameters(): {
+        [key: string]: any;
+    };
+    toJSON(): {
+        [key: string]: any;
+    };
+    private getSimplifiedKey;
+}

package/dist/types/src/models/Trigger.d.ts

@@ -1,37 +1,17 @@
 import { Parameter } from './Parameter.js';
-export declare class Trigger {
-    id: number;
-    name: string;
-    description: string;
+import { Node, Position } from './Node.js';
+export declare class Trigger extends Node {
     type: number;
-    parameters: {
-        [key: string]: Parameter;
-    };
-    keyMap: {
-        [key: string]: string;
-    };
     constructor(trigger: {
         id: number;
         name: string;
         description: string;
         type: number;
         parameters: Parameter[];
+        ref?: string;
+        position?: Position;
     });
-    setChainId(value: number): void;
-    setContractAddress(value: string): void;
     setCondition(value: string): void;
     setComparisonValue(value: number): void;
     setInterval(value: number): void;
-    setParams(key: string, value: any): void;
-    private setParameter;
-    private validateType;
-    private isAddress;
-    getParameter(key: string): any;
-    getParameters(): {
-        [key: string]: any;
-    };
-    toJSON(): {
-        [key: string]: any;
-    };
-    private getSimplifiedKey;
 }

package/dist/types/src/services/ApiService.d.ts

@@ -1,6 +1,3 @@
-export interface APISERVICES {
-    key: string;
-    type: string;
-    description: string;
-    value: any;
-}
+export declare const apiServices: {
+    post(endpoint: string, data: any): Promise<any>;
+};

package/dist/types/src/utils/typeValidator.d.ts

@@ -0,0 +1,4 @@
+export declare function validateType(expectedType: string, value: any): boolean;
+export declare function isAddress(value: string): boolean;
+export declare function isValidUrl(value: string): boolean;
+export declare function isValidPhoneNumber(value: string): boolean;

package/dist/types/test/action.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/automation.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/node.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/typeValidator.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/create-action.ts

@@ -0,0 +1,28 @@
+import { ACTIONS, getToken, CHAINS, Action } from '../src/index.js';
+
+const createAction = () => {
+  // Create an ERC20 transfer action
+  const transferAction = new Action(ACTIONS.TOKENS.ERC20.TRANSFER);
+  transferAction.setChainId(CHAINS.ETHEREUM);
+  transferAction.setParams("value", 1000);
+  transferAction.setParams("to", "0xe1432599B51d9BE1b5A27E2A2FB8e5dF684749C6");
+  transferAction.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
+
+  console.log(transferAction.toJSON());
+
+  // Create an SMS notification action
+  const smsAction = new Action(ACTIONS.NOTIFICATIONS.SMS);
+  smsAction.setParams("phoneNumber", "+1234567890");
+  smsAction.setParams("text", "This is a test message");
+
+  console.log(smsAction.toJSON());
+
+  // Create a Slack notification action
+  const slackAction = new Action(ACTIONS.NOTIFICATIONS.SLACK);
+  slackAction.setParams("webhook", "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX");
+  slackAction.setParams("text", "This is a test message");
+
+  console.log(slackAction.toJSON());
+};
+
+createAction();

package/examples/create-automation.ts

@@ -0,0 +1,41 @@
+import { ACTIONS, Action, TRIGGERS, Trigger, Automation, CHAINS, getToken, Edge } from '../src/index.js';
+
+const main = async () => {
+    const usdcTransferTrigger = new Trigger({
+        id: TRIGGERS.TOKENS.ERC20.TRANSFER.id,
+        name: TRIGGERS.TOKENS.ERC20.TRANSFER.name,
+        description: TRIGGERS.TOKENS.ERC20.TRANSFER.description,
+        type: TRIGGERS.TOKENS.ERC20.TRANSFER.type,
+        parameters: TRIGGERS.TOKENS.ERC20.TRANSFER.parameters,
+        ref: 'n-1',
+    });
+    usdcTransferTrigger.setChainId(CHAINS.ETHEREUM);
+    usdcTransferTrigger.setContractAddress(getToken(CHAINS.ETHEREUM, 'USDC').contractAddress);
+    usdcTransferTrigger.setPosition(0, 0);
+
+    const slackAction = new Action({
+        id: ACTIONS.NOTIFICATIONS.SLACK.id,
+        name: ACTIONS.NOTIFICATIONS.SLACK.name,
+        description: ACTIONS.NOTIFICATIONS.SLACK.description,
+        parameters: ACTIONS.NOTIFICATIONS.SLACK.parameters,
+        // not forced to provide a ref id, it will generate it
+    });
+    slackAction.setParams("webhook", "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX");
+    slackAction.setParams("text", "USDC has been transferred!");
+    slackAction.setPosition(0, -10);
+
+    const automation = new Automation("USDC Transfer Notification", [usdcTransferTrigger, slackAction]);
+
+    const edge = new Edge({
+        source: usdcTransferTrigger,
+        target: slackAction,
+    });
+
+    automation.addEdge(edge);
+
+    console.log(JSON.stringify(automation.toJSON(), null, 2));
+
+    //await automation.save();
+}
+
+main();

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "otomato-sdk",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "An SDK for building and managing automations on Otomato",
   "main": "dist/src/index.js",
   "types": "dist/types/src/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "npx tsc",
-    "test": "mocha --config .mocharc.json"
+    "test": "mocha --config .mocharc.json",
+    "publish": "npm publish"
   },
   "keywords": [
     "sdk",
@@ -34,4 +35,4 @@
     "axios": "^1.7.2",
     "ethers": "^6.13.0"
   }
-}
+}

package/src/constants/{ActionBlocks.ts → Blocks.ts}

@@ -18,7 +18,7 @@ export const TRIGGERS = {
         parameters: [
           {
             key: "chainId",
-            type: "int",
+            type: "chainId",
             description: "Chain ID of the ETH blockchain"
           },
           {
@@ -46,7 +46,7 @@ export const TRIGGERS = {
         parameters: [
           {
             key: "chainId",
-            type: "int",
+            type: "chainId",
             description: "Chain ID of the ETH blockchain"
           },
           {
@@ -322,3 +322,74 @@ export const TRIGGERS = {
     }
   }
 };
+
+export const ACTIONS = {
+  TOKENS: {
+    ERC20: {
+      CHAINS: [CHAINS.ALL],
+      TRANSFER: {
+        id: 1,
+        name: "Transfer ERC-20 Token",
+        description: "Transfer an ERC-20 token",
+        parameters: [
+          {
+            key: "chainId",
+            type: "chainId",
+            description: "Chain ID of the blockchain"
+          },
+          {
+            key: "abiParams.value",
+            type: "uint256",
+            description: "Amount of crypto to transfer"
+          },
+          {
+            key: "abiParams.to",
+            type: "address",
+            description: "Address to transfer crypto to"
+          },
+          {
+            key: "contractAddress",
+            type: "address",
+            description: "The contract address of the ERC-20 token"
+          }
+        ] as Parameter[]
+      },
+    },
+  },
+  NOTIFICATIONS: {
+    SMS: {
+      id: 3,
+      name: "Send SMS",
+      description: "Send an SMS notification to a specified phone number",
+      parameters: [
+        {
+          key: "phoneNumber",
+          type: "phone_number",
+          description: "Phone number to send the message to"
+        },
+        {
+          key: "text",
+          type: "paragraph",
+          description: "Content of the SMS message"
+        },
+      ] as Parameter[]
+    },
+    SLACK: {
+      id: 4,
+      name: "Send Slack Message",
+      description: "Send a message to a specified Slack channel via webhook",
+      parameters: [
+        {
+          key: "webhook",
+          type: "url",
+          description: "Slack channel webhook URL"
+        },
+        {
+          key: "text",
+          type: "paragraph",
+          description: "Content of the Slack message"
+        },
+      ] as Parameter[]
+    },
+  }
+};

package/src/constants/chains.ts

@@ -2,4 +2,4 @@ export const CHAINS = {
   ALL: 0,
   ETHEREUM: 1,
   MODE: 43334,
-};  
+};

package/src/constants/json.json

@@ -0,0 +1,16 @@
+{
+    "id": 1,
+    "refId": "n-1",
+    "data": {
+        "parameters": {
+            "chainId": 1,
+            "abiParams.value": null,
+            "abiParams.to": null,
+            "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
+        },
+    },
+    "position": {
+        "x": 0,
+        "y": 0
+    }
+}

package/src/constants/tokens.ts

@@ -82,6 +82,48 @@ export const TOKENS: Tokens = {
   ]
 };
 
+export interface NFT {
+  contractAddress: string;
+  name: string;
+}
+
+export interface NFTs {
+  [key: number]: NFT[];
+}
+
+export const NFTS: NFTs = {
+  1: [
+    {
+      contractAddress: "0x60e4d786628fea6478f785a6d7e704777c86a7c6",
+      name: "MutantApeYachtClub"
+    },
+    {
+      contractAddress: "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
+      name: "BoredApeYachtClub"
+    },
+    
+    {
+      contractAddress: "0xbd3531da5cf5857e7cfaa92426877b022e612cf8",
+      name: "Pudgy Penguins"
+    },
+    {
+      contractAddress: "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e",
+      name: "Doodles"
+    },
+    {
+      contractAddress: "0x524cab2ec69124574082676e6f654a18df49a048",
+      name: "Lil Pudgies"
+    },
+
+  ],
+  43334: [
+    {
+      contractAddress: "0x2ad86eeec513ac16804bb05310214c3fd496835b",
+      name: "Space id"
+    }
+  ]
+};
+
 export function getToken(chain: number, symbol: string): Token {
   if (!(chain in TOKENS)) {
     throw new Error(`Unsupported chain: ${chain}`);
@@ -95,3 +137,17 @@ export function getToken(chain: number, symbol: string): Token {
 
   return token;
 }
+
+export function getNFT(chain: number, name: string): NFT {
+  if (!(chain in NFTS)) {
+    throw new Error(`Unsupported chain: ${chain}`);
+  }
+
+  const nft = NFTS[chain].find(nft => nft.name === name);
+
+  if (!nft) {
+    throw new Error(`NFT ${name} not found on chain ${chain}`);
+  }
+
+  return nft;
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 // Exporting constants
-export * from './constants/ActionBlocks.js';
+export * from './constants/Blocks.js';
 export * from './constants/chains.js';
 export * from './constants/tokens.js';
 
@@ -9,7 +9,8 @@ export * from './models/Automation.js';
 export * from './models/Condition.js';
 export * from './models/Parameter.js';
 export * from './models/Trigger.js';
+export * from './models/Node.js';
+export * from './models/Edge.js';
 
 // Exporting services
 export * from './services/ApiService.js';
-export * from './services/AutomationService.js';

package/src/models/Action.ts

@@ -1,6 +1,8 @@
-export interface Action {
-    key: string;
-    type: string;
-    description: string;
-    value: any;
-  }
+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 }) {
+    super({ ...action, class: 'action' });
+  }
+}