sdk-triggerx 0.1.0

package/src/contracts/index.ts

@@ -0,0 +1 @@
+export * from './TriggerXContract'; 

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './client';
+export * from './config';
+export * from './types';
+export * from './api/jobs';
+export { createJobOnChain } from './contracts/JobRegistry';
+export * from './contracts';
+export * from './utils/errors'; 

package/src/types.ts

@@ -0,0 +1,262 @@
+export interface Task {
+  id: string;
+  name: string;
+  status: 'pending' | 'completed' | 'failed';
+  createdAt: string;
+}
+
+export interface ApiResponse<T> {
+  data: T;
+  error?: string;
+}
+
+// Enums for job type and argument type
+export enum JobType {
+  Time = 'time',
+  Event = 'event',
+  Condition = 'condition',
+}
+
+export enum ArgType {
+  Static = 'static',
+  Dynamic = 'dynamic',
+}
+
+// Discriminated union for job input
+export type CreateJobInput =
+  | (TimeBasedJobInput & { jobType: JobType.Time; argType: ArgType.Static | ArgType.Dynamic })
+  | (EventBasedJobInput & { jobType: JobType.Event; argType: ArgType.Static | ArgType.Dynamic })
+  | (ConditionBasedJobInput & { jobType: JobType.Condition; argType: ArgType.Static | ArgType.Dynamic });
+
+// 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';
+  timeInterval?: number;
+  cronExpression?: string;
+  specificSchedule?: string;
+  timezone: string;
+  recurring?: boolean;
+  jobCostPrediction: number;
+  createdChainId: string;
+  targetChainId: string;
+  targetContractAddress: string;
+  targetFunction: string;
+  abi: string;
+  isImua?: boolean;
+  arguments?: string[];
+  dynamicArgumentsScriptUrl?: string;
+  autotopupTG?: boolean;
+}
+
+export interface EventBasedJobInput {
+  userAddress: string;
+  etherBalance: BigInt | number;
+  tokenBalance: BigInt | number;
+  jobTitle: string;
+  timeFrame: number;
+  triggerChainId: string;
+  triggerContractAddress: string;
+  triggerEvent: string;
+  timezone: string;
+  recurring?: boolean;
+  jobCostPrediction: number;
+  createdChainId: string;
+  targetChainId: string;
+  targetContractAddress: string;
+  targetFunction: string;
+  abi: string;
+  isImua?: boolean;
+  arguments?: string[];
+  dynamicArgumentsScriptUrl?: string;
+  autotopupTG?: boolean;
+}
+
+export interface ConditionBasedJobInput {
+  userAddress: string;
+  etherBalance: BigInt | number;
+  tokenBalance: BigInt | number;
+  jobTitle: string;
+  timeFrame: number;
+  conditionType: string;
+  upperLimit: number;
+  lowerLimit: number;
+  valueSourceType: string;
+  valueSourceUrl: string;
+  timezone: string;
+  recurring?: boolean;
+  jobCostPrediction: number;
+  createdChainId: string;
+  targetChainId: string;
+  targetContractAddress: string;
+  targetFunction: string;
+  abi: string;
+  isImua?: boolean;
+  arguments?: string[];
+  dynamicArgumentsScriptUrl?: string;
+  autotopupTG?: boolean;
+}
+
+// Internal type matching backend struct
+export interface CreateJobData {
+  job_id: string;
+  user_address: string;
+  ether_balance: BigInt | number;
+  token_balance: BigInt | number;
+  job_title: string;
+  task_definition_id: number;
+  custom: boolean;
+  time_frame: number;
+  recurring: boolean;
+  job_cost_prediction: number;
+  timezone: string;
+  created_chain_id: string;
+  schedule_type?: string;
+  time_interval?: number;
+  cron_expression?: string;
+  specific_schedule?: string;
+  trigger_chain_id?: string;
+  trigger_contract_address?: string;
+  trigger_event?: string;
+  condition_type?: string;
+  upper_limit?: number;
+  lower_limit?: number;
+  value_source_type?: string;
+  value_source_url?: string;
+  target_chain_id: string;
+  target_contract_address: string;
+  target_function: string;
+  abi: string;
+  arg_type: number;
+  arguments?: string[];
+  dynamic_arguments_script_url?: string;
+  is_imua: boolean;
+}
+
+export interface JobResponse {
+  success: boolean;
+  data?: any;
+  error?: string;
+}
+
+// Types matching backend JobResponseAPI
+export interface JobDataAPI {
+  job_id: string; // Assuming BigIntString is represented as a string in TypeScript
+  job_title: string;
+  task_definition_id: number;
+  user_id: number; // Assuming int64 is represented as number
+  link_job_id: string; // Assuming BigIntString is represented as a string
+  chain_status: number;
+  custom: boolean;
+  time_frame: number; // Assuming int64 is represented as number
+  recurring: boolean;
+  status: string;
+  job_cost_prediction: number;
+  job_cost_actual: number;
+  task_ids: number[]; // Assuming []int64 is represented as number[]
+  created_at: Date; // Assuming time.Time is represented as Date
+  updated_at: Date; // Assuming time.Time is represented as Date
+  last_executed_at: Date; // Assuming time.Time is represented as Date
+  timezone: string;
+  is_imua: boolean;
+  created_chain_id: string;
+}
+
+export interface TimeJobData {
+  job_id: string; // Assuming *big.Int is represented as string
+  task_definition_id: number;
+  expiration_time: Date; // Assuming time.Time is represented as Date
+  created_at: Date; // Assuming time.Time is represented as Date
+  updated_at: Date; // Assuming time.Time is represented as Date
+  time_interval: number; // Assuming int64 is represented as number
+  schedule_type: string;
+  cron_expression: string;
+  specific_schedule: string;
+  timezone: string;
+  next_execution_timestamp: Date; // Assuming time.Time is represented as Date
+  target_chain_id: string;
+  target_contract_address: string;
+  target_function: string;
+  abi: string;
+  arg_type: number;
+  arguments: string[];
+  dynamic_arguments_script_url: string;
+  is_completed: boolean;
+  is_active: boolean;
+}
+
+export interface EventJobData {
+  job_id: string; // Assuming *big.Int is represented as string
+  task_definition_id: number;
+  expiration_time: Date; // Assuming time.Time is represented as Date
+  created_at: Date; // Assuming time.Time is represented as Date
+  updated_at: Date; // Assuming time.Time is represented as Date
+  recurring: boolean;
+  trigger_chain_id: string;
+  trigger_contract_address: string;
+  trigger_event: string;
+  target_chain_id: string;
+  target_contract_address: string;
+  target_function: string;
+  abi: string;
+  arg_type: number;
+  arguments: string[];
+  dynamic_arguments_script_url: string;
+  is_completed: boolean;
+  is_active: boolean;
+}
+
+export interface ConditionJobData {
+  job_id: string; // Assuming *big.Int is represented as string
+  task_definition_id: number;
+  expiration_time: Date; // Assuming time.Time is represented as Date
+  created_at: Date; // Assuming time.Time is represented as Date
+  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
+  value_source_type: string;
+  value_source_url: string;
+  target_chain_id: string;
+  target_contract_address: string;
+  target_function: string;
+  abi: string;
+  arg_type: number;
+  arguments: string[];
+  dynamic_arguments_script_url: string;
+  is_completed: boolean;
+  is_active: boolean;
+}
+
+export interface JobResponseUser {
+  success: boolean;
+  error?: string;
+  jobs?: JobResponseAPI
+}
+
+export interface JobResponseAPI {
+  job_data?: JobDataAPI;
+  time_job_data?: TimeJobData;
+  event_job_data?: EventJobData;
+  condition_job_data?: ConditionJobData;
+}
+
+// New interface for user data response
+export interface UserData {
+  user_id: number; // Assuming int64 is represented as number
+  user_address: string;
+  job_ids: string[]; // Assuming job IDs are represented as strings
+  ether_balance: BigInt | number;
+  token_balance: BigInt | number;
+  user_points: number;
+  total_jobs: number; // Assuming int64 is represented as number
+  total_tasks: number; // Assuming int64 is represented as number
+  created_at: Date; // Assuming time.Time is represented as Date
+  last_updated_at: Date; // Assuming time.Time is represented as Date
+  email: string; // Assuming email_id is represented as string
+}

package/src/utils/errors.ts

@@ -0,0 +1,13 @@
+export class TriggerXError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'TriggerXError';
+  }
+}
+
+export function wrapError(error: unknown): TriggerXError {
+  if (error instanceof Error) {
+    return new TriggerXError(error.message);
+  }
+  return new TriggerXError('Unknown error');
+} 

package/test/createJobExample.ts

@@ -0,0 +1,84 @@
+import { TriggerXClient, createJob } from '../src';
+import { JobType, ArgType, CreateJobInput } from '../src/types';
+import { ethers } from 'ethers';
+
+async function main() {
+
+    const apiKey = 'TGRX-ece02db8-f676-4a9f-a4f8-a95f59e755d8';
+    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',
+        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: '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: ['3'],
+        dynamicArgumentsScriptUrl: '',
+    };
+
+    // // Example: Condition-based static job
+    // const jobInput: CreateJobInput = {
+    //     jobType: JobType.Condition,
+    //     argType: ArgType.Static,
+    //     userAddress: '0x7Db951c0E6D8906687B459427eA3F3F2b456473B',
+    //     etherBalance: 50000000000000000,
+    //     tokenBalance: 50000000000000000000,
+    //     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,
+    //     jobCostPrediction: 0.1,
+    //     createdChainId: '11155420',
+    //     targetChainId: '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: '',
+    // };
+
+    // 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 = '3bd66a68dcde6ede3b38ced6de79489a447e0fac1648b749a5001b0aa167d089';
+    const providerUrl = 'https://opt-sepolia.g.alchemy.com/v2/m7cIDXzatSUYoiuE1xSY_TnUrK5j9-1W';
+    const provider = new ethers.JsonRpcProvider(providerUrl);
+    const signer = new ethers.Wallet(privateKey, provider);
+
+
+    const result = await createJob(client, {
+        jobInput,
+        signer,
+    });
+    console.log('Job creation result:', result);
+}
+
+main().catch(console.error);

package/test/deleteJob.test.ts

@@ -0,0 +1,25 @@
+// sdk-triggerx/test/deleteJob.test.ts
+
+import { TriggerXClient } from '../src/client';
+import { deleteJob } from '../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 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 deleteJob(client, jobId);
+    console.log(`Job with ID ${jobId} deleted successfully.`);
+  } catch (error) {
+    console.error('Error deleting job:', error);
+  }
+}
+
+main().catch(console.error);

package/test/example.test.d.ts

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

package/test/example.test.js

@@ -0,0 +1,11 @@
+"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/test/example.test.ts

@@ -0,0 +1,10 @@
+import { wrapError } from '../src/utils/errors';
+
+describe('wrapError', () => {
+  it('should wrap a standard error', () => {
+    const err = new Error('fail');
+    const wrapped = wrapError(err);
+    expect(wrapped).toBeInstanceOf(Error);
+    expect(wrapped.message).toBe('fail');
+  });
+}); 

package/test/getJobDataById.test.ts

@@ -0,0 +1,27 @@
+// sdk-triggerx/test/getJobDataById.test.ts
+
+import { TriggerXClient } from '../src/client';
+import { getJobDataById } from '../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 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 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/test/getUserData.test.ts

@@ -0,0 +1,25 @@
+// sdk-triggerx/test/getUserData.test.ts
+
+import { TriggerXClient } from '../src/client';
+import { getUserData } from '../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 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 getUserData(client, userAddress);
+    console.log('User Data:', userData);
+  } catch (error) {
+    console.error('Error fetching user data:', error);
+  }
+}
+
+main().catch(console.error);

package/test/getjob.test.ts

@@ -0,0 +1,23 @@
+import { TriggerXClient } from '../src/client';
+import { getJobData } from '../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 TriggerXClient(apiKey);
+
+  // Call the SDK function to get job data
+  const response = await 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/test/testTgFunctions.ts

@@ -0,0 +1,56 @@
+import { ethers } from 'ethers';
+import { topupTg } from '../src/api/topupTg';
+import { checkTgBalance } from '../src/api/checkTgBalance';
+import { withdrawTg } from '../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.JsonRpcProvider(providerUrl);
+    const signer = new ethers.Wallet(privateKey, provider);
+
+    // Test the checkTgBalance function
+    try {
+        const balance = await 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 topupTg(tgAmountToTopup, signer);
+        console.log('Topup Transaction:', txTopup);
+    } catch (error) {
+        console.error('Error during topup:', error);
+    }
+
+    // Test the checkTgBalance function
+    try {
+        const balance = await 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 withdrawTg(signer, tgAmountToWithdraw);
+        console.log('Withdraw Transaction:', txWithdraw);
+    } catch (error) {
+        console.error('Error during withdrawal:', error);
+    }
+
+     // Test the checkTgBalance function
+     try {
+        const balance = await checkTgBalance(signer);
+        console.log('TG Balance:', balance);
+    } catch (error) {
+        console.error('Error checking TG balance:', error);
+    }
+}
+
+main().catch(console.error);

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": ".",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src", "test"],
+  "exclude": ["node_modules", "dist"]
+}