npm - @mysten-incubation/devstack - Versions diffs - 0.0.1 → 0.1.0 - Mend

@mysten-incubation/devstack 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (838) hide show

package/dist/plugins/dashboard/server.mjs ADDED Viewed

@@ -0,0 +1,166 @@
+import { checkOrigin } from "./origin-policy.mjs";
+import { dashboardSchema } from "./schema.mjs";
+import { existsSync, readFileSync, statSync } from "node:fs";
+import { join, normalize, resolve, sep } from "node:path";
+import { fileURLToPath } from "node:url";
+import { createYoga } from "graphql-yoga";
+//#region src/plugins/dashboard/server.ts
+const DASHBOARD_UI_DIR = fileURLToPath(new URL("../../../dashboard-ui", import.meta.url));
+const CONTENT_TYPES = {
+	".html": "text/html; charset=utf-8",
+	".js": "text/javascript; charset=utf-8",
+	".mjs": "text/javascript; charset=utf-8",
+	".css": "text/css; charset=utf-8",
+	".json": "application/json; charset=utf-8",
+	".map": "application/json; charset=utf-8",
+	".svg": "image/svg+xml",
+	".png": "image/png",
+	".jpg": "image/jpeg",
+	".jpeg": "image/jpeg",
+	".gif": "image/gif",
+	".webp": "image/webp",
+	".ico": "image/x-icon",
+	".woff": "font/woff",
+	".woff2": "font/woff2",
+	".ttf": "font/ttf",
+	".txt": "text/plain; charset=utf-8",
+	".wasm": "application/wasm"
+};
+const contentTypeFor = (path) => {
+	const dot = path.lastIndexOf(".");
+	return CONTENT_TYPES[dot === -1 ? "" : path.slice(dot).toLowerCase()] ?? "application/octet-stream";
+};
+const testPage = (graphqlEndpoint) => `<!doctype html>
+<html lang="en">
+<head><meta charset="utf-8" /><title>devstack dashboard — API test</title>
+<style>body{font:14px/1.5 ui-monospace,monospace;background:#05080f;color:#e6eefb;margin:0;padding:24px}
+button{font:inherit;background:#1b2740;color:#e6eefb;border:1px solid #2c3c5e;border-radius:6px;padding:6px 12px;cursor:pointer}
+pre{background:#0b1322;border:1px solid #1b2740;border-radius:8px;padding:16px;overflow:auto;max-height:70vh}
+a{color:#69b7ff}</style></head>
+<body>
+<h1>devstack dashboard — API test</h1>
+<p>The bundled UI was not found (run <code>pnpm build</code> to bundle it). Falling back to the API test page.</p>
+<p>GraphiQL: <a href="${graphqlEndpoint}">${graphqlEndpoint}</a></p>
+<p><button id="load">query { state }</button> <button id="restart">mutation { restart }</button></p>
+<pre id="out">…</pre>
+<script type="module">
+const ep = ${JSON.stringify(graphqlEndpoint)};
+const out = document.getElementById('out');
+async function gql(query){
+  const r = await fetch(ep,{method:'POST',headers:{'content-type':'application/json'},body:JSON.stringify({query})});
+  return r.json();
+}
+document.getElementById('load').onclick = async () => {
+  out.textContent = JSON.stringify(await gql('{ ping state { cycle { id phase } summary { total ready failed health } services { key status } } }'), null, 2);
+};
+document.getElementById('restart').onclick = async () => {
+  out.textContent = JSON.stringify(await gql('mutation { restart { ok command } }'), null, 2);
+};
+<\/script>
+</body></html>`;
+/** CORS policy for the control plane, driven by the stack-scoped origin
+*  allowlist (`origin-policy.ts`).
+*
+*  The GraphQL schema exposes DESTRUCTIVE mutations (wipe/prune/shutdown/
+*  restart/restoreSnapshot/deleteSnapshot/mint). Since JSON POSTs are
+*  preflighted, a correct CORS policy is a real defense: it stops any
+*  site the user happens to be visiting — INCLUDING a sibling devstack
+*  stack on another `*.localhost` host — from driving a cross-origin
+*  request against this stack's dashboard.
+*
+*  We reflect the request `Origin` back ONLY when it is in THIS stack's
+*  allowlist (the dashboard's own router-fronted origin + direct loopback
+*  origins + caller-supplied `allowedOrigins`). The same-origin bundled SPA
+*  is served from the routed origin, so its `Origin` is in the allowlist and
+*  works. Every other origin — including a bare `*.localhost` from another
+*  stack — is denied (no `Access-Control-Allow-Origin` → the browser blocks
+*  the cross-origin read/write). A missing Origin (server-side tooling, the
+*  readiness probe) yields no CORS headers but a normal response.
+*  `credentials` stays `false`. */
+const corsOptionsFor = (policy) => (request) => {
+	const origin = request.headers.get("origin");
+	if (checkOrigin(policy, origin) !== "ok") return false;
+	return {
+		origin: [origin],
+		credentials: false
+	};
+};
+/** Strip query/hash and decode a request path into a relative file path. */
+const requestPathname = (url) => {
+	const noQuery = url.split(/[?#]/, 1)[0] ?? "/";
+	try {
+		return decodeURIComponent(noQuery);
+	} catch {
+		return noQuery;
+	}
+};
+/** Resolve a request pathname to an absolute file inside `root`, returning
+*  `undefined` for traversal attempts or paths that escape `root`.
+*
+*  Traversal is REJECTED, not re-rooted: if the normalized path still bears
+*  a `..` segment we bail rather than stripping it and serving a different
+*  file than was requested. The `startsWith(root)` guard then closes any
+*  residual escape (e.g. a sibling dir sharing a prefix). */
+const safeResolve = (root, pathname) => {
+	const normalized = normalize(pathname);
+	if (normalized === ".." || normalized.startsWith(`..${sep}`) || normalized.startsWith("../") || normalized.includes(`${sep}..${sep}`) || normalized.includes("/../") || normalized.endsWith(`${sep}..`) || normalized.endsWith("/..")) return;
+	const abs = resolve(root, normalized.replace(/^[/\\]+/, ""));
+	const rootWithSep = root.endsWith(sep) ? root : root + sep;
+	if (abs !== root && !abs.startsWith(rootWithSep)) return void 0;
+	return abs;
+};
+/** Build a Node request listener routing `/graphql` to yoga and everything
+*  else to the bundled SPA (with an index.html fallback for client routing).
+*  Falls back to the inline API test page when the UI bundle is absent. */
+const makeDashboardListener = (opts) => {
+	const graphqlEndpoint = opts.graphqlEndpoint ?? "/graphql";
+	const assetsDir = opts.assetsDir ?? DASHBOARD_UI_DIR;
+	const indexHtmlPath = join(assetsDir, "index.html");
+	const uiAvailable = existsSync(indexHtmlPath);
+	if (!uiAvailable) console.warn(`[devstack:dashboard] bundled UI not found at ${assetsDir}; serving the API test page only. Run \`pnpm build\` (or \`pnpm --filter @mysten-incubation/devstack build:dashboard-ui\`) to bundle the dashboard.`);
+	const yoga = createYoga({
+		schema: dashboardSchema,
+		context: () => opts.context,
+		graphqlEndpoint,
+		graphiql: true,
+		landingPage: false,
+		cors: corsOptionsFor(opts.originPolicy)
+	});
+	const fallbackPage = testPage(graphqlEndpoint);
+	const isGraphql = (pathname) => pathname === graphqlEndpoint || pathname.startsWith(`${graphqlEndpoint}/`);
+	const sendFile = (res, absPath) => {
+		try {
+			if (!statSync(absPath).isFile()) return false;
+			const body = readFileSync(absPath);
+			res.statusCode = 200;
+			res.setHeader("content-type", contentTypeFor(absPath));
+			res.end(body);
+			return true;
+		} catch {
+			return false;
+		}
+	};
+	return (req, res) => {
+		const pathname = requestPathname(req.url ?? "/");
+		if (isGraphql(pathname)) {
+			yoga(req, res);
+			return;
+		}
+		if (!uiAvailable) {
+			res.statusCode = 200;
+			res.setHeader("content-type", "text/html; charset=utf-8");
+			res.end(fallbackPage);
+			return;
+		}
+		const abs = pathname === "/" ? void 0 : safeResolve(assetsDir, pathname);
+		if (abs !== void 0 && sendFile(res, abs)) return;
+		if (sendFile(res, indexHtmlPath)) return;
+		res.statusCode = 404;
+		res.setHeader("content-type", "text/plain; charset=utf-8");
+		res.end("not found");
+	};
+};
+//#endregion
+export { makeDashboardListener };
+//# sourceMappingURL=server.mjs.map

package/dist/plugins/dashboard/server.mjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"server.mjs","names":[],"sources":["../../../src/plugins/dashboard/server.ts"],"sourcesContent":["// Dashboard HTTP listener.\n//\n// graphql-yoga hosts the Pothos schema at `/graphql` (with GraphiQL for\n// manual testing and SSE for subscriptions). Every other path serves the\n// built React SPA bundled with this package under `dashboard-ui/` (produced\n// by `pnpm build`'s `build:dashboard-ui` step and shipped via the package\n// `files` array). The listener is handed to `listenScopedHttpServer`, which\n// owns bind + graceful close.\n//\n// The SPA is served as static files with a client-side-routing fallback to\n// `index.html`. When the UI has not been built (the bundled dir is absent),\n// the listener logs a warning once and falls back to the inline test page so\n// `/graphql` and manual API checks keep working.\n\nimport { existsSync, readFileSync, statSync } from 'node:fs';\nimport { join, normalize, resolve, sep } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport { createYoga, type CORSOptions } from 'graphql-yoga';\nimport { dashboardSchema, type DashboardContext } from './schema.ts';\nimport { checkOrigin, type OriginPolicy } from './origin-policy.ts';\nimport type { HttpRequestListener } from '../../substrate/runtime/scoped-http-server.ts';\n\nexport interface DashboardListenerOptions {\n\t/** Per-request control-plane context (the `state` ref + `publishCommand`).\n\t * The dashboard is single-tenant, so this is constant for the server's\n\t * lifetime and handed to yoga as a static `context` factory. */\n\treadonly context: DashboardContext;\n\t/** Stack-scoped origin allowlist (see `origin-policy.ts`). Gates the CORS\n\t * reflection on `/graphql`: an Origin in the allowlist is echoed back; a\n\t * missing Origin (server-side / readiness probe) gets a normal response\n\t * with no CORS headers; any other Origin is denied (no `Access-Control-\n\t * Allow-Origin` → the browser blocks the cross-origin read/write). */\n\treadonly originPolicy: OriginPolicy;\n\t/** GraphQL path. Defaults to `/graphql`. */\n\treadonly graphqlEndpoint?: string;\n\t/** Override the bundled UI assets dir (mainly for tests). Defaults to the\n\t * package's `dashboard-ui/` directory resolved from this module. */\n\treadonly assetsDir?: string;\n}\n\n// The built SPA is copied into `<package root>/dashboard-ui/`. This module\n// compiles to `<root>/dist/plugins/dashboard/server.mjs`; the source lives at\n// `<root>/src/plugins/dashboard/server.ts`. Both are three levels below the\n// package root, so the same relative path resolves the bundled dir whether\n// running from `dist/` (installed dependency or repo build) or `src/`\n// (`--experimental-strip-types`).\nconst DASHBOARD_UI_DIR = fileURLToPath(new URL('../../../dashboard-ui', import.meta.url));\n\nconst CONTENT_TYPES: Record<string, string> = {\n\t'.html': 'text/html; charset=utf-8',\n\t'.js': 'text/javascript; charset=utf-8',\n\t'.mjs': 'text/javascript; charset=utf-8',\n\t'.css': 'text/css; charset=utf-8',\n\t'.json': 'application/json; charset=utf-8',\n\t'.map': 'application/json; charset=utf-8',\n\t'.svg': 'image/svg+xml',\n\t'.png': 'image/png',\n\t'.jpg': 'image/jpeg',\n\t'.jpeg': 'image/jpeg',\n\t'.gif': 'image/gif',\n\t'.webp': 'image/webp',\n\t'.ico': 'image/x-icon',\n\t'.woff': 'font/woff',\n\t'.woff2': 'font/woff2',\n\t'.ttf': 'font/ttf',\n\t'.txt': 'text/plain; charset=utf-8',\n\t'.wasm': 'application/wasm',\n};\n\nconst contentTypeFor = (path: string): string => {\n\tconst dot = path.lastIndexOf('.');\n\tconst ext = dot === -1 ? '' : path.slice(dot).toLowerCase();\n\treturn CONTENT_TYPES[ext] ?? 'application/octet-stream';\n};\n\nconst testPage = (graphqlEndpoint: string): string => `<!doctype html>\n<html lang=\"en\">\n<head><meta charset=\"utf-8\" /><title>devstack dashboard — API test</title>\n<style>body{font:14px/1.5 ui-monospace,monospace;background:#05080f;color:#e6eefb;margin:0;padding:24px}\nbutton{font:inherit;background:#1b2740;color:#e6eefb;border:1px solid #2c3c5e;border-radius:6px;padding:6px 12px;cursor:pointer}\npre{background:#0b1322;border:1px solid #1b2740;border-radius:8px;padding:16px;overflow:auto;max-height:70vh}\na{color:#69b7ff}</style></head>\n<body>\n<h1>devstack dashboard — API test</h1>\n<p>The bundled UI was not found (run <code>pnpm build</code> to bundle it). Falling back to the API test page.</p>\n<p>GraphiQL: <a href=\"${graphqlEndpoint}\">${graphqlEndpoint}</a></p>\n<p><button id=\"load\">query { state }</button> <button id=\"restart\">mutation { restart }</button></p>\n<pre id=\"out\">…</pre>\n<script type=\"module\">\nconst ep = ${JSON.stringify(graphqlEndpoint)};\nconst out = document.getElementById('out');\nasync function gql(query){\n const r = await fetch(ep,{method:'POST',headers:{'content-type':'application/json'},body:JSON.stringify({query})});\n return r.json();\n}\ndocument.getElementById('load').onclick = async () => {\n out.textContent = JSON.stringify(await gql('{ ping state { cycle { id phase } summary { total ready failed health } services { key status } } }'), null, 2);\n};\ndocument.getElementById('restart').onclick = async () => {\n out.textContent = JSON.stringify(await gql('mutation { restart { ok command } }'), null, 2);\n};\n</script>\n</body></html>`;\n\n/** CORS policy for the control plane, driven by the stack-scoped origin\n * allowlist (`origin-policy.ts`).\n *\n * The GraphQL schema exposes DESTRUCTIVE mutations (wipe/prune/shutdown/\n * restart/restoreSnapshot/deleteSnapshot/mint). Since JSON POSTs are\n * preflighted, a correct CORS policy is a real defense: it stops any\n * site the user happens to be visiting — INCLUDING a sibling devstack\n * stack on another `*.localhost` host — from driving a cross-origin\n * request against this stack's dashboard.\n *\n * We reflect the request `Origin` back ONLY when it is in THIS stack's\n * allowlist (the dashboard's own router-fronted origin + direct loopback\n * origins + caller-supplied `allowedOrigins`). The same-origin bundled SPA\n * is served from the routed origin, so its `Origin` is in the allowlist and\n * works. Every other origin — including a bare `*.localhost` from another\n * stack — is denied (no `Access-Control-Allow-Origin` → the browser blocks\n * the cross-origin read/write). A missing Origin (server-side tooling, the\n * readiness probe) yields no CORS headers but a normal response.\n * `credentials` stays `false`. */\nconst corsOptionsFor =\n\t(policy: OriginPolicy) =>\n\t(request: Request): CORSOptions => {\n\t\tconst origin = request.headers.get('origin');\n\t\t// No Origin (same-origin / non-CORS request) or a forbidden Origin →\n\t\t// no CORS headers. `false` denies; CORS never alters the status, so a\n\t\t// no-Origin server-side request still gets its normal 200 response.\n\t\tif (checkOrigin(policy, origin) !== 'ok') return false;\n\t\t// Reflect this exact origin (single-element array → echoed verbatim).\n\t\treturn { origin: [origin as string], credentials: false };\n\t};\n\n/** Strip query/hash and decode a request path into a relative file path. */\nconst requestPathname = (url: string): string => {\n\tconst noQuery = url.split(/[?#]/, 1)[0] ?? '/';\n\ttry {\n\t\treturn decodeURIComponent(noQuery);\n\t} catch {\n\t\treturn noQuery;\n\t}\n};\n\n/** Resolve a request pathname to an absolute file inside `root`, returning\n * `undefined` for traversal attempts or paths that escape `root`.\n *\n * Traversal is REJECTED, not re-rooted: if the normalized path still bears\n * a `..` segment we bail rather than stripping it and serving a different\n * file than was requested. The `startsWith(root)` guard then closes any\n * residual escape (e.g. a sibling dir sharing a prefix). */\nconst safeResolve = (root: string, pathname: string): string | undefined => {\n\tconst normalized = normalize(pathname);\n\t// A surviving `..` segment means the request tried to climb out of `root`;\n\t// reject rather than re-root. Cover both separators and bare/trailing forms.\n\tif (\n\t\tnormalized === '..' ||\n\t\tnormalized.startsWith(`..${sep}`) ||\n\t\tnormalized.startsWith('../') ||\n\t\tnormalized.includes(`${sep}..${sep}`) ||\n\t\tnormalized.includes('/../') ||\n\t\tnormalized.endsWith(`${sep}..`) ||\n\t\tnormalized.endsWith('/..')\n\t) {\n\t\treturn undefined;\n\t}\n\tconst rel = normalized.replace(/^[/\\\\]+/, '');\n\tconst abs = resolve(root, rel);\n\tconst rootWithSep = root.endsWith(sep) ? root : root + sep;\n\tif (abs !== root && !abs.startsWith(rootWithSep)) return undefined;\n\treturn abs;\n};\n\n/** Build a Node request listener routing `/graphql` to yoga and everything\n * else to the bundled SPA (with an index.html fallback for client routing).\n * Falls back to the inline API test page when the UI bundle is absent. */\nexport const makeDashboardListener = (opts: DashboardListenerOptions): HttpRequestListener => {\n\tconst graphqlEndpoint = opts.graphqlEndpoint ?? '/graphql';\n\tconst assetsDir = opts.assetsDir ?? DASHBOARD_UI_DIR;\n\tconst indexHtmlPath = join(assetsDir, 'index.html');\n\tconst uiAvailable = existsSync(indexHtmlPath);\n\n\tif (!uiAvailable) {\n\t\t// eslint-disable-next-line no-console\n\t\tconsole.warn(\n\t\t\t`[devstack:dashboard] bundled UI not found at ${assetsDir}; serving the API test page only. Run \\`pnpm build\\` (or \\`pnpm --filter @mysten-incubation/devstack build:dashboard-ui\\`) to bundle the dashboard.`,\n\t\t);\n\t}\n\n\tconst yoga = createYoga({\n\t\tschema: dashboardSchema,\n\t\tcontext: () => opts.context,\n\t\tgraphqlEndpoint,\n\t\tgraphiql: true,\n\t\tlandingPage: false,\n\t\t// Stack-scoped origin allowlist (see `corsOptionsFor` / `origin-policy.ts`):\n\t\t// reflect only origins in THIS stack's allowlist so the same-origin bundled\n\t\t// SPA works while arbitrary sites — including a sibling stack on another\n\t\t// `*.localhost` host — are denied cross-origin access to the destructive\n\t\t// control-plane mutations.\n\t\tcors: corsOptionsFor(opts.originPolicy),\n\t});\n\tconst fallbackPage = testPage(graphqlEndpoint);\n\n\t// Reserve `/graphql` by DECODED pathname so encoded variants\n\t// (`/graphql%2F…`, `/%67raphql`) route to yoga instead of leaking into the\n\t// static/SPA path. `pathname` is already query/hash-stripped + decoded.\n\tconst isGraphql = (pathname: string): boolean =>\n\t\tpathname === graphqlEndpoint || pathname.startsWith(`${graphqlEndpoint}/`);\n\n\tconst sendFile = (res: Parameters<HttpRequestListener>[1], absPath: string): boolean => {\n\t\ttry {\n\t\t\tif (!statSync(absPath).isFile()) return false;\n\t\t\tconst body = readFileSync(absPath);\n\t\t\tres.statusCode = 200;\n\t\t\tres.setHeader('content-type', contentTypeFor(absPath));\n\t\t\tres.end(body);\n\t\t\treturn true;\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t};\n\n\treturn (req, res) => {\n\t\tconst url = req.url ?? '/';\n\t\tconst pathname = requestPathname(url);\n\t\tif (isGraphql(pathname)) {\n\t\t\tvoid yoga(req, res);\n\t\t\treturn;\n\t\t}\n\n\t\t// No bundled UI: keep the API test page as an honest fallback.\n\t\tif (!uiAvailable) {\n\t\t\tres.statusCode = 200;\n\t\t\tres.setHeader('content-type', 'text/html; charset=utf-8');\n\t\t\tres.end(fallbackPage);\n\t\t\treturn;\n\t\t}\n\n\t\tconst abs = pathname === '/' ? undefined : safeResolve(assetsDir, pathname);\n\n\t\t// Serve a real static asset when one matches the request path.\n\t\tif (abs !== undefined && sendFile(res, abs)) return;\n\n\t\t// SPA fallback: any other path (client-side route) gets index.html so\n\t\t// the React router can take over.\n\t\tif (sendFile(res, indexHtmlPath)) return;\n\n\t\tres.statusCode = 404;\n\t\tres.setHeader('content-type', 'text/plain; charset=utf-8');\n\t\tres.end('not found');\n\t};\n};\n"],"mappings":";;;;;;;AA8CA,MAAM,mBAAmB,cAAc,IAAI,IAAI,yBAAyB,OAAO,KAAK,IAAI,CAAC;AAEzF,MAAM,gBAAwC;CAC7C,SAAS;CACT,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,QAAQ;CACR,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,SAAS;CACT,QAAQ;CACR,SAAS;CACT,UAAU;CACV,QAAQ;CACR,QAAQ;CACR,SAAS;CACT;AAED,MAAM,kBAAkB,SAAyB;CAChD,MAAM,MAAM,KAAK,YAAY,IAAI;AAEjC,QAAO,cADK,QAAQ,KAAK,KAAK,KAAK,MAAM,IAAI,CAAC,aAAa,KAC9B;;AAG9B,MAAM,YAAY,oBAAoC;;;;;;;;;;wBAU9B,gBAAgB,IAAI,gBAAgB;;;;aAI/C,KAAK,UAAU,gBAAgB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkC7C,MAAM,kBACJ,YACA,YAAkC;CAClC,MAAM,SAAS,QAAQ,QAAQ,IAAI,SAAS;AAI5C,KAAI,YAAY,QAAQ,OAAO,KAAK,KAAM,QAAO;AAEjD,QAAO;EAAE,QAAQ,CAAC,OAAiB;EAAE,aAAa;EAAO;;;AAI3D,MAAM,mBAAmB,QAAwB;CAChD,MAAM,UAAU,IAAI,MAAM,QAAQ,EAAE,CAAC,MAAM;AAC3C,KAAI;AACH,SAAO,mBAAmB,QAAQ;SAC3B;AACP,SAAO;;;;;;;;;;AAWT,MAAM,eAAe,MAAc,aAAyC;CAC3E,MAAM,aAAa,UAAU,SAAS;AAGtC,KACC,eAAe,QACf,WAAW,WAAW,KAAK,MAAM,IACjC,WAAW,WAAW,MAAM,IAC5B,WAAW,SAAS,GAAG,IAAI,IAAI,MAAM,IACrC,WAAW,SAAS,OAAO,IAC3B,WAAW,SAAS,GAAG,IAAI,IAAI,IAC/B,WAAW,SAAS,MAAM,CAE1B;CAGD,MAAM,MAAM,QAAQ,MADR,WAAW,QAAQ,WAAW,GACb,CAAC;CAC9B,MAAM,cAAc,KAAK,SAAS,IAAI,GAAG,OAAO,OAAO;AACvD,KAAI,QAAQ,QAAQ,CAAC,IAAI,WAAW,YAAY,CAAE,QAAO,KAAA;AACzD,QAAO;;;;;AAMR,MAAa,yBAAyB,SAAwD;CAC7F,MAAM,kBAAkB,KAAK,mBAAmB;CAChD,MAAM,YAAY,KAAK,aAAa;CACpC,MAAM,gBAAgB,KAAK,WAAW,aAAa;CACnD,MAAM,cAAc,WAAW,cAAc;AAE7C,KAAI,CAAC,YAEJ,SAAQ,KACP,gDAAgD,UAAU,qJAC1D;CAGF,MAAM,OAAO,WAAW;EACvB,QAAQ;EACR,eAAe,KAAK;EACpB;EACA,UAAU;EACV,aAAa;EAMb,MAAM,eAAe,KAAK,aAAa;EACvC,CAAC;CACF,MAAM,eAAe,SAAS,gBAAgB;CAK9C,MAAM,aAAa,aAClB,aAAa,mBAAmB,SAAS,WAAW,GAAG,gBAAgB,GAAG;CAE3E,MAAM,YAAY,KAAyC,YAA6B;AACvF,MAAI;AACH,OAAI,CAAC,SAAS,QAAQ,CAAC,QAAQ,CAAE,QAAO;GACxC,MAAM,OAAO,aAAa,QAAQ;AAClC,OAAI,aAAa;AACjB,OAAI,UAAU,gBAAgB,eAAe,QAAQ,CAAC;AACtD,OAAI,IAAI,KAAK;AACb,UAAO;UACA;AACP,UAAO;;;AAIT,SAAQ,KAAK,QAAQ;EAEpB,MAAM,WAAW,gBADL,IAAI,OAAO,IACc;AACrC,MAAI,UAAU,SAAS,EAAE;AACnB,QAAK,KAAK,IAAI;AACnB;;AAID,MAAI,CAAC,aAAa;AACjB,OAAI,aAAa;AACjB,OAAI,UAAU,gBAAgB,2BAA2B;AACzD,OAAI,IAAI,aAAa;AACrB;;EAGD,MAAM,MAAM,aAAa,MAAM,KAAA,IAAY,YAAY,WAAW,SAAS;AAG3E,MAAI,QAAQ,KAAA,KAAa,SAAS,KAAK,IAAI,CAAE;AAI7C,MAAI,SAAS,KAAK,cAAc,CAAE;AAElC,MAAI,aAAa;AACjB,MAAI,UAAU,gBAAgB,4BAA4B;AAC1D,MAAI,IAAI,YAAY"}

package/dist/plugins/deepbook/deploy.mjs CHANGED Viewed

@@ -1,30 +1,19 @@
-import { chainId, contentHash } from "../../substrate/brand.mjs";
-import { executeSuiTx } from "../../substrate/runtime/sui-execute/index.mjs";
+import { chainId } from "../../substrate/brand.mjs";
+import { probeManyLenient } from "../../substrate/runtime/probes.mjs";
+import { STALE_OBJECT_VERSION_RETRY_PROFILE, makeSpacedRetrySchedule } from "../../substrate/runtime/retry-policy.mjs";
+import { executeSuiTx, formatExecutedFailure, isSuiStaleObjectVersionError } from "../../substrate/runtime/sui-execute/index.mjs";
+import { artifactPublishError } from "../../primitives/artifact-publisher.mjs";
+import { acquireOnChainArtifact } from "../internal/acquire-on-chain-artifact.mjs";
+import { DeepbookSpans } from "./spans.mjs";
 import { deepbookPluginError } from "./errors.mjs";
-import { Effect, Schema } from "effect";
-import { createHash } from "node:crypto";
+import { currentLedgerObjectRef } from "../../substrate/runtime/sui-ledger/object-ref.mjs";
+import { stableContentHash } from "./hash.mjs";
+import { isPoolForPair } from "./type-strings.mjs";
+import { Effect } from "effect";
 import { normalizeStructTag, normalizeSuiAddress } from "@mysten/sui/utils";
 import { Transaction } from "@mysten/sui/transactions";
 import { bcs } from "@mysten/sui/bcs";
 //#region src/plugins/deepbook/deploy.ts
-const CachedDeepbookPoolSchema = Schema.Struct({
-	name: Schema.String,
-	poolId: Schema.String,
-	base: Schema.String,
-	quote: Schema.String,
-	baseCoinType: Schema.String,
-	quoteCoinType: Schema.String,
-	tickSize: Schema.String,
-	lotSize: Schema.String,
-	minSize: Schema.String
-});
-const CachedDeepbookPoolsSchema = Schema.Struct({ pools: Schema.Array(CachedDeepbookPoolSchema) });
-const CachedDeepbookSeedResultSchema = Schema.Struct({
-	poolName: Schema.String,
-	balanceManagerId: Schema.String,
-	digest: Schema.String
-});
-const stableContentHash = (input) => contentHash(createHash("sha256").update(input).digest("hex"));
 const fromCachedPools = (cached) => ({ pools: cached.pools.map((pool) => ({
 	name: pool.name,
 	poolId: pool.poolId,
@@ -84,25 +73,19 @@ const seedInputsHash = (pkg, signer, spec, pool) => stableContentHash([
 		String(order.payWithDeep ?? false)
 	].join("|"))
 ].join("||"));
+const sdkGetObjectLenient = (sdk, objectId) => Effect.tryPromise({
+	try: () => sdk.core.getObject({ objectId }),
+	catch: () => null
+}).pipe(Effect.catch(() => Effect.succeed(null)));
 const buildVerifyProbe = (sdk, cached) => Effect.gen(function* () {
-	for (const pool of cached.pools) {
-		const raw = yield* Effect.tryPromise({
-			try: () => sdk.core.getObject({ objectId: pool.poolId }),
-			catch: () => null
-		}).pipe(Effect.catch(() => Effect.succeed(null)));
-		if (raw === null || raw === void 0) return null;
-	}
+	if ((yield* probeManyLenient(cached.pools.map((pool) => sdkGetObjectLenient(sdk, pool.poolId)))).some((raw) => raw === null || raw === void 0)) return null;
 	return cached;
 });
 const buildSeedVerifyProbe = (sdk, cached) => Effect.gen(function* () {
-	const raw = yield* Effect.tryPromise({
-		try: () => sdk.core.getObject({ objectId: cached.balanceManagerId }),
-		catch: () => null
-	}).pipe(Effect.catch(() => Effect.succeed(null)));
+	const raw = yield* sdkGetObjectLenient(sdk, cached.balanceManagerId);
 	if (raw === null || raw === void 0) return null;
 	return cached;
 });
-const simulateClient = (sdk) => sdk.client;
 const findExistingPoolId = (sdk, signer, pkg, spec) => Effect.tryPromise({
 	try: async () => {
 		const tx = new Transaction();
@@ -112,7 +95,7 @@ const findExistingPoolId = (sdk, signer, pkg, spec) => Effect.tryPromise({
 			typeArguments: [spec.baseCoinType, spec.quoteCoinType],
 			arguments: [tx.object(pkg.registryId)]
 		});
-		const bytes = (await simulateClient(sdk).core.simulateTransaction({
+		const bytes = (await sdk.client.core.simulateTransaction({
 			transaction: tx,
 			include: {
 				commandResults: true,
@@ -120,7 +103,9 @@ const findExistingPoolId = (sdk, signer, pkg, spec) => Effect.tryPromise({
 			}
 		})).commandResults?.[0]?.returnValues?.[0]?.bcs;
 		if (bytes === void 0) return null;
-		return normalizeSuiAddress(bcs.Address.parse(bytes));
+		const normalized = normalizeSuiAddress(bcs.Address.parse(bytes));
+		if (normalized === normalizeSuiAddress("0x0")) return null;
+		return normalized;
 	},
 	catch: () => null
 }).pipe(Effect.catch(() => Effect.succeed(null)));
@@ -133,52 +118,42 @@ const findExistingPools = (sdk, signer, pkg, pools) => Effect.gen(function* () {
 	return found;
 });
 const pickCreatedPool = (changes, spec) => {
-	const base = normalizeStructTag(spec.baseCoinType);
-	const quote = normalizeStructTag(spec.quoteCoinType);
 	for (const change of changes) {
 		const type = change.objectType;
 		if (change.idOperation !== "Created" || type === void 0) continue;
-		if (!type.includes("::pool::Pool<")) continue;
-		if (type.includes(base) && type.includes(quote)) return change.objectId;
+		if (isPoolForPair(type, spec.baseCoinType, spec.quoteCoinType)) return change.objectId;
 	}
 	return null;
 };
 const mapArtifactError = (phase, err) => deepbookPluginError(phase, err._tag === "ArtifactPublishError" ? err.detail : String(err));
-const transactionBuildClient = (sdk) => sdk.client;
 const ORDER_TYPE_POST_ONLY = 3;
 const SELF_MATCHING_CANCEL_TAKER = 1;
 const MAX_TIMESTAMP = 18446744073709551615n;
 const SUI_TYPE = normalizeStructTag("0x2::sui::SUI");
 const SEED_GAS_BUDGET = 500000000n;
 const LOCALNET_REFERENCE_GAS_PRICE = 1000n;
-const STALE_OBJECT_RETRY_DELAY_MS = 500;
-const STALE_OBJECT_MAX_RETRIES = 20;
-const decodeErrorMessage = (message) => {
-	try {
-		return decodeURIComponent(message);
-	} catch {
-		return message;
-	}
-};
-const isStaleObjectVersionError = (err) => {
-	const message = decodeErrorMessage(err.message);
-	return message.includes("needs to be rebuilt because object") && message.includes("current version");
-};
-const executeSuiTxWithStaleObjectRetry = (params, attempt = 0) => executeSuiTx(params).pipe(Effect.catch((err) => isStaleObjectVersionError(err) && attempt < STALE_OBJECT_MAX_RETRIES ? Effect.sleep(`${STALE_OBJECT_RETRY_DELAY_MS} millis`).pipe(Effect.andThen(executeSuiTxWithStaleObjectRetry(params, attempt + 1))) : Effect.fail(err)));
+/** Retry `executeSuiTx` when the SDK reports a stale object version
+*  (concurrent re-versioning of a shared registry / pool object). The
+*  build closure rebuilds the transaction with fresh refs each attempt;
+*  caps at `STALE_OBJECT_VERSION_RETRY_PROFILE.attempts` so a true
+*  failure surfaces instead of looping forever. */
+const executeSuiTxWithStaleObjectRetry = (params) => executeSuiTx(params).pipe(Effect.retry({
+	schedule: makeSpacedRetrySchedule(STALE_OBJECT_VERSION_RETRY_PROFILE.delayMs, STALE_OBJECT_VERSION_RETRY_PROFILE.attempts),
+	while: isSuiStaleObjectVersionError
+}));
 const createDeepbookPools = (publisher, sdk, chain, signer, pkg, pools) => Effect.gen(function* () {
 	if (pools.length === 0) return { pools: [] };
-	const produced = yield* publisher.publish({
+	const produced = yield* acquireOnChainArtifact(publisher, {
 		namespace: "deepbook/pools",
 		chain: chainId(chain),
 		contentHash: poolInputsHash(pkg, signer, pools),
-		verifySchema: CachedDeepbookPoolsSchema,
 		verify: (cached) => buildVerifyProbe(sdk, cached),
 		produce: Effect.gen(function* () {
 			const existingPools = yield* findExistingPools(sdk, signer, pkg, pools);
 			const missingPools = pools.filter((pool) => !existingPools.has(pool.name));
 			const cachedPools = [];
 			if (missingPools.length > 0) {
-				const receipt = yield* executeSuiTx({
+				const result = yield* executeSuiTx({
 					client: sdk.client,
 					signer,
 					build: async () => {
@@ -202,34 +177,27 @@ const createDeepbookPools = (publisher, sdk, chain, signer, pkg, pools) => Effec
 								tx.object(pkg.adminCapId)
 							]
 						});
-						return tx.build({ client: transactionBuildClient(sdk) });
+						return tx.build({ client: sdk.client });
 					}
-				}).pipe(Effect.mapError((err) => ({
-					_tag: "ArtifactPublishError",
-					reason: "produce-failed",
-					detail: `deepbook pool transaction failed: ${err.message}`
-				})));
+				}).pipe(Effect.mapError((err) => artifactPublishError("produce-failed", `deepbook pool transaction failed: ${err.message}`)));
+				if (result.$kind === "FailedTransaction") return yield* Effect.fail(artifactPublishError("produce-failed", `deepbook pool transaction on-chain execution failed ` + formatExecutedFailure(result.FailedTransaction)));
+				const receipt = result.Transaction;
 				for (const pool of missingPools) {
 					const poolId = pickCreatedPool(receipt.objectChanges, pool);
-					if (poolId === null) return yield* Effect.fail({
-						_tag: "ArtifactPublishError",
-						reason: "produce-failed",
-						detail: `deepbook pool '${pool.name}' not found in objectChanges (digest=${receipt.digest}).`
-					});
+					if (poolId === null) return yield* Effect.fail(artifactPublishError("produce-failed", `deepbook pool '${pool.name}' not found in objectChanges (digest=${receipt.digest}).`));
 					cachedPools.push(toCachedPool(pool, poolId));
 				}
 			}
 			return { pools: pools.map((pool) => existingPools.get(pool.name) ?? cachedPools.find((p) => p.name === pool.name)).filter((pool) => pool !== void 0) };
-		}),
-		register: () => Effect.void
+		})
 	}).pipe(Effect.mapError((err) => mapArtifactError("create-pools", err)));
 	const producedPools = new Map(produced.pools.map((pool) => [pool.name, pool]));
 	const resolvedPools = pools.map((pool) => producedPools.get(pool.name));
 	if (resolvedPools.some((pool) => pool === void 0)) return yield* Effect.fail(deepbookPluginError("create-pools", "deepbook pool creation did not return every pool."));
 	return fromCachedPools({ pools: resolvedPools.filter((pool) => pool !== void 0) });
 }).pipe(Effect.withSpan("devstack.plugin.deepbook.createPools", { attributes: {
-	"deepbook.packageId": pkg.packageId,
-	"deepbook.pool.count": pools.length
+	[DeepbookSpans.packageId]: pkg.packageId,
+	[DeepbookSpans.poolCount]: pools.length
 } }));
 const poolByName = (pools, name) => pools.find((pool) => pool.name === name);
 const pickCreatedBalanceManager = (changes) => {
@@ -262,19 +230,14 @@ const requestSeedFunding = (strategy, signer, coinType, amount) => {
 	return strategy.request({
 		address: signer.address,
 		amount
-	}).pipe(Effect.mapError((err) => ({
-		_tag: "ArtifactPublishError",
-		reason: "produce-failed",
-		detail: `deepbook seed funding failed for ${coinType} to publisher '${signer.name}' amount=${amount}: ${errorDetail(err)}`
-	})));
+	}).pipe(Effect.mapError((err) => artifactPublishError("produce-failed", `deepbook seed funding failed for ${coinType} to publisher '${signer.name}' amount=${amount}: ${errorDetail(err)}`)));
 };
-const coinListClient = (sdk) => sdk.client;
 const selectOwnedCoinsForBalance = async (sdk, signer, coinType, amount, purpose) => {
 	const selected = [];
 	let selectedBalance = 0n;
 	let cursor = null;
 	do {
-		const page = await coinListClient(sdk).core.listCoins({
+		const page = await sdk.client.core.listCoins({
 			owner: signer.address,
 			coinType,
 			cursor,
@@ -295,23 +258,6 @@ const selectOwnedCoinsForBalance = async (sdk, signer, coinType, amount, purpose
 		selectedBalance
 	};
 };
-const ledgerObjectClient = (sdk) => sdk.client;
-const currentLedgerObjectRef = async (sdk, objectId) => {
-	const object = (await ledgerObjectClient(sdk).ledgerService.getObject({
-		objectId,
-		readMask: { paths: [
-			"object_id",
-			"version",
-			"digest"
-		] }
-	})).response?.object;
-	if (object === void 0 || object.objectId === void 0 || object.version === void 0 || object.digest === void 0) throw new Error(`object '${objectId}' was not found while resolving a DeepBook seed input.`);
-	return {
-		objectId: object.objectId,
-		version: object.version.toString(),
-		digest: object.digest
-	};
-};
 const setExplicitSeedGasPayment = async (tx, sdk, signer, suiDepositAmount) => {
 	const { selected } = await selectOwnedCoinsForBalance(sdk, signer, SUI_TYPE, SEED_GAS_BUDGET + suiDepositAmount, "DeepBook seed gas and SUI deposits");
 	const gasRefs = await Promise.all(selected.map((coin) => currentLedgerObjectRef(sdk, coin.objectId)));
@@ -352,16 +298,15 @@ const seedDeepbookPools = (publisher, sdk, chain, signer, pkg, specs, pools) =>
 		if (seed === void 0 || seed.orders.length === 0) continue;
 		const pool = poolByName(pools, spec.name);
 		if (pool === void 0) return yield* Effect.fail(deepbookPluginError("create-pools", `deepbook seed pool '${spec.name}' was not created.`));
-		const result = yield* publisher.publish({
+		const result = yield* acquireOnChainArtifact(publisher, {
 			namespace: `deepbook/seed/${spec.name}`,
 			chain: chainId(chain),
 			contentHash: seedInputsHash(pkg, signer, spec, pool),
-			verifySchema: CachedDeepbookSeedResultSchema,
 			verify: (cached) => buildSeedVerifyProbe(sdk, cached),
 			produce: Effect.gen(function* () {
 				yield* requestSeedFunding(spec.baseFundingStrategy, signer, pool.baseCoinType, seed.baseAmount);
 				yield* requestSeedFunding(spec.quoteFundingStrategy, signer, pool.quoteCoinType, seed.quoteAmount);
-				const receipt = yield* executeSuiTxWithStaleObjectRetry({
+				const result = yield* executeSuiTxWithStaleObjectRetry({
 					client: sdk.client,
 					signer,
 					build: async () => {
@@ -403,33 +348,26 @@ const seedDeepbookPools = (publisher, sdk, chain, signer, pkg, specs, pools) =>
 							]
 						});
 						tx.transferObjects([balanceManager], signer.address);
-						return tx.build({ client: transactionBuildClient(sdk) });
+						return tx.build({ client: sdk.client });
 					}
-				}).pipe(Effect.mapError((err) => ({
-					_tag: "ArtifactPublishError",
-					reason: "produce-failed",
-					detail: `deepbook seed transaction failed for pool '${spec.name}': ${err.message}`
-				})));
+				}).pipe(Effect.mapError((err) => artifactPublishError("produce-failed", `deepbook seed transaction failed for pool '${spec.name}': ${err.message}`)));
+				if (result.$kind === "FailedTransaction") return yield* Effect.fail(artifactPublishError("produce-failed", `deepbook seed transaction on-chain execution failed for pool '${spec.name}' ` + formatExecutedFailure(result.FailedTransaction)));
+				const receipt = result.Transaction;
 				const balanceManagerId = pickCreatedBalanceManager(receipt.objectChanges);
-				if (balanceManagerId === null) return yield* Effect.fail({
-					_tag: "ArtifactPublishError",
-					reason: "produce-failed",
-					detail: `deepbook seed BalanceManager not found in objectChanges (digest=${receipt.digest}).`
-				});
+				if (balanceManagerId === null) return yield* Effect.fail(artifactPublishError("produce-failed", `deepbook seed BalanceManager not found in objectChanges (digest=${receipt.digest}).`));
 				return {
 					poolName: spec.name,
 					balanceManagerId,
 					digest: receipt.digest
 				};
-			}),
-			register: () => Effect.void
+			})
 		}).pipe(Effect.mapError((err) => mapArtifactError("create-pools", err)));
 		seeded.push(result);
 	}
 	return seeded;
 }).pipe(Effect.withSpan("devstack.plugin.deepbook.seedPools", { attributes: {
-	"deepbook.packageId": pkg.packageId,
-	"deepbook.pool.count": specs.filter((spec) => spec.seed !== void 0).length
+	[DeepbookSpans.packageId]: pkg.packageId,
+	[DeepbookSpans.poolCount]: specs.filter((spec) => spec.seed !== void 0).length
 } }));
 //#endregion
 export { createDeepbookPools, seedDeepbookPools };