otomato-sdk 2.0.456 → 2.0.457

package/README.md

@@ -37,7 +37,7 @@ npm install otomato-sdk
 
 For the first example, set the following environment variables:
 *   `API_URL`: Should be set to `https://api.otomato.xyz/api`.
-*   `AUTH_TOKEN`: Obtain this by following the [Authentication](#authentication) instructions.
+*   `AUTH_TOKEN`: Obtain this by following the [Authentication](#authentication) instructions. Alternatively, you can use an `API_KEY` instead.
 
 Alternatively, you can replace these placeholder values directly in the example code.
 
@@ -55,15 +55,18 @@ async function simpleEthPriceMonitor() {
   const API_URL = process.env.API_URL || "https://api.otomato.xyz/api";
   const EMAIL_ADDRESS = process.env.EMAIL_ADDRESS || "your-email@example.com"; // Replace with your email or set as ENV var
   const AUTH_TOKEN = process.env.AUTH_TOKEN;
+  const API_KEY = process.env.API_KEY;
 
-  if (!AUTH_TOKEN) {
-    console.error("Error: AUTH_TOKEN is not set. Please set it as an environment variable or directly in the code.");
+  if (!AUTH_TOKEN || !API_KEY) {
+    console.error("Error: AUTH_TOKEN or API_KEY is not set. Please set it as an environment variable or directly in the code.");
     return;
   }
   if (EMAIL_ADDRESS === "your-email@example.com") {
     console.warn("Warning: EMAIL_ADDRESS is set to the default. Replace with your email to receive notifications.");
   }
   apiServices.setUrl(API_URL);
+  // Use either an API key or an auth token:
+  // apiServices.setApiKey(process.env.API_KEY);
   apiServices.setAuth(AUTH_TOKEN);
 
   const priceTrigger = new Trigger(TRIGGERS.TOKENS.PRICE.PRICE_MOVEMENT_AGAINST_CURRENCY);
@@ -133,7 +136,35 @@ simpleEthPriceMonitor();
 
 ### Authentication
 
-Before interacting with the Otomato SDK, you need to authenticate your account. This is done by obtaining an `AUTH_TOKEN`.
+Before interacting with the Otomato SDK, you need to authenticate. There are two approaches:
+
+#### Option 1: API Key (Recommended)
+
+API keys are the simplest way to authenticate.
+
+```js
+import { apiServices } from 'otomato-sdk';
+
+apiServices.setUrl('https://api.otomato.xyz/api');
+apiServices.setApiKey('sk_live_xxxx_...');
+```
+
+Set it via environment variable:
+```
+API_URL=https://api.otomato.xyz/api
+API_KEY=sk_live_xxxx_...
+```
+
+```js
+apiServices.setUrl(process.env.API_URL);
+apiServices.setApiKey(process.env.API_KEY);
+```
+
+> **Note:** If both an API key and an auth token are set, the API key takes priority.
+
+#### Option 2: Auth Token
+
+You can also authenticate using an `AUTH_TOKEN` obtained from the web app or programmatically.
 
 **How to get an `AUTH_TOKEN`:**
 
@@ -150,9 +181,9 @@ Before interacting with the Otomato SDK, you need to authenticate your account.
     async function getAuthToken(walletAddress, accessCode, ownerAddress, signFunction) {
       try {
         // Ensure chainId is defined, e.g., CHAINS.ETHEREUM or your specific chain
-        const chainId = CHAINS.ETHEREUM; 
+        const chainId = CHAINS.ETHEREUM;
         const loginPayload = await apiServices.generateLoginPayload(walletAddress, chainId, accessCode, ownerAddress);
-        
+
         // The signFunction needs to be implemented by you, using your preferred wallet library (ethers.js, web3.js, etc.)
         // It takes the JSON string of loginPayload and returns a signature.
         // Example: const signature = await ethersSigner.signMessage(JSON.stringify(loginPayload));
@@ -397,4 +428,4 @@ We welcome contributions to enhance the Otomato SDK! Please follow these steps:
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/src/constants/version.js

@@ -1,4 +1,4 @@
-export const SDK_VERSION = '2.0.456';
+export const SDK_VERSION = '2.0.457';
 export function compareVersions(v1, v2) {
     // Split the version strings into parts
     const v1Parts = v1.split('.').map(Number);

package/dist/src/services/ApiService.js

@@ -12,33 +12,41 @@ const axiosInstance = axios.create({
 class ApiServices {
     constructor() {
         this.auth = null;
+        this.apiKey = null;
     }
     setAuth(auth) {
         this.auth = auth;
     }
+    setApiKey(apiKey) {
+        this.apiKey = apiKey;
+    }
     setUrl(baseUrl) {
         axiosInstance.defaults.baseURL = baseUrl;
     }
+    getAuthHeaders() {
+        if (this.apiKey) {
+            return { 'X-API-KEY': this.apiKey };
+        }
+        if (this.auth) {
+            return { 'Authorization': this.auth };
+        }
+        return {};
+    }
     async post(url, data) {
-        const headers = this.auth ? { 'Authorization': this.auth } : {};
-        return await axiosInstance.post(url, data, { headers });
+        return await axiosInstance.post(url, data, { headers: this.getAuthHeaders() });
     }
     async patch(url, data) {
-        const headers = this.auth ? { 'Authorization': this.auth } : {};
-        return await axiosInstance.patch(url, data, { headers });
+        return await axiosInstance.patch(url, data, { headers: this.getAuthHeaders() });
     }
     async put(url, data) {
-        const headers = this.auth ? { 'Authorization': this.auth } : {};
-        return await axiosInstance.put(url, data, { headers });
+        return await axiosInstance.put(url, data, { headers: this.getAuthHeaders() });
     }
     async get(url) {
-        const headers = this.auth ? { 'Authorization': this.auth } : {};
-        const response = await axiosInstance.get(url, { headers });
+        const response = await axiosInstance.get(url, { headers: this.getAuthHeaders() });
         return response.data;
     }
     async delete(url) {
-        const headers = this.auth ? { 'Authorization': this.auth } : {};
-        return await axiosInstance.delete(url, { headers });
+        return await axiosInstance.delete(url, { headers: this.getAuthHeaders() });
     }
     async generateLoginPayload(address, chainId, referralCode, ownerWalletAddress) {
         const headers = { 'Content-Type': 'application/json' };
@@ -61,10 +69,10 @@ class ApiServices {
         return response.data;
     }
     async getWorkflowsOfUser(offset, limit, isActive, query) {
-        if (!this.auth) {
-            throw new Error('Authorization token is required');
+        if (!this.auth && !this.apiKey) {
+            throw new Error('Authorization token or API key is required');
         }
-        const headers = { 'Authorization': this.auth };
+        const headers = this.getAuthHeaders();
         // Set defaults for offset and limit if not provided
         const finalOffset = offset ?? 0;
         const finalLimit = limit ?? 8;
@@ -84,12 +92,12 @@ class ApiServices {
         return response.data;
     }
     async getSessionKeyPermissions(workflowId) {
-        if (!this.auth) {
-            throw new Error('Authorization token is required');
+        if (!this.auth && !this.apiKey) {
+            throw new Error('Authorization token or API key is required');
         }
         try {
             const url = `/workflows/${workflowId}/verify-contracts`;
-            const headers = { Authorization: this.auth };
+            const headers = this.getAuthHeaders();
             const response = await axiosInstance.post(url, {}, { headers });
             return response.data; // Return the data from the response
         }

package/dist/types/examples/Chains/OasisWETHBalanceTrigger.d.ts

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

package/dist/types/examples/Chains/OasisWETHTransferTrigger.d.ts

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

package/dist/types/examples/Chains/create-workflow-on-abstract.d.ts

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

package/dist/types/examples/Chains/oasis-accumulated-finance-apy-trigger.d.ts

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

package/dist/types/examples/Chains/oasis-accumulated-finance-tvl-trigger.d.ts

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

package/dist/types/examples/Chains/oasis-weth-balance-trigger.d.ts

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

package/dist/types/examples/Chains/oasis-wrose-transfer-trigger.d.ts

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

package/dist/types/examples/UseCases/LendingAggregator/lending-aggregator-2-protocols.d.ts

@@ -0,0 +1,4 @@
+/*************************************
+ * 6. Main Workflow Builder
+ *************************************/
+export declare function aggregatorWorkflow(): Promise<void>;

package/dist/types/examples/UseCases/LendingAggregator/stop-lending-aggregator-2-protocols.d.ts

@@ -0,0 +1,7 @@
+/*************************************
+ * File: stop-lending-aggregator.ts
+ *************************************/
+/*************************************
+ * 3. Build the 'Stop Lending Aggregator' Workflow
+ *************************************/
+export declare function stopLendingAggregator(): Promise<void>;

package/dist/types/examples/UseCases/Notifications/GetNotifiedWhenICanBorrowOnFluid.d.ts

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

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

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

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

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "2.0.456";
+export declare const SDK_VERSION = "2.0.457";
 export declare function compareVersions(v1: string, v2: string): number;

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

@@ -1,7 +1,10 @@
 declare class ApiServices {
     private auth;
+    private apiKey;
     setAuth(auth: string): void;
+    setApiKey(apiKey: string): void;
     setUrl(baseUrl: string): void;
+    private getAuthHeaders;
     post(url: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
     patch(url: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
     put(url: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;

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

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

package/package.json

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