@platonnetwork/web3-core-subscriptions

v0.13.0

Manages web3 subscriptions. This is an internal package.

NPM

README

GitHub

LGPL-3.0

Latest version published 8 months ago

    npm install @platonnetwork/web3-core-subscriptions

We couldn't find any similar packages Browse all packages

Package Health Score

68 / 100

Popularity
Limited
Maintenance
Sustainable
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (1)

Dependents: 0
GitHub Stars: 18
Forks: 14
Contributors: 200

The npm package @platonnetwork/web3-core-subscriptions receives a total of 1 downloads a week. As such, we scored @platonnetwork/web3-core-subscriptions popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @platonnetwork/web3-core-subscriptions, we found that it has been starred 18 times, and that 0 other projects in the ecosystem are dependent on it.

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

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.11.0

0.13.0

Indirect Vulnerabilities

0.11.0

0.13.0

License Risks

0.11.0

0.13.0

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

Indirect License Risks

@platonnetwork/web3-core-subscriptions@0.13.0
- @platonnetwork/web3-core-helpers@0.13.0 M

@platonnetwork/web3-core-subscriptions@0.13.0
- @platonnetwork/web3-core-helpers@0.13.0
  - @platonnetwork/web3-utils@0.13.0 M

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

We found a way for you to contribute to the project! Looks like @platonnetwork/web3-core-subscriptions is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test @platonnetwork/web3-core-subscriptions

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 2
Merged PR: 37
Open PR: 1
Last Commit: 8 months ago

Further analysis of the maintenance status of @platonnetwork/web3-core-subscriptions based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @platonnetwork/web3-core-subscriptions demonstrates a positive version release cadence with at least one new version released in the past 12 months.

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.

Community

Sustainable

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

A good and healthy external contribution signal for @platonnetwork/web3-core-subscriptions project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like @platonnetwork/web3-core-subscriptions is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: >=8.0.0

Age: 12 months
Dependencies: 3 Direct
Versions: 4
Install Size: 18.5 kB
Dist-tags: 1
# of Files: 8
Maintainers: 1
TS Typings: Yes

@platonnetwork/web3-core-subscriptions 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.

web3-core-subscriptions

This is a sub package of web3.js

The subscriptions package used within some web3.js packages. Please read the documentation for more.

Installation

Node.js

npm install web3-core-subscriptions

In the Browser

Build running the following in the web3.js repository:

npm run-script build-all

Then include dist/web3-core-subscriptions.js in your html file. This will expose the Web3Subscriptions object on the window object.

Usage

// in node.js
var Web3Subscriptions = require('web3-core-subscriptions');

var sub = new Web3Subscriptions({
    name: 'subscribe',
    type: 'eth',
    subscriptions: {
        'newBlockHeaders': {
            subscriptionName: 'newHeads',
            params: 0,
            outputFormatter: formatters.outputBlockFormatter
        },
        'pendingTransactions': {
            params: 0,
            outputFormatter: formatters.outputTransactionFormatter
        }
    }
});
sub.attachToObject(myCoolLib);

myCoolLib.subscribe('newBlockHeaders', function(){ ... });