@effectstream/npm-avail-light-client 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 +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @effectstream/npm-avail-light-client
|
|
2
|
+
|
|
3
|
+
NPM wrapper around the [Avail](https://www.availproject.org/) light client
|
|
4
|
+
CLI. Installs a pinned binary into `node_modules/.bin/npm-avail-light-client`
|
|
5
|
+
so the EffectStream orchestrator and Avail-side E2E tests can spin up a
|
|
6
|
+
light client without each developer fetching the binary by hand.
|
|
7
|
+
|
|
8
|
+
- Pinned Avail light-client binary, dropped into `node_modules/.bin/`.
|
|
9
|
+
- Linux / macOS, x64 and arm64.
|
|
10
|
+
- Used by the orchestrator's Avail step; pairs with `@effectstream/npm-avail-node`.
|
|
11
|
+
- Exercised by the [`e2e/avail/`](https://github.com/effectstream/effectstream/tree/main/e2e/avail) suite.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun add @effectstream/npm-avail-light-client
|
|
17
|
+
# or
|
|
18
|
+
npm install @effectstream/npm-avail-light-client
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The package downloads the pinned light-client binary for your OS/arch on
|
|
22
|
+
install.
|
|
23
|
+
|
|
24
|
+
## Standalone usage
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Through the bin shim
|
|
28
|
+
bunx npm-avail-light-client --network mainnet
|
|
29
|
+
|
|
30
|
+
# Or invoke the script directly
|
|
31
|
+
bun run --bun @effectstream/npm-avail-light-client/start -- --network mainnet
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Inside EffectStream
|
|
35
|
+
|
|
36
|
+
The orchestrator's Avail step boots this binary alongside the Avail node
|
|
37
|
+
wrapper (`@effectstream/npm-avail-node`) so syncs against Avail-DA work
|
|
38
|
+
locally. See:
|
|
39
|
+
|
|
40
|
+
- [`e2e/avail/`](https://github.com/effectstream/effectstream/tree/main/e2e/avail) — E2E suite.
|
|
41
|
+
- `@effectstream/sync` — `AvailFetcher`, `AvailSyncState` on the runtime side.
|
|
42
|
+
|
|
43
|
+
## Links
|
|
44
|
+
|
|
45
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/avail-light-client
|
|
46
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/avail-light-client
|
|
47
|
+
- Avail Light Client: https://github.com/availproject/avail-light
|