@megatao/sdk 1.1.0

package/cli/commands/utils.ts

@@ -0,0 +1,281 @@
+/**
+ * Utility Commands - Helper commands for CLI usage
+ */
+
+import { Command } from 'commander';
+import chalk from 'chalk';
+import Table from 'cli-table3';
+import { listAvailableMarketAddresses } from '../utils/client';
+
+export function utilityCommands(program: Command) {
+  const utils = program.command('utils').alias('u').description('Utility commands and helpers');
+
+  // Command overview - shows all available commands
+  utils
+    .command('commands')
+    .alias('help-all')
+    .description('Show overview of all CLI commands')
+    .action(() => {
+      console.log(chalk.bold('\n🚀 Alpha Futures CLI - Complete Command Reference\n'));
+
+      const sections = [
+        {
+          title: '💰 Account Management',
+          commands: [
+            ['account deposit <amount>', 'Deposit TAO to margin account'],
+            ['account withdraw <amount>', 'Withdraw TAO from margin account'],
+            ['account balance [address]', 'Check balances (enhanced with TAO wallet)'],
+            ['account transfer <recipient> <amount>', '🆕 Transfer TAO tokens'],
+            ['account info [address]', 'Get detailed account information'],
+          ],
+        },
+        {
+          title: '📊 Position Management',
+          commands: [
+            ['position open', 'Open a new position'],
+            ['position close <positionId>', 'Close an existing position (bytes16 format)'],
+            ['position list [address]', 'List all positions'],
+            ['position info <positionId>', 'Get detailed position information (bytes16 format)'],
+            ['position id <trader> [asset]', '🆕 Get position ID for trader+asset'],
+            ['position find [trader]', '🆕 Find all position IDs for a trader'],
+            ['position modify <positionId>', 'Add/remove margin from position (bytes16 format)'],
+          ],
+        },
+        {
+          title: '📈 Trading',
+          commands: [
+            ['trade market', 'Execute a market order'],
+            ['trade limit', 'Place a limit order (coming soon)'],
+            ['trade quick', 'Quick trade with interactive prompts'],
+            ['trade close-all', 'Close all open positions'],
+            ['trade calc', 'Trading calculator for position sizing'],
+          ],
+        },
+        {
+          title: '💸 Funding Rates',
+          commands: [
+            ['funding rate [asset]', '🆕 Get current funding rate'],
+            ['funding payment <positionId>', '🆕 Calculate funding payment (bytes16 format)'],
+            ['funding history [asset]', '🆕 Show funding rate history (coming soon)'],
+            ['funding simulate', '🆕 Simulate funding rate scenarios'],
+          ],
+        },
+        {
+          title: '🏪 Market Data',
+          commands: [
+            ['market price <asset>', 'Get current price and statistics'],
+            ['market list', 'List all available markets'],
+            ['market config', 'Check market configuration'],
+            ['market stats', 'View protocol-wide statistics'],
+            ['market oi [asset]', 'View open interest data'],
+          ],
+        },
+        {
+          title: '⚡ Liquidation',
+          commands: [
+            ['liquidation scan', 'Scan for liquidatable positions'],
+            ['liquidation execute <positionId>', 'Execute liquidation (bytes16 format)'],
+            ['liquidation monitor', 'Monitor liquidation opportunities'],
+            ['liquidation stats', 'View liquidation statistics'],
+          ],
+        },
+        {
+          title: '🏦 Protocol Vault',
+          commands: [
+            ['vault status', 'View vault status and reserves'],
+            ['vault exposure [asset]', 'View vault exposure by asset'],
+            ['vault stats', 'View vault statistics'],
+          ],
+        },
+      ];
+
+      sections.forEach((section) => {
+        console.log(chalk.bold(section.title));
+        const table = new Table({
+          head: ['Command', 'Description'],
+          colWidths: [40, 50],
+          style: { head: [] },
+        });
+
+        section.commands.forEach(([command, description]) => {
+          const displayCommand = command.includes('🆕') ? command.replace('🆕', '') : command;
+          const displayDescription = description.includes('🆕')
+            ? chalk.green(description)
+            : description;
+
+          table.push([chalk.cyan('alpha-futures ' + displayCommand), displayDescription]);
+        });
+
+        console.log(table.toString());
+        console.log();
+      });
+
+      console.log(chalk.bold('🆕 New Features Added:'));
+      console.log('  • TAO token transfers');
+      console.log('  • Enhanced balance checking (wallet + margin)');
+      console.log('  • Position ID lookup and search');
+      console.log('  • Comprehensive funding rate management');
+      console.log('  • Market configuration validation');
+      console.log();
+
+      console.log(chalk.bold('📖 Quick Start:'));
+      console.log('  1. Check configuration: ' + chalk.cyan('alpha-futures market config'));
+      console.log('  2. Check your balance: ' + chalk.cyan('alpha-futures account balance'));
+      console.log('  3. View market data: ' + chalk.cyan('alpha-futures market list'));
+      console.log(
+        '  4. Open a position: ' +
+          chalk.cyan('alpha-futures position open -a BITMIND -d long -s 1000 -m 333'),
+      );
+      console.log();
+
+      console.log(chalk.bold('🔧 Global Options:'));
+      console.log('  -n, --network <network>     Network to connect to (default: localhost)');
+      console.log('  -r, --rpc <url>            Custom RPC URL');
+      console.log('  -k, --key <privateKey>     Private key for transactions');
+      console.log('  --json                     Output in JSON format');
+      console.log('  --no-color                 Disable color output');
+      console.log();
+    });
+
+  // Environment check command
+  utils
+    .command('env-check')
+    .description('Check environment setup and configuration')
+    .action(() => {
+      console.log(chalk.bold('\n🔍 Environment Configuration Check\n'));
+
+      // Check if .env.anvil file exists
+      const fs = require('fs');
+      const path = require('path');
+      const envFilePath = path.resolve(process.cwd(), '.env.anvil');
+
+      console.log(chalk.bold('📁 Configuration Files:'));
+      if (fs.existsSync(envFilePath)) {
+        console.log(chalk.green('  ✅ .env.anvil file found'));
+      } else {
+        console.log(chalk.red('  ❌ .env.anvil file not found'));
+        console.log(chalk.yellow('     Run: cp .env.example .env.anvil'));
+      }
+
+      // Check essential environment variables
+      console.log(chalk.bold('\n🔑 Essential Environment Variables:'));
+      const essentialVars = ['PRIVATE_KEY', 'TAO_TOKEN'];
+
+      essentialVars.forEach((varName) => {
+        if (process.env[varName]) {
+          console.log(chalk.green(`  ✅ ${varName} is set`));
+        } else {
+          console.log(chalk.red(`  ❌ ${varName} is missing`));
+        }
+      });
+
+      // Check market addresses
+      console.log(chalk.bold('\n🏪 Market Addresses:'));
+      const markets = listAvailableMarketAddresses();
+      if (Object.keys(markets).length > 0) {
+        console.log(chalk.green(`  ✅ ${Object.keys(markets).length} markets configured`));
+        Object.keys(markets).forEach((asset) => {
+          console.log(`     • ${asset}`);
+        });
+      } else {
+        console.log(chalk.red('  ❌ No market addresses configured'));
+        console.log(chalk.yellow('     Available subnet markets: BITMIND, CHUTES, AFFINE, RIDGES'));
+      }
+
+      // Network connectivity check
+      console.log(chalk.bold('\n🌐 Network Settings:'));
+      const rpcUrl = process.env.RPC_URL || 'http://127.0.0.1:8545';
+      console.log(`  RPC URL: ${chalk.cyan(rpcUrl)}`);
+
+      console.log(chalk.bold('\n💡 Next Steps:'));
+      if (!process.env.PRIVATE_KEY) {
+        console.log('  1. Set your PRIVATE_KEY in .env.anvil');
+      }
+      if (Object.keys(markets).length === 0) {
+        console.log('  2. Subnet markets are pre-configured in constants');
+      }
+      console.log('  3. Test connection: alpha-futures market config');
+      console.log('  4. Check balance: alpha-futures account balance');
+    });
+
+  // Quick examples command
+  utils
+    .command('examples')
+    .description('Show common usage examples')
+    .action(() => {
+      console.log(chalk.bold('\n📝 Alpha Futures CLI - Usage Examples\n'));
+
+      const examples = [
+        {
+          title: '🚀 Getting Started',
+          commands: [
+            'alpha-futures market config                    # Check configuration',
+            'alpha-futures account balance                  # Check your balances',
+            'alpha-futures market list                      # View available markets',
+          ],
+        },
+        {
+          title: '💰 Account Management',
+          commands: [
+            'alpha-futures account deposit 100             # Deposit 100 TAO',
+            'alpha-futures account withdraw 50             # Withdraw 50 TAO',
+            'alpha-futures account transfer 0x123... 10    # Transfer 10 TAO',
+            'alpha-futures account balance --detailed       # Detailed balance view',
+          ],
+        },
+        {
+          title: '📊 Position Trading',
+          commands: [
+            'alpha-futures position open -a BITMIND -d long -s 1000 -m 333',
+            'alpha-futures position list --active          # Show active positions',
+            'alpha-futures position info 0x00000000000000000000000000000001  # Position details',
+            'alpha-futures position close 0x00000000000000000000000000000001 # Close position',
+          ],
+        },
+        {
+          title: '🔍 Position Discovery',
+          commands: [
+            'alpha-futures position id 0xa3A00185748B64eDA4149745415080cBA720E720 BITMIND   # Get position ID',
+            'alpha-futures position find 0xa3A00185748B64eDA4149745415080cBA720E720         # Find all positions',
+            'alpha-futures position find --asset BITMIND   # Find BITMIND position',
+          ],
+        },
+        {
+          title: '💸 Funding Rate Analysis',
+          commands: [
+            'alpha-futures funding rate BITMIND            # Get BITMIND funding rate',
+            'alpha-futures funding rate --all              # All funding rates',
+            'alpha-futures funding payment <positionId>    # Calculate funding payment',
+            'alpha-futures funding simulate -s 1000 --long # Simulate scenarios',
+          ],
+        },
+        {
+          title: '⚡ Quick Trading',
+          commands: [
+            'alpha-futures trade quick                     # Interactive trading',
+            'alpha-futures trade market -a BITMIND -s buy -z 1000 -l 3',
+            'alpha-futures trade calc                      # Position calculator',
+            'alpha-futures trade close-all                 # Emergency close',
+          ],
+        },
+      ];
+
+      examples.forEach((section) => {
+        console.log(chalk.bold(section.title));
+        section.commands.forEach((command) => {
+          const [cmd, comment] = command.split('#');
+          console.log(
+            chalk.cyan('  ' + cmd.trim()) + (comment ? chalk.gray(' # ' + comment.trim()) : ''),
+          );
+        });
+        console.log();
+      });
+
+      console.log(chalk.bold('🎯 Pro Tips:'));
+      console.log('  • Use --yes flag to skip confirmations in scripts');
+      console.log('  • Use --json flag for machine-readable output');
+      console.log('  • Use interactive mode: alpha-futures interactive');
+      console.log('  • Set aliases: alias af="alpha-futures"');
+      console.log();
+    });
+}