@clanker-chain/clanker-cli 2026.9.7-2 → 2026.9.7-4

package/lib/setup.mjs

@@ -2,13 +2,14 @@
  * Interactive / flag-driven `clanker setup`.
  */
 
-import { createInterface } from "node:readline/promises";
-import { stdin as input, stdout as output } from "node:process";
+import { stdin as input } from "node:process";
 import { existsSync } from "node:fs";
 import { getAddress } from "viem";
+import * as clack from "@clack/prompts";
 import {
   ANVIL_DEFAULT_ADDRESS,
   PRESETS,
+  SEPOLIA_FAST_FROM_BLOCK,
   clankerHome,
   configPath,
   initProfile,
@@ -22,11 +23,12 @@ import {
   resolvePreferredOperator,
 } from "./identity-query.mjs";
 import {
-  SEPOLIA_FAST_FROM_BLOCK,
   addressFromEnv,
   addressFromKeyFile,
   detectSetupHints,
+  formatSetupDetectTable,
 } from "./setup-detect.mjs";
+import { c, nextHint } from "./ui.mjs";
 
 /**
  * @param {string[]} argv
@@ -71,6 +73,14 @@ export function parseSetupFlags(argv) {
   };
 }
 
+function cancelIf(value) {
+  if (clack.isCancel(value)) {
+    clack.cancel("Setup aborted.");
+    process.exit(0);
+  }
+  return value;
+}
+
 /**
  * Validate address + label against registry (and Anvil-on-public).
  * @param {{ rpc: string, registry: string, label: string, address: string, skipChainCheck?: boolean }} opts
@@ -100,7 +110,6 @@ export async function assertSetupIdentity(opts) {
   const op = await readOperator(pub, opts.registry, opts.label);
 
   if (op.registeredAt === 0n) {
-    // New operator — fine; mint later
     return { address, operator: op, skipped: false, unregistered: true };
   }
 
@@ -116,14 +125,12 @@ export async function assertSetupIdentity(opts) {
 }
 
 /**
- * Build key pointer from flags / choices.
  * @returns {{ type: 'env'|'keyFile', value: string }|null}
  */
 export function buildKeyPointer({ keyFile, keyEnv, skipKey, env = process.env }) {
   if (skipKey) return null;
   if (keyFile) {
     if (!existsSync(keyFile)) throw new Error(`Key file not found: ${keyFile}`);
-    // validate readable
     addressFromKeyFile(keyFile);
     return { type: "keyFile", value: keyFile };
   }
@@ -175,8 +182,6 @@ export function applySetup(choices, opts = {}) {
 
 /**
  * Non-interactive setup (agents / CI).
- * @param {string[]} argv
- * @param {{ home?: string, env?: NodeJS.ProcessEnv, skipChainCheck?: boolean }} [opts]
  */
 export async function runSetupNonInteractive(argv, opts = {}) {
   const flags = parseSetupFlags(argv);
@@ -226,7 +231,6 @@ export async function runSetupNonInteractive(argv, opts = {}) {
     env,
   });
 
-  // Address from key must match --address when both set
   if (flags.keyFile && flags.address) {
     const fromKey = getAddress(addressFromKeyFile(flags.keyFile));
     if (fromKey !== getAddress(flags.address)) {
@@ -251,7 +255,7 @@ export async function runSetupNonInteractive(argv, opts = {}) {
 }
 
 /**
- * Interactive wizard when stdin is a TTY.
+ * Interactive wizard (Clack) when stdin is a TTY.
  */
 export async function runSetupInteractive(argv, opts = {}) {
   const flags = parseSetupFlags(argv);
@@ -265,273 +269,249 @@ export async function runSetupInteractive(argv, opts = {}) {
     openclawDir: opts.openclawDir,
   });
 
-  const rl =
-    opts.rl ??
-    createInterface({ input, output });
-  const ask = async (q, def) => {
-    const suffix = def != null && def !== "" ? ` [${def}]` : "";
-    const ans = (await rl.question(`${q}${suffix}: `)).trim();
-    return ans || def || "";
-  };
-  const askYesNo = async (q, defaultYes = true) => {
-    const def = defaultYes ? "Y/n" : "y/N";
-    const ans = (await rl.question(`${q} (${def}): `)).trim().toLowerCase();
-    if (!ans) return defaultYes;
-    return ans === "y" || ans === "yes";
-  };
-
-  try {
-    console.log("");
-    console.log("clanker setup — create your local operator profile");
-    console.log("");
-    console.log(
-      "This writes ~/.clanker/config.json (network) and operator.json (who you are).",
-    );
-    console.log(
-      "Reads like `clanker whoami` can use the owner address without a private key;",
-    );
-    console.log("mint/revoke still need a key file or OPERATOR_PRIVATE_KEY later.");
-    console.log("");
-    console.log(`Profile directory: ${home}`);
-    console.log("");
-
-    // Detection summary
-    console.log("Detected on this machine:");
-    if (hints.hasConfig) {
-      const p = hints.config?.preset ?? "?";
-      const reg = hints.config?.registryAddress ?? "(none)";
-      console.log(`  • Network config already at config.json (preset=${p}, registry=${reg})`);
-    } else {
-      console.log("  • No config.json yet — will create one");
-    }
-    if (hints.hasOperator) {
-      console.log(
-        `  • Operator profile already at operator.json (label=${hints.operator?.label}, owner=${hints.operator?.owner})`,
+  clack.intro(c.bold("clanker setup"));
+  clack.log.step("Creates ~/.clanker/config.json (network) and operator.json (identity).");
+  clack.log.message(
+    c.dim("whoami works from owner without a key; mint/revoke need a key pointer later."),
+  );
+  clack.log.message(c.dim(`Profile: ${home}`));
+  console.log("");
+  console.log(c.dim(formatSetupDetectTable(hints)));
+  console.log("");
+
+  if ((hints.hasConfig || hints.hasOperator) && !flags.force) {
+    if (hints.hasConfig && !hints.hasOperator) {
+      const cont = cancelIf(
+        await clack.confirm({
+          message: "Network config exists; continue to create operator.json?",
+          initialValue: true,
+        }),
       );
+      if (!cont) {
+        clack.cancel("Aborted.");
+        process.exit(0);
+      }
+      flags.force = true;
     } else {
-      console.log("  • No operator.json yet — that is what we need for bare `whoami`");
-    }
-    if (hints.foundryAvailable && hints.foundryAccounts.length) {
-      console.log(
-        `  • Foundry keystore accounts: ${hints.foundryAccounts.join(", ")} (names only; you paste the 0x address)`,
-      );
-    } else if (!hints.foundryAvailable) {
-      console.log("  • Foundry `cast` not on PATH (optional)");
-    }
-    if (hints.openclawBots.length) {
-      console.log(
-        `  • OpenClaw bot key files: ${hints.openclawBots.join(", ")}`,
-      );
-      console.log(
-        "    (These are bot signing keys — not your operator wallet. Useful context only.)",
+      const overwrite = cancelIf(
+        await clack.confirm({
+          message: "Replace existing config.json / operator.json?",
+          initialValue: false,
+        }),
       );
-    }
-    if (hints.hasOperatorPrivateKeyEnv) {
-      console.log(
-        `  • OPERATOR_PRIVATE_KEY is set in this shell → ${hints.envAddress ?? "(invalid key)"}`,
-      );
-    }
-    console.log("");
-
-    if ((hints.hasConfig || hints.hasOperator) && !flags.force) {
-      if (hints.hasConfig && !hints.hasOperator) {
-        console.log(
-          "You already have network settings from `clanker init`, but no operator identity.",
-        );
-        console.log(
-          "Continuing will refresh config.json if needed and create operator.json.",
-        );
-        const cont = await askYesNo("Continue setup?", true);
-        if (!cont) {
-          throw new Error("Aborted. Re-run `clanker setup` when ready.");
-        }
-        flags.force = true;
-      } else {
-        console.log(
-          "A full profile already exists. Continuing will REPLACE config.json and/or operator.json",
-        );
-        console.log("with the answers you give next (same files, new contents).");
-        const overwrite = await askYesNo("Replace existing profile files?", false);
-        if (!overwrite) {
-          throw new Error(
-            "Aborted. Pass --force to replace, or edit ~/.clanker/*.json by hand.",
-          );
-        }
-        flags.force = true;
+      if (!overwrite) {
+        clack.cancel("Aborted. Pass --force to replace.");
+        process.exit(0);
       }
-      console.log("");
+      flags.force = true;
     }
+  }
 
-    console.log("— Network —");
-    let preset =
-      flags.preset ||
-      hints.config?.preset ||
-      (await ask("Which network? sepolia (public hub) or local (Anvil)", "sepolia"));
-    preset = String(preset).toLowerCase();
-    if (!PRESETS[preset]) throw new Error(`Unknown preset "${preset}"`);
-
-    let fromBlock = flags.fromBlock;
-    if (preset === "sepolia") {
-      const useFast =
-        fromBlock != null
-          ? false
-          : await askYesNo(
-              `Speed up chain scans? Use fromBlock ${SEPOLIA_FAST_FROM_BLOCK} (recommended on public RPC)`,
-              true,
-            );
-      if (fromBlock == null) {
-        fromBlock = useFast ? SEPOLIA_FAST_FROM_BLOCK : PRESETS.sepolia.fromBlock;
-      }
-    }
+  let preset = flags.preset || hints.config?.preset || null;
+  if (!preset) {
+    preset = cancelIf(
+      await clack.select({
+        message: "Network",
+        options: [
+          { value: "sepolia", label: "sepolia", hint: "public closed-beta hub" },
+          { value: "local", label: "local", hint: "Anvil" },
+        ],
+        initialValue: "sepolia",
+      }),
+    );
+  }
+  preset = String(preset).toLowerCase();
+  if (!PRESETS[preset]) throw new Error(`Unknown preset "${preset}"`);
+
+  // Fast Sepolia default — no interactive fromBlock question
+  let fromBlock = flags.fromBlock;
+  if (fromBlock == null && preset === "sepolia") {
+    fromBlock = SEPOLIA_FAST_FROM_BLOCK;
+  }
 
-    console.log("");
-    console.log("— Operator identity —");
-    console.log(
-      "We need the wallet address that owns (or will own) your on-chain operator label.",
+  let address = flags.address ?? null;
+  if (!address && flags.keyFile) {
+    address = addressFromKeyFile(flags.keyFile);
+    clack.log.info(`Address from --key-file: ${address}`);
+  }
+  if (!address && hints.envAddress) {
+    const useEnv = cancelIf(
+      await clack.confirm({
+        message: `Use OPERATOR_PRIVATE_KEY address (${hints.envAddress})?`,
+        initialValue: true,
+      }),
     );
-    let address = flags.address ?? null;
-    if (!address && flags.keyFile) {
-      address = addressFromKeyFile(flags.keyFile);
-      console.log(`Using address from --key-file: ${address}`);
-    }
-    if (!address && hints.envAddress) {
-      const useEnv = await askYesNo(
-        `Use address from OPERATOR_PRIVATE_KEY (${hints.envAddress})?`,
-        true,
-      );
-      if (useEnv) address = hints.envAddress;
-    }
-    if (!address && hints.operator?.owner) {
-      const useOp = await askYesNo(
-        `Keep existing operator.json owner (${hints.operator.owner})?`,
-        true,
+    if (useEnv) address = hints.envAddress;
+  }
+  if (!address && hints.operator?.owner) {
+    const useOp = cancelIf(
+      await clack.confirm({
+        message: `Keep existing owner (${hints.operator.owner})?`,
+        initialValue: true,
+      }),
+    );
+    if (useOp) address = hints.operator.owner;
+  }
+  if (!address && hints.foundryAccounts.length) {
+    const options = [
+      ...hints.foundryAccounts.map((n) => ({
+        value: n,
+        label: n,
+        hint: "Foundry keystore — paste 0x next",
+      })),
+      { value: "__paste__", label: "Paste an address…", hint: "0x…" },
+    ];
+    const pick = cancelIf(
+      await clack.select({
+        message: "Operator owner source",
+        options,
+        initialValue: hints.foundryAccounts[0],
+      }),
+    );
+    if (pick === "__paste__") {
+      address = cancelIf(
+        await clack.text({
+          message: "Operator owner address",
+          placeholder: "0x…",
+          validate: (v) =>
+            /^0x[0-9a-fA-F]{40}$/.test(v || "") ? undefined : "Need 0x + 40 hex",
+        }),
       );
-      if (useOp) address = hints.operator.owner;
-    }
-    if (!address && hints.foundryAccounts.length) {
-      console.log("");
-      console.log("Foundry accounts on this machine (passwords are never stored here):");
-      hints.foundryAccounts.forEach((n, i) => console.log(`  ${i + 1}. ${n}`));
-      const pick = await ask(
-        "Type a Foundry account name to use, or leave blank to paste an address",
-        hints.foundryAccounts[0] ?? "",
+    } else {
+      address = cancelIf(
+        await clack.text({
+          message: `Paste 0x address for Foundry account "${pick}"`,
+          placeholder: "0x…",
+          validate: (v) =>
+            /^0x[0-9a-fA-F]{40}$/.test(v || "") ? undefined : "Need 0x + 40 hex",
+        }),
       );
-      if (pick) {
-        address = await ask(
-          `Paste the 0x address for "${pick}" (cast wallet address ${pick} after unlock)`,
-          "",
-        );
-      }
-    }
-    if (!address) {
-      address = await ask("Operator owner address (0x…)", "");
     }
-    if (!address || !/^0x[0-9a-fA-F]{40}$/.test(address)) {
-      throw new Error("A valid 0x operator address is required");
-    }
-    address = getAddress(address);
-
-    let label =
-      flags.operator ||
-      hints.operator?.label ||
-      (await ask("Operator label on-chain (e.g. org.openclaw.pat or org.you)", ""));
-    if (!label) throw new Error("Operator label is required");
-
-    const presetCfg = PRESETS[preset];
-    console.log("");
-    console.log("— Chain check —");
-    console.log(`Looking up "${label}" on ${preset}…`);
-    const check = await assertSetupIdentity({
+  }
+  if (!address) {
+    address = cancelIf(
+      await clack.text({
+        message: "Operator owner address",
+        placeholder: "0x…",
+        validate: (v) =>
+          /^0x[0-9a-fA-F]{40}$/.test(v || "") ? undefined : "Need 0x + 40 hex",
+      }),
+    );
+  }
+  address = getAddress(address);
+
+  let label = flags.operator || hints.operator?.label || null;
+  if (!label) {
+    label = cancelIf(
+      await clack.text({
+        message: "Operator label",
+        placeholder: "org.openclaw.pat",
+        validate: (v) => (v && v.trim() ? undefined : "Label required"),
+      }),
+    );
+  }
+
+  const presetCfg = PRESETS[preset];
+  const spin = clack.spinner();
+  spin.start(`Looking up "${label}" on ${preset}`);
+  let check;
+  try {
+    check = await assertSetupIdentity({
       rpc: presetCfg.chainRpcUrl,
       registry: presetCfg.registryAddress,
       label,
       address,
       skipChainCheck: flags.skipChainCheck || !presetCfg.registryAddress,
     });
-    if (check.unregistered) {
-      console.log(
-        `OK: "${label}" is not registered yet — after setup, run: clanker operator mint ${label}`,
+    spin.stop(
+      check.unregistered
+        ? c.yellow(`"${label}" not registered yet — mint after setup`)
+        : check.skipped
+          ? "Chain check skipped"
+          : c.green(`"${label}" active and owned by this address`),
+    );
+  } catch (err) {
+    spin.stop(c.red("Chain check failed"));
+    throw err;
+  }
+
+  let keyFile = flags.keyFile;
+  let keyEnv = flags.keyEnv;
+  let skipKey = flags.skipKey;
+  if (!skipKey && !keyFile && !keyEnv) {
+    if (hints.hasOperatorPrivateKeyEnv) {
+      const use = cancelIf(
+        await clack.confirm({
+          message: "Store OPERATOR_PRIVATE_KEY pointer for signing?",
+          initialValue: true,
+        }),
       );
-    } else if (check.operator) {
-      console.log(`OK: "${label}" is active on-chain and owned by this address.`);
+      if (use) keyEnv = "OPERATOR_PRIVATE_KEY";
+      else skipKey = true;
+    } else {
+      const path = cancelIf(
+        await clack.text({
+          message: "Operator key file path (Enter = read-only)",
+          placeholder: "~/.clanker/op.key",
+        }),
+      );
+      if (path && String(path).trim()) keyFile = String(path).trim();
+      else skipKey = true;
     }
+  }
 
-    console.log("");
-    console.log("— Signing key (optional) —");
-    console.log(
-      "Only needed for mint/revoke/transfer. Skip for read-only whoami/bots.",
-    );
-    let keyFile = flags.keyFile;
-    let keyEnv = flags.keyEnv;
-    let skipKey = flags.skipKey;
-    if (!skipKey && !keyFile && !keyEnv) {
-      if (hints.hasOperatorPrivateKeyEnv) {
-        const use = await askYesNo(
-          "Remember OPERATOR_PRIVATE_KEY as the signing pointer in operator.json?",
-          true,
-        );
-        if (use) keyEnv = "OPERATOR_PRIVATE_KEY";
-        else skipKey = true;
-      } else {
-        const path = await ask(
-          "Path to operator private-key file (blank = read-only profile)",
-          "",
-        );
-        if (path) keyFile = path;
-        else skipKey = true;
-      }
+  const key = buildKeyPointer({ keyFile, keyEnv, skipKey, env });
+  if (key?.type === "keyFile") {
+    const fromKey = getAddress(addressFromKeyFile(key.value));
+    if (fromKey !== address) {
+      throw new Error(`Key file address ${fromKey} does not match chosen owner ${address}`);
     }
+  }
 
-    const key = buildKeyPointer({ keyFile, keyEnv, skipKey, env });
-    if (key?.type === "keyFile") {
-      const fromKey = getAddress(addressFromKeyFile(key.value));
-      if (fromKey !== address) {
-        throw new Error(`Key file address ${fromKey} does not match chosen owner ${address}`);
-      }
-    }
+  clack.note(
+    [
+      `network:   ${preset}`,
+      `fromBlock: ${fromBlock ?? presetCfg.fromBlock}`,
+      `label:     ${label}`,
+      `owner:     ${address}`,
+      `signing:   ${key ? `${key.type}=${key.value}` : "none (read-only)"}`,
+    ].join("\n"),
+    "Summary",
+  );
 
-    console.log("");
-    console.log("— Summary (about to write) —");
-    console.log(`  network:  ${preset}`);
-    console.log(`  fromBlock:${fromBlock ?? presetCfg.fromBlock}`);
-    console.log(`  label:    ${label}`);
-    console.log(`  owner:    ${address}`);
-    console.log(
-      `  signing:  ${key ? `${key.type}=${key.value}` : "none (read-only whoami/bots)"}`,
-    );
-    const ok = flags.yes || (await askYesNo("Write these files now?", true));
-    if (!ok) throw new Error("Aborted");
-
-    const result = applySetup(
-      {
-        preset,
-        force: true,
-        fromBlock: fromBlock ?? undefined,
-        registryAddress: presetCfg.registryAddress,
-        label,
-        address,
-        key,
-      },
-      { home, env },
+  if (!flags.yes) {
+    const ok = cancelIf(
+      await clack.confirm({ message: "Write these files?", initialValue: true }),
     );
-
-    console.log("");
-    console.log(`Wrote ${result.configPath}`);
-    console.log(`Wrote ${result.operatorPath}`);
-    if (!key) {
-      console.log("");
-      console.log("Next: clanker whoami");
-      console.log(
-        "For mint/revoke later: re-run setup with a key file, or pass --key-file / OPERATOR_PRIVATE_KEY.",
-      );
-    } else {
-      console.log("");
-      console.log("Next: clanker whoami");
+    if (!ok) {
+      clack.cancel("Aborted.");
+      process.exit(0);
     }
-    return result;
-  } finally {
-    if (!opts.rl) rl.close();
   }
+
+  const result = applySetup(
+    {
+      preset,
+      force: true,
+      fromBlock: fromBlock ?? undefined,
+      registryAddress: presetCfg.registryAddress,
+      label,
+      address,
+      key,
+    },
+    { home, env },
+  );
+
+  clack.outro(c.green(`Wrote ${result.configPath}\nWrote ${result.operatorPath}`));
+  if (!key) {
+    nextHint([
+      "clanker whoami",
+      "clanker setup --key-file ~/.clanker/op.key --force   # when you need mint",
+    ]);
+  } else {
+    nextHint(["clanker whoami", `clanker bot mint <label>`]);
+  }
+  return result;
 }
 
 /**
@@ -541,7 +521,6 @@ export async function runSetup(argv, opts = {}) {
   const flags = parseSetupFlags(argv);
   const isTTY = opts.isTTY ?? Boolean(input.isTTY);
 
-  // Fully flagged non-interactive path
   if (
     !isTTY ||
     (flags.yes && flags.preset && flags.operator && (flags.address || flags.keyFile))
@@ -549,7 +528,15 @@ export async function runSetup(argv, opts = {}) {
     if (!isTTY && !(flags.preset && flags.operator)) {
       return runSetupNonInteractive(argv, opts);
     }
-    if (flags.yes && flags.preset && flags.operator && (flags.address || flags.keyFile || opts.env?.OPERATOR_PRIVATE_KEY || process.env.OPERATOR_PRIVATE_KEY)) {
+    if (
+      flags.yes &&
+      flags.preset &&
+      flags.operator &&
+      (flags.address ||
+        flags.keyFile ||
+        opts.env?.OPERATOR_PRIVATE_KEY ||
+        process.env.OPERATOR_PRIVATE_KEY)
+    ) {
       return runSetupNonInteractive(argv, opts);
     }
   }