@bsv/overlay-express 2.4.0 → 2.4.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/README.md +122 -3
- package/dist/cjs/mod.js +8 -1
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +19 -19
- package/dist/cjs/src/ArcadeProvider.js +196 -0
- package/dist/cjs/src/ArcadeProvider.js.map +1 -0
- package/dist/cjs/src/ChaintracksProvider.js +65 -0
- package/dist/cjs/src/ChaintracksProvider.js.map +1 -0
- package/dist/cjs/src/OverlayExpress.js +270 -28
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/OverlayMonitor.js +117 -3
- package/dist/cjs/src/OverlayMonitor.js.map +1 -1
- package/dist/cjs/src/ProviderChainBroadcaster.js +91 -0
- package/dist/cjs/src/ProviderChainBroadcaster.js.map +1 -0
- package/dist/cjs/src/generalGuide.md.js +1 -1
- 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/ArcadeProvider.js +189 -0
- package/dist/esm/src/ArcadeProvider.js.map +1 -0
- package/dist/esm/src/ChaintracksProvider.js +62 -0
- package/dist/esm/src/ChaintracksProvider.js.map +1 -0
- package/dist/esm/src/OverlayExpress.js +265 -28
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/OverlayMonitor.js +117 -3
- package/dist/esm/src/OverlayMonitor.js.map +1 -1
- package/dist/esm/src/ProviderChainBroadcaster.js +88 -0
- package/dist/esm/src/ProviderChainBroadcaster.js.map +1 -0
- package/dist/esm/src/generalGuide.md.js +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/types/mod.d.ts +3 -0
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/ArcadeProvider.d.ts +37 -0
- package/dist/types/src/ArcadeProvider.d.ts.map +1 -0
- package/dist/types/src/ChaintracksProvider.d.ts +29 -0
- package/dist/types/src/ChaintracksProvider.d.ts.map +1 -0
- package/dist/types/src/OverlayExpress.d.ts +38 -1
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/OverlayMonitor.d.ts +28 -0
- package/dist/types/src/OverlayMonitor.d.ts.map +1 -1
- package/dist/types/src/ProviderChainBroadcaster.d.ts +18 -0
- package/dist/types/src/ProviderChainBroadcaster.d.ts.map +1 -0
- package/dist/types/src/generalGuide.md.d.ts +1 -1
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/mod.ts +15 -0
- package/package.json +19 -19
- package/src/ArcadeProvider.ts +232 -0
- package/src/ChaintracksProvider.ts +79 -0
- package/src/OverlayExpress.ts +299 -28
- package/src/OverlayMonitor.ts +163 -3
- package/src/ProviderChainBroadcaster.ts +108 -0
- package/src/__tests__/OverlayExpress.test.ts +196 -4
- package/src/__tests__/OverlayMonitor.test.ts +74 -0
- package/src/__tests__/OverlayProviders.live.test.ts +43 -0
- package/src/__tests__/OverlayProviders.test.ts +123 -0
- package/src/generalGuide.md.ts +1 -1
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProviderChainBroadcaster = void 0;
|
|
4
|
+
const TERMINAL_CODES = new Set([
|
|
5
|
+
'400',
|
|
6
|
+
'460',
|
|
7
|
+
'463',
|
|
8
|
+
'464',
|
|
9
|
+
'DOUBLE_SPEND_ATTEMPTED',
|
|
10
|
+
'REJECTED',
|
|
11
|
+
'INVALID',
|
|
12
|
+
'MALFORMED',
|
|
13
|
+
'MINED_IN_STALE_BLOCK'
|
|
14
|
+
]);
|
|
15
|
+
function isTerminalBroadcastFailure(failure) {
|
|
16
|
+
const code = failure.code.toUpperCase();
|
|
17
|
+
const description = failure.description.toUpperCase();
|
|
18
|
+
if (TERMINAL_CODES.has(code))
|
|
19
|
+
return true;
|
|
20
|
+
if (code.includes('ORPHAN') || description.includes('ORPHAN'))
|
|
21
|
+
return true;
|
|
22
|
+
if (typeof failure.more === 'object' &&
|
|
23
|
+
failure.more !== null &&
|
|
24
|
+
'terminal' in failure.more &&
|
|
25
|
+
failure.more.terminal === true) {
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Tries transaction propagation providers in priority order.
|
|
32
|
+
*
|
|
33
|
+
* Transient provider failures fall through to the next provider. Terminal
|
|
34
|
+
* validation states, including double spends, stop immediately so a conflicting
|
|
35
|
+
* transaction is not retried against a second propagation surface.
|
|
36
|
+
*/
|
|
37
|
+
class ProviderChainBroadcaster {
|
|
38
|
+
constructor(providers) {
|
|
39
|
+
this.providers = providers;
|
|
40
|
+
if (providers.length === 0) {
|
|
41
|
+
throw new TypeError('ProviderChainBroadcaster requires at least one provider');
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
async broadcast(tx) {
|
|
45
|
+
const failures = [];
|
|
46
|
+
for (const provider of this.providers) {
|
|
47
|
+
let response;
|
|
48
|
+
try {
|
|
49
|
+
response = await provider.broadcaster.broadcast(tx);
|
|
50
|
+
}
|
|
51
|
+
catch (error) {
|
|
52
|
+
response = {
|
|
53
|
+
status: 'error',
|
|
54
|
+
code: '500',
|
|
55
|
+
description: error instanceof Error ? error.message : 'Internal Server Error',
|
|
56
|
+
more: { provider: provider.name, terminal: false }
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
if (response.status === 'success') {
|
|
60
|
+
return {
|
|
61
|
+
...response,
|
|
62
|
+
message: `[${provider.name}] ${response.message}`
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
failures.push({ provider: provider.name, failure: response });
|
|
66
|
+
if (isTerminalBroadcastFailure(response)) {
|
|
67
|
+
return annotateFailure(response, provider.name, failures);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
const last = failures[failures.length - 1];
|
|
71
|
+
return annotateFailure(last.failure, last.provider, failures);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
exports.ProviderChainBroadcaster = ProviderChainBroadcaster;
|
|
75
|
+
function annotateFailure(failure, provider, failures) {
|
|
76
|
+
return {
|
|
77
|
+
...failure,
|
|
78
|
+
more: {
|
|
79
|
+
...(typeof failure.more === 'object' && failure.more !== null ? failure.more : {}),
|
|
80
|
+
provider,
|
|
81
|
+
providerFailures: failures.map(item => ({
|
|
82
|
+
provider: item.provider,
|
|
83
|
+
code: item.failure.code,
|
|
84
|
+
description: item.failure.description,
|
|
85
|
+
txid: item.failure.txid,
|
|
86
|
+
more: item.failure.more
|
|
87
|
+
}))
|
|
88
|
+
}
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=ProviderChainBroadcaster.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ProviderChainBroadcaster.js","sourceRoot":"","sources":["../../../src/ProviderChainBroadcaster.ts"],"names":[],"mappings":";;;AAYA,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,wBAAwB;IACxB,UAAU;IACV,SAAS;IACT,WAAW;IACX,sBAAsB;CACvB,CAAC,CAAA;AAEF,SAAS,0BAA0B,CAAE,OAAyB;IAC5D,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;IACvC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAA;IACrD,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IACzC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAA;IAC1E,IACE,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;QAChC,OAAO,CAAC,IAAI,KAAK,IAAI;QACrB,UAAU,IAAI,OAAO,CAAC,IAAI;QAC1B,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,EAC9B,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAa,wBAAwB;IACnC,YAA8B,SAA6B;QAA7B,cAAS,GAAT,SAAS,CAAoB;QACzD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,SAAS,CAAC,yDAAyD,CAAC,CAAA;QAChF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAE,EAAe;QAC9B,MAAM,QAAQ,GAA2D,EAAE,CAAA;QAE3E,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,QAA8C,CAAA;YAClD,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACrD,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,QAAQ,GAAG;oBACT,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,KAAK;oBACX,WAAW,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;oBAC7E,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;iBACnD,CAAA;YACH,CAAC;YAED,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAClC,OAAO;oBACL,GAAG,QAAQ;oBACX,OAAO,EAAE,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,EAAE;iBAClD,CAAA;YACH,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAA;YAC7D,IAAI,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzC,OAAO,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;YAC3D,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC1C,OAAO,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC/D,CAAC;CACF;AAvCD,4DAuCC;AAED,SAAS,eAAe,CACtB,OAAyB,EACzB,QAAgB,EAChB,QAAgE;IAEhE,OAAO;QACL,GAAG,OAAO;QACV,IAAI,EAAE;YACJ,GAAG,CAAC,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,QAAQ;YACR,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACtC,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;gBACvB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;gBACrC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;gBACvB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;aACxB,CAAC,CAAC;SACJ;KACF,CAAA;AACH,CAAC"}
|
|
@@ -12,7 +12,7 @@ A Topic Manager controls addition and removal of transaction outputs to an Overl
|
|
|
12
12
|
#### Request Headers
|
|
13
13
|
\\\`\\\`\\\`json
|
|
14
14
|
{
|
|
15
|
-
"x-topics": "
|
|
15
|
+
"x-topics": "tm_messagebox", // comma-separated topic identifiers
|
|
16
16
|
"x-includes-off-chain-values": "false" // string "true" or "false"
|
|
17
17
|
}
|
|
18
18
|
\\\`\\\`\\\`
|