openbroker 1.0.82 → 1.0.87

package/scripts/info/funding-scan.ts

@@ -32,6 +32,7 @@ Examples:
 
 interface FundingScanResult {
   coin: string;
+  assetId: number;
   dex: string;
   hourlyRate: number;
   annualizedPct: number;
@@ -69,9 +70,14 @@ async function scanFunding(client: ReturnType<typeof getClient>, options: {
 
       // API returns HIP-3 names already prefixed (e.g., "xyz:CL")
       const coin = asset.name;
+      let assetId = isMain ? i : -1;
+      if (!isMain) {
+        try { assetId = client.getAssetIndex(coin); } catch { /* not registered */ }
+      }
 
       results.push({
         coin,
+        assetId,
         dex: dexData.dexName ?? 'main',
         hourlyRate,
         annualizedPct,

package/scripts/info/funding.ts

@@ -6,6 +6,7 @@ import { formatPercent, annualizeFundingRate, parseArgs } from '../core/utils.js
 
 interface FundingDisplay {
   coin: string;
+  assetId: number;
   hourlyRate: number;
   annualizedRate: number;
   premium: number;
@@ -38,7 +39,7 @@ async function main() {
 
       const hourlyRate = parseFloat(ctx.funding);
       const annualizedRate = annualizeFundingRate(hourlyRate);
-      const premium = parseFloat(ctx.premium);
+      const premium = parseFloat(ctx.premium ?? '0');
       const openInterest = parseFloat(ctx.openInterest);
       const markPx = parseFloat(ctx.markPx);
 
@@ -47,6 +48,7 @@ async function main() {
 
       fundingData.push({
         coin: asset.name,
+        assetId: i,
         hourlyRate,
         annualizedRate,
         premium,
@@ -84,8 +86,12 @@ async function main() {
 
           if (!showAll && openInterest < 1000) continue;
 
+          let assetId = -1;
+          try { assetId = client.getAssetIndex(coinName); } catch { /* not registered */ }
+
           fundingData.push({
             coin: coinName,
+            assetId,
             hourlyRate,
             annualizedRate,
             premium: 0,

package/scripts/info/markets.ts

@@ -6,6 +6,7 @@ import { formatUsd, parseArgs } from '../core/utils.js';
 
 interface MarketDisplay {
   coin: string;
+  assetId: number;
   markPx: number;
   oraclePx: number;
   prevDayPx: number;
@@ -47,6 +48,7 @@ async function main() {
 
       markets.push({
         coin: asset.name,
+        assetId: i,
         markPx,
         oraclePx,
         prevDayPx,
@@ -86,9 +88,12 @@ async function main() {
           const volume24h = parseFloat(ctx.dayNtlVlm);
           const openInterest = parseFloat(ctx.openInterest);
           const change24h = prevDayPx > 0 ? (markPx - prevDayPx) / prevDayPx : 0;
+          let assetId = -1;
+          try { assetId = client.getAssetIndex(coinName); } catch { /* not registered */ }
 
           markets.push({
             coin: coinName,
+            assetId,
             markPx,
             oraclePx,
             prevDayPx,

package/scripts/info/order-status.ts

@@ -11,6 +11,7 @@ Usage: openbroker order-status --oid <order-id>
 Options:
   --oid <id>          Order ID (number) or client order ID (hex string) — required
   --address <0x...>   Look up order on another account
+  --json              Output as JSON (machine-readable)
   --help, -h          Show this help
 
 Examples:
@@ -37,15 +38,23 @@ async function main() {
 
   const oid = oidArg.startsWith('0x') ? oidArg : parseInt(oidArg);
   const targetAddress = args.address as string | undefined;
+  const jsonOutput = args.json as boolean;
   const client = getClient();
   const lookupAddress = targetAddress?.toLowerCase();
 
-  console.log('Open Broker - Order Status');
-  console.log('=========================\n');
+  if (!jsonOutput) {
+    console.log('Open Broker - Order Status');
+    console.log('=========================\n');
+  }
 
   try {
     const result = await client.getOrderStatus(oid, lookupAddress);
 
+    if (jsonOutput) {
+      console.log(JSON.stringify(result, null, 2));
+      return;
+    }
+
     if (result.status === 'unknownOid') {
       console.log(`Order ${oidArg} not found`);
       return;

package/scripts/info/rate-limit.ts

@@ -9,6 +9,7 @@ function printUsage() {
 Usage: openbroker rate-limit [options]
 
 Options:
+  --json        Output as JSON (machine-readable)
   --help, -h    Show this help
 
 Examples:
@@ -24,14 +25,22 @@ async function main() {
     process.exit(0);
   }
 
+  const jsonOutput = args.json as boolean;
   const client = getClient();
 
-  console.log('Open Broker - API Rate Limit');
-  console.log('===========================\n');
+  if (!jsonOutput) {
+    console.log('Open Broker - API Rate Limit');
+    console.log('===========================\n');
+  }
 
   try {
     const rl = await client.getUserRateLimit();
 
+    if (jsonOutput) {
+      console.log(JSON.stringify(rl, null, 2));
+      return;
+    }
+
     const used = rl.nRequestsUsed;
     const cap = rl.nRequestsCap;
     const surplus = rl.nRequestsSurplus;

package/scripts/info/search-markets.ts

@@ -7,6 +7,7 @@ interface Args {
   query: string;
   type?: 'perp' | 'spot' | 'hip3' | 'all';
   verbose?: boolean;
+  json?: boolean;
 }
 
 function parseArgs(): Args {
@@ -23,6 +24,8 @@ function parseArgs(): Args {
       }
     } else if (arg === '--verbose') {
       args.verbose = true;
+    } else if (arg === '--json') {
+      args.json = true;
     } else if (arg === '--help' || arg === '-h') {
       console.log(`
 Search Markets - Find assets across all Hyperliquid markets
@@ -32,6 +35,7 @@ Usage: npx tsx scripts/info/search-markets.ts --query <search> [options]
 Options:
   --query <search>  Search term (required) - matches coin name
   --type <type>     Filter by market type: perp, spot, hip3, or all (default: all)
+  --json            Output as JSON (machine-readable)
   --verbose         Show detailed output
   --help            Show this help
 
@@ -40,6 +44,7 @@ Examples:
   npx tsx scripts/info/search-markets.ts --query BTC        # Find all BTC markets
   npx tsx scripts/info/search-markets.ts --query ETH --type perp  # ETH perps only
   npx tsx scripts/info/search-markets.ts --query PURR --type spot # PURR spot only
+  npx tsx scripts/info/search-markets.ts --query HYPE --json      # JSON output
 `);
       process.exit(0);
     } else if (!args.query && !arg.startsWith('-')) {
@@ -85,18 +90,23 @@ async function main() {
   client.verbose = args.verbose ?? false;
 
   const query = args.query.toUpperCase();
-  console.log(`Searching for "${query}" across all markets...\n`);
+  if (!args.json) {
+    console.log(`Searching for "${query}" across all markets...\n`);
+  }
 
-  const results: Array<{
+  interface Result {
     type: 'perp' | 'spot' | 'hip3';
     provider: string;
     coin: string;
+    assetId: number;
     price: string;
     volume24h: number;
     funding?: string;
     maxLeverage?: number;
     openInterest?: string;
-  }> = [];
+  }
+
+  const results: Result[] = [];
 
   // Search main perps
   if (args.type === 'all' || args.type === 'perp') {
@@ -110,6 +120,7 @@ async function main() {
           type: 'perp',
           provider: 'Hyperliquid',
           coin: asset.name,
+          assetId: i,
           price: ctx.markPx,
           volume24h: parseFloat(ctx.dayNtlVlm),
           funding: ctx.funding,
@@ -126,7 +137,7 @@ async function main() {
       // On testnet, load specific dex if query is "dex:COIN" format
       if (args.query.includes(':')) {
         await client.loadSingleHip3Dex(args.query.split(':')[0]);
-      } else {
+      } else if (!args.json) {
         console.log('  (Testnet: HIP-3 dexes not auto-loaded. Use "dexName:COIN" to search a specific dex.)\n');
       }
     }
@@ -143,10 +154,13 @@ async function main() {
           if (!asset || !ctx) continue;
 
           if (asset.name.toUpperCase().includes(query)) {
+            let assetId = -1;
+            try { assetId = client.getAssetIndex(asset.name); } catch { /* not registered */ }
             results.push({
               type: 'hip3',
               provider: dexData.dexName || `HIP-3 DEX ${dexIdx}`,
               coin: asset.name,
+              assetId,
               price: ctx.markPx,
               volume24h: parseFloat(ctx.dayNtlVlm || '0'),
               funding: ctx.funding,
@@ -199,6 +213,7 @@ async function main() {
             type: 'spot',
             provider: 'Spot',
             coin: displayName,
+            assetId: 10000 + pair.index,
             price: ctx.markPx,
             volume24h: parseFloat(ctx.dayNtlVlm || '0'),
           });
@@ -212,20 +227,25 @@ async function main() {
   // Sort by volume
   results.sort((a, b) => b.volume24h - a.volume24h);
 
+  if (args.json) {
+    console.log(JSON.stringify(results, null, 2));
+    return;
+  }
+
   if (results.length === 0) {
     console.log(`No markets found matching "${query}"`);
     return;
   }
 
   console.log(`Found ${results.length} market(s) matching "${query}":\n`);
-  console.log('Type     Provider         Coin           Price            24h Volume    Funding (Ann.)  OI');
-  console.log('-'.repeat(100));
+  console.log('Type     Provider         Coin           AssetID    Price            24h Volume    Funding (Ann.)  OI');
+  console.log('-'.repeat(112));
 
   for (const m of results) {
     const typeStr = m.type === 'hip3' ? 'HIP-3' : m.type.charAt(0).toUpperCase() + m.type.slice(1);
     const oi = m.openInterest ? formatVolume(parseFloat(m.openInterest)) : '-';
     console.log(
-      `${typeStr.padEnd(8)} ${m.provider.padEnd(16)} ${m.coin.padEnd(14)} ${formatPrice(m.price).padStart(16)} ${formatVolume(m.volume24h).padStart(13)} ${(m.funding ? formatFunding(m.funding) : '-').padStart(14)} ${oi.padStart(10)}`
+      `${typeStr.padEnd(8)} ${m.provider.padEnd(16)} ${m.coin.padEnd(14)} ${String(m.assetId).padStart(7)}    ${formatPrice(m.price).padStart(16)} ${formatVolume(m.volume24h).padStart(13)} ${(m.funding ? formatFunding(m.funding) : '-').padStart(14)} ${oi.padStart(10)}`
     );
   }
 
@@ -245,11 +265,11 @@ async function main() {
     const perpsWithFunding = markets.filter((m) => m.funding && m.type !== 'spot');
     if (perpsWithFunding.length > 1) {
       console.log(`\n=== ${coin} Funding Comparison ===\n`);
-      console.log('Provider         Coin           Funding (Ann.)    Price');
-      console.log('-'.repeat(65));
+      console.log('Provider         Coin           AssetID    Funding (Ann.)    Price');
+      console.log('-'.repeat(78));
       for (const m of perpsWithFunding.sort((a, b) => parseFloat(b.funding!) - parseFloat(a.funding!))) {
         console.log(
-          `${m.provider.padEnd(16)} ${m.coin.padEnd(14)} ${formatFunding(m.funding!).padStart(14)}    ${formatPrice(m.price)}`
+          `${m.provider.padEnd(16)} ${m.coin.padEnd(14)} ${String(m.assetId).padStart(7)}    ${formatFunding(m.funding!).padStart(14)}    ${formatPrice(m.price)}`
         );
       }
     }

package/scripts/info/spot.ts

@@ -9,6 +9,7 @@ interface Args {
   top?: number;
   verbose?: boolean;
   address?: string;
+  json?: boolean;
 }
 
 function parseArgs(): Args {
@@ -26,6 +27,8 @@ function parseArgs(): Args {
       args.address = process.argv[++i].toLowerCase();
     } else if (arg === '--verbose') {
       args.verbose = true;
+    } else if (arg === '--json') {
+      args.json = true;
     } else if (arg === '--help' || arg === '-h') {
       console.log(`
 Spot Markets - View Hyperliquid spot markets and balances
@@ -37,6 +40,7 @@ Options:
   --balances           Show your spot token balances
   --address <0x...>    Look up another account's spot balances (with --balances)
   --top <n>            Show only top N markets by volume
+  --json               Output as JSON (machine-readable)
   --verbose            Show detailed output
   --help               Show this help
 
@@ -85,10 +89,15 @@ async function main() {
   // Show balances
   if (args.balances) {
     const lookupAddress = args.address ?? client.address;
-    console.log(`Fetching spot balances for ${lookupAddress}...\n`);
+    if (!args.json) console.log(`Fetching spot balances for ${lookupAddress}...\n`);
 
     const balances = await client.getSpotBalances(args.address);
 
+    if (args.json) {
+      console.log(JSON.stringify(balances.balances ?? [], null, 2));
+      return;
+    }
+
     if (!balances.balances || balances.balances.length === 0) {
       console.log('No spot token balances found.');
       return;
@@ -112,17 +121,20 @@ async function main() {
   }
 
   // Show markets
-  console.log('Fetching spot market data...\n');
+  if (!args.json) console.log('Fetching spot market data...\n');
 
   const spotData = await client.getSpotMetaAndAssetCtxs();
 
   interface SpotMarket {
     name: string;
     index: number;
+    assetId: number;
     price: string;
     volume24h: number;
     change24h: string;
     tokens: [number, number];
+    base?: string;
+    quote?: string;
   }
 
   const markets: SpotMarket[] = [];
@@ -155,10 +167,13 @@ async function main() {
     markets.push({
       name: pair.name,
       index: pair.index,
+      assetId: 10000 + pair.index,
       price: ctx.markPx,
       volume24h: parseFloat(ctx.dayNtlVlm || '0'),
       change24h: formatChange(ctx.markPx, ctx.prevDayPx),
       tokens: pair.tokens,
+      base: tokenNameMap.get(pair.tokens[0]),
+      quote: tokenNameMap.get(pair.tokens[1]),
     });
   }
 
@@ -168,6 +183,11 @@ async function main() {
   // Apply top filter
   const displayMarkets = args.top ? markets.slice(0, args.top) : markets;
 
+  if (args.json) {
+    console.log(JSON.stringify(displayMarkets, null, 2));
+    return;
+  }
+
   if (displayMarkets.length === 0) {
     console.log(args.coin ? `No spot markets found for "${args.coin}"` : 'No spot markets found');
     return;
@@ -180,8 +200,8 @@ async function main() {
   }
 
   console.log(`=== Spot Markets (${displayMarkets.length} total) ===\n`);
-  console.log('Pair           Price            24h Volume    24h Change   Base/Quote');
-  console.log('-'.repeat(80));
+  console.log('Pair           AssetID    Price            24h Volume    24h Change   Base/Quote');
+  console.log('-'.repeat(92));
 
   for (const m of displayMarkets) {
     const baseToken = tokenMap.get(m.tokens[0]);
@@ -189,7 +209,7 @@ async function main() {
     const pairStr = `${baseToken?.name || '?'}/${quoteToken?.name || '?'}`;
 
     console.log(
-      `${m.name.padEnd(14)} ${formatPrice(m.price).padStart(16)} ${formatVolume(m.volume24h).padStart(13)} ${m.change24h.padStart(11)}   ${pairStr}`
+      `${m.name.padEnd(14)} ${String(m.assetId).padStart(7)}    ${formatPrice(m.price).padStart(16)} ${formatVolume(m.volume24h).padStart(13)} ${m.change24h.padStart(11)}   ${pairStr}`
     );
   }
 

package/scripts/info/trades.ts

@@ -11,6 +11,7 @@ Usage: openbroker trades --coin <symbol> [options]
 Options:
   --coin <symbol>   Asset symbol (required, e.g. ETH, BTC)
   --top <n>         Show last N trades (default: 30)
+  --json            Output as JSON (machine-readable)
   --help, -h        Show this help
 
 Examples:
@@ -35,10 +36,13 @@ async function main() {
   }
 
   const top = parseInt(args.top as string) || 30;
+  const jsonOutput = args.json as boolean;
   const client = getClient();
 
-  console.log(`Open Broker - ${normalizeCoin(coin)} Recent Trades`);
-  console.log('='.repeat(40) + '\n');
+  if (!jsonOutput) {
+    console.log(`Open Broker - ${normalizeCoin(coin)} Recent Trades`);
+    console.log('='.repeat(40) + '\n');
+  }
 
   try {
     // Load metadata (needed for HIP-3 coin resolution)
@@ -53,6 +57,13 @@ async function main() {
     trades.sort((a, b) => b.time - a.time);
     trades = trades.slice(0, top);
 
+    if (jsonOutput) {
+      let assetId = -1;
+      try { assetId = client.getAssetIndex(normalizeCoin(coin)); } catch { /* noop */ }
+      console.log(JSON.stringify({ coin: normalizeCoin(coin), assetId, trades }, null, 2));
+      return;
+    }
+
     if (trades.length === 0) {
       console.log('No recent trades found');
       return;

package/scripts/operations/limit-order.ts

@@ -129,7 +129,7 @@ async function main() {
     console.log('\nResult');
     console.log('------');
 
-    if (response.status === 'ok' && response.response) {
+    if (response.status === 'ok' && response.response && typeof response.response !== 'string') {
       const statuses = response.response.data.statuses;
       for (const status of statuses) {
         if (status.filled) {

package/scripts/operations/twap-cancel.ts

@@ -49,11 +49,13 @@ async function main() {
 
     const response = await client.twapCancel(coin, twapId);
 
+    // SDK returns a success-only response shape; failures throw and are
+    // caught by the surrounding try/catch. `status` is the success literal.
     const status = response.response.data.status;
     if (typeof status === 'string' && status === 'success') {
       console.log(`\nTWAP order ${twapId} cancelled successfully.`);
-    } else if (typeof status === 'object' && 'error' in status) {
-      console.error(`\nFailed to cancel TWAP: ${status.error}`);
+    } else {
+      console.error(`\nUnexpected TWAP cancel response status: ${JSON.stringify(status)}`);
       process.exit(1);
     }
   } catch (error) {

package/scripts/operations/twap.ts

@@ -123,17 +123,15 @@ async function main() {
       leverage,
     );
 
+    // SDK's TwapOrderSuccessResponse excludes the error variant — the SDK
+    // throws on failure and the surrounding try/catch handles that. So
+    // `status` only ever carries `{ running }` here.
     const status = response.response.data.status;
-    if ('running' in status) {
-      console.log(`TWAP order placed successfully!`);
-      console.log(`TWAP ID: ${status.running.twapId}`);
-      console.log(`\nThe exchange is now executing your TWAP order over ${formatDuration(durationMinutes * 60)}.`);
-      console.log(`To cancel: openbroker twap-cancel --coin ${coin} --twap-id ${status.running.twapId}`);
-      console.log(`To check status: openbroker twap-status`);
-    } else if ('error' in status) {
-      console.error(`TWAP order failed: ${status.error}`);
-      process.exit(1);
-    }
+    console.log(`TWAP order placed successfully!`);
+    console.log(`TWAP ID: ${status.running.twapId}`);
+    console.log(`\nThe exchange is now executing your TWAP order over ${formatDuration(durationMinutes * 60)}.`);
+    console.log(`To cancel: openbroker twap-cancel --coin ${coin} --twap-id ${status.running.twapId}`);
+    console.log(`To check status: openbroker twap-status`);
   } catch (error) {
     console.error('Error:', error instanceof Error ? error.message : error);
     process.exit(1);

package/scripts/plugin/tools.ts

@@ -1385,24 +1385,21 @@ export function createTools(watcherOrCtx: PositionWatcher | null | ToolsContext)
           const midPrice = parseFloat(mids[coin]);
 
           const response = await client.twapOrder(coin, isBuy, size, durationMinutes, randomize, reduceOnly, leverage);
+          // SDK's TwapOrderSuccessResponse excludes errors; they'd throw and
+          // be caught below. Status is always `{ running }` on this branch.
           const status = response.response.data.status;
 
-          if ('running' in status) {
-            return json({
-              twapId: status.running.twapId,
-              coin,
-              side: isBuy ? 'buy' : 'sell',
-              size,
-              durationMinutes,
-              randomize,
-              reduceOnly,
-              estimatedNotional: midPrice ? midPrice * size : undefined,
-              midPrice: midPrice || undefined,
-            });
-          } else if ('error' in status) {
-            return error(status.error);
-          }
-          return error('Unexpected response');
+          return json({
+            twapId: status.running.twapId,
+            coin,
+            side: isBuy ? 'buy' : 'sell',
+            size,
+            durationMinutes,
+            randomize,
+            reduceOnly,
+            estimatedNotional: midPrice ? midPrice * size : undefined,
+            midPrice: midPrice || undefined,
+          });
         } catch (err) {
           return error(err instanceof Error ? err.message : String(err));
         }
@@ -1428,14 +1425,13 @@ export function createTools(watcherOrCtx: PositionWatcher | null | ToolsContext)
         try {
           const client = getClient();
           const response = await client.twapCancel(coin, twapId);
+          // SDK returns the success-only response; failures throw.
           const status = response.response.data.status;
 
           if (typeof status === 'string' && status === 'success') {
             return json({ cancelled: true, coin, twapId });
-          } else if (typeof status === 'object' && 'error' in status) {
-            return error(status.error);
           }
-          return error('Unexpected response');
+          return error(`Unexpected TWAP cancel status: ${JSON.stringify(status)}`);
         } catch (err) {
           return error(err instanceof Error ? err.message : String(err));
         }

package/scripts/setup/onboard.ts

@@ -387,8 +387,10 @@ Examples:
     return setupApiWallet();
   }
 
-  // Options 1 & 2: Master wallet flow
-  let privateKey: `0x${string}`;
+  // Options 1 & 2: Master wallet flow. Initialised in the branches below —
+  // the compiler can't prove the while-loop in option 2 assigns, so we use
+  // `| undefined` and narrow at use sites (`assertDefined`).
+  let privateKey: `0x${string}` | undefined;
 
   if (choice === '2') {
     // User has existing key
@@ -417,6 +419,10 @@ Examples:
     console.log('✅ New wallet created');
   }
 
+  if (!privateKey) {
+    throw new Error('Internal error: privateKey was not set by onboarding flow.');
+  }
+
   // Derive account from private key
   const account = privateKeyToAccount(privateKey);
   console.log(`\nWallet Address: ${account.address}\n`);