Skip to main content

@effectstream/npm-avail-light-client

Package: @effectstream/npm-avail-light-client · Source

NPM wrapper around the Avail light client CLI. Installs a pinned binary into node_modules/.bin/npm-avail-light-client so the EffectStream orchestrator and Avail-side E2E tests can spin up a light client without each developer fetching the binary by hand.

  • Pinned Avail light-client binary, dropped into node_modules/.bin/.
  • Linux / macOS, x64 and arm64.
  • Used by the orchestrator's Avail step; pairs with @effectstream/npm-avail-node.
  • Exercised by the e2e/avail/ suite.

Install

bun add @effectstream/npm-avail-light-client
# or
npm install @effectstream/npm-avail-light-client

The package downloads the pinned light-client binary for your OS/arch on install.

Standalone usage

# Through the bin shim
bunx npm-avail-light-client --network mainnet

# Or invoke the script directly
bun run --bun @effectstream/npm-avail-light-client/start -- --network mainnet

Inside EffectStream

The orchestrator's Avail step boots this binary alongside the Avail node wrapper (@effectstream/npm-avail-node) so syncs against Avail-DA work locally. See:

  • e2e/avail/ - E2E suite.
  • @effectstream/sync - AvailFetcher, AvailSyncState on the runtime side.