@effectstream/npm-midnight-proof-server 0.100.14 → 0.100.16
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 +44 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# @effectstream/npm-midnight-proof-server
|
|
2
|
+
|
|
3
|
+
NPM wrapper around the Midnight proof-server binary. Installs a pinned
|
|
4
|
+
version into `node_modules/.bin/npm-midnight-proof-server` so the
|
|
5
|
+
EffectStream orchestrator can boot the proving sidecar that the
|
|
6
|
+
Midnight node depends on.
|
|
7
|
+
|
|
8
|
+
- Pinned Midnight proof-server sidecar.
|
|
9
|
+
- Boots alongside `@effectstream/npm-midnight-node`; no app-code import needed.
|
|
10
|
+
- Cache management via `--clean-binaries` / `--only-clean`.
|
|
11
|
+
- Required by ZK-heavy Midnight templates.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun add @effectstream/npm-midnight-proof-server
|
|
17
|
+
# or
|
|
18
|
+
npm install @effectstream/npm-midnight-proof-server
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Standalone usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Start the proof server (downloads the binary on first run)
|
|
25
|
+
bunx npm-midnight-proof-server
|
|
26
|
+
|
|
27
|
+
# Clean / re-download the cached binary
|
|
28
|
+
bunx npm-midnight-proof-server --clean-binaries
|
|
29
|
+
bunx npm-midnight-proof-server --only-clean
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Inside EffectStream
|
|
33
|
+
|
|
34
|
+
The orchestrator's Midnight step starts the proof server together with
|
|
35
|
+
`@effectstream/npm-midnight-node`. ZK-heavy templates and tests rely on
|
|
36
|
+
it implicitly — you don't import this package from app code, you just
|
|
37
|
+
add it to the orchestrator's dependency graph (which the templates
|
|
38
|
+
already do).
|
|
39
|
+
|
|
40
|
+
## Links
|
|
41
|
+
|
|
42
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/midnight-proof-server
|
|
43
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/midnight-proof-server
|
|
44
|
+
- Upstream Midnight: https://midnight.network/
|