@cobinhood/web3-providers-ws

Module to handle web3 RPC connections over WebSockets.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@cobinhood/web3-providers-ws
Minified + gzip package size for @cobinhood/web3-providers-ws in KB

Readme

web3-providers-ws

This is a sub package of web3.js

This is a websocket provider for web3.js.
Please read the documentation for more.

Installation

Node.js

npm install web3-providers-ws

In the Browser

Build running the following in the web3.js repository:

npm run-script build-all

Then include dist/web3-providers-ws.js in your html file. This will expose the Web3WsProvider object on the window object.

Usage

// in node.js
var Web3WsProvider = require('@cobinhood/web3-providers-ws');

var options = { timeout: 30000, headers: {authorization: 'Basic username:password'} } // set a custom timeout at 30 seconds, and credentials (you can also add the credentials to the URL: ws://username:password@localhost:8546)
var ws = new Web3WsProvider('ws://localhost:8546', options);

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.