openbroker 1.3.1 → 1.4.0

package/dist/operations/limit-order.js

@@ -0,0 +1,144 @@
+#!/usr/bin/env npx tsx
+// Execute a limit order on Hyperliquid
+import { getClient } from '../core/client.js';
+import { formatUsd, parseArgs } from '../core/utils.js';
+function printUsage() {
+    console.log(`
+Open Broker - Limit Order
+=========================
+
+Place a limit order with specified price.
+
+Usage:
+  npx tsx scripts/operations/limit-order.ts --coin <COIN> --side <buy|sell> --size <SIZE> --price <PRICE>
+
+Options:
+  --coin      Asset to trade (e.g., ETH, BTC)
+  --side      Order side: buy or sell
+  --size      Order size in base asset
+  --price     Limit price
+  --tif       Time in force: GTC, IOC, or ALO (default: GTC)
+              GTC = Good Till Cancel (rests on book)
+              IOC = Immediate Or Cancel (fills or cancels)
+              ALO = Add Liquidity Only (post-only, maker only)
+  --leverage  Set leverage (e.g., 10 for 10x). Cross for main perps, isolated for HIP-3
+  --reduce    Reduce-only order (default: false)
+  --dry       Dry run - show order details without executing
+
+Examples:
+  npx tsx scripts/operations/limit-order.ts --coin ETH --side buy --size 1 --price 3000
+  npx tsx scripts/operations/limit-order.ts --coin BTC --side sell --size 0.1 --price 100000 --tif ALO
+  npx tsx scripts/operations/limit-order.ts --coin SOL --side buy --size 10 --price 150 --reduce
+`);
+}
+async function main() {
+    const args = parseArgs(process.argv.slice(2));
+    // Parse and validate arguments
+    const coin = args.coin;
+    const side = args.side;
+    const size = parseFloat(args.size);
+    const price = parseFloat(args.price);
+    const tifArg = args.tif?.toUpperCase() || 'GTC';
+    const leverage = args.leverage ? parseInt(args.leverage) : undefined;
+    const reduceOnly = args.reduce;
+    const dryRun = args.dry;
+    if (!coin || !side || isNaN(size) || isNaN(price)) {
+        printUsage();
+        process.exit(1);
+    }
+    if (side !== 'buy' && side !== 'sell') {
+        console.error('Error: --side must be "buy" or "sell"');
+        process.exit(1);
+    }
+    if (size <= 0) {
+        console.error('Error: --size must be positive');
+        process.exit(1);
+    }
+    if (price <= 0) {
+        console.error('Error: --price must be positive');
+        process.exit(1);
+    }
+    // Map uppercase CLI input to Pascal case for SDK
+    const tifMap = {
+        'GTC': 'Gtc',
+        'IOC': 'Ioc',
+        'ALO': 'Alo'
+    };
+    const tif = tifMap[tifArg];
+    if (!tif) {
+        console.error(`Error: --tif must be one of: GTC, IOC, ALO`);
+        process.exit(1);
+    }
+    const isBuy = side === 'buy';
+    const client = getClient();
+    console.log('Open Broker - Limit Order');
+    console.log('=========================\n');
+    try {
+        // Get current price for reference
+        const mids = await client.getAllMids();
+        const midPrice = parseFloat(mids[coin]);
+        if (!midPrice) {
+            console.error(`Error: No market data for ${coin}`);
+            process.exit(1);
+        }
+        const notional = price * size;
+        const distanceFromMid = ((price - midPrice) / midPrice) * 100;
+        console.log('Order Details');
+        console.log('-------------');
+        console.log(`Coin:           ${coin}`);
+        console.log(`Side:           ${isBuy ? 'BUY' : 'SELL'}`);
+        console.log(`Size:           ${size}`);
+        console.log(`Limit Price:    ${formatUsd(price)}`);
+        console.log(`Current Mid:    ${formatUsd(midPrice)}`);
+        console.log(`Distance:       ${distanceFromMid >= 0 ? '+' : ''}${distanceFromMid.toFixed(2)}% from mid`);
+        console.log(`Notional:       ${formatUsd(notional)}`);
+        console.log(`Time in Force:  ${tif}`);
+        console.log(`Reduce Only:    ${reduceOnly ? 'Yes' : 'No'}`);
+        if (leverage)
+            console.log(`Leverage:       ${leverage}x`);
+        console.log(`Builder Fee:    ${client.builderInfo.f / 10} bps`);
+        // Warning if order would be aggressively priced
+        if ((isBuy && price > midPrice) || (!isBuy && price < midPrice)) {
+            console.log(`\n⚠️  Order is priced aggressively - may fill immediately as taker`);
+        }
+        if (dryRun) {
+            console.log('\n🔍 Dry run - order not submitted');
+            return;
+        }
+        console.log('\nSubmitting...');
+        const response = await client.limitOrder(coin, isBuy, size, price, tif, reduceOnly, leverage);
+        console.log('\nResult');
+        console.log('------');
+        if (response.status === 'ok' && response.response && typeof response.response !== 'string') {
+            const statuses = response.response.data.statuses;
+            for (const status of statuses) {
+                if (status.filled) {
+                    const fillSz = parseFloat(status.filled.totalSz);
+                    const avgPx = parseFloat(status.filled.avgPx);
+                    const fillNotional = fillSz * avgPx;
+                    console.log(`✅ Filled`);
+                    console.log(`   Order ID:  ${status.filled.oid}`);
+                    console.log(`   Size:      ${fillSz}`);
+                    console.log(`   Avg Price: ${formatUsd(avgPx)}`);
+                    console.log(`   Notional:  ${formatUsd(fillNotional)}`);
+                }
+                else if (status.resting) {
+                    console.log(`✅ Order placed`);
+                    console.log(`   Order ID:  ${status.resting.oid}`);
+                    console.log(`   Status:    Resting on book`);
+                }
+                else if (status.error) {
+                    console.log(`❌ Error: ${status.error}`);
+                }
+            }
+        }
+        else {
+            console.log(`❌ Error: ${response.error || 'Unknown error'}`);
+        }
+    }
+    catch (error) {
+        console.error('Error submitting order:', error);
+        process.exit(1);
+    }
+}
+main();

package/dist/operations/market-order.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env npx tsx
+export {};
+//# sourceMappingURL=market-order.d.ts.map

package/dist/operations/market-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"market-order.d.ts","sourceRoot":"","sources":["../../scripts/operations/market-order.ts"],"names":[],"mappings":""}

package/dist/operations/market-order.js

@@ -0,0 +1,153 @@
+#!/usr/bin/env npx tsx
+// Execute a market order on Hyperliquid
+import { getClient } from '../core/client.js';
+import { formatUsd, parseArgs, checkBuilderFeeApproval } from '../core/utils.js';
+function printUsage() {
+    console.log(`
+Open Broker - Market Order
+==========================
+
+Execute a market order with slippage protection.
+
+Usage:
+  npx tsx scripts/operations/market-order.ts --coin <COIN> --side <buy|sell> --size <SIZE>
+
+Options:
+  --coin      Asset to trade (e.g., ETH, BTC)
+  --side      Order side: buy or sell
+  --size      Order size in base asset
+  --slippage  Slippage tolerance in bps (default: from config, usually 50 = 0.5%)
+  --leverage  Set leverage (e.g., 10 for 10x). Cross for main perps, isolated for HIP-3
+  --reduce    Reduce-only order (default: false)
+  --dry       Dry run - show order details without executing
+  --verbose   Show full API request/response for debugging
+
+Environment:
+  HYPERLIQUID_PRIVATE_KEY  Your wallet private key (0x...)
+  HYPERLIQUID_NETWORK      "mainnet" or "testnet" (default: mainnet)
+  VERBOSE=1                Enable verbose logging
+
+Examples:
+  npx tsx scripts/operations/market-order.ts --coin ETH --side buy --size 0.1
+  npx tsx scripts/operations/market-order.ts --coin BTC --side sell --size 0.01 --slippage 100
+  npx tsx scripts/operations/market-order.ts --coin SOL --side buy --size 10 --dry
+  npx tsx scripts/operations/market-order.ts --coin ETH --side buy --size 0.1 --verbose
+`);
+}
+async function main() {
+    const args = parseArgs(process.argv.slice(2));
+    // Parse and validate arguments
+    const coin = args.coin;
+    const side = args.side;
+    const size = parseFloat(args.size);
+    const slippage = args.slippage ? parseInt(args.slippage) : undefined;
+    const leverage = args.leverage ? parseInt(args.leverage) : undefined;
+    const reduceOnly = args.reduce;
+    const dryRun = args.dry;
+    if (!coin || !side || isNaN(size)) {
+        printUsage();
+        process.exit(1);
+    }
+    if (side !== 'buy' && side !== 'sell') {
+        console.error('Error: --side must be "buy" or "sell"');
+        process.exit(1);
+    }
+    if (size <= 0) {
+        console.error('Error: --size must be positive');
+        process.exit(1);
+    }
+    const isBuy = side === 'buy';
+    const client = getClient();
+    // Enable verbose mode if requested
+    if (args.verbose) {
+        client.verbose = true;
+    }
+    console.log('Open Broker - Market Order');
+    console.log('==========================\n');
+    // Check builder fee approval (warning only, don't block)
+    await checkBuilderFeeApproval(client);
+    try {
+        // Get current price
+        const mids = await client.getAllMids();
+        const midPrice = parseFloat(mids[coin]);
+        if (!midPrice) {
+            console.error(`Error: No market data for ${coin}`);
+            process.exit(1);
+        }
+        // Calculate order details
+        const slippageBps = slippage ?? 50;
+        const slippageMultiplier = slippageBps / 10000;
+        const limitPrice = isBuy
+            ? midPrice * (1 + slippageMultiplier)
+            : midPrice * (1 - slippageMultiplier);
+        const notional = midPrice * size;
+        console.log('Order Details');
+        console.log('-------------');
+        console.log(`Coin:         ${coin}`);
+        console.log(`Side:         ${isBuy ? 'BUY' : 'SELL'}`);
+        console.log(`Size:         ${size}`);
+        console.log(`Mid Price:    ${formatUsd(midPrice)}`);
+        console.log(`Limit Price:  ${formatUsd(limitPrice)} (${slippageBps} bps slippage)`);
+        console.log(`Notional:     ~${formatUsd(notional)}`);
+        console.log(`Reduce Only:  ${reduceOnly ? 'Yes' : 'No'}`);
+        if (leverage)
+            console.log(`Leverage:     ${leverage}x`);
+        console.log(`Builder Fee:  ${client.builderInfo.f / 10} bps`);
+        if (dryRun) {
+            console.log('\n🔍 Dry run - order not submitted');
+            return;
+        }
+        console.log('\nExecuting...');
+        const response = await client.marketOrder(coin, isBuy, size, slippage, leverage);
+        console.log('\nResult');
+        console.log('------');
+        // Log full response for debugging
+        if (args.verbose || process.env.VERBOSE) {
+            console.log('\nFull Response:');
+            console.log(JSON.stringify(response, null, 2));
+        }
+        if (response.status === 'ok' && response.response && typeof response.response === 'object') {
+            const statuses = response.response.data.statuses;
+            for (const status of statuses) {
+                if (status.filled) {
+                    const fillSz = parseFloat(status.filled.totalSz);
+                    const avgPx = parseFloat(status.filled.avgPx);
+                    const fillNotional = fillSz * avgPx;
+                    const slippageActual = isBuy
+                        ? (avgPx - midPrice) / midPrice
+                        : (midPrice - avgPx) / midPrice;
+                    console.log(`✅ Filled`);
+                    console.log(`   Order ID:  ${status.filled.oid}`);
+                    console.log(`   Size:      ${fillSz}`);
+                    console.log(`   Avg Price: ${formatUsd(avgPx)}`);
+                    console.log(`   Notional:  ${formatUsd(fillNotional)}`);
+                    console.log(`   Slippage:  ${(slippageActual * 10000).toFixed(1)} bps`);
+                }
+                else if (status.resting) {
+                    console.log(`⏳ Resting (partial fill)`);
+                    console.log(`   Order ID:  ${status.resting.oid}`);
+                }
+                else if (status.error) {
+                    console.log(`❌ Error: ${status.error}`);
+                }
+                else {
+                    // Unknown status - show the whole thing
+                    console.log(`⚠️  Unknown status:`);
+                    console.log(JSON.stringify(status, null, 2));
+                }
+            }
+        }
+        else if (response.status === 'err') {
+            console.log(`❌ API Error: ${response.response || JSON.stringify(response)}`);
+        }
+        else {
+            console.log(`❌ Unexpected response:`);
+            console.log(JSON.stringify(response, null, 2));
+        }
+    }
+    catch (error) {
+        console.error('Error executing order:', error);
+        process.exit(1);
+    }
+}
+main();

package/dist/operations/outcome-order.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env npx tsx
+export {};
+//# sourceMappingURL=outcome-order.d.ts.map

package/dist/operations/outcome-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outcome-order.d.ts","sourceRoot":"","sources":["../../scripts/operations/outcome-order.ts"],"names":[],"mappings":""}

package/dist/operations/outcome-order.js

@@ -0,0 +1,171 @@
+#!/usr/bin/env npx tsx
+// Execute a HIP-4 outcome order on Hyperliquid
+import { getClient } from '../core/client.js';
+import { checkBuilderFeeApproval, formatUsd, parseArgs } from '../core/utils.js';
+function printUsage() {
+    console.log(`
+Open Broker - HIP-4 Outcome Order
+=================================
+
+Buy or sell a YES/NO outcome token.
+
+Usage:
+  openbroker outcome-order --outcome <id|#encoding|+encoding> --outcome-side <yes|no> --side <buy|sell> --size <SIZE>
+
+Options:
+  --outcome        Outcome id, outcome spot coin (#1230), or token name (+1230)
+  --outcome-side   Outcome side when --outcome is a plain id: yes/no or 0/1 (default: yes)
+  --side           Trade side: buy or sell
+  --size           Order size in outcome token units
+  --price          Limit price between 0.001 and 0.999 (omit for market IOC)
+  --tif            Time-in-force for limit orders: Gtc, Ioc, Alo (default: Gtc)
+  --slippage       Slippage tolerance in bps for market orders (default: config, usually 50)
+  --sz-decimals    Override size decimals if outcome metadata omits token decimals
+  --dry            Dry run - show order details without executing
+  --verbose        Show full API request/response for debugging
+
+Examples:
+  openbroker outcomes --query BTC
+  openbroker outcome-order --outcome 123 --outcome-side yes --side buy --size 10 --dry
+  openbroker outcome-buy --outcome 123 --outcome-side no --size 5 --price 0.42
+  openbroker outcome-sell --outcome #1230 --size 10
+`);
+}
+function formatOutcomePrice(price) {
+    return price.toFixed(4);
+}
+async function main() {
+    const args = parseArgs(process.argv.slice(2));
+    if (args.help || args.h) {
+        printUsage();
+        process.exit(0);
+    }
+    const outcomeRef = args.outcome;
+    const outcomeSide = args['outcome-side'];
+    const side = args.side;
+    const size = parseFloat(args.size);
+    const price = args.price ? parseFloat(args.price) : undefined;
+    const tif = args.tif ?? 'Gtc';
+    const slippage = args.slippage ? parseInt(args.slippage) : undefined;
+    const szDecimals = args['sz-decimals'] ? parseInt(args['sz-decimals'], 10) : undefined;
+    const dryRun = args.dry;
+    if (!outcomeRef || !side || isNaN(size)) {
+        printUsage();
+        process.exit(1);
+    }
+    if (side !== 'buy' && side !== 'sell') {
+        console.error('Error: --side must be "buy" or "sell"');
+        process.exit(1);
+    }
+    if (size <= 0) {
+        console.error('Error: --size must be positive');
+        process.exit(1);
+    }
+    if (price !== undefined && (price <= 0 || price >= 1)) {
+        console.error('Error: --price must be between 0 and 1 for outcome tokens');
+        process.exit(1);
+    }
+    if (szDecimals !== undefined && (szDecimals < 0 || szDecimals > 8)) {
+        console.error('Error: --sz-decimals must be between 0 and 8');
+        process.exit(1);
+    }
+    const client = getClient();
+    if (args.verbose)
+        client.verbose = true;
+    const isBuy = side === 'buy';
+    const isMarket = price === undefined;
+    console.log('Open Broker - HIP-4 Outcome Order');
+    console.log('=================================\n');
+    await checkBuilderFeeApproval(client);
+    try {
+        const resolved = client.resolveOutcomeRef(outcomeRef, outcomeSide);
+        const market = await client.getOutcomeMarket(resolved.outcome);
+        const marketSide = market?.sides.find((s) => s.side === resolved.side);
+        const sideName = marketSide?.name ?? (resolved.side === 0 ? 'Yes' : 'No');
+        const midPrice = await client.getOutcomeMidPrice(resolved.outcome, resolved.side);
+        const slippageBps = slippage ?? 50;
+        const limitPrice = isMarket
+            ? (isBuy ? midPrice * (1 + slippageBps / 10000) : midPrice * (1 - slippageBps / 10000))
+            : price;
+        const notional = midPrice * size;
+        console.log('Order Details');
+        console.log('-------------');
+        console.log(`Outcome:      ${resolved.outcome}`);
+        console.log(`Market:       ${market?.name ?? 'Unknown'}${market?.parsedDescription.underlying ? ` (${market.parsedDescription.underlying})` : ''}`);
+        if (market?.parsedDescription.expiry)
+            console.log(`Expiry:       ${market.parsedDescription.expiry}`);
+        if (market?.parsedDescription.targetPrice)
+            console.log(`Target:       ${market.parsedDescription.targetPrice}`);
+        console.log(`Outcome Side: ${sideName.toUpperCase()} (${resolved.side})`);
+        console.log(`Coin:         ${resolved.coin}`);
+        console.log(`Asset ID:     ${resolved.assetId}`);
+        console.log(`Trade Side:   ${isBuy ? 'BUY' : 'SELL'}`);
+        console.log(`Size:         ${size}`);
+        console.log(`Mid Price:    ${formatOutcomePrice(midPrice)}`);
+        if (isMarket) {
+            console.log(`Type:         Market (IOC)`);
+            console.log(`Limit Price:  ${formatOutcomePrice(limitPrice)} (${slippageBps} bps slippage)`);
+        }
+        else {
+            console.log(`Type:         Limit (${tif})`);
+            console.log(`Limit Price:  ${formatOutcomePrice(price)}`);
+        }
+        console.log(`Notional:     ~${formatUsd(notional)}`);
+        if (marketSide?.szDecimals !== undefined || szDecimals !== undefined) {
+            console.log(`Sz Decimals:  ${szDecimals ?? marketSide?.szDecimals}`);
+        }
+        console.log(`Builder Fee:  ${client.builderInfo.f / 10} bps`);
+        if (dryRun) {
+            console.log('\nDry run - order not submitted');
+            return;
+        }
+        console.log('\nExecuting...');
+        const response = isMarket
+            ? await client.outcomeMarketOrder(outcomeRef, outcomeSide, isBuy, size, slippage, szDecimals)
+            : await client.outcomeLimitOrder(outcomeRef, outcomeSide, isBuy, size, price, tif, szDecimals);
+        console.log('\nResult');
+        console.log('------');
+        if (args.verbose || process.env.VERBOSE) {
+            console.log('\nFull Response:');
+            console.log(JSON.stringify(response, null, 2));
+        }
+        if (response.status === 'ok' && response.response && typeof response.response === 'object') {
+            const statuses = response.response.data.statuses;
+            for (const status of statuses) {
+                if (status.filled) {
+                    const fillSz = parseFloat(status.filled.totalSz);
+                    const avgPx = parseFloat(status.filled.avgPx);
+                    console.log('Filled');
+                    console.log(`   Order ID:  ${status.filled.oid}`);
+                    console.log(`   Size:      ${fillSz}`);
+                    console.log(`   Avg Price: ${formatOutcomePrice(avgPx)}`);
+                    console.log(`   Notional:  ${formatUsd(fillSz * avgPx)}`);
+                }
+                else if (status.resting) {
+                    console.log('Resting');
+                    console.log(`   Order ID:  ${status.resting.oid}`);
+                }
+                else if (status.error) {
+                    console.log(`Error: ${status.error}`);
+                }
+                else {
+                    console.log('Unknown status:');
+                    console.log(JSON.stringify(status, null, 2));
+                }
+            }
+        }
+        else if (response.status === 'err') {
+            console.log(`API Error: ${response.response || JSON.stringify(response)}`);
+        }
+        else {
+            console.log('Unexpected response:');
+            console.log(JSON.stringify(response, null, 2));
+        }
+    }
+    catch (error) {
+        console.error('Error executing outcome order:', error);
+        console.error('Note: Hyperliquid currently documents outcomeMeta as testnet-only.');
+        process.exit(1);
+    }
+}
+main();

package/dist/operations/scale.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env npx tsx
+export {};
+//# sourceMappingURL=scale.d.ts.map

package/dist/operations/scale.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scale.d.ts","sourceRoot":"","sources":["../../scripts/operations/scale.ts"],"names":[],"mappings":""}