# web3-stream-provider

> Utility for creating an Ethereum web3 provider that forwards payloads through a stream.

Latest version **5.1.0** (published 2024-10-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install web3-stream-provider
pnpm add web3-stream-provider
yarn add web3-stream-provider
bun add web3-stream-provider
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2024-10-14 |
| First published | 2015-12-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^16.20 \|\| ^18.16 \|\| >=20 |
| Dependencies | 2 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | kumavis |
| Maintainers | mcmire, nicholasellul, lgbot, naugtur, ritave, danfinlay, kumavis, rekmarks, metamaskbot, gudahtt, sethkfman |
| Keywords | ethereum, web3, web3-provider, stream |

## Links

- npm: https://www.npmjs.com/package/web3-stream-provider
- Repository: https://github.com/kumavis/web3-stream-provider
- Homepage: https://github.com/kumavis/web3-stream-provider#readme
- Issues: https://github.com/kumavis/web3-stream-provider/issues
- npm.io page: https://npm.io/package/web3-stream-provider

## Dependencies (2)

- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [readable-stream](https://npm.io/package/readable-stream.md) ^3.6.2 || ^4.5.2

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 5.1.0 (latest) — 2024-10-14
- 5.0.0 — 2024-02-28
- 4.0.1 — 2023-10-25
- 4.0.0 — 2019-08-24
- 3.0.1 — 2017-07-04
- 3.0.0 — 2017-07-04
- 2.0.8 — 2016-08-26
- 2.0.7 — 2016-08-26
- 2.0.6 — 2016-08-11
- 2.0.5 — 2016-06-23
- 2.0.4 — 2016-06-23
- 2.0.3 — 2016-06-23
- 2.0.2 — 2016-06-14
- 2.0.1 — 2016-05-22
- 2.0.0 — 2016-05-22
- … 2 more at https://npm.io/package/web3-stream-provider/versions

## README

### web3-stream-provider

Utility for creating an Ethereum web3 provider that forwards payloads through a stream.
Only works for **async** payloads.


For connecting to a remote eth rpc handler
```js
const StreamProvider = require('web3-stream-provider')

var streamProvider = new StreamProvider()
var web3 = new Web3(streamProvider)

streamProvider.pipe(remoteRpcHandler).pipe(streamProvider)
```


For handling incoming rpc payloads
```js
const handleRequestsFromStream = require('web3-stream-provider/handler')

handleRequestsFromStream(remoteStream, provider, /* optional */ onRequest, onResponse)

function onRequest(request){
  // can modify the request if needed
  console.log(arguments)
}

function onResponse(err, request, response){
  console.log(arguments)
}
```

---
_Source: https://npm.io/package/web3-stream-provider · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._