@bsv/overlay-express 2.7.5 → 2.9.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 +202 -0
- package/NOTICE +2 -0
- package/PATENTS +12 -0
- package/README.md +179 -2
- package/THIRD_PARTY_NOTICES.md +1 -1
- package/dist/cjs/mod.d.ts +2 -1
- package/dist/cjs/mod.d.ts.map +1 -1
- package/dist/cjs/mod.js.map +1 -1
- package/dist/cjs/package.json +38 -10
- package/dist/cjs/src/ArcadeProvider.d.ts.map +1 -1
- package/dist/cjs/src/ArcadeProvider.js +6 -0
- package/dist/cjs/src/ArcadeProvider.js.map +1 -1
- package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts +10 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.js +125 -0
- package/dist/cjs/src/OutputLookupHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/OutputLookupResponseGuard.d.ts +31 -0
- package/dist/cjs/src/OutputLookupResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupResponseGuard.js +91 -0
- package/dist/cjs/src/OutputLookupResponseGuard.js.map +1 -0
- package/dist/cjs/src/OutputLookupRoutes.d.ts +53 -0
- package/dist/cjs/src/OutputLookupRoutes.d.ts.map +1 -0
- package/dist/cjs/src/OutputLookupRoutes.js +274 -0
- package/dist/cjs/src/OutputLookupRoutes.js.map +1 -0
- package/dist/cjs/src/OverlayExpress.d.ts +82 -0
- package/dist/cjs/src/OverlayExpress.d.ts.map +1 -1
- package/dist/cjs/src/OverlayExpress.js +294 -7
- package/dist/cjs/src/OverlayExpress.js.map +1 -1
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js +90 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.js +108 -0
- package/dist/cjs/src/PrivateAcquisitionResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts +7 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.js +269 -0
- package/dist/cjs/src/PrivateAcquisitionRoutes.js.map +1 -0
- package/dist/cjs/src/PrivateOverlayHost.d.ts +31 -0
- package/dist/cjs/src/PrivateOverlayHost.d.ts.map +1 -0
- package/dist/cjs/src/PrivateOverlayHost.js +64 -0
- package/dist/cjs/src/PrivateOverlayHost.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.js +38 -0
- package/dist/cjs/src/PrivatePublicationHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts +40 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivatePublicationHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts +14 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.js +82 -0
- package/dist/cjs/src/PrivatePublicationResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivatePublicationRoutes.d.ts +6 -0
- package/dist/cjs/src/PrivatePublicationRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePublicationRoutes.js +249 -0
- package/dist/cjs/src/PrivatePublicationRoutes.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js +82 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.js +3 -0
- package/dist/cjs/src/PrivatePurchaseHTTPPorts.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts +15 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.js +85 -0
- package/dist/cjs/src/PrivatePurchaseResponseGuard.js.map +1 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.d.ts +7 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.d.ts.map +1 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.js +276 -0
- package/dist/cjs/src/PrivatePurchaseRoutes.js.map +1 -0
- package/dist/cjs/src/ProposalHTTPPolicy.d.ts +11 -0
- package/dist/cjs/src/ProposalHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/ProposalHTTPPolicy.js +38 -0
- package/dist/cjs/src/ProposalHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/ProposalHTTPPorts.d.ts +59 -0
- package/dist/cjs/src/ProposalHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/ProposalHTTPPorts.js +3 -0
- package/dist/cjs/src/ProposalHTTPPorts.js.map +1 -0
- package/dist/cjs/src/ProposalResponseGuard.d.ts +18 -0
- package/dist/cjs/src/ProposalResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/ProposalResponseGuard.js +61 -0
- package/dist/cjs/src/ProposalResponseGuard.js.map +1 -0
- package/dist/cjs/src/ProposalRoutes.d.ts +10 -0
- package/dist/cjs/src/ProposalRoutes.d.ts.map +1 -0
- package/dist/cjs/src/ProposalRoutes.js +239 -0
- package/dist/cjs/src/ProposalRoutes.js.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts +8 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.js +77 -0
- package/dist/cjs/src/RootEvictionHTTPPolicy.js.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.d.ts +73 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.js +3 -0
- package/dist/cjs/src/RootEvictionHTTPPorts.js.map +1 -0
- package/dist/cjs/src/RootEvictionResponseGuard.d.ts +38 -0
- package/dist/cjs/src/RootEvictionResponseGuard.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionResponseGuard.js +83 -0
- package/dist/cjs/src/RootEvictionResponseGuard.js.map +1 -0
- package/dist/cjs/src/RootEvictionRoutes.d.ts +11 -0
- package/dist/cjs/src/RootEvictionRoutes.d.ts.map +1 -0
- package/dist/cjs/src/RootEvictionRoutes.js +198 -0
- package/dist/cjs/src/RootEvictionRoutes.js.map +1 -0
- package/dist/esm/mod.js.map +1 -1
- package/dist/esm/src/ArcadeProvider.js +6 -0
- package/dist/esm/src/ArcadeProvider.js.map +1 -1
- package/dist/esm/src/OutputLookupHTTPPolicy.js +117 -0
- package/dist/esm/src/OutputLookupHTTPPolicy.js.map +1 -0
- package/dist/esm/src/OutputLookupResponseGuard.js +85 -0
- package/dist/esm/src/OutputLookupResponseGuard.js.map +1 -0
- package/dist/esm/src/OutputLookupRoutes.js +275 -0
- package/dist/esm/src/OutputLookupRoutes.js.map +1 -0
- package/dist/esm/src/OverlayExpress.js +270 -12
- package/dist/esm/src/OverlayExpress.js.map +1 -1
- package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js +82 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPorts.js +2 -0
- package/dist/esm/src/PrivateAcquisitionHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionResponseGuard.js +105 -0
- package/dist/esm/src/PrivateAcquisitionResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivateAcquisitionRoutes.js +267 -0
- package/dist/esm/src/PrivateAcquisitionRoutes.js.map +1 -0
- package/dist/esm/src/PrivateOverlayHost.js +62 -0
- package/dist/esm/src/PrivateOverlayHost.js.map +1 -0
- package/dist/esm/src/PrivatePublicationHTTPPolicy.js +30 -0
- package/dist/esm/src/PrivatePublicationHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivatePublicationHTTPPorts.js +2 -0
- package/dist/esm/src/PrivatePublicationHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivatePublicationResponseGuard.js +79 -0
- package/dist/esm/src/PrivatePublicationResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivatePublicationRoutes.js +247 -0
- package/dist/esm/src/PrivatePublicationRoutes.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseHTTPPolicy.js +74 -0
- package/dist/esm/src/PrivatePurchaseHTTPPolicy.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseHTTPPorts.js +2 -0
- package/dist/esm/src/PrivatePurchaseHTTPPorts.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseResponseGuard.js +82 -0
- package/dist/esm/src/PrivatePurchaseResponseGuard.js.map +1 -0
- package/dist/esm/src/PrivatePurchaseRoutes.js +275 -0
- package/dist/esm/src/PrivatePurchaseRoutes.js.map +1 -0
- package/dist/esm/src/ProposalHTTPPolicy.js +30 -0
- package/dist/esm/src/ProposalHTTPPolicy.js.map +1 -0
- package/dist/esm/src/ProposalHTTPPorts.js +2 -0
- package/dist/esm/src/ProposalHTTPPorts.js.map +1 -0
- package/dist/esm/src/ProposalResponseGuard.js +58 -0
- package/dist/esm/src/ProposalResponseGuard.js.map +1 -0
- package/dist/esm/src/ProposalRoutes.js +237 -0
- package/dist/esm/src/ProposalRoutes.js.map +1 -0
- package/dist/esm/src/RootEvictionHTTPPolicy.js +71 -0
- package/dist/esm/src/RootEvictionHTTPPolicy.js.map +1 -0
- package/dist/esm/src/RootEvictionHTTPPorts.js +2 -0
- package/dist/esm/src/RootEvictionHTTPPorts.js.map +1 -0
- package/dist/esm/src/RootEvictionResponseGuard.js +80 -0
- package/dist/esm/src/RootEvictionResponseGuard.js.map +1 -0
- package/dist/esm/src/RootEvictionRoutes.js +196 -0
- package/dist/esm/src/RootEvictionRoutes.js.map +1 -0
- package/dist/types/mod.d.ts +2 -1
- package/dist/types/mod.d.ts.map +1 -1
- package/dist/types/src/ArcadeProvider.d.ts.map +1 -1
- package/dist/types/src/OutputLookupHTTPPolicy.d.ts +10 -0
- package/dist/types/src/OutputLookupHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/OutputLookupResponseGuard.d.ts +31 -0
- package/dist/types/src/OutputLookupResponseGuard.d.ts.map +1 -0
- package/dist/types/src/OutputLookupRoutes.d.ts +53 -0
- package/dist/types/src/OutputLookupRoutes.d.ts.map +1 -0
- package/dist/types/src/OverlayExpress.d.ts +82 -0
- package/dist/types/src/OverlayExpress.d.ts.map +1 -1
- package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts +19 -0
- package/dist/types/src/PrivateAcquisitionHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts +43 -0
- package/dist/types/src/PrivateAcquisitionHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts +14 -0
- package/dist/types/src/PrivateAcquisitionResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivateAcquisitionRoutes.d.ts +7 -0
- package/dist/types/src/PrivateAcquisitionRoutes.d.ts.map +1 -0
- package/dist/types/src/PrivateOverlayHost.d.ts +31 -0
- package/dist/types/src/PrivateOverlayHost.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts +17 -0
- package/dist/types/src/PrivatePublicationHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationHTTPPorts.d.ts +40 -0
- package/dist/types/src/PrivatePublicationHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationResponseGuard.d.ts +14 -0
- package/dist/types/src/PrivatePublicationResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivatePublicationRoutes.d.ts +6 -0
- package/dist/types/src/PrivatePublicationRoutes.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts +19 -0
- package/dist/types/src/PrivatePurchaseHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts +48 -0
- package/dist/types/src/PrivatePurchaseHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseResponseGuard.d.ts +15 -0
- package/dist/types/src/PrivatePurchaseResponseGuard.d.ts.map +1 -0
- package/dist/types/src/PrivatePurchaseRoutes.d.ts +7 -0
- package/dist/types/src/PrivatePurchaseRoutes.d.ts.map +1 -0
- package/dist/types/src/ProposalHTTPPolicy.d.ts +11 -0
- package/dist/types/src/ProposalHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/ProposalHTTPPorts.d.ts +59 -0
- package/dist/types/src/ProposalHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/ProposalResponseGuard.d.ts +18 -0
- package/dist/types/src/ProposalResponseGuard.d.ts.map +1 -0
- package/dist/types/src/ProposalRoutes.d.ts +10 -0
- package/dist/types/src/ProposalRoutes.d.ts.map +1 -0
- package/dist/types/src/RootEvictionHTTPPolicy.d.ts +8 -0
- package/dist/types/src/RootEvictionHTTPPolicy.d.ts.map +1 -0
- package/dist/types/src/RootEvictionHTTPPorts.d.ts +73 -0
- package/dist/types/src/RootEvictionHTTPPorts.d.ts.map +1 -0
- package/dist/types/src/RootEvictionResponseGuard.d.ts +38 -0
- package/dist/types/src/RootEvictionResponseGuard.d.ts.map +1 -0
- package/dist/types/src/RootEvictionRoutes.d.ts +11 -0
- package/dist/types/src/RootEvictionRoutes.d.ts.map +1 -0
- package/package.json +113 -15
- package/LICENSE.txt +0 -58
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/PATENTS
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
THE FOREGOING LICENSE APPLIES SOLELY TO COPYRIGHT IN THE SOFTWARE INDICATED, AS
|
|
2
|
+
BSV ASSOCIATION (THE “LICENSOR”) HOLDS NO PATENT RIGHTS. THE LICENSOR SHALL NOT,
|
|
3
|
+
AND SHALL PROCURE ANY ENTITY LICENSING INTELLECTUAL PROPERTY TO THE LICENSOR
|
|
4
|
+
SHALL NOT, ASSERT ANY PATENT RIGHTS AGAINST YOU IN CONNECTION WITH YOUR USE OF
|
|
5
|
+
THE SOFTWARE OR ANY WORK DERIVED FROM IT. HOWEVER, THE SOFTWARE IS PROVIDED "AS
|
|
6
|
+
IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
|
7
|
+
TO THE WARRANTIES REGARDING ENTITLEMENT, MERCHANTABILITY, FITNESS FOR A
|
|
8
|
+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE LICENSOR, AUTHORS
|
|
9
|
+
OR COPYRIGHT HOLDERS THEREOF BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
10
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
11
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
12
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Overlay Express
|
|
2
2
|
|
|
3
|
+
Release candidate `2.9.0`. Adds optional script verifier configuration and accepts Arcade SEEN_MULTIPLE_NODES and STUMP_PROCESSING as successful rebroadcast states. Existing deployments retain JavaScript verification. Operators may configure a preloaded verifier; no wire or data migration is required.
|
|
4
|
+
|
|
3
5
|
BSV BLOCKCHAIN | Overlay Express
|
|
4
6
|
|
|
5
7
|
An opinionated but configurable Overlay Services deployment system:
|
|
@@ -18,8 +20,53 @@ An opinionated but configurable Overlay Services deployment system:
|
|
|
18
20
|
|
|
19
21
|
Built-in discovery overflow probes use deterministic pages of at most 1000 rows. The configured engine result ceiling and extra-row overflow error remain enforced, including standard and high-throughput profiles.
|
|
20
22
|
|
|
23
|
+
The release candidate advances the packed Overlay dependency to support optional retained admission history. This package keeps its existing behavior and does not enable history retention automatically. No consumer or database migration is required.
|
|
24
|
+
|
|
25
|
+
The optional `@bsv/overlay-express/private-publication` entry exposes verified
|
|
26
|
+
private publication and publisher status through the shared BRC-103/104
|
|
27
|
+
authentication instance. Supply the same durable service and disclosure owner;
|
|
28
|
+
mount before generic parsers and response transformations. It checks original
|
|
29
|
+
selection and current record authority again after signing, sends only bounded
|
|
30
|
+
public projections and fixed errors, and preserves credential-free CORS by
|
|
31
|
+
default. It never mounts automatically or installs a payment handler. See the
|
|
32
|
+
[private publication guide](../../../docs/guides/verified-private-publication.md).
|
|
33
|
+
|
|
21
34
|
## Requirements and installation
|
|
22
35
|
|
|
36
|
+
The unpublished 2.8.0 candidate also provides the optional
|
|
37
|
+
`@bsv/overlay-express/root-eviction-response` companion. With middleware 2.3.0,
|
|
38
|
+
SDK 3.3.0 and a shared root journal, `guardRootAdvertisementResponse` checks current
|
|
39
|
+
access and every disclosed advertisement after signing and queues the native HTTP
|
|
40
|
+
response under the journal's gate. Stale responses are replaced in full by a
|
|
41
|
+
separately authorized signed reset. Capture the revision before hydration and
|
|
42
|
+
supply the complete target inventory and safe control-response headers. The
|
|
43
|
+
[root coordination guide](../../../docs/guides/root-eviction-coordination.md)
|
|
44
|
+
explains storage, policy and all-path integration obligations. Existing routes
|
|
45
|
+
remain unchanged; importing this companion does not enable the BRC-199 profile.
|
|
46
|
+
|
|
47
|
+
The optional `@bsv/overlay-express/root-eviction` entry composes a shared
|
|
48
|
+
`RootEvictionService` with exact authenticated request/status routes. It preserves
|
|
49
|
+
received UTF-8 byte limits and checks the observed revision and current access
|
|
50
|
+
again at native enqueue after packet and HTTP signing. Mount before generic
|
|
51
|
+
parsers with the same origin authentication middleware and durable journal.
|
|
52
|
+
Credential-free wildcard CORS is the default; exact origins are opt-in. It does
|
|
53
|
+
not publish capabilities or install a decision scheduler or serving adapters.
|
|
54
|
+
Call `configureRootEviction` before `start()` for native host integration. The
|
|
55
|
+
configured root identity must match the server wallet; root, authenticated lookup
|
|
56
|
+
and admin routes share authentication and host request capacity. Omitted root
|
|
57
|
+
origins inherit the host's edge policy, and byte limits cannot exceed host limits.
|
|
58
|
+
The injected journal and workers retain application ownership. See the root
|
|
59
|
+
coordination guide for installation and remaining obligations.
|
|
60
|
+
|
|
61
|
+
The optional lookup router and `configureOutputLookup` accept a structural
|
|
62
|
+
`disclosure` companion for a final current-session check after HTTP signing.
|
|
63
|
+
`LookupResponseDisclosure` from `@bsv/output-knowledge/lookup` composes that port
|
|
64
|
+
with durable SQLite sessions. It can replace an ineligible data response once
|
|
65
|
+
with a freshly authorized signed error, or close without a body when control
|
|
66
|
+
access is denied. Omitting the option preserves existing behavior. See the
|
|
67
|
+
[durable lookup guide](../../../docs/guides/durable-live-lookup.md#check-again-after-signing)
|
|
68
|
+
for the shared writer gate, current policy, physical work and callback obligations.
|
|
69
|
+
|
|
23
70
|
Overlay Express requires Node.js 22 or newer and a separately installed
|
|
24
71
|
`@bsv/sdk` peer dependency.
|
|
25
72
|
|
|
@@ -225,6 +272,28 @@ overlay state unless at least one provider accepts it or returns an already-know
|
|
|
225
272
|
success. Set it to `false` only for deliberate offline/dev workflows where local
|
|
226
273
|
overlay admission may proceed without current network propagation.
|
|
227
274
|
|
|
275
|
+
### Faster Script Verification
|
|
276
|
+
|
|
277
|
+
By default the engine verifies submitted and GASP-synced transactions with the
|
|
278
|
+
SDK's JavaScript script interpreter. To verify input scripts with the BSV BDK
|
|
279
|
+
engine compiled to WebAssembly instead (about 11x less CPU per input), install
|
|
280
|
+
`@bsv/verifast` and configure a preloaded verifier before `configureEngine()`:
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
import { BdkVerifier } from '@bsv/verifast'
|
|
284
|
+
|
|
285
|
+
const verifier = new BdkVerifier()
|
|
286
|
+
await verifier.preload()
|
|
287
|
+
server.configureScriptVerifier(verifier)
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
Preload it before serving traffic: in its default adaptive mode the verifier
|
|
291
|
+
keeps using the JavaScript interpreter until the WebAssembly module has loaded,
|
|
292
|
+
and `configureScriptVerifier()` logs a warning when given a verifier that is not
|
|
293
|
+
ready. Transactions are admitted or rejected the same way with either engine;
|
|
294
|
+
only the rejection message differs (`Script verification failed for
|
|
295
|
+
transaction …` instead of `Unable to verify SPV information.`).
|
|
296
|
+
|
|
228
297
|
### Transaction Propagation Providers
|
|
229
298
|
|
|
230
299
|
Overlay Express can compose multiple transaction propagation and proof sources:
|
|
@@ -289,6 +358,34 @@ for transactions that remain unproven past the threshold. Only transactions that
|
|
|
289
358
|
still cannot be proven are evicted. Operators can also run this manually through
|
|
290
359
|
the admin endpoints documented below.
|
|
291
360
|
|
|
361
|
+
### Registering Additional Routers
|
|
362
|
+
|
|
363
|
+
`registerRouter(path, factory)` mounts your own router inside the server. The factory runs
|
|
364
|
+
during `start()`, after the BRC-103 authentication middleware and before the admin routes and
|
|
365
|
+
the 404 handler, so the router inherits CORS, body parsing, response size limits, and
|
|
366
|
+
`req.auth.identityKey`. Requests without BRC-103 headers arrive with `req.auth.identityKey`
|
|
367
|
+
equal to `'unknown'`; routes that need authentication must reject them. Call it before
|
|
368
|
+
`start()`.
|
|
369
|
+
|
|
370
|
+
```ts
|
|
371
|
+
server.registerRouter('/', ({ engine, wallet }) => {
|
|
372
|
+
if (wallet === undefined) throw new Error('A server wallet is required')
|
|
373
|
+
const router = express.Router()
|
|
374
|
+
router.get('/status', (_req, res) => res.json({ ok: true }))
|
|
375
|
+
return router
|
|
376
|
+
})
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
The `wallet` in the context is the BRC-103 authentication wallet. It is built without a storage
|
|
380
|
+
provider, so it signs and verifies but cannot create or internalize actions: `createAction` and
|
|
381
|
+
`internalizeAction` throw. A router that takes payment, such as a BRC-178 host from `@bsv/eqc`,
|
|
382
|
+
must build its own storage-backed wallet from the same root key as the server, so that its
|
|
383
|
+
identity equals the BRC-103 session key and the SLAP-advertised key.
|
|
384
|
+
|
|
385
|
+
Registered routers inherit the response size limit (`MAX_RESPONSE_BYTES`: 4 MiB on the `small`
|
|
386
|
+
profile, 8 MiB on `standard`). A larger JSON body is replaced by a 413 after the handler ran, so a
|
|
387
|
+
router that is paid before it answers must bound its own responses below that limit.
|
|
388
|
+
|
|
292
389
|
### Admin-Protected Endpoints
|
|
293
390
|
|
|
294
391
|
We also provide admin-protected endpoints for advanced operations like manually
|
|
@@ -426,10 +523,90 @@ coverage.
|
|
|
426
523
|
|
|
427
524
|
## License
|
|
428
525
|
|
|
429
|
-
Current TS Stack changes are licensed under the
|
|
430
|
-
[LICENSE
|
|
526
|
+
Current TS Stack changes are licensed under the Apache License 2.0; see
|
|
527
|
+
[LICENSE](./LICENSE). This package also retains pre-uniformization code
|
|
431
528
|
under the Open BSV License Version 4. Redistributors must preserve
|
|
432
529
|
[THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md) and the applicable text in
|
|
433
530
|
[`LICENSES/`](./LICENSES/).
|
|
434
531
|
|
|
435
532
|
Thank you for being a part of the BSV Blockchain Overlay Express Project. Let's build the future of BSV Blockchain together!
|
|
533
|
+
|
|
534
|
+
## Next dependency release candidate
|
|
535
|
+
|
|
536
|
+
This candidate refreshes the packed first-party dependency ranges for the next
|
|
537
|
+
wallet interoperability release. It adds no independent API or wire-format
|
|
538
|
+
change. Adopt after the new dependency graph is published; current wallet
|
|
539
|
+
releases retain their existing published pins.
|
|
540
|
+
|
|
541
|
+
## Optional progressive and live lookup
|
|
542
|
+
|
|
543
|
+
Call `configureOutputLookup` before `start`, or import `createOutputLookupRouter`
|
|
544
|
+
from `@bsv/overlay-express/output-lookup` for standalone Express composition. The
|
|
545
|
+
new adapter requires SDK 3.3.0, a durable provider companion, a signed matching
|
|
546
|
+
capability manifest, current authorization and explicit browser origins. The
|
|
547
|
+
legacy root loads this adapter only when enabled. Existing finite lookup routes
|
|
548
|
+
and default startup remain unchanged.
|
|
549
|
+
|
|
550
|
+
The host shares its authentication instance, verifies the serving wallet identity
|
|
551
|
+
and clamps advertised byte budgets to its existing edge limits. Provider storage
|
|
552
|
+
lifecycle remains with the caller. See the [provider guide](../../../docs/guides/durable-live-lookup.md)
|
|
553
|
+
for initialization, exact retry recovery, disclosure guards, multi-process wakeups,
|
|
554
|
+
retention and standalone router ordering. The candidate is unpublished and the
|
|
555
|
+
complete BRC-192–199 integration remains under qualification.
|
|
556
|
+
|
|
557
|
+
## Optional authenticated proposals
|
|
558
|
+
|
|
559
|
+
`configureProposals` before `start` or the separate
|
|
560
|
+
`@bsv/overlay-express/proposals` router composes the durable proposal service,
|
|
561
|
+
service-owned disclosure validator and shared journal/native-enqueue gate.
|
|
562
|
+
This entry requires SDK 3.3.0 and auth middleware 2.3; legacy root peer floors and
|
|
563
|
+
routes remain unchanged. A current channel read differs from recovery of a
|
|
564
|
+
retained publication ACK. Both require current authorization and original
|
|
565
|
+
contract bounds after response signing. One sanitized replacement error may be
|
|
566
|
+
signed, with independently checked control permission before native enqueue.
|
|
567
|
+
|
|
568
|
+
The host shares authentication and handshake ownership with lookup/root companions,
|
|
569
|
+
keeps physical service work counted through settlement, clamps byte limits and
|
|
570
|
+
inherits host CORS policy unless explicitly overridden. Storage, capability
|
|
571
|
+
publication, verified recovery, expiry and admission workers remain host-owned.
|
|
572
|
+
See the [proposal guide](../../../docs/guides/non-final-proposals.md) for composition and recovery contracts.
|
|
573
|
+
|
|
574
|
+
### Private acquisition and publication
|
|
575
|
+
|
|
576
|
+
Explicit `configurePrivateAcquisition` and `configurePrivatePublication` methods
|
|
577
|
+
compose the installed private services with the host's single authenticated
|
|
578
|
+
wallet/session. Private acquisition routes precede publication's namespace
|
|
579
|
+
fallback and ordinary body parsers. The default public CORS policy remains
|
|
580
|
+
credential-free; explicit origins and host byte ceilings are preserved.
|
|
581
|
+
Acquisition-configured listeners alone select a bounded 128-KiB HTTP header
|
|
582
|
+
allowance for BRC-105 payment evidence. Standalone applications can import
|
|
583
|
+
`createPrivateAcquisitionRouter` from `@bsv/overlay-express/private-acquisition`.
|
|
584
|
+
The application owns durable custody, permissions, wallet recovery and worker
|
|
585
|
+
shutdown. See [acquisition and recovery](../../../docs/guides/private-acquisition-recovery.md)
|
|
586
|
+
for composition, original-obligation semantics, payment/recovery requests and
|
|
587
|
+
proxy limits. These opt-in profiles need the new SDK output APIs; legacy startup
|
|
588
|
+
retains its supported SDK floor.
|
|
589
|
+
|
|
590
|
+
### Covenant purchase companions
|
|
591
|
+
|
|
592
|
+
`configurePrivatePurchase` or the optional
|
|
593
|
+
`@bsv/overlay-express/private-purchase` router adds the proposed BRC-196
|
|
594
|
+
`/overlay/v1/purchases/prepare`, `/submit` and `/recover` operations under the
|
|
595
|
+
configured base path. These use the shared host authentication wallet, exact
|
|
596
|
+
selected capability and native physical disclosure owner. Covenant payment
|
|
597
|
+
occurs in the independently validated transaction; these routes reject HTTP
|
|
598
|
+
payment headers and do not introduce a second BRC-105 charge.
|
|
599
|
+
|
|
600
|
+
Purchase, acquisition and publication share one handshake owner and preserve
|
|
601
|
+
ordinary `/submit`/lookup behavior, request ceilings and credential-free CORS.
|
|
602
|
+
The application owns original protected custody, full domain/release validation
|
|
603
|
+
and stopping/draining the coordinator before closing its native domain. See
|
|
604
|
+
[purchase custody](../../../docs/guides/private-purchase-custody.md) for the
|
|
605
|
+
component boundaries and remaining end-to-end qualification requirements.
|
|
606
|
+
|
|
607
|
+
## SDK4 hotfix peer requirement
|
|
608
|
+
|
|
609
|
+
The SDK4 peer alternative starts at `@bsv/sdk ^4.0.1`, which restores numeric
|
|
610
|
+
wallet results and legacy wire compatibility. Existing SDK2/3 alternatives and
|
|
611
|
+
lower bounds remain unchanged. SDK4 users should install the 4.0.1 hotfix; no
|
|
612
|
+
application-wallet wire or data migration is required.
|
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Third-Party Notices
|
|
4
4
|
|
|
5
|
-
The
|
|
5
|
+
The Apache License, Version 2.0 in `LICENSE` applies to current TS Stack
|
|
6
6
|
first-party contributions. It does not replace, narrow, or relicense historical
|
|
7
7
|
or third-party material identified below. Each identified portion remains available
|
|
8
8
|
under its stated terms.
|
package/dist/cjs/mod.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
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';
|
|
1
|
+
export { default, type EngineConfig, type EdgePolicyConfig, type HealthCheckDefinition, type HealthCheckHandler, type HealthCheckResult, type HealthConfig, type HealthReport, type HealthStatus, type RegisteredRouterContext, type RegisteredRouterFactory, type TopicAnchorHeaderResolver } from './src/OverlayExpress.js';
|
|
2
2
|
export { BanService, type BannedRecord } from './src/BanService.js';
|
|
3
3
|
export { BanAwareLookupWrapper } from './src/BanAwareLookupWrapper.js';
|
|
4
4
|
export { BanAwareTopicManager } from './src/BanAwareTopicManager.js';
|
|
@@ -8,4 +8,5 @@ export { OverlayMonitor, analyzeOverlayAnchorTip, analyzeOverlayLookupResponse,
|
|
|
8
8
|
export { ArcadeProvider, isTerminalArcStatus, type ArcadeMerkleProof, type ArcadeProviderConfig } from './src/ArcadeProvider.js';
|
|
9
9
|
export { ProviderChainBroadcaster, type NamedBroadcaster } from './src/ProviderChainBroadcaster.js';
|
|
10
10
|
export { ChaintracksProvider, type ChaintracksHeader, type ChaintracksProviderConfig } from './src/ChaintracksProvider.js';
|
|
11
|
+
export type { OutputLookupCompanion, OutputLookupCaller, OutputLookupHTTPResponse, OutputLookupRouteOptions } from './src/OutputLookupRoutes.js';
|
|
11
12
|
//# sourceMappingURL=mod.d.ts.map
|
package/dist/cjs/mod.d.ts.map
CHANGED
|
@@ -1 +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"}
|
|
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,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,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;AACrC,YAAY,EACV,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,6BAA6B,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,6DAagC;AAZ9B,6HAAA,OAAO,OAAA;AAaT,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,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bsv/overlay-express",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.9.0",
|
|
4
4
|
"sideEffects": false,
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=22"
|
|
@@ -14,21 +14,23 @@
|
|
|
14
14
|
"dist",
|
|
15
15
|
"!dist/**/*.tsbuildinfo",
|
|
16
16
|
"README.md",
|
|
17
|
-
"LICENSE
|
|
17
|
+
"LICENSE",
|
|
18
|
+
"NOTICE",
|
|
19
|
+
"PATENTS",
|
|
18
20
|
"THIRD_PARTY_NOTICES.md",
|
|
19
21
|
"LICENSES"
|
|
20
22
|
],
|
|
21
23
|
"scripts": {
|
|
22
|
-
"test": "jest --watchman=false",
|
|
23
|
-
"test:watch": "jest --watch",
|
|
24
|
-
"test:coverage": "jest
|
|
25
|
-
"test:property": "jest --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts",
|
|
24
|
+
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watchman=false",
|
|
25
|
+
"test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
|
|
26
|
+
"test:coverage": "node ../../../scripts/jest-project-coverage.mjs",
|
|
27
|
+
"test:property": "node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand --watchman=false --runTestsByPath src/__tests/ReorgStream.property.test.ts src/__tests__/OutputLookupRoutes.property.test.ts src/__tests__/RootEvictionResponseGuard.property.test.ts src/__tests__/RootEvictionRoutes.property.test.ts src/__tests__/ProposalRoutes.property.test.ts src/__tests__/PrivatePublicationRoutes.property.test.ts src/__tests__/PrivateAcquisitionRoutes.property.test.ts src/__tests__/PrivatePurchaseRoutes.property.test.ts",
|
|
26
28
|
"test:live": "pnpm build && node ../../../scripts/run-governed-test.mjs live src/__tests__/OverlayProviders.live.test.ts",
|
|
27
29
|
"format:check": "pnpm --workspace-root exec prettier --check \"packages/overlays/overlay-express/{README.md,jest.config.js,mod.ts,package.json,tsconfig*.json}\"",
|
|
28
30
|
"lint": "oxlint mod.ts src jest.config.js --deny-warnings",
|
|
29
31
|
"lint:ci": "pnpm lint",
|
|
30
|
-
"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",
|
|
31
|
-
"typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false",
|
|
32
|
+
"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 --entry-exports \"./output-lookup=createOutputLookupRouter;./root-eviction-response=guardRootAdvertisementResponse;./root-eviction=createRootEvictionRouter;./proposals=createProposalRouter;./private-publication=createPrivatePublicationRouter;./private-acquisition=createPrivateAcquisitionRouter;./private-purchase=createPrivatePurchaseRouter\" && node ../../../scripts/check-legacy-overlay-sdk.mjs",
|
|
33
|
+
"typecheck": "tsc --project tsconfig.base.json --noEmit --incremental false && tsc --project tsconfig.proposal-tests.json",
|
|
32
34
|
"build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
|
|
33
35
|
"dev": "tsc -b -w",
|
|
34
36
|
"prepublishOnly": "pnpm build",
|
|
@@ -48,7 +50,7 @@
|
|
|
48
50
|
"SV"
|
|
49
51
|
],
|
|
50
52
|
"author": "BSV Association",
|
|
51
|
-
"license": "
|
|
53
|
+
"license": "Apache-2.0",
|
|
52
54
|
"bugs": {
|
|
53
55
|
"url": "https://github.com/bsv-blockchain/ts-stack/issues"
|
|
54
56
|
},
|
|
@@ -60,6 +62,7 @@
|
|
|
60
62
|
"@types/jest": "^30.0.0",
|
|
61
63
|
"@types/node": "^26.6.1",
|
|
62
64
|
"@typescript/native": "npm:typescript@7.0.2",
|
|
65
|
+
"express-rate-limit": "^8.6.1",
|
|
63
66
|
"fast-check": "^4.9.0",
|
|
64
67
|
"jest": "^30.5.1",
|
|
65
68
|
"oxlint": "^1.83.0",
|
|
@@ -82,11 +85,36 @@
|
|
|
82
85
|
"uuid": "^14.0.2"
|
|
83
86
|
},
|
|
84
87
|
"peerDependencies": {
|
|
85
|
-
"@bsv/sdk": "^2.4.0 || ^3.0.0 || ^4.0.
|
|
88
|
+
"@bsv/sdk": "^2.4.0 || ^3.0.0 || ^4.0.1"
|
|
86
89
|
},
|
|
87
90
|
"peerDependenciesMeta": {
|
|
88
91
|
"@bsv/sdk": {
|
|
89
92
|
"optional": false
|
|
90
93
|
}
|
|
94
|
+
},
|
|
95
|
+
"typesVersions": {
|
|
96
|
+
"*": {
|
|
97
|
+
"output-lookup": [
|
|
98
|
+
"dist/types/src/OutputLookupRoutes.d.ts"
|
|
99
|
+
],
|
|
100
|
+
"root-eviction-response": [
|
|
101
|
+
"dist/types/src/RootEvictionResponseGuard.d.ts"
|
|
102
|
+
],
|
|
103
|
+
"root-eviction": [
|
|
104
|
+
"dist/types/src/RootEvictionRoutes.d.ts"
|
|
105
|
+
],
|
|
106
|
+
"proposals": [
|
|
107
|
+
"dist/types/src/ProposalRoutes.d.ts"
|
|
108
|
+
],
|
|
109
|
+
"private-publication": [
|
|
110
|
+
"dist/types/src/PrivatePublicationRoutes.d.ts"
|
|
111
|
+
],
|
|
112
|
+
"private-acquisition": [
|
|
113
|
+
"dist/types/src/PrivateAcquisitionRoutes.d.ts"
|
|
114
|
+
],
|
|
115
|
+
"private-purchase": [
|
|
116
|
+
"dist/types/src/PrivatePurchaseRoutes.d.ts"
|
|
117
|
+
]
|
|
118
|
+
}
|
|
91
119
|
}
|
|
92
120
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArcadeProvider.d.ts","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAgBpG,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;IACpB,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;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;
|
|
1
|
+
{"version":3,"file":"ArcadeProvider.d.ts","sourceRoot":"","sources":["../../../src/ArcadeProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAgBpG,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;IACpB,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;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;AAyCD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAQjF;AA+JD;;;;;;;GAOG;AACH,qBAAa,cAAe,YAAW,WAAW;IAChD,QAAQ,CAAC,IAAI,YAAW;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IAEvD,YAAY,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,oBAAyB,EAazD;IAEK,SAAS,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAyE9E;IAEK,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAiC3E;IAED,OAAO,CAAC,cAAc;YAyBR,YAAY;CAoB3B"}
|
|
@@ -17,6 +17,12 @@ const SUCCESS_STATUSES = new Set([
|
|
|
17
17
|
'ANNOUNCED_TO_NETWORK',
|
|
18
18
|
'ACCEPTED_BY_NETWORK',
|
|
19
19
|
'SEEN_ON_NETWORK',
|
|
20
|
+
// Arcade (bsv-blockchain/broadcaster) answers a re-submit of a known transaction with its stored
|
|
21
|
+
// state, which can be later than SEEN_ON_NETWORK: seen by several miners, or already in a block.
|
|
22
|
+
// PENDING_RETRY and UNKNOWN stay out of this set and fall through as non-terminal failures, so
|
|
23
|
+
// the provider chain tries the next broadcaster.
|
|
24
|
+
'SEEN_MULTIPLE_NODES',
|
|
25
|
+
'STUMP_PROCESSING',
|
|
20
26
|
'STORED',
|
|
21
27
|
'MINED',
|
|
22
28
|
'IMMUTABLE'
|