@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
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { LookupService, LookupFormula, AdmissionMode, SpendNotificationMode, OutputAdmittedByTopic, OutputSpent, LookupServiceMetaData } from '@bsv/overlay';
|
|
2
|
+
import { LookupQuestion } from '@bsv/sdk';
|
|
3
|
+
import { BanService } from './BanService.js';
|
|
4
|
+
/**
|
|
5
|
+
* Wraps a SHIP or SLAP LookupService to intercept outputAdmittedByTopic calls
|
|
6
|
+
* and block outputs whose domain or outpoint appears in the persistent ban list.
|
|
7
|
+
*
|
|
8
|
+
* This prevents GASP from re-syncing stale or banned tokens that were previously
|
|
9
|
+
* removed by the Janitor or an admin.
|
|
10
|
+
*/
|
|
11
|
+
export declare class BanAwareLookupWrapper implements LookupService {
|
|
12
|
+
private readonly wrapped;
|
|
13
|
+
private readonly banService;
|
|
14
|
+
private readonly protocol;
|
|
15
|
+
private readonly logger;
|
|
16
|
+
readonly admissionMode: AdmissionMode;
|
|
17
|
+
readonly spendNotificationMode: SpendNotificationMode;
|
|
18
|
+
constructor(wrapped: LookupService, banService: BanService, protocol: 'SHIP' | 'SLAP', logger?: typeof console);
|
|
19
|
+
/**
|
|
20
|
+
* Intercepts admission to check the ban list before delegating to the wrapped service.
|
|
21
|
+
* If the output's domain or outpoint is banned, the admission is silently blocked.
|
|
22
|
+
*/
|
|
23
|
+
outputAdmittedByTopic(payload: OutputAdmittedByTopic): Promise<void>;
|
|
24
|
+
outputSpent(payload: OutputSpent): Promise<void>;
|
|
25
|
+
outputNoLongerRetainedInHistory(txid: string, outputIndex: number, topic: string): Promise<void>;
|
|
26
|
+
outputEvicted(txid: string, outputIndex: number): Promise<void>;
|
|
27
|
+
lookup(question: LookupQuestion): Promise<LookupFormula>;
|
|
28
|
+
getDocumentation(): Promise<string>;
|
|
29
|
+
getMetaData(): Promise<LookupServiceMetaData>;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=BanAwareLookupWrapper.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BanAwareLookupWrapper.d.ts","sourceRoot":"","sources":["../../../src/BanAwareLookupWrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,WAAW,EACX,qBAAqB,EAEtB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAmB,cAAc,EAAE,MAAM,UAAU,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C;;;;;;GAMG;AACH,qBAAa,qBAAsB,YAAW,aAAa;IAKvD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAPzB,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;IACrC,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB,CAAA;IAErD,YACmB,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,MAAM,GAAE,OAAO,OAAiB,EAIlD;IAED;;;OAGG;IACG,qBAAqB,CAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA4B1E;IAEK,WAAW,CAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAItD;IAEK,+BAA+B,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAItG;IAEK,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErE;IAEK,MAAM,CAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAE9D;IAEK,gBAAgB,IAAK,OAAO,CAAC,MAAM,CAAC,CAEzC;IAEK,WAAW,IAAK,OAAO,CAAC,qBAAqB,CAAC,CAEnD;CACF"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.BanAwareLookupWrapper = void 0;
|
|
4
|
+
const overlay_1 = require("@bsv/overlay");
|
|
4
5
|
const sdk_1 = require("@bsv/sdk");
|
|
5
6
|
/**
|
|
6
7
|
* Wraps a SHIP or SLAP LookupService to intercept outputAdmittedByTopic calls
|
|
@@ -27,7 +28,7 @@ class BanAwareLookupWrapper {
|
|
|
27
28
|
const { txid, outputIndex, lockingScript } = payload;
|
|
28
29
|
// Check if the specific outpoint is banned
|
|
29
30
|
if (await this.banService.isOutpointBanned(txid, outputIndex)) {
|
|
30
|
-
this.logger.log(`[BAN] Blocked banned outpoint
|
|
31
|
+
this.logger.log(`[BAN] Blocked banned outpoint from lookup admission: txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)} protocol=${(0, overlay_1.serializeLogValue)(this.protocol)}`);
|
|
31
32
|
return;
|
|
32
33
|
}
|
|
33
34
|
// Try to parse the domain from PushDrop fields and check domain ban
|
|
@@ -36,7 +37,7 @@ class BanAwareLookupWrapper {
|
|
|
36
37
|
if (result.fields.length >= 3) {
|
|
37
38
|
const domain = sdk_1.Utils.toUTF8(result.fields[2]);
|
|
38
39
|
if (await this.banService.isDomainBanned(domain)) {
|
|
39
|
-
this.logger.log(`[BAN] Blocked banned domain
|
|
40
|
+
this.logger.log(`[BAN] Blocked banned domain from lookup admission: domain=${(0, overlay_1.serializeLogValue)(domain)} protocol=${(0, overlay_1.serializeLogValue)(this.protocol)} txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
40
41
|
return;
|
|
41
42
|
}
|
|
42
43
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BanAwareLookupWrapper.js","sourceRoot":"","sources":["../../../src/BanAwareLookupWrapper.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"BanAwareLookupWrapper.js","sourceRoot":"","sources":["../../../src/BanAwareLookupWrapper.ts"],"names":[],"mappings":";;;AAAA,0CASqB;AACrB,kCAA0D;AAG1D;;;;;;GAMG;AACH;IAIE,YACmB,OAAsB,EACtB,UAAsB,EACtB,QAAyB,EACzB,MAAM,GAAmB,OAAO;uBAHhC,OAAO;0BACP,UAAU;wBACV,QAAQ;sBACR,MAAM;QAEvB,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;QAC1C,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAA;IAC5D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAE,OAA8B;QACzD,IAAI,OAAO,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YACtC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,OAAO,CAAA;YAEpD,2CAA2C;YAC3C,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6DAA6D,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,aAAa,IAAA,2BAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;gBAClM,OAAM;YACR,CAAC;YAED,oEAAoE;YACpE,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,cAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBAC7C,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBAC9B,MAAM,MAAM,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC7C,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;wBACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6DAA6D,IAAA,2BAAiB,EAAC,MAAM,CAAC,aAAa,IAAA,2BAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;wBACpO,OAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,2EAA2E;gBAC3E,sCAAsC;YACxC,CAAC;QACH,CAAC;QAED,kCAAkC;QAClC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;IAC1D,CAAC;IAED,KAAK,CAAC,WAAW,CAAE,OAAoB;QACrC,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,UAAU,EAAE,CAAC;YACnD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,+BAA+B,CAAE,IAAY,EAAE,WAAmB,EAAE,KAAa;QACrF,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,+BAA+B,KAAK,UAAU,EAAE,CAAC;YACvE,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB;QACpD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,MAAM,CAAE,QAAwB;QACpC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC5C,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,WAAW;QACf,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;IACzC,CAAC;CACF"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { TopicManager } from '@bsv/overlay';
|
|
2
|
+
import { AdmittanceInstructions } from '@bsv/sdk';
|
|
3
|
+
import { BanService } from './BanService.js';
|
|
4
|
+
/**
|
|
5
|
+
* Filters banned SHIP or SLAP advertisement outputs before the overlay engine
|
|
6
|
+
* admits them into topic storage.
|
|
7
|
+
*/
|
|
8
|
+
export declare class BanAwareTopicManager implements TopicManager {
|
|
9
|
+
private readonly wrapped;
|
|
10
|
+
private readonly banService;
|
|
11
|
+
private readonly protocol;
|
|
12
|
+
private readonly logger;
|
|
13
|
+
constructor(wrapped: TopicManager, banService: BanService, protocol: 'SHIP' | 'SLAP', logger?: typeof console);
|
|
14
|
+
identifyAdmissibleOutputs(beef: number[], previousCoins: number[], offChainValues?: number[], mode?: 'historical-tx' | 'current-tx' | 'historical-tx-no-spv'): Promise<AdmittanceInstructions>;
|
|
15
|
+
identifyNeededInputs(beef: number[], offChainValues?: number[]): Promise<Array<{
|
|
16
|
+
txid: string;
|
|
17
|
+
outputIndex: number;
|
|
18
|
+
}>>;
|
|
19
|
+
getDocumentation(): Promise<string>;
|
|
20
|
+
getMetaData(): Promise<{
|
|
21
|
+
name: string;
|
|
22
|
+
shortDescription: string;
|
|
23
|
+
iconURL?: string;
|
|
24
|
+
version?: string;
|
|
25
|
+
informationURL?: string;
|
|
26
|
+
}>;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=BanAwareTopicManager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BanAwareTopicManager.d.ts","sourceRoot":"","sources":["../../../src/BanAwareTopicManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,MAAM,cAAc,CAAA;AAC9D,OAAO,EAAE,sBAAsB,EAAgC,MAAM,UAAU,CAAA;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,YAAY;IAErD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJzB,YACmB,OAAO,EAAE,YAAY,EACrB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,MAAM,GAAE,OAAO,OAAiB,EAC/C;IAEE,yBAAyB,CAC7B,IAAI,EAAE,MAAM,EAAE,EACd,aAAa,EAAE,MAAM,EAAE,EACvB,cAAc,CAAC,EAAE,MAAM,EAAE,EACzB,IAAI,CAAC,EAAE,eAAe,GAAG,YAAY,GAAG,sBAAsB,GAC7D,OAAO,CAAC,sBAAsB,CAAC,CA2CjC;IAEK,oBAAoB,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAK5H;IAEK,gBAAgB,IAAK,OAAO,CAAC,MAAM,CAAC,CAEzC;IAEK,WAAW,IAAK,OAAO,CAAC;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAC,CAED;CACF"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.BanAwareTopicManager = void 0;
|
|
4
|
+
const overlay_1 = require("@bsv/overlay");
|
|
4
5
|
const sdk_1 = require("@bsv/sdk");
|
|
5
6
|
/**
|
|
6
7
|
* Filters banned SHIP or SLAP advertisement outputs before the overlay engine
|
|
@@ -28,7 +29,7 @@ class BanAwareTopicManager {
|
|
|
28
29
|
const outputsToAdmit = [];
|
|
29
30
|
for (const outputIndex of instructions.outputsToAdmit) {
|
|
30
31
|
if (await this.banService.isOutpointBanned(txid, outputIndex)) {
|
|
31
|
-
this.logger.log(`[BAN] Blocked banned outpoint
|
|
32
|
+
this.logger.log(`[BAN] Blocked banned outpoint from topic admittance: txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)} protocol=${(0, overlay_1.serializeLogValue)(this.protocol)}`);
|
|
32
33
|
continue;
|
|
33
34
|
}
|
|
34
35
|
const output = tx.outputs[outputIndex];
|
|
@@ -39,7 +40,7 @@ class BanAwareTopicManager {
|
|
|
39
40
|
if (result.fields.length >= 3 && sdk_1.Utils.toUTF8(result.fields[0]) === this.protocol) {
|
|
40
41
|
const domain = sdk_1.Utils.toUTF8(result.fields[2]);
|
|
41
42
|
if (await this.banService.isDomainBanned(domain)) {
|
|
42
|
-
this.logger.log(`[BAN] Blocked banned domain
|
|
43
|
+
this.logger.log(`[BAN] Blocked banned domain from topic admittance: domain=${(0, overlay_1.serializeLogValue)(domain)} protocol=${(0, overlay_1.serializeLogValue)(this.protocol)} txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
43
44
|
continue;
|
|
44
45
|
}
|
|
45
46
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BanAwareTopicManager.js","sourceRoot":"","sources":["../../../src/BanAwareTopicManager.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"BanAwareTopicManager.js","sourceRoot":"","sources":["../../../src/BanAwareTopicManager.ts"],"names":[],"mappings":";;;AAAA,0CAA8D;AAC9D,kCAA+E;AAG/E;;;GAGG;AACH;IACE,YACmB,OAAqB,EACrB,UAAsB,EACtB,QAAyB,EACzB,MAAM,GAAmB,OAAO;uBAHhC,OAAO;0BACP,UAAU;wBACV,QAAQ;sBACR,MAAM;IACtB,CAAC;IAEJ,KAAK,CAAC,yBAAyB,CAC7B,IAAc,EACd,aAAuB,EACvB,cAAyB,EACzB,IAA8D;QAE9D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,IAAI,CAAC,CAAA;QAC5G,IAAI,YAAY,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,YAAY,CAAA;QAEjE,IAAI,EAAe,CAAA;QACnB,IAAI,CAAC;YACH,EAAE,GAAG,iBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,YAAY,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;QACzB,MAAM,cAAc,GAAa,EAAE,CAAA;QAEnC,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,cAAc,EAAE,CAAC;YACtD,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6DAA6D,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,aAAa,IAAA,2BAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;gBAClM,SAAQ;YACV,CAAC;YAED,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;YACtC,IAAI,MAAM,KAAK,SAAS;gBAAE,SAAQ;YAElC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,cAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBACpD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClF,MAAM,MAAM,GAAG,WAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;oBAC7C,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;wBACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6DAA6D,IAAA,2BAAiB,EAAC,MAAM,CAAC,aAAa,IAAA,2BAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;wBACpO,SAAQ;oBACV,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,yEAAyE;YAC3E,CAAC;YAED,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAClC,CAAC;QAED,OAAO;YACL,GAAG,YAAY;YACf,cAAc;SACf,CAAA;IACH,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAE,IAAc,EAAE,cAAyB;QACnE,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,KAAK,UAAU,EAAE,CAAC;YAC5D,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;QACtE,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,WAAW;QAOf,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;IACzC,CAAC;CACF"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { Db } from 'mongodb';
|
|
2
|
+
/**
|
|
3
|
+
* Represents a banned record in the persistent ban list.
|
|
4
|
+
* Bans survive server restarts, GASP re-syncs, and janitor runs.
|
|
5
|
+
*/
|
|
6
|
+
export interface BannedRecord {
|
|
7
|
+
type: 'domain' | 'outpoint';
|
|
8
|
+
/** For domain bans: the domain URL. For outpoint bans: "txid.outputIndex" */
|
|
9
|
+
value: string;
|
|
10
|
+
/** For outpoint bans, the associated domain (for reference) */
|
|
11
|
+
domain?: string;
|
|
12
|
+
/** Human-readable reason for the ban */
|
|
13
|
+
reason?: string;
|
|
14
|
+
/** When the ban was created */
|
|
15
|
+
bannedAt: Date;
|
|
16
|
+
/** Identity key of the admin who created the ban */
|
|
17
|
+
bannedBy?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* BanService provides a persistent ban list stored in MongoDB.
|
|
21
|
+
*
|
|
22
|
+
* When the Janitor or an admin removes a SHIP/SLAP token, the associated
|
|
23
|
+
* domain or outpoint can be added to the ban list. The BanAwareLookupWrapper
|
|
24
|
+
* checks this list before admitting new outputs, preventing GASP from
|
|
25
|
+
* re-syncing previously removed stale tokens.
|
|
26
|
+
*/
|
|
27
|
+
export declare class BanService {
|
|
28
|
+
private readonly bans;
|
|
29
|
+
constructor(db: Db);
|
|
30
|
+
/**
|
|
31
|
+
* Sanitizes a value for use in MongoDB queries, preventing NoSQL injection.
|
|
32
|
+
* Ensures the value is a plain string and rejects objects/arrays that could
|
|
33
|
+
* contain MongoDB operators like $ne, $gt, etc.
|
|
34
|
+
*/
|
|
35
|
+
private sanitize;
|
|
36
|
+
/**
|
|
37
|
+
* Creates indexes for efficient ban lookups.
|
|
38
|
+
*/
|
|
39
|
+
ensureIndexes(): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Bans a domain, preventing any SHIP/SLAP tokens referencing it from being stored.
|
|
42
|
+
*/
|
|
43
|
+
banDomain(domain: string, reason?: string, bannedBy?: string): Promise<void>;
|
|
44
|
+
/**
|
|
45
|
+
* Removes a domain ban.
|
|
46
|
+
*/
|
|
47
|
+
unbanDomain(domain: string): Promise<void>;
|
|
48
|
+
/**
|
|
49
|
+
* Checks if a domain is banned.
|
|
50
|
+
*/
|
|
51
|
+
isDomainBanned(domain: string): Promise<boolean>;
|
|
52
|
+
/**
|
|
53
|
+
* Bans a specific outpoint (txid.outputIndex), preventing it from being re-admitted.
|
|
54
|
+
*/
|
|
55
|
+
banOutpoint(txid: string, outputIndex: number, reason?: string, domain?: string, bannedBy?: string): Promise<void>;
|
|
56
|
+
/**
|
|
57
|
+
* Removes an outpoint ban.
|
|
58
|
+
*/
|
|
59
|
+
unbanOutpoint(txid: string, outputIndex: number): Promise<void>;
|
|
60
|
+
/**
|
|
61
|
+
* Checks if a specific outpoint is banned.
|
|
62
|
+
*/
|
|
63
|
+
isOutpointBanned(txid: string, outputIndex: number): Promise<boolean>;
|
|
64
|
+
/**
|
|
65
|
+
* Lists all bans, optionally filtered by type.
|
|
66
|
+
*/
|
|
67
|
+
listBans(type?: 'domain' | 'outpoint'): Promise<BannedRecord[]>;
|
|
68
|
+
/**
|
|
69
|
+
* Removes a ban by type and value.
|
|
70
|
+
*/
|
|
71
|
+
removeBan(type: 'domain' | 'outpoint', value: string): Promise<void>;
|
|
72
|
+
/**
|
|
73
|
+
* Returns ban statistics.
|
|
74
|
+
*/
|
|
75
|
+
getStats(): Promise<{
|
|
76
|
+
domainBans: number;
|
|
77
|
+
outpointBans: number;
|
|
78
|
+
totalBans: number;
|
|
79
|
+
}>;
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=BanService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BanService.d.ts","sourceRoot":"","sources":["../../../src/BanService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAc,MAAM,SAAS,CAAA;AAExC;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAA;IAC3B,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAA;IACb,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,QAAQ,EAAE,IAAI,CAAA;IACd,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;GAOG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA0B;IAE/C,YAAa,EAAE,EAAE,EAAE,EAElB;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAOhB;;OAEG;IACG,aAAa,IAAK,OAAO,CAAC,IAAI,CAAC,CAGpC;IAED;;OAEG;IACG,SAAS,CAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAelF;IAED;;OAEG;IACG,WAAW,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhD;IAED;;OAEG;IACG,cAAc,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAGtD;IAED;;OAEG;IACG,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBxH;IAED;;OAEG;IACG,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrE;IAED;;OAEG;IACG,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAI3E;IAED;;OAEG;IACG,QAAQ,CAAE,IAAI,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAGrE;IAED;;OAEG;IACG,SAAS,CAAE,IAAI,EAAE,QAAQ,GAAG,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1E;IAED;;OAEG;IACG,QAAQ,IAAK,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAM1F;CACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BanService.js","sourceRoot":"","sources":["../../../src/BanService.ts"],"names":[],"mappings":";;;AAoBA;;;;;;;GAOG;AACH
|
|
1
|
+
{"version":3,"file":"BanService.js","sourceRoot":"","sources":["../../../src/BanService.ts"],"names":[],"mappings":";;;AAoBA;;;;;;;GAOG;AACH;IAGE,YAAa,EAAM;QACjB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,UAAU,CAAe,eAAe,CAAC,CAAA;IAC1D,CAAC;IAED;;;;OAIG;IACK,QAAQ,CAAE,KAAc;QAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAA;QAC/D,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACpE,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAE,MAAc,EAAE,MAAe,EAAE,QAAiB;QACjE,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QACxC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,EACrC;YACE,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,iBAAiB;gBACnC,QAAQ,EAAE,IAAI,IAAI,EAAE;gBACpB,QAAQ;aACT;SACF,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAE,MAAc;QAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAE,MAAc;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACxF,OAAO,MAAM,KAAK,IAAI,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmB,EAAE,MAAe,EAAE,MAAe,EAAE,QAAiB;QACvG,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAA;QAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,EAC3B;YACE,IAAI,EAAE;gBACJ,IAAI,EAAE,UAAU;gBAChB,KAAK;gBACL,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC1D,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,iBAAiB;gBACnC,QAAQ,EAAE,IAAI,IAAI,EAAE;gBACpB,QAAQ;aACT;SACF,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAE,IAAY,EAAE,WAAmB;QACpD,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAA;QAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IACxD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAE,IAAY,EAAE,WAAmB;QACvD,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAA;QAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;QACnE,OAAO,MAAM,KAAK,IAAI,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAE,IAA4B;QAC1C,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACtD,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAE,IAA2B,EAAE,KAAa;QACzD,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAA0B,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAChH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;SAC/C,CAAC,CAAA;QACF,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,GAAG,YAAY,EAAE,CAAA;IAC3E,CAAC;CACF"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { ChainTracker } from '@bsv/sdk';
|
|
2
|
+
export interface ChaintracksProviderConfig {
|
|
3
|
+
apiPrefix?: string;
|
|
4
|
+
fetch?: typeof fetch;
|
|
5
|
+
}
|
|
6
|
+
export interface ChaintracksHeader {
|
|
7
|
+
height: number;
|
|
8
|
+
hash: string;
|
|
9
|
+
merkleRoot: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Minimal go-chaintracks HTTP client for Overlay Express.
|
|
13
|
+
*
|
|
14
|
+
* It intentionally implements the SDK ChainTracker surface plus header lookup,
|
|
15
|
+
* which is enough for proof validation, BASM headers, and reorg stream URL
|
|
16
|
+
* construction without depending on wallet-toolbox client export timing.
|
|
17
|
+
*/
|
|
18
|
+
export declare class ChaintracksProvider implements ChainTracker {
|
|
19
|
+
private readonly baseUrl;
|
|
20
|
+
private readonly fetcher;
|
|
21
|
+
constructor(url: string, config?: ChaintracksProviderConfig);
|
|
22
|
+
currentHeight(): Promise<number>;
|
|
23
|
+
isValidRootForHeight(root: string, height: number): Promise<boolean>;
|
|
24
|
+
findHeaderForHeight(height: number): Promise<ChaintracksHeader | undefined>;
|
|
25
|
+
reorgStreamUrl(): string;
|
|
26
|
+
private getJson;
|
|
27
|
+
private getJsonOrUndefined;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=ChaintracksProvider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ChaintracksProvider.d.ts","sourceRoot":"","sources":["../../../src/ChaintracksProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB;AAeD;;;;;;GAMG;AACH,qBAAa,mBAAoB,YAAW,YAAY;IACtD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IAEtC,YAAa,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,yBAA8B,EAG/D;IAEK,aAAa,IAAK,OAAO,CAAC,MAAM,CAAC,CAGtC;IAEK,oBAAoB,CAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG1E;IAEK,mBAAmB,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAEjF;IAED,cAAc,IAAK,MAAM,CAExB;YAEa,OAAO;YAQP,kBAAkB;CAUjC"}
|
|
@@ -34,7 +34,7 @@ class ChaintracksProvider {
|
|
|
34
34
|
}
|
|
35
35
|
async isValidRootForHeight(root, height) {
|
|
36
36
|
const header = await this.findHeaderForHeight(height);
|
|
37
|
-
return header
|
|
37
|
+
return (header === null || header === void 0 ? void 0 : header.merkleRoot) === root;
|
|
38
38
|
}
|
|
39
39
|
async findHeaderForHeight(height) {
|
|
40
40
|
return await this.getJsonOrUndefined(`/header/height/${height}`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ChaintracksProvider.js","sourceRoot":"","sources":["../../../src/ChaintracksProvider.ts"],"names":[],"mappings":";;;AAaA,SAAS,OAAO,CAAE,GAAW;IAC3B,IAAI,OAAO,GAAG,GAAG,CAAA;IACjB,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,UAAU,CAAE,MAAc;IACjC,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,EAAE,CAAA;IAC5B,IAAI,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAA;IAC5D,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;GAMG;AACH
|
|
1
|
+
{"version":3,"file":"ChaintracksProvider.js","sourceRoot":"","sources":["../../../src/ChaintracksProvider.ts"],"names":[],"mappings":";;;AAaA,SAAS,OAAO,CAAE,GAAW;IAC3B,IAAI,OAAO,GAAG,GAAG,CAAA;IACjB,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,UAAU,CAAE,MAAc;IACjC,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,EAAE,CAAA;IAC5B,IAAI,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAA;IAC5D,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;GAMG;AACH;IAIE,YAAa,GAAW,EAAE,MAAM,GAA8B,EAAE;;QAC9D,IAAI,CAAC,OAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,OAAC,MAAM,CAAC,SAAS,mCAAI,iBAAiB,CAAC,EAAE,CAAA;QACpF,IAAI,CAAC,OAAO,SAAG,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,SAAS,CAAC,CAAA;QAClE,OAAO,QAAQ,CAAC,MAAM,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAE,IAAY,EAAE,MAAc;QACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;QACrD,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,MAAK,IAAI,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAE,MAAc;QACvC,OAAO,MAAM,IAAI,CAAC,kBAAkB,CAAoB,kBAAkB,MAAM,EAAE,CAAC,CAAA;IACrF,CAAC;IAED,cAAc;QACZ,OAAO,GAAG,IAAI,CAAC,OAAO,eAAe,CAAA;IACvC,CAAC;IAEO,KAAK,CAAC,OAAO,CAAI,IAAY;QACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAI,IAAI,CAAC,CAAA;QACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAI,IAAY;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;YAC5D,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SACxC,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,SAAS,CAAA;QAC7C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,KAAK,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;QACtG,CAAC;QACD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAO,CAAA;IACnC,CAAC;CACF"}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Db } from 'mongodb';
|
|
2
|
+
import { BanService } from './BanService.js';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for the Janitor Service
|
|
5
|
+
*/
|
|
6
|
+
export interface JanitorConfig {
|
|
7
|
+
mongoDb: Db;
|
|
8
|
+
logger?: typeof console;
|
|
9
|
+
requestTimeoutMs?: number;
|
|
10
|
+
hostDownRevokeScore?: number;
|
|
11
|
+
/** Optional BanService for persisting bans when hosts are removed */
|
|
12
|
+
banService?: BanService;
|
|
13
|
+
/** Whether to auto-ban domains when they exceed the down threshold (default: true) */
|
|
14
|
+
autoBanOnRemoval?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* Permit loopback/private IPs, HTTP, and non-standard ports for isolated
|
|
17
|
+
* development environments. Never enable this on an internet-facing node.
|
|
18
|
+
*/
|
|
19
|
+
allowPrivateHosts?: boolean;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Health status of a single record
|
|
23
|
+
*/
|
|
24
|
+
export interface HostHealthResult {
|
|
25
|
+
txid: string;
|
|
26
|
+
outputIndex: number;
|
|
27
|
+
domain: string;
|
|
28
|
+
topic?: string;
|
|
29
|
+
service?: string;
|
|
30
|
+
identityKey?: string;
|
|
31
|
+
createdAt?: Date;
|
|
32
|
+
healthy: boolean;
|
|
33
|
+
downCount: number;
|
|
34
|
+
responseTimeMs?: number;
|
|
35
|
+
statusCode?: number;
|
|
36
|
+
error?: string;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Summary report from a janitor run
|
|
40
|
+
*/
|
|
41
|
+
export interface JanitorReport {
|
|
42
|
+
startedAt: Date;
|
|
43
|
+
completedAt: Date;
|
|
44
|
+
durationMs: number;
|
|
45
|
+
shipResults: HostHealthResult[];
|
|
46
|
+
slapResults: HostHealthResult[];
|
|
47
|
+
summary: {
|
|
48
|
+
totalChecked: number;
|
|
49
|
+
healthy: number;
|
|
50
|
+
unhealthy: number;
|
|
51
|
+
removed: number;
|
|
52
|
+
banned: number;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* JanitorService runs health checks on SHIP and SLAP outputs.
|
|
57
|
+
* It validates domain names and checks /health endpoints to ensure services are operational.
|
|
58
|
+
*
|
|
59
|
+
* When a service is down, it increments a "down" counter. When healthy, it decrements.
|
|
60
|
+
* If the down counter reaches hostDownRevokeScore, the output is deleted and optionally
|
|
61
|
+
* the domain is added to the persistent ban list to prevent GASP re-sync.
|
|
62
|
+
*/
|
|
63
|
+
export declare class JanitorService {
|
|
64
|
+
private readonly mongoDb;
|
|
65
|
+
private readonly logger;
|
|
66
|
+
private readonly requestTimeoutMs;
|
|
67
|
+
private readonly hostDownRevokeScore;
|
|
68
|
+
private readonly banService?;
|
|
69
|
+
private readonly autoBanOnRemoval;
|
|
70
|
+
private readonly allowPrivateHosts;
|
|
71
|
+
constructor(config: JanitorConfig);
|
|
72
|
+
/**
|
|
73
|
+
* Runs a full pass of health checks on all SHIP and SLAP outputs.
|
|
74
|
+
* Returns a detailed report of the results.
|
|
75
|
+
*/
|
|
76
|
+
run(): Promise<JanitorReport>;
|
|
77
|
+
/**
|
|
78
|
+
* Checks a single URL's health endpoint. Used by the admin dashboard for on-demand checks.
|
|
79
|
+
*/
|
|
80
|
+
checkHost(url: string): Promise<{
|
|
81
|
+
healthy: boolean;
|
|
82
|
+
responseTimeMs: number;
|
|
83
|
+
statusCode?: number;
|
|
84
|
+
error?: string;
|
|
85
|
+
}>;
|
|
86
|
+
/**
|
|
87
|
+
* Gets health status for all records without modifying them.
|
|
88
|
+
* Used by the dashboard to display current state.
|
|
89
|
+
*/
|
|
90
|
+
getHealthStatus(): Promise<{
|
|
91
|
+
ship: HostHealthResult[];
|
|
92
|
+
slap: HostHealthResult[];
|
|
93
|
+
}>;
|
|
94
|
+
/**
|
|
95
|
+
* Checks all outputs for a specific collection and returns results.
|
|
96
|
+
*/
|
|
97
|
+
private checkTopicOutputs;
|
|
98
|
+
/**
|
|
99
|
+
* Checks a single output for health and returns the result.
|
|
100
|
+
*/
|
|
101
|
+
private checkOutput;
|
|
102
|
+
/**
|
|
103
|
+
* Extracts URL from output record
|
|
104
|
+
*/
|
|
105
|
+
private extractURLFromOutput;
|
|
106
|
+
/** Reject private/special IPv4 address space that could reach local services. */
|
|
107
|
+
private isPublicIPv4;
|
|
108
|
+
/** Reject non-global IPv6 address space, including IPv4-mapped addresses. */
|
|
109
|
+
private isPublicIPv6;
|
|
110
|
+
/**
|
|
111
|
+
* Validates the outbound health-check target. Production defaults require
|
|
112
|
+
* HTTPS, a public host, no credentials, and the standard TLS port. Redirects
|
|
113
|
+
* are also disabled in checkHost so an allowed target cannot bounce a
|
|
114
|
+
* request into an internal service.
|
|
115
|
+
*/
|
|
116
|
+
private isValidDomain;
|
|
117
|
+
/**
|
|
118
|
+
* Handles a healthy output by decrementing its down counter
|
|
119
|
+
*/
|
|
120
|
+
private handleHealthyOutput;
|
|
121
|
+
/**
|
|
122
|
+
* Handles an unhealthy output by incrementing its down counter.
|
|
123
|
+
* If the threshold is reached, deletes the record and optionally bans the domain.
|
|
124
|
+
* Returns true if the record was removed.
|
|
125
|
+
*/
|
|
126
|
+
private handleUnhealthyOutput;
|
|
127
|
+
}
|
|
128
|
+
//# sourceMappingURL=JanitorService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"JanitorService.d.ts","sourceRoot":"","sources":["../../../src/JanitorService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAA;AAG5B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,EAAE,CAAA;IACX,MAAM,CAAC,EAAE,OAAO,OAAO,CAAA;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,qEAAqE;IACrE,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,sFAAsF;IACtF,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,IAAI,CAAA;IACf,WAAW,EAAE,IAAI,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,gBAAgB,EAAE,CAAA;IAC/B,WAAW,EAAE,gBAAgB,EAAE,CAAA;IAC/B,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAI;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAY;IACxC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAE3C,YAAa,MAAM,EAAE,aAAa,EAQjC;IAED;;;OAGG;IACG,GAAG,IAAK,OAAO,CAAC,aAAa,CAAC,CA0CnC;IAED;;OAEG;IACG,SAAS,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CA2DxH;IAED;;;OAGG;IACG,eAAe,IAAK,OAAO,CAAC;QAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;QAAC,IAAI,EAAE,gBAAgB,EAAE,CAAA;KAAE,CAAC,CAgCxF;IAED;;OAEG;YACW,iBAAiB;IAiC/B;;OAEG;YACW,WAAW;IA4DzB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAyB5B,iFAAiF;IACjF,OAAO,CAAC,YAAY;IAoBpB,6EAA6E;IAC7E,OAAO,CAAC,YAAY;IAmBpB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IA0CrB;;OAEG;YACW,mBAAmB;IAcjC;;;;OAIG;YACW,qBAAqB;CA0CpC"}
|