otomato-sdk 1.5.3 → 1.5.5

package/dist/src/constants/Blocks.js

@@ -1,7 +1,3 @@
-const TRIGGER_TYPE = {
-    SUBSCRIPTION: 0,
-    POLLING: 1,
-};
 export const TRIGGERS = {
     "TOKENS": {
         "ERC20": {
@@ -538,6 +534,11 @@ export const ACTIONS = {
                         "description": "The contract address of the ERC20"
                     },
                 ],
+                "permissions": {
+                    "approvedTargets": [
+                        "$contractAddress"
+                    ]
+                },
                 "blockId": 100004,
                 "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
             }

package/dist/src/constants/WorkflowTemplates.js

@@ -1,4 +1,10 @@
 import { Workflow, Trigger, Action, Edge, TRIGGERS, ACTIONS, CHAINS, getTokenFromSymbol } from '../index.js';
+export const WORKFLOW_TEMPLATES_TAGS = {
+    NFTS: 'NFTs',
+    SOCIALS: 'Socials',
+    TRADING: 'Trading',
+    ON_CHAIN_MONITORING: 'On-chain monitoring'
+};
 const createModeTransferNotificationWorkflow = () => {
     const modeTransferTrigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
     modeTransferTrigger.setChainId(CHAINS.MODE);
@@ -7,27 +13,28 @@ const createModeTransferNotificationWorkflow = () => {
     const telegramAction = new Action(ACTIONS.NOTIFICATIONS.TELEGRAM.SEND_MESSAGE);
     telegramAction.setParams("message", "0x74B8....C6B4 transferred $MODE");
     const edge = new Edge({ source: modeTransferTrigger, target: telegramAction });
-    return new Workflow('Buy ETH when the market sentiment is fearful', [modeTransferTrigger, telegramAction], [edge]);
+    return new Workflow('MODE transfer notification', [modeTransferTrigger, telegramAction], [edge]);
 };
 const createETHFearAndGreedBuy = () => {
     const trigger = new Trigger(TRIGGERS.SOCIALS.FEAR_AND_GREED.GET_FEAR_AND_GREED_INDEX);
     trigger.setCondition('lt');
     trigger.setComparisonValue(30);
-    // todo: change to swap
     const telegramAction = new Action(ACTIONS.NOTIFICATIONS.TELEGRAM.SEND_MESSAGE);
-    telegramAction.setParams("message", "0x74B8....C6B4 transferred $MODE");
+    telegramAction.setParams("message", "The market sentiment is extremely fearful. Consider buying ETH.");
     const edge = new Edge({ source: trigger, target: telegramAction });
-    return new Workflow('MODE transfer notification', [trigger, telegramAction], [edge]);
+    return new Workflow('Buy ETH when the market sentiment is extremely fearful', [trigger, telegramAction], [edge]);
 };
 export const WORKFLOW_TEMPLATES = [
     {
         'name': 'MODE transfer notification',
         'description': 'Receive notifications when a top $MODE holder (0x74B8....C6B4) transfers $MODE',
+        'tags': [WORKFLOW_TEMPLATES_TAGS.ON_CHAIN_MONITORING],
         createWorkflow: createModeTransferNotificationWorkflow
     },
     {
-        'name': 'Buy ETH when the market sentiment is fearful',
-        'description': 'Buy eth when the bitcoin fear and greed is below 30',
+        'name': 'Buy ETH when the market sentiment is extremely fearful',
+        'description': 'Buy ETH when the Bitcoin Fear and Greed Index is below 30',
+        'tags': [WORKFLOW_TEMPLATES_TAGS.TRADING, WORKFLOW_TEMPLATES_TAGS.SOCIALS],
         createWorkflow: createETHFearAndGreedBuy
     },
 ];

package/dist/src/index.js

@@ -11,6 +11,7 @@ export * from './models/Parameter.js';
 export * from './models/Trigger.js';
 export * from './models/Node.js';
 export * from './models/Edge.js';
+export * from './models/SessionKeyPermission.js';
 // Exporting services
 export * from './services/ApiService.js';
 export * from './utils/helpers.js';

package/dist/src/models/Action.js

@@ -10,12 +10,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Node } from './Node.js';
 import { ACTIONS } from '../constants/Blocks.js';
 import { typeIsNumber } from '../utils/typeValidator.js';
+import { SessionKeyPermission } from './SessionKeyPermission.js';
 export class Action extends Node {
     constructor(action) {
         super(Object.assign(Object.assign({}, action), { class: 'action', parentInfo: findActionByBlockId(action.blockId).parentInfo }));
     }
-    getStaticParameters() {
-        return null;
+    getSessionKeyPermissions() {
+        const parentBlock = findActionByBlockId(this.blockId).block;
+        if (!parentBlock.permissions)
+            return null;
+        const permissions = SessionKeyPermission.fromJSON(parentBlock.permissions);
+        permissions.fill('contractAddress', this.getParameter('contractAddress'));
+        return permissions;
     }
     static fromJSON(json) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -44,9 +50,6 @@ export class Action extends Node {
                             }
                         }
                         break;
-                    case 'interval':
-                        // ignore
-                        break;
                     default:
                         action.setParams(key, value);
                         break;

package/dist/src/models/Node.js

@@ -105,9 +105,6 @@ export class Node {
             return acc;
         }, {});
     }
-    getStaticParameters() {
-        return null;
-    }
     toJSON() {
         const serializeBigInt = (key, value) => {
             if (typeof value === 'bigint') {
@@ -124,14 +121,13 @@ export class Node {
                 return value;
             }
         };
-        const staticParameters = this.getStaticParameters() || {};
         const json = {
             id: this.id,
             ref: this.ref,
             blockId: this.blockId,
             type: this.class,
             state: this.state,
-            parameters: Object.assign(Object.assign({}, this.getParameters()), staticParameters),
+            parameters: Object.assign({}, this.getParameters()),
         };
         if (this.position) {
             json.position = this.position;

package/dist/src/models/SessionKeyPermission.js

@@ -0,0 +1,47 @@
+export class SessionKeyPermission {
+    constructor(approvedTargets = []) {
+        if (!Array.isArray(approvedTargets)) {
+            console.error('approvedTargets should be an array. Received:', approvedTargets);
+            approvedTargets = [];
+        }
+        this.approvedTargets = approvedTargets;
+    }
+    fill(key, value) {
+        if (!Array.isArray(this.approvedTargets)) {
+            console.error('approvedTargets is not an array. Cannot call map on:', this.approvedTargets);
+            return;
+        }
+        this.approvedTargets = this.approvedTargets.map(target => {
+            const placeholder = `$${key}`;
+            if (typeof target === 'string' && target.includes(placeholder)) {
+                target = target.replace(placeholder, value);
+            }
+            return target;
+        });
+    }
+    toJSON() {
+        const containsPlaceholder = this.approvedTargets.some(target => typeof target === 'string' && target.includes('$'));
+        if (containsPlaceholder) {
+            throw new Error('Approved targets contain unresolved placeholders.');
+        }
+        return {
+            approvedTargets: this.approvedTargets,
+        };
+    }
+    static fromJSON(json) {
+        if (!json || !Array.isArray(json.approvedTargets)) {
+            console.error('Invalid JSON object for SessionKeyPermission:', json);
+            throw new Error('Invalid JSON object for SessionKeyPermission');
+        }
+        return new SessionKeyPermission(json.approvedTargets);
+    }
+    merge(other) {
+        if (!other || !Array.isArray(other.approvedTargets)) {
+            console.error('Invalid SessionKeyPermission object to merge:', other);
+            return;
+        }
+        const uniqueTargets = new Set(this.approvedTargets);
+        other.approvedTargets.forEach(target => uniqueTargets.add(target));
+        this.approvedTargets = Array.from(uniqueTargets);
+    }
+}

package/dist/src/models/Trigger.js

@@ -30,12 +30,6 @@ export class Trigger extends Node {
         }
         this.setParameter('comparisonValue', value);
     }
-    getStaticParameters() {
-        if (!this.notAPollingTrigger()) {
-            return { interval: 5000 };
-        }
-        return null;
-    }
     static fromJSON(json) {
         return __awaiter(this, void 0, void 0, function* () {
             const enriched = findTriggerByBlockId(json.blockId);
@@ -69,9 +63,6 @@ export class Trigger extends Node {
                             }
                         }
                         break;
-                    case 'interval':
-                        // ignore
-                        break;
                     default:
                         trigger.setParams(key, value);
                         break;

package/dist/src/models/Workflow.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Node } from './Node.js';
 import { Edge } from './Edge.js';
 import { apiServices } from '../services/ApiService.js';
+import { SessionKeyPermission } from './SessionKeyPermission.js';
 export class Workflow {
     constructor(name = '', nodes = [], edges = []) {
         this.id = null;
@@ -191,4 +192,21 @@ export class Workflow {
             }
         });
     }
+    getSessionKeyPermissions() {
+        const permissions = new SessionKeyPermission();
+        for (const node of this.nodes) {
+            try {
+                if (node.class === 'action' && 'getSessionKeyPermissions' in node) {
+                    const nodePermissions = node.getSessionKeyPermissions();
+                    if (nodePermissions) {
+                        permissions.merge(nodePermissions);
+                    }
+                }
+            }
+            catch (error) {
+                console.error(`Error getting session key permissions for node ${node.getRef()}:`, error);
+            }
+        }
+        return permissions;
+    }
 }

package/dist/types/examples/sessionKeyPermissions.d.ts

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

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

@@ -197,6 +197,9 @@ export declare const ACTIONS: {
                 type: number;
                 method: string;
                 parameters: Parameter[];
+                permissions: {
+                    approvedTargets: string[];
+                };
                 blockId: number;
                 image: string;
             };

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

@@ -1,6 +1,13 @@
 import { Workflow } from '../index.js';
+export declare const WORKFLOW_TEMPLATES_TAGS: {
+    NFTS: string;
+    SOCIALS: string;
+    TRADING: string;
+    ON_CHAIN_MONITORING: string;
+};
 export declare const WORKFLOW_TEMPLATES: {
     name: string;
     description: string;
+    tags: string[];
     createWorkflow: () => Workflow;
 }[];

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

@@ -9,6 +9,7 @@ export * from './models/Parameter.js';
 export * from './models/Trigger.js';
 export * from './models/Node.js';
 export * from './models/Edge.js';
+export * from './models/SessionKeyPermission.js';
 export * from './services/ApiService.js';
 export * from './utils/helpers.js';
 export * from './utils/typeValidator.js';

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

@@ -1,5 +1,6 @@
 import { Parameter } from './Parameter.js';
 import { Node, ParentInfo, Position, NodeState } from './Node.js';
+import { SessionKeyPermission } from './SessionKeyPermission.js';
 export declare class Action extends Node {
     constructor(action: {
         blockId: number;
@@ -12,7 +13,7 @@ export declare class Action extends Node {
         parentInfo?: ParentInfo;
         state?: NodeState;
     });
-    getStaticParameters(): null;
+    getSessionKeyPermissions(): SessionKeyPermission | null;
     static fromJSON(json: {
         [key: string]: any;
     }): Promise<Action>;

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

@@ -51,9 +51,6 @@ export declare abstract class Node {
     getParameters(): {
         [key: string]: any;
     };
-    getStaticParameters(): {
-        [key: string]: any;
-    } | null;
     toJSON(): {
         [key: string]: any;
     };

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

@@ -0,0 +1,12 @@
+export declare class SessionKeyPermission {
+    approvedTargets: string[];
+    constructor(approvedTargets?: string[]);
+    fill(key: string, value: any): void;
+    toJSON(): {
+        [key: string]: any;
+    };
+    static fromJSON(json: {
+        [key: string]: any;
+    }): SessionKeyPermission;
+    merge(other: SessionKeyPermission): void;
+}

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

@@ -17,9 +17,6 @@ export declare class Trigger extends Node {
     private notAPollingTrigger;
     setCondition(value: string): void;
     setComparisonValue(value: number): void;
-    getStaticParameters(): {
-        interval: number;
-    } | null;
     static fromJSON(json: {
         [key: string]: any;
     }): Promise<Trigger>;

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

@@ -1,5 +1,6 @@
 import { Node } from './Node.js';
 import { Edge } from './Edge.js';
+import { SessionKeyPermission } from './SessionKeyPermission.js';
 export type WorkflowState = 'inactive' | 'active' | 'failed' | 'completed';
 export declare class Workflow {
     id: string | null;
@@ -44,4 +45,5 @@ export declare class Workflow {
         success: boolean;
         error?: string;
     }>;
+    getSessionKeyPermissions(): SessionKeyPermission;
 }

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "otomato-sdk",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "An SDK for building and managing automations on Otomato",
   "main": "dist/src/index.js",
   "types": "dist/types/src/index.d.ts",