sdk-triggerx 0.1.0 → 0.1.2

package/README.md

@@ -33,6 +33,8 @@ import { TriggerXClient } from 'sdk-triggerx';
 const client = new TriggerXClient('YOUR_API_KEY');
 ```
 
+- To get your API key, visit: [Generate API Key](https://app.triggerx.network/generate-api)
+
 ---
 
 ### 2. Create a Job
@@ -58,9 +60,6 @@ import { createJob, JobType, ArgType } from 'sdk-triggerx';
 const jobInput = {
   jobType: JobType.Time,
   argType: ArgType.Static,
-  userAddress: '0x...',
-  etherBalance: 10000000000000000,
-  tokenBalance: 10000000000000000000,
   jobTitle: 'My Time Job',
   timeFrame: 36,
   scheduleType: 'interval',
@@ -78,6 +77,8 @@ const jobInput = {
   isImua: true,
   arguments: ['3'],
   dynamicArgumentsScriptUrl: '',
+  // if more TG needed auto top-up TG must true for automatially top up TG
+  autotopupTG: true,
 };
 
 const signer = /* ethers.Signer instance */;
@@ -93,9 +94,6 @@ console.log(result);
 const jobInput = {
   jobType: JobType.Event,
   argType: ArgType.Dynamic,
-  userAddress: '0x...',
-  etherBalance: 10000000000000000,
-  tokenBalance: 10000000000000000000,
   jobTitle: 'My Event Job',
   timeFrame: 36,
   recurring: true,
@@ -112,6 +110,7 @@ const jobInput = {
   arguments: [],
   dynamicArgumentsScriptUrl: 'https://your-ipfs-url',
   isImua: true,
+  autotopupTG: true,
 };
 
 const result = await createJob(client, { jobInput, signer });
@@ -126,9 +125,6 @@ console.log(result);
 const jobInput = {
   jobType: JobType.Condition,
   argType: ArgType.Static,
-  userAddress: '0x...',
-  etherBalance: 10000000000000000,
-  tokenBalance: 10000000000000000000,
   jobTitle: 'My Condition Job',
   timeFrame: 36,
   recurring: false,
@@ -147,6 +143,7 @@ const jobInput = {
   arguments: ['5'],
   dynamicArgumentsScriptUrl: '',
   isImua: true,
+  autotopupTG: true,
 };
 
 const result = await createJob(client, { jobInput, signer });

package/package.json

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

package/src/api/checkTgBalance.ts

@@ -13,15 +13,15 @@ export const checkTgBalance = async (signer: ethers.Signer) => {
     // We'll convert TGbalance from wei to ETH
     // If balance is an array: [ethSpent, TGbalance]
     // If balance is an object: { ethSpent, TGbalance }
-    let tgBalanceWei;
+    let tgBalanceWei: bigint;
     if (Array.isArray(balance)) {
-        tgBalanceWei = balance[1];
+        tgBalanceWei = balance[1] as bigint;
     } else if (balance && balance.TGbalance !== undefined) {
-        tgBalanceWei = balance.TGbalance;
+        tgBalanceWei = balance.TGbalance as bigint;
     } else {
         throw new Error('Unexpected balance format');
     }
-    const tgBalanceEth = ethers.formatEther(tgBalanceWei);
-    console.log('tgBalanceEth', tgBalanceEth);
-    return tgBalanceEth;
+    const tgBalance = ethers.formatEther(tgBalanceWei);
+    console.log('tgBalanceEth', tgBalance);
+    return { tgBalanceWei, tgBalance };
 };

package/src/api/jobs.ts

@@ -15,12 +15,16 @@ const JOB_ID = '3009495282496655901782243134420405284093052736340975530671528358
 const DYNAMIC_ARGS_URL = 'https://teal-random-koala-993.mypinata.cloud/ipfs/bafkreif426p7t7takzhw3g6we2h6wsvf27p5jxj3gaiynqf22p3jvhx4la';
 const JOB_REGISTRY_ADDRESS = '0xdB66c11221234C6B19cCBd29868310c31494C21C'; // Set your fixed contract address here
 
-export function toCreateJobDataFromTime(input: TimeBasedJobInput): CreateJobData {
+export function toCreateJobDataFromTime(
+  input: TimeBasedJobInput,
+  balances: { etherBalance: bigint; tokenBalanceWei: bigint },
+  userAddress: string,
+): CreateJobData {
   return {
     job_id: JOB_ID,
-    user_address: input.userAddress,
-    ether_balance: input.etherBalance,
-    token_balance: input.tokenBalance,
+    user_address: userAddress,
+    ether_balance: balances.etherBalance,
+    token_balance: balances.tokenBalanceWei,
     job_title: input.jobTitle,
     task_definition_id: input.dynamicArgumentsScriptUrl ? 2 : 1,
     custom: true,
@@ -44,12 +48,16 @@ export function toCreateJobDataFromTime(input: TimeBasedJobInput): CreateJobData
   };
 }
 
-export function toCreateJobDataFromEvent(input: EventBasedJobInput): CreateJobData {
+export function toCreateJobDataFromEvent(
+  input: EventBasedJobInput,
+  balances: { etherBalance: bigint; tokenBalanceWei: bigint },
+  userAddress: string,
+): CreateJobData {
   return {
     job_id: JOB_ID,
-    user_address: input.userAddress,
-    ether_balance: input.etherBalance,
-    token_balance: input.tokenBalance,
+    user_address: userAddress,
+    ether_balance: balances.etherBalance,
+    token_balance: balances.tokenBalanceWei,
     job_title: input.jobTitle,
     task_definition_id: input.dynamicArgumentsScriptUrl ? 4 : 3,
     custom: true,
@@ -72,12 +80,16 @@ export function toCreateJobDataFromEvent(input: EventBasedJobInput): CreateJobDa
   };
 }
 
-export function toCreateJobDataFromCondition(input: ConditionBasedJobInput): CreateJobData {
+export function toCreateJobDataFromCondition(
+  input: ConditionBasedJobInput,
+  balances: { etherBalance: bigint; tokenBalanceWei: bigint },
+  userAddress: string,
+): CreateJobData {
   return {
     job_id: JOB_ID,
-    user_address: input.userAddress,
-    ether_balance: input.etherBalance,
-    token_balance: input.tokenBalance,
+    user_address: userAddress,
+    ether_balance: balances.etherBalance,
+    token_balance: balances.tokenBalanceWei,
     job_title: input.jobTitle,
     task_definition_id: input.dynamicArgumentsScriptUrl ? 6 : 5,
     custom: true,
@@ -152,6 +164,8 @@ export async function createJob(
   // Use the API key from the client instance
   const apiKey = client.getApiKey();
 
+  const userAddress = await signer.getAddress();
+
   let jobTitle: string, timeFrame: number, targetContractAddress: string, jobType: number;
   if ('jobTitle' in jobInput) jobTitle = jobInput.jobTitle;
   if ('timeFrame' in jobInput) timeFrame = jobInput.timeFrame;
@@ -249,7 +263,7 @@ export async function createJob(
     // If you want to automate, you can add a `proceed` flag to params in the future.
 
     // Check if the user has enough TG to cover the job cost prediction
-    const tgBalance = await checkTgBalance(signer);
+    const { tgBalanceWei, tgBalance } = await checkTgBalance(signer);
     if (Number(tgBalance) < job_cost_prediction) {
       // Check if user has enabled auto topup
       // For each job type, autotopupTG should be present in jobInput
@@ -258,9 +272,15 @@ export async function createJob(
         throw new Error(`Insufficient TG balance. Job cost prediction is ${job_cost_prediction}. Current TG balance: ${tgBalance}. Please set autotopupTG: true in jobInput.`);
       } else {
         // autotopupTG is true, automatically top up
-        await topupTg(job_cost_prediction, signer);
+        const requiredTG = Math.ceil(job_cost_prediction * 1000); // 1 TG = 0.001 ETH
+        await topupTg(requiredTG, signer);
       }
-    } 
+    }
+
+  // Compute balances to store with the job
+  const tokenBalanceWei = tgBalanceWei;
+  const etherBalance = tokenBalanceWei / 1000n;
+
   // Patch jobInput with job_cost_prediction for downstream usage
   (jobInput as any).jobCostPrediction = job_cost_prediction;
 
@@ -277,21 +297,29 @@ export async function createJob(
 
   // 2. Convert input to CreateJobData
   let jobData: CreateJobData;
+  const balances = { etherBalance, tokenBalanceWei };
   if ('scheduleType' in jobInput) {
-    jobData = toCreateJobDataFromTime(jobInput as TimeBasedJobInput);
+    jobData = toCreateJobDataFromTime(jobInput as TimeBasedJobInput, balances, userAddress);
   } else if ('triggerChainId' in jobInput) {
-    jobData = toCreateJobDataFromEvent(jobInput as EventBasedJobInput);
+    jobData = toCreateJobDataFromEvent(jobInput as EventBasedJobInput, balances, userAddress);
   } else {
-    jobData = toCreateJobDataFromCondition(jobInput as ConditionBasedJobInput);
+    jobData = toCreateJobDataFromCondition(jobInput as ConditionBasedJobInput, balances, userAddress);
   }
   // 3. Set the job_id from contract
   jobData.job_id = jobId;
 
   // 4. Call the API
   try {
+    // Ensure JSON-serializable payload (use numbers for balances)
+    const jobDataForApi = {
+      ...jobData,
+      ether_balance: typeof jobData.ether_balance === 'bigint' ? Number(jobData.ether_balance) : Number(jobData.ether_balance),
+      token_balance: typeof jobData.token_balance === 'bigint' ? Number(jobData.token_balance) : Number(jobData.token_balance),
+    } as any;
+
     const res = await client.post<any>(
       '/api/jobs',
-      [jobData],
+      [jobDataForApi],
       {
         headers: { 'Content-Type': 'application/json', 'X-API-KEY': apiKey },
       }

package/src/client.ts

@@ -9,7 +9,7 @@ export class TriggerXClient {
     this.apiKey = apiKey; // Initialize the apiKey
     const baseConfig = getConfig();
     this.client = axios.create({
-      baseURL: config?.baseURL || baseConfig.apiUrl || 'http://localhost:9002',
+      baseURL: config?.baseURL || baseConfig.apiUrl || 'http://localhost:9002',  //http://localhost:9002 , https://data.triggerx.network
       headers: { 'Authorization': `Bearer ${this.apiKey}` }, // Set the API key here
       ...config,
     });

package/src/types.ts

@@ -30,9 +30,6 @@ export type CreateJobInput =
 
 // User-facing input types (without jobType/argType)
 export interface TimeBasedJobInput {
-  userAddress: string;
-  etherBalance: BigInt | number;
-  tokenBalance: BigInt | number;
   jobTitle: string;
   timeFrame: number;
   scheduleType: 'cron' | 'specific' | 'interval';
@@ -54,9 +51,6 @@ export interface TimeBasedJobInput {
 }
 
 export interface EventBasedJobInput {
-  userAddress: string;
-  etherBalance: BigInt | number;
-  tokenBalance: BigInt | number;
   jobTitle: string;
   timeFrame: number;
   triggerChainId: string;
@@ -77,9 +71,6 @@ export interface EventBasedJobInput {
 }
 
 export interface ConditionBasedJobInput {
-  userAddress: string;
-  etherBalance: BigInt | number;
-  tokenBalance: BigInt | number;
   jobTitle: string;
   timeFrame: number;
   conditionType: string;
@@ -199,6 +190,7 @@ export interface EventJobData {
   trigger_chain_id: string;
   trigger_contract_address: string;
   trigger_event: string;
+  timezone: string;
   target_chain_id: string;
   target_contract_address: string;
   target_function: string;
@@ -218,10 +210,11 @@ export interface ConditionJobData {
   updated_at: Date; // Assuming time.Time is represented as Date
   recurring: boolean;
   condition_type: string;
-  upper_limit: number; // Assuming float64 is represented as number
-  lower_limit: number; // Assuming float64 is represented as number
+  upper_limit: number;
+  lower_limit: number;
   value_source_type: string;
   value_source_url: string;
+  timezone: string;
   target_chain_id: string;
   target_contract_address: string;
   target_function: string;

package/test/createJobExample.ts

@@ -4,16 +4,13 @@ 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
     const jobInput: CreateJobInput = {
         jobType: JobType.Time,
         argType: ArgType.Static,
-        userAddress: '0x7Db951c0E6D8906687B459427eA3F3F2b456473B',
-        etherBalance: 50000000000000000,
-        tokenBalance: 50000000000000000000,
         jobTitle: 'SDK Test Time Job',
         timeFrame: 36,
         scheduleType: 'interval',
@@ -37,9 +34,6 @@ async function main() {
     // const jobInput: CreateJobInput = {
     //     jobType: JobType.Condition,
     //     argType: ArgType.Static,
-    //     userAddress: '0x7Db951c0E6D8906687B459427eA3F3F2b456473B',
-    //     etherBalance: 50000000000000000,
-    //     tokenBalance: 50000000000000000000,
     //     jobTitle: 'SDK Test Condition Job',
     //     timeFrame: 48,
     //     conditionType: 'greaterThan',
@@ -68,8 +62,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);