@bsv/overlay-express 0.2.0 → 0.2.1

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 CHANGED
@@ -68,6 +68,24 @@ main()
68
68
 
69
69
  Check out [API.md](./API.md) for the API docs.
70
70
 
71
+ ## Additional Features
72
+
73
+ ### Advanced Engine Configuration
74
+
75
+ 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:
76
+
77
+ ```typescript
78
+ server.configureEngineParams({
79
+ logTime: true,
80
+ throwOnBroadcastFailure: true,
81
+ overlayBroadcastFacilitator: new MyCustomFacilitator()
82
+ })
83
+ ```
84
+
85
+ ### Admin-Protected Endpoints
86
+
87
+ We also now provide admin-protected endpoints for certain advanced operations like manually syncing advertisements or triggering GASP sync. These endpoints require a Bearer token. You can supply a custom token in the constructor of `OverlayExpress`, or retrieve the auto-generated token by calling `server.getAdminToken()`. You can then include this token as a Bearer token in the `Authorization` header of requests to the `/admin/syncAdvertisements` and `/admin/startGASPSync` endpoints.
88
+
71
89
  ## License
72
90
 
73
91
  The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
@@ -48,9 +48,9 @@
48
48
  "typescript": "^5.2.2"
49
49
  },
50
50
  "dependencies": {
51
- "@bsv/overlay": "^0.1.22",
51
+ "@bsv/overlay": "^0.1.23",
52
52
  "@bsv/overlay-discovery-services": "^0.1.3",
53
- "@bsv/sdk": "^1.2.22",
53
+ "@bsv/sdk": "^1.3.24",
54
54
  "body-parser": "^1.20.3",
55
55
  "chalk": "^5.3.0",
56
56
  "express": "^4.21.1",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bsv/overlay-express",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "type": "module",
5
5
  "description": "BSV Blockchain Overlay Express",
6
6
  "main": "dist/cjs/mod.js",
@@ -63,9 +63,9 @@
63
63
  "typescript": "^5.2.2"
64
64
  },
65
65
  "dependencies": {
66
- "@bsv/overlay": "^0.1.22",
66
+ "@bsv/overlay": "^0.1.23",
67
67
  "@bsv/overlay-discovery-services": "^0.1.3",
68
- "@bsv/sdk": "^1.2.22",
68
+ "@bsv/sdk": "^1.3.24",
69
69
  "body-parser": "^1.20.3",
70
70
  "chalk": "^5.3.0",
71
71
  "express": "^4.21.1",