@bsv/overlay-express 2.4.2 → 2.5.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/LICENSE.txt +57 -27
- package/README.md +141 -56
- package/dist/cjs/mod.d.ts +11 -0
- package/dist/cjs/mod.d.ts.map +1 -0
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +26 -13
- package/dist/cjs/src/ArcadeProvider.d.ts +37 -0
- package/dist/cjs/src/ArcadeProvider.d.ts.map +1 -0
- package/dist/cjs/src/ArcadeProvider.js.map +1 -1
- package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts +36 -0
- package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareDiscoveryStorage.js +5 -4
- package/dist/cjs/src/BanAwareDiscoveryStorage.js.map +1 -1
- package/dist/cjs/src/BanAwareLookupWrapper.d.ts +31 -0
- package/dist/cjs/src/BanAwareLookupWrapper.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareLookupWrapper.js +3 -2
- package/dist/cjs/src/BanAwareLookupWrapper.js.map +1 -1
- package/dist/cjs/src/BanAwareTopicManager.d.ts +28 -0
- package/dist/cjs/src/BanAwareTopicManager.d.ts.map +1 -0
- package/dist/cjs/src/BanAwareTopicManager.js +3 -2
- package/dist/cjs/src/BanAwareTopicManager.js.map +1 -1
- package/dist/cjs/src/BanService.d.ts +79 -0
- package/dist/cjs/src/BanService.d.ts.map +1 -0
- package/dist/cjs/src/BanService.js +18 -5
- package/dist/cjs/src/BanService.js.map +1 -1
- package/dist/cjs/src/ChaintracksProvider.d.ts +29 -0
- package/dist/cjs/src/ChaintracksProvider.d.ts.map +1 -0
- package/dist/cjs/src/ChaintracksProvider.js +1 -1
- package/dist/cjs/src/ChaintracksProvider.js.map +1 -1
- package/dist/cjs/src/JanitorService.d.ts +135 -0
- package/dist/cjs/src/JanitorService.d.ts.map +1 -0
- package/dist/cjs/src/JanitorService.js +168 -48
- package/dist/cjs/src/JanitorService.js.map +1 -1
- package/dist/cjs/src/OverlayExpress.d.ts +472 -0
- package/dist/cjs/src/OverlayExpress.d.ts.map +1 -0
- package/dist/cjs/src/OverlayExpress.js +483 -193
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/OverlayMonitor.d.ts +197 -0
- package/dist/cjs/src/OverlayMonitor.d.ts.map +1 -0
- package/dist/cjs/src/OverlayMonitor.js +6 -4
- package/dist/cjs/src/OverlayMonitor.js.map +1 -1
- package/dist/cjs/src/ProviderChainBroadcaster.d.ts +18 -0
- package/dist/cjs/src/ProviderChainBroadcaster.d.ts.map +1 -0
- package/dist/cjs/src/ProviderChainBroadcaster.js +7 -3
- package/dist/cjs/src/ProviderChainBroadcaster.js.map +1 -1
- package/dist/cjs/src/ReorgStream.d.ts +74 -0
- package/dist/cjs/src/ReorgStream.d.ts.map +1 -0
- package/dist/cjs/src/ReorgStream.js +14 -6
- package/dist/cjs/src/ReorgStream.js.map +1 -1
- package/dist/cjs/src/ResourceBoundedLookupWrapper.d.ts +26 -0
- package/dist/cjs/src/ResourceBoundedLookupWrapper.d.ts.map +1 -0
- package/dist/cjs/src/ResourceBoundedLookupWrapper.js +70 -0
- package/dist/cjs/src/ResourceBoundedLookupWrapper.js.map +1 -0
- package/dist/cjs/src/generalGuide.md.d.ts +3 -0
- package/dist/cjs/src/generalGuide.md.d.ts.map +1 -0
- package/dist/cjs/src/generalGuide.md.js.map +1 -1
- package/dist/cjs/src/makeUserInterface.d.ts +22 -0
- package/dist/cjs/src/makeUserInterface.d.ts.map +1 -0
- package/dist/cjs/src/makeUserInterface.js +4 -4
- package/dist/cjs/src/makeUserInterface.js.map +1 -1
- package/dist/cjs/src/security/edgePolicy.d.ts +84 -0
- package/dist/cjs/src/security/edgePolicy.d.ts.map +1 -0
- package/dist/cjs/src/security/edgePolicy.js +533 -0
- package/dist/cjs/src/security/edgePolicy.js.map +1 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/ArcadeProvider.js.map +1 -1
- package/dist/esm/src/BanAwareDiscoveryStorage.js +5 -4
- package/dist/esm/src/BanAwareDiscoveryStorage.js.map +1 -1
- package/dist/esm/src/BanAwareLookupWrapper.js +3 -2
- package/dist/esm/src/BanAwareLookupWrapper.js.map +1 -1
- package/dist/esm/src/BanAwareTopicManager.js +3 -2
- package/dist/esm/src/BanAwareTopicManager.js.map +1 -1
- package/dist/esm/src/BanService.js +18 -5
- package/dist/esm/src/BanService.js.map +1 -1
- package/dist/esm/src/ChaintracksProvider.js +1 -1
- package/dist/esm/src/ChaintracksProvider.js.map +1 -1
- package/dist/esm/src/JanitorService.js +146 -19
- package/dist/esm/src/JanitorService.js.map +1 -1
- package/dist/esm/src/OverlayExpress.js +465 -176
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/ProviderChainBroadcaster.js +7 -3
- package/dist/esm/src/ProviderChainBroadcaster.js.map +1 -1
- package/dist/esm/src/ReorgStream.js +14 -6
- package/dist/esm/src/ReorgStream.js.map +1 -1
- package/dist/esm/src/ResourceBoundedLookupWrapper.js +70 -0
- package/dist/esm/src/ResourceBoundedLookupWrapper.js.map +1 -0
- package/dist/esm/src/makeUserInterface.js +3 -4
- package/dist/esm/src/makeUserInterface.js.map +1 -1
- package/dist/esm/src/security/edgePolicy.js +522 -0
- package/dist/esm/src/security/edgePolicy.js.map +1 -0
- package/dist/types/mod.d.ts +1 -1
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/ArcadeProvider.d.ts.map +1 -1
- package/dist/types/src/BanAwareDiscoveryStorage.d.ts.map +1 -1
- package/dist/types/src/BanAwareLookupWrapper.d.ts.map +1 -1
- package/dist/types/src/BanAwareTopicManager.d.ts.map +1 -1
- package/dist/types/src/BanService.d.ts +2 -4
- package/dist/types/src/BanService.d.ts.map +1 -1
- package/dist/types/src/ChaintracksProvider.d.ts.map +1 -1
- package/dist/types/src/JanitorService.d.ts +21 -1
- package/dist/types/src/JanitorService.d.ts.map +1 -1
- package/dist/types/src/OverlayExpress.d.ts +54 -2
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/OverlayMonitor.d.ts.map +1 -1
- package/dist/types/src/ProviderChainBroadcaster.d.ts.map +1 -1
- package/dist/types/src/ReorgStream.d.ts.map +1 -1
- package/dist/types/src/ResourceBoundedLookupWrapper.d.ts +26 -0
- package/dist/types/src/ResourceBoundedLookupWrapper.d.ts.map +1 -0
- package/dist/types/src/generalGuide.md.d.ts +1 -1
- package/dist/types/src/generalGuide.md.d.ts.map +1 -1
- package/dist/types/src/makeUserInterface.d.ts +1 -2
- package/dist/types/src/makeUserInterface.d.ts.map +1 -1
- package/dist/types/src/security/edgePolicy.d.ts +84 -0
- package/dist/types/src/security/edgePolicy.d.ts.map +1 -0
- package/package.json +47 -25
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +0 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +0 -1
- package/dist/types/tsconfig.types.tsbuildinfo +0 -1
- package/mod.ts +0 -47
- package/src/ArcadeProvider.ts +0 -232
- package/src/BanAwareDiscoveryStorage.ts +0 -91
- package/src/BanAwareLookupWrapper.ts +0 -95
- package/src/BanAwareTopicManager.ts +0 -87
- package/src/BanService.ts +0 -154
- package/src/ChaintracksProvider.ts +0 -79
- package/src/JanitorService.ts +0 -423
- package/src/OverlayExpress.ts +0 -2479
- package/src/OverlayMonitor.ts +0 -817
- package/src/ProviderChainBroadcaster.ts +0 -108
- package/src/ReorgStream.ts +0 -221
- package/src/__tests__/BanAwareDiscoveryStorage.test.ts +0 -131
- package/src/__tests__/BanAwareLookupWrapper.test.ts +0 -255
- package/src/__tests__/BanAwareTopicManager.test.ts +0 -132
- package/src/__tests__/BanService.test.ts +0 -310
- package/src/__tests__/InMemoryMigrationSource.test.ts +0 -11
- package/src/__tests__/JanitorService.test.ts +0 -941
- package/src/__tests__/OverlayExpress.test.ts +0 -1300
- package/src/__tests__/OverlayMonitor.test.ts +0 -255
- package/src/__tests__/OverlayProviders.live.test.ts +0 -43
- package/src/__tests__/OverlayProviders.test.ts +0 -123
- package/src/__tests__/README.md +0 -105
- package/src/__tests__/ReorgStream.test.ts +0 -66
- package/src/__tests__/makeUserInterface.test.ts +0 -193
- package/src/__tests__/setup.ts +0 -36
- package/src/auth-express-middleware.d.ts +0 -16
- package/src/generalGuide.md.ts +0 -74
- package/src/makeUserInterface.ts +0 -1224
package/LICENSE.txt
CHANGED
|
@@ -1,28 +1,58 @@
|
|
|
1
|
-
Open BSV License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
that contains the longest persistent chain of blocks
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Open BSV License Version 6 – granted by BSV Association, Alpenstrasse 15, 6300
|
|
2
|
+
Zug, Switzerland (CHE-427.008.338) ("Licensor"), to you as a user (henceforth
|
|
3
|
+
"You", "User" or "Licensee").
|
|
4
|
+
|
|
5
|
+
For the purposes of this license, the definitions below have the following
|
|
6
|
+
meanings:
|
|
7
|
+
|
|
8
|
+
"Bitcoin Protocol" means the protocol implementation, cryptographic rules,
|
|
9
|
+
network protocols, and consensus mechanisms in the Bitcoin White Paper as
|
|
10
|
+
described here https://protocol.bsvblockchain.org.
|
|
11
|
+
|
|
12
|
+
"Bitcoin White Paper" means the paper entitled 'Bitcoin: A Peer-to-Peer
|
|
13
|
+
Electronic Cash System' published by 'Satoshi Nakamoto' in October 2008.
|
|
14
|
+
|
|
15
|
+
"BSV Blockchain" means:
|
|
16
|
+
|
|
17
|
+
(a) the Bitcoin blockchain containing block height #556767 with the hash
|
|
18
|
+
"000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
|
|
19
|
+
that contains the longest honest persistent chain of blocks which has been
|
|
20
|
+
produced in a manner which is consistent with the rules set forth in the
|
|
21
|
+
Network Access Rules; and
|
|
22
|
+
(b) the test blockchains that contain the longest honest persistent chains of
|
|
23
|
+
blocks which has been produced in a manner which is consistent with the
|
|
24
|
+
rules set forth in the Network Access Rules.
|
|
25
|
+
|
|
26
|
+
"Network Access Rules" or "Rules" means the set of rules regulating the
|
|
27
|
+
relationship between BSV Association and the nodes on BSV based on the Bitcoin
|
|
28
|
+
Protocol rules and those set out in the Bitcoin White Paper, and available here
|
|
29
|
+
https://bsvblockchain.org/network-access-rules.
|
|
30
|
+
|
|
31
|
+
"Software" means the software the subject of this license, including any/all
|
|
32
|
+
intellectual property rights therein and associated documentation files.
|
|
33
|
+
|
|
34
|
+
BSV Association grants permission, free of charge and on a non-exclusive basis
|
|
35
|
+
to any person obtaining a copy of the Software to deal in the Software, including
|
|
36
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute,
|
|
37
|
+
sublicense, and/or sell copies of the Software, and to permit persons to whom the
|
|
38
|
+
Software is furnished to do so, subject to and conditioned upon the following
|
|
39
|
+
conditions:
|
|
40
|
+
|
|
41
|
+
1 - The text "© BSV Association", and this license shall be included in all
|
|
42
|
+
copies or substantial portions of the Software.
|
|
43
|
+
|
|
44
|
+
2 - The Software, and any software that is derived from the Software or parts
|
|
45
|
+
thereof, may only be used exclusively on the BSV Blockchain.
|
|
46
|
+
|
|
47
|
+
For the avoidance of doubt, this license is granted subject to and conditioned
|
|
48
|
+
upon your compliance with these terms only and is limited to uses on the BSV
|
|
49
|
+
Blockchain. Any exercise of rights not compliant with these terms including
|
|
50
|
+
use not for the BSV Blockchain is deemed outside the scope of the license.
|
|
51
|
+
|
|
22
52
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
24
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
25
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
|
26
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
27
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
28
|
-
THE SOFTWARE.
|
|
53
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES REGARDING ENTITLEMENT,
|
|
54
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
55
|
+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS THEREOF BE LIABLE FOR ANY CLAIM,
|
|
56
|
+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
57
|
+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
58
|
+
DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
BSV BLOCKCHAIN | Overlay Express
|
|
4
4
|
|
|
5
5
|
An opinionated but configurable Overlay Services deployment system:
|
|
6
|
+
|
|
6
7
|
- Uses express for HTTP on a given local port
|
|
7
8
|
- Easy setup with just a private key and a hosting URL
|
|
8
9
|
- Import and configure your topic managers the way you want
|
|
@@ -15,6 +16,26 @@ An opinionated but configurable Overlay Services deployment system:
|
|
|
15
16
|
Chaintracks header validation, BASM reorg streaming, and active
|
|
16
17
|
monitor-driven maintenance
|
|
17
18
|
|
|
19
|
+
## Requirements and installation
|
|
20
|
+
|
|
21
|
+
Overlay Express requires Node.js 22 or newer and a separately installed
|
|
22
|
+
`@bsv/sdk` peer dependency.
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install @bsv/overlay-express @bsv/sdk
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
The package provides matching ESM and CommonJS entry points with
|
|
29
|
+
condition-specific declarations:
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import OverlayExpress, { OverlayMonitor } from '@bsv/overlay-express'
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```js
|
|
36
|
+
const { default: OverlayExpress, OverlayMonitor } = require('@bsv/overlay-express')
|
|
37
|
+
```
|
|
38
|
+
|
|
18
39
|
## Example Usage
|
|
19
40
|
|
|
20
41
|
Here's a quick example:
|
|
@@ -26,66 +47,82 @@ dotenv.config()
|
|
|
26
47
|
|
|
27
48
|
// Hi there! Let's configure Overlay Express!
|
|
28
49
|
const main = async () => {
|
|
50
|
+
// We'll make a new server for our overlay node.
|
|
51
|
+
const server = new OverlayExpress(
|
|
52
|
+
// Name your overlay node with a one-word lowercase string
|
|
53
|
+
`testnode`,
|
|
54
|
+
|
|
55
|
+
// Provide the private key that gives your node its identity
|
|
56
|
+
process.env.SERVER_PRIVATE_KEY!,
|
|
57
|
+
|
|
58
|
+
// Provide the public FQDN without a scheme (for example, overlay.example)
|
|
59
|
+
process.env.HOSTING_FQDN!
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
// Decide what port you want the server to listen on.
|
|
63
|
+
server.configurePort(8080)
|
|
64
|
+
|
|
65
|
+
// Public CORS is the default so wallet UIs and mobile-backed web apps can
|
|
66
|
+
// call the protocol from previously unknown domains. Deployments with a
|
|
67
|
+
// closed caller set can opt into exact origins and customize the UI CSP.
|
|
68
|
+
server.configureEdgePolicy({
|
|
69
|
+
allowedOrigins: process.env.OVERLAY_CORS_ALLOWED_ORIGINS?.split(','),
|
|
70
|
+
securityHeaders: {
|
|
71
|
+
contentSecurityPolicy: process.env.OVERLAY_CONTENT_SECURITY_POLICY
|
|
72
|
+
}
|
|
73
|
+
})
|
|
29
74
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
75
|
+
// Connect to your SQL database with Knex
|
|
76
|
+
await server.configureKnex(process.env.KNEX_URL!)
|
|
77
|
+
|
|
78
|
+
// Also, be sure to connect to MongoDB
|
|
79
|
+
await server.configureMongo(process.env.MONGO_URL!)
|
|
80
|
+
|
|
81
|
+
// Here, you will configure the overlay topic managers and lookup services you want.
|
|
82
|
+
// - Topic managers decide what outputs can go in your overlay
|
|
83
|
+
// - Lookup services help people find things in your overlay
|
|
84
|
+
// - Make use of functions like `configureTopicManager` and `configureLookupServiceWithMongo`
|
|
85
|
+
// ADD YOUR OVERLAY SERVICES HERE
|
|
86
|
+
|
|
87
|
+
// For simple local deployments, sync can be disabled.
|
|
88
|
+
server.configureEnableGASPSync(false)
|
|
89
|
+
|
|
90
|
+
// Production deployments should configure at least one transaction
|
|
91
|
+
// propagation provider. Arcade can be used as the primary provider with Arc
|
|
92
|
+
// as a fallback. The callback token is optional, but recommended when
|
|
93
|
+
// exposing /arc-ingest publicly.
|
|
94
|
+
server.configureArcade(process.env.ARCADE_URL!, {
|
|
95
|
+
apiKey: process.env.ARCADE_API_KEY,
|
|
96
|
+
deploymentId: process.env.ARCADE_DEPLOYMENT_ID,
|
|
97
|
+
chaintracksApiPrefix: '/chaintracks/v2'
|
|
98
|
+
})
|
|
99
|
+
if (process.env.ARC_API_KEY) {
|
|
100
|
+
server.configureArcApiKey(process.env.ARC_API_KEY)
|
|
101
|
+
}
|
|
102
|
+
if (process.env.ARC_CALLBACK_TOKEN) {
|
|
103
|
+
server.configureArcCallbackToken(process.env.ARC_CALLBACK_TOKEN)
|
|
104
|
+
}
|
|
57
105
|
|
|
58
|
-
|
|
59
|
-
|
|
106
|
+
// Chaintracks-compatible services provide block headers for BASM and can
|
|
107
|
+
// stream reorg notifications. Arcade exposes go-chaintracks under
|
|
108
|
+
// /chaintracks/v2.
|
|
109
|
+
server.configureChaintracks(process.env.CHAINTRACKS_URL ?? process.env.ARCADE_URL!, {
|
|
110
|
+
apiPrefix: '/chaintracks/v2',
|
|
111
|
+
reorgStream: true,
|
|
112
|
+
scanDepth: 3
|
|
113
|
+
})
|
|
60
114
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
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
|
-
}
|
|
115
|
+
// Lastly, configure the engine and start the server!
|
|
116
|
+
await server.configureEngine()
|
|
117
|
+
await server.start()
|
|
76
118
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
server.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
})
|
|
85
|
-
|
|
86
|
-
// Lastly, configure the engine and start the server!
|
|
87
|
-
await server.configureEngine()
|
|
88
|
-
await server.start()
|
|
119
|
+
// Stop accepting work, stop background synchronization, and close the SQL
|
|
120
|
+
// and MongoDB clients during process or embedding-runtime shutdown.
|
|
121
|
+
const shutdown = async () => {
|
|
122
|
+
await server.close()
|
|
123
|
+
}
|
|
124
|
+
process.once('SIGTERM', () => void shutdown())
|
|
125
|
+
process.once('SIGINT', () => void shutdown())
|
|
89
126
|
}
|
|
90
127
|
|
|
91
128
|
// Happy hacking :)
|
|
@@ -98,6 +135,33 @@ Check out [API.md](./API.md) for the API docs.
|
|
|
98
135
|
|
|
99
136
|
## Additional Features
|
|
100
137
|
|
|
138
|
+
### Public HTTP edge policy
|
|
139
|
+
|
|
140
|
+
Overlay nodes are public protocol services. With no CORS configuration,
|
|
141
|
+
OverlayExpress returns `Access-Control-Allow-Origin: *` and never enables
|
|
142
|
+
cookie credentials. Set `OVERLAY_CORS_MODE=allowlist` with exact
|
|
143
|
+
`OVERLAY_CORS_ALLOWED_ORIGINS`, pass `allowedOrigins` to
|
|
144
|
+
`configureEdgePolicy`, or use `OVERLAY_CORS_MODE=disabled` for a deliberately
|
|
145
|
+
closed browser surface.
|
|
146
|
+
|
|
147
|
+
`configureEdgePolicy` also controls JSON/binary body limits, per-process
|
|
148
|
+
concurrency, Node HTTP timeouts, CSP, and other security headers. Environment
|
|
149
|
+
overrides are listed in `.env.example`. Protocol authentication, admin
|
|
150
|
+
authentication, callback tokens, and input validation remain required
|
|
151
|
+
regardless of CORS mode.
|
|
152
|
+
|
|
153
|
+
CSP applies to documents served by this process; it does not grant or deny API
|
|
154
|
+
callers. Configure UI CSP and API CORS independently. Credentialed cross-origin
|
|
155
|
+
requests require exact allowed origins and must never be combined with a
|
|
156
|
+
wildcard origin.
|
|
157
|
+
|
|
158
|
+
Call `await server.close()` during shutdown. It is idempotent and closes the
|
|
159
|
+
HTTP listener, BASM maintenance timers, the reorg stream, Knex, and MongoDB.
|
|
160
|
+
|
|
161
|
+
Janitor outbound checks accept only public HTTPS targets on the standard port
|
|
162
|
+
and do not follow redirects by default. `allowPrivateHosts: true` exists only
|
|
163
|
+
for isolated local development.
|
|
164
|
+
|
|
101
165
|
### Advanced Engine Configuration
|
|
102
166
|
|
|
103
167
|
We've introduced a new method, `configureEngineParams`, that allows you to pass advanced configuration options to the underlying Overlay Engine. Here's an example usage:
|
|
@@ -268,6 +332,27 @@ monitor.start()
|
|
|
268
332
|
Maintenance requests are reported alongside lookup probes so operators can alert
|
|
269
333
|
on failed maintenance separately from lookup/proof-shape warnings.
|
|
270
334
|
|
|
335
|
+
## Development
|
|
336
|
+
|
|
337
|
+
From the repository root:
|
|
338
|
+
|
|
339
|
+
```bash
|
|
340
|
+
pnpm --filter @bsv/overlay-express format:check
|
|
341
|
+
pnpm --filter @bsv/overlay-express lint
|
|
342
|
+
pnpm --filter @bsv/overlay-express typecheck
|
|
343
|
+
pnpm --filter @bsv/overlay-express test
|
|
344
|
+
pnpm --filter @bsv/overlay-express test:coverage
|
|
345
|
+
pnpm --filter @bsv/overlay-express test:live
|
|
346
|
+
pnpm --filter @bsv/overlay-express pack:check
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
The package check builds locally packed release candidates for Overlay Express
|
|
350
|
+
and its workspace Overlay dependencies, then verifies the npm tarball with
|
|
351
|
+
publint, strict type resolution, and clean ESM/CommonJS consumer projects.
|
|
352
|
+
`test:live` separately verifies public Arcade/Chaintracks endpoints without a
|
|
353
|
+
private credential; it is scheduled/release evidence, not deterministic PR
|
|
354
|
+
coverage.
|
|
355
|
+
|
|
271
356
|
## License
|
|
272
357
|
|
|
273
358
|
The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export { default, type EngineConfig, type EdgePolicyConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus, type TopicAnchorHeaderResolver } from './src/OverlayExpress.js';
|
|
2
|
+
export { BanService, type BannedRecord } from './src/BanService.js';
|
|
3
|
+
export { BanAwareLookupWrapper } from './src/BanAwareLookupWrapper.js';
|
|
4
|
+
export { BanAwareTopicManager } from './src/BanAwareTopicManager.js';
|
|
5
|
+
export { BanAwareSHIPStorage, BanAwareSLAPStorage } from './src/BanAwareDiscoveryStorage.js';
|
|
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';
|
|
8
|
+
export { ArcadeProvider, isTerminalArcStatus, type ArcadeMerkleProof, type ArcadeProviderConfig } from './src/ArcadeProvider.js';
|
|
9
|
+
export { ProviderChainBroadcaster, type NamedBroadcaster } from './src/ProviderChainBroadcaster.js';
|
|
10
|
+
export { ChaintracksProvider, type ChaintracksHeader, type ChaintracksProviderConfig } from './src/ChaintracksProvider.js';
|
|
11
|
+
//# sourceMappingURL=mod.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,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,EACL,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAA;AAChC,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;AAChC,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,wBAAwB,EAAE,KAAK,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACnG,OAAO,EACL,mBAAmB,EACnB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC/B,MAAM,8BAA8B,CAAA"}
|
package/dist/cjs/mod.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;AAAA,6DAWgC;AAV9B,6HAAA,OAAO,OAAA;AAWT,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,6DAKgC;AAJ9B,mHAAA,cAAc,OAAA;AAKhB,6DAegC;AAd9B,mHAAA,cAAc,OAAA;AACd,4HAAA,uBAAuB,OAAA;AACvB,iIAAA,4BAA4B,OAAA;AAa9B,6DAKgC;AAJ9B,mHAAA,cAAc,OAAA;AACd,wHAAA,mBAAmB,OAAA;AAIrB,iFAAmG;AAA1F,uIAAA,wBAAwB,OAAA;AACjC,uEAIqC;AAHnC,6HAAA,mBAAmB,OAAA"}
|
package/dist/cjs/package.json
CHANGED
|
@@ -1,24 +1,35 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bsv/overlay-express",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.5.0",
|
|
4
|
+
"sideEffects": false,
|
|
5
|
+
"engines": {
|
|
6
|
+
"node": ">=22"
|
|
7
|
+
},
|
|
8
|
+
"publishConfig": {
|
|
9
|
+
"access": "public"
|
|
10
|
+
},
|
|
4
11
|
"type": "commonjs",
|
|
5
12
|
"description": "BSV Blockchain Overlay Express",
|
|
6
13
|
"files": [
|
|
7
14
|
"dist",
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"mod.ts",
|
|
15
|
+
"!dist/**/*.tsbuildinfo",
|
|
16
|
+
"README.md",
|
|
11
17
|
"LICENSE.txt"
|
|
12
18
|
],
|
|
13
19
|
"scripts": {
|
|
14
|
-
"test": "jest",
|
|
20
|
+
"test": "jest --watchman=false",
|
|
15
21
|
"test:watch": "jest --watch",
|
|
16
|
-
"test:coverage": "jest --coverage",
|
|
17
|
-
"
|
|
18
|
-
"
|
|
22
|
+
"test:coverage": "jest --coverage --watchman=false",
|
|
23
|
+
"test:property": "jest --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts",
|
|
24
|
+
"test:live": "pnpm build && node ../../../scripts/run-governed-test.mjs live src/__tests__/OverlayProviders.live.test.ts",
|
|
25
|
+
"format:check": "pnpm --workspace-root exec prettier --check \"packages/overlays/overlay-express/{README.md,jest.config.js,mod.ts,package.json,tsconfig*.json}\"",
|
|
26
|
+
"lint": "oxlint mod.ts src jest.config.js --deny-warnings",
|
|
27
|
+
"lint:ci": "pnpm lint",
|
|
28
|
+
"pack:check": "pnpm --filter @bsv/overlay build && pnpm --filter @bsv/overlay-discovery-services build && pnpm build && node ../../../scripts/check-package-artifact.mjs . --exports ArcadeProvider,BanAwareLookupWrapper,BanAwareSHIPStorage,BanAwareSLAPStorage,BanAwareTopicManager,BanService,ChaintracksProvider,JanitorService,OverlayMonitor,ProviderChainBroadcaster,analyzeOverlayAnchorTip,analyzeOverlayLookupResponse,default,isTerminalArcStatus",
|
|
29
|
+
"typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false",
|
|
19
30
|
"build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
|
|
20
31
|
"dev": "tsc -b -w",
|
|
21
|
-
"
|
|
32
|
+
"prepublishOnly": "pnpm build",
|
|
22
33
|
"doc": "ts2md --inputFilename=mod.ts --outputFilename=API.md --filenameSubstring=API --firstHeadingLevel=1",
|
|
23
34
|
"demo": "rm -r dist && npm run build && npx tsx demo-ui.ts"
|
|
24
35
|
},
|
|
@@ -44,21 +55,23 @@
|
|
|
44
55
|
"@bsv/sdk": "workspace:^",
|
|
45
56
|
"@jest/globals": "^30.4.1",
|
|
46
57
|
"@types/body-parser": "^1.19.6",
|
|
47
|
-
"@types/express": "^5.0.6",
|
|
48
58
|
"@types/jest": "^30.0.0",
|
|
49
|
-
"@types/node": "^26.1.
|
|
59
|
+
"@types/node": "^26.1.2",
|
|
60
|
+
"@typescript/native": "npm:typescript@7.0.2",
|
|
61
|
+
"fast-check": "^4.9.0",
|
|
50
62
|
"jest": "^30.4.2",
|
|
63
|
+
"oxlint": "^1.76.0",
|
|
51
64
|
"ts-jest": "^29.4.12",
|
|
52
65
|
"ts2md": "^0.2.8",
|
|
53
66
|
"tsconfig-to-dual-package": "^1.2.0",
|
|
54
|
-
"typescript": "
|
|
55
|
-
"oxlint": "^1.75.0"
|
|
67
|
+
"typescript": "npm:@typescript/typescript6@6.0.2"
|
|
56
68
|
},
|
|
57
69
|
"dependencies": {
|
|
58
70
|
"@bsv/auth-express-middleware": "workspace:^",
|
|
59
71
|
"@bsv/overlay": "workspace:^",
|
|
60
72
|
"@bsv/overlay-discovery-services": "workspace:^",
|
|
61
73
|
"@bsv/wallet-toolbox-client": "workspace:^",
|
|
74
|
+
"@types/express": "^5.0.6",
|
|
62
75
|
"body-parser": "^2.3.0",
|
|
63
76
|
"chalk": "^5.6.2",
|
|
64
77
|
"express": "^5.2.1",
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { BroadcastFailure, Broadcaster, BroadcastResponse, MerklePath, Transaction } from '@bsv/sdk';
|
|
2
|
+
export interface ArcadeProviderConfig {
|
|
3
|
+
apiKey?: string;
|
|
4
|
+
callbackUrl?: string;
|
|
5
|
+
callbackToken?: string;
|
|
6
|
+
deploymentId?: string;
|
|
7
|
+
headers?: Record<string, string>;
|
|
8
|
+
fetch?: typeof fetch;
|
|
9
|
+
}
|
|
10
|
+
export interface ArcadeMerkleProof {
|
|
11
|
+
txid: string;
|
|
12
|
+
merklePath: MerklePath;
|
|
13
|
+
blockHeight?: number;
|
|
14
|
+
blockHash?: string;
|
|
15
|
+
merkleRoot: string;
|
|
16
|
+
}
|
|
17
|
+
export declare function isTerminalArcStatus(status: unknown, extraInfo?: unknown): boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Broadcaster/proof client for bsv-blockchain/arcade.
|
|
20
|
+
*
|
|
21
|
+
* Arcade exposes transaction propagation at `/tx` and status/proofs at
|
|
22
|
+
* `/tx/{txid}`. It returns terminal validation and double-spend statuses in the
|
|
23
|
+
* body, so callers must classify those as failed broadcasts even when HTTP
|
|
24
|
+
* accepted the request.
|
|
25
|
+
*/
|
|
26
|
+
export declare class ArcadeProvider implements Broadcaster {
|
|
27
|
+
private readonly config;
|
|
28
|
+
readonly name = "Arcade";
|
|
29
|
+
private readonly baseUrl;
|
|
30
|
+
private readonly fetcher;
|
|
31
|
+
constructor(url: string, config?: ArcadeProviderConfig);
|
|
32
|
+
broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure>;
|
|
33
|
+
fetchMerkleProof(txid: string): Promise<ArcadeMerkleProof | undefined>;
|
|
34
|
+
private requestHeaders;
|
|
35
|
+
private readResponse;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=ArcadeProvider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ArcadeProvider.d.ts","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,WAAW,EACZ,MAAM,UAAU,CAAA;AAEjB,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAmCD,wBAAgB,mBAAmB,CAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAIlF;AA+BD;;;;;;;GAOG;AACH,qBAAa,cAAe,YAAW,WAAW;IAKtB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAJjD,QAAQ,CAAC,IAAI,YAAW;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IAEtC,YAAa,GAAG,EAAE,MAAM,EAAmB,MAAM,GAAE,oBAAyB,EAG3E;IAEK,SAAS,CAAE,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CA4D/E;IAEK,gBAAgB,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAsB5E;IAED,OAAO,CAAC,cAAc;YAyBR,YAAY;CAS3B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArcadeProvider.js","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ArcadeProvider.js","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":";;;;AAAA,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,6BAAqC,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,+BAAO,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;IAKE,YAAa,GAAW,EAAmB,MAAM,GAAyB,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,SAAG,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,QAAE,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,QAAE,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,QAAE,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,OAAO,GAAwB,EAAE;;QACvD,MAAM,OAAO,GAA2B;YACtC,MAAM,QAAE,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"}
|
|
@@ -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;AAEpE,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;IAHzB,YACmB,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,UAAU,EACtB,MAAM,GAAE,OAAO,OAAiB,EAC/C;IAEE,aAAa,IAAK,OAAO,CAAC,IAAI,CAAC,CAEpC;IAEK,kBAAkB,CAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAE9F;IAEK,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,CAU3H;IAEK,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAExE;IAEK,UAAU,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAEvG;IAEK,OAAO,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAE9F;CACF;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAE5B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHzB,YACmB,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,UAAU,EACtB,MAAM,GAAE,OAAO,OAAiB,EAC/C;IAEE,aAAa,IAAK,OAAO,CAAC,IAAI,CAAC,CAEpC;IAEK,kBAAkB,CAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEhG;IAEK,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,CAU7H;IAEK,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAExE;IAEK,UAAU,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAEvG;IAEK,OAAO,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAE9F;CACF"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.BanAwareSLAPStorage = exports.BanAwareSHIPStorage = void 0;
|
|
4
|
+
const overlay_1 = require("@bsv/overlay");
|
|
4
5
|
/**
|
|
5
6
|
* Prevents banned SHIP records from being written to discovery storage.
|
|
6
7
|
*/
|
|
@@ -18,11 +19,11 @@ class BanAwareSHIPStorage {
|
|
|
18
19
|
}
|
|
19
20
|
async storeSHIPRecord(txid, outputIndex, identityKey, domain, topic) {
|
|
20
21
|
if (await this.banService.isOutpointBanned(txid, outputIndex)) {
|
|
21
|
-
this.logger.log(`[BAN] Blocked banned outpoint
|
|
22
|
+
this.logger.log(`[BAN] Blocked banned outpoint from SHIP storage: txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
22
23
|
return;
|
|
23
24
|
}
|
|
24
25
|
if (await this.banService.isDomainBanned(domain)) {
|
|
25
|
-
this.logger.log(`[BAN] Blocked banned domain
|
|
26
|
+
this.logger.log(`[BAN] Blocked banned domain from SHIP storage: domain=${(0, overlay_1.serializeLogValue)(domain)} txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
26
27
|
return;
|
|
27
28
|
}
|
|
28
29
|
return await this.wrapped.storeSHIPRecord(txid, outputIndex, identityKey, domain, topic);
|
|
@@ -55,11 +56,11 @@ class BanAwareSLAPStorage {
|
|
|
55
56
|
}
|
|
56
57
|
async storeSLAPRecord(txid, outputIndex, identityKey, domain, service) {
|
|
57
58
|
if (await this.banService.isOutpointBanned(txid, outputIndex)) {
|
|
58
|
-
this.logger.log(`[BAN] Blocked banned outpoint
|
|
59
|
+
this.logger.log(`[BAN] Blocked banned outpoint from SLAP storage: txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
59
60
|
return;
|
|
60
61
|
}
|
|
61
62
|
if (await this.banService.isDomainBanned(domain)) {
|
|
62
|
-
this.logger.log(`[BAN] Blocked banned domain
|
|
63
|
+
this.logger.log(`[BAN] Blocked banned domain from SLAP storage: domain=${(0, overlay_1.serializeLogValue)(domain)} txid=${(0, overlay_1.serializeLogValue)(txid)} outputIndex=${(0, overlay_1.serializeLogValue)(outputIndex)}`);
|
|
63
64
|
return;
|
|
64
65
|
}
|
|
65
66
|
return await this.wrapped.storeSLAPRecord(txid, outputIndex, identityKey, domain, service);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BanAwareDiscoveryStorage.js","sourceRoot":"","sources":["../../../src/BanAwareDiscoveryStorage.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"BanAwareDiscoveryStorage.js","sourceRoot":"","sources":["../../../src/BanAwareDiscoveryStorage.ts"],"names":[],"mappings":";;;AACA,0CAAgD;AAMhD;;GAEG;AACH;IACE,YACmB,OAAoB,EACpB,UAAsB,EACtB,MAAM,GAAmB,OAAO;uBAFhC,OAAO;0BACP,UAAU;sBACV,MAAM;IACtB,CAAC;IAEJ,KAAK,CAAC,aAAa;QACjB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAE,WAAmB,EAAE,MAAc,EAAE,KAAa;QAC1E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAC1E,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,IAAY,EAAE,WAAmB,EAAE,WAAmB,EAAE,MAAc,EAAE,KAAa;QAC1G,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yDAAyD,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YACjJ,OAAM;QACR,CAAC;QACD,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yDAAyD,IAAA,2BAAiB,EAAC,MAAM,CAAC,SAAS,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YACnL,OAAM;QACR,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAC1F,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAE,IAAY,EAAE,WAAmB;QACvD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IAC/D,CAAC;IAED,KAAK,CAAC,UAAU,CAAE,GAAG,IAA2C;QAC9D,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CAAE,GAAG,IAAwC;QACxD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAC5C,CAAC;CACF;;AAED;;GAEG;AACH;IACE,YACmB,OAAoB,EACpB,UAAsB,EACtB,MAAM,GAAmB,OAAO;uBAFhC,OAAO;0BACP,UAAU;sBACV,MAAM;IACtB,CAAC;IAEJ,KAAK,CAAC,aAAa;QACjB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAE,WAAmB,EAAE,MAAc,EAAE,OAAe;QAC5E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5E,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,IAAY,EAAE,WAAmB,EAAE,WAAmB,EAAE,MAAc,EAAE,OAAe;QAC5G,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yDAAyD,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YACjJ,OAAM;QACR,CAAC;QACD,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yDAAyD,IAAA,2BAAiB,EAAC,MAAM,CAAC,SAAS,IAAA,2BAAiB,EAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAiB,EAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YACnL,OAAM;QACR,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5F,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAE,IAAY,EAAE,WAAmB;QACvD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IAC/D,CAAC;IAED,KAAK,CAAC,UAAU,CAAE,GAAG,IAA2C;QAC9D,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CAAE,GAAG,IAAwC;QACxD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;IAC5C,CAAC;CACF"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { LookupService, LookupFormula, AdmissionMode, SpendNotificationMode, OutputAdmittedByTopic, OutputSpent, LookupServiceMetaData } from '@bsv/overlay';
|
|
2
|
+
import { LookupQuestion } from '@bsv/sdk';
|
|
3
|
+
import { BanService } from './BanService.js';
|
|
4
|
+
/**
|
|
5
|
+
* Wraps a SHIP or SLAP LookupService to intercept outputAdmittedByTopic calls
|
|
6
|
+
* and block outputs whose domain or outpoint appears in the persistent ban list.
|
|
7
|
+
*
|
|
8
|
+
* This prevents GASP from re-syncing stale or banned tokens that were previously
|
|
9
|
+
* removed by the Janitor or an admin.
|
|
10
|
+
*/
|
|
11
|
+
export declare class BanAwareLookupWrapper implements LookupService {
|
|
12
|
+
private readonly wrapped;
|
|
13
|
+
private readonly banService;
|
|
14
|
+
private readonly protocol;
|
|
15
|
+
private readonly logger;
|
|
16
|
+
readonly admissionMode: AdmissionMode;
|
|
17
|
+
readonly spendNotificationMode: SpendNotificationMode;
|
|
18
|
+
constructor(wrapped: LookupService, banService: BanService, protocol: 'SHIP' | 'SLAP', logger?: typeof console);
|
|
19
|
+
/**
|
|
20
|
+
* Intercepts admission to check the ban list before delegating to the wrapped service.
|
|
21
|
+
* If the output's domain or outpoint is banned, the admission is silently blocked.
|
|
22
|
+
*/
|
|
23
|
+
outputAdmittedByTopic(payload: OutputAdmittedByTopic): Promise<void>;
|
|
24
|
+
outputSpent(payload: OutputSpent): Promise<void>;
|
|
25
|
+
outputNoLongerRetainedInHistory(txid: string, outputIndex: number, topic: string): Promise<void>;
|
|
26
|
+
outputEvicted(txid: string, outputIndex: number): Promise<void>;
|
|
27
|
+
lookup(question: LookupQuestion): Promise<LookupFormula>;
|
|
28
|
+
getDocumentation(): Promise<string>;
|
|
29
|
+
getMetaData(): Promise<LookupServiceMetaData>;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=BanAwareLookupWrapper.d.ts.map
|