@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
package/README.md
CHANGED
|
@@ -11,6 +11,9 @@ An opinionated but configurable Overlay Services deployment system:
|
|
|
11
11
|
- Uses common Knex/SQL and Mongo databases across all services for efficiency
|
|
12
12
|
- Supports SHIP, SLAP, and GASP sync out of the box (or it can be disabled)
|
|
13
13
|
- Supports Arc callbacks natively for production (or disable it for simplicity during local development)
|
|
14
|
+
- Supports Arcade-first broadcast/proof lookup, Arc fallback broadcast,
|
|
15
|
+
Chaintracks header validation, BASM reorg streaming, and active
|
|
16
|
+
monitor-driven maintenance
|
|
14
17
|
|
|
15
18
|
## Example Usage
|
|
16
19
|
|
|
@@ -55,6 +58,31 @@ const main = async () => {
|
|
|
55
58
|
// For simple local deployments, sync can be disabled.
|
|
56
59
|
server.configureEnableGASPSync(false)
|
|
57
60
|
|
|
61
|
+
// Production deployments should configure at least one transaction
|
|
62
|
+
// propagation provider. Arcade can be used as the primary provider with Arc
|
|
63
|
+
// as a fallback. The callback token is optional, but recommended when
|
|
64
|
+
// exposing /arc-ingest publicly.
|
|
65
|
+
server.configureArcade(process.env.ARCADE_URL!, {
|
|
66
|
+
apiKey: process.env.ARCADE_API_KEY,
|
|
67
|
+
deploymentId: process.env.ARCADE_DEPLOYMENT_ID,
|
|
68
|
+
chaintracksApiPrefix: '/chaintracks/v2'
|
|
69
|
+
})
|
|
70
|
+
if (process.env.ARC_API_KEY) {
|
|
71
|
+
server.configureArcApiKey(process.env.ARC_API_KEY)
|
|
72
|
+
}
|
|
73
|
+
if (process.env.ARC_CALLBACK_TOKEN) {
|
|
74
|
+
server.configureArcCallbackToken(process.env.ARC_CALLBACK_TOKEN)
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
// Chaintracks-compatible services provide block headers for BASM and can
|
|
78
|
+
// stream reorg notifications. Arcade exposes go-chaintracks under
|
|
79
|
+
// /chaintracks/v2.
|
|
80
|
+
server.configureChaintracks(process.env.CHAINTRACKS_URL ?? process.env.ARCADE_URL!, {
|
|
81
|
+
apiPrefix: '/chaintracks/v2',
|
|
82
|
+
reorgStream: true,
|
|
83
|
+
scanDepth: 3
|
|
84
|
+
})
|
|
85
|
+
|
|
58
86
|
// Lastly, configure the engine and start the server!
|
|
59
87
|
await server.configureEngine()
|
|
60
88
|
await server.start()
|
|
@@ -82,9 +110,84 @@ server.configureEngineParams({
|
|
|
82
110
|
})
|
|
83
111
|
```
|
|
84
112
|
|
|
113
|
+
`throwOnBroadcastFailure` should remain `true` for most production overlays. With
|
|
114
|
+
provider-chain broadcast configured, this means a transaction is not committed to
|
|
115
|
+
overlay state unless at least one provider accepts it or returns an already-known
|
|
116
|
+
success. Set it to `false` only for deliberate offline/dev workflows where local
|
|
117
|
+
overlay admission may proceed without current network propagation.
|
|
118
|
+
|
|
119
|
+
### Transaction Propagation Providers
|
|
120
|
+
|
|
121
|
+
Overlay Express can compose multiple transaction propagation and proof sources:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
server.configureArcade('https://arcade-v2-us-1.bsvblockchain.tech', {
|
|
125
|
+
apiKey: process.env.ARCADE_API_KEY,
|
|
126
|
+
deploymentId: 'my-overlay-node',
|
|
127
|
+
chaintracksApiPrefix: '/chaintracks/v2'
|
|
128
|
+
})
|
|
129
|
+
|
|
130
|
+
server.configureArcApiKey(process.env.ARC_API_KEY!)
|
|
131
|
+
server.configureArcCallbackToken(process.env.ARC_CALLBACK_TOKEN!)
|
|
132
|
+
|
|
133
|
+
server.configureChaintracks('https://arcade-v2-us-1.bsvblockchain.tech', {
|
|
134
|
+
apiPrefix: '/chaintracks/v2',
|
|
135
|
+
reorgStream: true,
|
|
136
|
+
scanDepth: 3
|
|
137
|
+
})
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
- `configureArcade` registers Arcade as the first-choice broadcaster and proof
|
|
141
|
+
lookup provider.
|
|
142
|
+
- `configureArcApiKey` registers the standard Arc broadcaster as fallback.
|
|
143
|
+
- `configureArcCallbackToken` requires inbound `/arc-ingest` callbacks to present
|
|
144
|
+
the expected token.
|
|
145
|
+
- `configureChaintracks` configures a go-chaintracks compatible service for block
|
|
146
|
+
header lookup, BASM anchor header resolution, and optional reorg SSE.
|
|
147
|
+
|
|
148
|
+
Provider callbacks posted to `/arc-ingest` are classified as successful proof,
|
|
149
|
+
terminal invalidation, double spend, or transient status. Double-spend and other
|
|
150
|
+
terminal invalid statuses remove the affected transaction from the admitted
|
|
151
|
+
overlay state so the lookup layer does not keep serving data that the network has
|
|
152
|
+
rejected.
|
|
153
|
+
|
|
154
|
+
### BASM And Unproven Maintenance
|
|
155
|
+
|
|
156
|
+
BASM is opt-in because it requires direct proofs and block header resolution:
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
server.configureEnableBASMSync(true)
|
|
160
|
+
server.configureBASMBlockPollInterval(10 * 60 * 1000)
|
|
161
|
+
server.configureUnprovenMaintenance({
|
|
162
|
+
intervalMs: 60 * 60 * 1000,
|
|
163
|
+
thresholdBlocks: 144
|
|
164
|
+
})
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
When configured, unproven maintenance first tries the configured proof providers
|
|
168
|
+
for transactions that remain unproven past the threshold. Only transactions that
|
|
169
|
+
still cannot be proven are evicted. Operators can also run this manually through
|
|
170
|
+
the admin endpoints documented below.
|
|
171
|
+
|
|
85
172
|
### Admin-Protected Endpoints
|
|
86
173
|
|
|
87
|
-
We also
|
|
174
|
+
We also provide admin-protected endpoints for advanced operations like manually
|
|
175
|
+
syncing advertisements, triggering GASP/BASM sync, running unproven maintenance,
|
|
176
|
+
evicting specific outpoints, and running the janitor. These endpoints require a
|
|
177
|
+
Bearer token. You can supply a custom token in the constructor of
|
|
178
|
+
`OverlayExpress`, or retrieve the auto-generated token by calling
|
|
179
|
+
`server.getAdminToken()`.
|
|
180
|
+
|
|
181
|
+
Common admin endpoints:
|
|
182
|
+
|
|
183
|
+
- `POST /admin/syncAdvertisements`
|
|
184
|
+
- `POST /admin/startGASPSync`
|
|
185
|
+
- `POST /admin/startBASMSync`
|
|
186
|
+
- `POST /admin/refreshUnprovenProofs`
|
|
187
|
+
- `POST /admin/evictUnproven`
|
|
188
|
+
- `POST /admin/maintainUnproven`
|
|
189
|
+
- `POST /admin/evictOutpoint`
|
|
190
|
+
- `POST /admin/janitor`
|
|
88
191
|
|
|
89
192
|
### Health Endpoints
|
|
90
193
|
|
|
@@ -118,7 +221,12 @@ The janitor service also understands the richer `/health` response format, so ex
|
|
|
118
221
|
|
|
119
222
|
### Overlay Monitor
|
|
120
223
|
|
|
121
|
-
`OverlayMonitor` provides a reusable worker for monitoring Overlay Express lookup
|
|
224
|
+
`OverlayMonitor` provides a reusable worker for monitoring Overlay Express lookup
|
|
225
|
+
behavior and, when configured with an admin token, running maintenance actions.
|
|
226
|
+
It posts configured `/lookup` probes to any Overlay Express deployment, measures
|
|
227
|
+
response size, parses returned BEEF, and reports whether responsive output
|
|
228
|
+
transactions have direct Merkle proofs or are being served with deeper proof
|
|
229
|
+
ancestry.
|
|
122
230
|
|
|
123
231
|
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
232
|
|
|
@@ -138,7 +246,15 @@ const monitor = new OverlayMonitor({
|
|
|
138
246
|
query: { topic: 'tm_example' },
|
|
139
247
|
maxOutputs: 20
|
|
140
248
|
}
|
|
141
|
-
]
|
|
249
|
+
],
|
|
250
|
+
adminToken: process.env.OVERLAY_ADMIN_TOKEN,
|
|
251
|
+
maintenance: {
|
|
252
|
+
startBASMSync: true,
|
|
253
|
+
maintainUnproven: {
|
|
254
|
+
thresholdBlocks: 144
|
|
255
|
+
},
|
|
256
|
+
janitor: true
|
|
257
|
+
}
|
|
142
258
|
}
|
|
143
259
|
],
|
|
144
260
|
onReport: async report => {
|
|
@@ -149,6 +265,9 @@ const monitor = new OverlayMonitor({
|
|
|
149
265
|
monitor.start()
|
|
150
266
|
```
|
|
151
267
|
|
|
268
|
+
Maintenance requests are reported alongside lookup probes so operators can alert
|
|
269
|
+
on failed maintenance separately from lookup/proof-shape warnings.
|
|
270
|
+
|
|
152
271
|
## License
|
|
153
272
|
|
|
154
273
|
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.analyzeOverlayLookupResponse = exports.analyzeOverlayAnchorTip = exports.OverlayMonitor = exports.JanitorService = exports.BanAwareSLAPStorage = exports.BanAwareSHIPStorage = exports.BanAwareTopicManager = exports.BanAwareLookupWrapper = exports.BanService = exports.default = void 0;
|
|
6
|
+
exports.ChaintracksProvider = exports.ProviderChainBroadcaster = exports.isTerminalArcStatus = exports.ArcadeProvider = exports.analyzeOverlayLookupResponse = exports.analyzeOverlayAnchorTip = exports.OverlayMonitor = exports.JanitorService = exports.BanAwareSLAPStorage = exports.BanAwareSHIPStorage = exports.BanAwareTopicManager = 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");
|
|
@@ -21,4 +21,11 @@ var OverlayMonitor_js_1 = require("./src/OverlayMonitor.js");
|
|
|
21
21
|
Object.defineProperty(exports, "OverlayMonitor", { enumerable: true, get: function () { return OverlayMonitor_js_1.OverlayMonitor; } });
|
|
22
22
|
Object.defineProperty(exports, "analyzeOverlayAnchorTip", { enumerable: true, get: function () { return OverlayMonitor_js_1.analyzeOverlayAnchorTip; } });
|
|
23
23
|
Object.defineProperty(exports, "analyzeOverlayLookupResponse", { enumerable: true, get: function () { return OverlayMonitor_js_1.analyzeOverlayLookupResponse; } });
|
|
24
|
+
var ArcadeProvider_js_1 = require("./src/ArcadeProvider.js");
|
|
25
|
+
Object.defineProperty(exports, "ArcadeProvider", { enumerable: true, get: function () { return ArcadeProvider_js_1.ArcadeProvider; } });
|
|
26
|
+
Object.defineProperty(exports, "isTerminalArcStatus", { enumerable: true, get: function () { return ArcadeProvider_js_1.isTerminalArcStatus; } });
|
|
27
|
+
var ProviderChainBroadcaster_js_1 = require("./src/ProviderChainBroadcaster.js");
|
|
28
|
+
Object.defineProperty(exports, "ProviderChainBroadcaster", { enumerable: true, get: function () { return ProviderChainBroadcaster_js_1.ProviderChainBroadcaster; } });
|
|
29
|
+
var ChaintracksProvider_js_1 = require("./src/ChaintracksProvider.js");
|
|
30
|
+
Object.defineProperty(exports, "ChaintracksProvider", { enumerable: true, get: function () { return ChaintracksProvider_js_1.ChaintracksProvider; } });
|
|
24
31
|
//# 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,6DAUgC;AAT9B,6HAAA,OAAO,OAAA;AAUT,qDAAmE;AAA1D,2GAAA,UAAU,OAAA;AACnB,2EAAsE;AAA7D,iIAAA,qBAAqB,OAAA;AAC9B,yEAAoE;AAA3D,+HAAA,oBAAoB,OAAA;AAC7B,iFAA4F;AAAnF,kIAAA,mBAAmB,OAAA;AAAE,kIAAA,mBAAmB,OAAA;AACjD,6DAAuH;AAA9G,mHAAA,cAAc,OAAA;AACvB,6DAegC;AAd9B,mHAAA,cAAc,OAAA;AACd,4HAAA,uBAAuB,OAAA;AACvB,iIAAA,4BAA4B,OAAA"}
|
|
1
|
+
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,6DAUgC;AAT9B,6HAAA,OAAO,OAAA;AAUT,qDAAmE;AAA1D,2GAAA,UAAU,OAAA;AACnB,2EAAsE;AAA7D,iIAAA,qBAAqB,OAAA;AAC9B,yEAAoE;AAA3D,+HAAA,oBAAoB,OAAA;AAC7B,iFAA4F;AAAnF,kIAAA,mBAAmB,OAAA;AAAE,kIAAA,mBAAmB,OAAA;AACjD,6DAAuH;AAA9G,mHAAA,cAAc,OAAA;AACvB,6DAegC;AAd9B,mHAAA,cAAc,OAAA;AACd,4HAAA,uBAAuB,OAAA;AACvB,iIAAA,4BAA4B,OAAA;AAa9B,6DAKgC;AAJ9B,mHAAA,cAAc,OAAA;AACd,wHAAA,mBAAmB,OAAA;AAIrB,iFAG0C;AAFxC,uIAAA,wBAAwB,OAAA;AAG1B,uEAIqC;AAHnC,6HAAA,mBAAmB,OAAA"}
|
package/dist/cjs/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bsv/overlay-express",
|
|
3
|
-
"version": "2.4.
|
|
3
|
+
"version": "2.4.2",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"description": "BSV Blockchain Overlay Express",
|
|
6
6
|
"files": [
|
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
"test": "jest",
|
|
15
15
|
"test:watch": "jest --watch",
|
|
16
16
|
"test:coverage": "jest --coverage",
|
|
17
|
-
"lint": "
|
|
18
|
-
"lint:ci": "
|
|
17
|
+
"lint": "oxlint src",
|
|
18
|
+
"lint:ci": "oxlint src",
|
|
19
19
|
"build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
|
|
20
20
|
"dev": "tsc -b -w",
|
|
21
21
|
"prepublish": "npm run build",
|
|
@@ -41,33 +41,33 @@
|
|
|
41
41
|
},
|
|
42
42
|
"homepage": "https://github.com/bsv-blockchain/ts-stack/tree/main/packages/overlays/overlay-express#readme",
|
|
43
43
|
"devDependencies": {
|
|
44
|
+
"@bsv/sdk": "workspace:^",
|
|
44
45
|
"@jest/globals": "^30.4.1",
|
|
45
|
-
"@types/body-parser": "^1.19.
|
|
46
|
-
"@types/express": "^5.0.
|
|
46
|
+
"@types/body-parser": "^1.19.6",
|
|
47
|
+
"@types/express": "^5.0.6",
|
|
47
48
|
"@types/jest": "^30.0.0",
|
|
48
|
-
"@types/node": "^
|
|
49
|
+
"@types/node": "^26.1.1",
|
|
49
50
|
"jest": "^30.4.2",
|
|
50
|
-
"ts-jest": "^29.4.
|
|
51
|
-
"
|
|
52
|
-
"ts2md": "^0.2.0",
|
|
51
|
+
"ts-jest": "^29.4.12",
|
|
52
|
+
"ts2md": "^0.2.8",
|
|
53
53
|
"tsconfig-to-dual-package": "^1.2.0",
|
|
54
54
|
"typescript": "^6.0.3",
|
|
55
|
-
"
|
|
55
|
+
"oxlint": "^1.75.0"
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@bsv/auth-express-middleware": "
|
|
59
|
-
"@bsv/overlay": "
|
|
60
|
-
"@bsv/overlay-discovery-services": "
|
|
61
|
-
"@bsv/wallet-toolbox-client": "
|
|
62
|
-
"body-parser": "^2.
|
|
58
|
+
"@bsv/auth-express-middleware": "workspace:^",
|
|
59
|
+
"@bsv/overlay": "workspace:^",
|
|
60
|
+
"@bsv/overlay-discovery-services": "workspace:^",
|
|
61
|
+
"@bsv/wallet-toolbox-client": "workspace:^",
|
|
62
|
+
"body-parser": "^2.3.0",
|
|
63
63
|
"chalk": "^5.6.2",
|
|
64
64
|
"express": "^5.2.1",
|
|
65
|
-
"knex": "^3.
|
|
66
|
-
"mongodb": "^7.
|
|
67
|
-
"uuid": "^14.0.
|
|
65
|
+
"knex": "^3.3.0",
|
|
66
|
+
"mongodb": "^7.5.0",
|
|
67
|
+
"uuid": "^14.0.1"
|
|
68
68
|
},
|
|
69
69
|
"peerDependencies": {
|
|
70
|
-
"@bsv/sdk": "^2"
|
|
70
|
+
"@bsv/sdk": "^2.1.6"
|
|
71
71
|
},
|
|
72
72
|
"peerDependenciesMeta": {
|
|
73
73
|
"@bsv/sdk": {
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ArcadeProvider = void 0;
|
|
4
|
+
exports.isTerminalArcStatus = isTerminalArcStatus;
|
|
5
|
+
const sdk_1 = require("@bsv/sdk");
|
|
6
|
+
const TERMINAL_STATUSES = new Set([
|
|
7
|
+
'DOUBLE_SPEND_ATTEMPTED',
|
|
8
|
+
'REJECTED',
|
|
9
|
+
'INVALID',
|
|
10
|
+
'MALFORMED',
|
|
11
|
+
'MINED_IN_STALE_BLOCK'
|
|
12
|
+
]);
|
|
13
|
+
const SUCCESS_STATUSES = new Set([
|
|
14
|
+
'RECEIVED',
|
|
15
|
+
'SENT_TO_NETWORK',
|
|
16
|
+
'ANNOUNCED_TO_NETWORK',
|
|
17
|
+
'ACCEPTED_BY_NETWORK',
|
|
18
|
+
'SEEN_ON_NETWORK',
|
|
19
|
+
'STORED',
|
|
20
|
+
'MINED',
|
|
21
|
+
'IMMUTABLE'
|
|
22
|
+
]);
|
|
23
|
+
function isTerminalArcStatus(status, extraInfo) {
|
|
24
|
+
const statusText = typeof status === 'string' ? status.toUpperCase() : '';
|
|
25
|
+
const extraText = typeof extraInfo === 'string' ? extraInfo.toUpperCase() : '';
|
|
26
|
+
return TERMINAL_STATUSES.has(statusText) || statusText.includes('ORPHAN') || extraText.includes('ORPHAN');
|
|
27
|
+
}
|
|
28
|
+
function trimBaseUrl(url) {
|
|
29
|
+
let base = url;
|
|
30
|
+
while (base.endsWith('/'))
|
|
31
|
+
base = base.slice(0, -1);
|
|
32
|
+
return base;
|
|
33
|
+
}
|
|
34
|
+
function parseDescription(data, fallback) {
|
|
35
|
+
var _a, _b, _c, _d, _e, _f;
|
|
36
|
+
if (typeof data === 'string')
|
|
37
|
+
return data;
|
|
38
|
+
if (typeof data === 'object' && data !== null) {
|
|
39
|
+
const d = data;
|
|
40
|
+
return (_f = (_c = (_b = (_a = d.detail) !== null && _a !== void 0 ? _a : d.reason) !== null && _b !== void 0 ? _b : d.error) !== null && _c !== void 0 ? _c : `${(_d = d.txStatus) !== null && _d !== void 0 ? _d : ''} ${(_e = d.extraInfo) !== null && _e !== void 0 ? _e : ''}`.trim()) !== null && _f !== void 0 ? _f : fallback;
|
|
41
|
+
}
|
|
42
|
+
return fallback;
|
|
43
|
+
}
|
|
44
|
+
function rawTxForArcade(tx) {
|
|
45
|
+
try {
|
|
46
|
+
return tx.toHexEF();
|
|
47
|
+
}
|
|
48
|
+
catch (error) {
|
|
49
|
+
if (error instanceof Error &&
|
|
50
|
+
error.message === 'All inputs must have source transactions when serializing to EF format') {
|
|
51
|
+
return tx.toHex();
|
|
52
|
+
}
|
|
53
|
+
throw error;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Broadcaster/proof client for bsv-blockchain/arcade.
|
|
58
|
+
*
|
|
59
|
+
* Arcade exposes transaction propagation at `/tx` and status/proofs at
|
|
60
|
+
* `/tx/{txid}`. It returns terminal validation and double-spend statuses in the
|
|
61
|
+
* body, so callers must classify those as failed broadcasts even when HTTP
|
|
62
|
+
* accepted the request.
|
|
63
|
+
*/
|
|
64
|
+
class ArcadeProvider {
|
|
65
|
+
constructor(url, config = {}) {
|
|
66
|
+
var _a;
|
|
67
|
+
this.config = config;
|
|
68
|
+
this.name = 'Arcade';
|
|
69
|
+
this.baseUrl = trimBaseUrl(url);
|
|
70
|
+
this.fetcher = (_a = config.fetch) !== null && _a !== void 0 ? _a : fetch;
|
|
71
|
+
}
|
|
72
|
+
async broadcast(tx) {
|
|
73
|
+
var _a, _b, _c, _d;
|
|
74
|
+
const rawTx = rawTxForArcade(tx);
|
|
75
|
+
try {
|
|
76
|
+
const response = await this.fetcher(`${this.baseUrl}/tx`, {
|
|
77
|
+
method: 'POST',
|
|
78
|
+
headers: this.requestHeaders(),
|
|
79
|
+
body: JSON.stringify({ rawTx })
|
|
80
|
+
});
|
|
81
|
+
const data = await this.readResponse(response);
|
|
82
|
+
if (!response.ok) {
|
|
83
|
+
const failure = {
|
|
84
|
+
status: 'error',
|
|
85
|
+
code: (_a = data === null || data === void 0 ? void 0 : data.txStatus) !== null && _a !== void 0 ? _a : String(response.status),
|
|
86
|
+
txid: data === null || data === void 0 ? void 0 : data.txid,
|
|
87
|
+
description: parseDescription(data, response.statusText)
|
|
88
|
+
};
|
|
89
|
+
const more = {
|
|
90
|
+
provider: this.name,
|
|
91
|
+
httpStatus: response.status,
|
|
92
|
+
terminal: response.status === 400 || isTerminalArcStatus(data === null || data === void 0 ? void 0 : data.txStatus, data === null || data === void 0 ? void 0 : data.extraInfo),
|
|
93
|
+
response: data
|
|
94
|
+
};
|
|
95
|
+
if ((data === null || data === void 0 ? void 0 : data.competingTxs) !== undefined) {
|
|
96
|
+
more.competingTxs = data.competingTxs;
|
|
97
|
+
}
|
|
98
|
+
failure.more = more;
|
|
99
|
+
return failure;
|
|
100
|
+
}
|
|
101
|
+
const txStatus = data === null || data === void 0 ? void 0 : data.txStatus;
|
|
102
|
+
if (isTerminalArcStatus(txStatus, data === null || data === void 0 ? void 0 : data.extraInfo)) {
|
|
103
|
+
const failure = {
|
|
104
|
+
status: 'error',
|
|
105
|
+
code: txStatus !== null && txStatus !== void 0 ? txStatus : 'UNKNOWN',
|
|
106
|
+
txid: data === null || data === void 0 ? void 0 : data.txid,
|
|
107
|
+
description: `${txStatus !== null && txStatus !== void 0 ? txStatus : ''} ${(_b = data === null || data === void 0 ? void 0 : data.extraInfo) !== null && _b !== void 0 ? _b : ''}`.trim()
|
|
108
|
+
};
|
|
109
|
+
const more = { provider: this.name, terminal: true, response: data };
|
|
110
|
+
if ((data === null || data === void 0 ? void 0 : data.competingTxs) !== undefined) {
|
|
111
|
+
more.competingTxs = data.competingTxs;
|
|
112
|
+
}
|
|
113
|
+
failure.more = more;
|
|
114
|
+
return failure;
|
|
115
|
+
}
|
|
116
|
+
const statusText = typeof txStatus === 'string' ? txStatus.toUpperCase() : undefined;
|
|
117
|
+
return {
|
|
118
|
+
status: 'success',
|
|
119
|
+
txid: (_c = data === null || data === void 0 ? void 0 : data.txid) !== null && _c !== void 0 ? _c : tx.id('hex'),
|
|
120
|
+
message: `${txStatus !== null && txStatus !== void 0 ? txStatus : (SUCCESS_STATUSES.has(statusText !== null && statusText !== void 0 ? statusText : '') ? statusText !== null && statusText !== void 0 ? statusText : '' : response.statusText)} ${(_d = data === null || data === void 0 ? void 0 : data.extraInfo) !== null && _d !== void 0 ? _d : ''}`.trim(),
|
|
121
|
+
competingTxs: data === null || data === void 0 ? void 0 : data.competingTxs
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
catch (error) {
|
|
125
|
+
return {
|
|
126
|
+
status: 'error',
|
|
127
|
+
code: '500',
|
|
128
|
+
description: error instanceof Error ? error.message : 'Internal Server Error',
|
|
129
|
+
more: { provider: this.name, terminal: false }
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
async fetchMerkleProof(txid) {
|
|
134
|
+
var _a;
|
|
135
|
+
const response = await this.fetcher(`${this.baseUrl}/tx/${txid}`, {
|
|
136
|
+
method: 'GET',
|
|
137
|
+
headers: this.requestHeaders({ accept: 'application/json' })
|
|
138
|
+
});
|
|
139
|
+
if (response.status === 404)
|
|
140
|
+
return undefined;
|
|
141
|
+
const data = await this.readResponse(response);
|
|
142
|
+
if (!response.ok) {
|
|
143
|
+
throw new Error(`Arcade proof lookup failed for ${txid}: ${response.status} ${parseDescription(data, response.statusText)}`);
|
|
144
|
+
}
|
|
145
|
+
const mined = (data === null || data === void 0 ? void 0 : data.txStatus) === 'MINED' || (data === null || data === void 0 ? void 0 : data.txStatus) === 'IMMUTABLE';
|
|
146
|
+
if (!mined || (data === null || data === void 0 ? void 0 : data.merklePath) === undefined || data.merklePath === '') {
|
|
147
|
+
return undefined;
|
|
148
|
+
}
|
|
149
|
+
const merklePath = sdk_1.MerklePath.fromHex(data.merklePath);
|
|
150
|
+
return {
|
|
151
|
+
txid,
|
|
152
|
+
merklePath,
|
|
153
|
+
blockHeight: (_a = data.blockHeight) !== null && _a !== void 0 ? _a : merklePath.blockHeight,
|
|
154
|
+
blockHash: data.blockHash,
|
|
155
|
+
merkleRoot: merklePath.computeRoot(txid)
|
|
156
|
+
};
|
|
157
|
+
}
|
|
158
|
+
requestHeaders(options = {}) {
|
|
159
|
+
var _a;
|
|
160
|
+
const headers = {
|
|
161
|
+
Accept: (_a = options.accept) !== null && _a !== void 0 ? _a : 'application/json',
|
|
162
|
+
'Content-Type': 'application/json'
|
|
163
|
+
};
|
|
164
|
+
if (this.config.deploymentId !== undefined && this.config.deploymentId !== '') {
|
|
165
|
+
headers['XDeployment-ID'] = this.config.deploymentId;
|
|
166
|
+
}
|
|
167
|
+
if (this.config.apiKey !== undefined && this.config.apiKey !== '') {
|
|
168
|
+
headers.Authorization = `Bearer ${this.config.apiKey}`;
|
|
169
|
+
}
|
|
170
|
+
if (this.config.callbackUrl !== undefined && this.config.callbackUrl !== '') {
|
|
171
|
+
headers['X-CallbackUrl'] = this.config.callbackUrl;
|
|
172
|
+
}
|
|
173
|
+
if (this.config.callbackToken !== undefined && this.config.callbackToken !== '') {
|
|
174
|
+
headers['X-CallbackToken'] = this.config.callbackToken;
|
|
175
|
+
}
|
|
176
|
+
if (this.config.headers !== undefined) {
|
|
177
|
+
for (const [key, value] of Object.entries(this.config.headers)) {
|
|
178
|
+
headers[key] = value;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
return headers;
|
|
182
|
+
}
|
|
183
|
+
async readResponse(response) {
|
|
184
|
+
const text = await response.text();
|
|
185
|
+
if (text === '')
|
|
186
|
+
return undefined;
|
|
187
|
+
try {
|
|
188
|
+
return JSON.parse(text);
|
|
189
|
+
}
|
|
190
|
+
catch {
|
|
191
|
+
return text;
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
exports.ArcadeProvider = ArcadeProvider;
|
|
196
|
+
//# sourceMappingURL=ArcadeProvider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ArcadeProvider.js","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":";;;AA0DA,kDAIC;AA9DD,kCAMiB;AAiCjB,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,wBAAwB;IACxB,UAAU;IACV,SAAS;IACT,WAAW;IACX,sBAAsB;CACvB,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC;IAC/B,UAAU;IACV,iBAAiB;IACjB,sBAAsB;IACtB,qBAAqB;IACrB,iBAAiB;IACjB,QAAQ;IACR,OAAO;IACP,WAAW;CACZ,CAAC,CAAA;AAEF,SAAgB,mBAAmB,CAAE,MAAe,EAAE,SAAmB;IACvE,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACzE,MAAM,SAAS,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IAC9E,OAAO,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC3G,CAAC;AAED,SAAS,WAAW,CAAE,GAAW;IAC/B,IAAI,IAAI,GAAG,GAAG,CAAA;IACd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACnD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,gBAAgB,CAAE,IAAa,EAAE,QAAgB;;IACxD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,MAAM,CAAC,GAAG,IAAwB,CAAA;QAClC,OAAO,MAAA,MAAA,MAAA,MAAA,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAC,KAAK,mCAAI,GAAG,MAAA,CAAC,CAAC,QAAQ,mCAAI,EAAE,IAAI,MAAA,CAAC,CAAC,SAAS,mCAAI,EAAE,EAAE,CAAC,IAAI,EAAE,mCAAI,QAAQ,CAAA;IACzG,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,SAAS,cAAc,CAAE,EAAe;IACtC,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,OAAO,EAAE,CAAA;IACrB,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,IACE,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,OAAO,KAAK,wEAAwE,EAC1F,CAAC;YACD,OAAO,EAAE,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,cAAc;IAKzB,YAAa,GAAW,EAAmB,SAA+B,EAAE;;QAAjC,WAAM,GAAN,MAAM,CAA2B;QAJnE,SAAI,GAAG,QAAQ,CAAA;QAKtB,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,SAAS,CAAE,EAAe;;QAC9B,MAAM,KAAK,GAAG,cAAc,CAAC,EAAE,CAAC,CAAA;QAChC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,KAAK,EAAE;gBACxD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,IAAI,CAAC,cAAc,EAAE;gBAC9B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;aAChC,CAAC,CAAA;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAmB,QAAQ,CAAC,CAAA;YAChE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,OAAO,GAAqB;oBAChC,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC/C,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;oBAChB,WAAW,EAAE,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC;iBACzD,CAAA;gBACD,MAAM,IAAI,GAA4B;oBACpC,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,UAAU,EAAE,QAAQ,CAAC,MAAM;oBAC3B,QAAQ,EAAE,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC;oBACzF,QAAQ,EAAE,IAAI;iBACf,CAAA;gBACD,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,MAAK,SAAS,EAAE,CAAC;oBACrC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;gBACvC,CAAC;gBACD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;gBACnB,OAAO,OAAO,CAAA;YAChB,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAA;YAC/B,IAAI,mBAAmB,CAAC,QAAQ,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,EAAE,CAAC;gBACnD,MAAM,OAAO,GAAqB;oBAChC,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,SAAS;oBAC3B,IAAI,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI;oBAChB,WAAW,EAAE,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,IAAI,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,EAAE,EAAE,CAAC,IAAI,EAAE;iBACjE,CAAA;gBACD,MAAM,IAAI,GAA4B,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;gBAC7F,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,MAAK,SAAS,EAAE,CAAC;oBACrC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;gBACvC,CAAC;gBACD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;gBACnB,OAAO,OAAO,CAAA;YAChB,CAAC;YAED,MAAM,UAAU,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;YACpF,OAAO;gBACL,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,mCAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;gBAChC,OAAO,EAAE,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,EAAE,EAAE,CAAC,IAAI,EAAE;gBAC3I,YAAY,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY;aACjC,CAAA;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,OAAO;gBACL,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;gBAC7E,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;aAC/C,CAAA;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAE,IAAY;;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,OAAO,IAAI,EAAE,EAAE;YAChE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;SAC7D,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,SAAS,CAAA;QAC7C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAmB,QAAQ,CAAC,CAAA;QAChE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,KAAK,QAAQ,CAAC,MAAM,IAAI,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;QAC9H,CAAC;QACD,MAAM,KAAK,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,MAAK,OAAO,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,MAAK,WAAW,CAAA;QAC1E,IAAI,CAAC,KAAK,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,MAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YACvE,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,MAAM,UAAU,GAAG,gBAAU,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACtD,OAAO;YACL,IAAI;YACJ,UAAU;YACV,WAAW,EAAE,MAAA,IAAI,CAAC,WAAW,mCAAI,UAAU,CAAC,WAAW;YACvD,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC;SACzC,CAAA;IACH,CAAC;IAEO,cAAc,CAAE,UAA+B,EAAE;;QACvD,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,kBAAkB;YAC5C,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE,CAAC;YAC9E,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAA;QACtD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAClE,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;QACxD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE,CAAC;YAC5E,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAA;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,EAAE,EAAE,CAAC;YAChF,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAA;QACxD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACtC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/D,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;YACtB,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAI,QAAkB;QAC9C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,SAAS,CAAA;QACjC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAA;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAS,CAAA;QAClB,CAAC;IACH,CAAC;CACF;AAlID,wCAkIC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ChaintracksProvider = void 0;
|
|
4
|
+
function trimUrl(url) {
|
|
5
|
+
let trimmed = url;
|
|
6
|
+
while (trimmed.endsWith('/'))
|
|
7
|
+
trimmed = trimmed.slice(0, -1);
|
|
8
|
+
return trimmed;
|
|
9
|
+
}
|
|
10
|
+
function trimPrefix(prefix) {
|
|
11
|
+
if (prefix === '')
|
|
12
|
+
return '';
|
|
13
|
+
let trimmed = prefix.startsWith('/') ? prefix : `/${prefix}`;
|
|
14
|
+
while (trimmed.endsWith('/'))
|
|
15
|
+
trimmed = trimmed.slice(0, -1);
|
|
16
|
+
return trimmed;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Minimal go-chaintracks HTTP client for Overlay Express.
|
|
20
|
+
*
|
|
21
|
+
* It intentionally implements the SDK ChainTracker surface plus header lookup,
|
|
22
|
+
* which is enough for proof validation, BASM headers, and reorg stream URL
|
|
23
|
+
* construction without depending on wallet-toolbox client export timing.
|
|
24
|
+
*/
|
|
25
|
+
class ChaintracksProvider {
|
|
26
|
+
constructor(url, config = {}) {
|
|
27
|
+
var _a, _b;
|
|
28
|
+
this.baseUrl = `${trimUrl(url)}${trimPrefix((_a = config.apiPrefix) !== null && _a !== void 0 ? _a : '/chaintracks/v2')}`;
|
|
29
|
+
this.fetcher = (_b = config.fetch) !== null && _b !== void 0 ? _b : fetch;
|
|
30
|
+
}
|
|
31
|
+
async currentHeight() {
|
|
32
|
+
const response = await this.getJson('/height');
|
|
33
|
+
return response.height;
|
|
34
|
+
}
|
|
35
|
+
async isValidRootForHeight(root, height) {
|
|
36
|
+
const header = await this.findHeaderForHeight(height);
|
|
37
|
+
return header !== undefined && header.merkleRoot === root;
|
|
38
|
+
}
|
|
39
|
+
async findHeaderForHeight(height) {
|
|
40
|
+
return await this.getJsonOrUndefined(`/header/height/${height}`);
|
|
41
|
+
}
|
|
42
|
+
reorgStreamUrl() {
|
|
43
|
+
return `${this.baseUrl}/reorg/stream`;
|
|
44
|
+
}
|
|
45
|
+
async getJson(path) {
|
|
46
|
+
const value = await this.getJsonOrUndefined(path);
|
|
47
|
+
if (value === undefined) {
|
|
48
|
+
throw new Error(`Chaintracks returned no value for ${path}`);
|
|
49
|
+
}
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
async getJsonOrUndefined(path) {
|
|
53
|
+
const response = await this.fetcher(`${this.baseUrl}${path}`, {
|
|
54
|
+
headers: { Accept: 'application/json' }
|
|
55
|
+
});
|
|
56
|
+
if (response.status === 404)
|
|
57
|
+
return undefined;
|
|
58
|
+
if (!response.ok) {
|
|
59
|
+
throw new Error(`Chaintracks request failed for ${path}: ${response.status} ${response.statusText}`);
|
|
60
|
+
}
|
|
61
|
+
return await response.json();
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
exports.ChaintracksProvider = ChaintracksProvider;
|
|
65
|
+
//# sourceMappingURL=ChaintracksProvider.js.map
|
|
@@ -0,0 +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,MAAa,mBAAmB;IAI9B,YAAa,GAAW,EAAE,SAAoC,EAAE;;QAC9D,IAAI,CAAC,OAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,MAAA,MAAM,CAAC,SAAS,mCAAI,iBAAiB,CAAC,EAAE,CAAA;QACpF,IAAI,CAAC,OAAO,GAAG,MAAA,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,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,KAAK,IAAI,CAAA;IAC3D,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;AA7CD,kDA6CC"}
|