@zcash-app/dashboard 0.0.1 → 0.1.0-alpha.4

package/README.md

@@ -0,0 +1,50 @@
+# @zcash-app/dashboard
+
+Developer dashboard and real-time explorer for shielded Zcash applications on the Z3 stack.
+
+## Getting Started
+
+Run the development server:
+
+```bash
+pnpm dev
+```
+
+Open [http://localhost:3050](http://localhost:3050) with your browser to view the dashboard.
+
+## Security & Storage Architecture
+
+> [!WARNING]
+> **Plaintext Memo & Counterparty Storage**:
+> Decrypted transaction memos and counterparties are stored in **plaintext** in the SQLite wallet database (`wallet_transactions` table) to support local search, history inspection, and accounting.
+> 
+> To protect user privacy:
+> - Persisted databases are stored under `~/.zcash-app/dashboard/`.
+> - Directory permissions are strictly enforced to `0700` (read, write, execute by owner only).
+> - SQLite database files are strictly enforced to `0600` (read and write by owner only).
+> - Spending keys are never persisted in the dashboard database; only view keys and public metadata are stored.
+
+## Background Synchronization & API
+
+The dashboard uses non-blocking background synchronization with the indexer via `@zcash-app/sdk`:
+
+- **`/api/sync/status`**: Returns immediate sync status without blocking (`status`, `scanned`, `target`, `notesFound`, `pendingFetches`, `failedFetches`). Responses always return in under 5 seconds (typically < 50ms).
+- **Batch Transaction Fetching**: For each transaction touching the wallet (new note or spent nullifier), the full transaction is fetched, decrypted, and upserted idempotently into `wallet_transactions` (keyed by `txid + action_index + direction`).
+- **Chain Reorganization**: On reorg detection, `resolveReorg` rolls back commitment trees and deletes orphaned rows in `wallet_transactions` at `height >= fromHeight`.
+
+## Theme Configuration
+
+The dashboard uses a dark cypherpunk-industrial color palette configured entirely via CSS custom properties in `src/app/globals.css` under `:root`. Zero hard-coded hex colors exist in component files.
+
+To change the primary accent (e.g. from teal to electric gold or violet), edit `:root` in `src/app/globals.css`:
+
+```css
+:root {
+  /* Change primary accent */
+  --accent-primary: #f59e0b;       /* e.g. Gold */
+  --btn-primary-bg-start: #f59e0b;
+  --btn-primary-bg-end: #d97706;
+  --btn-primary-text: #1c1917;     /* High contrast text */
+  --progress-fill: #f59e0b;
+}
+```

package/next.config.mjs

@@ -0,0 +1,12 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  serverExternalPackages: ["@zcash-app/core", "@zcash-app/sdk", "@grpc/grpc-js"],
+  webpack: (config) => {
+    config.externals = [...(config.externals || []), "@zcash-app/core", "@zcash-app/sdk"];
+    return config;
+  },
+  allowedDevOrigins: ['127.0.0.1', 'localhost'],
+  turbopack: {},
+};
+
+export default nextConfig;

package/package.json

@@ -1,10 +1,58 @@
 {
   "name": "@zcash-app/dashboard",
-  "version": "0.0.1",
-  "description": "Placeholder. Real releases are published from CI (create-zcash-app).",
+  "version": "0.1.0-alpha.4",
+  "description": "Developer dashboard for shielded Zcash apps",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Ultra-Tech-code/create-zcash-app.git"
+    "url": "git+https://github.com/Ultra-Tech-code/create-zcash-app.git",
+    "directory": "packages/dashboard"
+  },
+  "homepage": "https://github.com/Ultra-Tech-code/create-zcash-app#readme",
+  "bugs": {
+    "url": "https://github.com/Ultra-Tech-code/create-zcash-app/issues"
+  },
+  "keywords": [
+    "zcash",
+    "shielded",
+    "orchard",
+    "dashboard",
+    "developer-tools"
+  ],
+  "files": [
+    ".next",
+    "!.next/cache/**",
+    "!.next/dev/**",
+    "!.next/diagnostics/**",
+    "!.next/types/**",
+    "!.next/trace",
+    "!.next/trace-build",
+    "!.next/trace*",
+    "public",
+    "package.json",
+    "next.config.mjs",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "next": "16.4.2",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "@zcash-app/sdk": "0.1.0-alpha.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "eslint": "^9",
+    "eslint-config-next": "16.4.2",
+    "playwright": "^1.64.1",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "dev": "next dev -p 3050 --webpack",
+    "build": "next build --webpack",
+    "start": "next start -p 3050",
+    "lint": "eslint",
+    "test": "node --test test/*.test.mjs"
   }
-}
+}

package/public/file.svg

@@ -0,0 +1 @@
+<svg fill="none" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><path d="M14.5 13.5V5.41a1 1 0 0 0-.3-.7L9.8.29A1 1 0 0 0 9.08 0H1.5v13.5A2.5 2.5 0 0 0 4 16h8a2.5 2.5 0 0 0 2.5-2.5m-1.5 0v-7H8v-5H3v12a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1M9.5 5V2.12L12.38 5zM5.13 5h-.62v1.25h2.12V5zm-.62 3h7.12v1.25H4.5zm.62 3h-.62v1.25h7.12V11z" clip-rule="evenodd" fill="#666" fill-rule="evenodd"/></svg>

package/public/globe.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g clip-path="url(#a)"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.27 14.1a6.5 6.5 0 0 0 3.67-3.45q-1.24.21-2.7.34-.31 1.83-.97 3.1M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16m.48-1.52a7 7 0 0 1-.96 0H7.5a4 4 0 0 1-.84-1.32q-.38-.89-.63-2.08a40 40 0 0 0 3.92 0q-.25 1.2-.63 2.08a4 4 0 0 1-.84 1.31zm2.94-4.76q1.66-.15 2.95-.43a7 7 0 0 0 0-2.58q-1.3-.27-2.95-.43a18 18 0 0 1 0 3.44m-1.27-3.54a17 17 0 0 1 0 3.64 39 39 0 0 1-4.3 0 17 17 0 0 1 0-3.64 39 39 0 0 1 4.3 0m1.1-1.17q1.45.13 2.69.34a6.5 6.5 0 0 0-3.67-3.44q.65 1.26.98 3.1M8.48 1.5l.01.02q.41.37.84 1.31.38.89.63 2.08a40 40 0 0 0-3.92 0q.25-1.2.63-2.08a4 4 0 0 1 .85-1.32 7 7 0 0 1 .96 0m-2.75.4a6.5 6.5 0 0 0-3.67 3.44 29 29 0 0 1 2.7-.34q.31-1.83.97-3.1M4.58 6.28q-1.66.16-2.95.43a7 7 0 0 0 0 2.58q1.3.27 2.95.43a18 18 0 0 1 0-3.44m.17 4.71q-1.45-.12-2.69-.34a6.5 6.5 0 0 0 3.67 3.44q-.65-1.27-.98-3.1" fill="#666"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h16v16H0z"/></clipPath></defs></svg>

package/public/next.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

package/public/vercel.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1155 1000"><path d="m577.3 0 577.4 1000H0z" fill="#fff"/></svg>

package/public/window.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.5 2.5h13v10a1 1 0 0 1-1 1h-11a1 1 0 0 1-1-1zM0 1h16v11.5a2.5 2.5 0 0 1-2.5 2.5h-11A2.5 2.5 0 0 1 0 12.5zm3.75 4.5a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5M7 4.75a.75.75 0 1 1-1.5 0 .75.75 0 0 1 1.5 0m1.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5" fill="#666"/></svg>