otomato-sdk 1.5.39 → 1.5.40

package/README.md

@@ -24,7 +24,7 @@ Here's how to create a trigger using the Otomato SDK:
 ```typescript
 import { Trigger, TRIGGERS, CHAINS, getTokenFromSymbol } from 'otomato-sdk';
 
-const transferTrigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
+const transferTrigger = new Trigger(TRIGGERS.TOKENS.TRANSFER.TRANSFER);
 transferTrigger.setChainId(CHAINS.ETHEREUM);
 transferTrigger.setParams("value", 1000);
 transferTrigger.setParams("to", "0xe1432599B51d9BE1b5A27E2A2FB8e5dF684749C6");

package/dist/src/constants/Blocks.js

@@ -1,11 +1,11 @@
 export const TRIGGERS = {
     "TOKENS": {
-        "ERC20": {
-            "description": "The most used standard for tokens on ethereum compatible blockchains",
+        "TRANSFER": {
+            "description": "Monitors token transfers",
             "chains": [
                 0
             ],
-            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp",
+            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenTransfer.png",
             "TRANSFER": {
                 "name": "Transfer token",
                 "description": "This block gets triggered when someone transfers the ERC20 configured in the params",
@@ -71,8 +71,15 @@ export const TRIGGERS = {
                     }
                 ],
                 "blockId": 1,
-                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
-            },
+                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenTransfer.png"
+            }
+        },
+        "BALANCE": {
+            "description": "Monitors token balance of selected addresses",
+            "chains": [
+                0
+            ],
+            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenBalance.png",
             "BALANCE": {
                 "name": "ERC20 balance check",
                 "description": "Fetches the balance of an ERC20 and checks it against the specified condition.",
@@ -98,7 +105,7 @@ export const TRIGGERS = {
                     },
                     {
                         "key": "contractAddress",
-                        "type": "address",
+                        "type": "erc20",
                         "description": "The contract address of the ERC20",
                         "mandatory": true,
                         "category": 0
@@ -151,7 +158,7 @@ export const TRIGGERS = {
                     }
                 ],
                 "blockId": 5,
-                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
+                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenBalance.png"
             }
         }
     },
@@ -463,7 +470,9 @@ export const TRIGGERS = {
                 "blockId": 9,
                 "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/splicefi.png"
             }
-        },
+        }
+    },
+    "LENDING": {
         "IONIC": {
             "description": "#1 money market for Yield Bearing Assets on the OP Superchain",
             "chains": [
@@ -530,15 +539,14 @@ export const TRIGGERS = {
                         ]
                     }
                 ],
+                "before": "\n    async (env) => {\n        const otomatoSdk = await import('otomato-sdk');\n \n        if (!env.parameters.chainId)\n            throw new Error('You need to provide the chainId first');\n        \n        const getIonicTokenFromToken = (chain, tokenAddress) => {\n    const CHAINS = otomatoSdk.CHAINS;\n    if (chain == CHAINS.MODE) {\n        switch (tokenAddress.toLowerCase()) {\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'USDT').contractAddress.toLowerCase():\n                return '0x94812F2eEa03A49869f95e1b5868C6f3206ee3D3';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'USDC').contractAddress.toLowerCase():\n                return '0x2BE717340023C9e14C1Bb12cb3ecBcfd3c3fB038';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'ezETH').contractAddress.toLowerCase():\n                return '0x59e710215d45F584f44c0FEe83DA6d43D762D857';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'WETH').contractAddress.toLowerCase():\n                return '0x71ef7EDa2Be775E5A7aa8afD02C45F059833e9d2';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'WBTC').contractAddress.toLowerCase():\n                return '0xd70254C3baD29504789714A7c69d60Ec1127375C';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'STONE').contractAddress.toLowerCase():\n                return '0x959FA710CCBb22c7Ce1e59Da82A247e686629310';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'wrsETH').contractAddress.toLowerCase():\n                return '0x49950319aBE7CE5c3A6C90698381b45989C99b46';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'weETH.mode').contractAddress.toLowerCase():\n                return '0xA0D844742B4abbbc43d8931a6Edb00C56325aA18';\n            case otomatoSdk.getTokenFromSymbol(CHAINS.MODE, 'M-BTC').contractAddress.toLowerCase():\n                return '0x19F245782b1258cf3e11Eda25784A378cC18c108';\n\n            default: throw new Error('This asset is not available on Ionic');\n        }\n    }\n}\n        \n        let ionicTokenContractAddress = getIonicTokenFromToken(\n            env.parameters.chainId,\n            env.parameters.token.toLowerCase()\n        );\n        return {\n            contractAddress: ionicTokenContractAddress\n        };\n    }",
                 "output": {
                     "lendingRate": "float"
                 },
                 "blockId": 15,
                 "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ionic.jpg"
             }
-        }
-    },
-    "LENDING": {
+        },
         "ASTARIA": {
             "description": "Astaria is an oracle-less, intent-based, fixed-rate lending protocol supporting unlimited loan durations for any asset",
             "chains": [
@@ -1121,8 +1129,8 @@ export const ACTIONS = {
             "chains": [
                 34443
             ],
-            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/delay.png",
             "SWAP": {
+                "id": 100005,
                 "name": "Swap",
                 "description": "Swap two assets using the best market rates accross multiple pools",
                 "type": 1,
@@ -1189,7 +1197,7 @@ export const ACTIONS = {
                         "value": 0.3,
                         "mandatory": true,
                         "category": 1
-                    },
+                    }
                 ],
                 "examples": [
                     {
@@ -1231,10 +1239,9 @@ export const ACTIONS = {
                         "Transfer ETH"
                     ]
                 },
-                "duplicate": true,
-                "blockId": 100005,
-                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/delay.png"
-            }
+                "duplicate": true
+            },
+            "blockId": 100013
         }
     },
     "NOTIFICATIONS": {
@@ -1355,12 +1362,12 @@ export const ACTIONS = {
         }
     },
     "TOKENS": {
-        "ERC20": {
-            "description": "The most used standard for tokens on ethereum compatible blockchains",
+        "TRANSFER": {
+            "description": "Transfer token",
             "chains": [
                 34443
             ],
-            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp",
+            "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenTransfer.png",
             "TRANSFER": {
                 "name": "Transfer token",
                 "description": "Transfers an ERC20 token",
@@ -1408,7 +1415,7 @@ export const ACTIONS = {
                         "type": 0,
                         "chainId": "{{parameters.chainId}}",
                         "contractAddress": "{{parameters.contractAddress}}",
-                        "amount": "{{parameters.abi.parameters.amount}}"
+                        "amount": "{{parameters.abi.parameters.value}}"
                     }
                 ],
                 "examples": [
@@ -1447,7 +1454,7 @@ export const ACTIONS = {
                     ]
                 },
                 "blockId": 100004,
-                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/ethereum.webp"
+                "image": "https://otomato-sdk-images.s3.eu-west-1.amazonaws.com/tokenTransfer.png"
             }
         }
     },
@@ -1809,7 +1816,7 @@ export const ACTIONS = {
                     },
                     {
                         "key": "abiParams.tokens",
-                        "type": "uint256",
+                        "type": "addresses_array",
                         "description": "List of collaterals",
                         "mandatory": true,
                         "category": 0
@@ -1821,10 +1828,10 @@ export const ACTIONS = {
                         "0xFB3323E24743Caf4ADD0fDCCFB268565c0685556"
                     ],
                     "label": [
-                        "Borrow against {{tokenSymbol({{parameters.chainId}}, {{parameters.abiParams.tokens[0]}})}} on IONIC"
+                        "Enable {{tokenSymbol({{parameters.chainId}}, {{parameters.abi.parameters.tokens[0]}})}} as collateral on IONIC"
                     ],
                     "labelNotAuthorized": [
-                        "Transfer {{tokenSymbol({{parameters.chainId}}, {{parameters.abiParams.tokens[0]}})}}"
+                        "Transfer {{tokenSymbol({{parameters.chainId}}, {{parameters.abi.parameters.tokens[0]}})}}"
                     ]
                 },
                 "blockId": 100012,

package/dist/src/constants/WorkflowTemplates.js

@@ -15,7 +15,7 @@ export const WORKFLOW_TEMPLATES_TAGS = {
     ON_CHAIN_MONITORING: 'On-chain monitoring'
 };
 const createModeTransferNotificationWorkflow = () => {
-    const modeTransferTrigger = new Trigger(TRIGGERS.TOKENS.ERC20.TRANSFER);
+    const modeTransferTrigger = new Trigger(TRIGGERS.TOKENS.TRANSFER.TRANSFER);
     modeTransferTrigger.setChainId(CHAINS.MODE);
     modeTransferTrigger.setContractAddress(getTokenFromSymbol(CHAINS.MODE, 'MODE').contractAddress);
     modeTransferTrigger.setParams('from', '0x74B847b308BD89Ef15639E6e4a2544E4b8b8C6B4');

package/dist/src/models/Action.js

@@ -23,12 +23,67 @@ export class Action extends Node {
             const permissions = SessionKeyPermission.fromJSON(parentBlock.permissions);
             permissions.fillParameters(this.getParameters());
             permissions.fillMethod();
+            // Handle 'before' code for the main action
             if (parentBlock.before) {
                 yield permissions.fillBeforeVariables(parentBlock.before, this.getParameters());
             }
+            // Handle batchWith: for any batched actions, merge their permissions
+            if (parentBlock.batchWith && parentBlock.batchWith.length > 0) {
+                for (const batch of parentBlock.batchWith) {
+                    const batchedAction = findActionByBlockId(batch.id).block;
+                    if (batchedAction.permissions) {
+                        const batchedActionInstance = new Action(batchedAction);
+                        // Replace placeholders in parameters
+                        const resolvedBatchParams = batch.parameters;
+                        Object.keys(resolvedBatchParams).forEach(key => {
+                            var _a;
+                            // If it's an ABI parameter, handle it separately
+                            if (key === 'abi' && ((_a = resolvedBatchParams.abi) === null || _a === void 0 ? void 0 : _a.parameters)) {
+                                Object.keys(resolvedBatchParams.abi.parameters).forEach(abiKey => {
+                                    const abiValue = this.replaceVariables(resolvedBatchParams.abi.parameters[abiKey]);
+                                    batchedActionInstance.setParams(`${abiKey}`, abiValue);
+                                });
+                            }
+                            else {
+                                let value = this.replaceVariables(resolvedBatchParams[key]);
+                                batchedActionInstance.setParams(key, value);
+                            }
+                        });
+                        // Get batched permissions
+                        const batchedPermissions = yield batchedActionInstance.getSessionKeyPermissions();
+                        if (!batchedPermissions)
+                            continue;
+                        batchedPermissions.fillParameters(batch.parameters); // Pass batched action parameters
+                        batchedPermissions.fillMethod();
+                        // Handle 'before' code for the batched action
+                        if (batchedAction.before) {
+                            yield batchedPermissions.fillBeforeVariables(batchedAction.before, batch.parameters);
+                        }
+                        // Merge the batched action's permissions with the main action's permissions
+                        permissions.merge(batchedPermissions);
+                    }
+                }
+            }
             return permissions;
         });
     }
+    /**
+     * Replace any placeholders like {{parameters.tokenToDeposit}} with actual values
+     * from the parameters of the current action. Supports both strings and arrays.
+     */
+    replaceVariables(value) {
+        if (typeof value === 'string') {
+            return value.replace(/\{\{parameters\.(.*?)\}\}/g, (_, key) => {
+                console.log(`Looking for ${key} parameter`);
+                return this.getParameter(key) || '';
+            });
+        }
+        if (Array.isArray(value)) {
+            return value.map(item => this.replaceVariables(item)); // Recursively handle each array element
+        }
+        // Return the value unchanged if it's neither a string nor an array
+        return value;
+    }
     static fromJSON(json) {
         return __awaiter(this, void 0, void 0, function* () {
             const enriched = findActionByBlockId(json.blockId);

package/dist/src/models/Node.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { validateType, isANumber } from '../utils/typeValidator.js';
+import { validateType, typeIsNumber } from '../utils/typeValidator.js';
 import { apiServices } from '../services/ApiService.js';
 let nodeCounter = 0;
 const generatedRefs = new Set();
@@ -73,11 +73,22 @@ export class Node {
         if (key in this.parameters) {
             const param = this.parameters[key];
             try {
-                // if the user pass '100000n' for a number, we transform it to Bigints
-                if (isANumber(param.type) && (value === null || value === void 0 ? void 0 : value.endsWith('n')))
+                // BigInt conversion
+                if (typeIsNumber(param.type) && typeof value === 'string' && value.endsWith('n')) {
                     value = BigInt(value.substring(0, value.length - 1));
+                }
+                // String to integer conversion
+                if (typeIsNumber(param.type) && typeof value === 'string') {
+                    const parsedValue = parseInt(value, 10);
+                    if (!isNaN(parsedValue)) {
+                        value = parsedValue;
+                    }
+                }
+            }
+            catch (e) {
+                console.error(`Error processing parameter ${key}:`, e);
             }
-            catch (e) { }
+            // Validate the value type
             if (validateType(param.type, value)) {
                 this.parameters[key].value = value;
             }

package/dist/src/models/SessionKeyPermission.js

@@ -14,12 +14,13 @@ export class SessionKeyPermission {
         this.label = label;
         this.labelNotAuthorized = labelNotAuthorized;
     }
-    // Existing method to replace placeholders with actual values
     fill(key, value) {
-        const replacePlaceholder = (target) => {
-            const placeholder = new RegExp(`{{${key}}}`, 'g');
-            return target.replace(placeholder, value);
-        };
+        // Escape special regex characters in the key
+        const escapedKey = key.replace(/[.*+?^${}()|[\]\\[\]]/g, '\\$&');
+        const placeholder = new RegExp(`{{${escapedKey}}}`, 'g');
+        // Function to replace placeholders in a target string
+        const replacePlaceholder = (target) => target.replace(placeholder, value);
+        // Apply the placeholder replacement logic
         this.approvedTargets = this.approvedTargets.map(replacePlaceholder);
         this.label = this.label.map(replacePlaceholder);
         this.labelNotAuthorized = this.labelNotAuthorized.map(replacePlaceholder);
@@ -61,16 +62,34 @@ export class SessionKeyPermission {
     // The rest of your existing code
     fillParameters(params) {
         var _a;
-        // 1. replace non-ABI params
+        // Helper to handle the replacement in case of arrays
+        const fillArray = (key, array) => {
+            array.forEach((item, index) => {
+                if (typeof item === 'string') {
+                    this.fill(`${key}[${index}]`, item);
+                }
+            });
+        };
+        // 1. Replace non-ABI params
         for (let key in params) {
             if (key !== 'abi') {
-                this.fill(`parameters.${key}`, params[key]);
+                if (Array.isArray(params[key])) {
+                    fillArray(`parameters.${key}`, params[key]);
+                }
+                else {
+                    this.fill(`parameters.${key}`, params[key]);
+                }
             }
         }
-        // 2. replace ABI params
+        // 2. Replace ABI params
         const abiParams = (_a = params.abi) === null || _a === void 0 ? void 0 : _a.parameters;
         for (let key in abiParams) {
-            this.fill(`parameters.abiParams.${key}`, abiParams[key]);
+            if (Array.isArray(abiParams[key])) {
+                fillArray(`parameters.abi.parameters.${key}`, abiParams[key]);
+            }
+            else {
+                this.fill(`parameters.abi.parameters.${key}`, abiParams[key]);
+            }
         }
     }
     fillMethod() {

package/dist/src/utils/typeValidator.js

@@ -1,25 +1,4 @@
 import { ethers } from 'ethers';
-export function isANumber(type) {
-    switch (type) {
-        case 'integer':
-            return true;
-        case 'int8':
-        case 'int16':
-        case 'int32':
-        case 'int64':
-        case 'int128':
-        case 'int256':
-            return true;
-        case 'uint8':
-        case 'uint16':
-        case 'uint32':
-        case 'uint64':
-        case 'uint128':
-        case 'uint256':
-            return true;
-        default: return false;
-    }
-}
 export function validateType(expectedType, value) {
     switch (expectedType) {
         case 'bool':
@@ -62,6 +41,9 @@ export function validateType(expectedType, value) {
         case 'logic_operator':
             const validOperators = new Set(['gte', 'gt', 'lte', 'lt', 'eq', 'neq']);
             return typeof value === 'string' && validOperators.has(value);
+        case 'addresses_array':
+            // Ensure value is an array, and each element is a valid address
+            return Array.isArray(value) && value.every(isAddress);
         case 'any':
             return true;
         default:

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

@@ -1,7 +1,7 @@
 import { Parameter } from '../models/Parameter.js';
 export declare const TRIGGERS: {
     TOKENS: {
-        ERC20: {
+        TRANSFER: {
             description: string;
             chains: number[];
             image: string;
@@ -30,6 +30,11 @@ export declare const TRIGGERS: {
                 blockId: number;
                 image: string;
             };
+        };
+        BALANCE: {
+            description: string;
+            chains: number[];
+            image: string;
             BALANCE: {
                 name: string;
                 description: string;
@@ -183,6 +188,8 @@ export declare const TRIGGERS: {
                 image: string;
             };
         };
+    };
+    LENDING: {
         IONIC: {
             description: string;
             chains: number[];
@@ -204,6 +211,7 @@ export declare const TRIGGERS: {
                         value: string;
                     })[];
                 }[];
+                before: string;
                 output: {
                     lendingRate: string;
                 };
@@ -211,8 +219,6 @@ export declare const TRIGGERS: {
                 image: string;
             };
         };
-    };
-    LENDING: {
         ASTARIA: {
             description: string;
             chains: number[];
@@ -452,8 +458,8 @@ export declare const ACTIONS: {
         SWAP: {
             description: string;
             chains: number[];
-            image: string;
             SWAP: {
+                id: number;
                 name: string;
                 description: string;
                 type: number;
@@ -476,7 +482,34 @@ export declare const ACTIONS: {
                     tokenOut: string;
                     transactionHash: string;
                 };
-                parameters: Parameter[];
+                parameters: ({
+                    key: string;
+                    type: string;
+                    description: string;
+                    mandatory: boolean;
+                    category: number;
+                    erc20FormattedAmount?: undefined;
+                    value?: undefined;
+                } | {
+                    key: string;
+                    type: string;
+                    description: string;
+                    mandatory: boolean;
+                    category: number;
+                    erc20FormattedAmount: {
+                        contractAddress: string;
+                        chain: string;
+                    };
+                    value?: undefined;
+                } | {
+                    key: string;
+                    type: string;
+                    description: string;
+                    value: number;
+                    mandatory: boolean;
+                    category: number;
+                    erc20FormattedAmount?: undefined;
+                })[];
                 examples: {
                     name: string;
                     description: string;
@@ -494,9 +527,8 @@ export declare const ACTIONS: {
                     labelNotAuthorized: string[];
                 };
                 duplicate: boolean;
-                blockId: number;
-                image: string;
             };
+            blockId: number;
         };
     };
     NOTIFICATIONS: {
@@ -569,7 +601,7 @@ export declare const ACTIONS: {
         };
     };
     TOKENS: {
-        ERC20: {
+        TRANSFER: {
             description: string;
             chains: number[];
             image: string;

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

@@ -17,6 +17,11 @@ export declare class Action extends Node {
         state?: NodeState;
     });
     getSessionKeyPermissions(): Promise<SessionKeyPermission | null>;
+    /**
+     * Replace any placeholders like {{parameters.tokenToDeposit}} with actual values
+     * from the parameters of the current action. Supports both strings and arrays.
+     */
+    replaceVariables(value: any): any;
     static fromJSON(json: {
         [key: string]: any;
     }): Promise<Action>;

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

@@ -1,4 +1,3 @@
-export declare function isANumber(type: string): boolean;
 export declare function validateType(expectedType: string, value: any): boolean;
 export declare function typeIsNumber(type: string): boolean;
 export declare function isAddress(value: string): boolean;

package/package.json

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