@effectstream/npm-midnight-node 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 +51 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @effectstream/npm-midnight-node
|
|
2
|
+
|
|
3
|
+
NPM wrapper that downloads and runs the
|
|
4
|
+
[Midnight](https://midnight.network/) Node binary. Installs a pinned
|
|
5
|
+
version on first invocation and exposes a `npm-midnight-node` CLI for
|
|
6
|
+
the EffectStream orchestrator and templates.
|
|
7
|
+
|
|
8
|
+
- Pinned Midnight node binary, downloaded on first run.
|
|
9
|
+
- `--dev` for a local node; `--clean-binaries` / `--only-clean` to manage the cache.
|
|
10
|
+
- Consumed by `@effectstream/sync`'s `MidnightFetcher`.
|
|
11
|
+
- Templates: `evm-midnight-v2`, `night-bitcoin`, `zswap-da`, `zk-cardano`.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun add @effectstream/npm-midnight-node
|
|
17
|
+
# or
|
|
18
|
+
npm install @effectstream/npm-midnight-node
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Standalone usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Start a local Midnight node (downloads the binary on first run)
|
|
25
|
+
bunx npm-midnight-node --dev
|
|
26
|
+
|
|
27
|
+
# Clear the downloaded binary cache
|
|
28
|
+
bunx npm-midnight-node --clean-binaries
|
|
29
|
+
|
|
30
|
+
# Only clean, don't redownload
|
|
31
|
+
bunx npm-midnight-node --only-clean
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Inside EffectStream
|
|
35
|
+
|
|
36
|
+
The orchestrator's Midnight step starts this binary, plus
|
|
37
|
+
`@effectstream/npm-midnight-proof-server` and
|
|
38
|
+
`@effectstream/npm-midnight-indexer`, then `@effectstream/sync`'s
|
|
39
|
+
`MidnightFetcher` consumes the node's RPC. Templates that target
|
|
40
|
+
Midnight:
|
|
41
|
+
|
|
42
|
+
- [`templates/evm-midnight-v2/`](https://github.com/effectstream/effectstream/tree/main/templates/evm-midnight-v2)
|
|
43
|
+
- [`templates/night-bitcoin/`](https://github.com/effectstream/effectstream/tree/main/templates/night-bitcoin)
|
|
44
|
+
- [`templates/zswap-da/`](https://github.com/effectstream/effectstream/tree/main/templates/zswap-da)
|
|
45
|
+
- [`templates/zk-cardano/`](https://github.com/effectstream/effectstream/tree/main/templates/zk-cardano)
|
|
46
|
+
|
|
47
|
+
## Links
|
|
48
|
+
|
|
49
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/midnight-node
|
|
50
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/midnight-node
|
|
51
|
+
- Upstream Midnight: https://midnight.network/
|