@bsv/overlay-express 2.7.5 → 2.8.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.
- package/README.md +146 -0
- package/dist/cjs/mod.d.ts +2 -1
- package/dist/cjs/mod.d.ts.map +1 -1
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +34 -8
- package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts +10 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.js +125 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/OutputLookupResponseGuard.d.ts +31 -0
- package/dist/cjs/src/OutputLookupResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupResponseGuard.js +91 -0
- package/dist/cjs/src/OutputLookupResponseGuard.js.map +1 -0
- package/dist/cjs/src/OutputLookupRoutes.d.ts +53 -0
- package/dist/cjs/src/OutputLookupRoutes.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupRoutes.js +274 -0
- package/dist/cjs/src/OutputLookupRoutes.js.map +1 -0
- package/dist/cjs/src/OverlayExpress.d.ts +63 -0
- package/dist/cjs/src/OverlayExpress.d.ts.map +1 -1
- package/dist/cjs/src/OverlayExpress.js +263 -6
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js +90 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.js +108 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts +7 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.js +269 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.js.map +1 -0
- package/dist/cjs/src/PrivateOverlayHost.d.ts +31 -0
- package/dist/cjs/src/PrivateOverlayHost.d.ts.map +1 -0
- package/dist/cjs/src/PrivateOverlayHost.js +64 -0
- package/dist/cjs/src/PrivateOverlayHost.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.js +38 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts +40 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts +14 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.js +82 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationRoutes.d.ts +6 -0
- package/dist/cjs/src/PrivatePublicationRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationRoutes.js +249 -0
- package/dist/cjs/src/PrivatePublicationRoutes.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js +82 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts +15 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.js +85 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.d.ts +7 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.js +276 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.js.map +1 -0
- package/dist/cjs/src/ProposalHTTPPolicy.d.ts +11 -0
- package/dist/cjs/src/ProposalHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/ProposalHTTPPolicy.js +38 -0
- package/dist/cjs/src/ProposalHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/ProposalHTTPPorts.d.ts +59 -0
- package/dist/cjs/src/ProposalHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/ProposalHTTPPorts.js +3 -0
- package/dist/cjs/src/ProposalHTTPPorts.js.map +1 -0
- package/dist/cjs/src/ProposalResponseGuard.d.ts +18 -0
- package/dist/cjs/src/ProposalResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/ProposalResponseGuard.js +61 -0
- package/dist/cjs/src/ProposalResponseGuard.js.map +1 -0
- package/dist/cjs/src/ProposalRoutes.d.ts +10 -0
- package/dist/cjs/src/ProposalRoutes.d.ts.map +1 -0
- package/dist/cjs/src/ProposalRoutes.js +239 -0
- package/dist/cjs/src/ProposalRoutes.js.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts +8 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.js +77 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.d.ts +73 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.js +3 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.js.map +1 -0
- package/dist/cjs/src/RootEvictionResponseGuard.d.ts +38 -0
- package/dist/cjs/src/RootEvictionResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionResponseGuard.js +83 -0
- package/dist/cjs/src/RootEvictionResponseGuard.js.map +1 -0
- package/dist/cjs/src/RootEvictionRoutes.d.ts +11 -0
- package/dist/cjs/src/RootEvictionRoutes.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionRoutes.js +198 -0
- package/dist/cjs/src/RootEvictionRoutes.js.map +1 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/OutputLookupHTTPPolicy.js +117 -0
- package/dist/esm/src/OutputLookupHTTPPolicy.js.map +1 -0
- package/dist/esm/src/OutputLookupResponseGuard.js +85 -0
- package/dist/esm/src/OutputLookupResponseGuard.js.map +1 -0
- package/dist/esm/src/OutputLookupRoutes.js +275 -0
- package/dist/esm/src/OutputLookupRoutes.js.map +1 -0
- package/dist/esm/src/OverlayExpress.js +239 -11
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js +82 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPorts.js +2 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionResponseGuard.js +105 -0
- package/dist/esm/src/PrivateAcquisitionResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionRoutes.js +267 -0
- package/dist/esm/src/PrivateAcquisitionRoutes.js.map +1 -0
- package/dist/esm/src/PrivateOverlayHost.js +62 -0
- package/dist/esm/src/PrivateOverlayHost.js.map +1 -0
- package/dist/esm/src/PrivatePublicationHTTPPolicy.js +30 -0
- package/dist/esm/src/PrivatePublicationHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivatePublicationHTTPPorts.js +2 -0
- package/dist/esm/src/PrivatePublicationHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivatePublicationResponseGuard.js +79 -0
- package/dist/esm/src/PrivatePublicationResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivatePublicationRoutes.js +247 -0
- package/dist/esm/src/PrivatePublicationRoutes.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseHTTPPolicy.js +74 -0
- package/dist/esm/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseHTTPPorts.js +2 -0
- package/dist/esm/src/PrivatePurchaseHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseResponseGuard.js +82 -0
- package/dist/esm/src/PrivatePurchaseResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseRoutes.js +275 -0
- package/dist/esm/src/PrivatePurchaseRoutes.js.map +1 -0
- package/dist/esm/src/ProposalHTTPPolicy.js +30 -0
- package/dist/esm/src/ProposalHTTPPolicy.js.map +1 -0
- package/dist/esm/src/ProposalHTTPPorts.js +2 -0
- package/dist/esm/src/ProposalHTTPPorts.js.map +1 -0
- package/dist/esm/src/ProposalResponseGuard.js +58 -0
- package/dist/esm/src/ProposalResponseGuard.js.map +1 -0
- package/dist/esm/src/ProposalRoutes.js +237 -0
- package/dist/esm/src/ProposalRoutes.js.map +1 -0
- package/dist/esm/src/RootEvictionHTTPPolicy.js +71 -0
- package/dist/esm/src/RootEvictionHTTPPolicy.js.map +1 -0
- package/dist/esm/src/RootEvictionHTTPPorts.js +2 -0
- package/dist/esm/src/RootEvictionHTTPPorts.js.map +1 -0
- package/dist/esm/src/RootEvictionResponseGuard.js +80 -0
- package/dist/esm/src/RootEvictionResponseGuard.js.map +1 -0
- package/dist/esm/src/RootEvictionRoutes.js +196 -0
- package/dist/esm/src/RootEvictionRoutes.js.map +1 -0
- package/dist/types/mod.d.ts +2 -1
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/OutputLookupHTTPPolicy.d.ts +10 -0
- package/dist/types/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/OutputLookupResponseGuard.d.ts +31 -0
- package/dist/types/src/OutputLookupResponseGuard.d.ts.map +1 -0
- package/dist/types/src/OutputLookupRoutes.d.ts +53 -0
- package/dist/types/src/OutputLookupRoutes.d.ts.map +1 -0
- package/dist/types/src/OverlayExpress.d.ts +63 -0
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
- package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
- package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
- package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionRoutes.d.ts +7 -0
- package/dist/types/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
- package/dist/types/src/PrivateOverlayHost.d.ts +31 -0
- package/dist/types/src/PrivateOverlayHost.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
- package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationHTTPPorts.d.ts +40 -0
- package/dist/types/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationResponseGuard.d.ts +14 -0
- package/dist/types/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationRoutes.d.ts +6 -0
- package/dist/types/src/PrivatePublicationRoutes.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
- package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
- package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseResponseGuard.d.ts +15 -0
- package/dist/types/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseRoutes.d.ts +7 -0
- package/dist/types/src/PrivatePurchaseRoutes.d.ts.map +1 -0
- package/dist/types/src/ProposalHTTPPolicy.d.ts +11 -0
- package/dist/types/src/ProposalHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/ProposalHTTPPorts.d.ts +59 -0
- package/dist/types/src/ProposalHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/ProposalResponseGuard.d.ts +18 -0
- package/dist/types/src/ProposalResponseGuard.d.ts.map +1 -0
- package/dist/types/src/ProposalRoutes.d.ts +10 -0
- package/dist/types/src/ProposalRoutes.d.ts.map +1 -0
- package/dist/types/src/RootEvictionHTTPPolicy.d.ts +8 -0
- package/dist/types/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/RootEvictionHTTPPorts.d.ts +73 -0
- package/dist/types/src/RootEvictionHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/RootEvictionResponseGuard.d.ts +38 -0
- package/dist/types/src/RootEvictionResponseGuard.d.ts.map +1 -0
- package/dist/types/src/RootEvictionRoutes.d.ts +11 -0
- package/dist/types/src/RootEvictionRoutes.d.ts.map +1 -0
- package/package.json +109 -13
package/README.md
CHANGED
|
@@ -18,8 +18,53 @@ An opinionated but configurable Overlay Services deployment system:
|
|
|
18
18
|
|
|
19
19
|
Built-in discovery overflow probes use deterministic pages of at most 1000 rows. The configured engine result ceiling and extra-row overflow error remain enforced, including standard and high-throughput profiles.
|
|
20
20
|
|
|
21
|
+
The release candidate advances the packed Overlay dependency to support optional retained admission history. This package keeps its existing behavior and does not enable history retention automatically. No consumer or database migration is required.
|
|
22
|
+
|
|
23
|
+
The optional `@bsv/overlay-express/private-publication` entry exposes verified
|
|
24
|
+
private publication and publisher status through the shared BRC-103/104
|
|
25
|
+
authentication instance. Supply the same durable service and disclosure owner;
|
|
26
|
+
mount before generic parsers and response transformations. It checks original
|
|
27
|
+
selection and current record authority again after signing, sends only bounded
|
|
28
|
+
public projections and fixed errors, and preserves credential-free CORS by
|
|
29
|
+
default. It never mounts automatically or installs a payment handler. See the
|
|
30
|
+
[private publication guide](../../../docs/guides/verified-private-publication.md).
|
|
31
|
+
|
|
21
32
|
## Requirements and installation
|
|
22
33
|
|
|
34
|
+
The unpublished 2.8.0 candidate also provides the optional
|
|
35
|
+
`@bsv/overlay-express/root-eviction-response` companion. With middleware 2.3.0,
|
|
36
|
+
SDK 3.3.0 and a shared root journal, `guardRootAdvertisementResponse` checks current
|
|
37
|
+
access and every disclosed advertisement after signing and queues the native HTTP
|
|
38
|
+
response under the journal's gate. Stale responses are replaced in full by a
|
|
39
|
+
separately authorized signed reset. Capture the revision before hydration and
|
|
40
|
+
supply the complete target inventory and safe control-response headers. The
|
|
41
|
+
[root coordination guide](../../../docs/guides/root-eviction-coordination.md)
|
|
42
|
+
explains storage, policy and all-path integration obligations. Existing routes
|
|
43
|
+
remain unchanged; importing this companion does not enable the BRC-199 profile.
|
|
44
|
+
|
|
45
|
+
The optional `@bsv/overlay-express/root-eviction` entry composes a shared
|
|
46
|
+
`RootEvictionService` with exact authenticated request/status routes. It preserves
|
|
47
|
+
received UTF-8 byte limits and checks the observed revision and current access
|
|
48
|
+
again at native enqueue after packet and HTTP signing. Mount before generic
|
|
49
|
+
parsers with the same origin authentication middleware and durable journal.
|
|
50
|
+
Credential-free wildcard CORS is the default; exact origins are opt-in. It does
|
|
51
|
+
not publish capabilities or install a decision scheduler or serving adapters.
|
|
52
|
+
Call `configureRootEviction` before `start()` for native host integration. The
|
|
53
|
+
configured root identity must match the server wallet; root, authenticated lookup
|
|
54
|
+
and admin routes share authentication and host request capacity. Omitted root
|
|
55
|
+
origins inherit the host's edge policy, and byte limits cannot exceed host limits.
|
|
56
|
+
The injected journal and workers retain application ownership. See the root
|
|
57
|
+
coordination guide for installation and remaining obligations.
|
|
58
|
+
|
|
59
|
+
The optional lookup router and `configureOutputLookup` accept a structural
|
|
60
|
+
`disclosure` companion for a final current-session check after HTTP signing.
|
|
61
|
+
`LookupResponseDisclosure` from `@bsv/output-knowledge/lookup` composes that port
|
|
62
|
+
with durable SQLite sessions. It can replace an ineligible data response once
|
|
63
|
+
with a freshly authorized signed error, or close without a body when control
|
|
64
|
+
access is denied. Omitting the option preserves existing behavior. See the
|
|
65
|
+
[durable lookup guide](../../../docs/guides/durable-live-lookup.md#check-again-after-signing)
|
|
66
|
+
for the shared writer gate, current policy, physical work and callback obligations.
|
|
67
|
+
|
|
23
68
|
Overlay Express requires Node.js 22 or newer and a separately installed
|
|
24
69
|
`@bsv/sdk` peer dependency.
|
|
25
70
|
|
|
@@ -289,6 +334,34 @@ for transactions that remain unproven past the threshold. Only transactions that
|
|
|
289
334
|
still cannot be proven are evicted. Operators can also run this manually through
|
|
290
335
|
the admin endpoints documented below.
|
|
291
336
|
|
|
337
|
+
### Registering Additional Routers
|
|
338
|
+
|
|
339
|
+
`registerRouter(path, factory)` mounts your own router inside the server. The factory runs
|
|
340
|
+
during `start()`, after the BRC-103 authentication middleware and before the admin routes and
|
|
341
|
+
the 404 handler, so the router inherits CORS, body parsing, response size limits, and
|
|
342
|
+
`req.auth.identityKey`. Requests without BRC-103 headers arrive with `req.auth.identityKey`
|
|
343
|
+
equal to `'unknown'`; routes that need authentication must reject them. Call it before
|
|
344
|
+
`start()`.
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
server.registerRouter('/', ({ engine, wallet }) => {
|
|
348
|
+
if (wallet === undefined) throw new Error('A server wallet is required')
|
|
349
|
+
const router = express.Router()
|
|
350
|
+
router.get('/status', (_req, res) => res.json({ ok: true }))
|
|
351
|
+
return router
|
|
352
|
+
})
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
The `wallet` in the context is the BRC-103 authentication wallet. It is built without a storage
|
|
356
|
+
provider, so it signs and verifies but cannot create or internalize actions: `createAction` and
|
|
357
|
+
`internalizeAction` throw. A router that takes payment, such as a BRC-178 host from `@bsv/eqc`,
|
|
358
|
+
must build its own storage-backed wallet from the same root key as the server, so that its
|
|
359
|
+
identity equals the BRC-103 session key and the SLAP-advertised key.
|
|
360
|
+
|
|
361
|
+
Registered routers inherit the response size limit (`MAX_RESPONSE_BYTES`: 4 MiB on the `small`
|
|
362
|
+
profile, 8 MiB on `standard`). A larger JSON body is replaced by a 413 after the handler ran, so a
|
|
363
|
+
router that is paid before it answers must bound its own responses below that limit.
|
|
364
|
+
|
|
292
365
|
### Admin-Protected Endpoints
|
|
293
366
|
|
|
294
367
|
We also provide admin-protected endpoints for advanced operations like manually
|
|
@@ -433,3 +506,76 @@ under the Open BSV License Version 4. Redistributors must preserve
|
|
|
433
506
|
[`LICENSES/`](./LICENSES/).
|
|
434
507
|
|
|
435
508
|
Thank you for being a part of the BSV Blockchain Overlay Express Project. Let's build the future of BSV Blockchain together!
|
|
509
|
+
|
|
510
|
+
## Optional progressive and live lookup
|
|
511
|
+
|
|
512
|
+
Call `configureOutputLookup` before `start`, or import `createOutputLookupRouter`
|
|
513
|
+
from `@bsv/overlay-express/output-lookup` for standalone Express composition. The
|
|
514
|
+
new adapter requires SDK 3.3.0, a durable provider companion, a signed matching
|
|
515
|
+
capability manifest, current authorization and explicit browser origins. The
|
|
516
|
+
legacy root loads this adapter only when enabled. Existing finite lookup routes
|
|
517
|
+
and default startup remain unchanged.
|
|
518
|
+
|
|
519
|
+
The host shares its authentication instance, verifies the serving wallet identity
|
|
520
|
+
and clamps advertised byte budgets to its existing edge limits. Provider storage
|
|
521
|
+
lifecycle remains with the caller. See the [provider guide](../../../docs/guides/durable-live-lookup.md)
|
|
522
|
+
for initialization, exact retry recovery, disclosure guards, multi-process wakeups,
|
|
523
|
+
retention and standalone router ordering. The candidate is unpublished and the
|
|
524
|
+
complete BRC-192–199 integration remains under qualification.
|
|
525
|
+
|
|
526
|
+
## Optional authenticated proposals
|
|
527
|
+
|
|
528
|
+
`configureProposals` before `start` or the separate
|
|
529
|
+
`@bsv/overlay-express/proposals` router composes the durable proposal service,
|
|
530
|
+
service-owned disclosure validator and shared journal/native-enqueue gate.
|
|
531
|
+
This entry requires SDK 3.3.0 and auth middleware 2.3; legacy root peer floors and
|
|
532
|
+
routes remain unchanged. A current channel read differs from recovery of a
|
|
533
|
+
retained publication ACK. Both require current authorization and original
|
|
534
|
+
contract bounds after response signing. One sanitized replacement error may be
|
|
535
|
+
signed, with independently checked control permission before native enqueue.
|
|
536
|
+
|
|
537
|
+
The host shares authentication and handshake ownership with lookup/root companions,
|
|
538
|
+
keeps physical service work counted through settlement, clamps byte limits and
|
|
539
|
+
inherits host CORS policy unless explicitly overridden. Storage, capability
|
|
540
|
+
publication, verified recovery, expiry and admission workers remain host-owned.
|
|
541
|
+
See the [proposal guide](../../../docs/guides/non-final-proposals.md) for composition and recovery contracts.
|
|
542
|
+
|
|
543
|
+
### Private acquisition and publication
|
|
544
|
+
|
|
545
|
+
Explicit `configurePrivateAcquisition` and `configurePrivatePublication` methods
|
|
546
|
+
compose the installed private services with the host's single authenticated
|
|
547
|
+
wallet/session. Private acquisition routes precede publication's namespace
|
|
548
|
+
fallback and ordinary body parsers. The default public CORS policy remains
|
|
549
|
+
credential-free; explicit origins and host byte ceilings are preserved.
|
|
550
|
+
Acquisition-configured listeners alone select a bounded 128-KiB HTTP header
|
|
551
|
+
allowance for BRC-105 payment evidence. Standalone applications can import
|
|
552
|
+
`createPrivateAcquisitionRouter` from `@bsv/overlay-express/private-acquisition`.
|
|
553
|
+
The application owns durable custody, permissions, wallet recovery and worker
|
|
554
|
+
shutdown. See [acquisition and recovery](../../../docs/guides/private-acquisition-recovery.md)
|
|
555
|
+
for composition, original-obligation semantics, payment/recovery requests and
|
|
556
|
+
proxy limits. These opt-in profiles need the new SDK output APIs; legacy startup
|
|
557
|
+
retains its supported SDK floor.
|
|
558
|
+
|
|
559
|
+
### Covenant purchase companions
|
|
560
|
+
|
|
561
|
+
`configurePrivatePurchase` or the optional
|
|
562
|
+
`@bsv/overlay-express/private-purchase` router adds the proposed BRC-196
|
|
563
|
+
`/overlay/v1/purchases/prepare`, `/submit` and `/recover` operations under the
|
|
564
|
+
configured base path. These use the shared host authentication wallet, exact
|
|
565
|
+
selected capability and native physical disclosure owner. Covenant payment
|
|
566
|
+
occurs in the independently validated transaction; these routes reject HTTP
|
|
567
|
+
payment headers and do not introduce a second BRC-105 charge.
|
|
568
|
+
|
|
569
|
+
Purchase, acquisition and publication share one handshake owner and preserve
|
|
570
|
+
ordinary `/submit`/lookup behavior, request ceilings and credential-free CORS.
|
|
571
|
+
The application owns original protected custody, full domain/release validation
|
|
572
|
+
and stopping/draining the coordinator before closing its native domain. See
|
|
573
|
+
[purchase custody](../../../docs/guides/private-purchase-custody.md) for the
|
|
574
|
+
component boundaries and remaining end-to-end qualification requirements.
|
|
575
|
+
|
|
576
|
+
## SDK4 hotfix peer requirement
|
|
577
|
+
|
|
578
|
+
The SDK4 peer alternative starts at `@bsv/sdk ^4.0.1`, which restores numeric
|
|
579
|
+
wallet results and legacy wire compatibility. Existing SDK2/3 alternatives and
|
|
580
|
+
lower bounds remain unchanged. SDK4 users should install the 4.0.1 hotfix; no
|
|
581
|
+
application-wallet wire or data migration is required.
|
package/dist/cjs/mod.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { default, type EngineConfig, type EdgePolicyConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus, type TopicAnchorHeaderResolver } from './src/OverlayExpress.js';
|
|
1
|
+
export { default, type EngineConfig, type EdgePolicyConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus, type RegisteredRouterContext, type RegisteredRouterFactory, type TopicAnchorHeaderResolver } from './src/OverlayExpress.js';
|
|
2
2
|
export { BanService, type BannedRecord } from './src/BanService.js';
|
|
3
3
|
export { BanAwareLookupWrapper } from './src/BanAwareLookupWrapper.js';
|
|
4
4
|
export { BanAwareTopicManager } from './src/BanAwareTopicManager.js';
|
|
@@ -8,4 +8,5 @@ export { OverlayMonitor, analyzeOverlayAnchorTip, analyzeOverlayLookupResponse,
|
|
|
8
8
|
export { ArcadeProvider, isTerminalArcStatus, type ArcadeMerkleProof, type ArcadeProviderConfig } from './src/ArcadeProvider.js';
|
|
9
9
|
export { ProviderChainBroadcaster, type NamedBroadcaster } from './src/ProviderChainBroadcaster.js';
|
|
10
10
|
export { ChaintracksProvider, type ChaintracksHeader, type ChaintracksProviderConfig } from './src/ChaintracksProvider.js';
|
|
11
|
+
export type { OutputLookupCompanion, OutputLookupCaller, OutputLookupHTTPResponse, OutputLookupRouteOptions } from './src/OutputLookupRoutes.js';
|
|
11
12
|
//# sourceMappingURL=mod.d.ts.map
|
package/dist/cjs/mod.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AAC5F,OAAO,EACL,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,4BAA4B,EAC5B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC3B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACnG,OAAO,EACL,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC/B,MAAM,8BAA8B,CAAA"}
|
|
1
|
+
{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AAC5F,OAAO,EACL,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,4BAA4B,EAC5B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC3B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACnG,OAAO,EACL,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC/B,MAAM,8BAA8B,CAAA;AACrC,YAAY,EACV,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,6BAA6B,CAAA"}
|
package/dist/cjs/mod.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,6DAagC;AAZ9B,6HAAA,OAAO,OAAA;AAaT,qDAAmE;AAA1D,2GAAA,UAAU,OAAA;AACnB,2EAAsE;AAA7D,iIAAA,qBAAqB,OAAA;AAC9B,yEAAoE;AAA3D,+HAAA,oBAAoB,OAAA;AAC7B,iFAA4F;AAAnF,kIAAA,mBAAmB,OAAA;AAAE,kIAAA,mBAAmB,OAAA;AACjD,6DAKgC;AAJ9B,mHAAA,cAAc,OAAA;AAKhB,6DAegC;AAd9B,mHAAA,cAAc,OAAA;AACd,4HAAA,uBAAuB,OAAA;AACvB,iIAAA,4BAA4B,OAAA;AAa9B,6DAKgC;AAJ9B,mHAAA,cAAc,OAAA;AACd,wHAAA,mBAAmB,OAAA;AAIrB,iFAAmG;AAA1F,uIAAA,wBAAwB,OAAA;AACjC,uEAIqC;AAHnC,6HAAA,mBAAmB,OAAA"}
|
package/dist/cjs/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bsv/overlay-express",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.8.0",
|
|
4
4
|
"sideEffects": false,
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=22"
|
|
@@ -19,16 +19,16 @@
|
|
|
19
19
|
"LICENSES"
|
|
20
20
|
],
|
|
21
21
|
"scripts": {
|
|
22
|
-
"test": "jest --watchman=false",
|
|
23
|
-
"test:watch": "jest --watch",
|
|
24
|
-
"test:coverage": "jest --coverage --watchman=false",
|
|
25
|
-
"test:property": "jest --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts",
|
|
22
|
+
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watchman=false",
|
|
23
|
+
"test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
|
|
24
|
+
"test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --runInBand --watchman=false",
|
|
25
|
+
"test:property": "node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts src/__tests__/OutputLookupRoutes.property.test.ts src/__tests__/RootEvictionResponseGuard.property.test.ts src/__tests__/RootEvictionRoutes.property.test.ts src/__tests__/ProposalRoutes.property.test.ts src/__tests__/PrivatePublicationRoutes.property.test.ts src/__tests__/PrivateAcquisitionRoutes.property.test.ts src/__tests__/PrivatePurchaseRoutes.property.test.ts",
|
|
26
26
|
"test:live": "pnpm build && node ../../../scripts/run-governed-test.mjs live src/__tests__/OverlayProviders.live.test.ts",
|
|
27
27
|
"format:check": "pnpm --workspace-root exec prettier --check \"packages/overlays/overlay-express/{README.md,jest.config.js,mod.ts,package.json,tsconfig*.json}\"",
|
|
28
28
|
"lint": "oxlint mod.ts src jest.config.js --deny-warnings",
|
|
29
29
|
"lint:ci": "pnpm lint",
|
|
30
|
-
"pack:check": "pnpm --filter @bsv/overlay build && pnpm --filter @bsv/overlay-discovery-services build && pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports ArcadeProvider,BanAwareLookupWrapper,BanAwareSHIPStorage,BanAwareSLAPStorage,BanAwareTopicManager,BanService,ChaintracksProvider,JanitorService,OverlayMonitor,ProviderChainBroadcaster,analyzeOverlayAnchorTip,analyzeOverlayLookupResponse,default,isTerminalArcStatus",
|
|
31
|
-
"typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false",
|
|
30
|
+
"pack:check": "pnpm --filter @bsv/overlay build && pnpm --filter @bsv/overlay-discovery-services build && pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports ArcadeProvider,BanAwareLookupWrapper,BanAwareSHIPStorage,BanAwareSLAPStorage,BanAwareTopicManager,BanService,ChaintracksProvider,JanitorService,OverlayMonitor,ProviderChainBroadcaster,analyzeOverlayAnchorTip,analyzeOverlayLookupResponse,default,isTerminalArcStatus --entry-exports \"./output-lookup=createOutputLookupRouter;./root-eviction-response=guardRootAdvertisementResponse;./root-eviction=createRootEvictionRouter;./proposals=createProposalRouter;./private-publication=createPrivatePublicationRouter;./private-acquisition=createPrivateAcquisitionRouter;./private-purchase=createPrivatePurchaseRouter\" && node ../../../scripts/check-legacy-overlay-sdk.mjs",
|
|
31
|
+
"typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false && tsc --project tsconfig.proposal-tests.json",
|
|
32
32
|
"build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
|
|
33
33
|
"dev": "tsc -b -w",
|
|
34
34
|
"prepublishOnly": "pnpm build",
|
|
@@ -60,6 +60,7 @@
|
|
|
60
60
|
"@types/jest": "^30.0.0",
|
|
61
61
|
"@types/node": "^26.6.1",
|
|
62
62
|
"@typescript/native": "npm:typescript@7.0.2",
|
|
63
|
+
"express-rate-limit": "^8.6.1",
|
|
63
64
|
"fast-check": "^4.9.0",
|
|
64
65
|
"jest": "^30.5.1",
|
|
65
66
|
"oxlint": "^1.83.0",
|
|
@@ -82,11 +83,36 @@
|
|
|
82
83
|
"uuid": "^14.0.2"
|
|
83
84
|
},
|
|
84
85
|
"peerDependencies": {
|
|
85
|
-
"@bsv/sdk": "^2.4.0 || ^3.0.0 || ^4.0.
|
|
86
|
+
"@bsv/sdk": "^2.4.0 || ^3.0.0 || ^4.0.1"
|
|
86
87
|
},
|
|
87
88
|
"peerDependenciesMeta": {
|
|
88
89
|
"@bsv/sdk": {
|
|
89
90
|
"optional": false
|
|
90
91
|
}
|
|
92
|
+
},
|
|
93
|
+
"typesVersions": {
|
|
94
|
+
"*": {
|
|
95
|
+
"output-lookup": [
|
|
96
|
+
"dist/types/src/OutputLookupRoutes.d.ts"
|
|
97
|
+
],
|
|
98
|
+
"root-eviction-response": [
|
|
99
|
+
"dist/types/src/RootEvictionResponseGuard.d.ts"
|
|
100
|
+
],
|
|
101
|
+
"root-eviction": [
|
|
102
|
+
"dist/types/src/RootEvictionRoutes.d.ts"
|
|
103
|
+
],
|
|
104
|
+
"proposals": [
|
|
105
|
+
"dist/types/src/ProposalRoutes.d.ts"
|
|
106
|
+
],
|
|
107
|
+
"private-publication": [
|
|
108
|
+
"dist/types/src/PrivatePublicationRoutes.d.ts"
|
|
109
|
+
],
|
|
110
|
+
"private-acquisition": [
|
|
111
|
+
"dist/types/src/PrivateAcquisitionRoutes.d.ts"
|
|
112
|
+
],
|
|
113
|
+
"private-purchase": [
|
|
114
|
+
"dist/types/src/PrivatePurchaseRoutes.d.ts"
|
|
115
|
+
]
|
|
116
|
+
}
|
|
91
117
|
}
|
|
92
118
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Request, Response } from 'express';
|
|
2
|
+
import { type OutputServiceError } from '@bsv/sdk';
|
|
3
|
+
/** Do not expose exception messages, queries, private rows, cursor material or storage paths. */
|
|
4
|
+
export declare function lookupHTTPError(error: unknown): OutputServiceError;
|
|
5
|
+
export declare function sendLookupHTTPError(res: Response, error: unknown): void;
|
|
6
|
+
export declare function lookupPrivateHeaders(res: Response): void;
|
|
7
|
+
/** Exact configured origins only; no cookie credentials or environment-driven wildcard. */
|
|
8
|
+
export declare function lookupOrigins(input: readonly string[]): ReadonlySet<string>;
|
|
9
|
+
export declare function lookupCORS(req: Request, res: Response, origins: ReadonlySet<string>): boolean;
|
|
10
|
+
//# sourceMappingURL=OutputLookupHTTPPolicy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupHTTPPolicy.d.ts","sourceRoot":"","sources":["../../../src/OutputLookupHTTPPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAIL,KAAK,kBAAkB,EACxB,MAAM,UAAU,CAAA;AAkCjB,iGAAiG;AACjG,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB,CAyBlE;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAOvE;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CASxD;AAED,2FAA2F;AAC3F,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAiB3E;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAwB7F"}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.lookupHTTPError = lookupHTTPError;
|
|
4
|
+
exports.sendLookupHTTPError = sendLookupHTTPError;
|
|
5
|
+
exports.lookupPrivateHeaders = lookupPrivateHeaders;
|
|
6
|
+
exports.lookupOrigins = lookupOrigins;
|
|
7
|
+
exports.lookupCORS = lookupCORS;
|
|
8
|
+
const sdk_1 = require("@bsv/sdk");
|
|
9
|
+
const authenticationHeaders = [
|
|
10
|
+
'x-bsv-auth-identity-key',
|
|
11
|
+
'x-bsv-auth-message-type',
|
|
12
|
+
'x-bsv-auth-nonce',
|
|
13
|
+
'x-bsv-auth-request-id',
|
|
14
|
+
'x-bsv-auth-requested-certificates',
|
|
15
|
+
'x-bsv-auth-signature',
|
|
16
|
+
'x-bsv-auth-version',
|
|
17
|
+
'x-bsv-auth-your-nonce'
|
|
18
|
+
];
|
|
19
|
+
const selectionHeaders = ['x-bsv-overlay-capability', 'x-bsv-overlay-profile'];
|
|
20
|
+
const allowedHeaders = [
|
|
21
|
+
'authorization',
|
|
22
|
+
'content-type',
|
|
23
|
+
'cache-control',
|
|
24
|
+
...authenticationHeaders,
|
|
25
|
+
...selectionHeaders
|
|
26
|
+
];
|
|
27
|
+
const codes = new Set([
|
|
28
|
+
'invalid',
|
|
29
|
+
'unauthorized',
|
|
30
|
+
'not-found',
|
|
31
|
+
'conflict',
|
|
32
|
+
'equivocation',
|
|
33
|
+
'reset-required',
|
|
34
|
+
'context-changed',
|
|
35
|
+
'expired',
|
|
36
|
+
'limited',
|
|
37
|
+
'unsupported',
|
|
38
|
+
'unavailable'
|
|
39
|
+
]);
|
|
40
|
+
/** Do not expose exception messages, queries, private rows, cursor material or storage paths. */
|
|
41
|
+
function lookupHTTPError(error) {
|
|
42
|
+
var _a, _b, _c;
|
|
43
|
+
let code = 'unavailable', retryable = true;
|
|
44
|
+
let limit;
|
|
45
|
+
if (error instanceof Error) {
|
|
46
|
+
const properties = Object.getOwnPropertyDescriptors(error);
|
|
47
|
+
const candidate = (_a = properties.code) === null || _a === void 0 ? void 0 : _a.value;
|
|
48
|
+
if (typeof candidate === 'string' &&
|
|
49
|
+
codes.has(candidate)) {
|
|
50
|
+
code = candidate;
|
|
51
|
+
retryable = ((_b = properties.retryable) === null || _b === void 0 ? void 0 : _b.value) === true;
|
|
52
|
+
if (code === 'limited')
|
|
53
|
+
limit = (_c = properties.limit) === null || _c === void 0 ? void 0 : _c.value;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
const base = { version: 1, error: { code, message: `Lookup request ${code}`, retryable } };
|
|
57
|
+
if (limit !== undefined) {
|
|
58
|
+
try {
|
|
59
|
+
return (0, sdk_1.parseOutputServiceError)({ ...base, error: { ...base.error, limit } });
|
|
60
|
+
}
|
|
61
|
+
catch {
|
|
62
|
+
/* Only validated bounded diagnostics are public. */
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
return (0, sdk_1.parseOutputServiceError)(base);
|
|
66
|
+
}
|
|
67
|
+
function sendLookupHTTPError(res, error) {
|
|
68
|
+
if (res.destroyed || res.writableEnded || res.headersSent)
|
|
69
|
+
return;
|
|
70
|
+
const packet = lookupHTTPError(error);
|
|
71
|
+
res
|
|
72
|
+
.status((0, sdk_1.outputServiceErrorHTTPStatus)(packet.error.code))
|
|
73
|
+
.set('content-type', 'application/json')
|
|
74
|
+
.end((0, sdk_1.canonicalOutputJSON)(packet, { bytes: 4096 }));
|
|
75
|
+
}
|
|
76
|
+
function lookupPrivateHeaders(res) {
|
|
77
|
+
res.set({
|
|
78
|
+
'cache-control': 'private, no-store',
|
|
79
|
+
'x-content-type-options': 'nosniff',
|
|
80
|
+
'x-accel-buffering': 'no'
|
|
81
|
+
});
|
|
82
|
+
res.vary('Authorization, x-bsv-auth-identity-key, x-bsv-overlay-capability, x-bsv-overlay-profile, Origin');
|
|
83
|
+
}
|
|
84
|
+
/** Exact configured origins only; no cookie credentials or environment-driven wildcard. */
|
|
85
|
+
function lookupOrigins(input) {
|
|
86
|
+
if (!Array.isArray(input) || input.length > 256)
|
|
87
|
+
throw new TypeError('Lookup origins must be a bounded array');
|
|
88
|
+
const result = new Set();
|
|
89
|
+
for (const origin of input) {
|
|
90
|
+
if (typeof origin !== 'string' || origin.length > 2048)
|
|
91
|
+
throw new TypeError('Invalid lookup origin');
|
|
92
|
+
const parsed = new URL(origin);
|
|
93
|
+
if (!['https:', 'http:'].includes(parsed.protocol) ||
|
|
94
|
+
parsed.origin !== origin ||
|
|
95
|
+
result.has(origin))
|
|
96
|
+
throw new TypeError('Lookup origins must be unique canonical HTTP(S) origins');
|
|
97
|
+
result.add(origin);
|
|
98
|
+
}
|
|
99
|
+
return result;
|
|
100
|
+
}
|
|
101
|
+
function lookupCORS(req, res, origins) {
|
|
102
|
+
const origin = req.headers.origin;
|
|
103
|
+
if (origin !== undefined) {
|
|
104
|
+
if (typeof origin !== 'string' || !origins.has(origin)) {
|
|
105
|
+
res.status(403).end();
|
|
106
|
+
return false;
|
|
107
|
+
}
|
|
108
|
+
res.set({
|
|
109
|
+
'access-control-allow-origin': origin,
|
|
110
|
+
'access-control-allow-methods': 'GET, POST, OPTIONS',
|
|
111
|
+
'access-control-allow-headers': allowedHeaders.join(', '),
|
|
112
|
+
'access-control-expose-headers': [...authenticationHeaders, ...selectionHeaders].join(', ')
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
if (req.method === 'OPTIONS') {
|
|
116
|
+
const wanted = req.headers['access-control-request-headers'];
|
|
117
|
+
const valid = wanted === undefined ||
|
|
118
|
+
(typeof wanted === 'string' &&
|
|
119
|
+
wanted.split(',').every(name => allowedHeaders.includes(name.trim().toLowerCase())));
|
|
120
|
+
res.status(valid ? 204 : 403).end();
|
|
121
|
+
return false;
|
|
122
|
+
}
|
|
123
|
+
return true;
|
|
124
|
+
}
|
|
125
|
+
//# sourceMappingURL=OutputLookupHTTPPolicy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupHTTPPolicy.js","sourceRoot":"","sources":["../../../src/OutputLookupHTTPPolicy.ts"],"names":[],"mappings":";;;;;;;AACA,kCAKiB;AAEjB,MAAM,qBAAqB,GAAG;IAC5B,yBAAyB;IACzB,yBAAyB;IACzB,kBAAkB;IAClB,uBAAuB;IACvB,mCAAmC;IACnC,sBAAsB;IACtB,oBAAoB;IACpB,uBAAuB;CACxB,CAAA;AACD,MAAM,gBAAgB,GAAG,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,CAAA;AAC9E,MAAM,cAAc,GAAG;IACrB,eAAe;IACf,cAAc;IACd,eAAe;IACf,GAAG,qBAAqB;IACxB,GAAG,gBAAgB;CACpB,CAAA;AACD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAsC;IACzD,SAAS;IACT,cAAc;IACd,WAAW;IACX,UAAU;IACV,cAAc;IACd,gBAAgB;IAChB,iBAAiB;IACjB,SAAS;IACT,SAAS;IACT,aAAa;IACb,aAAa;CACd,CAAC,CAAA;AAEF,iGAAiG;AACjG,yBAAgC,KAAc;;IAC5C,IAAI,IAAI,GAAwC,aAAa,EAC3D,SAAS,GAAG,IAAI,CAAA;IAClB,IAAI,KAAc,CAAA;IAClB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAA;QAC1D,MAAM,SAAS,GAAY,MAAA,UAAU,CAAC,IAAI,0CAAE,KAAK,CAAA;QACjD,IACE,OAAO,SAAS,KAAK,QAAQ;YAC7B,KAAK,CAAC,GAAG,CAAC,SAAgD,CAAC,EAC3D,CAAC;YACD,IAAI,GAAG,SAAgD,CAAA;YACvD,SAAS,GAAG,CAAA,MAAA,UAAU,CAAC,SAAS,0CAAE,KAAK,MAAK,IAAI,CAAA;YAChD,IAAI,IAAI,KAAK,SAAS;gBAAE,KAAK,GAAG,MAAA,UAAU,CAAC,KAAK,0CAAE,KAAK,CAAA;QACzD,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,kBAAkB,IAAI,EAAE,EAAE,SAAS,EAAE,EAAE,CAAA;IAC1F,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,IAAA,6BAAuB,EAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,oDAAoD;QACtD,CAAC;IACH,CAAC;IACD,OAAO,IAAA,6BAAuB,EAAC,IAAI,CAAC,CAAA;AACtC,CAAC;AAED,6BAAoC,GAAa,EAAE,KAAc;IAC/D,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,WAAW;QAAE,OAAM;IACjE,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAA;IACrC,GAAG;SACA,MAAM,CAAC,IAAA,kCAA4B,EAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACvD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;SACvC,GAAG,CAAC,IAAA,yBAAmB,EAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;AACtD,CAAC;AAED,8BAAqC,GAAa;IAChD,GAAG,CAAC,GAAG,CAAC;QACN,eAAe,EAAE,mBAAmB;QACpC,wBAAwB,EAAE,SAAS;QACnC,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAA;IACF,GAAG,CAAC,IAAI,CACN,iGAAiG,CAClG,CAAA;AACH,CAAC;AAED,2FAA2F;AAC3F,uBAA8B,KAAwB;IACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;QAC7C,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAA;IAC/D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAA;IAChC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;QAC3B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,IAAI;YACpD,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAA;QAC9B,IACE,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC9C,MAAM,CAAC,MAAM,KAAK,MAAM;YACxB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;YAElB,MAAM,IAAI,SAAS,CAAC,yDAAyD,CAAC,CAAA;QAChF,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACpB,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,oBAA2B,GAAY,EAAE,GAAa,EAAE,OAA4B;IAClF,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAA;IACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAA;YACrB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,GAAG,CAAC,GAAG,CAAC;YACN,6BAA6B,EAAE,MAAM;YACrC,8BAA8B,EAAE,oBAAoB;YACpD,8BAA8B,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YACzD,+BAA+B,EAAE,CAAC,GAAG,qBAAqB,EAAE,GAAG,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;SAC5F,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAA;QAC5D,MAAM,KAAK,GACT,MAAM,KAAK,SAAS;YACpB,CAAC,OAAO,MAAM,KAAK,QAAQ;gBACzB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAA;QACxF,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAA;QACnC,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { Response } from 'express';
|
|
2
|
+
import type { OutputLookupCaller } from './OutputLookupRoutes.js';
|
|
3
|
+
/** Structural private host port. Implementations own current session/access checks and native enqueue. */
|
|
4
|
+
export interface OutputLookupResponseBinding {
|
|
5
|
+
enqueue(bytes: Uint8Array, identity: string, enqueue: (bytes: Uint8Array) => undefined, signal: AbortSignal): Promise<void>;
|
|
6
|
+
}
|
|
7
|
+
export interface OutputLookupDisclosure {
|
|
8
|
+
bind(operation: 'open' | 'read', body: string, caller: OutputLookupCaller): OutputLookupResponseBinding;
|
|
9
|
+
control(body: string, caller: OutputLookupCaller): OutputLookupResponseBinding;
|
|
10
|
+
}
|
|
11
|
+
export interface OutputLookupResponseGuardOptions {
|
|
12
|
+
disclosure: OutputLookupDisclosure;
|
|
13
|
+
caller: OutputLookupCaller;
|
|
14
|
+
initial: {
|
|
15
|
+
operation: 'open' | 'read' | 'close';
|
|
16
|
+
body: string;
|
|
17
|
+
} | {
|
|
18
|
+
error: unknown;
|
|
19
|
+
};
|
|
20
|
+
/** Complete safe CORS/profile headers; never copied from the signed candidate. */
|
|
21
|
+
controlHeaders: Readonly<Record<string, string>>;
|
|
22
|
+
}
|
|
23
|
+
export declare function lookupResponseControl(error: unknown): {
|
|
24
|
+
statusCode: number;
|
|
25
|
+
body: Uint8Array;
|
|
26
|
+
};
|
|
27
|
+
/** Copy only response fields owned by this router, with no row/cursor-derived headers. */
|
|
28
|
+
export declare function lookupResponseControlHeaders(res: Response): Record<string, string>;
|
|
29
|
+
/** Signing stays outside storage; the bound owner admits exactly one native enqueue afterward. */
|
|
30
|
+
export declare function guardOutputLookupResponse(res: Response, options: OutputLookupResponseGuardOptions): void;
|
|
31
|
+
//# sourceMappingURL=OutputLookupResponseGuard.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupResponseGuard.d.ts","sourceRoot":"","sources":["../../../src/OutputLookupResponseGuard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AASvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAEjE,0GAA0G;AAC1G,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CACL,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,EACzC,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AACD,MAAM,WAAW,sBAAsB;IACrC,IAAI,CACF,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,GACzB,2BAA2B,CAAA;IAC9B,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,2BAA2B,CAAA;CAC/E;AACD,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,sBAAsB,CAAA;IAClC,MAAM,EAAE,kBAAkB,CAAA;IAC1B,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAA;IACpF,kFAAkF;IAClF,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjD;AACD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAM9F;AACD,0FAA0F;AAC1F,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAalF;AAED,kGAAkG;AAClG,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,QAAQ,EACb,OAAO,EAAE,gCAAgC,GACxC,IAAI,CAkEN"}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.lookupResponseControl = lookupResponseControl;
|
|
4
|
+
exports.lookupResponseControlHeaders = lookupResponseControlHeaders;
|
|
5
|
+
exports.guardOutputLookupResponse = guardOutputLookupResponse;
|
|
6
|
+
const auth_express_middleware_1 = require("@bsv/auth-express-middleware");
|
|
7
|
+
const sdk_1 = require("@bsv/sdk");
|
|
8
|
+
const OutputLookupHTTPPolicy_js_1 = require("./OutputLookupHTTPPolicy.js");
|
|
9
|
+
function lookupResponseControl(error) {
|
|
10
|
+
const packet = (0, OutputLookupHTTPPolicy_js_1.lookupHTTPError)(error);
|
|
11
|
+
return {
|
|
12
|
+
statusCode: (0, sdk_1.outputServiceErrorHTTPStatus)(packet.error.code),
|
|
13
|
+
body: new TextEncoder().encode((0, sdk_1.canonicalOutputJSON)(packet, { bytes: 4096 }))
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
/** Copy only response fields owned by this router, with no row/cursor-derived headers. */
|
|
17
|
+
function lookupResponseControlHeaders(res) {
|
|
18
|
+
const result = {};
|
|
19
|
+
for (const name of [
|
|
20
|
+
'access-control-allow-origin',
|
|
21
|
+
'access-control-allow-methods',
|
|
22
|
+
'access-control-allow-headers',
|
|
23
|
+
'access-control-expose-headers',
|
|
24
|
+
'vary'
|
|
25
|
+
]) {
|
|
26
|
+
const value = res.getHeader(name);
|
|
27
|
+
if (typeof value === 'string')
|
|
28
|
+
result[name] = value;
|
|
29
|
+
}
|
|
30
|
+
return result;
|
|
31
|
+
}
|
|
32
|
+
/** Signing stays outside storage; the bound owner admits exactly one native enqueue afterward. */
|
|
33
|
+
function guardOutputLookupResponse(res, options) {
|
|
34
|
+
const { disclosure } = options, caller = { ...options.caller };
|
|
35
|
+
const original = 'operation' in options.initial ? { ...options.initial } : undefined;
|
|
36
|
+
let control = 'error' in options.initial ? lookupResponseControl(options.initial.error) : undefined;
|
|
37
|
+
let binding;
|
|
38
|
+
if (!original)
|
|
39
|
+
binding = disclosure.control(new TextDecoder().decode(control.body), caller);
|
|
40
|
+
else if (original.operation === 'close')
|
|
41
|
+
binding = disclosure.control(original.body, caller);
|
|
42
|
+
else
|
|
43
|
+
binding = disclosure.bind(original.operation, original.body, caller);
|
|
44
|
+
const controlHeaders = {
|
|
45
|
+
...options.controlHeaders,
|
|
46
|
+
'content-type': 'application/json',
|
|
47
|
+
'cache-control': 'private, no-store',
|
|
48
|
+
'x-content-type-options': 'nosniff',
|
|
49
|
+
'x-bsv-overlay-capability': caller.capabilityDigest,
|
|
50
|
+
'x-bsv-overlay-profile': sdk_1.OUTPUT_LOOKUP_PROFILE
|
|
51
|
+
};
|
|
52
|
+
(0, auth_express_middleware_1.guardAuthenticatedResponse)(res, async (candidate, enqueue, signal) => {
|
|
53
|
+
var _a;
|
|
54
|
+
let attempted = false;
|
|
55
|
+
try {
|
|
56
|
+
if (candidate.identityKey !== caller.principal ||
|
|
57
|
+
candidate.headers['x-bsv-overlay-capability'] !== caller.capabilityDigest ||
|
|
58
|
+
candidate.headers['x-bsv-overlay-profile'] !== sdk_1.OUTPUT_LOOKUP_PROFILE)
|
|
59
|
+
throw new sdk_1.OutputProtocolError('unauthorized', 'Lookup response identity or selection changed');
|
|
60
|
+
const expectedStatus = (_a = control === null || control === void 0 ? void 0 : control.statusCode) !== null && _a !== void 0 ? _a : 200;
|
|
61
|
+
if (candidate.statusCode !== expectedStatus)
|
|
62
|
+
throw new sdk_1.OutputProtocolError('invalid', 'Lookup response status changed');
|
|
63
|
+
await binding.enqueue(candidate.body, candidate.identityKey, bytes => {
|
|
64
|
+
if (attempted)
|
|
65
|
+
throw new sdk_1.OutputProtocolError('unavailable', 'Lookup response was already enqueued');
|
|
66
|
+
if (signal.aborted)
|
|
67
|
+
throw new sdk_1.OutputProtocolError('cancelled', 'Lookup enqueue cancelled');
|
|
68
|
+
if (bytes.length !== candidate.body.length ||
|
|
69
|
+
!bytes.every((byte, index) => byte === candidate.body[index]))
|
|
70
|
+
throw new sdk_1.OutputProtocolError('invalid', 'Lookup native enqueue bytes changed');
|
|
71
|
+
attempted = true;
|
|
72
|
+
enqueue();
|
|
73
|
+
return undefined;
|
|
74
|
+
}, signal);
|
|
75
|
+
if (!attempted)
|
|
76
|
+
throw new Error('Lookup owner did not enqueue the response');
|
|
77
|
+
}
|
|
78
|
+
catch (error) {
|
|
79
|
+
if (attempted ||
|
|
80
|
+
signal.aborted ||
|
|
81
|
+
candidate.attempt !== 0 ||
|
|
82
|
+
!original ||
|
|
83
|
+
original.operation === 'close')
|
|
84
|
+
throw error;
|
|
85
|
+
control = lookupResponseControl(error);
|
|
86
|
+
binding = disclosure.control(new TextDecoder().decode(control.body), caller);
|
|
87
|
+
return { ...control, body: control.body.slice(), headers: controlHeaders };
|
|
88
|
+
}
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=OutputLookupResponseGuard.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupResponseGuard.js","sourceRoot":"","sources":["../../../src/OutputLookupResponseGuard.ts"],"names":[],"mappings":";;;;;AACA,0EAAyE;AACzE,kCAKiB;AACjB,2EAA6D;AA2B7D,+BAAsC,KAAc;IAClD,MAAM,MAAM,GAAG,IAAA,2CAAe,EAAC,KAAK,CAAC,CAAA;IACrC,OAAO;QACL,UAAU,EAAE,IAAA,kCAA4B,EAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAC3D,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAA,yBAAmB,EAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;KAC7E,CAAA;AACH,CAAC;AACD,0FAA0F;AAC1F,sCAA6C,GAAa;IACxD,MAAM,MAAM,GAA2B,EAAE,CAAA;IACzC,KAAK,MAAM,IAAI,IAAI;QACjB,6BAA6B;QAC7B,8BAA8B;QAC9B,8BAA8B;QAC9B,+BAA+B;QAC/B,MAAM;KACP,EAAE,CAAC;QACF,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IACrD,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,kGAAkG;AAClG,mCACE,GAAa,EACb,OAAyC;IAEzC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAC5B,MAAM,GAAG,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAA;IAChC,MAAM,QAAQ,GAAG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IACpF,IAAI,OAAO,GACT,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvF,IAAI,OAAoC,CAAA;IACxC,IAAI,CAAC,QAAQ;QAAE,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;SACvF,IAAI,QAAQ,CAAC,SAAS,KAAK,OAAO;QAAE,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;;QACvF,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzE,MAAM,cAAc,GAAG;QACrB,GAAG,OAAO,CAAC,cAAc;QACzB,cAAc,EAAE,kBAAkB;QAClC,eAAe,EAAE,mBAAmB;QACpC,wBAAwB,EAAE,SAAS;QACnC,0BAA0B,EAAE,MAAM,CAAC,gBAAgB;QACnD,uBAAuB,EAAE,2BAAqB;KAC/C,CAAA;IACD,IAAA,oDAA0B,EAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;;QACnE,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC;YACH,IACE,SAAS,CAAC,WAAW,KAAK,MAAM,CAAC,SAAS;gBAC1C,SAAS,CAAC,OAAO,CAAC,0BAA0B,CAAC,KAAK,MAAM,CAAC,gBAAgB;gBACzE,SAAS,CAAC,OAAO,CAAC,uBAAuB,CAAC,KAAK,2BAAqB;gBAEpE,MAAM,IAAI,yBAAmB,CAC3B,cAAc,EACd,+CAA+C,CAChD,CAAA;YACH,MAAM,cAAc,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,GAAG,CAAA;YACjD,IAAI,SAAS,CAAC,UAAU,KAAK,cAAc;gBACzC,MAAM,IAAI,yBAAmB,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAA;YAC5E,MAAM,OAAO,CAAC,OAAO,CACnB,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,WAAW,EACrB,KAAK,CAAC,EAAE;gBACN,IAAI,SAAS;oBACX,MAAM,IAAI,yBAAmB,CAAC,aAAa,EAAE,sCAAsC,CAAC,CAAA;gBACtF,IAAI,MAAM,CAAC,OAAO;oBAAE,MAAM,IAAI,yBAAmB,CAAC,WAAW,EAAE,0BAA0B,CAAC,CAAA;gBAC1F,IACE,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,MAAM;oBACtC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAE7D,MAAM,IAAI,yBAAmB,CAAC,SAAS,EAAE,qCAAqC,CAAC,CAAA;gBACjF,SAAS,GAAG,IAAI,CAAA;gBAChB,OAAO,EAAE,CAAA;gBACT,OAAO,SAAS,CAAA;YAClB,CAAC,EACD,MAAM,CACP,CAAA;YACD,IAAI,CAAC,SAAS;gBAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IACE,SAAS;gBACT,MAAM,CAAC,OAAO;gBACd,SAAS,CAAC,OAAO,KAAK,CAAC;gBACvB,CAAC,QAAQ;gBACT,QAAQ,CAAC,SAAS,KAAK,OAAO;gBAE9B,MAAM,KAAK,CAAA;YACb,OAAO,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAA;YACtC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;YAC5E,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAA;QAC5E,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { type OutputLookupDisclosure } from './OutputLookupResponseGuard.js';
|
|
2
|
+
import { type RequestHandler, type Router } from 'express';
|
|
3
|
+
/** Structural companion port: no ESM-only runtime dependency in this dual-format package. */
|
|
4
|
+
export interface OutputLookupCompanion {
|
|
5
|
+
open(input: unknown, caller: OutputLookupCaller, signal?: AbortSignal): Promise<OutputLookupHTTPResponse>;
|
|
6
|
+
read(input: unknown, caller: OutputLookupCaller, signal?: AbortSignal): Promise<OutputLookupHTTPResponse>;
|
|
7
|
+
close(input: unknown, caller: OutputLookupCaller, signal?: AbortSignal): Promise<OutputLookupHTTPResponse>;
|
|
8
|
+
}
|
|
9
|
+
export interface OutputLookupCaller {
|
|
10
|
+
principal: string | null;
|
|
11
|
+
capabilityDigest: string;
|
|
12
|
+
}
|
|
13
|
+
export interface OutputLookupHTTPResponse {
|
|
14
|
+
body: string;
|
|
15
|
+
headers: {
|
|
16
|
+
'x-bsv-overlay-capability': string;
|
|
17
|
+
'x-bsv-overlay-profile': string;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
export interface OutputLookupRouteOptions {
|
|
21
|
+
companion: OutputLookupCompanion;
|
|
22
|
+
/** Optional post-signing native session/access gate. Requires BRC-103 authentication. */
|
|
23
|
+
disclosure?: OutputLookupDisclosure;
|
|
24
|
+
/** One service binding per concrete base path. Separate paths may host other companions. */
|
|
25
|
+
service: string;
|
|
26
|
+
baseURL: string;
|
|
27
|
+
identity: string;
|
|
28
|
+
chain: {
|
|
29
|
+
network: string;
|
|
30
|
+
genesisHash: string;
|
|
31
|
+
};
|
|
32
|
+
authentication: 'none' | 'brc103';
|
|
33
|
+
/** The same middleware instance must handle the root handshake and these signed requests. */
|
|
34
|
+
authenticate?: RequestHandler;
|
|
35
|
+
/** Include the root handshake route only once per HTTP origin. Defaults to true. */
|
|
36
|
+
handleHandshake?: boolean;
|
|
37
|
+
manifest(): unknown;
|
|
38
|
+
now(): string;
|
|
39
|
+
allowedOrigins: readonly string[];
|
|
40
|
+
allowLocalHTTP?: boolean;
|
|
41
|
+
maximumRequests?: number;
|
|
42
|
+
maximumRequestBytes?: number;
|
|
43
|
+
maximumResponseBytes?: number;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Mount at the application root BEFORE generic parsers, compression, caches and
|
|
47
|
+
* payload logging. The exact configured paths and malformed lookup paths are
|
|
48
|
+
* handled here. TLS termination, Node header/body deadlines and authentication
|
|
49
|
+
* middleware capacity remain host responsibilities. No payment middleware runs.
|
|
50
|
+
*/
|
|
51
|
+
export declare function createOutputLookupRouter(options: OutputLookupRouteOptions): Router;
|
|
52
|
+
export type { OutputLookupDisclosure, OutputLookupResponseBinding } from './OutputLookupResponseGuard.js';
|
|
53
|
+
//# sourceMappingURL=OutputLookupRoutes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupRoutes.d.ts","sourceRoot":"","sources":["../../../src/OutputLookupRoutes.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,sBAAsB,EAC5B,MAAM,gCAAgC,CAAA;AACvC,OAAgB,EAAgB,KAAK,cAAc,EAAiB,KAAK,MAAM,EAAE,MAAM,SAAS,CAAA;AAoBhG,6FAA6F;AAC7F,MAAM,WAAW,qBAAqB;IACpC,IAAI,CACF,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACpC,IAAI,CACF,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACpC,KAAK,CACH,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,kBAAkB,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,wBAAwB,CAAC,CAAA;CACrC;AACD,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AACD,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QAAE,0BAA0B,EAAE,MAAM,CAAC;QAAC,uBAAuB,EAAE,MAAM,CAAA;KAAE,CAAA;CACjF;AACD,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,qBAAqB,CAAA;IAChC,yFAAyF;IACzF,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,4FAA4F;IAC5F,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/C,cAAc,EAAE,MAAM,GAAG,QAAQ,CAAA;IACjC,6FAA6F;IAC7F,YAAY,CAAC,EAAE,cAAc,CAAA;IAC7B,oFAAoF;IACpF,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,QAAQ,IAAI,OAAO,CAAA;IACnB,GAAG,IAAI,MAAM,CAAA;IACb,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AA8SD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,wBAAwB,GAAG,MAAM,CAGlF;AAED,YAAY,EACV,sBAAsB,EACtB,2BAA2B,EAC5B,MAAM,gCAAgC,CAAA"}
|