sdk-triggerx 0.1.6 → 0.1.7

package/dist/{src/api → api}/jobs.js

@@ -120,9 +120,6 @@ function encodeJobType4or6Data(recurringJob, ipfsHash) {
  */
 async function createJob(client, params) {
     let { jobInput, signer, encodedData } = params;
-    if (!signer) {
-        throw new Error('A valid ethers.Signer must be provided to createJob');
-    }
     // Use the API key from the client instance
     const apiKey = client.getApiKey();
     const userAddress = await signer.getAddress();

package/dist/{src/config.js → config.js}

@@ -1,6 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfig = getConfig;
+const dotenv_1 = __importDefault(require("dotenv"));
+dotenv_1.default.config();
 function getConfig() {
     return {
         apiKey: process.env.API_KEY || '',

package/package.json

@@ -1,36 +1,39 @@
 {
   "name": "sdk-triggerx",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "SDK for interacting with the TriggerX backend and smart contracts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "test": "jest",
-    "lint": "eslint src --ext .ts",
-    "example": "npm run -s build && node dist/test/createJobExample.js"
+    "lint": "eslint src --ext .ts"
   },
-  "author": "",
+  "author": "Nipun Shah",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trigg3rX/triggerx-newSDK.git"
+  },
+  "keywords": ["triggerx", "sdk", "web3", "blockchain", "ethers"],
   "directories": {
     "test": "test"
   },
-  "keywords": [],
+  "files": [
+    "dist"
+  ],
   "dependencies": {
-    "axios": "^1.11.0"
-  },
-  "peerDependencies": {
-    "ethers": ">=6 <7"
+    "axios": "^1.11.0",
+    "ethers": "^6.15.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
+    "dotenv": "^17.2.1",
     "eslint": "^9.32.0",
-    "ethers": "^6.15.0",
     "jest": "^30.0.5",
     "ts-jest": "^29.4.0",
     "typescript": "^5.8.3"
-  },
-  "sideEffects": false
+  }
 }

package/.eslintrc.json

@@ -1,16 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "extends": [
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "env": {
-    "node": true,
-    "es2020": true,
-    "jest": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "sourceType": "module"
-  },
-  "rules": {}
-} 

package/dist/test/createJobExample.d.ts

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

package/dist/test/createJobExample.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = require("../src");
-const types_1 = require("../src/types");
-const ethers_1 = require("ethers");
-async function main() {
-    const apiKey = 'TGRX-02c20872-4bdf-4fd9-9e74-556861b16690';
-    const client = new src_1.TriggerXClient(apiKey);
-    // Example: Time-based static job
-    const jobInput = {
-        jobType: types_1.JobType.Time,
-        argType: types_1.ArgType.Static,
-        jobTitle: 'SDK Test Time Job for mainnet',
-        timeFrame: 36,
-        scheduleType: 'interval',
-        timeInterval: 33,
-        cronExpression: '0 0 * * *',
-        specificSchedule: '2025-01-01 00:00:00',
-        timezone: 'Asia/Calcutta',
-        chainId: '421614',
-        targetContractAddress: '0xDE85FE97A73B891f12CbBF1210cc225AF332C90B',
-        targetFunction: 'helloWorld',
-        abi: '[{"inputs":[],"name":"count","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_cnt","type":"uint256"}],"name":"helloWorld","outputs":[],"stateMutability":"nonpayable","type":"function"}]',
-        isImua: false,
-        arguments: ['3'],
-        dynamicArgumentsScriptUrl: '',
-        autotopupTG: true,
-    };
-    // // Example: Condition-based static job
-    // const jobInput: CreateJobInput = {
-    //     jobType: JobType.Condition,
-    //     argType: ArgType.Static,
-    //     jobTitle: 'SDK Test Condition Job',
-    //     timeFrame: 48,
-    //     conditionType: 'greaterThan',
-    //     upperLimit: 100,
-    //     lowerLimit: 10,
-    //     valueSourceType: 'http',
-    //     valueSourceUrl: 'https://api.example.com/value',
-    //     timezone: 'Asia/Calcutta',
-    //     recurring: false,
-    //     chainId: '11155420',
-    //     targetContractAddress: '0x49a81A591afdDEF973e6e49aaEa7d76943ef234C',
-    //     targetFunction: 'incrementBy',
-    //     abi: '[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"previousValue","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newValue","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"incrementAmount","type":"uint256"}],"name":"CounterIncremented","type":"event"},{"inputs":[],"name":"getCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"increment","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"incrementBy","outputs":[],"stateMutability":"nonpayable","type":"function"}]',
-    //     isImua: true,
-    //     arguments: ['5'],
-    //     dynamicArgumentsScriptUrl: '',
-    // };
-    // // Example: Event-based static job
-    // const eventJobInput: CreateJobInput = {
-    //     jobType: JobType.Event,
-    //     argType: ArgType.Static,
-    //     jobTitle: 'SDK Test Event Job',
-    //     timeFrame: 25,
-    //     triggerChainId: '11155420',
-    //     triggerContractAddress: '0x49a81A591afdDEF973e6e49aaEa7d76943ef234C',
-    //     triggerEvent: 'CounterIncremented(uint256,uint256,uint256)',
-    //     timezone: 'Asia/Calcutta',
-    //     chainId: '11155420',
-    //     targetContractAddress: '0x49a81A591afdDEF973e6e49aaEa7d76943ef234C',
-    //     targetFunction: 'incrementBy',
-    //     abi: '[{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"previousValue","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newValue","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"incrementAmount","type":"uint256"}],"name":"CounterIncremented","type":"event"},{"inputs":[],"name":"getCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"increment","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"incrementBy","outputs":[],"stateMutability":"nonpayable","type":"function"}]',
-    // };
-    // To test, you can call createJob with this input as well:
-    // const conditionResult = await createJob(client, {
-    //     jobInput: conditionJobInput,
-    //     signer,
-    // });
-    // console.log('Condition Job creation result:', conditionResult);
-    // These would typically come from env/config/user input
-    const privateKey = '0x3bd66a68dcde6ede3b38ced6de79489a447e0fac1648b749a5001b0aa167d089';
-    const providerUrl = 'https://arb-sepolia.g.alchemy.com/v2/zU9y7U094z69CQwzpro2mCKnW3A8gtlx';
-    const provider = new ethers_1.ethers.JsonRpcProvider(providerUrl);
-    const signer = new ethers_1.ethers.Wallet(privateKey, provider);
-    console.log('Job input:', client);
-    const result = await (0, src_1.createJob)(client, {
-        jobInput: jobInput,
-        // @ts-ignore
-        signer: signer,
-    });
-    console.log('Job creation result:', result);
-}
-main().catch(console.error);

package/dist/test/deleteJob.test.d.ts

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

package/dist/test/deleteJob.test.js

@@ -1,22 +0,0 @@
-"use strict";
-// sdk-triggerx/test/deleteJob.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../src/client");
-const deleteJob_1 = require("../src/api/deleteJob");
-async function main() {
-    // The user should provide their actual API key here
-    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8';
-    // Create the client with the API key
-    const client = new client_1.TriggerXClient(apiKey);
-    // Specify the job ID to delete
-    const jobId = 'YOUR_JOB_ID'; // Replace with an actual job ID for testing
-    try {
-        // Call the SDK function to delete the job
-        await (0, deleteJob_1.deleteJob)(client, jobId);
-        console.log(`Job with ID ${jobId} deleted successfully.`);
-    }
-    catch (error) {
-        console.error('Error deleting job:', error);
-    }
-}
-main().catch(console.error);

package/dist/test/example.test.d.ts

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

package/dist/test/example.test.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errors_1 = require("../src/utils/errors");
-describe('wrapError', () => {
-    it('should wrap a standard error', () => {
-        const err = new Error('fail');
-        const wrapped = (0, errors_1.wrapError)(err);
-        expect(wrapped).toBeInstanceOf(Error);
-        expect(wrapped.message).toBe('fail');
-    });
-});

package/dist/test/getJobDataById.test.d.ts

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

package/dist/test/getJobDataById.test.js

@@ -1,23 +0,0 @@
-"use strict";
-// sdk-triggerx/test/getJobDataById.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../src/client");
-const getJobDataById_1 = require("../src/api/getJobDataById");
-async function main() {
-    // The user should provide their actual API key here
-    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8'; // Use a mock API key
-    // Create the client with the API key
-    const client = new client_1.TriggerXClient(apiKey);
-    // Define a job ID for testing
-    const jobId = 'YOUR_JOB_ID'; // Replace with a valid job ID for testing
-    try {
-        // Call the SDK function to get job data
-        const response = await (0, getJobDataById_1.getJobDataById)(client, jobId);
-        // Log the response
-        console.log('Job Data:', response);
-    }
-    catch (error) {
-        console.error('Error fetching job data:', error);
-    }
-}
-main().catch(console.error);

package/dist/test/getUserData.test.d.ts

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

package/dist/test/getUserData.test.js

@@ -1,22 +0,0 @@
-"use strict";
-// sdk-triggerx/test/getUserData.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../src/client");
-const getUserData_1 = require("../src/api/getUserData");
-async function main() {
-    // The user should provide their actual API key here
-    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8';
-    // Create the client with the API key
-    const client = new client_1.TriggerXClient(apiKey);
-    // Specify the user address to fetch data for
-    const userAddress = 'YOUR_USER_ADDRESS'; // Replace with an actual user address for testing
-    try {
-        // Call the SDK function to get user data
-        const userData = await (0, getUserData_1.getUserData)(client, userAddress);
-        console.log('User Data:', userData);
-    }
-    catch (error) {
-        console.error('Error fetching user data:', error);
-    }
-}
-main().catch(console.error);

package/dist/test/getjob.test.d.ts

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

package/dist/test/getjob.test.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../src/client");
-const getjob_1 = require("../src/api/getjob");
-async function main() {
-    // The user should provide their actual API key here
-    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8';
-    // Create the client with the API key
-    const client = new client_1.TriggerXClient(apiKey);
-    // Call the SDK function to get job data
-    const response = await (0, getjob_1.getJobData)(client);
-    if (response.success) {
-        // Access job_data from the response
-        const jobData = response.jobs; // Use optional chaining in case job_data is undefined
-        console.log('Job Data:', jobData);
-    }
-    else {
-        console.error('Error fetching jobs:', response.error);
-    }
-}
-main().catch(console.error);

package/dist/test/testTgFunctions.d.ts

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

package/dist/test/testTgFunctions.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
-const topupTg_1 = require("../src/api/topupTg");
-const checkTgBalance_1 = require("../src/api/checkTgBalance");
-const withdrawTg_1 = require("../src/api/withdrawTg");
-async function main() {
-    // Replace with your actual provider URL and private key
-    const providerUrl = 'https://opt-sepolia.g.alchemy.com/v2/m7cIDXzatSUYoiuE1xSY_TnUrK5j9-1W';
-    const privateKey = ''; // Replace with your private key
-    const provider = new ethers_1.ethers.JsonRpcProvider(providerUrl);
-    const signer = new ethers_1.ethers.Wallet(privateKey, provider);
-    // Test the checkTgBalance function
-    try {
-        const balance = await (0, checkTgBalance_1.checkTgBalance)(signer);
-        console.log('TG Balance:', balance);
-    }
-    catch (error) {
-        console.error('Error checking TG balance:', error);
-    }
-    // Test the topupTg function
-    const tgAmountToTopup = 1; // Amount of TG to purchase
-    try {
-        const txTopup = await (0, topupTg_1.topupTg)(tgAmountToTopup, signer);
-        console.log('Topup Transaction:', txTopup);
-    }
-    catch (error) {
-        console.error('Error during topup:', error);
-    }
-    // Test the checkTgBalance function
-    try {
-        const balance = await (0, checkTgBalance_1.checkTgBalance)(signer);
-        console.log('TG Balance:', balance);
-    }
-    catch (error) {
-        console.error('Error checking TG balance:', error);
-    }
-    // Test the withdrawTg function
-    const tgAmountToWithdraw = '1'; // Amount of TG to withdraw
-    try {
-        const txWithdraw = await (0, withdrawTg_1.withdrawTg)(signer, tgAmountToWithdraw);
-        console.log('Withdraw Transaction:', txWithdraw);
-    }
-    catch (error) {
-        console.error('Error during withdrawal:', error);
-    }
-    // Test the checkTgBalance function
-    try {
-        const balance = await (0, checkTgBalance_1.checkTgBalance)(signer);
-        console.log('TG Balance:', balance);
-    }
-    catch (error) {
-        console.error('Error checking TG balance:', error);
-    }
-}
-main().catch(console.error);

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testMatch: ['**/test/**/*.test.ts'],
-  moduleFileExtensions: ['ts', 'js', 'json'],
-  roots: ['<rootDir>/src', '<rootDir>/test'],
-}; 

package/scripts/deploy.ts

@@ -1,9 +0,0 @@
-// scripts/deploy.ts
-// Script for deploying/testing contracts
-
-async function main() {
-  // TODO: Implement contract deployment logic
-  console.log('Deploy script placeholder');
-}
-
-main(); 

package/src/api/checkTgBalance.ts

@@ -1,27 +0,0 @@
-import { ethers } from 'ethers';
-import gasRegistryAbi from '../contracts/abi/GasRegistry.json';
-
-export const checkTgBalance = async (signer: ethers.Signer) => {
-    const gasRegistryContractAddress = process.env.GAS_REGISTRY_CONTRACT_ADDRESS as string || '0x85ea3eB894105bD7e7e2A8D34cf66C8E8163CD2a';
-    if (!gasRegistryContractAddress) {
-        throw new Error('GAS_REGISTRY_CONTRACT_ADDRESS is not set in the environment variables');
-    }
-    const contract = new ethers.Contract(gasRegistryContractAddress, gasRegistryAbi, signer);
-    const address = await signer.getAddress();
-    const balance = await contract.balances(address);
-    // balance is likely an array or object with ethSpent and TGbalance, both in wei
-    // We'll convert TGbalance from wei to ETH
-    // If balance is an array: [ethSpent, TGbalance]
-    // If balance is an object: { ethSpent, TGbalance }
-    let tgBalanceWei: bigint;
-    if (Array.isArray(balance)) {
-        tgBalanceWei = balance[1] as bigint;
-    } else if (balance && balance.TGbalance !== undefined) {
-        tgBalanceWei = balance.TGbalance as bigint;
-    } else {
-        throw new Error('Unexpected balance format');
-    }
-    const tgBalance = ethers.formatEther(tgBalanceWei);
-    console.log('tgBalanceEth', tgBalance);
-    return { tgBalanceWei, tgBalance };
-};

package/src/api/deleteJob.ts

@@ -1,22 +0,0 @@
-// sdk-triggerx/src/api/deleteJob.ts
-
-import { TriggerXClient } from '../client';
-
-export const deleteJob = async (client: TriggerXClient, jobId: string): Promise<void> => {
-  const apiKey = client.getApiKey(); // Assuming you have a method to get the API key
-
-  try {
-    await client.put<void>(
-      `api/jobs/delete/${jobId}`, {}, 
-      {
-        headers: {
-          'Content-Type': 'application/json',
-          'X-API-KEY': apiKey,
-        },
-      }
-    );
-  } catch (error) {
-    console.error('Error deleting job:', error);
-    throw error; // Rethrow the error for handling in the calling function
-  }
-};

package/src/api/getJobDataById.ts

@@ -1,24 +0,0 @@
-// sdk-triggerx/src/api/getJobDataById.ts
-
-import { TriggerXClient } from '../client';
-import { JobDataAPI } from '../types';
-
-export const getJobDataById = async (client: TriggerXClient, jobId: string): Promise<JobDataAPI> => {
-  const apiKey = client.getApiKey(); // Assuming you have a method to get the API key
-
-  try {
-    const response = await client.get<JobDataAPI>(
-        `/api/jobs/${jobId}`, 
-        {
-            headers: {
-                'Content-Type': 'application/json',
-                'X-API-KEY': apiKey,
-            },
-        }
-    );
-    return response; // Assuming the response data matches the JobDataAPI interface
-  } catch (error) {
-    console.error('Error fetching job data by ID:', error);
-    throw error; // Rethrow the error for handling in the calling function
-  }
-};

package/src/api/getUserData.ts

@@ -1,24 +0,0 @@
-// sdk-triggerx/src/api/getUserData.ts
-
-import { TriggerXClient } from '../client';
-import { UserData } from '../types';
-
-export const getUserData = async (client: TriggerXClient, address: string): Promise<UserData> => {
-  const apiKey = client.getApiKey(); // Assuming you have a method to get the API key
-
-  try {
-    const response = await client.get<UserData>(
-      `api/users/${address}`, 
-      {
-        headers: {
-          'Content-Type': 'application/json',
-          'X-API-KEY': apiKey,
-        },
-      }
-    );
-    return response; // Assuming the response data matches the UserData interface
-  } catch (error) {
-    console.error('Error fetching user data:', error);
-    throw error; // Rethrow the error for handling in the calling function
-  }
-};

package/src/api/getjob.ts

@@ -1,26 +0,0 @@
-import { TriggerXClient } from '../client';
-import { JobResponseUser, JobResponseAPI } from '../types';
-
-/**
- * Fetch job data for a given API key by calling the backend endpoint.
- * @param client TriggerXClient instance
- * @returns JobResponse containing job data or error
- */
-export async function getJobData(client: TriggerXClient): Promise<JobResponseUser> {
-  try {
-
-    const apiKey = client.getApiKey(); // Assuming you have a method to get the API key
-    const data = await client.get<JobResponseUser>(
-      '/api/jobs/by-apikey',
-      {
-        headers: {
-          'Content-Type': 'application/json',
-          'X-API-KEY': apiKey,
-        },
-      }
-    );
-    return { success: true, jobs: data.jobs };
-  } catch (error) {
-    return { success: false, error: (error as Error).message,};
-  }
-}