@artblocks/abx-token-api 0.1.0-alpha.1 → 0.1.0-alpha.11
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.
- package/dist/control-plane.d.ts +84 -0
- package/dist/control-plane.d.ts.map +1 -0
- package/dist/control-plane.js +698 -0
- package/dist/control-plane.js.map +1 -0
- package/dist/dashboard.d.ts +1 -1
- package/dist/dashboard.d.ts.map +1 -1
- package/dist/dashboard.js +18 -13
- package/dist/dashboard.js.map +1 -1
- package/dist/metadata.d.ts +9 -1
- package/dist/metadata.d.ts.map +1 -1
- package/dist/metadata.js +101 -21
- package/dist/metadata.js.map +1 -1
- package/dist/resolve.d.ts +0 -2
- package/dist/resolve.d.ts.map +1 -1
- package/dist/resolve.js +0 -5
- package/dist/resolve.js.map +1 -1
- package/dist/server.d.ts +0 -26
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +194 -403
- package/dist/server.js.map +1 -1
- package/dist/watcher.d.ts.map +1 -1
- package/dist/watcher.js +125 -2
- package/dist/watcher.js.map +1 -1
- package/package.json +4 -4
package/dist/server.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { createServer } from 'node:http';
|
|
2
|
-
import {
|
|
3
|
-
import { discoverDeployBlock, fieldOf, makePublicClient, normalizeAttributes, renderArtifactKey, resolveChain, DEFAULT_CHAIN_KEY, verifyAgainstHash, METADATA_FIELD as F, METADATA_REPRESENTATION as R, } from '@artblocks/abx-sdk';
|
|
2
|
+
import { fieldOf, makePublicClient, normalizeAttributes, renderArtifactKey, resolveChain, DEFAULT_CHAIN_KEY, verifyAgainstHash, METADATA_FIELD as F, METADATA_REPRESENTATION as R, } from '@artblocks/abx-sdk';
|
|
4
3
|
import { resolveBackend } from '@artblocks/abx-storage';
|
|
5
4
|
import { fallbackImageSvg, IMAGE_MEDIA_TYPE } from './art.js';
|
|
6
5
|
import { buildContractMetadata, buildTokenMetadata, fieldMimeType } from './metadata.js';
|
|
@@ -9,16 +8,41 @@ import { depStatusReport } from './deps.js';
|
|
|
9
8
|
import { ABX_JS } from './abxjs.js';
|
|
10
9
|
import { resolveFieldBytes, resolveFieldRendered, COLLECTION_TOKEN_ID } from './resolve.js';
|
|
11
10
|
import { renderDashboard, renderIndex } from './dashboard.js';
|
|
12
|
-
import {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
//
|
|
16
|
-
//
|
|
17
|
-
//
|
|
18
|
-
|
|
19
|
-
//
|
|
20
|
-
//
|
|
21
|
-
|
|
11
|
+
import { watchIntervalMs } from './watcher.js';
|
|
12
|
+
import { requireBearer, routeControlPlane, safeLocators, sendError, sendJson, serviceDescriptor, summarize, } from './control-plane.js';
|
|
13
|
+
// EVERYTHING chain-derived in this module is resolved LAZILY, on first use.
|
|
14
|
+
//
|
|
15
|
+
// It used to be three module-scope consts, and that made an invalid `ABX_CHAIN` catastrophic in a
|
|
16
|
+
// way wildly out of proportion to the mistake: the CLI imports this package (for the generator
|
|
17
|
+
// runtime), so the throw happened during module evaluation — before `main()` existed to catch it.
|
|
18
|
+
// `ABX_CHAIN=mainnet abx doctor` printed a raw Node stack trace with an internal source path and
|
|
19
|
+
// exited 1, and so did EVERY other command, including the ones whose whole job is to tell you what
|
|
20
|
+
// is wrong with your environment. A cold agent hit it and reported the tool as broken; it was right.
|
|
21
|
+
// Deferring the work to first use keeps a bad value an ordinary, catchable error.
|
|
22
|
+
let _chainClient = null;
|
|
23
|
+
/** A read-only client for resolving on-chain `reader`-represented content (eth_call). */
|
|
24
|
+
function chainClientLazy() {
|
|
25
|
+
return (_chainClient ??= makePublicClient());
|
|
26
|
+
}
|
|
27
|
+
let _serverChainId = null;
|
|
28
|
+
/**
|
|
29
|
+
* The chain this resolver serves. The path grammar carries the chainId
|
|
30
|
+
* (`/t/{chainId}/{address}/{tokenId}`), so a single host can serve many chains and reject paths for
|
|
31
|
+
* chains it doesn't index. Today one resolver = one chain; this gates that.
|
|
32
|
+
*/
|
|
33
|
+
function serverChainId() {
|
|
34
|
+
return (_serverChainId ??= resolveChain(process.env.ABX_CHAIN).id);
|
|
35
|
+
}
|
|
36
|
+
/** The chain *key* ('sepolia', …) the indexer registers projects under — the string form of the same
|
|
37
|
+
* chain {@link serverChainId} identifies. MUST match its default (base-sepolia): a stale 'sepolia'
|
|
38
|
+
* once desynced the key from the id. */
|
|
39
|
+
function serverChainKey() {
|
|
40
|
+
return process.env.ABX_CHAIN ?? DEFAULT_CHAIN_KEY;
|
|
41
|
+
}
|
|
42
|
+
/** The context the /v1 control plane + descriptor run against (control-plane.ts owns the routes). */
|
|
43
|
+
function controlPlaneCtx(indexer, storage, baseUrl) {
|
|
44
|
+
return { indexer, storage, chainId: serverChainId(), chainKey: serverChainKey(), baseUrl };
|
|
45
|
+
}
|
|
22
46
|
/**
|
|
23
47
|
* Resolve a token's image bytes by dispatching on the `image` field's single active
|
|
24
48
|
* representation (token scope first, else the collection-wide field — the same fallback the
|
|
@@ -31,14 +55,14 @@ const SERVER_CHAIN_KEY = process.env.ABX_CHAIN ?? DEFAULT_CHAIN_KEY; // MUST mat
|
|
|
31
55
|
*/
|
|
32
56
|
export async function resolveContent(state, token, storage) {
|
|
33
57
|
const image = fieldOf(token.fields, F.image) ?? fieldOf(state.collectionFields, F.image);
|
|
34
|
-
const onChain = await resolveFieldBytes(
|
|
58
|
+
const onChain = await resolveFieldBytes(chainClientLazy(), image); // inline / inline-gzip / reader / reader-gzip
|
|
35
59
|
if (onChain)
|
|
36
60
|
return { contentType: IMAGE_MEDIA_TYPE, body: onChain };
|
|
37
61
|
// computed on-chain at read (`renderer`) — best-effort: a reverting renderer degrades to the
|
|
38
62
|
// placeholder rather than erroring the route (mirrors the on-chain renderer's fallback rule).
|
|
39
63
|
if (image?.representation === R.renderer) {
|
|
40
64
|
try {
|
|
41
|
-
const rendered = await resolveFieldRendered(
|
|
65
|
+
const rendered = await resolveFieldRendered(chainClientLazy(), state.address, token.tokenId, F.image, image);
|
|
42
66
|
if (rendered)
|
|
43
67
|
return { contentType: rendered.contentType, body: rendered.bytes };
|
|
44
68
|
}
|
|
@@ -130,10 +154,32 @@ export function createTokenApiServer(opts) {
|
|
|
130
154
|
await route(req, res, indexer, baseUrl, storage);
|
|
131
155
|
}
|
|
132
156
|
catch (err) {
|
|
133
|
-
|
|
157
|
+
// NEVER hand a raw internal error to the client. An unexpected failure here is usually an
|
|
158
|
+
// upstream RPC error, and viem's message embeds the full endpoint URL — which for a keyed
|
|
159
|
+
// endpoint IS a credential. On a multi-tenant provider that would leak the operator's RPC key
|
|
160
|
+
// to any tenant who can trigger a 500 (see specs/self-host-toolkit/remote-services.md). So:
|
|
161
|
+
// full detail to the operator's log, a generic + redacted message on the wire.
|
|
162
|
+
const detail = err.message ?? 'unknown error';
|
|
163
|
+
console.error(`[server] ${req.method} ${req.url} failed: ${detail}`);
|
|
164
|
+
sendJson(res, 500, {
|
|
165
|
+
error: `internal error serving ${req.url ?? '/'} — see the node's logs for detail${upstreamHint(detail)}`,
|
|
166
|
+
code: 'internal_error',
|
|
167
|
+
});
|
|
134
168
|
}
|
|
135
169
|
});
|
|
136
170
|
}
|
|
171
|
+
/** A safe, credential-free hint about WHAT class of thing broke, so a caller isn't left blind by the
|
|
172
|
+
* generic 500. Recognizes the common upstream-RPC failures by status text only — never echoes the
|
|
173
|
+
* message (which can embed a keyed endpoint URL). */
|
|
174
|
+
function upstreamHint(detail) {
|
|
175
|
+
if (/\b429\b|Too Many Requests|rate limit/i.test(detail))
|
|
176
|
+
return ' (upstream RPC rate-limited this node — its operator needs a higher-capacity endpoint)';
|
|
177
|
+
if (/\b(401|403)\b|Unauthorized|Forbidden/i.test(detail))
|
|
178
|
+
return " (this node's upstream RPC rejected its credentials)";
|
|
179
|
+
if (/\b5\d\d\b|ECONNREFUSED|ETIMEDOUT|fetch failed/i.test(detail))
|
|
180
|
+
return " (this node's upstream RPC is unreachable or erroring)";
|
|
181
|
+
return '';
|
|
182
|
+
}
|
|
137
183
|
export function startTokenApiServer(opts) {
|
|
138
184
|
const port = opts.port ?? Number(process.env.ABX_PORT ?? DEFAULT_PORT);
|
|
139
185
|
const baseUrl = opts.baseUrl ?? resolveBaseUrl(port);
|
|
@@ -147,27 +193,44 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
147
193
|
const url = new URL(req.url ?? '/', 'http://localhost');
|
|
148
194
|
const parts = url.pathname.split('/').filter(Boolean);
|
|
149
195
|
const method = req.method ?? 'GET';
|
|
196
|
+
// CORS preflight — without this, a browser client can never send Authorization to the
|
|
197
|
+
// control plane (the wildcard origin above covers simple GETs only).
|
|
198
|
+
if (method === 'OPTIONS') {
|
|
199
|
+
res.writeHead(204, {
|
|
200
|
+
'access-control-allow-methods': 'GET,POST,DELETE,OPTIONS',
|
|
201
|
+
'access-control-allow-headers': 'authorization,content-type',
|
|
202
|
+
'access-control-max-age': '86400',
|
|
203
|
+
});
|
|
204
|
+
res.end();
|
|
205
|
+
return;
|
|
206
|
+
}
|
|
150
207
|
// GET / — read-only node index: which contracts this resolver serves (no actions).
|
|
151
208
|
if (parts.length === 0) {
|
|
152
209
|
res.writeHead(200, { 'content-type': 'text/html; charset=utf-8' });
|
|
153
|
-
res.end(renderIndex(indexer.listProjects(), baseUrl,
|
|
210
|
+
res.end(renderIndex(indexer.listProjects(), baseUrl, serverChainId()));
|
|
154
211
|
return;
|
|
155
212
|
}
|
|
156
213
|
// GET /d/:chainId/:addr — the per-contract dashboard (read-only; namespaced so one host can
|
|
157
214
|
// serve many contracts/chains). Actions live behind the admin token, not on this page.
|
|
158
215
|
if (parts[0] === 'd' && parts[1] && parts[2]) {
|
|
159
|
-
if (Number(parts[1]) !==
|
|
216
|
+
if (Number(parts[1]) !== serverChainId())
|
|
160
217
|
return wrongChain(res, parts[1]);
|
|
161
218
|
const state = indexer.getProject(parts[2]);
|
|
162
219
|
if (!state)
|
|
163
|
-
return
|
|
220
|
+
return unknownProject(res);
|
|
164
221
|
res.writeHead(200, { 'content-type': 'text/html; charset=utf-8' });
|
|
165
|
-
res.end(renderDashboard(state, baseUrl,
|
|
222
|
+
res.end(renderDashboard(state, baseUrl, serverChainId()));
|
|
166
223
|
return;
|
|
167
224
|
}
|
|
168
225
|
// GET /health
|
|
169
226
|
if (parts[0] === 'health')
|
|
170
227
|
return sendJson(res, 200, { ok: true, baseUrl });
|
|
228
|
+
// GET /.well-known/abx-service — the service descriptor (public): what this node supports,
|
|
229
|
+
// agent-readably, so a client can match a project's needs to this service BEFORE trusting it
|
|
230
|
+
// with a registration. See specs/self-host-toolkit/remote-services.md.
|
|
231
|
+
if (parts[0] === '.well-known' && parts[1] === 'abx-service') {
|
|
232
|
+
return sendJson(res, 200, await serviceDescriptor(controlPlaneCtx(indexer, storage, baseUrl)));
|
|
233
|
+
}
|
|
171
234
|
// GET /abx.js — the runtime companion (directory builds include it; the generator inlines it).
|
|
172
235
|
if (parts[0] === 'abx.js') {
|
|
173
236
|
res.writeHead(200, {
|
|
@@ -183,15 +246,15 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
183
246
|
// entry-fetch-failure fallback; template mode: the generator document assembled from
|
|
184
247
|
// chain). This is the same document a render node captures — the live view IS the input.
|
|
185
248
|
if (parts[0] === 'a' && parts[1] && parts[2] && parts[3] !== undefined) {
|
|
186
|
-
if (Number(parts[1]) !==
|
|
249
|
+
if (Number(parts[1]) !== serverChainId())
|
|
187
250
|
return wrongChain(res, parts[1]);
|
|
188
251
|
const state = indexer.getProject(parts[2]);
|
|
189
252
|
if (!state)
|
|
190
|
-
return
|
|
253
|
+
return unknownProject(res);
|
|
191
254
|
const token = resolveTokenView(state, parts[3]);
|
|
192
255
|
if (!token)
|
|
193
|
-
return
|
|
194
|
-
const view = await resolveLiveView(
|
|
256
|
+
return sendError(res, 404, 'not_registered', 'unknown token — not minted, and outside this project\'s supply cap');
|
|
257
|
+
const view = await resolveLiveView(chainClientLazy(), state, token);
|
|
195
258
|
if (!view)
|
|
196
259
|
return sendJson(res, 404, { error: 'no live view — not a code project' });
|
|
197
260
|
if (view.kind === 'redirect') {
|
|
@@ -203,25 +266,14 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
203
266
|
res.end(view.html);
|
|
204
267
|
return;
|
|
205
268
|
}
|
|
206
|
-
// /
|
|
207
|
-
// it's a *remote `abx add`*: it
|
|
208
|
-
// any local one) which contracts to index.
|
|
209
|
-
// "no signing key on the host" rule is intact; the
|
|
210
|
-
// control only. Disabled unless ABX_RESOLVER_ADMIN_TOKEN is
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
// POST /admin/effect-artifacts — a conforming effect runner publishes a render output (a durable
|
|
215
|
-
// locator, or raw bytes for small must-inline outputs like traits) so a resolver that does NOT share
|
|
216
|
-
// the runner's storage disk can still serve it. Same bearer as the control plane; never signs on-chain.
|
|
217
|
-
if (parts[0] === 'admin' && parts[1] === 'effect-artifacts') {
|
|
218
|
-
return adminRenderArtifacts(req, res, indexer, storage);
|
|
219
|
-
}
|
|
220
|
-
// POST /admin/effect-status — a runner reports a run's transient state ('rendering' /
|
|
221
|
-
// 'failed{error}' / 'done'). Pure observability: correctness stays artifact-presence at the
|
|
222
|
-
// settled inputsHash; these rows are rebuildable and 'done' simply clears one. Admin-gated.
|
|
223
|
-
if (parts[0] === 'admin' && parts[1] === 'effect-status') {
|
|
224
|
-
return adminEffectStatus(req, res, indexer);
|
|
269
|
+
// /v1/* — the control plane (register/list/deregister/reindex/status + the effect-publish
|
|
270
|
+
// lane). This is the ONE write surface on the resolver, and it's a *remote `abx add`*: it
|
|
271
|
+
// tells THIS node (a different projection store from any local one) which contracts to index.
|
|
272
|
+
// It never signs anything on-chain — the "no signing key on the host" rule is intact; the
|
|
273
|
+
// bearer token authorizes indexing control only. Disabled unless ABX_RESOLVER_ADMIN_TOKEN is
|
|
274
|
+
// set on the resolver. Routes + auth live in control-plane.ts.
|
|
275
|
+
if (parts[0] === 'v1') {
|
|
276
|
+
return routeControlPlane(req, res, controlPlaneCtx(indexer, storage, baseUrl), parts.slice(1));
|
|
225
277
|
}
|
|
226
278
|
// /api/*
|
|
227
279
|
if (parts[0] === 'api') {
|
|
@@ -238,30 +290,21 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
238
290
|
// same registry-order resolution the generator document uses, sharing its cache) plus
|
|
239
291
|
// the URL-budget flag for directory projects. Public, like the other status reads.
|
|
240
292
|
if (parts[1] === 'deps' && parts[2] && parts[3]) {
|
|
241
|
-
if (Number(parts[2]) !==
|
|
293
|
+
if (Number(parts[2]) !== serverChainId())
|
|
242
294
|
return wrongChain(res, parts[2]);
|
|
243
295
|
const state = indexer.getProject(parts[3]);
|
|
244
296
|
if (!state)
|
|
245
|
-
return
|
|
246
|
-
return sendJson(res, 200, await depStatusReport(
|
|
297
|
+
return unknownProject(res);
|
|
298
|
+
return sendJson(res, 200, await depStatusReport(chainClientLazy(), state));
|
|
247
299
|
}
|
|
248
300
|
if (parts[1] === 'project' && parts[2]) {
|
|
249
301
|
const address = parts[2];
|
|
250
|
-
// POST|GET /api/project/:addr/reindex — full replay from chain. ADMIN-ONLY: a full replay
|
|
251
|
-
// is expensive + mutating, so it must never be a public action (it's `abx index --remote`
|
|
252
|
-
// from the CLI). Gated by the same bearer as the control plane.
|
|
253
|
-
if (parts[3] === 'reindex') {
|
|
254
|
-
if (!requireAdmin(req, res))
|
|
255
|
-
return;
|
|
256
|
-
const { state, elapsedMs } = await indexer.reindex(address, { full: true });
|
|
257
|
-
notifyEffects(address);
|
|
258
|
-
return sendJson(res, 200, { elapsedMs, state });
|
|
259
|
-
}
|
|
260
302
|
// GET /api/project/:addr/verify — re-hashes served bytes against the on-chain anchor.
|
|
261
|
-
//
|
|
303
|
+
// BEARER-ONLY: it triggers outbound chain + gateway fetches, so it isn't a public endpoint
|
|
262
304
|
// (anyone can still verify independently via `abx verify` — no need for this node to do it).
|
|
305
|
+
// Reindex moved to the control plane: POST /v1/projects/{chainId}/{address}/reindex.
|
|
263
306
|
if (parts[3] === 'verify') {
|
|
264
|
-
if (!
|
|
307
|
+
if (!requireBearer(req, res))
|
|
265
308
|
return;
|
|
266
309
|
return sendJson(res, 200, await verifyProject(indexer.getProject(address), storage));
|
|
267
310
|
}
|
|
@@ -272,31 +315,33 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
272
315
|
if (parts[3] === 'effects') {
|
|
273
316
|
const state = indexer.getProject(address);
|
|
274
317
|
if (!state)
|
|
275
|
-
return
|
|
318
|
+
return unknownProject(res);
|
|
276
319
|
return sendJson(res, 200, await effectStatusReport(indexer, state, storage));
|
|
277
320
|
}
|
|
278
321
|
// GET /api/project/:addr
|
|
279
322
|
const state = indexer.getProject(address);
|
|
280
323
|
if (!state)
|
|
281
|
-
return
|
|
324
|
+
return unknownProject(res);
|
|
282
325
|
return sendJson(res, 200, state);
|
|
283
326
|
}
|
|
284
|
-
return
|
|
327
|
+
return sendError(res, 404, 'unknown_route', 'unknown api route', {
|
|
328
|
+
routes: ['/api/projects', '/api/watch', '/api/project/:address', '/api/project/:address/effects', '/api/project/:address/verify', '/api/deps/:chainId/:address'],
|
|
329
|
+
});
|
|
285
330
|
}
|
|
286
331
|
// GET /t/:chainId/:addr/:id and /t/:chainId/:addr/:id/image
|
|
287
332
|
if (parts[0] === 't' && parts[1] && parts[2] && parts[3] !== undefined) {
|
|
288
|
-
if (Number(parts[1]) !==
|
|
333
|
+
if (Number(parts[1]) !== serverChainId())
|
|
289
334
|
return wrongChain(res, parts[1]);
|
|
290
335
|
const address = parts[2];
|
|
291
336
|
const tokenId = parts[3];
|
|
292
337
|
const state = indexer.getProject(address);
|
|
293
338
|
if (!state)
|
|
294
|
-
return
|
|
339
|
+
return unknownProject(res);
|
|
295
340
|
// Resolve the issuance token → its metadata-id slot (identity vs. content), synthesizing a
|
|
296
341
|
// pre-mint view for a not-yet-issued id within the cap so metadata warms before mint.
|
|
297
342
|
const token = resolveTokenView(state, tokenId);
|
|
298
343
|
if (!token)
|
|
299
|
-
return
|
|
344
|
+
return sendError(res, 404, 'not_registered', 'unknown token — not minted, and outside this project\'s supply cap');
|
|
300
345
|
if (parts[4] === 'image') {
|
|
301
346
|
// the render-effect seam: no explicit image field + a code project ⇒ serve the
|
|
302
347
|
// artifact stored at the CURRENT inputsHash address, when a producer has run.
|
|
@@ -304,10 +349,11 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
304
349
|
state.collectionFields.some((f) => f.field === 'image');
|
|
305
350
|
if (!hasImageField && isCodeProject(state)) {
|
|
306
351
|
try {
|
|
307
|
-
const { key, found } = await currentRenderArtifact(
|
|
308
|
-
//
|
|
309
|
-
// share
|
|
310
|
-
//
|
|
352
|
+
const { key, found } = await currentRenderArtifact(chainClientLazy(), state, token, storage);
|
|
353
|
+
// `image` is a REFERENCED output (`effects.md → Bound vs referenced`): a producer that
|
|
354
|
+
// doesn't share this node's disk registers a locator (ipfs/ar/https) and we 302 straight to
|
|
355
|
+
// it (gateway resolved at serve time), never proxying its bytes. `found` is the co-located
|
|
356
|
+
// case — the producer wrote the artifact into the backend we share.
|
|
311
357
|
const published = indexer.store.getEffectArtifact(key);
|
|
312
358
|
if (published?.locator) {
|
|
313
359
|
res.writeHead(302, { location: resolveLocatorUrl(published.locator), 'cache-control': 'public, max-age=300' });
|
|
@@ -352,22 +398,58 @@ async function route(req, res, indexer, baseUrl, storage) {
|
|
|
352
398
|
}
|
|
353
399
|
return serveFieldArtifact(res, state, token, parts[5], storage, displayMeta(indexer, address));
|
|
354
400
|
}
|
|
355
|
-
return sendJson(res, 200, await buildTokenMetadata(
|
|
401
|
+
return sendJson(res, 200, await buildTokenMetadata(chainClientLazy(), state, token, baseUrl, serverChainId(), displayMeta(indexer, address), storage, planeAccess(indexer)));
|
|
356
402
|
}
|
|
357
403
|
// GET /c/:chainId/:addr and /c/:chainId/:addr/data/{field}
|
|
358
404
|
if (parts[0] === 'c' && parts[1] && parts[2]) {
|
|
359
|
-
if (Number(parts[1]) !==
|
|
405
|
+
if (Number(parts[1]) !== serverChainId())
|
|
360
406
|
return wrongChain(res, parts[1]);
|
|
361
407
|
const address = parts[2];
|
|
362
408
|
const state = indexer.getProject(address);
|
|
363
409
|
if (!state)
|
|
364
|
-
return
|
|
410
|
+
return unknownProject(res);
|
|
365
411
|
if (parts[3] === 'data' && parts[4]) {
|
|
366
412
|
return serveFieldArtifact(res, state, null, parts[4], storage, displayMeta(indexer, address));
|
|
367
413
|
}
|
|
368
|
-
return sendJson(res, 200, await buildContractMetadata(
|
|
414
|
+
return sendJson(res, 200, await buildContractMetadata(chainClientLazy(), state, baseUrl, serverChainId(), displayMeta(indexer, address), storage));
|
|
369
415
|
}
|
|
370
|
-
|
|
416
|
+
return sendRouteError(res, parts);
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* The last word of the router: nothing matched. A BARE 404 here is actively misleading — it's the
|
|
420
|
+
* same answer as "this project isn't indexed", so a client that hand-built a URL (dropping the
|
|
421
|
+
* `:id` off `/t/:chainId/:address/:id` and expecting collection metadata is the observed case)
|
|
422
|
+
* reads its own mistake as a service outage and reports a non-bug.
|
|
423
|
+
*
|
|
424
|
+
* So: a KNOWN route prefix with the wrong segment count is a **400 `invalid_request`** naming the
|
|
425
|
+
* correct template, and anything else is a **404 `unknown_route`**. Same `{error, code}` shape the
|
|
426
|
+
* control plane already uses (remote-services.md → Errors), so clients key off `code`, not prose.
|
|
427
|
+
*
|
|
428
|
+
* These are hints, not a discoverable API: the route grammar is fixed by the `abx-token-api/v1`
|
|
429
|
+
* interface and committed on-chain per contract (`tokenURIBase`/`contractURIBase`). The real fix for
|
|
430
|
+
* a client is to read the URL off the contract (`abx tokenuri` / `abx contracturi`) rather than
|
|
431
|
+
* assembling one — so every hint below points at the grammar it should already have, and never
|
|
432
|
+
* invites a client to treat routes as per-node negotiable.
|
|
433
|
+
*/
|
|
434
|
+
const ROUTE_TEMPLATES = {
|
|
435
|
+
t: { template: '/t/:chainId/:address/:id (· /image · /data/:field)', what: 'ERC-721 token metadata' },
|
|
436
|
+
c: { template: '/c/:chainId/:address (· /data/:field)', what: 'ERC-7572 collection metadata' },
|
|
437
|
+
a: { template: '/a/:chainId/:address/:id', what: 'the live view of a code project' },
|
|
438
|
+
d: { template: '/d/:chainId/:address', what: 'the per-contract read-only dashboard' },
|
|
439
|
+
};
|
|
440
|
+
function sendRouteError(res, parts) {
|
|
441
|
+
const known = parts[0] ? ROUTE_TEMPLATES[parts[0]] : undefined;
|
|
442
|
+
if (known) {
|
|
443
|
+
// The single highest-value hint: a `/t/:chainId/:address` with no token id is almost always
|
|
444
|
+
// someone reaching for collection metadata. Name `/c/…` explicitly.
|
|
445
|
+
const missingId = (parts[0] === 't' || parts[0] === 'a') && parts.length === 3;
|
|
446
|
+
return sendError(res, 400, 'invalid_request', `malformed ${known.what} path — use ${known.template}` +
|
|
447
|
+
(missingId ? '. For COLLECTION-level metadata (no token id) use /c/:chainId/:address' : ''), { route: known.template, ...(missingId ? { didYouMean: `/c/${parts[1]}/${parts[2]}` } : {}) });
|
|
448
|
+
}
|
|
449
|
+
return sendError(res, 404, 'unknown_route', 'this node serves no route at that path', {
|
|
450
|
+
routes: Object.values(ROUTE_TEMPLATES).map((r) => r.template.split(' ')[0]),
|
|
451
|
+
hint: 'a contract commits its own metadata URL on-chain (tokenURIBase/contractURIBase) — read it with `abx tokenuri` / `abx contracturi` instead of building a path',
|
|
452
|
+
});
|
|
371
453
|
}
|
|
372
454
|
/** The manifest's read surface over the effect-artifact registry (metadata.ts stays store-free). */
|
|
373
455
|
function planeAccess(indexer) {
|
|
@@ -376,14 +458,18 @@ function planeAccess(indexer) {
|
|
|
376
458
|
get: (key) => indexer.store.getEffectArtifact(key),
|
|
377
459
|
};
|
|
378
460
|
}
|
|
379
|
-
/** Serve one EFFECT artifact's bytes at the CURRENT settled inputsHash
|
|
380
|
-
*
|
|
381
|
-
*
|
|
461
|
+
/** Serve one EFFECT artifact's bytes at the CURRENT settled inputsHash. Three sources, in order,
|
|
462
|
+
* mirroring `effects.md → Bound vs referenced`:
|
|
463
|
+
* - a registered locator (a REFERENCED output) → **302**, never a proxy: the producer holds those
|
|
464
|
+
* bytes and its egress stays its own;
|
|
465
|
+
* - a BOUND output's content, held with the row (≤64KB, this node stitches it into the JSON too);
|
|
466
|
+
* - this node's own custody at the artifact key — a CO-LOCATED producer sharing the backend.
|
|
467
|
+
* Else 404 (not produced yet, or stale after a param change — self-invalidation, not an error). */
|
|
382
468
|
async function serveEffectArtifact(res, state, token, effectKey, outputKey, storage, indexer) {
|
|
383
469
|
if (!isCodeProject(state))
|
|
384
470
|
return sendJson(res, 404, { error: 'no effect artifacts — not a code project' });
|
|
385
471
|
try {
|
|
386
|
-
const hash = await currentSettledInputsHash(
|
|
472
|
+
const hash = await currentSettledInputsHash(chainClientLazy(), state, token);
|
|
387
473
|
const key = renderArtifactKey(state.chainId, state.address, token.tokenId, hash, outputKey, effectKey);
|
|
388
474
|
const row = indexer.store.getEffectArtifact(key);
|
|
389
475
|
if (row?.locator) {
|
|
@@ -391,6 +477,14 @@ async function serveEffectArtifact(res, state, token, effectKey, outputKey, stor
|
|
|
391
477
|
res.end();
|
|
392
478
|
return;
|
|
393
479
|
}
|
|
480
|
+
if (row?.bytes) {
|
|
481
|
+
res.writeHead(200, {
|
|
482
|
+
'content-type': row.contentType || 'application/octet-stream',
|
|
483
|
+
'cache-control': 'public, max-age=300',
|
|
484
|
+
});
|
|
485
|
+
res.end(row.bytes);
|
|
486
|
+
return;
|
|
487
|
+
}
|
|
394
488
|
const stored = await storage.get(key);
|
|
395
489
|
if (stored) {
|
|
396
490
|
res.writeHead(200, {
|
|
@@ -420,17 +514,17 @@ async function serveFieldArtifact(res, state, token, field, storage, display) {
|
|
|
420
514
|
return sendJson(res, 404, { error: `no '${field}' field set` });
|
|
421
515
|
const tokenId = token?.tokenId ?? '0';
|
|
422
516
|
try {
|
|
423
|
-
const onChain = await resolveFieldBytes(
|
|
517
|
+
const onChain = await resolveFieldBytes(chainClientLazy(), entry);
|
|
424
518
|
if (onChain) {
|
|
425
519
|
res.writeHead(200, {
|
|
426
|
-
'content-type': await fieldMimeType(
|
|
520
|
+
'content-type': await fieldMimeType(chainClientLazy(), state, entry, field, tokenId, display, storage),
|
|
427
521
|
'cache-control': 'public, max-age=300',
|
|
428
522
|
});
|
|
429
523
|
res.end(onChain);
|
|
430
524
|
return;
|
|
431
525
|
}
|
|
432
526
|
// computed on-chain at read — the collection surface passes the sentinel id (no token).
|
|
433
|
-
const rendered = await resolveFieldRendered(
|
|
527
|
+
const rendered = await resolveFieldRendered(chainClientLazy(), state.address, token?.tokenId ?? COLLECTION_TOKEN_ID, field, entry);
|
|
434
528
|
if (rendered) {
|
|
435
529
|
if (rendered.contentType === 'text/uri-list') {
|
|
436
530
|
const target = new TextDecoder().decode(rendered.bytes).trim();
|
|
@@ -523,32 +617,6 @@ function safeTokenAttributes(json) {
|
|
|
523
617
|
return undefined;
|
|
524
618
|
}
|
|
525
619
|
}
|
|
526
|
-
/** Parse a stored content-locators JSON column → `{hash: locator}` (lowercased keys, never throws). */
|
|
527
|
-
function safeLocators(json) {
|
|
528
|
-
try {
|
|
529
|
-
const obj = JSON.parse(json);
|
|
530
|
-
const out = {};
|
|
531
|
-
for (const [k, v] of Object.entries(obj))
|
|
532
|
-
if (typeof v === 'string')
|
|
533
|
-
out[k.toLowerCase()] = v;
|
|
534
|
-
return Object.keys(out).length ? out : undefined;
|
|
535
|
-
}
|
|
536
|
-
catch {
|
|
537
|
-
return undefined;
|
|
538
|
-
}
|
|
539
|
-
}
|
|
540
|
-
/** Merge incoming content locators over the stored ones (additive — a re-add can bring new hashes
|
|
541
|
-
* without dropping known ones). Returns a JSON string for the column, or undefined if empty. */
|
|
542
|
-
function mergeLocators(existingJson, incoming) {
|
|
543
|
-
const base = existingJson ? safeLocators(existingJson) ?? {} : {};
|
|
544
|
-
if (incoming && typeof incoming === 'object') {
|
|
545
|
-
for (const [k, v] of Object.entries(incoming)) {
|
|
546
|
-
if (typeof v === 'string' && v)
|
|
547
|
-
base[k.toLowerCase()] = v;
|
|
548
|
-
}
|
|
549
|
-
}
|
|
550
|
-
return Object.keys(base).length ? JSON.stringify(base) : undefined;
|
|
551
|
-
}
|
|
552
620
|
export async function verifyProject(state, storage) {
|
|
553
621
|
if (!state)
|
|
554
622
|
return { error: 'unknown project' };
|
|
@@ -564,301 +632,6 @@ export async function verifyProject(state, storage) {
|
|
|
564
632
|
}));
|
|
565
633
|
return { address: state.address, tokens };
|
|
566
634
|
}
|
|
567
|
-
function summarize(s) {
|
|
568
|
-
return {
|
|
569
|
-
address: s.address,
|
|
570
|
-
name: s.name,
|
|
571
|
-
symbol: s.symbol,
|
|
572
|
-
owner: s.owner,
|
|
573
|
-
abxVersion: s.abxVersion,
|
|
574
|
-
isCanonical: s.isCanonical,
|
|
575
|
-
extensions: s.extensions.map((e) => e.name),
|
|
576
|
-
eventCount: s.eventCount,
|
|
577
|
-
tokenCount: s.tokens.length,
|
|
578
|
-
mintedCount: s.tokens.filter((t) => t.minted).length,
|
|
579
|
-
reconstructedAt: s.reconstructedAt,
|
|
580
|
-
};
|
|
581
|
-
}
|
|
582
|
-
function sendJson(res, status, body) {
|
|
583
|
-
res.writeHead(status, { 'content-type': 'application/json; charset=utf-8' });
|
|
584
|
-
res.end(JSON.stringify(body, null, 2));
|
|
585
|
-
}
|
|
586
|
-
// ── admin control plane (remote `abx add`) ───────────────────────────────────--
|
|
587
|
-
/** Guard an admin-only API action (reindex/verify): 404 when no admin token is configured on the
|
|
588
|
-
* host (the action surface is disabled), 401 on a missing/bad bearer. Returns false if it handled
|
|
589
|
-
* the response (caller must stop), true when the request is authorized to proceed. */
|
|
590
|
-
function requireAdmin(req, res) {
|
|
591
|
-
if (!process.env.ABX_RESOLVER_ADMIN_TOKEN) {
|
|
592
|
-
sendJson(res, 404, { error: 'admin action disabled — set ABX_RESOLVER_ADMIN_TOKEN on the resolver (operate via the abx CLI)' });
|
|
593
|
-
return false;
|
|
594
|
-
}
|
|
595
|
-
if (!adminAuthorized(req)) {
|
|
596
|
-
sendJson(res, 401, { error: 'unauthorized — this action needs Authorization: Bearer <ABX_RESOLVER_ADMIN_TOKEN>' });
|
|
597
|
-
return false;
|
|
598
|
-
}
|
|
599
|
-
return true;
|
|
600
|
-
}
|
|
601
|
-
/** Constant-time bearer check against ABX_RESOLVER_ADMIN_TOKEN. */
|
|
602
|
-
function adminAuthorized(req) {
|
|
603
|
-
const token = process.env.ABX_RESOLVER_ADMIN_TOKEN;
|
|
604
|
-
if (!token)
|
|
605
|
-
return false;
|
|
606
|
-
const header = req.headers['authorization'];
|
|
607
|
-
const raw = (Array.isArray(header) ? header[0] : header) ?? '';
|
|
608
|
-
const m = /^Bearer\s+(.+)$/i.exec(raw.trim());
|
|
609
|
-
if (!m)
|
|
610
|
-
return false;
|
|
611
|
-
const got = Buffer.from(m[1]);
|
|
612
|
-
const want = Buffer.from(token);
|
|
613
|
-
return got.length === want.length && timingSafeEqual(got, want);
|
|
614
|
-
}
|
|
615
|
-
/** Read + JSON-parse a request body, capped so a bad caller can't exhaust memory. */
|
|
616
|
-
async function readJsonBody(req, maxBytes = 64 * 1024) {
|
|
617
|
-
const chunks = [];
|
|
618
|
-
let size = 0;
|
|
619
|
-
for await (const chunk of req) {
|
|
620
|
-
size += chunk.length;
|
|
621
|
-
if (size > maxBytes)
|
|
622
|
-
throw new Error('request body too large');
|
|
623
|
-
chunks.push(chunk);
|
|
624
|
-
}
|
|
625
|
-
if (chunks.length === 0)
|
|
626
|
-
return {};
|
|
627
|
-
return JSON.parse(Buffer.concat(chunks).toString('utf8'));
|
|
628
|
-
}
|
|
629
|
-
const ADDRESS_RE = /^0x[0-9a-fA-F]{40}$/;
|
|
630
|
-
/**
|
|
631
|
-
* `POST /admin/projects {address, fromBlock?, factory?, label?, description?, externalUrl?,
|
|
632
|
-
* attributes?, contentLocators?}` — attributes are off-chain operator traits; contentLocators
|
|
633
|
-
* bridge `{ "0x<keccak>": "ipfs://<cid>" }` so the image points at IPFS without holding bytes.
|
|
634
|
-
* → register the contract with THIS node and replay it from chain. Idempotent: a
|
|
635
|
-
* re-POST is the post-deploy "nudge" that pulls events that landed since.
|
|
636
|
-
* `DELETE /admin/projects/:address` → stop indexing it (drops the projection).
|
|
637
|
-
*
|
|
638
|
-
* We deliberately do NOT factory-scope here: if you own this resolver and you tell it
|
|
639
|
-
* a contract, it does its best to index it. (Allowlisting by factory is a platform
|
|
640
|
-
* concern — see docs/10-backlog.md B6 — not a self-hosting one.)
|
|
641
|
-
*/
|
|
642
|
-
/**
|
|
643
|
-
* Decide the scan floor + whether a full replay is needed when registering a project via the
|
|
644
|
-
* admin control plane. Pure (the discovery/refusal fallback for the null case is the caller's):
|
|
645
|
-
* - explicit `bodyFromBlock` wins; else the `existingFromBlock` already stored.
|
|
646
|
-
* - `null` ⇒ NEITHER supplied nor stored — the caller must derive the deploy block or refuse
|
|
647
|
-
* (never default to genesis: a range-capped RPC would sweep millions of blocks).
|
|
648
|
-
* - `full` is true only when forced, on a first registration (no existing floor), or when the
|
|
649
|
-
* floor actually CHANGED — so re-sending the SAME floor (the CLI now always forwards the deploy
|
|
650
|
-
* block, even on a nudge) stays incremental: `abx add --remote` twice ≠ two full scans.
|
|
651
|
-
*/
|
|
652
|
-
export function planRegistrationFloor(bodyFromBlock, existingFromBlock, forceFull = false) {
|
|
653
|
-
const fromBlock = bodyFromBlock !== undefined ? String(bodyFromBlock) : existingFromBlock;
|
|
654
|
-
if (fromBlock === undefined)
|
|
655
|
-
return null;
|
|
656
|
-
const full = forceFull || existingFromBlock === undefined || fromBlock !== existingFromBlock;
|
|
657
|
-
return { fromBlock, full };
|
|
658
|
-
}
|
|
659
|
-
async function adminProjects(req, res, indexer, addrSeg) {
|
|
660
|
-
if (!process.env.ABX_RESOLVER_ADMIN_TOKEN) {
|
|
661
|
-
return sendJson(res, 404, {
|
|
662
|
-
error: 'admin API disabled — set ABX_RESOLVER_ADMIN_TOKEN on the resolver to enable remote add/remove',
|
|
663
|
-
});
|
|
664
|
-
}
|
|
665
|
-
if (!adminAuthorized(req)) {
|
|
666
|
-
return sendJson(res, 401, { error: 'unauthorized — send Authorization: Bearer <ABX_RESOLVER_ADMIN_TOKEN>' });
|
|
667
|
-
}
|
|
668
|
-
const method = req.method ?? 'GET';
|
|
669
|
-
if (method === 'POST' && addrSeg === undefined) {
|
|
670
|
-
let body;
|
|
671
|
-
try {
|
|
672
|
-
body = await readJsonBody(req);
|
|
673
|
-
}
|
|
674
|
-
catch (err) {
|
|
675
|
-
return sendJson(res, 400, { error: err.message });
|
|
676
|
-
}
|
|
677
|
-
const address = body.address;
|
|
678
|
-
if (!address || !ADDRESS_RE.test(address)) {
|
|
679
|
-
return sendJson(res, 400, { error: 'body.address must be a 0x-prefixed 20-byte address' });
|
|
680
|
-
}
|
|
681
|
-
// A re-POST is the post-deploy nudge: preserve the existing scan floor + metadata
|
|
682
|
-
// (don't reset fromBlock and re-scan), and re-index incrementally. A first add — or one
|
|
683
|
-
// that supplies a *new* fromBlock — replays fully from that floor. (See planRegistrationFloor.)
|
|
684
|
-
const existing = indexer.store.getRegistration(address);
|
|
685
|
-
let plan = planRegistrationFloor(body.fromBlock, existing?.fromBlock, body.full === true);
|
|
686
|
-
if (!plan) {
|
|
687
|
-
// No floor supplied and none stored. NEVER default to genesis — a range-capped RPC would
|
|
688
|
-
// grind millions of blocks (the "resolver won't index" trap). Derive the deploy block from
|
|
689
|
-
// chain; refuse if we can't (archive getCode unavailable) rather than guess a bad floor.
|
|
690
|
-
const discovered = await discoverDeployBlock(indexer.publicClient(SERVER_CHAIN_KEY), address);
|
|
691
|
-
if (discovered === null) {
|
|
692
|
-
return sendJson(res, 400, {
|
|
693
|
-
error: 'first registration needs fromBlock (the contract deploy block) — refusing a from-genesis scan. ' +
|
|
694
|
-
'The abx CLI derives it automatically; if calling the API directly, pass fromBlock, or point the resolver at an archive RPC that serves historical eth_getCode.',
|
|
695
|
-
});
|
|
696
|
-
}
|
|
697
|
-
plan = { fromBlock: discovered.toString(), full: true };
|
|
698
|
-
}
|
|
699
|
-
const { fromBlock, full } = plan;
|
|
700
|
-
// Attributes / locators arrive as JSON values; store them as text. Normalize attributes so a
|
|
701
|
-
// bad payload can't poison the served traits. Each preserves the existing value when omitted.
|
|
702
|
-
let attributes = existing?.attributes;
|
|
703
|
-
if (body.attributes !== undefined) {
|
|
704
|
-
attributes = body.attributes === null ? undefined : JSON.stringify(normalizeAttributes(body.attributes));
|
|
705
|
-
}
|
|
706
|
-
// Per-token off-chain traits (a Series' editable attributes): a `{ "<tokenId>": attrs }` object,
|
|
707
|
-
// each value normalized. Same preserve-on-omit / clear-on-null semantics as `attributes`.
|
|
708
|
-
let tokenAttributes = existing?.tokenAttributes;
|
|
709
|
-
if (body.tokenAttributes !== undefined) {
|
|
710
|
-
if (body.tokenAttributes === null)
|
|
711
|
-
tokenAttributes = undefined;
|
|
712
|
-
else {
|
|
713
|
-
const norm = {};
|
|
714
|
-
for (const [tokenId, v] of Object.entries(body.tokenAttributes)) {
|
|
715
|
-
const a = normalizeAttributes(v);
|
|
716
|
-
if (a.length)
|
|
717
|
-
norm[tokenId] = a;
|
|
718
|
-
}
|
|
719
|
-
tokenAttributes = Object.keys(norm).length ? JSON.stringify(norm) : undefined;
|
|
720
|
-
}
|
|
721
|
-
}
|
|
722
|
-
let contentLocators = existing?.contentLocators;
|
|
723
|
-
if (body.contentLocators !== undefined) {
|
|
724
|
-
contentLocators = mergeLocators(existing?.contentLocators, body.contentLocators);
|
|
725
|
-
}
|
|
726
|
-
indexer.register({
|
|
727
|
-
address: address,
|
|
728
|
-
chainKey: SERVER_CHAIN_KEY,
|
|
729
|
-
fromBlock,
|
|
730
|
-
factory: body.factory ?? existing?.factory ?? process.env.ABX_FACTORY ?? null,
|
|
731
|
-
label: body.label ?? existing?.label,
|
|
732
|
-
description: body.description ?? existing?.description,
|
|
733
|
-
externalUrl: body.externalUrl ?? existing?.externalUrl,
|
|
734
|
-
attributes,
|
|
735
|
-
tokenAttributes,
|
|
736
|
-
contentLocators,
|
|
737
|
-
});
|
|
738
|
-
const { state, elapsedMs, mode } = await indexer.reindex(address, { full });
|
|
739
|
-
notifyEffects(address);
|
|
740
|
-
return sendJson(res, 200, { ok: true, mode, elapsedMs, project: summarize(state) });
|
|
741
|
-
}
|
|
742
|
-
if (method === 'DELETE' && addrSeg) {
|
|
743
|
-
if (!ADDRESS_RE.test(addrSeg))
|
|
744
|
-
return sendJson(res, 400, { error: 'address path segment must be a 0x address' });
|
|
745
|
-
const existed = !!indexer.store.getRegistration(addrSeg);
|
|
746
|
-
indexer.store.deregister(addrSeg);
|
|
747
|
-
return sendJson(res, existed ? 200 : 404, existed ? { ok: true, address: addrSeg } : { error: 'not registered' });
|
|
748
|
-
}
|
|
749
|
-
return sendJson(res, 405, { error: 'use POST /admin/projects or DELETE /admin/projects/<address>' });
|
|
750
|
-
}
|
|
751
|
-
/**
|
|
752
|
-
* `POST /admin/effect-artifacts {address, tokenId, inputsHash, output?, effectKey?, locator? |
|
|
753
|
-
* bytes_base64?, contentType?}` — a conforming effect runner publishes a render output so a
|
|
754
|
-
* resolver that does NOT share the runner's storage disk can serve it. Two modes:
|
|
755
|
-
* - `locator` (ipfs://<cid> | ar://<txid> | https://…): stored as a pointer; `/image` 302-redirects.
|
|
756
|
-
* - `bytes_base64`: stored in this node's own byte custody (what traits use — they inline into JSON).
|
|
757
|
-
* The artifact key is computed from the runner-supplied `inputsHash` — NOT recomputed from current
|
|
758
|
-
* state — so a render is never re-addressed to a state it doesn't depict (a param change instead makes
|
|
759
|
-
* it unreachable, the correct self-invalidation). Admin-token gated; never signs on-chain.
|
|
760
|
-
*/
|
|
761
|
-
async function adminRenderArtifacts(req, res, indexer, storage) {
|
|
762
|
-
if (!process.env.ABX_RESOLVER_ADMIN_TOKEN) {
|
|
763
|
-
return sendJson(res, 404, { error: 'admin API disabled — set ABX_RESOLVER_ADMIN_TOKEN on the resolver' });
|
|
764
|
-
}
|
|
765
|
-
if (!adminAuthorized(req)) {
|
|
766
|
-
return sendJson(res, 401, { error: 'unauthorized — send Authorization: Bearer <ABX_RESOLVER_ADMIN_TOKEN>' });
|
|
767
|
-
}
|
|
768
|
-
if ((req.method ?? 'GET') !== 'POST') {
|
|
769
|
-
return sendJson(res, 405, { error: 'use POST /admin/effect-artifacts' });
|
|
770
|
-
}
|
|
771
|
-
let body;
|
|
772
|
-
try {
|
|
773
|
-
body = await readJsonBody(req, 8 * 1024 * 1024); // a thumbnail pushed as bytes can exceed the 64KB default
|
|
774
|
-
}
|
|
775
|
-
catch (err) {
|
|
776
|
-
return sendJson(res, 400, { error: err.message });
|
|
777
|
-
}
|
|
778
|
-
const address = body.address;
|
|
779
|
-
if (!address || !ADDRESS_RE.test(address)) {
|
|
780
|
-
return sendJson(res, 400, { error: 'body.address must be a 0x-prefixed 20-byte address' });
|
|
781
|
-
}
|
|
782
|
-
if (body.tokenId === undefined || body.tokenId === null) {
|
|
783
|
-
return sendJson(res, 400, { error: 'body.tokenId required' });
|
|
784
|
-
}
|
|
785
|
-
const tokenId = String(body.tokenId);
|
|
786
|
-
const inputsHashHex = body.inputsHash;
|
|
787
|
-
if (!inputsHashHex || !/^0x[0-9a-fA-F]{64}$/.test(inputsHashHex)) {
|
|
788
|
-
return sendJson(res, 400, { error: 'body.inputsHash must be the 0x 32-byte hash the runner rendered (this node does NOT recompute it)' });
|
|
789
|
-
}
|
|
790
|
-
// Any declared output key (the data plane's generality) — 'image'/'traits' are just the
|
|
791
|
-
// reference render effect's two.
|
|
792
|
-
const output = typeof body.output === 'string' && body.output ? body.output : 'image';
|
|
793
|
-
const effectKey = typeof body.effectKey === 'string' && body.effectKey ? body.effectKey : 'render';
|
|
794
|
-
const contentType = body.contentType ?? (output === 'traits' ? 'application/json' : 'image/png');
|
|
795
|
-
const key = renderArtifactKey(SERVER_CHAIN_ID, address, tokenId, inputsHashHex, output, effectKey);
|
|
796
|
-
// BOTH modes register a row — the row is the `artifacts` manifest's enumeration surface;
|
|
797
|
-
// locator NULL on the bytes mode means "the bytes live in this node's custody at the key".
|
|
798
|
-
const row = { key, address, tokenId, effectKey, outputKey: output, inputsHash: inputsHashHex, contentType };
|
|
799
|
-
const locator = typeof body.locator === 'string' && body.locator ? body.locator : undefined;
|
|
800
|
-
if (locator) {
|
|
801
|
-
indexer.store.putEffectArtifact({ ...row, locator });
|
|
802
|
-
return sendJson(res, 200, { ok: true, mode: 'locator', key, output, locator });
|
|
803
|
-
}
|
|
804
|
-
const bytesB64 = typeof body.bytes_base64 === 'string' && body.bytes_base64 ? body.bytes_base64 : undefined;
|
|
805
|
-
if (bytesB64) {
|
|
806
|
-
const bytes = new Uint8Array(Buffer.from(bytesB64, 'base64'));
|
|
807
|
-
await storage.put(key, { bytes, contentType });
|
|
808
|
-
indexer.store.putEffectArtifact({ ...row, locator: null });
|
|
809
|
-
return sendJson(res, 200, { ok: true, mode: 'bytes', key, output, bytes: bytes.length });
|
|
810
|
-
}
|
|
811
|
-
return sendJson(res, 400, { error: 'provide body.locator (a durable ipfs://ar://https URL) or body.bytes_base64' });
|
|
812
|
-
}
|
|
813
|
-
/**
|
|
814
|
-
* `POST /admin/effect-status {key, address, tokenId, effectKey, status, error?, attempts?}` — a
|
|
815
|
-
* runner reports one run's transient state for the artifact `key` it is producing (the runner
|
|
816
|
-
* computes the key; this node never re-derives it, mirroring /admin/effect-artifacts). `status`
|
|
817
|
-
* 'done' clears the row (artifact presence takes over as truth); 'rendering'/'failed' upsert.
|
|
818
|
-
*/
|
|
819
|
-
async function adminEffectStatus(req, res, indexer) {
|
|
820
|
-
if (!process.env.ABX_RESOLVER_ADMIN_TOKEN) {
|
|
821
|
-
return sendJson(res, 404, { error: 'admin API disabled — set ABX_RESOLVER_ADMIN_TOKEN on the resolver' });
|
|
822
|
-
}
|
|
823
|
-
if (!adminAuthorized(req)) {
|
|
824
|
-
return sendJson(res, 401, { error: 'unauthorized — send Authorization: Bearer <ABX_RESOLVER_ADMIN_TOKEN>' });
|
|
825
|
-
}
|
|
826
|
-
if ((req.method ?? 'GET') !== 'POST')
|
|
827
|
-
return sendJson(res, 405, { error: 'use POST /admin/effect-status' });
|
|
828
|
-
let body;
|
|
829
|
-
try {
|
|
830
|
-
body = await readJsonBody(req);
|
|
831
|
-
}
|
|
832
|
-
catch (err) {
|
|
833
|
-
return sendJson(res, 400, { error: err.message });
|
|
834
|
-
}
|
|
835
|
-
const key = body.key;
|
|
836
|
-
if (!key || !/^0x[0-9a-fA-F]{64}$/.test(key)) {
|
|
837
|
-
return sendJson(res, 400, { error: 'body.key must be the 0x 32-byte artifact key this run produces' });
|
|
838
|
-
}
|
|
839
|
-
const address = body.address;
|
|
840
|
-
if (!address || !ADDRESS_RE.test(address)) {
|
|
841
|
-
return sendJson(res, 400, { error: 'body.address must be a 0x-prefixed 20-byte address' });
|
|
842
|
-
}
|
|
843
|
-
const status = body.status;
|
|
844
|
-
if (status === 'done') {
|
|
845
|
-
indexer.store.clearEffectStatus(key);
|
|
846
|
-
return sendJson(res, 200, { ok: true, cleared: key });
|
|
847
|
-
}
|
|
848
|
-
if (status !== 'rendering' && status !== 'failed') {
|
|
849
|
-
return sendJson(res, 400, { error: "body.status must be 'rendering' | 'failed' | 'done'" });
|
|
850
|
-
}
|
|
851
|
-
indexer.store.putEffectStatus({
|
|
852
|
-
key,
|
|
853
|
-
address,
|
|
854
|
-
tokenId: String(body.tokenId ?? ''),
|
|
855
|
-
effectKey: typeof body.effectKey === 'string' && body.effectKey ? body.effectKey : 'render',
|
|
856
|
-
status,
|
|
857
|
-
error: typeof body.error === 'string' ? body.error.slice(0, 2000) : null,
|
|
858
|
-
attempts: typeof body.attempts === 'number' ? body.attempts : undefined,
|
|
859
|
-
});
|
|
860
|
-
return sendJson(res, 200, { ok: true, key, status });
|
|
861
|
-
}
|
|
862
635
|
/**
|
|
863
636
|
* Per-token effect status for a project — the "did every thumbnail land?" surface behind
|
|
864
637
|
* `GET /api/project/:addr/effects` and `abx verify`. Status is DERIVED, in precedence order:
|
|
@@ -874,7 +647,7 @@ async function effectStatusReport(indexer, state, storage) {
|
|
|
874
647
|
const counts = { upToDate: 0, stale: 0, rendering: 0, failed: 0 };
|
|
875
648
|
if (isCodeProject(state)) {
|
|
876
649
|
for (const token of state.tokens.filter((t) => t.minted)) {
|
|
877
|
-
const { key, found } = await currentRenderArtifact(
|
|
650
|
+
const { key, found } = await currentRenderArtifact(chainClientLazy(), state, token, storage);
|
|
878
651
|
const published = !found && !!indexer.store.getEffectArtifact(key);
|
|
879
652
|
const row = byKey.get(key.toLowerCase());
|
|
880
653
|
let status;
|
|
@@ -933,8 +706,26 @@ function watchStatusReport(indexer) {
|
|
|
933
706
|
chains,
|
|
934
707
|
};
|
|
935
708
|
}
|
|
936
|
-
/**
|
|
709
|
+
/**
|
|
710
|
+
* The path was well-formed and on the right chain — this node just doesn't index that contract.
|
|
711
|
+
* Code `not_registered` (the control plane's own code for the same condition) so a client can tell
|
|
712
|
+
* it apart from a malformed path (400 `invalid_request`) and a nonexistent route (404
|
|
713
|
+
* `unknown_route`). Those three used to be one indistinguishable `{error: '…'}` 404.
|
|
714
|
+
*/
|
|
715
|
+
function unknownProject(res) {
|
|
716
|
+
sendError(res, 404, 'not_registered', 'this node does not index that contract', {
|
|
717
|
+
hint: 'register it with `abx add <address> --remote <name|url>` (bearer-gated control plane), then `abx index <address> --remote`',
|
|
718
|
+
});
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* A path whose chainId segment isn't the chain this resolver serves. **400 `unsupported_chain`**,
|
|
722
|
+
* matching the control plane's `checkChain` exactly (control-plane.ts) — it's a request error, not a
|
|
723
|
+
* missing resource, and answering 404 made it indistinguishable from "that project isn't indexed
|
|
724
|
+
* here", which sent at least one client hunting a phantom outage. `chains` says what IS served.
|
|
725
|
+
*/
|
|
937
726
|
function wrongChain(res, got) {
|
|
938
|
-
|
|
727
|
+
sendError(res, 400, 'unsupported_chain', `this resolver serves chain ${serverChainId()}, not ${got}`, {
|
|
728
|
+
chains: [serverChainId()],
|
|
729
|
+
});
|
|
939
730
|
}
|
|
940
731
|
//# sourceMappingURL=server.js.map
|