fico-web3-providers-ws

v1.7.1-rc.8

Module to handle web3 RPC connections over WebSockets. For more information about how to use this package see README

Latest version published 3 years ago

License: LGPL-3.0

NPM

GitHub

Package Health Score

69 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.7.1-rc.8	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 1 M 0 L

License

LGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (0)

GitHub Stars: 19.28K
Forks: 4.94K
Contributors: 290

Direct Usage Popularity

The npm package fico-web3-providers-ws receives a total of 0 downloads a week. As such, we scored fico-web3-providers-ws popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package fico-web3-providers-ws, we found that it has been starred 19,282 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 290
Funding: No

A good and healthy external contribution signal for fico-web3-providers-ws project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 168
Open PR: 23
Last Release: 3 years ago
Last Commit: 15 days ago

Further analysis of the maintenance status of fico-web3-providers-ws based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for fico-web3-providers-ws is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8.0.0

Age: 3 years
Dependencies: 3 Direct
Versions: 10
Install Size: 31.9 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: No

fico-web3-providers-ws has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

web3-providers-ws

This is a websocket provider sub-package for web3.js.

Please read the documentation for more.

Installation

Node.js

npm install web3-providers-ws

Usage

const Web3WsProvider = require('fico-web3-providers-ws');

const options = {
    timeout: 30000, // ms

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

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

      // Useful to keep a connection alive
      keepalive: true,
      keepaliveInterval: 60000 // ms
    },

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

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

Additional client config options can be found here.

Types

All the TypeScript typings are placed in the types folder.

fico-web3-providers-ws dependencies

eventemitter3 fico-web3-core-helpers websocket

fico-web3-providers-ws development dependencies

dtslint typescript

FAQs

What is fico-web3-providers-ws?

Module to handle web3 RPC connections over WebSockets. Visit Snyk Advisor to see a full health score report for fico-web3-providers-ws, including popularity, security, maintenance & community analysis.

Is fico-web3-providers-ws popular?

We’re still processing downloads data for the npm package fico-web3-providers-ws. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is fico-web3-providers-ws well maintained?

We found indications that fico-web3-providers-ws is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is fico-web3-providers-ws safe to use?

The npm package fico-web3-providers-ws was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 9 November-2024, at 00:33 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP