@bsv/overlay-express 0.8.2-rc1 → 0.8.2
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/dist/cjs/package.json +13 -13
- package/dist/cjs/src/JanitorService.js +215 -0
- package/dist/cjs/src/JanitorService.js.map +1 -0
- package/dist/cjs/src/OverlayExpress.js +130 -30
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/generalGuide.md.js +77 -0
- package/dist/cjs/src/generalGuide.md.js.map +1 -0
- package/dist/cjs/src/makeUserInterface.js +290 -93
- package/dist/cjs/src/makeUserInterface.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/JanitorService.js +211 -0
- package/dist/esm/src/JanitorService.js.map +1 -0
- package/dist/esm/src/OverlayExpress.js +125 -25
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/generalGuide.md.js +75 -0
- package/dist/esm/src/generalGuide.md.js.map +1 -0
- package/dist/esm/src/makeUserInterface.js +287 -93
- package/dist/esm/src/makeUserInterface.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/src/JanitorService.d.ts +59 -0
- package/dist/types/src/JanitorService.d.ts.map +1 -0
- package/dist/types/src/OverlayExpress.d.ts +15 -3
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/generalGuide.md.d.ts +3 -0
- package/dist/types/src/generalGuide.md.d.ts.map +1 -0
- package/dist/types/src/makeUserInterface.d.ts +7 -2
- package/dist/types/src/makeUserInterface.d.ts.map +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/OverlayExpress.ts +55 -4
|
@@ -26,6 +26,7 @@ export interface EngineConfig {
|
|
|
26
26
|
logPrefix?: string;
|
|
27
27
|
throwOnBroadcastFailure?: boolean;
|
|
28
28
|
overlayBroadcastFacilitator?: OverlayBroadcastFacilitator;
|
|
29
|
+
suppressDefaultSyncAdvertisements?: boolean;
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
32
|
* OverlayExpress class provides an Express-based server for hosting Overlay Services.
|
|
@@ -39,12 +40,12 @@ export default class OverlayExpress {
|
|
|
39
40
|
app: express.Application;
|
|
40
41
|
port: number;
|
|
41
42
|
logger: typeof console;
|
|
42
|
-
knex: Knex.Knex
|
|
43
|
+
knex: Knex.Knex;
|
|
43
44
|
migrationsToRun: Migration[];
|
|
44
|
-
mongoDb: Db
|
|
45
|
+
mongoDb: Db;
|
|
45
46
|
network: 'main' | 'test';
|
|
46
47
|
chainTracker: ChainTracker | 'scripts only';
|
|
47
|
-
engine: Engine
|
|
48
|
+
engine: Engine;
|
|
48
49
|
managers: Record<string, TopicManager>;
|
|
49
50
|
services: Record<string, LookupService>;
|
|
50
51
|
enableGASPSync: boolean;
|
|
@@ -53,6 +54,10 @@ export default class OverlayExpress {
|
|
|
53
54
|
webUIConfig: UIConfig;
|
|
54
55
|
engineConfig: EngineConfig;
|
|
55
56
|
private readonly adminToken;
|
|
57
|
+
janitorConfig: {
|
|
58
|
+
requestTimeoutMs: number;
|
|
59
|
+
hostDownRevokeScore: number;
|
|
60
|
+
};
|
|
56
61
|
/**
|
|
57
62
|
* Constructs an instance of OverlayExpress.
|
|
58
63
|
* @param name - The name of the service
|
|
@@ -76,6 +81,13 @@ export default class OverlayExpress {
|
|
|
76
81
|
* @param config - Web UI configuration options
|
|
77
82
|
*/
|
|
78
83
|
configureWebUI(config: UIConfig): void;
|
|
84
|
+
/**
|
|
85
|
+
* Configures the janitor service parameters
|
|
86
|
+
* @param config - Janitor configuration options
|
|
87
|
+
* - requestTimeoutMs: Timeout for health check requests (default: 10000ms)
|
|
88
|
+
* - hostDownRevokeScore: Number of consecutive failures before deleting output (default: 3)
|
|
89
|
+
*/
|
|
90
|
+
configureJanitor(config: Partial<typeof this.janitorConfig>): void;
|
|
79
91
|
/**
|
|
80
92
|
* Configures the logger to be used by the server.
|
|
81
93
|
* @param logger - A logger object (e.g., console)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OverlayExpress.d.ts","sourceRoot":"","sources":["../../../src/OverlayExpress.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAAE,MAAM,EAAe,aAAa,EAAE,YAAY,EAAyB,UAAU,EAAE,MAAM,cAAc,CAAA;AAClH,OAAO,EAEL,YAAY,EAKZ,WAAW,EACX,2BAA2B,
|
|
1
|
+
{"version":3,"file":"OverlayExpress.d.ts","sourceRoot":"","sources":["../../../src/OverlayExpress.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,EAAE,MAAM,EAAe,aAAa,EAAE,YAAY,EAAyB,UAAU,EAAE,MAAM,cAAc,CAAA;AAClH,OAAO,EAEL,YAAY,EAKZ,WAAW,EACX,2BAA2B,EAO5B,MAAM,UAAU,CAAA;AACjB,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAe,EAAE,EAAE,MAAM,SAAS,CAAA;AACzC,OAA0B,EAAE,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAOzE;;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;CAC5C;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IA0ExB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,MAAM;IAClB,gBAAgB,EAAE,MAAM;IA1EjC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAA;IAGxB,IAAI,EAAE,MAAM,CAAO;IAGnB,MAAM,EAAE,OAAO,OAAO,CAAU;IAGhC,IAAI,EAAE,IAAI,CAAC,IAAI,CAA6B;IAG5C,eAAe,EAAE,SAAS,EAAE,CAAK;IAGjC,OAAO,EAAE,EAAE,CAAsB;IAGjC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAS;IAIjC,YAAY,EAAE,YAAY,GAAG,cAAc,CAAiC;IAG5E,MAAM,EAAE,MAAM,CAA0B;IAGxC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;IAG3C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAK;IAI5C,cAAc,EAAE,OAAO,CAAO;IAG9B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAY;IAGzC,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;KAC5B,CAGE;IAEH;;;;;;;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;;;;;OAKG;IACH,gBAAgB,CAAE,MAAM,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI;IAQnE;;;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;;;;OAIG;IACH,uBAAuB,CAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAK/C;;;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;;;OAGG;IACG,cAAc,CAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9D;;;;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;;;;;;OAMG;IACG,eAAe,CAAE,qBAAqB,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAyGnE;;;OAGG;IACH,OAAO,CAAC,UAAU;IAMlB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAMnB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAMpB;;;OAGG;IACG,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;CAgkB9B"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
declare const _default: "`\n# General Guide\n\n## Topic Managers \n\nA Topic Manager controls addition and removal of transaction outputs to an Overlay Topic. It processes transaction by exposing a /submit endpoint, request should looks something like:\n\n### [POST] /submit\n\n#### Request Headers\n\\`\\`\\`json\n{\n \"x-topics\": \"[\"tm_messagebox\"]\", // array of topic identifiers as stringified JSON\n \"x-includes-off-chain-values\": \"false\" // string \"true\" or \"false\"\n}\n\\`\\`\\`\n\n#### Request Body\n\\`\\`\\`json\n[1,1,1,1... ], // transaction in atomic BEEF format as Uint8Array\n\\`\\`\\`\n\nThe engine processes this TaggedBEEF and generates a STEAK (Submitted Transaction Execution AcKnowledgment), which is returned to the client.\n\n#### Response Body\n\\`\\`\\`json\n{\n \"tm_messagebox\": {\n \"outputsToAdmit\": [0], // which of the outputs in the BEEF to admit\n \"coinsToRetain\": [], // which of the inputs in the BEEF to mark spent but keep within the Topic\n \"coinsRemoved\": [], // which of the inputs in the BEEF to remove from the Topic\n },\n ... // per topic\n}\n\\`\\`\\`\n\n<br />\n\n## Lookup Services\n\nA Lookup Service is a component that enables data retrieval from the Overlay Services ecosystem. It allows clients to search and retrieve transactions that were previously submitted to Topic Managers, using specific criteria or identifiers.\n\n### [POST] /lookup\n\n#### Request Body\n\\`\\`\\`json\n{\n \"service\": \"ls_messagebox\", // Lookup Service identifier as string,\n \"query\": \"findAll\" // query must be a string, JSON queries should be stringified\n}\n\\`\\`\\`\n\n#### Response Body\n\\`\\`\\`json\n{\n \"type\": \"output-list\",\n \"outputs\": [{\n \"beef\": [1, 1, 1...], // number[]\n \"outputIndex\": 0, // number\n \"context\"?: [1, 1, 1...], // number[]\n }>]\n}\n\\`\\`\\`\n\n<br />\n\n## Summary\n\nUsually Topic Managers and Lookup Services are paired, but they can be separated for greater flexibility. Together, they form a complete system for data submission, organization, and retrieval within the Overlay Services framework.\n\n<br />\n<br />\n`\n";
|
|
2
|
+
export default _default;
|
|
3
|
+
//# sourceMappingURL=generalGuide.md.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generalGuide.md.d.ts","sourceRoot":"","sources":["../../../src/generalGuide.md.ts"],"names":[],"mappings":";AAAA,wBAyEC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
export
|
|
1
|
+
export interface UIConfig {
|
|
2
|
+
host?: string;
|
|
2
3
|
faviconUrl?: string;
|
|
3
4
|
backgroundColor?: string;
|
|
4
5
|
primaryColor?: string;
|
|
@@ -7,10 +8,14 @@ export type UIConfig = {
|
|
|
7
8
|
headingFontFamily?: string;
|
|
8
9
|
additionalStyles?: string;
|
|
9
10
|
sectionBackgroundColor?: string;
|
|
11
|
+
primaryTextColor?: string;
|
|
10
12
|
linkColor?: string;
|
|
11
13
|
hoverColor?: string;
|
|
12
14
|
borderColor?: string;
|
|
13
|
-
|
|
15
|
+
secondaryBackgroundColor?: string;
|
|
16
|
+
secondaryTextColor?: string;
|
|
17
|
+
defaultContent?: string;
|
|
18
|
+
}
|
|
14
19
|
declare const _default: (config?: UIConfig) => string;
|
|
15
20
|
export default _default;
|
|
16
21
|
//# sourceMappingURL=makeUserInterface.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"makeUserInterface.d.ts","sourceRoot":"","sources":["../../../src/makeUserInterface.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"makeUserInterface.d.ts","sourceRoot":"","sources":["../../../src/makeUserInterface.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;yBAEe,SAAQ,QAAa,KAAG,MAAM;AAA9C,wBA8gBC"}
|