@artblocks/abx-token-api 0.1.0-alpha.4 → 0.1.0-alpha.6

package/dist/control-plane.d.ts

@@ -0,0 +1,78 @@
+/**
+ * The /v1 control plane + the service descriptor — the resolver's ONE write surface, speaking the
+ * provider-neutral interface pinned by specs/self-host-toolkit/remote-services.md. Everything here
+ * is index/metadata control (register, list, deregister, reindex, status, effect publishes): the
+ * bearer token never signs anything on-chain, so the "no signing key on the host" rule is intact.
+ *
+ * This module never imports server.ts (one-way dependency), which is why the shared HTTP helpers
+ * (sendJson, the bearer guard) live here and the read plane imports them.
+ */
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import { type ProjectState, type ServiceDescriptor } from '@artblocks/abx-sdk';
+import type { SelfHostIndexer } from '@artblocks/abx-indexer';
+import type { StorageBackend } from '@artblocks/abx-storage';
+export interface ControlPlaneContext {
+    indexer: SelfHostIndexer;
+    storage: StorageBackend;
+    /** The chain this node serves — every control-plane call names a chainId and is checked against it. */
+    chainId: number;
+    /** The chain KEY ('sepolia', …) the indexer registers projects under — the string form of chainId. */
+    chainKey: string;
+    /** The public base this node believes it serves — echoed in the descriptor. */
+    baseUrl: string;
+}
+export declare function sendJson(res: ServerResponse, status: number, body: unknown): void;
+/**
+ * The ONE bearer guard for every gated route: 404 code `disabled` when no token is configured on
+ * the host (the write surface honestly doesn't exist — the descriptor omits the control-plane
+ * interface too), 401 code `unauthorized` on a missing/bad bearer. Returns false if it handled
+ * the response (caller must stop), true when the request may proceed. 403 (`forbidden`) is
+ * spec-defined for multi-tenant providers; this single-token reference never emits it.
+ */
+export declare function requireBearer(req: IncomingMessage, res: ServerResponse): boolean;
+/** The one-line project summary shared by `GET /api/projects` and the register/reindex responses. */
+export declare function summarize(s: ProjectState): {
+    address: `0x${string}`;
+    name: string | null;
+    symbol: string | null;
+    owner: `0x${string}` | null;
+    abxVersion: number | null;
+    isCanonical: boolean | null;
+    extensions: string[];
+    eventCount: number;
+    tokenCount: number;
+    mintedCount: number;
+    reconstructedAt: string;
+};
+/** Parse a stored content-locators JSON column → `{hash: locator}` (lowercased keys, never throws). */
+export declare function safeLocators(json: string): Record<string, string> | undefined;
+/**
+ * Decide the scan floor + whether a full replay is needed when registering a project via the
+ * control plane. Pure (the discovery/refusal fallback for the null case is the caller's):
+ *   - explicit `bodyFromBlock` wins; else the `existingFromBlock` already stored.
+ *   - `null` ⇒ NEITHER supplied nor stored — the caller must derive the deploy block or refuse
+ *     (never default to genesis: a range-capped RPC would sweep millions of blocks).
+ *   - `full` is true only when forced, on a first registration (no existing floor), or when the
+ *     floor actually CHANGED — so re-sending the SAME floor (the CLI now always forwards the deploy
+ *     block, even on a nudge) stays incremental: registering twice ≠ two full scans.
+ */
+export declare function planRegistrationFloor(bodyFromBlock: string | undefined, existingFromBlock: string | undefined, forceFull?: boolean): {
+    fromBlock: string;
+    full: boolean;
+} | null;
+/**
+ * `GET /.well-known/abx-service` — what this node supports, agent-readably (public, no auth).
+ * The control-plane + effects-publish interfaces (and `auth`) appear iff the bearer token is
+ * configured: a token-less self-host node honestly advertises no remote control surface — which
+ * is how a client tells "disabled" from "wrong URL". `render` appears when a runner rides behind
+ * this resolver (ABX_EFFECTS_URL); its declared effects come from a best-effort `/health` probe.
+ * Provider identity (name, signup/docs URLs) is deployment env — no provider ships in this code.
+ */
+export declare function serviceDescriptor(ctx: ControlPlaneContext): Promise<ServiceDescriptor>;
+/**
+ * Dispatch a `/v1/*` request (`parts` excludes the leading `v1`). Every route is bearer-gated;
+ * `chainId` is explicit everywhere (body on collection POSTs, path elsewhere) and validated, so a
+ * project can never silently register against the wrong chain. Wrong method on a known path ⇒ 405.
+ */
+export declare function routeControlPlane(req: IncomingMessage, res: ServerResponse, ctx: ControlPlaneContext, parts: string[]): Promise<void>;
+//# sourceMappingURL=control-plane.d.ts.map

package/dist/control-plane.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"control-plane.d.ts","sourceRoot":"","sources":["../src/control-plane.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH,OAAO,KAAK,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AAC/D,OAAO,EAaL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EAEvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAG3D,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,eAAe,CAAC;IACzB,OAAO,EAAE,cAAc,CAAC;IACxB,uGAAuG;IACvG,OAAO,EAAE,MAAM,CAAC;IAChB,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAC;IACjB,+EAA+E;IAC/E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAGjF;AA6DD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAUhF;AA+BD,qGAAqG;AACrG,wBAAgB,SAAS,CAAC,CAAC,EAAE,YAAY;;;;;;;;;;;;EAcxC;AAED,uGAAuG;AACvG,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAS7E;AAcD;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,iBAAiB,EAAE,MAAM,GAAG,SAAS,EACrC,SAAS,UAAQ,GAChB;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAC,GAAG,IAAI,CAK3C;AAuCD;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAuB5F;AAID;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,eAAe,EACpB,GAAG,EAAE,cAAc,EACnB,GAAG,EAAE,mBAAmB,EACxB,KAAK,EAAE,MAAM,EAAE,GACd,OAAO,CAAC,IAAI,CAAC,CA6Cf"}