@bsv/overlay-express 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -0
- package/dist/cjs/mod.js +4 -1
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +19 -15
- package/dist/cjs/src/BanService.js +2 -2
- package/dist/cjs/src/BanService.js.map +1 -1
- package/dist/cjs/src/OverlayExpress.js +191 -189
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/OverlayMonitor.js +306 -0
- package/dist/cjs/src/OverlayMonitor.js.map +1 -0
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/mod.js +1 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/BanService.js +2 -2
- package/dist/esm/src/BanService.js.map +1 -1
- package/dist/esm/src/OverlayExpress.js +186 -186
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/OverlayMonitor.js +304 -0
- package/dist/esm/src/OverlayMonitor.js.map +1 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/mod.d.ts +1 -0
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/OverlayExpress.d.ts +29 -1
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/OverlayMonitor.d.ts +125 -0
- package/dist/types/src/OverlayMonitor.d.ts.map +1 -0
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/mod.ts +13 -0
- package/package.json +32 -28
- package/src/BanService.ts +2 -2
- package/src/OverlayExpress.ts +199 -197
- package/src/OverlayMonitor.ts +445 -0
- package/src/__tests__/OverlayExpress.test.ts +86 -1
- package/src/__tests__/OverlayMonitor.test.ts +116 -0
package/README.md
CHANGED
|
@@ -116,6 +116,39 @@ server.registerHealthCheck({
|
|
|
116
116
|
|
|
117
117
|
The janitor service also understands the richer `/health` response format, so existing SHIP/SLAP health validation remains compatible.
|
|
118
118
|
|
|
119
|
+
### Overlay Monitor
|
|
120
|
+
|
|
121
|
+
`OverlayMonitor` provides a reusable worker for monitoring Overlay Express lookup behavior. It posts configured `/lookup` probes to any Overlay Express deployment, measures response size, parses returned BEEF, and reports whether responsive output transactions have direct Merkle proofs or are being served with deeper proof ancestry.
|
|
122
|
+
|
|
123
|
+
This is intended to be run by deployments as a long-running monitor process or by cluster scheduling. It is not tied to a specific deployment platform.
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import { OverlayMonitor } from '@bsv/overlay-express'
|
|
127
|
+
|
|
128
|
+
const monitor = new OverlayMonitor({
|
|
129
|
+
intervalMs: 24 * 60 * 60 * 1000,
|
|
130
|
+
targets: [
|
|
131
|
+
{
|
|
132
|
+
name: 'example-overlay',
|
|
133
|
+
baseUrl: 'https://overlay.example',
|
|
134
|
+
probes: [
|
|
135
|
+
{
|
|
136
|
+
name: 'example-topic',
|
|
137
|
+
service: 'ls_example',
|
|
138
|
+
query: { topic: 'tm_example' },
|
|
139
|
+
maxOutputs: 20
|
|
140
|
+
}
|
|
141
|
+
]
|
|
142
|
+
}
|
|
143
|
+
],
|
|
144
|
+
onReport: async report => {
|
|
145
|
+
console.log(JSON.stringify(report.summary))
|
|
146
|
+
}
|
|
147
|
+
})
|
|
148
|
+
|
|
149
|
+
monitor.start()
|
|
150
|
+
```
|
|
151
|
+
|
|
119
152
|
## License
|
|
120
153
|
|
|
121
154
|
The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
|
package/dist/cjs/mod.js
CHANGED
|
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.JanitorService = exports.BanAwareLookupWrapper = exports.BanService = exports.default = void 0;
|
|
6
|
+
exports.analyzeOverlayLookupResponse = exports.OverlayMonitor = exports.JanitorService = exports.BanAwareLookupWrapper = exports.BanService = exports.default = void 0;
|
|
7
7
|
var OverlayExpress_js_1 = require("./src/OverlayExpress.js");
|
|
8
8
|
Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(OverlayExpress_js_1).default; } });
|
|
9
9
|
var BanService_js_1 = require("./src/BanService.js");
|
|
@@ -12,4 +12,7 @@ var BanAwareLookupWrapper_js_1 = require("./src/BanAwareLookupWrapper.js");
|
|
|
12
12
|
Object.defineProperty(exports, "BanAwareLookupWrapper", { enumerable: true, get: function () { return BanAwareLookupWrapper_js_1.BanAwareLookupWrapper; } });
|
|
13
13
|
var JanitorService_js_1 = require("./src/JanitorService.js");
|
|
14
14
|
Object.defineProperty(exports, "JanitorService", { enumerable: true, get: function () { return JanitorService_js_1.JanitorService; } });
|
|
15
|
+
var OverlayMonitor_js_1 = require("./src/OverlayMonitor.js");
|
|
16
|
+
Object.defineProperty(exports, "OverlayMonitor", { enumerable: true, get: function () { return OverlayMonitor_js_1.OverlayMonitor; } });
|
|
17
|
+
Object.defineProperty(exports, "analyzeOverlayLookupResponse", { enumerable: true, get: function () { return OverlayMonitor_js_1.analyzeOverlayLookupResponse; } });
|
|
15
18
|
//# sourceMappingURL=mod.js.map
|
package/dist/cjs/mod.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,6DASgC;AAR9B,6HAAA,OAAO,OAAA;AAST,qDAAmE;AAA1D,2GAAA,UAAU,OAAA;AACnB,2EAAsE;AAA7D,iIAAA,qBAAqB,OAAA;AAC9B,6DAAuH;AAA9G,mHAAA,cAAc,OAAA"}
|
|
1
|
+
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,6DASgC;AAR9B,6HAAA,OAAO,OAAA;AAST,qDAAmE;AAA1D,2GAAA,UAAU,OAAA;AACnB,2EAAsE;AAA7D,iIAAA,qBAAqB,OAAA;AAC9B,6DAAuH;AAA9G,mHAAA,cAAc,OAAA;AACvB,6DAYgC;AAX9B,mHAAA,cAAc,OAAA;AACd,iIAAA,4BAA4B,OAAA"}
|
package/dist/cjs/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bsv/overlay-express",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.0",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "BSV Blockchain Overlay Express",
|
|
6
6
|
"files": [
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
},
|
|
25
25
|
"repository": {
|
|
26
26
|
"type": "git",
|
|
27
|
-
"url": "git+https://github.com/bsv-blockchain/
|
|
27
|
+
"url": "git+https://github.com/bsv-blockchain/ts-stack.git",
|
|
28
|
+
"directory": "packages/overlays/overlay-express"
|
|
28
29
|
},
|
|
29
30
|
"keywords": [
|
|
30
31
|
"BSV",
|
|
@@ -36,30 +37,33 @@
|
|
|
36
37
|
"author": "BSV Association",
|
|
37
38
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
38
39
|
"bugs": {
|
|
39
|
-
"url": "https://github.com/bsv-blockchain/
|
|
40
|
+
"url": "https://github.com/bsv-blockchain/ts-stack/issues"
|
|
40
41
|
},
|
|
41
|
-
"homepage": "https://github.com/bsv-blockchain/overlay-express#readme",
|
|
42
|
+
"homepage": "https://github.com/bsv-blockchain/ts-stack/tree/main/packages/overlays/overlay-express#readme",
|
|
42
43
|
"devDependencies": {
|
|
44
|
+
"@jest/globals": "^30.4.1",
|
|
45
|
+
"@types/body-parser": "^1.19.5",
|
|
43
46
|
"@types/express": "^5.0.0",
|
|
44
|
-
"@types/jest": "^
|
|
45
|
-
"
|
|
46
|
-
"
|
|
47
|
+
"@types/jest": "^30.0.0",
|
|
48
|
+
"@types/node": "^25.9.1",
|
|
49
|
+
"jest": "^30.4.2",
|
|
50
|
+
"ts-jest": "^29.4.11",
|
|
47
51
|
"ts-standard": "^12.0.2",
|
|
48
52
|
"ts2md": "^0.2.0",
|
|
49
53
|
"tsconfig-to-dual-package": "^1.2.0",
|
|
50
|
-
"typescript": "^
|
|
54
|
+
"typescript": "^6.0.3"
|
|
51
55
|
},
|
|
52
56
|
"dependencies": {
|
|
53
|
-
"@bsv/auth-express-middleware": "^2.0.
|
|
54
|
-
"@bsv/overlay": "^2.0.
|
|
55
|
-
"@bsv/overlay-discovery-services": "^2.0.
|
|
56
|
-
"@bsv/sdk": "^2.
|
|
57
|
-
"@bsv/wallet-toolbox-client": "^2.
|
|
57
|
+
"@bsv/auth-express-middleware": "^2.0.6",
|
|
58
|
+
"@bsv/overlay": "^2.0.3",
|
|
59
|
+
"@bsv/overlay-discovery-services": "^2.0.3",
|
|
60
|
+
"@bsv/sdk": "^2.1.3",
|
|
61
|
+
"@bsv/wallet-toolbox-client": "^2.1.28",
|
|
58
62
|
"body-parser": "^2.2.2",
|
|
59
63
|
"chalk": "^5.6.2",
|
|
60
64
|
"express": "^5.2.1",
|
|
61
|
-
"knex": "^3.
|
|
65
|
+
"knex": "^3.2.10",
|
|
62
66
|
"mongodb": "^7.1.0",
|
|
63
|
-
"uuid": "^
|
|
67
|
+
"uuid": "^14.0.0"
|
|
64
68
|
}
|
|
65
69
|
}
|
|
@@ -20,7 +20,7 @@ class BanService {
|
|
|
20
20
|
*/
|
|
21
21
|
sanitize(value) {
|
|
22
22
|
if (typeof value !== 'string') {
|
|
23
|
-
throw new
|
|
23
|
+
throw new TypeError('Invalid input: expected a string value');
|
|
24
24
|
}
|
|
25
25
|
return value;
|
|
26
26
|
}
|
|
@@ -68,7 +68,7 @@ class BanService {
|
|
|
68
68
|
$set: {
|
|
69
69
|
type: 'outpoint',
|
|
70
70
|
value,
|
|
71
|
-
domain: domain
|
|
71
|
+
domain: domain != null ? this.sanitize(domain) : undefined,
|
|
72
72
|
reason: reason !== null && reason !== void 0 ? reason : 'Manually banned',
|
|
73
73
|
bannedAt: new Date(),
|
|
74
74
|
bannedBy
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BanService.js","sourceRoot":"","sources":["../../../src/BanService.ts"],"names":[],"mappings":";;;AAoBA;;;;;;;GAOG;AACH,MAAa,UAAU;IAGrB,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,
|
|
1
|
+
{"version":3,"file":"BanService.js","sourceRoot":"","sources":["../../../src/BanService.ts"],"names":[],"mappings":";;;AAoBA;;;;;;;GAOG;AACH,MAAa,UAAU;IAGrB,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;AA7HD,gCA6HC"}
|