@tokamak-private-dapps/private-state-cli 2.1.1 → 2.2.0

package/commands/wallet.mjs

@@ -0,0 +1,80 @@
+import {
+  assertProviderChainIdMatchesNetwork,
+  assertListLocalWalletsArgs,
+  assertRecoverWalletArgs,
+  assertWalletChannelMoveArgs,
+  assertWalletExportBackupArgs,
+  assertWalletExportKeyArgs,
+  assertWalletGetChannelFundArgs,
+  assertWalletGetMetaArgs,
+  assertWalletImportBackupArgs,
+  assertWalletImportKeyArgs,
+  handleGrothVaultMove,
+  handleListLocalWallets,
+  handleRecoverWallet,
+  handleWalletExportBackup,
+  handleWalletExportKey,
+  handleWalletGetChannelFund,
+  handleWalletGetMeta,
+  handleWalletImportBackup,
+  handleWalletImportKey,
+  loadExplicitCommandRuntime,
+  loadWalletCommandRuntime,
+} from "../lib/runtime.mjs";
+
+export const walletCommands = Object.freeze({
+  "wallet-list": async (args) => {
+    assertListLocalWalletsArgs(args);
+    handleListLocalWallets({ args });
+  },
+  "wallet-export-backup": async (args) => {
+    assertWalletExportBackupArgs(args);
+    handleWalletExportBackup({ args });
+  },
+  "wallet-export-viewing-key": async (args) => {
+    assertWalletExportKeyArgs(args, "wallet-export-viewing-key");
+    handleWalletExportKey({ args, keyKind: "viewing" });
+  },
+  "wallet-export-spending-key": async (args) => {
+    assertWalletExportKeyArgs(args, "wallet-export-spending-key");
+    handleWalletExportKey({ args, keyKind: "spending" });
+  },
+  "wallet-import-backup": async (args) => {
+    assertWalletImportBackupArgs(args);
+    handleWalletImportBackup({ args });
+  },
+  "wallet-import-viewing-key": async (args) => {
+    assertWalletImportKeyArgs(args, "wallet-import-viewing-key");
+    handleWalletImportKey({ args, keyKind: "viewing" });
+  },
+  "wallet-import-spending-key": async (args) => {
+    assertWalletImportKeyArgs(args, "wallet-import-spending-key");
+    handleWalletImportKey({ args, keyKind: "spending" });
+  },
+  "wallet-recover-workspace": async (args) => {
+    assertRecoverWalletArgs(args);
+    const { network, provider, rpcUrl } = loadExplicitCommandRuntime(args, { staticNetwork: true, prepareArtifacts: true });
+    await assertProviderChainIdMatchesNetwork({ provider, network, rpcUrl });
+    await handleRecoverWallet({ args, network, provider, rpcUrl });
+  },
+  "wallet-get-meta": async (args) => {
+    assertWalletGetMetaArgs(args);
+    const { provider } = loadWalletCommandRuntime(args, { prepareArtifacts: true });
+    await handleWalletGetMeta({ args, provider });
+  },
+  "wallet-get-channel-fund": async (args) => {
+    assertWalletGetChannelFundArgs(args);
+    const { provider } = loadWalletCommandRuntime(args, { prepareArtifacts: true });
+    await handleWalletGetChannelFund({ args, provider });
+  },
+  "wallet-deposit-channel": async (args) => {
+    assertWalletChannelMoveArgs(args, "wallet-deposit-channel");
+    const { provider } = loadWalletCommandRuntime(args, { prepareArtifacts: true });
+    await handleGrothVaultMove({ args, provider, direction: "deposit" });
+  },
+  "wallet-withdraw-channel": async (args) => {
+    assertWalletChannelMoveArgs(args, "wallet-withdraw-channel");
+    const { provider } = loadWalletCommandRuntime(args, { prepareArtifacts: true });
+    await handleGrothVaultMove({ args, provider, direction: "withdraw" });
+  },
+});

package/investigator/README.md

@@ -10,13 +10,13 @@ private-state-cli wallet get-notes \
   --acknowledge-full-note-plaintext-export
 ```
 
-Open `index.html` in a modern browser, load the raw ZIP, select a filter scope, and build a narrower
-user-consent disclosure ZIP. From an installed CLI package, `private-state-cli investigator` prints the bundled
-HTML path and opens it in the default browser.
+Open `index.html` in a modern browser, load the raw ZIP, choose the disclosure request type, inspect the graph, and
+build a narrower user-consent disclosure ZIP. From an installed CLI package, `private-state-cli investigator` prints
+the bundled HTML path and opens it in the default browser.
 
 The tool does not run a server and does not send files over the network. It reads the selected ZIP in
-the browser and writes a new ZIP with selected note records plus directly referenced transaction,
-receipt, and event files.
+the browser. It can write a new ZIP with selected note records plus directly referenced transaction,
+receipt, and event files, and it can export a Markdown ASCII-art linkage report.
 
 The raw evidence bundle contains plaintext for all locally known notes. Do not submit the raw bundle
 as an exchange or auditor package unless full wallet-history disclosure is intended. Use the
@@ -26,7 +26,17 @@ The investigator accepts current epoch-aware evidence bundles only. Supported no
 `wallets/<wallet>/epochs/<epoch-id>/notes/` inside the ZIP. If a bundle uses an older layout, rebuild the local wallet
 workspace with `wallet recover-workspace` and export a new evidence ZIP with `wallet get-notes --export-evidence`.
 
-## Supported Filtering
+## Supported Investigation Views
+
+- purpose-first request presets for full graph view, specific note receipt, specific note use, transaction linkage,
+  period receipts, and counterparty subsets
+- an interactive SVG note-linkage graph where every matched note is a node
+- graph edges for external note creation, external note spend, and locally recoverable note-to-note linkage
+- node detail overlays showing commitment, nullifier, value, status, creation reference, spend reference, direction, and
+  available counterparty metadata
+- a Markdown ASCII-art report with a compact graph section and separate note detail sections
+
+## Supported Filtering Inputs
 
 - note commitment or nullifier
 - creation transaction or spend transaction