@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
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
import { guardOutputLookupResponse, lookupResponseControl, lookupResponseControlHeaders } from './OutputLookupResponseGuard.js';
|
|
2
|
+
import express from 'express';
|
|
3
|
+
import { canonicalOutputBase, canonicalOutputJSON, OUTPUT_LOOKUP_PROFILE, outputHex32, outputIdentity, outputU64, OutputProtocolError, parseOutputCapabilities, parseOutputJSON, verifyOutputPacket } from '@bsv/sdk';
|
|
4
|
+
import { lookupCORS, lookupOrigins, lookupPrivateHeaders, sendLookupHTTPError } from './OutputLookupHTTPPolicy.js';
|
|
5
|
+
function checkHeaders(req) {
|
|
6
|
+
let bytes = 0;
|
|
7
|
+
const names = new Set();
|
|
8
|
+
for (let index = 0; index < req.rawHeaders.length; index += 2) {
|
|
9
|
+
const name = req.rawHeaders[index].toLowerCase(), value = req.rawHeaders[index + 1];
|
|
10
|
+
bytes += Buffer.byteLength(name) + Buffer.byteLength(value);
|
|
11
|
+
if (bytes > 16384)
|
|
12
|
+
throw new OutputProtocolError('limited', 'Lookup HTTP header bound');
|
|
13
|
+
if (names.has(name))
|
|
14
|
+
throw new OutputProtocolError('invalid', 'Duplicate lookup HTTP header');
|
|
15
|
+
names.add(name);
|
|
16
|
+
}
|
|
17
|
+
const encoding = req.headers['content-encoding'];
|
|
18
|
+
if (encoding !== undefined && encoding !== 'identity')
|
|
19
|
+
throw new OutputProtocolError('unsupported', 'Lookup requires identity encoding');
|
|
20
|
+
}
|
|
21
|
+
function selection(req) {
|
|
22
|
+
const capabilityDigest = outputHex32(req.headers['x-bsv-overlay-capability']);
|
|
23
|
+
if (req.headers['x-bsv-overlay-profile'] !== OUTPUT_LOOKUP_PROFILE)
|
|
24
|
+
throw new OutputProtocolError('unsupported', 'Required lookup profile was not selected');
|
|
25
|
+
if (req.headers['cache-control'] !== 'no-store')
|
|
26
|
+
throw new OutputProtocolError('invalid', 'Lookup requires no-store requests');
|
|
27
|
+
return { principal: null, capabilityDigest };
|
|
28
|
+
}
|
|
29
|
+
class LookupHTTPHandler {
|
|
30
|
+
options;
|
|
31
|
+
baseURL;
|
|
32
|
+
identity;
|
|
33
|
+
origins;
|
|
34
|
+
maximum;
|
|
35
|
+
requestBytes;
|
|
36
|
+
responseBytes;
|
|
37
|
+
prefix;
|
|
38
|
+
paths;
|
|
39
|
+
raw;
|
|
40
|
+
active = 0;
|
|
41
|
+
constructor(input) {
|
|
42
|
+
if (input.disclosure !== undefined && input.authentication !== 'brc103')
|
|
43
|
+
throw new TypeError('Lookup native disclosure requires authenticated transport');
|
|
44
|
+
this.options = { ...input, chain: { ...input.chain } };
|
|
45
|
+
this.baseURL = canonicalOutputBase(input.baseURL, input.allowLocalHTTP);
|
|
46
|
+
this.identity = outputIdentity(input.identity);
|
|
47
|
+
this.origins = lookupOrigins(input.allowedOrigins);
|
|
48
|
+
this.maximum = input.maximumRequests ?? 64;
|
|
49
|
+
if (!Number.isSafeInteger(this.maximum) || this.maximum < 1 || this.maximum > 4096)
|
|
50
|
+
throw new TypeError('Invalid lookup HTTP request capacity');
|
|
51
|
+
this.requestBytes = input.maximumRequestBytes ?? 1048576;
|
|
52
|
+
this.responseBytes = input.maximumResponseBytes ?? 4194304;
|
|
53
|
+
for (const [value, minimum, maximum] of [
|
|
54
|
+
[this.requestBytes, 1, 1048576],
|
|
55
|
+
[this.responseBytes, 65536, 4194304]
|
|
56
|
+
])
|
|
57
|
+
if (!Number.isSafeInteger(value) || value < minimum || value > maximum)
|
|
58
|
+
throw new TypeError('Invalid lookup HTTP byte capacity');
|
|
59
|
+
this.raw = express.raw({ type: () => true, limit: this.requestBytes, inflate: false });
|
|
60
|
+
if (!['none', 'brc103'].includes(input.authentication) ||
|
|
61
|
+
(input.authentication === 'brc103' && !input.authenticate))
|
|
62
|
+
throw new TypeError('Authenticated lookup requires its actual authentication middleware');
|
|
63
|
+
this.prefix = new URL(this.baseURL).pathname.replace(/\/$/, '') + '/overlay/v1';
|
|
64
|
+
const paths = new Map([
|
|
65
|
+
[this.prefix + '/capabilities', 'capabilities'],
|
|
66
|
+
[this.prefix + '/lookup/open', 'open'],
|
|
67
|
+
[this.prefix + '/lookup/read', 'read'],
|
|
68
|
+
[this.prefix + '/lookup/close', 'close']
|
|
69
|
+
]);
|
|
70
|
+
if (input.authentication === 'brc103' && input.handleHandshake !== false)
|
|
71
|
+
paths.set('/.well-known/auth', 'handshake');
|
|
72
|
+
this.paths = paths;
|
|
73
|
+
}
|
|
74
|
+
route(path) {
|
|
75
|
+
const exact = this.paths.get(path);
|
|
76
|
+
if (exact)
|
|
77
|
+
return exact;
|
|
78
|
+
const lower = path.toLowerCase();
|
|
79
|
+
if (lower.startsWith((this.prefix + '/lookup').toLowerCase()) ||
|
|
80
|
+
lower === (this.prefix + '/capabilities').toLowerCase())
|
|
81
|
+
return 'unknown';
|
|
82
|
+
return undefined;
|
|
83
|
+
}
|
|
84
|
+
handle = (req, res, next) => {
|
|
85
|
+
const route = this.route(req.path);
|
|
86
|
+
if (!route) {
|
|
87
|
+
next();
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
lookupPrivateHeaders(res);
|
|
91
|
+
try {
|
|
92
|
+
if (!this.admit(req, res, route))
|
|
93
|
+
return;
|
|
94
|
+
this.track(res);
|
|
95
|
+
if (route === 'capabilities') {
|
|
96
|
+
res.status(200).set('content-type', 'application/json').end(this.capabilities());
|
|
97
|
+
return;
|
|
98
|
+
}
|
|
99
|
+
this.raw(req, res, error => this.parsed(req, res, route, error));
|
|
100
|
+
}
|
|
101
|
+
catch (error) {
|
|
102
|
+
sendLookupHTTPError(res, error);
|
|
103
|
+
}
|
|
104
|
+
};
|
|
105
|
+
admit(req, res, route) {
|
|
106
|
+
checkHeaders(req);
|
|
107
|
+
if (!lookupCORS(req, res, this.origins))
|
|
108
|
+
return false;
|
|
109
|
+
if (route === 'unknown')
|
|
110
|
+
throw new OutputProtocolError('not-found', 'Unknown lookup protocol endpoint');
|
|
111
|
+
if (this.active >= this.maximum)
|
|
112
|
+
throw new OutputProtocolError('limited', 'Lookup HTTP capacity is full', true);
|
|
113
|
+
if (req.method !== (route === 'capabilities' ? 'GET' : 'POST'))
|
|
114
|
+
throw new OutputProtocolError('invalid', 'Invalid lookup HTTP method');
|
|
115
|
+
if (route !== 'capabilities' &&
|
|
116
|
+
req.headers['content-type']?.split(';', 1)[0].trim().toLowerCase() !== 'application/json')
|
|
117
|
+
throw new OutputProtocolError('invalid', 'Lookup requires a JSON request');
|
|
118
|
+
if (req.body !== undefined)
|
|
119
|
+
throw new OutputProtocolError('unsupported', 'Lookup routes must precede generic body parsers');
|
|
120
|
+
return true;
|
|
121
|
+
}
|
|
122
|
+
track(res) {
|
|
123
|
+
this.active++;
|
|
124
|
+
let released = false;
|
|
125
|
+
const release = () => {
|
|
126
|
+
if (released)
|
|
127
|
+
return;
|
|
128
|
+
released = true;
|
|
129
|
+
this.active--;
|
|
130
|
+
res.removeListener('finish', release);
|
|
131
|
+
res.removeListener('close', release);
|
|
132
|
+
};
|
|
133
|
+
res.once('finish', release);
|
|
134
|
+
res.once('close', release);
|
|
135
|
+
}
|
|
136
|
+
capabilities() {
|
|
137
|
+
const manifest = parseOutputCapabilities(this.options.manifest(), this.options.allowLocalHTTP);
|
|
138
|
+
if (manifest.body.identity !== this.identity ||
|
|
139
|
+
manifest.body.baseURL !== this.baseURL ||
|
|
140
|
+
canonicalOutputJSON(manifest.body.chain) !== canonicalOutputJSON(this.options.chain) ||
|
|
141
|
+
!verifyOutputPacket('capabilities', manifest, this.identity))
|
|
142
|
+
throw new OutputProtocolError('unauthorized', 'Lookup manifest differs from configured provider');
|
|
143
|
+
if (outputU64(this.options.now()) >= outputU64(manifest.body.expiresAt))
|
|
144
|
+
throw new OutputProtocolError('expired', 'Lookup capability expired');
|
|
145
|
+
const services = manifest.body.services;
|
|
146
|
+
if (services.length !== 1 ||
|
|
147
|
+
services[0].name !== this.options.service ||
|
|
148
|
+
services[0].profiles.length !== 1 ||
|
|
149
|
+
services[0].profiles[0].id !== OUTPUT_LOOKUP_PROFILE ||
|
|
150
|
+
services[0].profiles[0].authentication !== this.options.authentication)
|
|
151
|
+
throw new OutputProtocolError('unsupported', 'Manifest advertises unbound lookup services');
|
|
152
|
+
if (services[0].profiles[0].maxRequestBytes > this.requestBytes ||
|
|
153
|
+
Math.min(4194304, services[0].profiles[0].maxResponseBytes) > this.responseBytes)
|
|
154
|
+
throw new OutputProtocolError('unsupported', 'Manifest exceeds lookup HTTP byte capacity');
|
|
155
|
+
return canonicalOutputJSON(manifest, { bytes: 262144 });
|
|
156
|
+
}
|
|
157
|
+
parsed(req, res, route, error) {
|
|
158
|
+
try {
|
|
159
|
+
if (error) {
|
|
160
|
+
const tooLarge = error instanceof Error &&
|
|
161
|
+
Object.getOwnPropertyDescriptor(error, 'type')?.value === 'entity.too.large';
|
|
162
|
+
throw new OutputProtocolError(tooLarge ? 'limited' : 'invalid', 'Invalid bounded lookup body');
|
|
163
|
+
}
|
|
164
|
+
if (route === 'handshake') {
|
|
165
|
+
req.body = parseOutputJSON(req.body, { bytes: this.requestBytes });
|
|
166
|
+
this.options.authenticate(req, res, error => sendLookupHTTPError(res, error ?? new OutputProtocolError('unsupported', 'Handshake was not handled')));
|
|
167
|
+
}
|
|
168
|
+
else {
|
|
169
|
+
this.authenticated(req, res, route);
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
catch (error) {
|
|
173
|
+
sendLookupHTTPError(res, error);
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
authenticated(req, res, operation) {
|
|
177
|
+
const execute = () => {
|
|
178
|
+
void this.execute(req, res, operation).catch(error => sendLookupHTTPError(res, error));
|
|
179
|
+
};
|
|
180
|
+
if (this.options.authentication === 'brc103')
|
|
181
|
+
this.options.authenticate(req, res, error => {
|
|
182
|
+
if (error)
|
|
183
|
+
sendLookupHTTPError(res, error);
|
|
184
|
+
else
|
|
185
|
+
execute();
|
|
186
|
+
});
|
|
187
|
+
else
|
|
188
|
+
execute();
|
|
189
|
+
}
|
|
190
|
+
authenticatePrincipal(req, who) {
|
|
191
|
+
if (this.options.authentication === 'brc103') {
|
|
192
|
+
const auth = req.auth;
|
|
193
|
+
if (auth?.identityKey === undefined || auth.identityKey === 'unknown')
|
|
194
|
+
throw new OutputProtocolError('unauthorized', 'Lookup requires an authenticated principal');
|
|
195
|
+
who.principal = outputIdentity(auth?.identityKey);
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
async execute(req, res, operation) {
|
|
199
|
+
const who = selection(req);
|
|
200
|
+
res.set({
|
|
201
|
+
'x-bsv-overlay-capability': who.capabilityDigest,
|
|
202
|
+
'x-bsv-overlay-profile': OUTPUT_LOOKUP_PROFILE
|
|
203
|
+
});
|
|
204
|
+
this.authenticatePrincipal(req, who);
|
|
205
|
+
const controller = new AbortController(), cancel = () => controller.abort();
|
|
206
|
+
req.once('aborted', cancel);
|
|
207
|
+
res.once('close', cancel);
|
|
208
|
+
let guarded = false;
|
|
209
|
+
try {
|
|
210
|
+
if (req.aborted || res.destroyed)
|
|
211
|
+
controller.abort();
|
|
212
|
+
const input = parseOutputJSON(req.body, { bytes: this.requestBytes });
|
|
213
|
+
const response = await this.options.companion[operation](input, who, controller.signal);
|
|
214
|
+
if (controller.signal.aborted || res.destroyed || res.writableEnded)
|
|
215
|
+
return;
|
|
216
|
+
if (typeof response.body !== 'string' ||
|
|
217
|
+
Buffer.byteLength(response.body) > this.responseBytes ||
|
|
218
|
+
response.headers['x-bsv-overlay-capability'] !== who.capabilityDigest ||
|
|
219
|
+
response.headers['x-bsv-overlay-profile'] !== OUTPUT_LOOKUP_PROFILE)
|
|
220
|
+
throw new OutputProtocolError('unavailable', 'Lookup companion violated its response contract');
|
|
221
|
+
if (this.options.disclosure) {
|
|
222
|
+
guardOutputLookupResponse(res, {
|
|
223
|
+
disclosure: this.options.disclosure,
|
|
224
|
+
caller: who,
|
|
225
|
+
initial: { operation, body: response.body },
|
|
226
|
+
controlHeaders: lookupResponseControlHeaders(res)
|
|
227
|
+
});
|
|
228
|
+
guarded = true;
|
|
229
|
+
}
|
|
230
|
+
res.status(200).set('content-type', 'application/json').end(response.body);
|
|
231
|
+
}
|
|
232
|
+
catch (error) {
|
|
233
|
+
if (!this.options.disclosure)
|
|
234
|
+
throw error;
|
|
235
|
+
if (res.destroyed || res.writableEnded || req.aborted)
|
|
236
|
+
return;
|
|
237
|
+
if (guarded) {
|
|
238
|
+
res.destroy();
|
|
239
|
+
return;
|
|
240
|
+
}
|
|
241
|
+
try {
|
|
242
|
+
guardOutputLookupResponse(res, {
|
|
243
|
+
disclosure: this.options.disclosure,
|
|
244
|
+
caller: who,
|
|
245
|
+
initial: { error },
|
|
246
|
+
controlHeaders: lookupResponseControlHeaders(res)
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
catch {
|
|
250
|
+
res.destroy();
|
|
251
|
+
return;
|
|
252
|
+
}
|
|
253
|
+
const control = lookupResponseControl(error);
|
|
254
|
+
res
|
|
255
|
+
.status(control.statusCode)
|
|
256
|
+
.set('content-type', 'application/json')
|
|
257
|
+
.end(Buffer.from(control.body));
|
|
258
|
+
}
|
|
259
|
+
finally {
|
|
260
|
+
req.removeListener('aborted', cancel);
|
|
261
|
+
res.removeListener('close', cancel);
|
|
262
|
+
}
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Mount at the application root BEFORE generic parsers, compression, caches and
|
|
267
|
+
* payload logging. The exact configured paths and malformed lookup paths are
|
|
268
|
+
* handled here. TLS termination, Node header/body deadlines and authentication
|
|
269
|
+
* middleware capacity remain host responsibilities. No payment middleware runs.
|
|
270
|
+
*/
|
|
271
|
+
export function createOutputLookupRouter(options) {
|
|
272
|
+
const handler = new LookupHTTPHandler(options);
|
|
273
|
+
return express.Router({ caseSensitive: true, strict: true }).use(handler.handle);
|
|
274
|
+
}
|
|
275
|
+
//# sourceMappingURL=OutputLookupRoutes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OutputLookupRoutes.js","sourceRoot":"","sources":["../../../src/OutputLookupRoutes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,4BAA4B,EAE7B,MAAM,gCAAgC,CAAA;AACvC,OAAO,OAA0E,MAAM,SAAS,CAAA;AAChG,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,WAAW,EACX,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,uBAAuB,EACvB,eAAe,EACf,kBAAkB,EACnB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,UAAU,EACV,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,6BAA6B,CAAA;AAmDpC,SAAS,YAAY,CAAC,GAAY;IAChC,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAA;IAC/B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAC9C,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;QACnC,KAAK,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAC3D,IAAI,KAAK,GAAG,KAAK;YAAE,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAA;QACvF,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,8BAA8B,CAAC,CAAA;QAC7F,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAChD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,UAAU;QACnD,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,mCAAmC,CAAC,CAAA;AACrF,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC7B,MAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAA;IAC7E,IAAI,GAAG,CAAC,OAAO,CAAC,uBAAuB,CAAC,KAAK,qBAAqB;QAChE,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,0CAA0C,CAAC,CAAA;IAC1F,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,UAAU;QAC7C,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,mCAAmC,CAAC,CAAA;IAC/E,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAA;AAC9C,CAAC;AAKD,MAAM,iBAAiB;IACJ,OAAO,CAA0B;IACjC,OAAO,CAAQ;IACf,QAAQ,CAAQ;IAChB,OAAO,CAAqB;IAC5B,OAAO,CAAQ;IACf,YAAY,CAAQ;IACpB,aAAa,CAAQ;IACrB,MAAM,CAAQ;IACd,KAAK,CAAkC;IACvC,GAAG,CAAgB;IAC5B,MAAM,GAAG,CAAC,CAAA;IAElB,YAAY,KAA+B;QACzC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,cAAc,KAAK,QAAQ;YACrE,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAA;QAClF,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,EAAE,CAAA;QACtD,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;QACvE,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC9C,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAClD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,eAAe,IAAI,EAAE,CAAA;QAC1C,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI;YAChF,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAA;QAC7D,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,mBAAmB,IAAI,OAAO,CAAA;QACxD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,oBAAoB,IAAI,OAAO,CAAA;QAC1D,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI;YACtC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,OAAO,CAAC;YAC/B,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,OAAO,CAAC;SACrC;YACC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,OAAO,IAAI,KAAK,GAAG,OAAO;gBACpE,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;QAC5D,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;QACtF,IACE,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;YAClD,CAAC,KAAK,CAAC,cAAc,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAE1D,MAAM,IAAI,SAAS,CAAC,oEAAoE,CAAC,CAAA;QAC3F,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,aAAa,CAAA;QAC/E,MAAM,KAAK,GAAG,IAAI,GAAG,CAAsB;YACzC,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,cAAc,CAAC;YAC/C,CAAC,IAAI,CAAC,MAAM,GAAG,cAAc,EAAE,MAAM,CAAC;YACtC,CAAC,IAAI,CAAC,MAAM,GAAG,cAAc,EAAE,MAAM,CAAC;YACtC,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,OAAO,CAAC;SACzC,CAAC,CAAA;QACF,IAAI,KAAK,CAAC,cAAc,KAAK,QAAQ,IAAI,KAAK,CAAC,eAAe,KAAK,KAAK;YACtE,KAAK,CAAC,GAAG,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAA;QAC7C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAEO,KAAK,CAAC,IAAY;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,KAAK;YAAE,OAAO,KAAK,CAAA;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAChC,IACE,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YACzD,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,CAAC,WAAW,EAAE;YAEvD,OAAO,SAAS,CAAA;QAClB,OAAO,SAAS,CAAA;IAClB,CAAC;IAEQ,MAAM,GAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,EAAE,CAAA;YACN,OAAM;QACR,CAAC;QACD,oBAAoB,CAAC,GAAG,CAAC,CAAA;QACzB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC;gBAAE,OAAM;YACxC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACf,IAAI,KAAK,KAAK,cAAc,EAAE,CAAC;gBAC7B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;gBAChF,OAAM;YACR,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAA;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;IACH,CAAC,CAAA;IAEO,KAAK,CACX,GAAY,EACZ,GAAa,EACb,KAAkB;QAElB,YAAY,CAAC,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC;YAAE,OAAO,KAAK,CAAA;QACrD,IAAI,KAAK,KAAK,SAAS;YACrB,MAAM,IAAI,mBAAmB,CAAC,WAAW,EAAE,kCAAkC,CAAC,CAAA;QAChF,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO;YAC7B,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,8BAA8B,EAAE,IAAI,CAAC,CAAA;QAChF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,KAAK,KAAK,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;YAC5D,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAA;QACxE,IACE,KAAK,KAAK,cAAc;YACxB,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,kBAAkB;YAEzF,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAA;QAC5E,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;YACxB,MAAM,IAAI,mBAAmB,CAC3B,aAAa,EACb,iDAAiD,CAClD,CAAA;QACH,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,KAAK,CAAC,GAAa;QACzB,IAAI,CAAC,MAAM,EAAE,CAAA;QACb,IAAI,QAAQ,GAAG,KAAK,CAAA;QACpB,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,IAAI,QAAQ;gBAAE,OAAM;YACpB,QAAQ,GAAG,IAAI,CAAA;YACf,IAAI,CAAC,MAAM,EAAE,CAAA;YACb,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YACrC,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACtC,CAAC,CAAA;QACD,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC5B,CAAC;IAEO,YAAY;QAClB,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAC9F,IACE,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YACxC,QAAQ,CAAC,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;YACtC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACpF,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;YAE5D,MAAM,IAAI,mBAAmB,CAC3B,cAAc,EACd,kDAAkD,CACnD,CAAA;QACH,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YACrE,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAA;QACvE,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAA;QACvC,IACE,QAAQ,CAAC,MAAM,KAAK,CAAC;YACrB,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO;YACzC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YACjC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,qBAAqB;YACpD,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,IAAI,CAAC,OAAO,CAAC,cAAc;YAEtE,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,6CAA6C,CAAC,CAAA;QAC7F,IACE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAAe,GAAG,IAAI,CAAC,YAAY;YAC3D,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,aAAa;YAEhF,MAAM,IAAI,mBAAmB,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAA;QAC5F,OAAO,mBAAmB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IACzD,CAAC;IAEO,MAAM,CACZ,GAAY,EACZ,GAAa,EACb,KAAoC,EACpC,KAAe;QAEf,IAAI,CAAC;YACH,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,QAAQ,GACZ,KAAK,YAAY,KAAK;oBACtB,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,KAAK,KAAK,kBAAkB,CAAA;gBAC9E,MAAM,IAAI,mBAAmB,CAC3B,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAChC,6BAA6B,CAC9B,CAAA;YACH,CAAC;YACD,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBAC1B,GAAG,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;gBAClE,IAAI,CAAC,OAAO,CAAC,YAAa,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,CAC3C,mBAAmB,CACjB,GAAG,EACH,KAAK,IAAI,IAAI,mBAAmB,CAAC,aAAa,EAAE,2BAA2B,CAAC,CAC7E,CACF,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;YACrC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,GAAY,EAAE,GAAa,EAAE,SAA0B;QAC3E,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;QACxF,CAAC,CAAA;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,QAAQ;YAC1C,IAAI,CAAC,OAAO,CAAC,YAAa,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE;gBAC3C,IAAI,KAAK;oBAAE,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;;oBACrC,OAAO,EAAE,CAAA;YAChB,CAAC,CAAC,CAAA;;YACC,OAAO,EAAE,CAAA;IAChB,CAAC;IAEO,qBAAqB,CAAC,GAAY,EAAE,GAAuB;QACjE,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,QAAQ,EAAE,CAAC;YAC7C,MAAM,IAAI,GAAI,GAAqD,CAAC,IAAI,CAAA;YACxE,IAAI,IAAI,EAAE,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;gBACnE,MAAM,IAAI,mBAAmB,CAAC,cAAc,EAAE,4CAA4C,CAAC,CAAA;YAC7F,GAAG,CAAC,SAAS,GAAG,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QACnD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,SAA0B;QAC3E,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;QAC1B,GAAG,CAAC,GAAG,CAAC;YACN,0BAA0B,EAAE,GAAG,CAAC,gBAAgB;YAChD,uBAAuB,EAAE,qBAAqB;SAC/C,CAAC,CAAA;QACF,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QACpC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,EACtC,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;QACnC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QACzB,IAAI,OAAO,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC;YACH,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,SAAS;gBAAE,UAAU,CAAC,KAAK,EAAE,CAAA;YACpD,MAAM,KAAK,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;YACrE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;YACvF,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,aAAa;gBAAE,OAAM;YAC3E,IACE,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;gBACjC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa;gBACrD,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,KAAK,GAAG,CAAC,gBAAgB;gBACrE,QAAQ,CAAC,OAAO,CAAC,uBAAuB,CAAC,KAAK,qBAAqB;gBAEnE,MAAM,IAAI,mBAAmB,CAC3B,aAAa,EACb,iDAAiD,CAClD,CAAA;YACH,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;gBAC5B,yBAAyB,CAAC,GAAG,EAAE;oBAC7B,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;oBACnC,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE;oBAC3C,cAAc,EAAE,4BAA4B,CAAC,GAAG,CAAC;iBAClD,CAAC,CAAA;gBACF,OAAO,GAAG,IAAI,CAAA;YAChB,CAAC;YACD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU;gBAAE,MAAM,KAAK,CAAA;YACzC,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,OAAO;gBAAE,OAAM;YAC7D,IAAI,OAAO,EAAE,CAAC;gBACZ,GAAG,CAAC,OAAO,EAAE,CAAA;gBACb,OAAM;YACR,CAAC;YACD,IAAI,CAAC;gBACH,yBAAyB,CAAC,GAAG,EAAE;oBAC7B,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;oBACnC,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,EAAE,KAAK,EAAE;oBAClB,cAAc,EAAE,4BAA4B,CAAC,GAAG,CAAC;iBAClD,CAAC,CAAA;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,GAAG,CAAC,OAAO,EAAE,CAAA;gBACb,OAAM;YACR,CAAC;YACD,MAAM,OAAO,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAA;YAC5C,GAAG;iBACA,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;iBAC1B,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;iBACvC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QACnC,CAAC;gBAAS,CAAC;YACT,GAAG,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;YACrC,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAiC;IACxE,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAC9C,OAAO,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAClF,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { createServer } from 'node:http';
|
|
1
2
|
import { Reader, Writer } from '@bsv/sdk/primitives/utils';
|
|
2
3
|
import express from 'express';
|
|
3
4
|
import bodyParser from 'body-parser';
|
|
@@ -23,7 +24,7 @@ import { ArcadeProvider, isTerminalArcStatus } from './ArcadeProvider.js';
|
|
|
23
24
|
import { ProviderChainBroadcaster } from './ProviderChainBroadcaster.js';
|
|
24
25
|
import { ChaintracksProvider } from './ChaintracksProvider.js';
|
|
25
26
|
import { assertBoundedString, assertHash, assertNonnegativeSafeInteger, fetchWithDeadline, isRecord, readBoundedJson, secureServiceFetch } from './OutboundSecurity.js';
|
|
26
|
-
import { bodyParserErrorHandler, concurrencyLimit, configureHttpServer, corsPolicy, initialDoubleSlashCompatibility, profileValue, readBodyLimitBytes, readResourceLimit, readResourceProfile, responseSizeLimit, securityHeaders } from './security/edgePolicy.js';
|
|
27
|
+
import { bodyParserErrorHandler, concurrencyLimit, configureHttpServer, corsPolicy, readCorsOriginSetting, initialDoubleSlashCompatibility, profileValue, readBodyLimitBytes, readResourceLimit, readResourceProfile, responseSizeLimit, securityHeaders } from './security/edgePolicy.js';
|
|
27
28
|
/**
|
|
28
29
|
* In-memory migration source for Knex migrations.
|
|
29
30
|
* Allows running migrations defined in code rather than files.
|
|
@@ -302,6 +303,11 @@ export default class OverlayExpress {
|
|
|
302
303
|
serverWallet;
|
|
303
304
|
// Optional shared store for BSV mutual-auth sessions.
|
|
304
305
|
authSessionManager;
|
|
306
|
+
outputLookup;
|
|
307
|
+
rootEviction;
|
|
308
|
+
privateOverlayOptions = {};
|
|
309
|
+
proposalIdentity;
|
|
310
|
+
proposalRoutes;
|
|
305
311
|
// Server start time for uptime tracking
|
|
306
312
|
startTime;
|
|
307
313
|
// Health endpoint configuration
|
|
@@ -333,6 +339,10 @@ export default class OverlayExpress {
|
|
|
333
339
|
contentSecurityPolicy: "default-src 'none'; script-src 'none'; style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; img-src 'self' data: https:; connect-src 'self' https:; font-src 'self' https://cdn.jsdelivr.net; base-uri 'none'; form-action 'none'; frame-ancestors 'none'"
|
|
334
340
|
}
|
|
335
341
|
};
|
|
342
|
+
// Application routers mounted by start(), in registration order
|
|
343
|
+
registeredRouters = [];
|
|
344
|
+
// Set once start() begins wiring routes; later registrations could never be reached
|
|
345
|
+
startInvoked = false;
|
|
336
346
|
/**
|
|
337
347
|
* Constructs an instance of OverlayExpress.
|
|
338
348
|
* @param name - The name of the service
|
|
@@ -591,6 +601,26 @@ export default class OverlayExpress {
|
|
|
591
601
|
});
|
|
592
602
|
this.logger.log(chalk.blue(`Registered health check ${definition.name}`));
|
|
593
603
|
}
|
|
604
|
+
/**
|
|
605
|
+
* Registers an application router. Its factory runs during `start()`, after the BRC-103
|
|
606
|
+
* authentication middleware is mounted and before the admin routes and the 404 handler, so
|
|
607
|
+
* the router inherits CORS, body parsing, response limits, and `req.auth`.
|
|
608
|
+
*
|
|
609
|
+
* @param path - Mount path, beginning with "/"
|
|
610
|
+
* @param factory - Receives the engine and server wallet and returns the router
|
|
611
|
+
*/
|
|
612
|
+
registerRouter(path, factory) {
|
|
613
|
+
if (this.startInvoked)
|
|
614
|
+
throw new Error('registerRouter must be called before start()');
|
|
615
|
+
if (typeof path !== 'string' || !path.startsWith('/')) {
|
|
616
|
+
throw new TypeError('Router path must begin with "/"');
|
|
617
|
+
}
|
|
618
|
+
if (typeof factory !== 'function')
|
|
619
|
+
throw new TypeError('Router factory must be a function');
|
|
620
|
+
this.registeredRouters.push({ path, factory });
|
|
621
|
+
this.logger.log(chalk.blue(`Registered router at ${path}`));
|
|
622
|
+
return this;
|
|
623
|
+
}
|
|
594
624
|
/**
|
|
595
625
|
* Configures the admin identity key for wallet-based admin detection.
|
|
596
626
|
* When set, the frontend can compare the user's wallet identity key against this
|
|
@@ -614,6 +644,110 @@ export default class OverlayExpress {
|
|
|
614
644
|
this.authSessionManager = sessionManager;
|
|
615
645
|
this.logger.log(chalk.blue('BSV authentication session manager has been configured.'));
|
|
616
646
|
}
|
|
647
|
+
/**
|
|
648
|
+
* Opt in to a durable BRC-193 companion at its signed concrete base path.
|
|
649
|
+
* This never upgrades an existing finite LookupService or changes /lookup.
|
|
650
|
+
* Configure before start; the host retains ownership of provider storage.
|
|
651
|
+
*/
|
|
652
|
+
configureOutputLookup(options) {
|
|
653
|
+
if (this.isListening)
|
|
654
|
+
throw new Error('Configure the live lookup companion before start');
|
|
655
|
+
this.outputLookup = {
|
|
656
|
+
...options,
|
|
657
|
+
chain: { ...options.chain },
|
|
658
|
+
allowedOrigins: [...options.allowedOrigins]
|
|
659
|
+
};
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* Explicit root coordination routes sharing this host's authentication wallet.
|
|
663
|
+
* Configure before start. The caller retains database and worker ownership;
|
|
664
|
+
* this does not publish capabilities or retrofit existing serving paths.
|
|
665
|
+
*/
|
|
666
|
+
configureRootEviction(options) {
|
|
667
|
+
if (this.isListening)
|
|
668
|
+
throw new Error('Configure root coordination before start');
|
|
669
|
+
assertSingleLineString(options.identity, 'Root coordination identity', 66, false);
|
|
670
|
+
if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
|
|
671
|
+
throw new TypeError('Root origins must be an array');
|
|
672
|
+
this.rootEviction = {
|
|
673
|
+
...options,
|
|
674
|
+
...(options.allowedOrigins === undefined
|
|
675
|
+
? {}
|
|
676
|
+
: { allowedOrigins: [...options.allowedOrigins] })
|
|
677
|
+
};
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* Opt-in non-final proposal routes; storage, policy and admission remain caller-owned.
|
|
681
|
+
* The closure retains the journal's record type without adding SDK types to legacy
|
|
682
|
+
* host declarations. No proposal enters ordinary admission except explicit finalize.
|
|
683
|
+
*/
|
|
684
|
+
configureProposals(options) {
|
|
685
|
+
if (this.isListening)
|
|
686
|
+
throw new Error('Configure proposals before start');
|
|
687
|
+
assertSingleLineString(options.identity, 'Proposal identity', 66, false);
|
|
688
|
+
if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
|
|
689
|
+
throw new TypeError('Proposal origins must be an array');
|
|
690
|
+
const owned = {
|
|
691
|
+
...options,
|
|
692
|
+
...(options.allowedOrigins === undefined
|
|
693
|
+
? {}
|
|
694
|
+
: { allowedOrigins: [...options.allowedOrigins] })
|
|
695
|
+
};
|
|
696
|
+
this.proposalIdentity = options.identity;
|
|
697
|
+
this.proposalRoutes = async (authenticate, handleHandshake, limits) => {
|
|
698
|
+
const { createProposalRouter } = await import('./ProposalRoutes.js');
|
|
699
|
+
const origins = owned.allowedOrigins ?? limits.origins;
|
|
700
|
+
return createProposalRouter({
|
|
701
|
+
...owned,
|
|
702
|
+
authenticate,
|
|
703
|
+
handleHandshake,
|
|
704
|
+
allowedOrigins: origins === '*' ? undefined : origins,
|
|
705
|
+
maximumRequestBytes: Math.min(owned.maximumRequestBytes ?? 1048576, limits.request),
|
|
706
|
+
maximumResponseBytes: Math.min(owned.maximumResponseBytes ?? 4194304, limits.response)
|
|
707
|
+
});
|
|
708
|
+
};
|
|
709
|
+
}
|
|
710
|
+
/** Optional private acquisition; the application owns durable storage and workers. */
|
|
711
|
+
configurePrivateAcquisition(options) {
|
|
712
|
+
if (this.isListening)
|
|
713
|
+
throw new Error('Configure private acquisition before start');
|
|
714
|
+
if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
|
|
715
|
+
throw new TypeError('Private overlay origins must be an array');
|
|
716
|
+
this.privateOverlayOptions.acquisition = {
|
|
717
|
+
...options,
|
|
718
|
+
...(options.allowedOrigins === undefined
|
|
719
|
+
? {}
|
|
720
|
+
: { allowedOrigins: [...options.allowedOrigins] })
|
|
721
|
+
};
|
|
722
|
+
}
|
|
723
|
+
/** Optional private publication using the same authentication and native response gate. */
|
|
724
|
+
configurePrivatePublication(options) {
|
|
725
|
+
if (this.isListening)
|
|
726
|
+
throw new Error('Configure private publication before start');
|
|
727
|
+
if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
|
|
728
|
+
throw new TypeError('Private overlay origins must be an array');
|
|
729
|
+
this.privateOverlayOptions.publication = {
|
|
730
|
+
...options,
|
|
731
|
+
...(options.allowedOrigins === undefined
|
|
732
|
+
? {}
|
|
733
|
+
: { allowedOrigins: [...options.allowedOrigins] })
|
|
734
|
+
};
|
|
735
|
+
}
|
|
736
|
+
/** Optional selected-host covenant purchases. The application owns durable
|
|
737
|
+
* preparation, exact transaction validation, release and physical disclosure.
|
|
738
|
+
*/
|
|
739
|
+
configurePrivatePurchase(options) {
|
|
740
|
+
if (this.isListening)
|
|
741
|
+
throw new Error('Configure private purchase before start');
|
|
742
|
+
if (options.allowedOrigins !== undefined && !Array.isArray(options.allowedOrigins))
|
|
743
|
+
throw new TypeError('Private overlay origins must be an array');
|
|
744
|
+
this.privateOverlayOptions.purchase = {
|
|
745
|
+
...options,
|
|
746
|
+
...(options.allowedOrigins === undefined
|
|
747
|
+
? {}
|
|
748
|
+
: { allowedOrigins: [...options.allowedOrigins] })
|
|
749
|
+
};
|
|
750
|
+
}
|
|
617
751
|
/**
|
|
618
752
|
* Configures the logger to be used by the server.
|
|
619
753
|
* @param logger - A logger object (e.g., console)
|
|
@@ -1700,6 +1834,41 @@ export default class OverlayExpress {
|
|
|
1700
1834
|
async start() {
|
|
1701
1835
|
const engine = this.ensureEngine();
|
|
1702
1836
|
const knex = this.ensureKnex();
|
|
1837
|
+
const rootEviction = this.rootEviction;
|
|
1838
|
+
const proposalRoutes = this.proposalRoutes;
|
|
1839
|
+
let privateOverlay;
|
|
1840
|
+
if (this.privateOverlayOptions.acquisition ||
|
|
1841
|
+
this.privateOverlayOptions.publication ||
|
|
1842
|
+
this.privateOverlayOptions.purchase) {
|
|
1843
|
+
const { PrivateOverlayHost } = await import('./PrivateOverlayHost.js');
|
|
1844
|
+
privateOverlay = new PrivateOverlayHost(this.privateOverlayOptions);
|
|
1845
|
+
}
|
|
1846
|
+
const authenticatedLookup = this.outputLookup?.authentication === 'brc103';
|
|
1847
|
+
let companionAuth;
|
|
1848
|
+
if (authenticatedLookup || rootEviction || proposalRoutes || privateOverlay) {
|
|
1849
|
+
if (!this.serverWallet) {
|
|
1850
|
+
if (authenticatedLookup)
|
|
1851
|
+
throw new Error('Authenticated live lookup requires a server wallet');
|
|
1852
|
+
if (rootEviction)
|
|
1853
|
+
throw new Error('Root coordination requires a server wallet');
|
|
1854
|
+
if (privateOverlay)
|
|
1855
|
+
throw new Error('Private overlays require a server wallet');
|
|
1856
|
+
throw new Error('Proposals require a server wallet');
|
|
1857
|
+
}
|
|
1858
|
+
const { publicKey } = await this.serverWallet.getPublicKey({ identityKey: true });
|
|
1859
|
+
if (authenticatedLookup && publicKey !== this.outputLookup.identity)
|
|
1860
|
+
throw new Error('Live lookup identity must match the server authentication wallet');
|
|
1861
|
+
if (rootEviction && publicKey !== rootEviction.identity)
|
|
1862
|
+
throw new Error('Root coordination identity must match the server authentication wallet');
|
|
1863
|
+
if (proposalRoutes && publicKey !== this.proposalIdentity)
|
|
1864
|
+
throw new Error('Proposal identity must match the server authentication wallet');
|
|
1865
|
+
privateOverlay?.requireIdentity(publicKey);
|
|
1866
|
+
companionAuth = createAuthMiddleware({
|
|
1867
|
+
wallet: this.serverWallet,
|
|
1868
|
+
sessionManager: this.authSessionManager,
|
|
1869
|
+
allowUnauthenticated: true
|
|
1870
|
+
});
|
|
1871
|
+
}
|
|
1703
1872
|
const hasConfiguredArcProvider = (typeof this.arcApiKey === 'string' && this.arcApiKey.length > 0) ||
|
|
1704
1873
|
(typeof this.arcadeUrl === 'string' && this.arcadeUrl.length > 0);
|
|
1705
1874
|
if (hasConfiguredArcProvider &&
|
|
@@ -1707,6 +1876,7 @@ export default class OverlayExpress {
|
|
|
1707
1876
|
throw new Error('ARC/Arcade is configured without an ARC callback token; configureArcCallbackToken is required');
|
|
1708
1877
|
}
|
|
1709
1878
|
this.startTime = new Date();
|
|
1879
|
+
this.startInvoked = true;
|
|
1710
1880
|
const edgePolicy = this.edgePolicyConfig;
|
|
1711
1881
|
const resourceProfile = readResourceProfile(edgePolicy.environmentPrefix);
|
|
1712
1882
|
const maxResponseBytes = readResourceLimit(edgePolicy.environmentPrefix, 'MAX_RESPONSE_BYTES', profileValue(resourceProfile, {
|
|
@@ -1785,14 +1955,60 @@ export default class OverlayExpress {
|
|
|
1785
1955
|
...edgePolicy.securityHeaders,
|
|
1786
1956
|
environmentPrefix: edgePolicy.environmentPrefix
|
|
1787
1957
|
}));
|
|
1958
|
+
const requestCapacity = concurrencyLimit(edgePolicy.environmentPrefix, edgePolicy.maxConcurrentRequests === 200
|
|
1959
|
+
? profileValue(resourceProfile, { small: 8, standard: 24, highThroughput: 96 })
|
|
1960
|
+
: edgePolicy.maxConcurrentRequests);
|
|
1961
|
+
if (this.outputLookup || rootEviction || proposalRoutes || privateOverlay) {
|
|
1962
|
+
// All companions share host capacity, including long polls. Raw signed
|
|
1963
|
+
// requests stay before legacy parsers, transformations and payload logging.
|
|
1964
|
+
this.app.use(requestCapacity);
|
|
1965
|
+
const jsonBytes = readBodyLimitBytes(`${edgePolicy.environmentPrefix}_JSON`, edgePolicy.jsonBodyLimitBytes);
|
|
1966
|
+
if (this.outputLookup) {
|
|
1967
|
+
const { createOutputLookupRouter } = await import('./OutputLookupRoutes.js');
|
|
1968
|
+
this.app.use(createOutputLookupRouter({
|
|
1969
|
+
...this.outputLookup,
|
|
1970
|
+
authenticate: companionAuth,
|
|
1971
|
+
maximumRequestBytes: Math.min(this.outputLookup.maximumRequestBytes ?? 1048576, jsonBytes),
|
|
1972
|
+
maximumResponseBytes: Math.min(this.outputLookup.maximumResponseBytes ?? 4194304, maxResponseBytes === -1 ? 4194304 : maxResponseBytes)
|
|
1973
|
+
}));
|
|
1974
|
+
}
|
|
1975
|
+
if (rootEviction) {
|
|
1976
|
+
const { createRootEvictionRouter } = await import('./RootEvictionRoutes.js');
|
|
1977
|
+
const originSetting = rootEviction.allowedOrigins ??
|
|
1978
|
+
edgePolicy.allowedOrigins ??
|
|
1979
|
+
readCorsOriginSetting(edgePolicy.environmentPrefix);
|
|
1980
|
+
this.app.use(createRootEvictionRouter({
|
|
1981
|
+
...rootEviction,
|
|
1982
|
+
authenticate: companionAuth,
|
|
1983
|
+
handleHandshake: !authenticatedLookup,
|
|
1984
|
+
allowedOrigins: originSetting === '*' ? undefined : originSetting,
|
|
1985
|
+
maximumRequestBytes: Math.min(rootEviction.maximumRequestBytes ?? 1048576, jsonBytes),
|
|
1986
|
+
maximumResponseBytes: Math.min(rootEviction.maximumResponseBytes ?? 1048576, maxResponseBytes === -1 ? 1048576 : maxResponseBytes)
|
|
1987
|
+
}));
|
|
1988
|
+
}
|
|
1989
|
+
if (proposalRoutes) {
|
|
1990
|
+
this.app.use(await proposalRoutes(companionAuth, !authenticatedLookup && !rootEviction, {
|
|
1991
|
+
request: jsonBytes,
|
|
1992
|
+
response: maxResponseBytes === -1 ? 4194304 : maxResponseBytes,
|
|
1993
|
+
origins: edgePolicy.allowedOrigins ?? readCorsOriginSetting(edgePolicy.environmentPrefix)
|
|
1994
|
+
}));
|
|
1995
|
+
}
|
|
1996
|
+
if (privateOverlay) {
|
|
1997
|
+
for (const router of privateOverlay.routes(companionAuth, !authenticatedLookup && !rootEviction && !proposalRoutes, {
|
|
1998
|
+
request: jsonBytes,
|
|
1999
|
+
response: maxResponseBytes === -1 ? 4194304 : maxResponseBytes,
|
|
2000
|
+
origins: edgePolicy.allowedOrigins ?? readCorsOriginSetting(edgePolicy.environmentPrefix)
|
|
2001
|
+
}))
|
|
2002
|
+
this.app.use(router);
|
|
2003
|
+
}
|
|
2004
|
+
}
|
|
1788
2005
|
this.app.use(corsPolicy({
|
|
1789
2006
|
environmentPrefix: edgePolicy.environmentPrefix,
|
|
1790
2007
|
allowedOrigins: edgePolicy.allowedOrigins,
|
|
1791
2008
|
methods: ['GET', 'POST', 'OPTIONS']
|
|
1792
2009
|
}));
|
|
1793
|
-
this.
|
|
1794
|
-
|
|
1795
|
-
: edgePolicy.maxConcurrentRequests));
|
|
2010
|
+
if (!this.outputLookup && !rootEviction && !proposalRoutes && !privateOverlay)
|
|
2011
|
+
this.app.use(requestCapacity);
|
|
1796
2012
|
this.app.use(bodyParser.json({
|
|
1797
2013
|
limit: readBodyLimitBytes(`${edgePolicy.environmentPrefix}_JSON`, edgePolicy.jsonBodyLimitBytes),
|
|
1798
2014
|
type: 'application/json'
|
|
@@ -2294,14 +2510,22 @@ export default class OverlayExpress {
|
|
|
2294
2510
|
* are present, allowing Bearer token fallback.
|
|
2295
2511
|
*/
|
|
2296
2512
|
if (this.serverWallet !== undefined) {
|
|
2297
|
-
const bsvAuth =
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2513
|
+
const bsvAuth = companionAuth ??
|
|
2514
|
+
createAuthMiddleware({
|
|
2515
|
+
wallet: this.serverWallet,
|
|
2516
|
+
sessionManager: this.authSessionManager,
|
|
2517
|
+
allowUnauthenticated: true
|
|
2518
|
+
});
|
|
2302
2519
|
this.app.use(bsvAuth);
|
|
2303
2520
|
this.logger.log(chalk.blue('BSV mutual authentication middleware enabled.'));
|
|
2304
2521
|
}
|
|
2522
|
+
// Routers mount strictly in registration order: each factory starts after the previous one
|
|
2523
|
+
// was mounted. reduce invokes every callback up front, so nothing may run before the await.
|
|
2524
|
+
await this.registeredRouters.reduce(async (previous, { path, factory }) => {
|
|
2525
|
+
await previous;
|
|
2526
|
+
this.app.use(path, await factory({ engine, wallet: this.serverWallet }));
|
|
2527
|
+
this.logger.log(chalk.blue(`Mounted registered router at ${path}`));
|
|
2528
|
+
}, Promise.resolve());
|
|
2305
2529
|
/**
|
|
2306
2530
|
* Middleware for checking admin authentication.
|
|
2307
2531
|
* Supports two authentication methods:
|
|
@@ -2851,10 +3075,14 @@ export default class OverlayExpress {
|
|
|
2851
3075
|
});
|
|
2852
3076
|
await this.runStartupSync();
|
|
2853
3077
|
// Start listening on the configured port
|
|
2854
|
-
|
|
3078
|
+
const listening = () => {
|
|
2855
3079
|
this.isListening = true;
|
|
2856
3080
|
this.logger.log(chalk.green.bold(`${this.name} is ready and listening on local port ${this.port}`));
|
|
2857
|
-
}
|
|
3081
|
+
};
|
|
3082
|
+
this.server =
|
|
3083
|
+
privateOverlay?.maximumHeaderBytes === undefined
|
|
3084
|
+
? this.app.listen(this.port, listening)
|
|
3085
|
+
: createServer({ maxHeaderSize: privateOverlay.maximumHeaderBytes }, this.app).listen(this.port, listening);
|
|
2858
3086
|
configureHttpServer(this.server, edgePolicy.environmentPrefix, edgePolicy.http);
|
|
2859
3087
|
}
|
|
2860
3088
|
/**
|