SDK Quick Start

import { OfferHubSDK } from '@offerhub/sdk';

const sdk = new OfferHubSDK({
  apiUrl: process.env.OFFERHUB_API_URL,    // e.g., http://localhost:4000
  apiKey: process.env.OFFERHUB_API_KEY,    // e.g., ohk_live_xxx
  timeout: 30000,                           // Optional: request timeout (default: 30s)
  retryAttempts: 3,                         // Optional: retry count (default: 3)
});

OFFERHUB_API_URL=http://localhost:4000
OFFERHUB_API_KEY=ohk_live_your_api_key_here

const user = await sdk.users.create({
  externalUserId: 'your-user-123',
  email: 'buyer@example.com',
  type: 'BUYER'   // or 'SELLER', 'BOTH'
});

console.log('User ID:', user.id);  // usr_abc123

const balance = await sdk.balance.get(user.id);

console.log('Available:', balance.available);  // "100.00"
console.log('Reserved:', balance.reserved);    // "0.00"

const order = await sdk.orders.create({
  buyer_id: 'usr_buyer123',
  seller_id: 'usr_seller456',
  amount: '100.00',
  currency: 'USD',
  title: 'Logo Design',
  description: 'Design a logo for my startup'
});

console.log('Order ID:', order.id);      // ord_xyz789
console.log('Status:', order.status);    // ORDER_CREATED

const milestones = await sdk.orders.getMilestones(order.id);

const completedMilestone = await sdk.orders.completeMilestone(order.id, 'design');
console.log('Milestone status:', completedMilestone.status); // COMPLETED

// 1. Reserve funds
await sdk.orders.reserve(order.id);

// 2. Create escrow on blockchain
await sdk.orders.createEscrow(order.id);

// 3. Fund the escrow
await sdk.orders.fundEscrow(order.id);

// 4. Release to seller when work is done
await sdk.orders.release(order.id, 'Work completed');

// Create SDK instance with idempotency key
const idempotentSdk = sdk.withIdempotencyKey(
  '550e8400-e29b-41d4-a716-446655440000'
);

// This request can be safely retried
const order = await idempotentSdk.orders.create({
  buyer_id: 'usr_buyer',
  seller_id: 'usr_seller',
  amount: '100.00',
  title: 'Service'
});

import {
  InsufficientFundsError,
  NotFoundError,
  ValidationError,
  InvalidTransitionError,
  OfferHubError
} from '@offerhub/sdk';

try {
  await sdk.orders.reserve('ord_123');
} catch (error) {
  if (error instanceof InsufficientFundsError) {
    console.error(`Need ${error.required}, have ${error.available}`);
  } else if (error instanceof NotFoundError) {
    console.error(`${error.resourceType} not found`);
  } else if (error instanceof ValidationError) {
    console.error('Validation errors:', error.errors);
  } else if (error instanceof InvalidTransitionError) {
    console.error(`Cannot transition from ${error.currentState}`);
  } else if (error instanceof OfferHubError) {
    console.error('API error:', error.message);
  }
}

import type { User, Order, Balance } from '@offerhub/sdk';

async function processOrder(user: User): Promise<Order> {
  const balance: Balance = await sdk.balance.get(user.id);

  if (parseFloat(balance.available) < 100) {
    throw new Error('Insufficient funds');
  }

  return sdk.orders.create({
    buyerId: user.id,
    sellerId: 'usr_seller',
    amount: '100.00',
    title: 'Service'
  });
}