okx-trade-cli 1.0.2 → 1.0.3

package/dist/index.js

@@ -6,6 +6,8 @@ import { createRequire } from "module";
 
 // ../core/dist/index.js
 import { createHmac } from "crypto";
+import path from "path";
+import os from "os";
 import { readFileSync, existsSync } from "fs";
 import { join } from "path";
 import { homedir } from "os";
@@ -24,6 +26,7 @@ var OkxMcpError = class extends Error {
   code;
   suggestion;
   endpoint;
+  traceId;
   constructor(type, message, options) {
     super(message, options?.cause ? { cause: options.cause } : void 0);
     this.name = type;
@@ -31,6 +34,7 @@ var OkxMcpError = class extends Error {
     this.code = options?.code;
     this.suggestion = options?.suggestion;
     this.endpoint = options?.endpoint;
+    this.traceId = options?.traceId;
   }
 };
 var ConfigError = class extends OkxMcpError {
@@ -39,13 +43,13 @@ var ConfigError = class extends OkxMcpError {
   }
 };
 var RateLimitError = class extends OkxMcpError {
-  constructor(message, suggestion, endpoint) {
-    super("RateLimitError", message, { suggestion, endpoint });
+  constructor(message, suggestion, endpoint, traceId) {
+    super("RateLimitError", message, { suggestion, endpoint, traceId });
   }
 };
 var AuthenticationError = class extends OkxMcpError {
-  constructor(message, suggestion, endpoint) {
-    super("AuthenticationError", message, { suggestion, endpoint });
+  constructor(message, suggestion, endpoint, traceId) {
+    super("AuthenticationError", message, { suggestion, endpoint, traceId });
   }
 };
 var OkxApiError = class extends OkxMcpError {
@@ -71,6 +75,7 @@ function toToolErrorPayload(error, fallbackEndpoint) {
       message: error.message,
       suggestion: error.suggestion,
       endpoint: error.endpoint ?? fallbackEndpoint,
+      traceId: error.traceId,
       timestamp: (/* @__PURE__ */ new Date()).toISOString()
     };
   }
@@ -154,6 +159,9 @@ var RateLimiter = class {
 function isDefined(value) {
   return value !== void 0 && value !== null;
 }
+function extractTraceId(headers) {
+  return headers.get("x-trace-id") ?? headers.get("x-request-id") ?? headers.get("traceid") ?? void 0;
+}
 function stringifyQueryValue(value) {
   if (Array.isArray(value)) {
     return value.map((item) => String(item)).join(",");
@@ -180,28 +188,28 @@ var OkxRestClient = class {
   constructor(config) {
     this.config = config;
   }
-  async publicGet(path, query, rateLimit) {
+  async publicGet(path3, query, rateLimit) {
     return this.request({
       method: "GET",
-      path,
+      path: path3,
       auth: "public",
       query,
       rateLimit
     });
   }
-  async privateGet(path, query, rateLimit) {
+  async privateGet(path3, query, rateLimit) {
     return this.request({
       method: "GET",
-      path,
+      path: path3,
       auth: "private",
       query,
       rateLimit
     });
   }
-  async privatePost(path, body, rateLimit) {
+  async privatePost(path3, body, rateLimit) {
     return this.request({
       method: "POST",
-      path,
+      path: path3,
       auth: "private",
       body,
       rateLimit
@@ -220,6 +228,9 @@ var OkxRestClient = class {
       "Content-Type": "application/json",
       Accept: "application/json"
     });
+    if (this.config.userAgent) {
+      headers.set("User-Agent", this.config.userAgent);
+    }
     if (config.auth === "private") {
       if (!this.config.hasAuth) {
         throw new ConfigError(
@@ -259,6 +270,7 @@ var OkxRestClient = class {
       );
     }
     const rawText = await response.text();
+    const traceId = extractTraceId(response.headers);
     let parsed;
     try {
       parsed = rawText ? JSON.parse(rawText) : {};
@@ -270,7 +282,8 @@ var OkxRestClient = class {
           {
             code: String(response.status),
             endpoint: `${config.method} ${config.path}`,
-            suggestion: "Verify endpoint path and request parameters."
+            suggestion: "Verify endpoint path and request parameters.",
+            traceId
           }
         );
       }
@@ -286,7 +299,8 @@ var OkxRestClient = class {
         {
           code: String(response.status),
           endpoint: `${config.method} ${config.path}`,
-          suggestion: "Retry later or verify endpoint parameters."
+          suggestion: "Retry later or verify endpoint parameters.",
+          traceId
         }
       );
     }
@@ -297,12 +311,14 @@ var OkxRestClient = class {
         throw new AuthenticationError(
           message,
           "Check API key, secret, passphrase and permissions.",
-          `${config.method} ${config.path}`
+          `${config.method} ${config.path}`,
+          traceId
         );
       }
       throw new OkxApiError(message, {
         code: responseCode,
-        endpoint: `${config.method} ${config.path}`
+        endpoint: `${config.method} ${config.path}`,
+        traceId
       });
     }
     return {
@@ -313,21 +329,24 @@ var OkxRestClient = class {
     };
   }
 };
+var DEFAULT_LOG_DIR = path.join(os.homedir(), ".okx", "logs");
 var OKX_API_BASE_URL = "https://www.okx.com";
 var MODULES = [
   "market",
   "spot",
   "swap",
-  "account"
+  "futures",
+  "account",
+  "bot"
 ];
 var DEFAULT_MODULES = ["spot", "swap", "account"];
 function configFilePath() {
   return join(homedir(), ".okx", "config.toml");
 }
 function readTomlProfile(profileName) {
-  const path = configFilePath();
-  if (!existsSync(path)) return {};
-  const raw = readFileSync(path, "utf-8");
+  const path3 = configFilePath();
+  if (!existsSync(path3)) return {};
+  const raw = readFileSync(path3, "utf-8");
   const config = parse(raw);
   const name = profileName ?? config.default_profile ?? "default";
   return config.profiles?.[name] ?? {};
@@ -394,7 +413,8 @@ function loadConfig(cli) {
     timeoutMs: Math.floor(rawTimeout),
     modules: parseModuleList(cli.modules),
     readOnly: cli.readOnly,
-    demo
+    demo,
+    userAgent: cli.userAgent
   };
 }
 var CACHE_FILE = join2(homedir2(), ".okx", "update-check.json");
@@ -471,7 +491,8 @@ function loadProfileConfig(opts) {
     profile: opts.profile,
     modules: opts.modules,
     readOnly: opts.readOnly ?? false,
-    demo: opts.demo ?? false
+    demo: opts.demo ?? false,
+    userAgent: opts.userAgent
   });
 }
 
@@ -955,13 +976,18 @@ function writeCliConfig(config) {
 
 // src/commands/config.ts
 import { existsSync as existsSync4, readFileSync as readFileSync3 } from "fs";
-import { parse as parse2 } from "smol-toml";
+import { parse as parse2, stringify as stringify2 } from "smol-toml";
+import { createInterface } from "readline";
+import { spawnSync } from "child_process";
 function readFullConfig() {
-  const path = configFilePath();
-  if (!existsSync4(path)) return { profiles: {} };
-  const raw = readFileSync3(path, "utf-8");
+  const path3 = configFilePath();
+  if (!existsSync4(path3)) return { profiles: {} };
+  const raw = readFileSync3(path3, "utf-8");
   return parse2(raw);
 }
+function prompt(rl, question) {
+  return new Promise((resolve) => rl.question(question, resolve));
+}
 function cmdConfigShow(json) {
   const config = readFullConfig();
   if (json) return printJson(config);
@@ -995,6 +1021,184 @@ function cmdConfigSet(key, value) {
     process.exitCode = 1;
   }
 }
+async function cmdConfigInit() {
+  const apiUrl = "https://www.okx.com/account/my-api";
+  process.stdout.write("OKX Trade CLI \u2014 \u914D\u7F6E\u5411\u5BFC\n\n");
+  process.stdout.write(`\u8BF7\u524D\u5F80 ${apiUrl} \u521B\u5EFA API Key\uFF08\u9700\u8981 trade \u6743\u9650\uFF09
+
+`);
+  try {
+    const opener = process.platform === "darwin" ? "open" : "xdg-open";
+    spawnSync(opener, [apiUrl], { stdio: "ignore" });
+  } catch {
+  }
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  try {
+    const profileNameRaw = await prompt(rl, "Profile \u540D\u79F0 (\u9ED8\u8BA4: default): ");
+    const profileName = profileNameRaw.trim() || "default";
+    const apiKey = (await prompt(rl, "API Key: ")).trim();
+    if (!apiKey) {
+      process.stderr.write("\u9519\u8BEF: API Key \u4E0D\u80FD\u4E3A\u7A7A\n");
+      process.exitCode = 1;
+      return;
+    }
+    const secretKey = (await prompt(rl, "Secret Key: ")).trim();
+    if (!secretKey) {
+      process.stderr.write("\u9519\u8BEF: Secret Key \u4E0D\u80FD\u4E3A\u7A7A\n");
+      process.exitCode = 1;
+      return;
+    }
+    const passphrase = (await prompt(rl, "Passphrase: ")).trim();
+    if (!passphrase) {
+      process.stderr.write("\u9519\u8BEF: Passphrase \u4E0D\u80FD\u4E3A\u7A7A\n");
+      process.exitCode = 1;
+      return;
+    }
+    const demoRaw = (await prompt(rl, "\u4F7F\u7528\u6A21\u62DF\u76D8\uFF1F(Y/n) ")).trim().toLowerCase();
+    const demo = demoRaw !== "n";
+    if (demo) {
+      process.stdout.write("\u5DF2\u9009\u62E9\u6A21\u62DF\u76D8\u6A21\u5F0F\uFF0C\u53EF\u968F\u65F6\u901A\u8FC7 okx config set \u5207\u6362\u4E3A\u5B9E\u76D8\u3002\n");
+    }
+    const config = readFullConfig();
+    config.profiles[profileName] = { api_key: apiKey, secret_key: secretKey, passphrase, demo };
+    const configPath = configFilePath();
+    try {
+      writeCliConfig(config);
+      process.stdout.write(`
+\u914D\u7F6E\u5DF2\u4FDD\u5B58\u5230 ${configPath}
+`);
+      process.stdout.write(`\u4F7F\u7528\u65B9\u5F0F: okx --profile ${profileName} account balance
+`);
+      if (!config.default_profile) {
+        process.stdout.write(`\u63D0\u793A: \u8FD0\u884C okx config set default_profile ${profileName} \u53EF\u5C06\u5176\u8BBE\u4E3A\u9ED8\u8BA4
+`);
+      }
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      const isPermission = err instanceof Error && "code" in err && (err.code === "EACCES" || err.code === "EPERM");
+      process.stderr.write(`\u5199\u5165\u914D\u7F6E\u6587\u4EF6\u5931\u8D25: ${message}
+`);
+      if (isPermission) {
+        process.stderr.write(`\u6743\u9650\u4E0D\u8DB3\uFF0C\u8BF7\u68C0\u67E5 ${configPath} \u53CA\u5176\u7236\u76EE\u5F55\u7684\u8BFB\u5199\u6743\u9650\u3002
+`);
+      }
+      process.stderr.write("\u8BF7\u624B\u52A8\u5C06\u4EE5\u4E0B\u5185\u5BB9\u5199\u5165 " + configPath + ":\n\n");
+      process.stdout.write(stringify2(config) + "\n");
+      process.exitCode = 1;
+    }
+  } finally {
+    rl.close();
+  }
+}
+
+// src/commands/client-setup.ts
+import * as fs from "fs";
+import * as path2 from "path";
+import * as os2 from "os";
+import * as readline from "readline";
+var CLIENTS = [
+  {
+    name: "Claude Desktop",
+    configPath: path2.join(os2.homedir(), "Library/Application Support/Claude/claude_desktop_config.json"),
+    mcpKey: "mcpServers"
+  },
+  {
+    name: "Cursor",
+    configPath: path2.join(os2.homedir(), ".cursor/mcp.json"),
+    mcpKey: "mcpServers"
+  },
+  {
+    name: "Windsurf",
+    configPath: path2.join(os2.homedir(), ".codeium/windsurf/mcp_config.json"),
+    mcpKey: "mcpServers"
+  }
+];
+var MCP_ENTRY = {
+  command: "okx-trade-mcp",
+  args: ["--modules", "all"]
+};
+var MCP_SERVER_NAME = "okx-trade-mcp";
+function prompt2(rl, question) {
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      resolve(answer);
+    });
+  });
+}
+async function cmdSetupClients() {
+  const detected = CLIENTS.filter((c) => fs.existsSync(c.configPath));
+  if (detected.length === 0) {
+    process.stdout.write(
+      "No supported IDE/client installations detected.\nChecked:\n" + CLIENTS.map((c) => `  - ${c.name}: ${c.configPath}`).join("\n") + "\n"
+    );
+    return;
+  }
+  process.stdout.write(`Detected ${detected.length} client(s):
+`);
+  for (const c of detected) {
+    process.stdout.write(`  - ${c.name}
+`);
+  }
+  process.stdout.write("\n");
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  try {
+    for (const client of detected) {
+      const answer = await prompt2(rl, `Configure ${client.name}? (y/N) `);
+      if (answer.trim().toLowerCase() !== "y") {
+        process.stdout.write(`  Skipped ${client.name}.
+`);
+        continue;
+      }
+      let data = { [client.mcpKey]: {} };
+      if (fs.existsSync(client.configPath)) {
+        const raw = fs.readFileSync(client.configPath, "utf-8");
+        try {
+          data = JSON.parse(raw);
+        } catch {
+          process.stderr.write(
+            `  Error: Failed to parse JSON for ${client.name} at ${client.configPath}. Skipping.
+`
+          );
+          continue;
+        }
+      }
+      if (typeof data[client.mcpKey] !== "object" || data[client.mcpKey] === null) {
+        data[client.mcpKey] = {};
+      }
+      const servers = data[client.mcpKey];
+      if (Object.prototype.hasOwnProperty.call(servers, MCP_SERVER_NAME)) {
+        process.stdout.write(`  Already configured in ${client.name}. Skipping.
+`);
+        continue;
+      }
+      servers[MCP_SERVER_NAME] = MCP_ENTRY;
+      const jsonOutput = JSON.stringify(data, null, 2);
+      try {
+        fs.writeFileSync(client.configPath, jsonOutput, "utf-8");
+        process.stdout.write(`  Configured ${client.name} successfully.
+`);
+      } catch (err) {
+        const reason = err instanceof Error ? err.message : String(err);
+        process.stderr.write(
+          `  Error: Failed to write config for ${client.name}: ${reason}
+  Add the following to "${client.configPath}" manually:
+
+  "${MCP_SERVER_NAME}": ${JSON.stringify(MCP_ENTRY, null, 2).split("\n").join("\n  ")}
+
+`
+        );
+      }
+    }
+  } finally {
+    rl.close();
+  }
+  process.stdout.write(
+    "\nDone. Please restart any configured IDE/client for the changes to take effect.\n"
+  );
+}
 
 // src/index.ts
 var _require = createRequire(import.meta.url);
@@ -1046,8 +1250,10 @@ Commands:
                   [--newSlTriggerPx <price>] [--newSlOrdPx <price|-1>]
   swap algo cancel --instId <id> --algoId <id>
 
+  config init
   config show
   config set <key> <value>
+  config setup-clients
 `);
 }
 async function main() {
@@ -1102,14 +1308,16 @@ async function main() {
   const [module, action, ...rest] = positionals;
   const json = values.json ?? false;
   if (module === "config") {
+    if (action === "init") return cmdConfigInit();
     if (action === "show") return cmdConfigShow(json);
     if (action === "set") return cmdConfigSet(rest[0], rest[1]);
+    if (action === "setup-clients") return cmdSetupClients();
     process.stderr.write(`Unknown config command: ${action}
 `);
     process.exitCode = 1;
     return;
   }
-  const config = loadProfileConfig({ profile: values.profile });
+  const config = loadProfileConfig({ profile: values.profile, userAgent: `okx-trade-cli/${CLI_VERSION}` });
   const client = new OkxRestClient(config);
   if (module === "market") {
     if (action === "ticker") return cmdMarketTicker(client, rest[0], json);
@@ -1271,8 +1479,12 @@ async function main() {
 main().catch((error) => {
   const payload = toToolErrorPayload(error);
   process.stderr.write(`Error: ${payload.message}
+`);
+  if (payload.traceId) process.stderr.write(`TraceId: ${payload.traceId}
 `);
   if (payload.suggestion) process.stderr.write(`Hint: ${payload.suggestion}
+`);
+  process.stderr.write(`Version: okx-trade-cli@${CLI_VERSION}
 `);
   process.exitCode = 1;
 });