openbroker 1.0.33

package/bin/cli.ts

@@ -0,0 +1,170 @@
+#!/usr/bin/env node
+// Open Broker CLI - Hyperliquid trading toolkit
+
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const scriptsDir = path.resolve(__dirname, '../scripts');
+
+const commands: Record<string, { script: string; description: string }> = {
+  // Setup
+  'setup': { script: 'setup/onboard.ts', description: 'Interactive setup wizard' },
+  'onboard': { script: 'setup/onboard.ts', description: 'Interactive setup wizard' },
+  'approve-builder': { script: 'setup/approve-builder.ts', description: 'Approve builder fee' },
+
+  // Info
+  'account': { script: 'info/account.ts', description: 'View account balance and equity' },
+  'positions': { script: 'info/positions.ts', description: 'View open positions' },
+  'funding': { script: 'info/funding.ts', description: 'View funding rates' },
+  'markets': { script: 'info/markets.ts', description: 'View market data' },
+  'all-markets': { script: 'info/all-markets.ts', description: 'View all markets (perps, HIP-3, spot)' },
+  'search': { script: 'info/search-markets.ts', description: 'Search for assets across providers' },
+  'spot': { script: 'info/spot.ts', description: 'View spot markets and balances' },
+
+  // Operations
+  'buy': { script: 'operations/market-order.ts', description: 'Market buy order' },
+  'sell': { script: 'operations/market-order.ts', description: 'Market sell order' },
+  'market': { script: 'operations/market-order.ts', description: 'Market order' },
+  'limit': { script: 'operations/limit-order.ts', description: 'Limit order' },
+  'trigger': { script: 'operations/trigger-order.ts', description: 'Trigger order (TP/SL)' },
+  'tpsl': { script: 'operations/set-tpsl.ts', description: 'Set TP/SL on position' },
+  'cancel': { script: 'operations/cancel.ts', description: 'Cancel orders' },
+  'twap': { script: 'operations/twap.ts', description: 'TWAP execution' },
+  'scale': { script: 'operations/scale.ts', description: 'Scale in/out orders' },
+  'bracket': { script: 'operations/bracket.ts', description: 'Bracket order (entry + TP + SL)' },
+  'chase': { script: 'operations/chase.ts', description: 'Chase order with ALO' },
+
+  // Strategies
+  'funding-arb': { script: 'strategies/funding-arb.ts', description: 'Funding arbitrage strategy' },
+  'grid': { script: 'strategies/grid.ts', description: 'Grid trading strategy' },
+  'dca': { script: 'strategies/dca.ts', description: 'DCA strategy' },
+  'mm-spread': { script: 'strategies/mm-spread.ts', description: 'Market making (spread)' },
+  'mm-maker': { script: 'strategies/mm-maker.ts', description: 'Market making (ALO)' },
+};
+
+function printHelp() {
+  console.log(`
+Open Broker - Hyperliquid Trading CLI
+
+Usage: openbroker <command> [options]
+
+Setup Commands:
+  setup, onboard       Interactive setup wizard (generate wallet, configure)
+  approve-builder      Approve builder fee (one-time)
+
+Info Commands:
+  account              View account balance, equity, and margin
+  positions            View open positions with PnL
+  funding              View funding rates (sorted by annualized rate)
+  markets              View market data for main perps
+  all-markets          View all markets (perps, HIP-3, spot)
+  search               Search for assets across all providers
+  spot                 View spot markets and balances
+
+Trading Commands:
+  buy                  Market buy order
+  sell                 Market sell order
+  market               Market order (specify --side)
+  limit                Limit order
+  trigger              Trigger order (stop loss / take profit)
+  tpsl                 Set TP/SL on existing position
+  cancel               Cancel orders
+
+Advanced Execution:
+  twap                 Time-weighted average price execution
+  scale                Scale in/out with multiple orders
+  bracket              Entry with TP and SL
+  chase                Chase price with ALO orders
+
+Strategies:
+  funding-arb          Funding rate arbitrage
+  grid                 Grid trading
+  dca                  Dollar cost averaging
+  mm-spread            Market making (spread-based)
+  mm-maker             Market making (ALO orders)
+
+Options:
+  --help, -h           Show help for a command
+  --dry                Preview without executing
+  --verbose            Show debug output
+
+Examples:
+  openbroker setup                              # First-time setup
+  openbroker account                            # View account info
+  openbroker buy --coin ETH --size 0.1          # Market buy 0.1 ETH
+  openbroker limit --coin BTC --side buy --size 0.01 --price 60000
+  openbroker search --query GOLD                # Find GOLD across providers
+  openbroker tpsl --coin HYPE --tp 40 --sl 30   # Set TP/SL on position
+
+Documentation: https://github.com/aurracloud/open-broker
+`);
+}
+
+function runScript(scriptPath: string, args: string[]) {
+  const fullPath = path.join(scriptsDir, scriptPath);
+
+  // Use tsx to run TypeScript directly
+  const child = spawn('npx', ['tsx', fullPath, ...args], {
+    stdio: 'inherit',
+    cwd: path.resolve(__dirname, '..'),
+    env: { ...process.env },
+  });
+
+  child.on('error', (err) => {
+    if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
+      console.error('Error: npx/tsx not found. Please ensure Node.js is installed.');
+    } else {
+      console.error('Error:', err.message);
+    }
+    process.exit(1);
+  });
+
+  child.on('exit', (code) => {
+    process.exit(code ?? 0);
+  });
+}
+
+function main() {
+  const args = process.argv.slice(2);
+
+  if (args.length === 0 || args[0] === '--help' || args[0] === '-h') {
+    printHelp();
+    process.exit(0);
+  }
+
+  const command = args[0].toLowerCase();
+  const commandArgs = args.slice(1);
+
+  // Handle buy/sell shortcuts
+  if (command === 'buy') {
+    runScript(commands['market'].script, ['--side', 'buy', ...commandArgs]);
+    return;
+  }
+  if (command === 'sell') {
+    runScript(commands['market'].script, ['--side', 'sell', ...commandArgs]);
+    return;
+  }
+
+  // Handle version
+  if (command === '--version' || command === '-v') {
+    import('../package.json', { with: { type: 'json' } }).then((pkg) => {
+      console.log(`openbroker v${pkg.default.version}`);
+      process.exit(0);
+    });
+    return;
+  }
+
+  const cmd = commands[command];
+  if (!cmd) {
+    console.error(`Unknown command: ${command}`);
+    console.log('Run "openbroker --help" for usage information.');
+    process.exit(1);
+  }
+
+  runScript(cmd.script, commandArgs);
+}
+
+main();

package/bin/openbroker.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+// This wrapper uses tsx to run the TypeScript CLI
+import { spawn } from 'child_process';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const cliPath = path.join(__dirname, 'cli.ts');
+
+// Run the TypeScript CLI with tsx
+const child = spawn(
+  process.execPath,
+  ['--import', 'tsx', cliPath, ...process.argv.slice(2)],
+  {
+    stdio: 'inherit',
+    cwd: process.cwd(),
+  }
+);
+
+child.on('exit', (code) => {
+  process.exit(code ?? 0);
+});

package/config/example.env

@@ -0,0 +1,48 @@
+# Open Broker - Environment Variables
+# Copy this file to .env in the project root and fill in your values:
+#   cp config/example.env .env
+
+# Required: Your wallet private key (64 hex chars with 0x prefix)
+# WARNING: Keep this secret! Never commit .env to git
+HYPERLIQUID_PRIVATE_KEY=0x...
+
+# Optional: Network (mainnet or testnet)
+# Default: mainnet
+HYPERLIQUID_NETWORK=mainnet
+
+# =============================================================================
+# API Wallet Setup (Optional)
+# =============================================================================
+# To use an API wallet (recommended for automated trading):
+# 1. Generate a new wallet for signing (the "API wallet")
+# 2. Approve it as an agent on your main account via Hyperliquid UI
+# 3. Set HYPERLIQUID_PRIVATE_KEY to the API wallet's key
+# 4. Set HYPERLIQUID_ACCOUNT_ADDRESS to your main account address
+#
+# IMPORTANT: Builder fee approval must be done with the MAIN wallet first!
+# After approval, you can switch to using the API wallet for trading.
+#
+# HYPERLIQUID_ACCOUNT_ADDRESS=0x...
+
+# =============================================================================
+# Builder Fee Configuration
+# =============================================================================
+# Open Broker uses builder codes to fund development.
+# Default builder: 0xbb67021fA3e62ab4DA985bb5a55c5c1884381068
+#
+# Custom builder address (optional):
+# BUILDER_ADDRESS=0x...
+#
+# Builder fee in tenths of basis points (10 = 1 bps = 0.01%)
+# Default: 10
+# BUILDER_FEE=10
+
+# =============================================================================
+# Trading Configuration
+# =============================================================================
+# Default slippage for market orders in basis points
+# Default: 50 (0.5%)
+# SLIPPAGE_BPS=50
+
+# Enable verbose/debug logging
+# VERBOSE=1

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "openbroker",
+  "version": "1.0.33",
+  "description": "Hyperliquid trading CLI - execute orders, manage positions, and run trading strategies",
+  "type": "module",
+  "bin": {
+    "openbroker": "./bin/openbroker.js"
+  },
+  "files": [
+    "bin/",
+    "scripts/",
+    "config/example.env",
+    "README.md",
+    "CHANGELOG.md",
+    "SKILL.md"
+  ],
+  "scripts": {
+    "onboard": "tsx scripts/setup/onboard.ts",
+    "setup": "tsx scripts/setup/onboard.ts",
+    "approve-builder": "tsx scripts/setup/approve-builder.ts",
+    "account": "tsx scripts/info/account.ts",
+    "positions": "tsx scripts/info/positions.ts",
+    "funding": "tsx scripts/info/funding.ts",
+    "markets": "tsx scripts/info/markets.ts",
+    "all-markets": "tsx scripts/info/all-markets.ts",
+    "search-markets": "tsx scripts/info/search-markets.ts",
+    "spot": "tsx scripts/info/spot.ts",
+    "market-order": "tsx scripts/operations/market-order.ts",
+    "limit-order": "tsx scripts/operations/limit-order.ts",
+    "trigger-order": "tsx scripts/operations/trigger-order.ts",
+    "set-tpsl": "tsx scripts/operations/set-tpsl.ts",
+    "cancel": "tsx scripts/operations/cancel.ts",
+    "twap": "tsx scripts/operations/twap.ts",
+    "scale": "tsx scripts/operations/scale.ts",
+    "bracket": "tsx scripts/operations/bracket.ts",
+    "chase": "tsx scripts/operations/chase.ts",
+    "funding-arb": "tsx scripts/strategies/funding-arb.ts",
+    "grid": "tsx scripts/strategies/grid.ts",
+    "dca": "tsx scripts/strategies/dca.ts",
+    "mm-spread": "tsx scripts/strategies/mm-spread.ts",
+    "mm-maker": "tsx scripts/strategies/mm-maker.ts",
+    "prepublishOnly": "npm run test:cli",
+    "test:cli": "node --import tsx bin/cli.ts --help"
+  },
+  "dependencies": {
+    "@nktkas/hyperliquid": "^0.30.3",
+    "dotenv": "^17.2.3",
+    "tsx": "^4.19.0",
+    "viem": "^2.21.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aurracloud/openbroker.git"
+  },
+  "homepage": "https://github.com/aurracloud/openbroker#readme",
+  "bugs": {
+    "url": "https://github.com/aurracloud/openbroker/issues"
+  },
+  "author": "aurracloud",
+  "keywords": [
+    "hyperliquid",
+    "trading",
+    "cli",
+    "defi",
+    "perpetuals",
+    "crypto",
+    "dex",
+    "agent-skills",
+    "ai-agents"
+  ],
+  "license": "MIT"
+}