Package Health Score

45 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.5.0	\|	02/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.2	\|	09/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.11	\|	05/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.1	\|	09/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.14	\|	07/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

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

Limited

Weekly Downloads (9)

GitHub Stars: 8
Forks: 7
Contributors: 20

Direct Usage Popularity

The npm package ilp-plugin-btp receives a total of 9 downloads a week. As such, we scored ilp-plugin-btp popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package ilp-plugin-btp, we found that it has been starred 8 times.

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

Community

Limited

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

With more than 10 contributors for the ilp-plugin-btp repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like ilp-plugin-btp is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

No Recent Commits

Open Issues: 12
Open PR: 1
Last Release: 4 years ago
Last Commit: 4 years ago

Further analysis of the maintenance status of ilp-plugin-btp 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 ilp-plugin-btp 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.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: >=10.0.0

Age: 7 years
Dependencies: 8 Direct
Versions: 36
Install Size: 97.4 kB
Dist-tags: 1
# of Files: 18
Maintainers: 1
TS Typings: Yes

ilp-plugin-btp 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

ILP Plugin BTP

> One plugin to rule them all

Used right out of the box, this plugin is capable of representing a data channel with no money involved. It will send BTP messages with no knowledge of the data within, so it can be used for ILP packets. The sendMoney function is a no-op, because there is no system involved handling money.

The main use of this plugin, however, is as a building block for plugins that do have an underlying ledger. In this way, it's the successor of ilp-plugin-payment-channel-framework

Plugins that sub-class the AbstractBtpPlugin should override sendMoney and _handleMoney at least.

Use as a Data Channel for ILP

const server = new BtpPlugin({
  listener: {
    port: 9000,
    secret: 'shh_its_a_secret'
  }
})

await server.connect()

const client = new BtpPlugin({
  server: 'btp+ws://:shh_its_a_secret@localhost:9000'
})

await client.connect()

server.registerDataHandler(serverHandler)
client.registerDataHandler(clientHandler)

await client.sendData(IlpPacket.serializeIlpPrepare({
  // ...
})

Use as a Base Class for a New Plugin

Two functions must be defined in order for the plugin to handle money.

sendMoney (amount: string) -> Promise: sends amount of units to the peer. This should be done via a BTP TRANSFER call.
_handleMoney (from: string, btpPacket: BtpPacket) -> Promise>: This function is called on an incoming BTP TRANSFER.

BtpSubProtocol is made up of:

protocolName: string: The name of this side protocol. ILP-level information must be named ilp.
contentType: number: The content type. 0 is application/octet-stream, 1 is text/plain-utf8, and 2 is application/json. Mainly used for logging and smart deserializing.
data: buffer: The actual protocol data.

ilp-plugin-btp dependencies

@types/debug @types/node @types/ws btp-packet debug eventemitter2 ilp-logger ws

ilp-plugin-btp development dependencies

@types/lodash @types/long codecov gh-pages mocha node-fetch source-map-support ts-node tslint tslint-config-standard typedoc typescript

FAQs

What is ilp-plugin-btp?

Generic BTP plugin for ILP. Visit Snyk Advisor to see a full health score report for ilp-plugin-btp, including popularity, security, maintenance & community analysis.

Is ilp-plugin-btp popular?

The npm package ilp-plugin-btp receives a total of 9 weekly downloads. As such, ilp-plugin-btp popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ilp-plugin-btp well maintained?

We found indications that ilp-plugin-btp is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is ilp-plugin-btp safe to use?

The npm package ilp-plugin-btp 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 10 November-2024, at 06:44 (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

ilp-plugin-btp

Generic BTP plugin for ILP For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (9)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

ILP Plugin BTP

Use as a Data Channel for ILP

Use as a Base Class for a New Plugin

ilp-plugin-btp dependencies

ilp-plugin-btp development dependencies

FAQs

What is ilp-plugin-btp?

Is ilp-plugin-btp popular?

Is ilp-plugin-btp well maintained?

Is ilp-plugin-btp safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (9)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ILP Plugin BTP

Use as a Data Channel for ILP

Use as a Base Class for a New Plugin

ilp-plugin-btp dependencies

ilp-plugin-btp development dependencies

FAQs

What is ilp-plugin-btp?

Is ilp-plugin-btp popular?

Is ilp-plugin-btp well maintained?

Is ilp-plugin-btp safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues