@bsv/overlay-express 2.4.1 → 2.4.9
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/LICENSE.txt +57 -27
- package/README.md +141 -56
- package/dist/cjs/mod.d.ts +11 -0
- package/dist/cjs/mod.d.ts.map +1 -0
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +36 -23
- package/dist/cjs/src/ArcadeProvider.d.ts +37 -0
- package/dist/cjs/src/ArcadeProvider.d.ts.map +1 -0
- package/dist/cjs/src/ArcadeProvider.js.map +1 -1
- package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts +36 -0
- package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareDiscoveryStorage.js +5 -4
- package/dist/cjs/src/BanAwareDiscoveryStorage.js.map +1 -1
- package/dist/cjs/src/BanAwareLookupWrapper.d.ts +31 -0
- package/dist/cjs/src/BanAwareLookupWrapper.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareLookupWrapper.js +3 -2
- package/dist/cjs/src/BanAwareLookupWrapper.js.map +1 -1
- package/dist/cjs/src/BanAwareTopicManager.d.ts +28 -0
- package/dist/cjs/src/BanAwareTopicManager.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareTopicManager.js +3 -2
- package/dist/cjs/src/BanAwareTopicManager.js.map +1 -1
- package/dist/cjs/src/BanService.d.ts +81 -0
- package/dist/cjs/src/BanService.d.ts.map +1 -0
- package/dist/cjs/src/BanService.js.map +1 -1
- package/dist/cjs/src/ChaintracksProvider.d.ts +29 -0
- package/dist/cjs/src/ChaintracksProvider.d.ts.map +1 -0
- package/dist/cjs/src/ChaintracksProvider.js +1 -1
- package/dist/cjs/src/ChaintracksProvider.js.map +1 -1
- package/dist/cjs/src/JanitorService.d.ts +128 -0
- package/dist/cjs/src/JanitorService.d.ts.map +1 -0
- package/dist/cjs/src/JanitorService.js +108 -37
- package/dist/cjs/src/JanitorService.js.map +1 -1
- package/dist/cjs/src/OverlayExpress.d.ts +466 -0
- package/dist/cjs/src/OverlayExpress.d.ts.map +1 -0
- package/dist/cjs/src/OverlayExpress.js +337 -160
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/OverlayMonitor.d.ts +197 -0
- package/dist/cjs/src/OverlayMonitor.d.ts.map +1 -0
- package/dist/cjs/src/OverlayMonitor.js +6 -4
- package/dist/cjs/src/OverlayMonitor.js.map +1 -1
- package/dist/cjs/src/ProviderChainBroadcaster.d.ts +18 -0
- package/dist/cjs/src/ProviderChainBroadcaster.d.ts.map +1 -0
- package/dist/cjs/src/ProviderChainBroadcaster.js +7 -3
- package/dist/cjs/src/ProviderChainBroadcaster.js.map +1 -1
- package/dist/cjs/src/ReorgStream.d.ts +74 -0
- package/dist/cjs/src/ReorgStream.d.ts.map +1 -0
- package/dist/cjs/src/ReorgStream.js +14 -6
- package/dist/cjs/src/ReorgStream.js.map +1 -1
- package/dist/cjs/src/generalGuide.md.d.ts +3 -0
- package/dist/cjs/src/generalGuide.md.d.ts.map +1 -0
- package/dist/cjs/src/generalGuide.md.js +1 -1
- package/dist/cjs/src/generalGuide.md.js.map +1 -1
- package/dist/cjs/src/makeUserInterface.d.ts +22 -0
- package/dist/cjs/src/makeUserInterface.d.ts.map +1 -0
- package/dist/cjs/src/makeUserInterface.js +4 -4
- package/dist/cjs/src/makeUserInterface.js.map +1 -1
- package/dist/cjs/src/security/edgePolicy.d.ts +57 -0
- package/dist/cjs/src/security/edgePolicy.d.ts.map +1 -0
- package/dist/cjs/src/security/edgePolicy.js +379 -0
- package/dist/cjs/src/security/edgePolicy.js.map +1 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/ArcadeProvider.js.map +1 -1
- package/dist/esm/src/BanAwareDiscoveryStorage.js +5 -4
- package/dist/esm/src/BanAwareDiscoveryStorage.js.map +1 -1
- package/dist/esm/src/BanAwareLookupWrapper.js +3 -2
- package/dist/esm/src/BanAwareLookupWrapper.js.map +1 -1
- package/dist/esm/src/BanAwareTopicManager.js +3 -2
- package/dist/esm/src/BanAwareTopicManager.js.map +1 -1
- package/dist/esm/src/ChaintracksProvider.js +1 -1
- package/dist/esm/src/ChaintracksProvider.js.map +1 -1
- package/dist/esm/src/JanitorService.js +84 -8
- package/dist/esm/src/JanitorService.js.map +1 -1
- package/dist/esm/src/OverlayExpress.js +319 -146
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/ProviderChainBroadcaster.js +7 -3
- package/dist/esm/src/ProviderChainBroadcaster.js.map +1 -1
- package/dist/esm/src/ReorgStream.js +14 -6
- package/dist/esm/src/ReorgStream.js.map +1 -1
- package/dist/esm/src/generalGuide.md.js +1 -1
- package/dist/esm/src/makeUserInterface.js +3 -4
- package/dist/esm/src/makeUserInterface.js.map +1 -1
- package/dist/esm/src/security/edgePolicy.js +377 -0
- package/dist/esm/src/security/edgePolicy.js.map +1 -0
- package/dist/types/mod.d.ts +1 -1
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/ArcadeProvider.d.ts.map +1 -1
- package/dist/types/src/BanAwareDiscoveryStorage.d.ts.map +1 -1
- package/dist/types/src/BanAwareLookupWrapper.d.ts.map +1 -1
- package/dist/types/src/BanAwareTopicManager.d.ts.map +1 -1
- package/dist/types/src/BanService.d.ts.map +1 -1
- package/dist/types/src/ChaintracksProvider.d.ts.map +1 -1
- package/dist/types/src/JanitorService.d.ts +14 -1
- package/dist/types/src/JanitorService.d.ts.map +1 -1
- package/dist/types/src/OverlayExpress.d.ts +48 -2
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/OverlayMonitor.d.ts.map +1 -1
- package/dist/types/src/ProviderChainBroadcaster.d.ts.map +1 -1
- package/dist/types/src/ReorgStream.d.ts.map +1 -1
- package/dist/types/src/generalGuide.md.d.ts +1 -1
- package/dist/types/src/generalGuide.md.d.ts.map +1 -1
- package/dist/types/src/makeUserInterface.d.ts +1 -2
- package/dist/types/src/makeUserInterface.d.ts.map +1 -1
- package/dist/types/src/security/edgePolicy.d.ts +57 -0
- package/dist/types/src/security/edgePolicy.d.ts.map +1 -0
- package/package.json +51 -29
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +0 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +0 -1
- package/dist/types/tsconfig.types.tsbuildinfo +0 -1
- package/mod.ts +0 -47
- package/src/ArcadeProvider.ts +0 -232
- package/src/BanAwareDiscoveryStorage.ts +0 -91
- package/src/BanAwareLookupWrapper.ts +0 -95
- package/src/BanAwareTopicManager.ts +0 -87
- package/src/BanService.ts +0 -154
- package/src/ChaintracksProvider.ts +0 -79
- package/src/JanitorService.ts +0 -423
- package/src/OverlayExpress.ts +0 -2456
- package/src/OverlayMonitor.ts +0 -817
- package/src/ProviderChainBroadcaster.ts +0 -108
- package/src/ReorgStream.ts +0 -221
- package/src/__tests__/BanAwareDiscoveryStorage.test.ts +0 -131
- package/src/__tests__/BanAwareLookupWrapper.test.ts +0 -255
- package/src/__tests__/BanAwareTopicManager.test.ts +0 -132
- package/src/__tests__/BanService.test.ts +0 -310
- package/src/__tests__/InMemoryMigrationSource.test.ts +0 -11
- package/src/__tests__/JanitorService.test.ts +0 -941
- package/src/__tests__/OverlayExpress.test.ts +0 -1142
- package/src/__tests__/OverlayMonitor.test.ts +0 -255
- package/src/__tests__/OverlayProviders.live.test.ts +0 -39
- package/src/__tests__/OverlayProviders.test.ts +0 -123
- package/src/__tests__/README.md +0 -105
- package/src/__tests__/ReorgStream.test.ts +0 -66
- package/src/__tests__/makeUserInterface.test.ts +0 -193
- package/src/__tests__/setup.ts +0 -36
- package/src/auth-express-middleware.d.ts +0 -16
- package/src/generalGuide.md.ts +0 -74
- package/src/makeUserInterface.ts +0 -1224
|
@@ -45,8 +45,8 @@ const mongodb_1 = require("mongodb");
|
|
|
45
45
|
const makeUserInterface_js_1 = __importDefault(require("./makeUserInterface.js"));
|
|
46
46
|
const DiscoveryServices = __importStar(require("@bsv/overlay-discovery-services"));
|
|
47
47
|
const chalk_1 = __importDefault(require("chalk"));
|
|
48
|
-
const node_util_1 = __importDefault(require("node:util"));
|
|
49
48
|
const uuid_1 = require("uuid");
|
|
49
|
+
const node_crypto_1 = require("node:crypto");
|
|
50
50
|
const JanitorService_js_1 = require("./JanitorService.js");
|
|
51
51
|
const BanService_js_1 = require("./BanService.js");
|
|
52
52
|
const BanAwareLookupWrapper_js_1 = require("./BanAwareLookupWrapper.js");
|
|
@@ -58,6 +58,7 @@ const auth_express_middleware_1 = require("@bsv/auth-express-middleware");
|
|
|
58
58
|
const ArcadeProvider_js_1 = require("./ArcadeProvider.js");
|
|
59
59
|
const ProviderChainBroadcaster_js_1 = require("./ProviderChainBroadcaster.js");
|
|
60
60
|
const ChaintracksProvider_js_1 = require("./ChaintracksProvider.js");
|
|
61
|
+
const edgePolicy_js_1 = require("./security/edgePolicy.js");
|
|
61
62
|
/**
|
|
62
63
|
* In-memory migration source for Knex migrations.
|
|
63
64
|
* Allows running migrations defined in code rather than files.
|
|
@@ -71,7 +72,7 @@ class InMemoryMigrationSource {
|
|
|
71
72
|
* @param loadExtensions - Array of file extensions to filter by (not used here)
|
|
72
73
|
* @returns Promise resolving to the array of migrations
|
|
73
74
|
*/
|
|
74
|
-
async getMigrations(
|
|
75
|
+
async getMigrations(_loadExtensions) {
|
|
75
76
|
return this.migrations;
|
|
76
77
|
}
|
|
77
78
|
/**
|
|
@@ -91,6 +92,36 @@ class InMemoryMigrationSource {
|
|
|
91
92
|
return await Promise.resolve(migration);
|
|
92
93
|
}
|
|
93
94
|
}
|
|
95
|
+
class PublicRequestError extends Error {
|
|
96
|
+
constructor(message) {
|
|
97
|
+
super(message);
|
|
98
|
+
this.name = 'PublicRequestError';
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
function publicErrorMessage(error, fallback = 'Request could not be processed') {
|
|
102
|
+
return error instanceof PublicRequestError ? error.message : fallback;
|
|
103
|
+
}
|
|
104
|
+
function secretMatches(provided, expected) {
|
|
105
|
+
const providedDigest = (0, node_crypto_1.createHash)('sha256').update(provided, 'utf8').digest();
|
|
106
|
+
const expectedDigest = (0, node_crypto_1.createHash)('sha256').update(expected, 'utf8').digest();
|
|
107
|
+
return (0, node_crypto_1.timingSafeEqual)(providedDigest, expectedDigest);
|
|
108
|
+
}
|
|
109
|
+
function parseTopicsHeader(header) {
|
|
110
|
+
const value = header.trim();
|
|
111
|
+
let parsed;
|
|
112
|
+
try {
|
|
113
|
+
parsed = value.startsWith('[')
|
|
114
|
+
? JSON.parse(value)
|
|
115
|
+
: value.split(',').map(topic => topic.trim());
|
|
116
|
+
}
|
|
117
|
+
catch {
|
|
118
|
+
throw new PublicRequestError('Invalid x-topics header: expected a comma-separated list or JSON string array');
|
|
119
|
+
}
|
|
120
|
+
if (!Array.isArray(parsed) || parsed.some(topic => typeof topic !== 'string' || topic.length === 0)) {
|
|
121
|
+
throw new PublicRequestError('Invalid x-topics header: expected a comma-separated list or JSON string array');
|
|
122
|
+
}
|
|
123
|
+
return parsed;
|
|
124
|
+
}
|
|
94
125
|
/**
|
|
95
126
|
* OverlayExpress class provides an Express-based server for hosting Overlay Services.
|
|
96
127
|
* It allows configuration of various components like databases, topic managers, and lookup services.
|
|
@@ -162,7 +193,8 @@ class OverlayExpress {
|
|
|
162
193
|
this.janitorConfig = {
|
|
163
194
|
requestTimeoutMs: 10000, // 10 seconds
|
|
164
195
|
hostDownRevokeScore: 3,
|
|
165
|
-
autoBanOnRemoval: true
|
|
196
|
+
autoBanOnRemoval: true,
|
|
197
|
+
allowPrivateHosts: false
|
|
166
198
|
};
|
|
167
199
|
// Health endpoint configuration
|
|
168
200
|
this.healthConfig = {
|
|
@@ -173,6 +205,22 @@ class OverlayExpress {
|
|
|
173
205
|
this.healthChecks = [];
|
|
174
206
|
// Lifecycle marker for readiness/liveness reporting
|
|
175
207
|
this.isListening = false;
|
|
208
|
+
this.edgePolicyConfig = {
|
|
209
|
+
environmentPrefix: 'OVERLAY',
|
|
210
|
+
jsonBodyLimitBytes: 8 * 1024 * 1024,
|
|
211
|
+
binaryBodyLimitBytes: 64 * 1024 * 1024,
|
|
212
|
+
maxConcurrentRequests: 200,
|
|
213
|
+
http: {
|
|
214
|
+
requestTimeoutMs: 2 * 60 * 1000,
|
|
215
|
+
headersTimeoutMs: 15000,
|
|
216
|
+
keepAliveTimeoutMs: 5000,
|
|
217
|
+
socketTimeoutMs: 2 * 60 * 1000,
|
|
218
|
+
maxRequestsPerSocket: 1000
|
|
219
|
+
},
|
|
220
|
+
securityHeaders: {
|
|
221
|
+
contentSecurityPolicy: "default-src 'none'; script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; img-src 'self' data: https://bsvblockchain.org; connect-src 'self' https:; font-src 'self' https://cdn.jsdelivr.net; base-uri 'none'; form-action 'none'; frame-ancestors 'none'"
|
|
222
|
+
}
|
|
223
|
+
};
|
|
176
224
|
this.app = (0, express_1.default)();
|
|
177
225
|
this.logger.log(chalk_1.default.green.bold(`${name} constructed`));
|
|
178
226
|
this.adminToken = adminToken !== null && adminToken !== void 0 ? adminToken : (0, uuid_1.v4)(); // generate random if not provided
|
|
@@ -205,6 +253,7 @@ class OverlayExpress {
|
|
|
205
253
|
* - requestTimeoutMs: Timeout for health check requests (default: 10000ms)
|
|
206
254
|
* - hostDownRevokeScore: Number of consecutive failures before deleting output (default: 3)
|
|
207
255
|
* - autoBanOnRemoval: Whether to auto-ban domains when removed by janitor (default: true)
|
|
256
|
+
* - allowPrivateHosts: Permit private/HTTP targets for isolated local development (default: false)
|
|
208
257
|
*/
|
|
209
258
|
configureJanitor(config) {
|
|
210
259
|
this.janitorConfig = {
|
|
@@ -223,6 +272,30 @@ class OverlayExpress {
|
|
|
223
272
|
};
|
|
224
273
|
this.logger.log(chalk_1.default.blue('Health reporting has been configured.'));
|
|
225
274
|
}
|
|
275
|
+
/**
|
|
276
|
+
* Configures explicit browser origins and bounded request/resource policy.
|
|
277
|
+
* Public cross-origin access is the default; pass allowedOrigins or set
|
|
278
|
+
* OVERLAY_CORS_MODE=allowlist to restrict browser callers.
|
|
279
|
+
*/
|
|
280
|
+
configureEdgePolicy(config) {
|
|
281
|
+
const { http, securityHeaders: headerConfig, ...topLevel } = config;
|
|
282
|
+
const definedTopLevel = Object.fromEntries(Object.entries(topLevel).filter(([, value]) => value !== undefined));
|
|
283
|
+
const definedHttp = Object.fromEntries(Object.entries(http !== null && http !== void 0 ? http : {}).filter(([, value]) => value !== undefined));
|
|
284
|
+
const definedHeaders = Object.fromEntries(Object.entries(headerConfig !== null && headerConfig !== void 0 ? headerConfig : {}).filter(([, value]) => value !== undefined));
|
|
285
|
+
this.edgePolicyConfig = {
|
|
286
|
+
...this.edgePolicyConfig,
|
|
287
|
+
...definedTopLevel,
|
|
288
|
+
http: {
|
|
289
|
+
...this.edgePolicyConfig.http,
|
|
290
|
+
...definedHttp
|
|
291
|
+
},
|
|
292
|
+
securityHeaders: {
|
|
293
|
+
...this.edgePolicyConfig.securityHeaders,
|
|
294
|
+
...definedHeaders
|
|
295
|
+
}
|
|
296
|
+
};
|
|
297
|
+
this.logger.log(chalk_1.default.blue('HTTP edge policy has been configured.'));
|
|
298
|
+
}
|
|
226
299
|
/**
|
|
227
300
|
* Registers an application-specific health check.
|
|
228
301
|
*/
|
|
@@ -246,6 +319,15 @@ class OverlayExpress {
|
|
|
246
319
|
this.adminIdentityKey = identityKey;
|
|
247
320
|
this.logger.log(chalk_1.default.blue('Admin identity key has been configured.'));
|
|
248
321
|
}
|
|
322
|
+
/**
|
|
323
|
+
* Configures BRC-103 session storage for the administrative mutual-auth
|
|
324
|
+
* middleware. Horizontally scaled services should supply a shared
|
|
325
|
+
* AsyncSessionManager rather than use the default process-local store.
|
|
326
|
+
*/
|
|
327
|
+
configureAuthSessionManager(sessionManager) {
|
|
328
|
+
this.authSessionManager = sessionManager;
|
|
329
|
+
this.logger.log(chalk_1.default.blue('BSV authentication session manager has been configured.'));
|
|
330
|
+
}
|
|
249
331
|
/**
|
|
250
332
|
* Configures the logger to be used by the server.
|
|
251
333
|
* @param logger - A logger object (e.g., console)
|
|
@@ -506,22 +588,25 @@ class OverlayExpress {
|
|
|
506
588
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
507
589
|
const knex = this.ensureKnex();
|
|
508
590
|
if (autoConfigureShipSlap) {
|
|
591
|
+
const mongoDb = this.ensureMongo();
|
|
592
|
+
const shipStorage = new DiscoveryServices.SHIPStorage(mongoDb);
|
|
593
|
+
const slapStorage = new DiscoveryServices.SLAPStorage(mongoDb);
|
|
594
|
+
// Run the one-time discovery migration before the engine can accept
|
|
595
|
+
// traffic, so a failed unique-index build is a visible startup failure.
|
|
596
|
+
await shipStorage.ensureIndexes();
|
|
597
|
+
await slapStorage.ensureIndexes();
|
|
509
598
|
this.configureTopicManager('tm_ship', new DiscoveryServices.SHIPTopicManager());
|
|
510
599
|
this.configureTopicManager('tm_slap', new DiscoveryServices.SLAPTopicManager());
|
|
511
|
-
this.
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
this.
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
? storage
|
|
522
|
-
: new BanAwareDiscoveryStorage_js_1.BanAwareSLAPStorage(storage, this.banService, this.logger);
|
|
523
|
-
return new DiscoveryServices.SLAPLookupService(storageForLookup);
|
|
524
|
-
});
|
|
600
|
+
const shipStorageForLookup = this.banService === undefined
|
|
601
|
+
? shipStorage
|
|
602
|
+
: new BanAwareDiscoveryStorage_js_1.BanAwareSHIPStorage(shipStorage, this.banService, this.logger);
|
|
603
|
+
const slapStorageForLookup = this.banService === undefined
|
|
604
|
+
? slapStorage
|
|
605
|
+
: new BanAwareDiscoveryStorage_js_1.BanAwareSLAPStorage(slapStorage, this.banService, this.logger);
|
|
606
|
+
this.services.ls_ship = new DiscoveryServices.SHIPLookupService(shipStorageForLookup);
|
|
607
|
+
this.services.ls_slap = new DiscoveryServices.SLAPLookupService(slapStorageForLookup);
|
|
608
|
+
this.logger.log(chalk_1.default.blue('Configured lookup service ls_ship with MongoDB'));
|
|
609
|
+
this.logger.log(chalk_1.default.blue('Configured lookup service ls_slap with MongoDB'));
|
|
525
610
|
}
|
|
526
611
|
this.wrapBanAwareServices();
|
|
527
612
|
const syncConfig = this.buildSyncConfig();
|
|
@@ -754,7 +839,8 @@ class OverlayExpress {
|
|
|
754
839
|
requestTimeoutMs: this.janitorConfig.requestTimeoutMs,
|
|
755
840
|
hostDownRevokeScore: this.janitorConfig.hostDownRevokeScore,
|
|
756
841
|
banService: this.banService,
|
|
757
|
-
autoBanOnRemoval: this.janitorConfig.autoBanOnRemoval
|
|
842
|
+
autoBanOnRemoval: this.janitorConfig.autoBanOnRemoval,
|
|
843
|
+
allowPrivateHosts: this.janitorConfig.allowPrivateHosts
|
|
758
844
|
});
|
|
759
845
|
}
|
|
760
846
|
/** Ban a domain and remove all its SHIP/SLAP records from MongoDB. */
|
|
@@ -825,11 +911,12 @@ class OverlayExpress {
|
|
|
825
911
|
async runHealthCheck(definition) {
|
|
826
912
|
var _a, _b;
|
|
827
913
|
const startedAt = Date.now();
|
|
914
|
+
let timeout;
|
|
828
915
|
try {
|
|
829
916
|
const result = ((_a = (await Promise.race([
|
|
830
917
|
Promise.resolve(definition.handler()),
|
|
831
918
|
new Promise((_, reject) => {
|
|
832
|
-
setTimeout(() => reject(new Error(`Timed out after ${this.healthConfig.timeoutMs}ms`)), this.healthConfig.timeoutMs);
|
|
919
|
+
timeout = setTimeout(() => reject(new Error(`Timed out after ${this.healthConfig.timeoutMs}ms`)), this.healthConfig.timeoutMs);
|
|
833
920
|
})
|
|
834
921
|
]))) !== null && _a !== void 0 ? _a : {});
|
|
835
922
|
return {
|
|
@@ -843,18 +930,28 @@ class OverlayExpress {
|
|
|
843
930
|
};
|
|
844
931
|
}
|
|
845
932
|
catch (error) {
|
|
933
|
+
this.logger.error({
|
|
934
|
+
operation: 'overlay.health_check',
|
|
935
|
+
check: definition.name,
|
|
936
|
+
error
|
|
937
|
+
});
|
|
846
938
|
return {
|
|
847
939
|
name: definition.name,
|
|
848
940
|
scope: definition.scope,
|
|
849
941
|
critical: definition.critical,
|
|
850
942
|
status: 'error',
|
|
851
|
-
message:
|
|
943
|
+
message: 'Health check failed',
|
|
852
944
|
durationMs: Date.now() - startedAt
|
|
853
945
|
};
|
|
854
946
|
}
|
|
947
|
+
finally {
|
|
948
|
+
if (timeout !== undefined)
|
|
949
|
+
clearTimeout(timeout);
|
|
950
|
+
}
|
|
855
951
|
}
|
|
856
952
|
async collectHealthReport(mode) {
|
|
857
|
-
var _a
|
|
953
|
+
var _a;
|
|
954
|
+
var _b, _c;
|
|
858
955
|
const definitions = [
|
|
859
956
|
{
|
|
860
957
|
name: 'process',
|
|
@@ -889,7 +986,8 @@ class OverlayExpress {
|
|
|
889
986
|
scope: 'ready',
|
|
890
987
|
critical: true,
|
|
891
988
|
handler: async () => {
|
|
892
|
-
var _a, _b
|
|
989
|
+
var _a, _b;
|
|
990
|
+
var _c;
|
|
893
991
|
if (this.knex === undefined) {
|
|
894
992
|
throw new TypeError('Knex is not configured');
|
|
895
993
|
}
|
|
@@ -923,8 +1021,8 @@ class OverlayExpress {
|
|
|
923
1021
|
for (const check of this.healthChecks) {
|
|
924
1022
|
definitions.push({
|
|
925
1023
|
name: check.name,
|
|
926
|
-
scope: (
|
|
927
|
-
critical: (
|
|
1024
|
+
scope: (_b = check.scope) !== null && _b !== void 0 ? _b : 'ready',
|
|
1025
|
+
critical: (_c = check.critical) !== null && _c !== void 0 ? _c : false,
|
|
928
1026
|
handler: check.handler
|
|
929
1027
|
});
|
|
930
1028
|
}
|
|
@@ -958,14 +1056,18 @@ class OverlayExpress {
|
|
|
958
1056
|
advertisableFQDN: this.advertisableFQDN,
|
|
959
1057
|
port: this.port,
|
|
960
1058
|
network: this.network,
|
|
961
|
-
startedAt: (
|
|
1059
|
+
startedAt: (_a = this.startTime) === null || _a === void 0 ? void 0 : _a.toISOString(),
|
|
962
1060
|
uptimeMs: this.startTime === undefined ? 0 : Date.now() - this.startTime.getTime(),
|
|
963
1061
|
topicManagerCount: Object.keys(this.managers).length,
|
|
964
1062
|
lookupServiceCount: Object.keys(this.services).length
|
|
965
1063
|
},
|
|
966
1064
|
checks: this.healthConfig.includeDetails
|
|
967
1065
|
? checks
|
|
968
|
-
: checks.map(
|
|
1066
|
+
: checks.map(check => {
|
|
1067
|
+
const publicCheck = { ...check };
|
|
1068
|
+
delete publicCheck.details;
|
|
1069
|
+
return publicCheck;
|
|
1070
|
+
}),
|
|
969
1071
|
context
|
|
970
1072
|
};
|
|
971
1073
|
return report;
|
|
@@ -973,20 +1075,83 @@ class OverlayExpress {
|
|
|
973
1075
|
/**
|
|
974
1076
|
* Renders a request or response body for verbose logging, truncating overly long payloads.
|
|
975
1077
|
*/
|
|
976
|
-
formatBodyForLog(body,
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
bodyString = JSON.stringify(body, null, 2);
|
|
1078
|
+
formatBodyForLog(body, okPrefix) {
|
|
1079
|
+
if (Buffer.isBuffer(body)) {
|
|
1080
|
+
return chalk_1.default.green(`${okPrefix} binary body (${(0, overlay_1.serializeLogValue)(body.byteLength)} bytes)`);
|
|
980
1081
|
}
|
|
981
|
-
|
|
982
|
-
|
|
1082
|
+
if (typeof body === 'string') {
|
|
1083
|
+
return chalk_1.default.green(`${okPrefix} string body (${(0, overlay_1.serializeLogValue)(Buffer.byteLength(body, 'utf8'))} bytes)`);
|
|
983
1084
|
}
|
|
984
|
-
|
|
985
|
-
|
|
1085
|
+
if (body != null && typeof body === 'object') {
|
|
1086
|
+
const keys = Array.isArray(body) ? body.length : Object.keys(body).length;
|
|
1087
|
+
return chalk_1.default.green(`${okPrefix} structured body (${(0, overlay_1.serializeLogValue)(keys)} top-level item(s))`);
|
|
1088
|
+
}
|
|
1089
|
+
return chalk_1.default.green(`${okPrefix} type=${(0, overlay_1.serializeLogValue)(typeof body)}`);
|
|
1090
|
+
}
|
|
1091
|
+
redactHeadersForLog(headers) {
|
|
1092
|
+
const sensitiveHeader = /authorization|cookie|token|secret|payment|signature|nonce/i;
|
|
1093
|
+
return Object.fromEntries(Object.entries(headers).map(([name, value]) => [
|
|
1094
|
+
name,
|
|
1095
|
+
sensitiveHeader.test(name) ? '[REDACTED]' : value
|
|
1096
|
+
]));
|
|
1097
|
+
}
|
|
1098
|
+
arcCallbackRequestToken(req) {
|
|
1099
|
+
const authorization = req.headers.authorization;
|
|
1100
|
+
const headerToken = Array.isArray(authorization) ? authorization[0] : authorization;
|
|
1101
|
+
if (typeof headerToken === 'string' && headerToken.startsWith('Bearer ')) {
|
|
1102
|
+
return headerToken.slice('Bearer '.length);
|
|
1103
|
+
}
|
|
1104
|
+
return headerToken;
|
|
1105
|
+
}
|
|
1106
|
+
arcCallbackAuthorized(req) {
|
|
1107
|
+
if (typeof this.arcCallbackToken !== 'string' || this.arcCallbackToken.length === 0) {
|
|
1108
|
+
return true;
|
|
1109
|
+
}
|
|
1110
|
+
const callbackHeader = req.headers['x-callback-token'];
|
|
1111
|
+
const callbackToken = Array.isArray(callbackHeader) ? callbackHeader[0] : callbackHeader;
|
|
1112
|
+
return (this.arcCallbackRequestToken(req) === this.arcCallbackToken ||
|
|
1113
|
+
callbackToken === this.arcCallbackToken);
|
|
1114
|
+
}
|
|
1115
|
+
async processArcIngest(engine, req, res) {
|
|
1116
|
+
if (!this.arcCallbackAuthorized(req)) {
|
|
1117
|
+
return res.status(401).json({ status: 'error', message: 'Unauthorized callback' });
|
|
1118
|
+
}
|
|
1119
|
+
const { txid, merklePath: merklePathHex, blockHeight, txStatus, extraInfo, competingTxs, topic } = req.body;
|
|
1120
|
+
if (typeof txid !== 'string' || txid === '') {
|
|
1121
|
+
throw new PublicRequestError('Provider callback is missing txid');
|
|
1122
|
+
}
|
|
1123
|
+
if ((0, ArcadeProvider_js_1.isTerminalArcStatus)(txStatus, extraInfo)) {
|
|
1124
|
+
const report = await engine.evictAppliedTransaction(txid, {
|
|
1125
|
+
topic: typeof topic === 'string' ? topic : undefined,
|
|
1126
|
+
reason: `${txStatus !== null && txStatus !== void 0 ? txStatus : ''} ${extraInfo !== null && extraInfo !== void 0 ? extraInfo : ''}`.trim()
|
|
1127
|
+
});
|
|
1128
|
+
this.logger.warn({
|
|
1129
|
+
operation: 'overlay.provider_callback',
|
|
1130
|
+
outcome: 'terminal_evicted',
|
|
1131
|
+
txid,
|
|
1132
|
+
txStatus,
|
|
1133
|
+
competingTxs,
|
|
1134
|
+
report
|
|
1135
|
+
});
|
|
1136
|
+
return res.status(200).json({
|
|
1137
|
+
status: 'success',
|
|
1138
|
+
message: 'Terminal transaction status processed',
|
|
1139
|
+
data: { ...report, txStatus, competingTxs }
|
|
1140
|
+
});
|
|
1141
|
+
}
|
|
1142
|
+
if (typeof merklePathHex !== 'string' || merklePathHex === '') {
|
|
1143
|
+
return res
|
|
1144
|
+
.status(202)
|
|
1145
|
+
.json({ status: 'success', message: 'Transaction status received without proof' });
|
|
986
1146
|
}
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
:
|
|
1147
|
+
await engine.handleNewMerkleProof(txid, sdk_1.MerklePath.fromHex(merklePathHex), blockHeight);
|
|
1148
|
+
this.logger.log({
|
|
1149
|
+
operation: 'overlay.provider_callback',
|
|
1150
|
+
outcome: 'proof_ingested',
|
|
1151
|
+
txid,
|
|
1152
|
+
blockHeight
|
|
1153
|
+
});
|
|
1154
|
+
return res.status(200).json({ status: 'success', message: 'Transaction status updated' });
|
|
990
1155
|
}
|
|
991
1156
|
/**
|
|
992
1157
|
* Installs middleware that verbosely logs incoming requests and outgoing responses.
|
|
@@ -995,13 +1160,11 @@ class OverlayExpress {
|
|
|
995
1160
|
this.app.use((req, res, next) => {
|
|
996
1161
|
const startTime = Date.now();
|
|
997
1162
|
// Log incoming request details
|
|
998
|
-
this.logger.log(chalk_1.default.magenta.bold(`Incoming Request:
|
|
999
|
-
|
|
1000
|
-
this.logger.log(chalk_1.default.cyan('Headers:'));
|
|
1001
|
-
this.logger.log(node_util_1.default.inspect(req.headers, { colors: true, depth: null }));
|
|
1163
|
+
this.logger.log(chalk_1.default.magenta.bold(`Incoming Request: method=${(0, overlay_1.serializeLogValue)(req.method)} url=${(0, overlay_1.serializeLogValue)(req.originalUrl)}`));
|
|
1164
|
+
this.logger.log(chalk_1.default.cyan(`Headers: ${(0, overlay_1.serializeLogValue)(this.redactHeadersForLog(req.headers))}`));
|
|
1002
1165
|
// Handle request body
|
|
1003
1166
|
if (req.body != null && Object.keys(req.body).length > 0) {
|
|
1004
|
-
this.logger.log(this.formatBodyForLog(req.body, '
|
|
1167
|
+
this.logger.log(this.formatBodyForLog(req.body, 'Request Body:'));
|
|
1005
1168
|
}
|
|
1006
1169
|
// Intercept the res.send method to log responses
|
|
1007
1170
|
const originalSend = res.send;
|
|
@@ -1013,12 +1176,11 @@ class OverlayExpress {
|
|
|
1013
1176
|
// Log outgoing response details after the response is finished
|
|
1014
1177
|
res.on('finish', () => {
|
|
1015
1178
|
const duration = Date.now() - startTime;
|
|
1016
|
-
this.logger.log(chalk_1.default.magenta.bold(`Outgoing Response:
|
|
1017
|
-
this.logger.log(chalk_1.default.cyan(
|
|
1018
|
-
this.logger.log(node_util_1.default.inspect(res.getHeaders(), { colors: true, depth: null }));
|
|
1179
|
+
this.logger.log(chalk_1.default.magenta.bold(`Outgoing Response: method=${(0, overlay_1.serializeLogValue)(req.method)} url=${(0, overlay_1.serializeLogValue)(req.originalUrl)} status=${(0, overlay_1.serializeLogValue)(res.statusCode)} durationMs=${(0, overlay_1.serializeLogValue)(duration)}`));
|
|
1180
|
+
this.logger.log(chalk_1.default.cyan(`Response Headers: ${(0, overlay_1.serializeLogValue)(this.redactHeadersForLog(res.getHeaders()))}`));
|
|
1019
1181
|
// Handle response body
|
|
1020
1182
|
if (responseBody != null) {
|
|
1021
|
-
this.logger.log(this.formatBodyForLog(responseBody, 'Response
|
|
1183
|
+
this.logger.log(this.formatBodyForLog(responseBody, 'Response Body:'));
|
|
1022
1184
|
}
|
|
1023
1185
|
});
|
|
1024
1186
|
next();
|
|
@@ -1032,25 +1194,30 @@ class OverlayExpress {
|
|
|
1032
1194
|
const engine = this.ensureEngine();
|
|
1033
1195
|
const knex = this.ensureKnex();
|
|
1034
1196
|
this.startTime = new Date();
|
|
1035
|
-
|
|
1036
|
-
this.app.
|
|
1197
|
+
const edgePolicy = this.edgePolicyConfig;
|
|
1198
|
+
this.app.disable('x-powered-by');
|
|
1199
|
+
this.app.use((0, edgePolicy_js_1.securityHeaders)({
|
|
1200
|
+
environmentPrefix: edgePolicy.environmentPrefix,
|
|
1201
|
+
...edgePolicy.securityHeaders
|
|
1202
|
+
}));
|
|
1203
|
+
this.app.use((0, edgePolicy_js_1.corsPolicy)({
|
|
1204
|
+
environmentPrefix: edgePolicy.environmentPrefix,
|
|
1205
|
+
allowedOrigins: edgePolicy.allowedOrigins,
|
|
1206
|
+
methods: ['GET', 'POST', 'OPTIONS']
|
|
1207
|
+
}));
|
|
1208
|
+
this.app.use((0, edgePolicy_js_1.concurrencyLimit)(edgePolicy.environmentPrefix, edgePolicy.maxConcurrentRequests));
|
|
1209
|
+
this.app.use(body_parser_1.default.json({
|
|
1210
|
+
limit: (0, edgePolicy_js_1.readBodyLimitBytes)(`${edgePolicy.environmentPrefix}_JSON`, edgePolicy.jsonBodyLimitBytes),
|
|
1211
|
+
type: 'application/json'
|
|
1212
|
+
}));
|
|
1213
|
+
this.app.use(body_parser_1.default.raw({
|
|
1214
|
+
limit: (0, edgePolicy_js_1.readBodyLimitBytes)(`${edgePolicy.environmentPrefix}_BINARY`, edgePolicy.binaryBodyLimitBytes),
|
|
1215
|
+
type: 'application/octet-stream'
|
|
1216
|
+
}));
|
|
1217
|
+
this.app.use(edgePolicy_js_1.bodyParserErrorHandler);
|
|
1037
1218
|
if (this.verboseRequestLogging) {
|
|
1038
1219
|
this.setupVerboseRequestLogging();
|
|
1039
1220
|
}
|
|
1040
|
-
// Enable CORS
|
|
1041
|
-
this.app.use((req, res, next) => {
|
|
1042
|
-
res.header('Access-Control-Allow-Origin', '*');
|
|
1043
|
-
res.header('Access-Control-Allow-Headers', '*');
|
|
1044
|
-
res.header('Access-Control-Allow-Methods', '*');
|
|
1045
|
-
res.header('Access-Control-Expose-Headers', '*');
|
|
1046
|
-
res.header('Access-Control-Allow-Private-Network', 'true');
|
|
1047
|
-
if (req.method === 'OPTIONS') {
|
|
1048
|
-
res.sendStatus(200);
|
|
1049
|
-
}
|
|
1050
|
-
else {
|
|
1051
|
-
next();
|
|
1052
|
-
}
|
|
1053
|
-
});
|
|
1054
1221
|
// Serve a static documentation site or user interface
|
|
1055
1222
|
this.app.get('/', (req, res) => {
|
|
1056
1223
|
res.set('content-type', 'text/html');
|
|
@@ -1066,9 +1233,10 @@ class OverlayExpress {
|
|
|
1066
1233
|
const report = await this.collectHealthReport('live');
|
|
1067
1234
|
return res.status(report.live ? 200 : 503).json(report);
|
|
1068
1235
|
})().catch((error) => {
|
|
1236
|
+
this.logger.error({ operation: 'overlay.health_live', error });
|
|
1069
1237
|
res.status(500).json({
|
|
1070
1238
|
status: 'error',
|
|
1071
|
-
message:
|
|
1239
|
+
message: 'Health report unavailable'
|
|
1072
1240
|
});
|
|
1073
1241
|
});
|
|
1074
1242
|
});
|
|
@@ -1078,9 +1246,10 @@ class OverlayExpress {
|
|
|
1078
1246
|
const report = await this.collectHealthReport('ready');
|
|
1079
1247
|
return res.status(report.ready ? 200 : 503).json(report);
|
|
1080
1248
|
})().catch((error) => {
|
|
1249
|
+
this.logger.error({ operation: 'overlay.health_ready', error });
|
|
1081
1250
|
res.status(500).json({
|
|
1082
1251
|
status: 'error',
|
|
1083
|
-
message:
|
|
1252
|
+
message: 'Health report unavailable'
|
|
1084
1253
|
});
|
|
1085
1254
|
});
|
|
1086
1255
|
});
|
|
@@ -1090,9 +1259,10 @@ class OverlayExpress {
|
|
|
1090
1259
|
const report = await this.collectHealthReport('full');
|
|
1091
1260
|
return res.status(report.ready ? 200 : 503).json(report);
|
|
1092
1261
|
})().catch((error) => {
|
|
1262
|
+
this.logger.error({ operation: 'overlay.health_full', error });
|
|
1093
1263
|
res.status(500).json({
|
|
1094
1264
|
status: 'error',
|
|
1095
|
-
message:
|
|
1265
|
+
message: 'Health report unavailable'
|
|
1096
1266
|
});
|
|
1097
1267
|
});
|
|
1098
1268
|
});
|
|
@@ -1107,7 +1277,7 @@ class OverlayExpress {
|
|
|
1107
1277
|
catch (error) {
|
|
1108
1278
|
return res.status(400).json({
|
|
1109
1279
|
status: 'error',
|
|
1110
|
-
message: error
|
|
1280
|
+
message: publicErrorMessage(error)
|
|
1111
1281
|
});
|
|
1112
1282
|
}
|
|
1113
1283
|
})().catch(() => {
|
|
@@ -1127,7 +1297,7 @@ class OverlayExpress {
|
|
|
1127
1297
|
catch (error) {
|
|
1128
1298
|
return res.status(400).json({
|
|
1129
1299
|
status: 'error',
|
|
1130
|
-
message: error
|
|
1300
|
+
message: publicErrorMessage(error)
|
|
1131
1301
|
});
|
|
1132
1302
|
}
|
|
1133
1303
|
})().catch(() => {
|
|
@@ -1150,7 +1320,7 @@ class OverlayExpress {
|
|
|
1150
1320
|
catch (error) {
|
|
1151
1321
|
return res.status(400).json({
|
|
1152
1322
|
status: 'error',
|
|
1153
|
-
message: error
|
|
1323
|
+
message: publicErrorMessage(error)
|
|
1154
1324
|
});
|
|
1155
1325
|
}
|
|
1156
1326
|
})().catch(() => {
|
|
@@ -1172,7 +1342,7 @@ class OverlayExpress {
|
|
|
1172
1342
|
catch (error) {
|
|
1173
1343
|
return res.status(400).json({
|
|
1174
1344
|
status: 'error',
|
|
1175
|
-
message: error
|
|
1345
|
+
message: publicErrorMessage(error)
|
|
1176
1346
|
});
|
|
1177
1347
|
}
|
|
1178
1348
|
})().catch(() => {
|
|
@@ -1191,11 +1361,15 @@ class OverlayExpress {
|
|
|
1191
1361
|
const topicsHeader = req.headers['x-topics'];
|
|
1192
1362
|
const includesOffChain = req.headers['x-includes-off-chain-values'] === 'true';
|
|
1193
1363
|
if (typeof topicsHeader !== 'string') {
|
|
1194
|
-
throw new
|
|
1364
|
+
throw new PublicRequestError('Missing x-topics header');
|
|
1365
|
+
}
|
|
1366
|
+
const topics = parseTopicsHeader(topicsHeader);
|
|
1367
|
+
const body = req.body;
|
|
1368
|
+
if (body == null || typeof body[Symbol.iterator] !== 'function' || body.length === 0) {
|
|
1369
|
+
throw new PublicRequestError('Missing or empty BEEF body');
|
|
1195
1370
|
}
|
|
1196
|
-
const topics = JSON.parse(topicsHeader);
|
|
1197
1371
|
let offChainValues;
|
|
1198
|
-
let beef = Array.from(
|
|
1372
|
+
let beef = Array.from(body);
|
|
1199
1373
|
if (includesOffChain) {
|
|
1200
1374
|
const r = new sdk_1.Utils.Reader(beef);
|
|
1201
1375
|
const l = r.readVarIntNum();
|
|
@@ -1218,10 +1392,10 @@ class OverlayExpress {
|
|
|
1218
1392
|
}
|
|
1219
1393
|
}
|
|
1220
1394
|
catch (error) {
|
|
1221
|
-
|
|
1395
|
+
this.logger.error(chalk_1.default.red(`Error in /submit: error=${(0, overlay_1.serializeErrorForLog)(error)}`));
|
|
1222
1396
|
return res.status(400).json({
|
|
1223
1397
|
status: 'error',
|
|
1224
|
-
message: error
|
|
1398
|
+
message: publicErrorMessage(error)
|
|
1225
1399
|
});
|
|
1226
1400
|
}
|
|
1227
1401
|
})().catch(() => {
|
|
@@ -1280,10 +1454,10 @@ class OverlayExpress {
|
|
|
1280
1454
|
return res.status(200).send(Buffer.from(writer.toArray()));
|
|
1281
1455
|
}
|
|
1282
1456
|
catch (error) {
|
|
1283
|
-
|
|
1457
|
+
this.logger.error(chalk_1.default.red(`Error in /lookup: error=${(0, overlay_1.serializeErrorForLog)(error)}`));
|
|
1284
1458
|
return res.status(400).json({
|
|
1285
1459
|
status: 'error',
|
|
1286
|
-
message: error
|
|
1460
|
+
message: publicErrorMessage(error)
|
|
1287
1461
|
});
|
|
1288
1462
|
}
|
|
1289
1463
|
})().catch(() => {
|
|
@@ -1300,63 +1474,13 @@ class OverlayExpress {
|
|
|
1300
1474
|
;
|
|
1301
1475
|
(async () => {
|
|
1302
1476
|
try {
|
|
1303
|
-
|
|
1304
|
-
const authorization = req.headers.authorization;
|
|
1305
|
-
const headerToken = Array.isArray(authorization) ? authorization[0] : authorization;
|
|
1306
|
-
const xCallbackToken = req.headers['x-callback-token'];
|
|
1307
|
-
const callbackToken = Array.isArray(xCallbackToken) ? xCallbackToken[0] : xCallbackToken;
|
|
1308
|
-
const bearerToken = typeof headerToken === 'string' && headerToken.startsWith('Bearer ')
|
|
1309
|
-
? headerToken.slice('Bearer '.length)
|
|
1310
|
-
: headerToken;
|
|
1311
|
-
if (bearerToken !== this.arcCallbackToken && callbackToken !== this.arcCallbackToken) {
|
|
1312
|
-
return res.status(401).json({ status: 'error', message: 'Unauthorized callback' });
|
|
1313
|
-
}
|
|
1314
|
-
}
|
|
1315
|
-
const { txid, merklePath: merklePathHex, blockHeight, txStatus, extraInfo, competingTxs, topic } = req.body;
|
|
1316
|
-
if (typeof txid !== 'string' || txid === '') {
|
|
1317
|
-
throw new TypeError('Provider callback is missing txid');
|
|
1318
|
-
}
|
|
1319
|
-
if ((0, ArcadeProvider_js_1.isTerminalArcStatus)(txStatus, extraInfo)) {
|
|
1320
|
-
const report = await engine.evictAppliedTransaction(txid, {
|
|
1321
|
-
topic: typeof topic === 'string' ? topic : undefined,
|
|
1322
|
-
reason: `${txStatus !== null && txStatus !== void 0 ? txStatus : ''} ${extraInfo !== null && extraInfo !== void 0 ? extraInfo : ''}`.trim()
|
|
1323
|
-
});
|
|
1324
|
-
this.logger.warn({
|
|
1325
|
-
operation: 'overlay.provider_callback',
|
|
1326
|
-
outcome: 'terminal_evicted',
|
|
1327
|
-
txid,
|
|
1328
|
-
txStatus,
|
|
1329
|
-
competingTxs,
|
|
1330
|
-
report
|
|
1331
|
-
});
|
|
1332
|
-
return res.status(200).json({
|
|
1333
|
-
status: 'success',
|
|
1334
|
-
message: 'Terminal transaction status processed',
|
|
1335
|
-
data: {
|
|
1336
|
-
...report,
|
|
1337
|
-
txStatus,
|
|
1338
|
-
competingTxs
|
|
1339
|
-
}
|
|
1340
|
-
});
|
|
1341
|
-
}
|
|
1342
|
-
if (typeof merklePathHex !== 'string' || merklePathHex === '') {
|
|
1343
|
-
return res.status(202).json({ status: 'success', message: 'Transaction status received without proof' });
|
|
1344
|
-
}
|
|
1345
|
-
const merklePath = sdk_1.MerklePath.fromHex(merklePathHex);
|
|
1346
|
-
await engine.handleNewMerkleProof(txid, merklePath, blockHeight);
|
|
1347
|
-
this.logger.log({
|
|
1348
|
-
operation: 'overlay.provider_callback',
|
|
1349
|
-
outcome: 'proof_ingested',
|
|
1350
|
-
txid,
|
|
1351
|
-
blockHeight
|
|
1352
|
-
});
|
|
1353
|
-
return res.status(200).json({ status: 'success', message: 'Transaction status updated' });
|
|
1477
|
+
return await this.processArcIngest(engine, req, res);
|
|
1354
1478
|
}
|
|
1355
1479
|
catch (error) {
|
|
1356
|
-
|
|
1480
|
+
this.logger.error(chalk_1.default.red(`Error in /arc-ingest: error=${(0, overlay_1.serializeErrorForLog)(error)}`));
|
|
1357
1481
|
return res.status(400).json({
|
|
1358
1482
|
status: 'error',
|
|
1359
|
-
message: error
|
|
1483
|
+
message: publicErrorMessage(error)
|
|
1360
1484
|
});
|
|
1361
1485
|
}
|
|
1362
1486
|
})().catch(() => {
|
|
@@ -1384,7 +1508,7 @@ class OverlayExpress {
|
|
|
1384
1508
|
console.error(chalk_1.default.red('Error in /requestSyncResponse:'), error);
|
|
1385
1509
|
return res.status(400).json({
|
|
1386
1510
|
status: 'error',
|
|
1387
|
-
message: error
|
|
1511
|
+
message: publicErrorMessage(error)
|
|
1388
1512
|
});
|
|
1389
1513
|
}
|
|
1390
1514
|
})().catch(() => {
|
|
@@ -1406,7 +1530,7 @@ class OverlayExpress {
|
|
|
1406
1530
|
console.error(chalk_1.default.red('Error in /requestForeignGASPNode:'), error);
|
|
1407
1531
|
return res.status(400).json({
|
|
1408
1532
|
status: 'error',
|
|
1409
|
-
message: error
|
|
1533
|
+
message: publicErrorMessage(error)
|
|
1410
1534
|
});
|
|
1411
1535
|
}
|
|
1412
1536
|
})().catch(() => {
|
|
@@ -1425,7 +1549,7 @@ class OverlayExpress {
|
|
|
1425
1549
|
const readBasmTopic = (req) => {
|
|
1426
1550
|
const header = req.headers['x-bsv-topic'];
|
|
1427
1551
|
if (typeof header !== 'string' || header.length === 0) {
|
|
1428
|
-
throw new
|
|
1552
|
+
throw new PublicRequestError('Missing x-bsv-topic header');
|
|
1429
1553
|
}
|
|
1430
1554
|
return header;
|
|
1431
1555
|
};
|
|
@@ -1447,7 +1571,7 @@ class OverlayExpress {
|
|
|
1447
1571
|
console.error(chalk_1.default.red(`Error in ${path}:`), error);
|
|
1448
1572
|
return res.status(400).json({
|
|
1449
1573
|
status: 'error',
|
|
1450
|
-
message: error
|
|
1574
|
+
message: publicErrorMessage(error)
|
|
1451
1575
|
});
|
|
1452
1576
|
}
|
|
1453
1577
|
})().catch(() => {
|
|
@@ -1457,7 +1581,7 @@ class OverlayExpress {
|
|
|
1457
1581
|
};
|
|
1458
1582
|
const requireTxids = (value) => {
|
|
1459
1583
|
if (!Array.isArray(value) || !value.every(txid => typeof txid === 'string')) {
|
|
1460
|
-
throw new
|
|
1584
|
+
throw new PublicRequestError('txids must be an array of strings');
|
|
1461
1585
|
}
|
|
1462
1586
|
return value;
|
|
1463
1587
|
};
|
|
@@ -1490,6 +1614,7 @@ class OverlayExpress {
|
|
|
1490
1614
|
if (this.serverWallet !== undefined) {
|
|
1491
1615
|
const bsvAuth = (0, auth_express_middleware_1.createAuthMiddleware)({
|
|
1492
1616
|
wallet: this.serverWallet,
|
|
1617
|
+
sessionManager: this.authSessionManager,
|
|
1493
1618
|
allowUnauthenticated: true
|
|
1494
1619
|
});
|
|
1495
1620
|
this.app.use(bsvAuth);
|
|
@@ -1516,7 +1641,7 @@ class OverlayExpress {
|
|
|
1516
1641
|
const authHeader = req.headers.authorization;
|
|
1517
1642
|
if (typeof authHeader === 'string' && authHeader.startsWith('Bearer ')) {
|
|
1518
1643
|
const token = authHeader.substring('Bearer '.length);
|
|
1519
|
-
if (token
|
|
1644
|
+
if (secretMatches(token, this.adminToken)) {
|
|
1520
1645
|
next();
|
|
1521
1646
|
return;
|
|
1522
1647
|
}
|
|
@@ -1544,13 +1669,14 @@ class OverlayExpress {
|
|
|
1544
1669
|
this.app.get('/admin/stats', checkAdminAuth, (req, res) => {
|
|
1545
1670
|
;
|
|
1546
1671
|
(async () => {
|
|
1547
|
-
var _a, _b
|
|
1672
|
+
var _a, _b;
|
|
1673
|
+
var _c;
|
|
1548
1674
|
try {
|
|
1549
1675
|
const db = this.ensureMongo();
|
|
1550
1676
|
const [shipCount, slapCount, banStats] = await Promise.all([
|
|
1551
1677
|
db.collection('shipRecords').countDocuments(),
|
|
1552
1678
|
db.collection('slapRecords').countDocuments(),
|
|
1553
|
-
(
|
|
1679
|
+
(_c = (_a = this.banService) === null || _a === void 0 ? void 0 : _a.getStats()) !== null && _c !== void 0 ? _c : { domainBans: 0, outpointBans: 0, totalBans: 0 }
|
|
1554
1680
|
]);
|
|
1555
1681
|
return res.status(200).json({
|
|
1556
1682
|
status: 'success',
|
|
@@ -1558,7 +1684,7 @@ class OverlayExpress {
|
|
|
1558
1684
|
nodeName: this.name,
|
|
1559
1685
|
network: this.network,
|
|
1560
1686
|
uptime: this.startTime != null ? Date.now() - this.startTime.getTime() : 0,
|
|
1561
|
-
startedAt: (
|
|
1687
|
+
startedAt: (_b = this.startTime) === null || _b === void 0 ? void 0 : _b.toISOString(),
|
|
1562
1688
|
shipRecordCount: shipCount,
|
|
1563
1689
|
slapRecordCount: slapCount,
|
|
1564
1690
|
bannedDomains: banStats.domainBans,
|
|
@@ -1575,7 +1701,7 @@ class OverlayExpress {
|
|
|
1575
1701
|
catch (error) {
|
|
1576
1702
|
return res.status(400).json({
|
|
1577
1703
|
status: 'error',
|
|
1578
|
-
message: error
|
|
1704
|
+
message: publicErrorMessage(error)
|
|
1579
1705
|
});
|
|
1580
1706
|
}
|
|
1581
1707
|
})().catch(() => {
|
|
@@ -1618,7 +1744,7 @@ class OverlayExpress {
|
|
|
1618
1744
|
catch (error) {
|
|
1619
1745
|
return res.status(400).json({
|
|
1620
1746
|
status: 'error',
|
|
1621
|
-
message: error
|
|
1747
|
+
message: publicErrorMessage(error)
|
|
1622
1748
|
});
|
|
1623
1749
|
}
|
|
1624
1750
|
})().catch(() => {
|
|
@@ -1661,7 +1787,7 @@ class OverlayExpress {
|
|
|
1661
1787
|
catch (error) {
|
|
1662
1788
|
return res.status(400).json({
|
|
1663
1789
|
status: 'error',
|
|
1664
|
-
message: error
|
|
1790
|
+
message: publicErrorMessage(error)
|
|
1665
1791
|
});
|
|
1666
1792
|
}
|
|
1667
1793
|
})().catch(() => {
|
|
@@ -1674,8 +1800,9 @@ class OverlayExpress {
|
|
|
1674
1800
|
this.app.post('/admin/health-check', checkAdminAuth, (req, res) => {
|
|
1675
1801
|
;
|
|
1676
1802
|
(async () => {
|
|
1803
|
+
var _a;
|
|
1677
1804
|
try {
|
|
1678
|
-
const
|
|
1805
|
+
const url = (_a = req.body) === null || _a === void 0 ? void 0 : _a.url;
|
|
1679
1806
|
if (typeof url !== 'string' || url.length === 0) {
|
|
1680
1807
|
return res.status(400).json({ status: 'error', message: 'url is required' });
|
|
1681
1808
|
}
|
|
@@ -1686,7 +1813,7 @@ class OverlayExpress {
|
|
|
1686
1813
|
catch (error) {
|
|
1687
1814
|
return res.status(400).json({
|
|
1688
1815
|
status: 'error',
|
|
1689
|
-
message: error
|
|
1816
|
+
message: publicErrorMessage(error)
|
|
1690
1817
|
});
|
|
1691
1818
|
}
|
|
1692
1819
|
})().catch(() => {
|
|
@@ -1718,7 +1845,7 @@ class OverlayExpress {
|
|
|
1718
1845
|
catch (error) {
|
|
1719
1846
|
return res.status(400).json({
|
|
1720
1847
|
status: 'error',
|
|
1721
|
-
message: error
|
|
1848
|
+
message: publicErrorMessage(error)
|
|
1722
1849
|
});
|
|
1723
1850
|
}
|
|
1724
1851
|
})().catch(() => {
|
|
@@ -1748,7 +1875,7 @@ class OverlayExpress {
|
|
|
1748
1875
|
catch (error) {
|
|
1749
1876
|
return res.status(400).json({
|
|
1750
1877
|
status: 'error',
|
|
1751
|
-
message: error
|
|
1878
|
+
message: publicErrorMessage(error)
|
|
1752
1879
|
});
|
|
1753
1880
|
}
|
|
1754
1881
|
})().catch(() => {
|
|
@@ -1773,7 +1900,7 @@ class OverlayExpress {
|
|
|
1773
1900
|
catch (error) {
|
|
1774
1901
|
return res.status(400).json({
|
|
1775
1902
|
status: 'error',
|
|
1776
|
-
message: error
|
|
1903
|
+
message: publicErrorMessage(error)
|
|
1777
1904
|
});
|
|
1778
1905
|
}
|
|
1779
1906
|
})().catch(() => {
|
|
@@ -1815,7 +1942,7 @@ class OverlayExpress {
|
|
|
1815
1942
|
catch (error) {
|
|
1816
1943
|
return res.status(400).json({
|
|
1817
1944
|
status: 'error',
|
|
1818
|
-
message: error
|
|
1945
|
+
message: publicErrorMessage(error)
|
|
1819
1946
|
});
|
|
1820
1947
|
}
|
|
1821
1948
|
})().catch(() => {
|
|
@@ -1836,7 +1963,7 @@ class OverlayExpress {
|
|
|
1836
1963
|
console.error(chalk_1.default.red('Error in /admin/syncAdvertisements:'), error);
|
|
1837
1964
|
return res.status(400).json({
|
|
1838
1965
|
status: 'error',
|
|
1839
|
-
message: error
|
|
1966
|
+
message: publicErrorMessage(error)
|
|
1840
1967
|
});
|
|
1841
1968
|
}
|
|
1842
1969
|
})().catch(() => {
|
|
@@ -1860,7 +1987,7 @@ class OverlayExpress {
|
|
|
1860
1987
|
console.error(chalk_1.default.red('Error in /admin/startGASPSync:'), error);
|
|
1861
1988
|
return res.status(400).json({
|
|
1862
1989
|
status: 'error',
|
|
1863
|
-
message: error
|
|
1990
|
+
message: publicErrorMessage(error)
|
|
1864
1991
|
});
|
|
1865
1992
|
}
|
|
1866
1993
|
})().catch(() => {
|
|
@@ -1947,7 +2074,7 @@ class OverlayExpress {
|
|
|
1947
2074
|
console.error(chalk_1.default.red('Error in /admin/evictOutpoint:'), error);
|
|
1948
2075
|
return res.status(400).json({
|
|
1949
2076
|
status: 'error',
|
|
1950
|
-
message: error
|
|
2077
|
+
message: publicErrorMessage(error)
|
|
1951
2078
|
});
|
|
1952
2079
|
}
|
|
1953
2080
|
})().catch(() => {
|
|
@@ -1972,7 +2099,7 @@ class OverlayExpress {
|
|
|
1972
2099
|
console.error(chalk_1.default.red('Error in /admin/janitor:'), error);
|
|
1973
2100
|
return res.status(400).json({
|
|
1974
2101
|
status: 'error',
|
|
1975
|
-
message: error
|
|
2102
|
+
message: publicErrorMessage(error)
|
|
1976
2103
|
});
|
|
1977
2104
|
}
|
|
1978
2105
|
})().catch(() => {
|
|
@@ -1990,7 +2117,7 @@ class OverlayExpress {
|
|
|
1990
2117
|
this.logger.log(chalk_1.default.green('Knex migrations run'), result);
|
|
1991
2118
|
// 404 handler for all other routes
|
|
1992
2119
|
this.app.use((req, res) => {
|
|
1993
|
-
this.logger.log(chalk_1.default.red(
|
|
2120
|
+
this.logger.log(chalk_1.default.red(`404 Not Found: url=${(0, overlay_1.serializeLogValue)(req.url)}`));
|
|
1994
2121
|
res.status(404).json({
|
|
1995
2122
|
status: 'error',
|
|
1996
2123
|
code: 'ERR_ROUTE_NOT_FOUND',
|
|
@@ -1999,10 +2126,57 @@ class OverlayExpress {
|
|
|
1999
2126
|
});
|
|
2000
2127
|
await this.runStartupSync();
|
|
2001
2128
|
// Start listening on the configured port
|
|
2002
|
-
this.app.listen(this.port, () => {
|
|
2129
|
+
this.server = this.app.listen(this.port, () => {
|
|
2003
2130
|
this.isListening = true;
|
|
2004
2131
|
this.logger.log(chalk_1.default.green.bold(`${this.name} is ready and listening on local port ${this.port}`));
|
|
2005
2132
|
});
|
|
2133
|
+
(0, edgePolicy_js_1.configureHttpServer)(this.server, edgePolicy.environmentPrefix, edgePolicy.http);
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* Stops new HTTP work, background synchronization, and database clients.
|
|
2137
|
+
*
|
|
2138
|
+
* The operation is idempotent so multiple signal handlers or embedding
|
|
2139
|
+
* runtimes can share shutdown ownership safely.
|
|
2140
|
+
*/
|
|
2141
|
+
async close() {
|
|
2142
|
+
var _a;
|
|
2143
|
+
(_a = this.closePromise) !== null && _a !== void 0 ? _a : (this.closePromise = this.closeResources());
|
|
2144
|
+
await this.closePromise;
|
|
2145
|
+
}
|
|
2146
|
+
async closeResources() {
|
|
2147
|
+
var _a, _b, _c;
|
|
2148
|
+
var _d, _e;
|
|
2149
|
+
this.isListening = false;
|
|
2150
|
+
if (this.basmBlockPollTimer !== undefined) {
|
|
2151
|
+
clearInterval(this.basmBlockPollTimer);
|
|
2152
|
+
this.basmBlockPollTimer = undefined;
|
|
2153
|
+
}
|
|
2154
|
+
if (this.unprovenMaintenanceTimer !== undefined) {
|
|
2155
|
+
clearInterval(this.unprovenMaintenanceTimer);
|
|
2156
|
+
this.unprovenMaintenanceTimer = undefined;
|
|
2157
|
+
}
|
|
2158
|
+
(_a = this.reorgAdapter) === null || _a === void 0 ? void 0 : _a.stop();
|
|
2159
|
+
this.reorgAdapter = undefined;
|
|
2160
|
+
const server = this.server;
|
|
2161
|
+
this.server = undefined;
|
|
2162
|
+
const closeServer = server === undefined
|
|
2163
|
+
? Promise.resolve()
|
|
2164
|
+
: new Promise((resolve, reject) => {
|
|
2165
|
+
server.close(error => {
|
|
2166
|
+
if (error !== undefined)
|
|
2167
|
+
reject(error);
|
|
2168
|
+
else
|
|
2169
|
+
resolve();
|
|
2170
|
+
});
|
|
2171
|
+
});
|
|
2172
|
+
await closeServer;
|
|
2173
|
+
await Promise.all([
|
|
2174
|
+
(_d = (_b = this.knex) === null || _b === void 0 ? void 0 : _b.destroy()) !== null && _d !== void 0 ? _d : Promise.resolve(),
|
|
2175
|
+
(_e = (_c = this.mongoClient) === null || _c === void 0 ? void 0 : _c.close()) !== null && _e !== void 0 ? _e : Promise.resolve()
|
|
2176
|
+
]);
|
|
2177
|
+
this.knex = undefined;
|
|
2178
|
+
this.mongoClient = undefined;
|
|
2179
|
+
this.mongoDb = undefined;
|
|
2006
2180
|
}
|
|
2007
2181
|
/**
|
|
2008
2182
|
* Runs the post-listen startup work: advertiser init, advertisement sync,
|
|
@@ -2111,23 +2285,26 @@ class OverlayExpress {
|
|
|
2111
2285
|
}
|
|
2112
2286
|
/** Revalidate recent BASM anchors against the chain tracker, reconciling any reorg. */
|
|
2113
2287
|
async revalidateBASMAnchors() {
|
|
2114
|
-
var _a
|
|
2288
|
+
var _a;
|
|
2289
|
+
var _b;
|
|
2115
2290
|
try {
|
|
2116
|
-
const depth = (
|
|
2117
|
-
await ((
|
|
2291
|
+
const depth = (_b = this.engineConfig.reorgScanDepth) !== null && _b !== void 0 ? _b : this.reorgScanDepth;
|
|
2292
|
+
await ((_a = this.engine) === null || _a === void 0 ? void 0 : _a.revalidateRecentAnchors(depth));
|
|
2118
2293
|
}
|
|
2119
2294
|
catch (e) {
|
|
2120
2295
|
console.error(chalk_1.default.red('Failed to revalidate BASM anchors'), e);
|
|
2121
2296
|
}
|
|
2122
2297
|
}
|
|
2123
2298
|
startUnprovenMaintenance() {
|
|
2124
|
-
var _a, _b
|
|
2125
|
-
|
|
2299
|
+
var _a, _b;
|
|
2300
|
+
var _c;
|
|
2301
|
+
const intervalMs = (_c = this.engineConfig.unprovenMaintenanceIntervalMs) !== null && _c !== void 0 ? _c : this.unprovenMaintenanceIntervalMs;
|
|
2126
2302
|
if (intervalMs <= 0)
|
|
2127
2303
|
return;
|
|
2128
2304
|
const run = () => {
|
|
2129
2305
|
void (async () => {
|
|
2130
|
-
var _a
|
|
2306
|
+
var _a;
|
|
2307
|
+
var _b;
|
|
2131
2308
|
try {
|
|
2132
2309
|
const report = await ((_a = this.engine) === null || _a === void 0 ? void 0 : _a.maintainUnprovenTransactions({
|
|
2133
2310
|
thresholdBlocks: (_b = this.engineConfig.unprovenEvictionBlocks) !== null && _b !== void 0 ? _b : this.unprovenEvictionBlocks,
|
|
@@ -2142,7 +2319,7 @@ class OverlayExpress {
|
|
|
2142
2319
|
};
|
|
2143
2320
|
run();
|
|
2144
2321
|
this.unprovenMaintenanceTimer = setInterval(run, intervalMs);
|
|
2145
|
-
(
|
|
2322
|
+
(_b = (_a = this.unprovenMaintenanceTimer).unref) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
2146
2323
|
}
|
|
2147
2324
|
}
|
|
2148
2325
|
exports.default = OverlayExpress;
|