sdk-triggerx 0.1.1 → 0.1.3

package/README.md

@@ -31,11 +31,10 @@ npm install sdk-triggerx
 import { TriggerXClient } from 'sdk-triggerx';
 
 const client = new TriggerXClient('YOUR_API_KEY');
-
-//👉 To get your API key, visit: [https://app.triggerx.network/generate-api](https://app.triggerx.network/generate-api)
-
 ```
 
+- To get your API key, visit: [Generate API Key](https://app.triggerx.network/generate-api)
+
 ---
 
 ### 2. Create a Job
@@ -51,6 +50,16 @@ const client = new TriggerXClient('YOUR_API_KEY');
 - `ArgType.Static`: Hardcoded values
 - `ArgType.Dynamic`: Runtime values fetched from a script
 
+#### Supported Condition Types (for `conditionType`)
+
+- `greater_than`
+- `less_than`
+- `between`
+- `equals`
+- `not_equals`
+- `greater_equal`
+- `less_equal`
+
 ---
 
 #### 🕒 Example: Time-based Static Job
@@ -59,27 +68,26 @@ const client = new TriggerXClient('YOUR_API_KEY');
 import { createJob, JobType, ArgType } from 'sdk-triggerx';
 
 const jobInput = {
-  jobType: JobType.Time,
-  argType: ArgType.Static,
-  jobTitle: 'My Time Job',
-  timeFrame: 36,
-  scheduleType: 'interval',
-  timeInterval: 33,
-  cronExpression: '0 0 * * *',
-  specificSchedule: '2025-01-01 00:00:00',
-  timezone: 'Asia/Calcutta',
-  recurring: false,
-  jobCostPrediction: 0.1,
-  createdChainId: '11155420',
-  targetChainId: '11155420',
-  targetContractAddress: '0x...',
-  targetFunction: 'incrementBy',
-  abi: '[...]',
-  isImua: true,
-  arguments: ['3'],
-  dynamicArgumentsScriptUrl: '',
-  // if more TG needed auto top-up TG must true for automatially top up TG
-  autotopupTG: true,
+  jobType: JobType.Time,               // Job type discriminator
+  argType: ArgType.Static,             // Static or Dynamic arguments
+
+  jobTitle: 'My Time Job',             // Human-readable job title
+  timeFrame: 36,                       // Duration the job stays active (seconds)
+  scheduleType: 'interval',            // 'interval' | 'cron' | 'specific'
+  timeInterval: 33,                    // Required if scheduleType = 'interval' (seconds)
+  // cronExpression: '0 0 * * *',      // Required if scheduleType = 'cron' (CRON string)
+  // specificSchedule: '2025-01-01 00:00:00', // Required if scheduleType = 'specific' (datetime)
+  timezone: 'Asia/Calcutta',           // IANA timezone for scheduling
+
+  chainId: '11155420',                 // EVM chain for creation/target
+  targetContractAddress: '0x...',      // Target contract to call
+  targetFunction: 'incrementBy',       // Target function name
+  abi: '[...]',                        // JSON ABI string for target contract
+
+  isImua: false,                        // Optional feature flag
+  arguments: ['3'],                    // Target function args as strings
+  dynamicArgumentsScriptUrl: '',       // If ArgType.Dynamic, provide IPFS/URL here
+  autotopupTG: true,                   // Auto top-up TG if balance is low
 };
 
 const signer = /* ethers.Signer instance */;
@@ -93,25 +101,27 @@ console.log(result);
 
 ```ts
 const jobInput = {
-  jobType: JobType.Event,
-  argType: ArgType.Dynamic,
-  jobTitle: 'My Event Job',
-  timeFrame: 36,
-  recurring: true,
-  jobCostPrediction: 0.2,
-  timezone: 'Asia/Calcutta',
-  createdChainId: '11155420',
-  triggerChainId: '11155420',
-  triggerContractAddress: '0x...',
-  triggerEvent: 'CounterIncremented',
-  targetChainId: '11155420',
-  targetContractAddress: '0x...',
-  targetFunction: 'incrementBy',
-  abi: '[...]',
-  arguments: [],
-  dynamicArgumentsScriptUrl: 'https://your-ipfs-url',
-  isImua: true,
-  autotopupTG: true,
+  jobType: JobType.Event,                // Job type discriminator
+  argType: ArgType.Dynamic,              // Dynamic arguments fetched via script
+
+  jobTitle: 'My Event Job',              // Human-readable job title
+  timeFrame: 36,                         // Duration the job stays active (seconds)
+  recurring: true,                       // Whether the event job recurs
+  timezone: 'Asia/Calcutta',             // IANA timezone (for metadata)
+
+  chainId: '11155420',                   // EVM chain for creation/target
+  triggerChainId: '11155420',            // Chain where the event is emitted
+  triggerContractAddress: '0x...',       // Event-emitting contract address
+  triggerEvent: 'CounterIncremented',    // Event name to watch
+
+  targetContractAddress: '0x...',        // Target contract to call
+  targetFunction: 'incrementBy',         // Target function name
+  abi: '[...]',                          // JSON ABI for target contract
+
+  arguments: [],                         // Target function args as strings
+  dynamicArgumentsScriptUrl: 'https://your-ipfs-url', // Script URL for dynamic args
+  isImua: false,                          // Optional feature flag
+  autotopupTG: true,                     // Auto top-up TG if balance is low
 };
 
 const result = await createJob(client, { jobInput, signer });
@@ -124,27 +134,29 @@ console.log(result);
 
 ```ts
 const jobInput = {
-  jobType: JobType.Condition,
-  argType: ArgType.Static,
-  jobTitle: 'My Condition Job',
-  timeFrame: 36,
-  recurring: false,
-  jobCostPrediction: 0.3,
-  timezone: 'Asia/Calcutta',
-  createdChainId: '11155420',
-  conditionType: 'greaterThan',
-  upperLimit: 100,
-  lowerLimit: 10,
-  valueSourceType: 'api',
-  valueSourceUrl: 'https://api.example.com/value',
-  targetChainId: '11155420',
-  targetContractAddress: '0x...',
-  targetFunction: 'incrementBy',
-  abi: '[...]',
-  arguments: ['5'],
-  dynamicArgumentsScriptUrl: '',
-  isImua: true,
-  autotopupTG: true,
+  jobType: JobType.Condition,           // Job type discriminator
+  argType: ArgType.Static,              // Static arguments
+
+  jobTitle: 'My Condition Job',         // Human-readable job title
+  timeFrame: 36,                        // Duration the job stays active (seconds)
+  recurring: false,                     // Whether the condition job recurs
+  timezone: 'Asia/Calcutta',            // IANA timezone (for metadata)
+
+  chainId: '11155420',                  // EVM chain for creation/target
+  conditionType: 'greater_than',        // One of the supported condition types 'greater_than' | 'less_than' |'between' | 'equals' | 'not_equals' | 'greater_equal' | 'less_equal'
+  upperLimit: 100,                      // Upper threshold
+  lowerLimit: 10,                       // Lower threshold
+  valueSourceType: 'api',               // 'api'
+  valueSourceUrl: 'https://api.example.com/value', // Source URL for condition
+
+  targetContractAddress: '0x...',       // Target contract to call
+  targetFunction: 'incrementBy',        // Target function name
+  abi: '[...]',                         // JSON ABI for target contract
+
+  arguments: ['5'],                     // Target function args as strings
+  dynamicArgumentsScriptUrl: '',        // If ArgType.Dynamic, provide IPFS/URL here
+  isImua: false,                         // Optional feature flag
+  autotopupTG: true,                    // Auto top-up TG if balance is low
 };
 
 const result = await createJob(client, { jobInput, signer });
@@ -216,22 +228,6 @@ Includes:
 
 ---
 
-## 🗂️ Project Structure
-
-```
-sdk-triggerx/
-├── index.ts              # Entry point
-├── client.ts             # Axios client wrapper
-├── config.ts             # Config and environment loader
-├── types.ts              # Shared interfaces and enums
-├── api/                  # Backend API modules
-├── contracts/            # Contract logic and ABIs
-├── utils/                # Error and helper utilities
-├── test/                 # Unit/integration tests
-└── scripts/              # Example/test scripts
-```
-
----
 
 ## ✅ Requirements
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdk-triggerx",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "SDK for interacting with the TriggerX backend and smart contracts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/jobs.ts

@@ -19,6 +19,7 @@ export function toCreateJobDataFromTime(
   input: TimeBasedJobInput,
   balances: { etherBalance: bigint; tokenBalanceWei: bigint },
   userAddress: string,
+  jobCostPrediction: number,
 ): CreateJobData {
   return {
     job_id: JOB_ID,
@@ -29,15 +30,15 @@ export function toCreateJobDataFromTime(
     task_definition_id: input.dynamicArgumentsScriptUrl ? 2 : 1,
     custom: true,
     time_frame: input.timeFrame,
-    recurring: input.recurring ?? false,
-    job_cost_prediction: input.jobCostPrediction,
+    recurring: false,
+    job_cost_prediction: jobCostPrediction,
     timezone: input.timezone,
-    created_chain_id: input.createdChainId,
+    created_chain_id: input.chainId,
     schedule_type: input.scheduleType,
-    time_interval: input.timeInterval,
-    cron_expression: input.cronExpression,
-    specific_schedule: input.specificSchedule,
-    target_chain_id: input.targetChainId,
+    time_interval: input.scheduleType === 'interval' ? input.timeInterval : undefined,
+    cron_expression: input.scheduleType === 'cron' ? input.cronExpression : undefined,
+    specific_schedule: input.scheduleType === 'specific' ? input.specificSchedule : undefined,
+    target_chain_id: input.chainId,
     target_contract_address: input.targetContractAddress,
     target_function: input.targetFunction,
     abi: input.abi,
@@ -52,6 +53,7 @@ export function toCreateJobDataFromEvent(
   input: EventBasedJobInput,
   balances: { etherBalance: bigint; tokenBalanceWei: bigint },
   userAddress: string,
+  jobCostPrediction: number,
 ): CreateJobData {
   return {
     job_id: JOB_ID,
@@ -63,13 +65,13 @@ export function toCreateJobDataFromEvent(
     custom: true,
     time_frame: input.timeFrame,
     recurring: input.recurring ?? false,
-    job_cost_prediction: input.jobCostPrediction,
+    job_cost_prediction: jobCostPrediction,
     timezone: input.timezone,
-    created_chain_id: input.createdChainId,
-    trigger_chain_id: input.triggerChainId,
+    created_chain_id: input.chainId,
+    trigger_chain_id: (input as any).triggerChainId ?? input.chainId,
     trigger_contract_address: input.triggerContractAddress,
     trigger_event: input.triggerEvent,
-    target_chain_id: input.targetChainId,
+    target_chain_id: input.chainId,
     target_contract_address: input.targetContractAddress,
     target_function: input.targetFunction,
     abi: input.abi,
@@ -84,6 +86,7 @@ export function toCreateJobDataFromCondition(
   input: ConditionBasedJobInput,
   balances: { etherBalance: bigint; tokenBalanceWei: bigint },
   userAddress: string,
+  jobCostPrediction: number,
 ): CreateJobData {
   return {
     job_id: JOB_ID,
@@ -95,15 +98,15 @@ export function toCreateJobDataFromCondition(
     custom: true,
     time_frame: input.timeFrame,
     recurring: input.recurring ?? false,
-    job_cost_prediction: input.jobCostPrediction,
+    job_cost_prediction: jobCostPrediction,
     timezone: input.timezone,
-    created_chain_id: input.createdChainId,
+    created_chain_id: input.chainId,
     condition_type: input.conditionType,
     upper_limit: input.upperLimit,
     lower_limit: input.lowerLimit,
     value_source_type: input.valueSourceType,
     value_source_url: input.valueSourceUrl,
-    target_chain_id: input.targetChainId,
+    target_chain_id: input.chainId,
     target_contract_address: input.targetContractAddress,
     target_function: input.targetFunction,
     abi: input.abi,
@@ -171,6 +174,19 @@ export async function createJob(
   if ('timeFrame' in jobInput) timeFrame = jobInput.timeFrame;
   if ('targetContractAddress' in jobInput) targetContractAddress = jobInput.targetContractAddress;
 
+  // Validate schedule-specific fields for time-based jobs
+  if ('scheduleType' in jobInput) {
+    if (jobInput.scheduleType === 'interval' && (jobInput.timeInterval === undefined || jobInput.timeInterval === null)) {
+      throw new Error('timeInterval is required when scheduleType is interval');
+    }
+    if (jobInput.scheduleType === 'cron' && !jobInput.cronExpression) {
+      throw new Error('cronExpression is required when scheduleType is cron');
+    }
+    if (jobInput.scheduleType === 'specific' && !jobInput.specificSchedule) {
+      throw new Error('specificSchedule is required when scheduleType is specific');
+    }
+  }
+
   // Infer jobType from jobInput
   if ('scheduleType' in jobInput) {
     jobType = jobInput.dynamicArgumentsScriptUrl ? 2 : 1; // Time-based job
@@ -207,6 +223,7 @@ export async function createJob(
       }
     }
   }
+
   // Handle job_cost_prediction logic based on argType (static/dynamic)
   // If static, set to 0.1. If dynamic, call backend API to get fee and ask user to proceed.
 
@@ -299,11 +316,11 @@ export async function createJob(
   let jobData: CreateJobData;
   const balances = { etherBalance, tokenBalanceWei };
   if ('scheduleType' in jobInput) {
-    jobData = toCreateJobDataFromTime(jobInput as TimeBasedJobInput, balances, userAddress);
+    jobData = toCreateJobDataFromTime(jobInput as TimeBasedJobInput, balances, userAddress, job_cost_prediction);
   } else if ('triggerChainId' in jobInput) {
-    jobData = toCreateJobDataFromEvent(jobInput as EventBasedJobInput, balances, userAddress);
+    jobData = toCreateJobDataFromEvent(jobInput as EventBasedJobInput, balances, userAddress, job_cost_prediction);
   } else {
-    jobData = toCreateJobDataFromCondition(jobInput as ConditionBasedJobInput, balances, userAddress);
+    jobData = toCreateJobDataFromCondition(jobInput as ConditionBasedJobInput, balances, userAddress, job_cost_prediction);
   }
   // 3. Set the job_id from contract
   jobData.job_id = jobId;

package/src/types.ts

@@ -33,14 +33,12 @@ export interface TimeBasedJobInput {
   jobTitle: string;
   timeFrame: number;
   scheduleType: 'cron' | 'specific' | 'interval';
-  timeInterval?: number;
-  cronExpression?: string;
-  specificSchedule?: string;
+  timeInterval?: number; // required only if scheduleType === 'interval'
+  cronExpression?: string; // required only if scheduleType === 'cron'
+  specificSchedule?: string; // required only if scheduleType === 'specific'
   timezone: string;
-  recurring?: boolean;
-  jobCostPrediction: number;
-  createdChainId: string;
-  targetChainId: string;
+  // recurring removed for time-based jobs; always false
+  chainId: string; // single chain input; used for created/target
   targetContractAddress: string;
   targetFunction: string;
   abi: string;
@@ -58,9 +56,7 @@ export interface EventBasedJobInput {
   triggerEvent: string;
   timezone: string;
   recurring?: boolean;
-  jobCostPrediction: number;
-  createdChainId: string;
-  targetChainId: string;
+  chainId: string; // used for created/trigger/target chains
   targetContractAddress: string;
   targetFunction: string;
   abi: string;
@@ -73,16 +69,14 @@ export interface EventBasedJobInput {
 export interface ConditionBasedJobInput {
   jobTitle: string;
   timeFrame: number;
-  conditionType: string;
+  conditionType: 'greater_than' | 'less_than' | 'between' | 'equals' | 'not_equals' | 'greater_equal' | 'less_equal';
   upperLimit: number;
   lowerLimit: number;
   valueSourceType: string;
   valueSourceUrl: string;
   timezone: string;
   recurring?: boolean;
-  jobCostPrediction: number;
-  createdChainId: string;
-  targetChainId: string;
+  chainId: string; // used for created/target chains
   targetContractAddress: string;
   targetFunction: string;
   abi: string;

package/test/createJobExample.ts

@@ -4,7 +4,7 @@ import { ethers } from 'ethers';
 
 async function main() {
 
-    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8';
+    const apiKey = '';
     const client = new TriggerXClient(apiKey);
 
     // Example: Time-based static job
@@ -18,10 +18,7 @@ async function main() {
         cronExpression: '0 0 * * *',
         specificSchedule: '2025-01-01 00:00:00',
         timezone: 'Asia/Calcutta',
-        recurring: false,
-        jobCostPrediction: 0.1,
-        createdChainId: '11155420',
-        targetChainId: '11155420',
+        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"}]',
@@ -34,7 +31,6 @@ async function main() {
     // const jobInput: CreateJobInput = {
     //     jobType: JobType.Condition,
     //     argType: ArgType.Static,
-    //     userAddress: '0x7Db951c0E6D8906687B459427eA3F3F2b456473A',
     //     jobTitle: 'SDK Test Condition Job',
     //     timeFrame: 48,
     //     conditionType: 'greaterThan',
@@ -44,9 +40,7 @@ async function main() {
     //     valueSourceUrl: 'https://api.example.com/value',
     //     timezone: 'Asia/Calcutta',
     //     recurring: false,
-    //     jobCostPrediction: 0.1,
-    //     createdChainId: '11155420',
-    //     targetChainId: '11155420',
+    //     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"}]',
@@ -63,8 +57,8 @@ async function main() {
     // console.log('Condition Job creation result:', conditionResult);
 
     // These would typically come from env/config/user input
-    const privateKey = '3bd66a68dcde6ede3b38ced6de79489a447e0fac1648b749a5001b0aa167d089';
-    const providerUrl = 'https://opt-sepolia.g.alchemy.com/v2/m7cIDXzatSUYoiuE1xSY_TnUrK5j9-1W';
+    const privateKey = '';
+    const providerUrl = '';
     const provider = new ethers.JsonRpcProvider(providerUrl);
     const signer = new ethers.Wallet(privateKey, provider);