multiaddr implementation (binary + string representation of network addresses)
JavaScript implementation of multiaddr.
A standard way to represent addresses that
npm i multiaddr
<script> TagLoading 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>
// if we are coming from <= 8.x you can use the factory function
const { multiaddr } = require('multiaddr')
const addr = multiaddr("/ip4/127.0.0.1/udp/1234")
// <Multiaddr /ip4/127.0.0.1/udp/1234>
// or just the class directly
const { Multiaddr } = require('multiaddr')
const addr = new 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>
https://multiformats.github.io/js-multiaddr/
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>>.
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.
MIT © 2016 Protocol Labs Inc.
FAQs
multiaddr implementation (binary + string representation of network addresses)
The npm package multiaddr receives a total of 45,764 weekly downloads. As such, multiaddr popularity was classified as popular.
We found that multiaddr demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.