Web3-providers-ws NPM

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

npm install web3-providers-ws

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('web3-providers-ws');

var options = {
    timeout: 30000, // ms

    // Useful for credentialed urls, e.g: ws://username:password@localhost:8546
    headers: {
      authorization: 'Basic username:password'
    },

    // Useful if requests are large
    clientConfig: {
      maxReceivedFrameSize: 100000000,   // bytes - default: 1MiB
      maxReceivedMessageSize: 100000000, // bytes - default: 8MiB
    },

    // Enable auto reconnection
    reconnect: {
        auto: true,
        delay: 5000, // ms
        maxAttempts: 5,
        onTimeout: false
    }
};

var ws = new Web3WsProvider('ws://localhost:8546', options);

(Additional client config options can be found [here][1])

[1]: https://github.com/web3-js/WebSocket-Node/blob/polyfill/globalThis/docs/WebSocketClient.md

Types

All the TypeScript typings are placed in the types folder.

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

5 months ago

6 months ago

6 months ago

6 months ago

5 months ago

5 months ago

6 months ago

5 months ago

6 months ago

5 months ago

6 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

5 months ago

5 months ago

6 months ago

7 months ago

5 months ago

5 months ago

5 months ago

6 months ago

5 months ago

5 months ago

6 months ago

5 months ago

6 months ago

6 months ago

6 months ago

5 months ago

6 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

8 months ago

7 months ago

8 months ago

10 months ago

9 months ago

7 months ago

7 months ago

10 months ago

8 months ago

9 months ago

7 months ago

11 months ago

10 months ago

10 months ago

8 months ago

10 months ago

8 months ago

9 months ago

9 months ago

10 months ago

10 months ago

7 months ago

10 months ago

9 months ago

9 months ago

11 months ago

10 months ago

10 months ago

9 months ago

9 months ago

8 months ago

8 months ago

7 months ago

7 months ago

7 months ago

9 months ago

7 months ago

10 months ago

9 months ago

10 months ago

9 months ago

9 months ago

7 months ago

9 months ago

7 months ago

11 months ago

7 months ago

7 months ago

7 months ago

8 months ago

7 months ago

7 months ago

7 months ago

8 months ago

9 months ago

7 months ago

8 months ago

7 months ago

10 months ago

7 months ago

9 months ago

7 months ago

8 months ago

11 months ago

9 months ago

10 months ago

7 months ago

10 months ago

10 months ago

9 months ago

8 months ago

7 months ago

11 months ago

10 months ago

9 months ago

10 months ago

9 months ago

10 months ago

12 months ago

12 months ago