@c4roa0/agentpay-user 0.0.0-stage → 0.3.0

package/src/uninstall-local.mjs

@@ -0,0 +1,299 @@
+import { installationDirectory, legacyInstallationDirectory } from "./installation-paths.mjs";
+import { walletPackage } from "./wallet-package.mjs";
+// SPDX-License-Identifier: MPL-2.0
+// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+// If a copy was not distributed with this file, see https://mozilla.org/MPL/2.0/.
+import { lstat, realpath, readFile, rm, unlink } from "node:fs/promises";
+import { dirname, join, relative, resolve, parse, isAbsolute } from "node:path";
+import { homedir } from "node:os";
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+import { createInterface } from "node:readline/promises";
+import { autostartFiles, isManagedUnit } from "./autostart-files.mjs";
+import {
+  resolveUserDataDir,
+  installedUserDir,
+} from "./local-data-directory.mjs";
+import { readServiceSettings, listenerPresent } from "./local-services.mjs";
+const execute = promisify(execFile);
+const inside = (parent, path) => {
+  const r = relative(parent, path);
+  return r === "" || (!r.startsWith("..") && !parse(r).root);
+};
+async function target(path, { directory = false, privateMode = false } = {}) {
+  try {
+    const info = await lstat(path);
+    if (
+      info.isSymbolicLink() ||
+      info.uid !== process.getuid() ||
+      info.mode & (privateMode ? 0o077 : 0o022) ||
+      (directory ? !info.isDirectory() : !info.isFile()) ||
+      (await realpath(path)) !== path
+    )
+      throw Error(`Cannot safely remove this path: ${path}`);
+    return { path, directory, dev: info.dev, ino: info.ino, privateMode };
+  } catch (error) {
+    if (error.code === "ENOENT") return null;
+    throw error;
+  }
+}
+export async function uninstallPlan({
+  dataDir,
+  userDir = installedUserDir,
+  home = homedir(),
+  node = process.execPath,
+  removeData = false,
+}) {
+  dataDir = resolve(dataDir);
+  userDir = resolve(userDir);
+  home = resolve(home);
+  let walletDir;
+  try { walletDir = walletPackage(userDir).directory; } catch { walletDir = userDir; }
+  for (const protectedPath of [parse(dataDir).root, home, userDir, walletDir])
+    if (inside(dataDir, protectedPath))
+      throw Error(
+        "Refusing to remove a home, repository or ancestor directory.",
+      );
+  const targets = [];
+  const data = await target(dataDir, { directory: true, privateMode: true });
+  if (data && removeData) targets.push(data);
+  let settings;
+  if (data)
+    try {
+      settings = await readServiceSettings(dataDir);
+    } catch (e) {
+      if (e.code !== "ENOENT") throw e;
+      const pid = await lstat(
+        join(dataDir, "runtime/user-runtime-guide.pid"),
+      ).catch((x) => {
+        if (x.code === "ENOENT") return null;
+        throw x;
+      });
+      if (pid)
+        throw Error(
+          "Runtime startup settings are missing but a guide process record exists. Inspect it before uninstalling.",
+        );
+    }
+  const installDir = installationDirectory();
+  for (const reserved of [join(home, ".config"), installDir])
+    if (inside(dataDir, reserved) || inside(reserved, dataDir))
+      throw Error(
+        "Data directory overlaps installation or service configuration. No files were removed.",
+      );
+  const lock = await lstat(join(installDir, "install.lock")).catch((e) => {
+    if (e.code === "ENOENT") return null;
+    throw e;
+  });
+  if (lock)
+    throw Error(
+      "An installer lock exists. Finish or inspect that installation before uninstalling.",
+    );
+  const install = await target(installDir, {
+    directory: true,
+    privateMode: true,
+  });
+  if (install && removeData) {
+    const state = await target(join(installDir, "state.json"), {
+      privateMode: true,
+    });
+    if (state) {
+      const saved = JSON.parse(await readFile(state.path, "utf8"));
+      if (
+        saved.version !== 1 ||
+        typeof saved.dataDir !== "string" ||
+        !isAbsolute(saved.dataDir) ||
+        resolve(saved.dataDir) !== dataDir
+      )
+        throw Error(
+          "Installation record points to another data directory; no files were removed.",
+        );
+      targets.push({ ...install, checkpoint: true });
+
+    }
+  }
+  // Retire only the old source checkpoint that names this exact data directory.
+  // Otherwise a later setup could rediscover and reimport purged configuration.
+  if (removeData) {
+    const legacyDir = legacyInstallationDirectory(userDir);
+    if (legacyDir !== installDir) {
+      const legacy = await target(legacyDir, { directory: true, privateMode: true });
+      const record = legacy && await target(join(legacyDir, "state.json"), { privateMode: true });
+      if (record) {
+        const saved = JSON.parse(await readFile(record.path, "utf8"));
+        if (saved.version === 1 && typeof saved.dataDir === "string" && isAbsolute(saved.dataDir) && resolve(saved.dataDir) === dataDir) {
+          if (await lstat(join(legacyDir, "install.lock")).catch(e => { if (e.code !== "ENOENT") throw e; return null; }))
+            throw Error("An old installer lock exists. Finish that installation before uninstalling.");
+          for (const name of ["user-deployment.json", "anvil-onboarding.json"]) {
+            const file = await target(join(dirname(userDir), name), { privateMode: true });
+            if (file) targets.push(file);
+          }
+          targets.push({ ...legacy, checkpoint: true });
+        }
+      }
+    }
+  }
+  const unitDir = join(home, ".config/systemd/user"),
+    generated = autostartFiles({ node, userDir, dataDir }),
+    units = [];
+  for (const [name, body] of Object.entries(generated)) {
+    const file = await target(join(unitDir, name));
+    if (!file) continue;
+    for (const path of [
+      join(home, ".config"),
+      join(home, ".config/systemd"),
+      unitDir,
+    ]) {
+      const info = await lstat(path);
+      if (
+        !info.isDirectory() ||
+        info.isSymbolicLink() ||
+        info.uid !== process.getuid() ||
+        info.mode & 0o022
+      )
+        throw Error("Service configuration directory ownership is unsafe.");
+    }
+    if (!isManagedUnit(await readFile(file.path, "utf8"), name, dataDir))
+      throw Error(
+        `Service file is not this installation's managed file: ${name}`,
+      );
+    units.push({ ...file, name });
+  }
+  return { dataDir, targets, units, settings, removeData };
+}
+async function unchanged(item) {
+  const fresh = await target(item.path, item);
+  if (!fresh || fresh.dev !== item.dev || fresh.ino !== item.ino)
+    throw Error("An uninstall target changed. No further files were removed.");
+}
+export async function removeInstallation(
+  plan,
+  {
+    manage = async (args) =>
+      execute("systemctl", ["--user", ...args], {
+        timeout: 45000,
+        maxBuffer: 16384,
+      }),
+    probe = listenerPresent,
+  } = {},
+) {
+  // Validate all targets before stopping, and again immediately before deletion.
+  for (const item of [...plan.targets, ...plan.units]) await unchanged(item);
+  if (plan.units.length) {
+    await manage(["stop", ...plan.units.map((u) => u.name)]);
+    for (const unit of plan.units) {
+      const { stdout } = await manage([
+        "show",
+        unit.name,
+        "--property=MainPID,ActiveState",
+      ]);
+      const state = Object.fromEntries(
+        stdout
+          .trim()
+          .split("\n")
+          .map((s) => s.split("=")),
+      );
+      if (
+        state.MainPID !== "0" ||
+        !["inactive", "failed"].includes(state.ActiveState)
+      )
+        throw Error("A local service has not stopped; data was preserved.");
+    }
+  }
+  if (await probe(join(plan.dataDir, "wallet/wallet.sock")))
+    throw Error(
+      "A Wallet outside these managed services is still running. Stop it explicitly; data was preserved.",
+    );
+  if (
+    plan.settings &&
+    (await probe({
+      host: "127.0.0.1",
+      port: Number(new URL(plan.settings.runtimeUrl).port),
+    }))
+  )
+    throw Error(
+      "A Runtime or other process still occupies this port. Stop/review it explicitly; data was preserved.",
+    );
+  if (plan.units.length) {
+    await manage(["disable", ...plan.units.map((u) => u.name)]);
+    for (const unit of plan.units) {
+      await unchanged(unit);
+      await unlink(unit.path);
+    }
+    await manage(["daemon-reload"]);
+  }
+  // Remove the installation checkpoint last so interrupted cleanup can find its scope.
+  const ordered = [...plan.targets].sort(
+    (a, b) =>
+      Number(Boolean(a.checkpoint)) -
+      Number(Boolean(b.checkpoint)),
+  );
+  for (const item of ordered) {
+    await unchanged(item);
+    await rm(item.path, { recursive: item.directory, force: false });
+  }
+}
+export async function uninstallLocal({
+  ask,
+  write = console.log,
+  plan = uninstallPlan,
+  remove = removeInstallation,
+  dataDir,
+  terminal = Boolean(process.stdin.isTTY),
+  removeData = false,
+} = {}) {
+  if (!terminal)
+    throw Error(
+      "Run agentpay uninstall in an interactive terminal. No files were removed.",
+    );
+  const selected = await plan({
+    dataDir: dataDir || (await resolveUserDataDir()),
+    removeData,
+  });
+  write("Uninstall AgentPay from this computer");
+  write(
+    removeData ? "This permanently deletes the local Session Key, credentials, installed Skills and transaction recovery history. Reinstalling cannot restore them." : "This removes background services. Your keys, Policies, Orders, configuration and cache will be kept.",
+  );
+  write(
+    "It does not revoke Safe permissions or cancel on-chain Orders. Resolve pending Orders and revoke the Safe permission first if you intend to retire it.",
+  );
+  write("Services will stop. Removal is limited to:");
+  for (const item of [...selected.units, ...selected.targets])
+    write(`  ${item.path}`);
+  const confirmation = removeData ? "DELETE LOCAL AGENTPAY DATA" : "REMOVE AGENTPAY SERVICES";
+  let input;
+  if (ask)
+    input = await ask(
+      `Type ${confirmation} to continue, or anything else to cancel: `,
+    );
+  else {
+    const terminal = createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+    try {
+      input = await terminal.question(
+        `Type ${confirmation} to continue, or anything else to cancel: `,
+      );
+    } finally {
+      terminal.close();
+    }
+  }
+  if (input !== confirmation) {
+    write("Uninstall cancelled. Nothing was stopped or deleted.");
+    return 0;
+  }
+  try {
+    await remove(selected);
+  } catch (error) {
+    write(
+      "Uninstall did not finish. Some services or files may already have changed. Review the error before retrying; keep the installed User package.",
+    );
+    throw error;
+  }
+  write(
+    `Selected services and data removal complete. On-chain permissions remain unchanged.
+To remove a global program installation: npm uninstall --global @c4roa0/agentpay-user
+For a source checkout, you may now delete the User program folder.`,
+  );
+  return 0;
+}

package/src/user-cli.mjs

@@ -0,0 +1,354 @@
+// SPDX-License-Identifier: MPL-2.0
+// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+// If a copy was not distributed with this file, see https://mozilla.org/MPL/2.0/.
+import { spawn } from "node:child_process";
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+import { join } from "node:path";
+import { installedUserDir } from "./local-data-directory.mjs";
+const execute = promisify(execFile);
+const groups = {
+  wallet: [
+    ["info", "Wallet identity and local file locations"],
+    ["unlock", "Unlock Wallet for payments"],
+    ["lock", "Lock Wallet; keep services running"],
+    ["restore", "Restore an existing key and Policy"],
+  ],
+  policy: [
+    ["info", "View current spending permission"],
+    ["renew", "Renew or replace spending limits and expiry"],
+    ["revoke", "Revoke spending permission on-chain"],
+  ],
+  service: [
+    ["start", "Start Wallet and Runtime"],
+    ["stop", "Stop Wallet and Runtime"],
+    ["restart", "Restart both; Wallet starts locked"],
+    ["autostart on|off", "Change startup at login"],
+    ["logs wallet|runtime", "Read recent service logs"],
+  ],
+  market: [
+    ["connect [--market URL]", "Sign in and connect this Wallet to Market"],
+  ],
+  orders: [
+    ["list", "List saved Orders and warnings"],
+    ["details ID", "Read saved Order details"],
+    ["status ID", "Check an Order online"],
+    ["retrieve ID", "Retrieve its original result"],
+    ["case ID", "Find support for an Order"],
+    ["archive ID", "Hide a reviewed local warning"],
+    ["unarchive ID", "Show its warning again"],
+    ["files ID [remove KEY]", "View or remove cached attachments"],
+  ],
+  cache: [
+    ["info", "View cache usage"],
+    ["list [PAGE] [input|output]", "List cached files"],
+    ["details ID", "Inspect one cached file"],
+    ["export ID PATH", "Export a verified copy"],
+    ["clean", "Review and confirm cleanup"],
+    ["settings [KEY VALUE]", "View or change cache limits"],
+  ],
+  payment: [["test", "Test the full payment path with the official Skill"]],
+};
+function panel(title, rows, example = "") {
+  return (
+    "\nAgentPay · " +
+    title +
+    "\n\n" +
+    rows
+      .map(([name, description]) => "  " + name.padEnd(32) + "  " + description)
+      .join("\n") +
+    (example ? "\n\nExample:\n  " + example : "") +
+    "\n"
+  );
+}
+export const helpText =
+  panel(
+    "User and Wallet",
+    [
+      ["status", "Check services, permission and Order warnings"],
+      ["install --market URL", "Install and continue setup"],
+      ["setup", "Continue setup"],
+      ["update [-f]", "Check npm and update User, Wallet and the official test Skill"],
+      ["repair [-f]", "Refresh installed services; -f skips confirmation"],
+      ["uninstall [--delete-data]", "Remove services; optionally erase private data"],
+      ...Object.keys(groups).map((name) => [
+        name + " help",
+        name === "service"
+          ? "Background processes and login startup"
+          : name === "policy"
+            ? "Spending permission"
+            : name === "orders"
+              ? "Order history and support"
+              : name === "wallet"
+                ? "Local Wallet"
+                : name === "market"
+                  ? "Website connection"
+                  : name === "payment"
+                    ? "Payment path checks"
+                    : "Local file cache",
+      ]),
+      ["help", "Show this overview"],
+    ],
+    "agentpay policy help",
+  ) +
+  `
+Update your installation
+  npm installation: agentpay update
+  Source checkout: update User, run npm ci, then agentpay repair.
+  Keep your private data. Do not uninstall to upgrade.
+`;
+
+function topicHelp(group, sub) {
+  if (group === "service" && sub === "autostart")
+    return (
+      panel(
+        "Login startup",
+        [
+          ["agentpay service autostart on", "Enable startup at future logins"],
+          ["agentpay service autostart off", "Disable startup at future logins"],
+        ],
+        "agentpay service autostart off",
+      ) + "Current processes are unchanged. Wallet starts locked.\n"
+    );
+  const notes = {
+    wallet: "Locking Wallet does not revoke on-chain spending permission.",
+    policy:
+      "Renewal and revocation require owner approval. Existing Orders are retained.",
+    service:
+      "Services run in the background as systemd user services. Closing your terminal does not stop them.",
+    orders:
+      "Use an Order/request ID or unique short ID. Queries need an unlocked Wallet; retrieving a result does not purchase again.",
+    cache:
+      "Add --offline when Runtime is stopped. Unfinished inputs are protected.",
+    market: "Connecting grants website Order access, not spending permission.",
+    payment:
+      "Each new test requires price confirmation. An interrupted test continues its original Order.",
+  };
+  return (
+    panel(
+      group[0].toUpperCase() + group.slice(1),
+      groups[group].map(([name, text]) => [
+        "agentpay " + group + " " + name,
+        text,
+      ]),
+      "agentpay " +
+        group +
+        " " +
+        (group === "orders" ? "details ORDER_ID" : groups[group][0][0]),
+    ) +
+    "\n" +
+    notes[group] +
+    "\n"
+  );
+}
+function runNode(args) {
+  return new Promise((resolve) => {
+    const child = spawn(process.execPath, args, {
+      stdio: "inherit",
+      shell: false,
+    });
+    child.once("error", () => {
+      console.error(
+        "Could not launch this command with the selected Node executable. Check AGENTPAY_NODE and run agentpay help.",
+      );
+      resolve(1);
+    });
+    child.once("exit", (code) => resolve(code ?? 1));
+  });
+}
+export async function runUserCli(
+  args,
+  {
+    run = runNode,
+    status = async (write) => {
+      const { showStatusPanel } = await import("./status-panel.mjs");
+      return showStatusPanel(write);
+    },
+    logs = async (role) => {
+      try {
+        const { stdout } = await execute(
+          "journalctl",
+          [
+            "--user",
+            "-u",
+            `agentpay-local-${role}.service`,
+            "-n",
+            "40",
+            "--no-pager",
+          ],
+          { timeout: 10000, maxBuffer: 262144 },
+        );
+        console.log(
+          `Recent ${role === "wallet" ? "Wallet" : "Runtime"} service logs`,
+        );
+        process.stdout.write(
+          !stdout.trim() || stdout.trim() === "-- No entries --"
+            ? "No recent entries for this user service.\n"
+            : stdout,
+        );
+        return 0;
+      } catch {
+        console.error(
+          "Could not read the user service journal. Run agentpay status to check services; verify access to your systemd user journal.",
+        );
+        return 1;
+      }
+    },
+    uninstall = async (options) => {
+      const { uninstallLocal } = await import("./uninstall-local.mjs");
+      return uninstallLocal(options);
+    },
+    connect = async (args, options) => {
+      const { connectMarket } = await import("./connect-market.mjs");
+      return connectMarket(args, options);
+    },
+    write = console.log,
+  } = {},
+) {
+  const [command, ...rest] = args;
+  const script = (name) => join(installedUserDir, "scripts", name + ".mjs");
+  const isHelp = (value) => ["help", "--help", "-h"].includes(value);
+  if (!command || isHelp(command)) {
+    if (rest.length && groups[rest[0]]) write(topicHelp(rest[0], rest[1]));
+    else write(helpText);
+    return 0;
+  }
+  if (
+    groups[command] &&
+    (!rest.length || (rest.length === 1 && isHelp(rest[0])))
+  ) {
+    write(topicHelp(command));
+    return 0;
+  }
+  const [action, ...values] = rest;
+  if (groups[command] && values.length === 1 && isHelp(values[0])) {
+    write(topicHelp(command, action));
+    return 0;
+  }
+  if (
+    ["update", "repair", "install", "setup", "status", "uninstall"].includes(command) &&
+    rest.length === 1 &&
+    isHelp(action)
+  ) {
+    write(helpText);
+    return 0;
+  }
+  if (command === "orders" && action === "files" && !values.length) {
+    write(
+      panel("Order files", [
+        ["agentpay orders files ORDER_ID", "List cached attachments"],
+        [
+          "agentpay orders files ORDER_ID remove FILE_KEY",
+          "Confirm removal of one copy",
+        ],
+      ]),
+    );
+    return 0;
+  }
+  if (
+    command === "service" &&
+    action === "autostart" &&
+    (!values.length || (values.length === 1 && isHelp(values[0])))
+  ) {
+    write(topicHelp(command, action));
+    return 0;
+  }
+  if (command === "install" && rest.length === 2 && action === "--market")
+    return run([script("install-user"), ...rest]);
+  if (
+    command === "repair" &&
+    (!rest.length || (rest.length === 1 && action === "-f"))
+  )
+    return run([script("repair"), ...rest]);
+  if (command === "update" && (!rest.length || (rest.length === 1 && action === "-f")))
+    return run([script("update"), ...rest]);
+  if (command === "setup" && !rest.length)
+    return run([script("user-setup"), "--guided"]);
+  if (command === "payment" && action === "test" && !values.length)
+    return run([script("official-paid-test")]);
+  if (command === "status" && !rest.length) return status(write);
+  if (command === "uninstall" && (!rest.length || (rest.length === 1 && action === "--delete-data"))) return uninstall({ removeData: action === "--delete-data" });
+  if (command === "wallet") {
+    if (["unlock", "lock"].includes(action) && !values.length)
+      return run([script(action)]);
+    if (action === "restore" && !values.length) {
+      const { runWalletRestore } = await import("./restore-wallet.mjs");
+      return runWalletRestore({ write });
+    }
+    if (action === "info" && !values.length) {
+      const { showLocalInfo } = await import("./local-info.mjs");
+      return showLocalInfo({ write });
+    }
+  }
+  if (command === "policy" && !values.length) {
+    if (["renew", "revoke"].includes(action)) return run([script(action)]);
+    if (action === "info") {
+      const { showPolicyInfo } = await import("./policy-info.mjs");
+      return showPolicyInfo({ write });
+    }
+  }
+  if (command === "service") {
+    if (["start", "restart"].includes(action) && !values.length) {
+      const prepared = await run([script("autostart"), "prepare"]);
+      return prepared || run([script("autostart"), action]);
+    }
+    if (action === "stop" && !values.length)
+      return run([script("autostart"), "stop"]);
+    if (
+      action === "autostart" &&
+      values.length === 1 &&
+      ["on", "off"].includes(values[0])
+    )
+      return run([
+        script("autostart"),
+        values[0] === "on" ? "enable" : "disable",
+      ]);
+    if (
+      action === "logs" &&
+      values.length === 1 &&
+      ["wallet", "runtime"].includes(values[0])
+    )
+      return logs(values[0]);
+  }
+  if (
+    command === "market" &&
+    action === "connect" &&
+    (!values.length || (values.length === 2 && values[0] === "--market"))
+  )
+    return connect(values, { write });
+  if (command === "orders") {
+    if (action === "files") {
+      const { runFileCache } = await import("./file-cache-cli.mjs");
+      return runFileCache(values, { write });
+    }
+    if (
+      (action === "list" && !values.length) ||
+      ([
+        "details",
+        "status",
+        "retrieve",
+        "case",
+        "archive",
+        "unarchive",
+      ].includes(action) &&
+        values.length === 1)
+    ) {
+      const { runOrderSupport } = await import("./order-support.mjs");
+      return runOrderSupport(action === "list" ? [] : [values[0], action], {
+        write,
+      });
+    }
+  }
+  if (command === "cache") {
+    const { runCacheManagement } = await import("./cache-management-cli.mjs");
+    return runCacheManagement(
+      [...(action === "info" ? ["summary"] : [action]), ...values],
+      { write },
+    );
+  }
+  write(
+    "Unknown command or arguments. " +
+      (groups[command] ? "Use agentpay " + command + " help." : "Use agentpay help."),
+  );
+  return 2;
+}