multiaddr

v8.1.2

multiaddr implementation (binary + string representation of network addresses)

NPM

README

GitHub

Website

MIT

Latest version published 1 month ago

    npm install multiaddr

We couldn't find any similar packages Browse all packages

Package Health Score

80 / 100

Popularity
Recognized
Maintenance
Healthy
Security
No known security issues
Community
Active

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

Secure my Project

Popularity

Recognized

Weekly Downloads (41,550)

Dependents: 208
GitHub Stars: 80
Forks: 45
Contributors: 30

The npm package multiaddr receives a total of 41,550 downloads a week. As such, we scored multiaddr popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package multiaddr, we found that it has been starred 80 times, and that 208 other projects on 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

6.0.6

6.1.1

7.5.0

8.0.0

8.1.2

Indirect Vulnerabilities

6.0.6

6.1.1

7.5.0

8.0.0

8.1.2

License Risks

6.0.6

6.1.1

7.5.0

8.0.0

8.1.2

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

Security Policy: No

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

We found a way for you to contribute to the project! Looks like multiaddr is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test multiaddr

Fix it in your project with Snyk!

Maintenance

Healthy

Commit Frequency

Open Issues: 4
Merged PR: 88
Open PR: 7
Last Commit: 1 month ago

Further analysis of the maintenance status of multiaddr based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that multiaddr demonstrates a positive version release cadence with at least one new version released in the past 3 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

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No
License: MIT

With more than 10 contributors for the multiaddr 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 multiaddr is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 8 Direct / 23 Total
Versions: 59
Install Size: 109 kB
Dist-tags: 1
# of Files: 13
Maintainers: 4
TS Typings: Yes

We detected a total of 23 direct & transitive dependencies for multiaddr. See the full dependency tree of multiaddr

multiaddr 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.

js-multiaddr

JavaScript implementation of multiaddr.

Lead Maintainer

Jacob Heun

js-multiaddr

Background

What is multiaddr?

A standard way to represent addresses that

support any standard network protocol
are self-describing
have a binary packed format
have a nice string representation
encapsulate well

Install

npm i multiaddr

Setup

Node.js

const multiaddr = require('multiaddr')

Browser: Browserify, Webpack, other bundlers

The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

const multiaddr = require('multiaddr')

Browser: `<script>` Tag

Loading this module through a script tag will make the Multiaddr obj available in the global namespace.

<script src="https://unpkg.com/multiaddr/dist/index.min.js"></script>

Usage

$ node

> const multiaddr = require('multiaddr')

> const addr = multiaddr("/ip4/127.0.0.1/udp/1234")
<Multiaddr /ip4/127.0.0.1/udp/1234>

> addr.bytes
<Uint8Array 04 7f 00 00 01 11 04 d2>

> addr.toString()
'/ip4/127.0.0.1/udp/1234'

> addr.protos()
[
  {code: 4, name: 'ip4', size: 32},
  {code: 273, name: 'udp', size: 16}
]

// gives you an object that is friendly with what Node.js core modules expect for addresses
> addr.nodeAddress()
{
  family: "4",
  port: 1234,
  address: "127.0.0.1"
}

> addr.encapsulate('/sctp/5678')
<Multiaddr /ip4/127.0.0.1/udp/1234/sctp/5678>

API

https://multiformats.github.io/js-multiaddr/

Resolvers

multiaddr allows multiaddrs to be resolved when appropriate resolvers are provided. This module already has resolvers available, but you can also create your own. Resolvers should always be set in the same module that is calling multiaddr.resolve() to avoid conflicts if multiple versions of multiaddr are in your dependency tree. To provide multiaddr resolvers you can do:

const multiaddr = require('multiaddr')
const resolvers = require('multiaddr/src/resolvers')

multiaddr.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)

The available resolvers are:

Name	type	Description
`dnsaddrResolver`	`dnsaddr`	dnsaddr resolution with TXT Records

A resolver receives a Multiaddr as a parameter and returns a Promise<Array<string>>.

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

multiaddr versions

Dist-Tags for multiaddr

latest

Version	Published	Tag	Node.js Compatability	Licenses	Dependencies	Direct Vulnerabilities	Publisher
8.1.2	11 December 2020	latest	*	MIT	8	0 H 0 M 0 L	vascosantos
8.0.0	07 August 2020		*	MIT	6	0 H 0 M 0 L	jacobheun
7.5.0	25 June 2020		*	MIT	6	0 H 0 M 0 L	jacobheun
All Versions

Last updated on 18 January-2021, at 02:22 (UTC).

multiaddr

multiaddr implementation (binary + string representation of network addresses)

Package Health Score

Popularity

Security

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Maintenance

Community

Embed Package Health Score Badge

Package

js-multiaddr

Lead Maintainer

Table of Contents

Background

What is multiaddr?

Install

Setup

Node.js

Browser: Browserify, Webpack, other bundlers

Browser: `<script>` Tag

Usage

API

Resolvers

Contribute

License

multiaddr versions

multiaddr dependencies

Package Health Score

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risks

Embed Package Health Score Badge

js-multiaddr

Lead Maintainer

Table of Contents

Background

What is multiaddr?

Install

Setup

Node.js

Browser: Browserify, Webpack, other bundlers

Browser: <script> Tag

Usage

API

Resolvers

Contribute

License

multiaddr versions

multiaddr dependencies

Browser: `<script>` Tag