@bsv/overlay-express 2.2.1 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -0
- package/dist/cjs/mod.js +10 -1
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +12 -11
- package/dist/cjs/src/BanAwareDiscoveryStorage.js +78 -0
- package/dist/cjs/src/BanAwareDiscoveryStorage.js.map +1 -0
- package/dist/cjs/src/BanAwareTopicManager.js +71 -0
- package/dist/cjs/src/BanAwareTopicManager.js.map +1 -0
- package/dist/cjs/src/OverlayExpress.js +375 -96
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/OverlayMonitor.js +464 -0
- package/dist/cjs/src/OverlayMonitor.js.map +1 -0
- package/dist/cjs/src/ReorgStream.js +193 -0
- package/dist/cjs/src/ReorgStream.js.map +1 -0
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/mod.js +3 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/BanAwareDiscoveryStorage.js +79 -0
- package/dist/esm/src/BanAwareDiscoveryStorage.js.map +1 -0
- package/dist/esm/src/BanAwareTopicManager.js +71 -0
- package/dist/esm/src/BanAwareTopicManager.js.map +1 -0
- package/dist/esm/src/OverlayExpress.js +375 -94
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/OverlayMonitor.js +458 -0
- package/dist/esm/src/OverlayMonitor.js.map +1 -0
- package/dist/esm/src/ReorgStream.js +190 -0
- package/dist/esm/src/ReorgStream.js.map +1 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/mod.d.ts +4 -1
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/BanAwareDiscoveryStorage.d.ts +36 -0
- package/dist/types/src/BanAwareDiscoveryStorage.d.ts.map +1 -0
- package/dist/types/src/BanAwareTopicManager.d.ts +28 -0
- package/dist/types/src/BanAwareTopicManager.d.ts.map +1 -0
- package/dist/types/src/OverlayExpress.d.ts +82 -4
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/OverlayMonitor.d.ts +169 -0
- package/dist/types/src/OverlayMonitor.d.ts.map +1 -0
- package/dist/types/src/ReorgStream.d.ts +74 -0
- package/dist/types/src/ReorgStream.d.ts.map +1 -0
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/mod.ts +20 -1
- package/package.json +12 -11
- package/src/BanAwareDiscoveryStorage.ts +91 -0
- package/src/BanAwareTopicManager.ts +87 -0
- package/src/OverlayExpress.ts +461 -102
- package/src/OverlayMonitor.ts +657 -0
- package/src/ReorgStream.ts +221 -0
- package/src/__tests__/BanAwareDiscoveryStorage.test.ts +131 -0
- package/src/__tests__/BanAwareTopicManager.test.ts +132 -0
- package/src/__tests__/OverlayExpress.test.ts +86 -1
- package/src/__tests__/OverlayMonitor.test.ts +181 -0
- package/src/__tests__/ReorgStream.test.ts +66 -0
package/dist/types/mod.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
export { default, type EngineConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus } from './src/OverlayExpress.js';
|
|
1
|
+
export { default, type EngineConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus, type TopicAnchorHeaderResolver } from './src/OverlayExpress.js';
|
|
2
2
|
export { BanService, type BannedRecord } from './src/BanService.js';
|
|
3
3
|
export { BanAwareLookupWrapper } from './src/BanAwareLookupWrapper.js';
|
|
4
|
+
export { BanAwareTopicManager } from './src/BanAwareTopicManager.js';
|
|
5
|
+
export { BanAwareSHIPStorage, BanAwareSLAPStorage } from './src/BanAwareDiscoveryStorage.js';
|
|
4
6
|
export { JanitorService, type JanitorConfig, type JanitorReport, type HostHealthResult } from './src/JanitorService.js';
|
|
7
|
+
export { OverlayMonitor, analyzeOverlayAnchorTip, analyzeOverlayLookupResponse, type OverlayAnchorProbe, type OverlayAnchorProbeResult, type OverlayLookupOutputSummary, type OverlayLookupProbe, type OverlayLookupProbeResult, type OverlayMonitorConfig, type OverlayMonitorLogger, type OverlayMonitorReport, type OverlayMonitorTarget, type OverlayMonitorThresholds, type OverlayMonitorWarning } from './src/OverlayMonitor.js';
|
|
5
8
|
//# sourceMappingURL=mod.d.ts.map
|
package/dist/types/mod.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,YAAY,
|
|
1
|
+
{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AAC5F,OAAO,EAAE,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AACvH,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,4BAA4B,EAC5B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC3B,MAAM,yBAAyB,CAAA"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import * as DiscoveryServices from '@bsv/overlay-discovery-services';
|
|
2
|
+
import { BanService } from './BanService.js';
|
|
3
|
+
type SHIPStorage = InstanceType<typeof DiscoveryServices.SHIPStorage>;
|
|
4
|
+
type SLAPStorage = InstanceType<typeof DiscoveryServices.SLAPStorage>;
|
|
5
|
+
/**
|
|
6
|
+
* Prevents banned SHIP records from being written to discovery storage.
|
|
7
|
+
*/
|
|
8
|
+
export declare class BanAwareSHIPStorage {
|
|
9
|
+
private readonly wrapped;
|
|
10
|
+
private readonly banService;
|
|
11
|
+
private readonly logger;
|
|
12
|
+
constructor(wrapped: SHIPStorage, banService: BanService, logger?: typeof console);
|
|
13
|
+
ensureIndexes(): Promise<void>;
|
|
14
|
+
hasDuplicateRecord(identityKey: string, domain: string, topic: string): Promise<boolean>;
|
|
15
|
+
storeSHIPRecord(txid: string, outputIndex: number, identityKey: string, domain: string, topic: string): Promise<void>;
|
|
16
|
+
deleteSHIPRecord(txid: string, outputIndex: number): Promise<void>;
|
|
17
|
+
findRecord(...args: Parameters<SHIPStorage['findRecord']>): ReturnType<SHIPStorage['findRecord']>;
|
|
18
|
+
findAll(...args: Parameters<SHIPStorage['findAll']>): ReturnType<SHIPStorage['findAll']>;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Prevents banned SLAP records from being written to discovery storage.
|
|
22
|
+
*/
|
|
23
|
+
export declare class BanAwareSLAPStorage {
|
|
24
|
+
private readonly wrapped;
|
|
25
|
+
private readonly banService;
|
|
26
|
+
private readonly logger;
|
|
27
|
+
constructor(wrapped: SLAPStorage, banService: BanService, logger?: typeof console);
|
|
28
|
+
ensureIndexes(): Promise<void>;
|
|
29
|
+
hasDuplicateRecord(identityKey: string, domain: string, service: string): Promise<boolean>;
|
|
30
|
+
storeSLAPRecord(txid: string, outputIndex: number, identityKey: string, domain: string, service: string): Promise<void>;
|
|
31
|
+
deleteSLAPRecord(txid: string, outputIndex: number): Promise<void>;
|
|
32
|
+
findRecord(...args: Parameters<SLAPStorage['findRecord']>): ReturnType<SLAPStorage['findRecord']>;
|
|
33
|
+
findAll(...args: Parameters<SLAPStorage['findAll']>): ReturnType<SLAPStorage['findAll']>;
|
|
34
|
+
}
|
|
35
|
+
export {};
|
|
36
|
+
//# sourceMappingURL=BanAwareDiscoveryStorage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BanAwareDiscoveryStorage.d.ts","sourceRoot":"","sources":["../../../src/BanAwareDiscoveryStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,iCAAiC,CAAA;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,KAAK,WAAW,GAAG,YAAY,CAAC,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAA;AACrE,KAAK,WAAW,GAAG,YAAY,CAAC,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAA;AAErE;;GAEG;AACH,qBAAa,mBAAmB;IAE5B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAFN,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,UAAU,EACtB,MAAM,GAAE,OAAO,OAAiB;IAG7C,aAAa,IAAK,OAAO,CAAC,IAAI,CAAC;IAI/B,kBAAkB,CAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzF,eAAe,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYtH,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE,UAAU,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAIlG,OAAO,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAGhG;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAE5B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAFN,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,UAAU,EACtB,MAAM,GAAE,OAAO,OAAiB;IAG7C,aAAa,IAAK,OAAO,CAAC,IAAI,CAAC;IAI/B,kBAAkB,CAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3F,eAAe,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxH,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE,UAAU,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAIlG,OAAO,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAGhG"}
|
|
@@ -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,EAAE,MAAM,cAAc,CAAA;AAC3C,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;gBAHN,OAAO,EAAE,YAAY,EACrB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,MAAM,GAAE,OAAO,OAAiB;IAG7C,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;IA6C5B,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;IAOvH,gBAAgB,IAAK,OAAO,CAAC,MAAM,CAAC;IAIpC,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;CAGH"}
|
|
@@ -28,6 +28,11 @@ export interface EngineConfig {
|
|
|
28
28
|
throwOnBroadcastFailure?: boolean;
|
|
29
29
|
overlayBroadcastFacilitator?: OverlayBroadcastFacilitator;
|
|
30
30
|
suppressDefaultSyncAdvertisements?: boolean;
|
|
31
|
+
topicAnchorHeaderResolver?: TopicAnchorHeaderResolver;
|
|
32
|
+
enableBASMSync?: boolean;
|
|
33
|
+
unprovenEvictionBlocks?: number;
|
|
34
|
+
reorgStreamUrl?: string;
|
|
35
|
+
reorgScanDepth?: number;
|
|
31
36
|
}
|
|
32
37
|
export type HealthStatus = 'ok' | 'degraded' | 'error';
|
|
33
38
|
export interface HealthCheckResult {
|
|
@@ -68,6 +73,11 @@ export interface HealthReport {
|
|
|
68
73
|
checks: HealthCheckResult[];
|
|
69
74
|
context?: Record<string, any>;
|
|
70
75
|
}
|
|
76
|
+
export type TopicAnchorHeaderResolver = (blockHeight: number) => Promise<{
|
|
77
|
+
blockHeight: number;
|
|
78
|
+
blockHash: string;
|
|
79
|
+
merkleRoot?: string;
|
|
80
|
+
} | undefined>;
|
|
71
81
|
/**
|
|
72
82
|
* OverlayExpress class provides an Express-based server for hosting Overlay Services.
|
|
73
83
|
* It allows configuration of various components like databases, topic managers, and lookup services.
|
|
@@ -90,7 +100,16 @@ export default class OverlayExpress {
|
|
|
90
100
|
managers: Record<string, TopicManager>;
|
|
91
101
|
services: Record<string, LookupService>;
|
|
92
102
|
enableGASPSync: boolean;
|
|
103
|
+
enableBASMSync: boolean;
|
|
104
|
+
unprovenEvictionBlocks: number;
|
|
105
|
+
basmBlockPollIntervalMs: number;
|
|
106
|
+
private basmBlockPollTimer?;
|
|
107
|
+
reorgStreamUrl?: string;
|
|
108
|
+
reorgScanDepth: number;
|
|
109
|
+
private reorgAdapter?;
|
|
110
|
+
topicAnchorHeaderResolver?: TopicAnchorHeaderResolver;
|
|
93
111
|
arcApiKey: string | undefined;
|
|
112
|
+
arcCallbackToken: string | undefined;
|
|
94
113
|
verboseRequestLogging: boolean;
|
|
95
114
|
webUIConfig: UIConfig;
|
|
96
115
|
engineConfig: EngineConfig;
|
|
@@ -176,12 +195,44 @@ export default class OverlayExpress {
|
|
|
176
195
|
* @param apiKey - The ARC API key
|
|
177
196
|
*/
|
|
178
197
|
configureArcApiKey(apiKey: string): void;
|
|
198
|
+
/**
|
|
199
|
+
* Configures the ARC callback token expected by /arc-ingest.
|
|
200
|
+
* @param token - The token ARC should present when posting callback notifications.
|
|
201
|
+
*/
|
|
202
|
+
configureArcCallbackToken(token: string): void;
|
|
179
203
|
/**
|
|
180
204
|
* Enables or disables GASP synchronization (high-level setting).
|
|
181
205
|
* This is a broad toggle that can be overridden or customized through syncConfiguration.
|
|
182
206
|
* @param enable - true to enable, false to disable
|
|
183
207
|
*/
|
|
184
208
|
configureEnableGASPSync(enable: boolean): void;
|
|
209
|
+
/**
|
|
210
|
+
* Enables or disables BRC-136 BASM synchronization.
|
|
211
|
+
* BASM is opt-in because it requires direct proofs and block hash resolution.
|
|
212
|
+
*/
|
|
213
|
+
configureEnableBASMSync(enable: boolean): void;
|
|
214
|
+
/**
|
|
215
|
+
* Configures the block header resolver used to derive BASM block hashes.
|
|
216
|
+
*/
|
|
217
|
+
configureTopicAnchorHeaderResolver(resolver: TopicAnchorHeaderResolver): void;
|
|
218
|
+
/**
|
|
219
|
+
* Configures the go-chaintracks (Arcade) reorg SSE stream used to reconcile
|
|
220
|
+
* BASM anchors with blockchain reorganizations in real time.
|
|
221
|
+
* @param url - The reorg stream URL, e.g. `https://arcade.example/v2/reorg/stream`.
|
|
222
|
+
* @param scanDepth - Optional revalidation-sweep depth in blocks (default 3).
|
|
223
|
+
*/
|
|
224
|
+
configureReorgStream(url: string, scanDepth?: number): void;
|
|
225
|
+
/**
|
|
226
|
+
* Configures the opt-in unproven state eviction threshold.
|
|
227
|
+
*/
|
|
228
|
+
configureUnprovenEviction(config: {
|
|
229
|
+
thresholdBlocks?: number;
|
|
230
|
+
}): void;
|
|
231
|
+
/**
|
|
232
|
+
* Configures how often the BASM anchor chain is extended with empty anchors to
|
|
233
|
+
* follow the chain tip. Set to 0 to disable periodic polling.
|
|
234
|
+
*/
|
|
235
|
+
configureBASMBlockPollInterval(intervalMs: number): void;
|
|
185
236
|
/**
|
|
186
237
|
* Enables or disables verbose request logging.
|
|
187
238
|
* @param enable - true to enable, false to disable
|
|
@@ -245,19 +296,21 @@ export default class OverlayExpress {
|
|
|
245
296
|
* By default, auto-configures SHIP and SLAP unless autoConfigureShipSlap = false
|
|
246
297
|
* Then it merges in any advanced engine config from `this.engineConfig`.
|
|
247
298
|
*
|
|
248
|
-
* When a BanService is available (from configureMongo), SHIP
|
|
249
|
-
*
|
|
250
|
-
*
|
|
299
|
+
* When a BanService is available (from configureMongo), auto-configured SHIP
|
|
300
|
+
* and SLAP managers, discovery storage, and lookup services are wrapped so
|
|
301
|
+
* banned outputs are not admitted or indexed.
|
|
251
302
|
*
|
|
252
303
|
* @param autoConfigureShipSlap - Whether to auto-configure SHIP and SLAP services (default: true)
|
|
253
304
|
*/
|
|
254
305
|
configureEngine(autoConfigureShipSlap?: boolean): Promise<void>;
|
|
255
|
-
/** Wrap SHIP/SLAP with ban-aware
|
|
306
|
+
/** Wrap SHIP/SLAP managers and services with ban-aware filters if BanService is configured. */
|
|
256
307
|
private wrapBanAwareServices;
|
|
257
308
|
/** Build the sync config based on enableGASPSync and engineConfig. */
|
|
258
309
|
private buildSyncConfig;
|
|
259
310
|
/** Build the ARC broadcaster if an API key is configured. */
|
|
260
311
|
private buildBroadcaster;
|
|
312
|
+
/** Build the BASM block header resolver. */
|
|
313
|
+
private buildTopicAnchorHeaderResolver;
|
|
261
314
|
/** Resolve the SLAP trackers from config or network defaults. */
|
|
262
315
|
private resolveSlapTrackers;
|
|
263
316
|
/** Build the WalletAdvertiser (or use user-provided one). */
|
|
@@ -295,11 +348,36 @@ export default class OverlayExpress {
|
|
|
295
348
|
private banDomainAndRemoveRecords;
|
|
296
349
|
private runHealthCheck;
|
|
297
350
|
private collectHealthReport;
|
|
351
|
+
/**
|
|
352
|
+
* Renders a request or response body for verbose logging, truncating overly long payloads.
|
|
353
|
+
*/
|
|
354
|
+
private formatBodyForLog;
|
|
355
|
+
/**
|
|
356
|
+
* Installs middleware that verbosely logs incoming requests and outgoing responses.
|
|
357
|
+
*/
|
|
358
|
+
private setupVerboseRequestLogging;
|
|
298
359
|
/**
|
|
299
360
|
* Starts the Express server.
|
|
300
361
|
* Sets up routes and begins listening on the configured port.
|
|
301
362
|
*/
|
|
302
363
|
start(): Promise<void>;
|
|
364
|
+
/**
|
|
365
|
+
* Runs the post-listen startup work: advertiser init, advertisement sync,
|
|
366
|
+
* and the optional GASP/BASM background syncs.
|
|
367
|
+
*/
|
|
368
|
+
private runStartupSync;
|
|
369
|
+
/** Attempt a GASP sync at startup when enabled. */
|
|
370
|
+
private runGaspStartupSync;
|
|
371
|
+
/** Attempt a BASM sync at startup when enabled, then begin tip-following. */
|
|
372
|
+
private runBasmStartupSync;
|
|
373
|
+
/** Poll for new blocks to advance anchor chains and detect reorgs. */
|
|
374
|
+
private startBASMBlockPolling;
|
|
375
|
+
/** Real-time reorg reconciliation via the go-chaintracks (Arcade) reorg SSE. */
|
|
376
|
+
private startBASMReorgStream;
|
|
377
|
+
/** Extend every topic's BASM anchor chain to the current chain tip. */
|
|
378
|
+
private advanceBASMAnchorChains;
|
|
379
|
+
/** Revalidate recent BASM anchors against the chain tracker, reconciling any reorg. */
|
|
380
|
+
private revalidateBASMAnchors;
|
|
303
381
|
}
|
|
304
382
|
export {};
|
|
305
383
|
//# sourceMappingURL=OverlayExpress.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OverlayExpress.d.ts","sourceRoot":"","sources":["../../../src/OverlayExpress.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,
|
|
1
|
+
{"version":3,"file":"OverlayExpress.d.ts","sourceRoot":"","sources":["../../../src/OverlayExpress.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EACL,MAAM,EAEN,aAAa,EACb,YAAY,EAEZ,UAAU,EACX,MAAM,cAAc,CAAA;AACrB,OAAO,EAEL,YAAY,EAKZ,WAAW,EACX,2BAA2B,EAS3B,eAAe,EAChB,MAAM,UAAU,CAAA;AACjB,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,SAAS,CAAA;AACzC,OAA0B,EAAE,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAMzE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAQ5C;;GAEG;AACH,UAAU,SAAS;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C;AAqCD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,YAAY,GAAG,cAAc,CAAA;IAC5C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,CAAA;IAC7D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,2BAA2B,CAAC,EAAE,2BAA2B,CAAA;IACzD,iCAAiC,CAAC,EAAE,OAAO,CAAA;IAC3C,yBAAyB,CAAC,EAAE,yBAAyB,CAAA;IACrD,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,UAAU,GAAG,OAAO,CAAA;AAEtD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,MAAM,EAAE,YAAY,CAAA;IACpB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC,GAAG,IAAI,CAAA;AAE3M,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,kBAAkB,CAAA;CAC5B;AAED,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAA;CACnG;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;QACxB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE,MAAM,CAAA;QAChB,iBAAiB,EAAE,MAAM,CAAA;QACzB,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,MAAM,EAAE,iBAAiB,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC;IACvE,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,GAAG,SAAS,CAAC,CAAA;AAed;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAuIxB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,MAAM;IAClB,gBAAgB,EAAE,MAAM;IAvIjC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAA;IAGxB,IAAI,EAAE,MAAM,CAAO;IAGnB,MAAM,EAAE,OAAO,OAAO,CAAU;IAGhC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAA;IAGhB,eAAe,EAAE,SAAS,EAAE,CAAK;IAGjC,OAAO,CAAC,EAAE,EAAE,CAAA;IAGZ,WAAW,CAAC,EAAE,WAAW,CAAA;IAGzB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAS;IAIjC,YAAY,EAAE,YAAY,GAAG,cAAc,CAAiC;IAG5E,MAAM,CAAC,EAAE,MAAM,CAAA;IAGf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;IAG3C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAK;IAI5C,cAAc,EAAE,OAAO,CAAO;IAI9B,cAAc,EAAE,OAAO,CAAQ;IAG/B,sBAAsB,EAAE,MAAM,CAAM;IAKpC,uBAAuB,EAAE,MAAM,CAAiB;IAGhD,OAAO,CAAC,kBAAkB,CAAC,CAAgC;IAK3D,cAAc,CAAC,EAAE,MAAM,CAAA;IAGvB,cAAc,EAAE,MAAM,CAAI;IAG1B,OAAO,CAAC,YAAY,CAAC,CAAiB;IAGtC,yBAAyB,CAAC,EAAE,yBAAyB,CAAA;IAGrD,SAAS,EAAE,MAAM,GAAG,SAAS,CAAY;IAGzC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAY;IAGhD,qBAAqB,EAAE,OAAO,CAAQ;IAGtC,WAAW,EAAE,QAAQ,CAAK;IAI1B,YAAY,EAAE,YAAY,CAAK;IAI/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IAGnC,aAAa,EAAE;QACb,gBAAgB,EAAE,MAAM,CAAA;QACxB,mBAAmB,EAAE,MAAM,CAAA;QAC3B,gBAAgB,EAAE,OAAO,CAAA;KAC1B,CAIE;IAGH,UAAU,CAAC,EAAE,UAAU,CAAA;IAGvB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAGzB,YAAY,CAAC,EAAE,eAAe,CAAA;IAG9B,OAAO,CAAC,SAAS,CAAC,CAAM;IAGxB,YAAY,EAAE,YAAY,CAGzB;IAGD,YAAY,EAAE,qBAAqB,EAAE,CAAK;IAG1C,WAAW,EAAE,OAAO,CAAQ;IAE5B;;;;;;;OAOG;gBAEM,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EAC/B,UAAU,CAAC,EAAE,MAAM;IAOrB;;OAEG;IACH,aAAa,IAAK,MAAM;IAIxB;;;OAGG;IACH,aAAa,CAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAKlC;;;OAGG;IACH,cAAc,CAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKvC;;;;;;OAMG;IACH,gBAAgB,CAAE,MAAM,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI;IAQnE;;OAEG;IACH,eAAe,CAAE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAQrD;;OAEG;IACH,mBAAmB,CAAE,UAAU,EAAE,qBAAqB,GAAG,IAAI;IAU7D;;;;;;OAMG;IACH,yBAAyB,CAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAKrD;;;OAGG;IACH,eAAe,CAAE,MAAM,EAAE,OAAO,OAAO,GAAG,IAAI;IAK9C;;;;OAIG;IACH,gBAAgB,CAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAMjD;;;;OAIG;IACH,qBAAqB,CAAE,YAAY,GAAE,YAAY,GAAG,cAA+C,GAAG,IAAI;IAK1G;;;OAGG;IACH,kBAAkB,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAKzC;;;OAGG;IACH,yBAAyB,CAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAK/C;;;;OAIG;IACH,uBAAuB,CAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAK/C;;;OAGG;IACH,uBAAuB,CAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAK/C;;OAEG;IACH,kCAAkC,CAAE,QAAQ,EAAE,yBAAyB,GAAG,IAAI;IAK9E;;;;;OAKG;IACH,oBAAoB,CAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ5D;;OAEG;IACH,yBAAyB,CAAE,MAAM,EAAE;QAAE,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAOtE;;;OAGG;IACH,8BAA8B,CAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAKzD;;;OAGG;IACH,8BAA8B,CAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAKtD;;;OAGG;IACG,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtE;;;;OAIG;IACG,cAAc,CAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc9D;;;;OAIG;IACH,qBAAqB,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAKjE;;;;OAIG;IACH,sBAAsB,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI;IAKnE;;;;OAIG;IACH,8BAA8B,CAC5B,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK;QAAE,OAAO,EAAE,aAAa,CAAC;QAAC,UAAU,EAAE,SAAS,EAAE,CAAA;KAAE,GACvF,IAAI;IAQP;;;;OAIG;IACH,+BAA+B,CAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,aAAa,GAAG,IAAI;IAMpG;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAE,MAAM,EAAE,YAAY,GAAG,IAAI;IAQlD;;;;;;;;;;OAUG;IACG,eAAe,CAAE,qBAAqB,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA4DnE,+FAA+F;IAC/F,OAAO,CAAC,oBAAoB;IAkB5B,sEAAsE;IACtE,OAAO,CAAC,eAAe;IAWvB,6DAA6D;IAC7D,OAAO,CAAC,gBAAgB;IAUxB,4CAA4C;IAC5C,OAAO,CAAC,8BAA8B;IA0BtC,iEAAiE;IACjE,OAAO,CAAC,mBAAmB;IAK3B,6DAA6D;YAC/C,eAAe;IAkB7B,kEAAkE;IAClE,OAAO,CAAC,gBAAgB;IAcxB;;;OAGG;IACH,OAAO,CAAC,UAAU;IAOlB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAOnB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAYrB,sEAAsE;YACxD,eAAe;IAa7B,4EAA4E;YAC9D,iBAAiB;IAkB/B,2FAA2F;YAC7E,iBAAiB;IAW/B,mEAAmE;YACrD,uBAAuB;IASrC,4DAA4D;YAC9C,yBAAyB;YASzB,cAAc;YAsCd,mBAAmB;IA8HjC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;OAEG;IACH,OAAO,CAAC,0BAA0B;IA6ClC;;;OAGG;IACG,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IA+6B7B;;;OAGG;YACW,cAAc;IA4B5B,mDAAmD;YACrC,kBAAkB;IAchC,6EAA6E;YAC/D,kBAAkB;IAmBhC,sEAAsE;IACtE,OAAO,CAAC,qBAAqB;IAa7B,gFAAgF;IAChF,OAAO,CAAC,oBAAoB;IAiB5B,uEAAuE;YACzD,uBAAuB;IAQrC,uFAAuF;YACzE,qBAAqB;CAQpC"}
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
export interface OverlayMonitorLogger {
|
|
2
|
+
log: (...args: any[]) => void;
|
|
3
|
+
warn: (...args: any[]) => void;
|
|
4
|
+
error: (...args: any[]) => void;
|
|
5
|
+
}
|
|
6
|
+
export interface OverlayLookupProbe {
|
|
7
|
+
name?: string;
|
|
8
|
+
service: string;
|
|
9
|
+
query: unknown;
|
|
10
|
+
maxOutputs?: number;
|
|
11
|
+
}
|
|
12
|
+
export interface OverlayAnchorProbe {
|
|
13
|
+
name?: string;
|
|
14
|
+
topic: string;
|
|
15
|
+
expectedTac?: string;
|
|
16
|
+
expectedBlockHeight?: number;
|
|
17
|
+
currentHeight?: number;
|
|
18
|
+
maxTipLagBlocks?: number;
|
|
19
|
+
}
|
|
20
|
+
export interface OverlayMonitorTarget {
|
|
21
|
+
name: string;
|
|
22
|
+
baseUrl: string;
|
|
23
|
+
probes: OverlayLookupProbe[];
|
|
24
|
+
anchorProbes?: OverlayAnchorProbe[];
|
|
25
|
+
headers?: Record<string, string>;
|
|
26
|
+
}
|
|
27
|
+
export interface OverlayMonitorThresholds {
|
|
28
|
+
responseBytes?: number;
|
|
29
|
+
beefBytes?: number;
|
|
30
|
+
txsWithoutProof?: number;
|
|
31
|
+
requireSubjectProof?: boolean;
|
|
32
|
+
anchorTipLagBlocks?: number;
|
|
33
|
+
expiredUnprovenCount?: number;
|
|
34
|
+
}
|
|
35
|
+
export interface OverlayMonitorConfig {
|
|
36
|
+
targets: OverlayMonitorTarget[];
|
|
37
|
+
thresholds?: OverlayMonitorThresholds;
|
|
38
|
+
intervalMs?: number;
|
|
39
|
+
/** Per-probe request timeout in milliseconds. Defaults to 30000. */
|
|
40
|
+
timeoutMs?: number;
|
|
41
|
+
fetchImpl?: typeof fetch;
|
|
42
|
+
logger?: OverlayMonitorLogger;
|
|
43
|
+
onReport?: (report: OverlayMonitorReport) => Promise<void> | void;
|
|
44
|
+
now?: () => Date;
|
|
45
|
+
}
|
|
46
|
+
export interface OverlayMonitorWarning {
|
|
47
|
+
code: 'response-bytes' | 'beef-bytes' | 'txs-without-proof' | 'subject-proof-missing' | 'anchor-tip-mismatch' | 'anchor-stale-height' | 'expired-unproven-state';
|
|
48
|
+
message: string;
|
|
49
|
+
value: number | boolean;
|
|
50
|
+
threshold?: number | boolean;
|
|
51
|
+
outputIndex?: number;
|
|
52
|
+
txid?: string;
|
|
53
|
+
}
|
|
54
|
+
export interface OverlayLookupOutputSummary {
|
|
55
|
+
outputIndex: number;
|
|
56
|
+
txid?: string;
|
|
57
|
+
beefBytes: number;
|
|
58
|
+
txCount?: number;
|
|
59
|
+
proofCount?: number;
|
|
60
|
+
txsWithoutProof?: number;
|
|
61
|
+
subjectHasProof?: boolean;
|
|
62
|
+
subjectRawTxBytes?: number;
|
|
63
|
+
currentToSubjectRawRatio?: number;
|
|
64
|
+
contextBytes?: number;
|
|
65
|
+
error?: string;
|
|
66
|
+
}
|
|
67
|
+
export interface OverlayLookupProbeResult {
|
|
68
|
+
target: string;
|
|
69
|
+
url: string;
|
|
70
|
+
probe: string;
|
|
71
|
+
service: string;
|
|
72
|
+
status: number;
|
|
73
|
+
ok: boolean;
|
|
74
|
+
responseBytes: number;
|
|
75
|
+
outputCount: number;
|
|
76
|
+
analyzedOutputCount: number;
|
|
77
|
+
outputs: OverlayLookupOutputSummary[];
|
|
78
|
+
warnings: OverlayMonitorWarning[];
|
|
79
|
+
durationMs: number;
|
|
80
|
+
error?: string;
|
|
81
|
+
}
|
|
82
|
+
export interface OverlayAnchorProbeResult {
|
|
83
|
+
target: string;
|
|
84
|
+
url: string;
|
|
85
|
+
probe: string;
|
|
86
|
+
topic: string;
|
|
87
|
+
status: number;
|
|
88
|
+
ok: boolean;
|
|
89
|
+
responseBytes: number;
|
|
90
|
+
blockHeight?: number;
|
|
91
|
+
tac?: string;
|
|
92
|
+
warnings: OverlayMonitorWarning[];
|
|
93
|
+
durationMs: number;
|
|
94
|
+
error?: string;
|
|
95
|
+
}
|
|
96
|
+
export interface OverlayMonitorReport {
|
|
97
|
+
startedAt: Date;
|
|
98
|
+
completedAt: Date;
|
|
99
|
+
durationMs: number;
|
|
100
|
+
results: OverlayLookupProbeResult[];
|
|
101
|
+
anchorResults: OverlayAnchorProbeResult[];
|
|
102
|
+
summary: {
|
|
103
|
+
targetCount: number;
|
|
104
|
+
probeCount: number;
|
|
105
|
+
anchorProbeCount: number;
|
|
106
|
+
failedProbeCount: number;
|
|
107
|
+
responseBytes: number;
|
|
108
|
+
outputCount: number;
|
|
109
|
+
analyzedOutputCount: number;
|
|
110
|
+
outputsMissingSubjectProof: number;
|
|
111
|
+
warningCount: number;
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
interface AnalyzeOptions {
|
|
115
|
+
target: string;
|
|
116
|
+
url: string;
|
|
117
|
+
probe: string;
|
|
118
|
+
service: string;
|
|
119
|
+
status: number;
|
|
120
|
+
ok: boolean;
|
|
121
|
+
responseBody: unknown;
|
|
122
|
+
responseBytes: number;
|
|
123
|
+
durationMs: number;
|
|
124
|
+
thresholds?: OverlayMonitorThresholds;
|
|
125
|
+
maxOutputs?: number;
|
|
126
|
+
error?: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* OverlayMonitor runs generic Overlay Express /lookup probes and reports response
|
|
130
|
+
* size plus BEEF proof shape. It is intended for long-running monitor workers or
|
|
131
|
+
* scheduled jobs, analogous to a storage monitor but scoped to overlay health.
|
|
132
|
+
*/
|
|
133
|
+
export declare class OverlayMonitor {
|
|
134
|
+
private readonly targets;
|
|
135
|
+
private readonly thresholds;
|
|
136
|
+
private readonly fetchImpl;
|
|
137
|
+
private readonly logger;
|
|
138
|
+
private readonly onReport?;
|
|
139
|
+
private readonly now;
|
|
140
|
+
private readonly intervalMs?;
|
|
141
|
+
private readonly timeoutMs;
|
|
142
|
+
private timer?;
|
|
143
|
+
private running;
|
|
144
|
+
constructor(config: OverlayMonitorConfig);
|
|
145
|
+
runOnce(): Promise<OverlayMonitorReport>;
|
|
146
|
+
start(): void;
|
|
147
|
+
stop(): void;
|
|
148
|
+
private runProbe;
|
|
149
|
+
private runAnchorProbe;
|
|
150
|
+
}
|
|
151
|
+
export declare function analyzeOverlayAnchorTip(options: {
|
|
152
|
+
target: string;
|
|
153
|
+
url: string;
|
|
154
|
+
probe: string;
|
|
155
|
+
topic: string;
|
|
156
|
+
status: number;
|
|
157
|
+
ok: boolean;
|
|
158
|
+
responseBody: Record<string, unknown>;
|
|
159
|
+
responseBytes: number;
|
|
160
|
+
durationMs: number;
|
|
161
|
+
thresholds?: OverlayMonitorThresholds;
|
|
162
|
+
expectedTac?: string;
|
|
163
|
+
expectedBlockHeight?: number;
|
|
164
|
+
currentHeight?: number;
|
|
165
|
+
maxTipLagBlocks?: number;
|
|
166
|
+
}): OverlayAnchorProbeResult;
|
|
167
|
+
export declare function analyzeOverlayLookupResponse(options: AnalyzeOptions): OverlayLookupProbeResult;
|
|
168
|
+
export {};
|
|
169
|
+
//# sourceMappingURL=OverlayMonitor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OverlayMonitor.d.ts","sourceRoot":"","sources":["../../../src/OverlayMonitor.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAC7B,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAC9B,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,kBAAkB,EAAE,CAAA;IAC5B,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,wBAAwB;IACvC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,oBAAoB,EAAE,CAAA;IAC/B,UAAU,CAAC,EAAE,wBAAwB,CAAA;IACrC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;IACxB,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACjE,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,gBAAgB,GAAG,YAAY,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,qBAAqB,GAAG,qBAAqB,GAAG,wBAAwB,CAAA;IAChK,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,OAAO,CAAA;IACX,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,OAAO,EAAE,0BAA0B,EAAE,CAAA;IACrC,QAAQ,EAAE,qBAAqB,EAAE,CAAA;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,OAAO,CAAA;IACX,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,qBAAqB,EAAE,CAAA;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,IAAI,CAAA;IACf,WAAW,EAAE,IAAI,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,wBAAwB,EAAE,CAAA;IACnC,aAAa,EAAE,wBAAwB,EAAE,CAAA;IACzC,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAA;QACnB,UAAU,EAAE,MAAM,CAAA;QAClB,gBAAgB,EAAE,MAAM,CAAA;QACxB,gBAAgB,EAAE,MAAM,CAAA;QACxB,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,MAAM,CAAA;QACnB,mBAAmB,EAAE,MAAM,CAAA;QAC3B,0BAA0B,EAAE,MAAM,CAAA;QAClC,YAAY,EAAE,MAAM,CAAA;KACrB,CAAA;CACF;AAED,UAAU,cAAc;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,OAAO,CAAA;IACX,YAAY,EAAE,OAAO,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,wBAAwB,CAAA;IACrC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAWD;;;;GAIG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoC;IAC/D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAwD;IAClF,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAQ;IAClC,OAAO,CAAC,KAAK,CAAC,CAAgC;IAC9C,OAAO,CAAC,OAAO,CAAQ;gBAEV,MAAM,EAAE,oBAAoB;IAanC,OAAO,IAAK,OAAO,CAAC,oBAAoB,CAAC;IA4B/C,KAAK,IAAK,IAAI;IAmBd,IAAI,IAAK,IAAI;YAOC,QAAQ;YAuER,cAAc;CA0E7B;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,EAAE,OAAO,CAAA;IACX,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACrC,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,wBAAwB,CAAA;IACrC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,GAAG,wBAAwB,CAwD3B;AAED,wBAAgB,4BAA4B,CAAE,OAAO,EAAE,cAAc,GAAG,wBAAwB,CAmC/F"}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Consumes the go-chaintracks (Arcade) reorg SSE stream (`GET /v2/reorg/stream`)
|
|
3
|
+
* and normalizes each `ReorgEvent` into the overlay engine's `handleReorg` input.
|
|
4
|
+
*
|
|
5
|
+
* The stream emits `data: <JSON>\n\n` frames (no `event:`/`id:` lines) with
|
|
6
|
+
* `: keepalive` comment frames in between. Because there are no event ids, a
|
|
7
|
+
* reconnect cannot replay events missed while disconnected — so every (re)connect
|
|
8
|
+
* triggers an `onConnect` catch-up (the engine's revalidation sweep).
|
|
9
|
+
*/
|
|
10
|
+
/** Input shape accepted by `Engine.handleReorg`. */
|
|
11
|
+
export interface ReorgHandlerInput {
|
|
12
|
+
orphanedBlockHashes: string[];
|
|
13
|
+
rebuildFromHeight: number;
|
|
14
|
+
newTipHeight: number;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Parses a single SSE data frame (a go-chaintracks `ReorgEvent` JSON document)
|
|
18
|
+
* into `handleReorg` input. Returns `null` for malformed frames.
|
|
19
|
+
*
|
|
20
|
+
* `ReorgEvent` = { orphanedHashes: string[], commonAncestor: BlockHeader|null,
|
|
21
|
+
* newTip: BlockHeader, depth: number }. Block hashes are go-sdk `chainhash.Hash`
|
|
22
|
+
* values marshaled as reversed (display) hex; they are lower-cased here to match
|
|
23
|
+
* the overlay's stored block hashes.
|
|
24
|
+
*/
|
|
25
|
+
export declare function parseReorgEvent(frame: string): ReorgHandlerInput | null;
|
|
26
|
+
/**
|
|
27
|
+
* Splits an SSE byte buffer into complete event payloads. Frames are delimited by
|
|
28
|
+
* a blank line (`\n\n`); within a frame, `data:` lines are concatenated and
|
|
29
|
+
* comment lines (starting with `:`) are ignored. Any trailing partial frame is
|
|
30
|
+
* returned in `rest` for the next read.
|
|
31
|
+
*/
|
|
32
|
+
export declare function extractSseFrames(buffer: string): {
|
|
33
|
+
events: string[];
|
|
34
|
+
rest: string;
|
|
35
|
+
};
|
|
36
|
+
export interface ReorgSseAdapterOptions {
|
|
37
|
+
/** Reorg SSE URL, e.g. `https://arcade.example/v2/reorg/stream`. */
|
|
38
|
+
url: string;
|
|
39
|
+
/** Invoked for each parsed reorg event. */
|
|
40
|
+
onReorg: (input: ReorgHandlerInput) => Promise<void>;
|
|
41
|
+
/** Invoked on every (re)connect for catch-up, since the stream has no replay. */
|
|
42
|
+
onConnect?: () => Promise<void>;
|
|
43
|
+
logger?: Pick<typeof console, 'log' | 'warn' | 'error'>;
|
|
44
|
+
/** Delay before reconnecting after the stream ends or errors. */
|
|
45
|
+
reconnectDelayMs?: number;
|
|
46
|
+
/** Injectable fetch (defaults to global fetch); aids testing. */
|
|
47
|
+
fetchImpl?: typeof fetch;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Long-lived SSE client that keeps the overlay's BASM anchors reconciled with
|
|
51
|
+
* chain reorgs. Auto-reconnects with a fixed delay and runs a catch-up on connect.
|
|
52
|
+
*/
|
|
53
|
+
export declare class ReorgSseAdapter {
|
|
54
|
+
private readonly url;
|
|
55
|
+
private readonly onReorg;
|
|
56
|
+
private readonly onConnect?;
|
|
57
|
+
private readonly logger;
|
|
58
|
+
private readonly reconnectDelayMs;
|
|
59
|
+
private readonly fetchImpl;
|
|
60
|
+
private controller?;
|
|
61
|
+
private stopped;
|
|
62
|
+
constructor(options: ReorgSseAdapterOptions);
|
|
63
|
+
/** Begins consuming the stream in the background. */
|
|
64
|
+
start(): void;
|
|
65
|
+
/** Stops consuming and aborts any in-flight connection. */
|
|
66
|
+
stop(): void;
|
|
67
|
+
private runLoop;
|
|
68
|
+
private connectOnce;
|
|
69
|
+
private runCatchUp;
|
|
70
|
+
private pumpEvents;
|
|
71
|
+
private processReorgFrame;
|
|
72
|
+
private delay;
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=ReorgStream.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ReorgStream.d.ts","sourceRoot":"","sources":["../../../src/ReorgStream.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAChC,mBAAmB,EAAE,MAAM,EAAE,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAiCxE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAE,MAAM,EAAE,MAAM,GAAG;IAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAsBpF;AAED,MAAM,WAAW,sBAAsB;IACrC,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAA;IACX,2CAA2C;IAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpD,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,OAAO,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;IACvD,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,iEAAiE;IACjE,SAAS,CAAC,EAAE,OAAO,KAAK,CAAA;CACzB;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6C;IACrE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAqB;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgD;IACvE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,UAAU,CAAC,CAAiB;IACpC,OAAO,CAAC,OAAO,CAAQ;gBAEV,OAAO,EAAE,sBAAsB;IAS5C,qDAAqD;IACrD,KAAK,IAAK,IAAI;IAOd,2DAA2D;IAC3D,IAAI,IAAK,IAAI;YAKC,OAAO;YAgBP,WAAW;YAeX,UAAU;YAWV,UAAU;YAiBV,iBAAiB;YAajB,KAAK;CAMpB"}
|