@ouronet/talos-registry 2.1.0 → 2.2.0

package/dist/index.d.ts

@@ -16,6 +16,6 @@ export type { CallPlan } from "./plan.js";
 export { parseCapability, parseCapabilities, capabilityRecipe } from "./caps.js";
 export type { ParsedCapability, CapabilityRecipe } from "./caps.js";
 export { formatForType, formatDecimal, formatInteger, formatString, formatBool } from "./format.js";
-export { tooltipModel, tooltipModels, signatureRows, chainOf, isOffRegistryKey, isNativeKey, isPlaceholder, PLACEHOLDER, CHAIN_PALETTE, CHAIN_LABEL, CONSUMERS, STOA_SIGNATURES, KADENA_SIGNATURES, NATIVE_SIGNATURES } from "./tooltip.js";
-export type { TooltipModel, TooltipSlot, TooltipPreview, Chain, ConsumerIdentity } from "./tooltip.js";
+export { tooltipModel, tooltipModels, signatureRows, chainOf, isOffRegistryKey, isNativeKey, isPlaceholder, PLACEHOLDER, CHAIN_PALETTE, CHAIN_LABEL, CONSUMERS, STOA_SIGNATURES, KADENA_SIGNATURES, NATIVE_SIGNATURES, paramRole, paramsByRole, unfilledFillable } from "./tooltip.js";
+export type { TooltipModel, TooltipSlot, TooltipPreview, Chain, ConsumerIdentity, ParamRole } from "./tooltip.js";
 export type * from "./types.js";

package/dist/index.js

@@ -15,4 +15,4 @@ export { parseCapability, parseCapabilities, capabilityRecipe } from "./caps.js"
 export { formatForType, formatDecimal, formatInteger, formatString, formatBool } from "./format.js";
 // THE TOOLTIP CANON. Shared implementation rather than a shared document -- see TOOLTIP-CANON.md
 // for why each rule exists, and `tooltip.ts` for the rules themselves.
-export { tooltipModel, tooltipModels, signatureRows, chainOf, isOffRegistryKey, isNativeKey, isPlaceholder, PLACEHOLDER, CHAIN_PALETTE, CHAIN_LABEL, CONSUMERS, STOA_SIGNATURES, KADENA_SIGNATURES, NATIVE_SIGNATURES } from "./tooltip.js";
+export { tooltipModel, tooltipModels, signatureRows, chainOf, isOffRegistryKey, isNativeKey, isPlaceholder, PLACEHOLDER, CHAIN_PALETTE, CHAIN_LABEL, CONSUMERS, STOA_SIGNATURES, KADENA_SIGNATURES, NATIVE_SIGNATURES, paramRole, paramsByRole, unfilledFillable } from "./tooltip.js";

package/dist/tooltip.d.ts

@@ -51,6 +51,14 @@ export interface TooltipSlot {
     isPreflightFed: boolean;
     /** false = never prefill into an input that can reach a signed transaction (guards). */
     prefillable: boolean;
+    /**
+     * The CALLER supplied this value; it is not a ghost.
+     *
+     * Tracked in the model rather than left to each renderer, because "is this the user's data or
+     * an example?" is the question every one of this module's bugs turned on, and two consumers
+     * answering it separately is two chances to answer it differently.
+     */
+    supplied: boolean;
     /** the registry's own note about this argument, when it has one. */
     note?: string;
 }
@@ -171,3 +179,30 @@ export declare function signatureRows(m: TooltipModel): {
     names: string[];
     types: string[];
 };
+/**
+ * What KIND of thing a parameter holds.
+ *
+ * Pact types cannot answer this -- `patron`, `id`, `ats` and `swpair` are all `string`, and a
+ * value of the wrong kind in any of them type-checks, renders plausibly, and makes the preview
+ * succeed against the wrong entity. That is the defect class this whole module exists to prevent,
+ * and it has now produced four separate bugs.
+ */
+export type ParamRole = "ouronet-account" | "kadena-account" | "token-id" | "dpof-id" | "ats-pool" | "swap-pool" | "other";
+/** The role of a parameter name, or undefined when nothing is known about it. */
+export declare function paramRole(name: string): ParamRole | undefined;
+/** Every name this registry can classify, grouped. Useful for building a consumer's fill map. */
+export declare function paramsByRole(): Record<ParamRole, string[]>;
+/**
+ * RULE 7, as a check: which slots the consumer COULD have filled and did not.
+ *
+ * A slot qualifies when its role is known and the caller supplied no value for it. Those are the
+ * ones that silently show somebody else's real id -- `ats = "Auryndex-…"` on a SilverStoa button,
+ * an example account whose pool ledger is empty, a reward token rendered as "no live example".
+ *
+ * Placeholders and preflight-fed slots are NOT reported: the first is honestly unresolved and the
+ * second must not be invented. This answers "what did you leave on the table", not "what is
+ * missing".
+ *
+ * A conformant consumer asserts this is empty for every button it renders.
+ */
+export declare function unfilledFillable(m: TooltipModel): TooltipSlot[];

package/dist/tooltip.js

@@ -185,6 +185,7 @@ function offRegistryModel(key, kind, values, consumer) {
             isPreflightFed: false,
             // A guard is never prefillable, on any chain. Same rule, same reason.
             prefillable: type !== "guard",
+            supplied: values[name] !== undefined,
         })),
         // No preview, deliberately. Neither chain's `coin` has a reader that prices a call, so there
         // is no cost to show -- and a renderer must SAY that rather than leaving an empty panel,
@@ -257,6 +258,7 @@ export function tooltipModel(key, values = {}, consumer) {
             isPlaceholder,
             isPreflightFed,
             prefillable: u?.zbom !== false,
+            supplied: supplied !== undefined,
             note: ep.ghost.notes?.[p.name],
         };
     });
@@ -325,3 +327,81 @@ export function tooltipModels(keys, values = {}, consumer) {
 export function signatureRows(m) {
     return { names: m.slots.map((s) => s.name), types: m.slots.map((s) => s.type) };
 }
+/**
+ * DERIVED FROM THE GHOST'S SHAPE, not from a hand-written list of 332 names.
+ *
+ * Hand-classifying the vocabulary would be the same act that produced the bugs: a human deciding
+ * that `ats` looks like a token because both are strings. The registry's ghosts were each resolved
+ * for their own parameter and READ FROM MAINNET, so the value's shape is evidence rather than
+ * opinion -- an Ouronet account is a glyph string, a pool is `Name-O136CBn22ncY`, a swap pair
+ * starts `W|`, a hibernated DPOF starts `H|`.
+ *
+ * A name whose ghost is the generic `"example"` gets NO role, and that is correct: nothing is
+ * known about it, so nothing should be inferred. Those render as visible placeholders.
+ */
+const ROLE_PATTERNS = [
+    [/^k:/, "kadena-account"],
+    [/^[^\u0000-\u007F]\./, "ouronet-account"],
+    [/^W\|/, "swap-pool"],
+    [/^H\|/, "dpof-id"],
+    [/^[A-Za-z]+-O136CBn22ncY$/, "ats-pool"],
+    [/^[A-Z0-9]+-[A-Za-z0-9]{3}-[A-Za-z0-9]+$/, "token-id"],
+];
+let ROLES = null;
+function buildRoles() {
+    const out = new Map();
+    const reg = registry;
+    for (const coll of [reg.entrypoints, reg.previews]) {
+        for (const v of Object.values(coll)) {
+            const args = v?.ghost?.args ?? {};
+            for (const p of v?.params ?? []) {
+                if (p.type !== "string" || out.has(p.name))
+                    continue;
+                const g = args[p.name];
+                if (typeof g !== "string" || g === "example")
+                    continue;
+                for (const [re, role] of ROLE_PATTERNS)
+                    if (re.test(g)) {
+                        out.set(p.name, role);
+                        break;
+                    }
+            }
+        }
+    }
+    return out;
+}
+/** The role of a parameter name, or undefined when nothing is known about it. */
+export function paramRole(name) {
+    if (!ROLES)
+        ROLES = buildRoles();
+    return ROLES.get(name);
+}
+/** Every name this registry can classify, grouped. Useful for building a consumer's fill map. */
+export function paramsByRole() {
+    if (!ROLES)
+        ROLES = buildRoles();
+    const out = {};
+    for (const [n, r] of ROLES)
+        (out[r] ??= []).push(n);
+    for (const k of Object.keys(out))
+        out[k].sort();
+    return out;
+}
+/**
+ * RULE 7, as a check: which slots the consumer COULD have filled and did not.
+ *
+ * A slot qualifies when its role is known and the caller supplied no value for it. Those are the
+ * ones that silently show somebody else's real id -- `ats = "Auryndex-…"` on a SilverStoa button,
+ * an example account whose pool ledger is empty, a reward token rendered as "no live example".
+ *
+ * Placeholders and preflight-fed slots are NOT reported: the first is honestly unresolved and the
+ * second must not be invented. This answers "what did you leave on the table", not "what is
+ * missing".
+ *
+ * A conformant consumer asserts this is empty for every button it renders.
+ */
+export function unfilledFillable(m) {
+    return m.slots.filter((s) => !s.supplied
+        && !s.isPlaceholder && !s.isPreflightFed
+        && paramRole(s.name) !== undefined);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ouronet/talos-registry",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "The Ouronet callable surface, generated from the deployed contracts. Supply values; never type a function name.",
   "type": "module",
   "main": "./dist/index.js",