ironq-sdk

ironq-sdk

TypeScript SDK for the IronQ on-chain job queue on Solana.

Install

npm i ironq-sdk

Peer dependencies: @coral-xyz/anchor >= 0.30.0, @solana/web3.js >= 1.90.0

Usage

import { Program } from "@coral-xyz/anchor";
import {
  PROGRAM_ID,
  SEEDS,
  findQueuePDA,
  findVaultPDA,
  findJobPDA,
  findWorkerPDA,
  findResultPDA,
} from "ironq-sdk";
import type { QueueConfig, Job, Worker, JobResult } from "ironq-sdk";

// Derive PDAs
const [queue] = findQueuePDA(authority.publicKey);
const [vault] = findVaultPDA(queue);
const [job] = findJobPDA(queue, 0);
const [worker] = findWorkerPDA(queue, wallet.publicKey);
const [result] = findResultPDA(job);

// Fetch accounts (with Anchor program client)
const queueData: QueueConfig = await program.account.queueConfig.fetch(queue);
const jobData: Job = await program.account.job.fetch(job);

API

Constants

Export	Description
PROGRAM_ID	IronQ program ID (Devnet)
SEEDS	PDA seed constants (QUEUE, VAULT, JOB, WORKER, RESULT)

PDA Helpers

Function	Parameters	Returns
findQueuePDA	authority: PublicKey	[PublicKey, bump]
findVaultPDA	queue: PublicKey	[PublicKey, bump]
findJobPDA	queue: PublicKey, jobId: BN | number	[PublicKey, bump]
findWorkerPDA	queue: PublicKey, wallet: PublicKey	[PublicKey, bump]
findResultPDA	job: PublicKey	[PublicKey, bump]

Types

• QueueConfig — Queue configuration account
• Job — Job account (status, reward, data hash, deadline, retries)
• Worker — Worker account (stake, stats, active jobs)
• JobResult — Result account (result hash, timestamp)
• JobStatus — Union type: open | claimed | submitted | completed | disputed | expired | cancelled

Links

• GitHub
• Full Documentation
• CLI — cargo install ironq-cli
• Devnet Explorer

License

ISC