@multiformats/multiaddr
multiaddr implementation (binary + string representation of network addresses)
Table of contents
Install
$ npm i @multiformats/multiaddr
<script>
tag
Browser Loading this module through a script tag will make it's exports available as MultiformatsMultiaddr
in the global namespace.
<script src="https://unpkg.com/@multiformats/multiaddr/dist/index.min.js"></script>
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
Usage
import { multiaddr } from '@multiformats/multiaddr'
const addr = multiaddr("/ip4/127.0.0.1/udp/1234")
// Multiaddr(/ip4/127.0.0.1/udp/1234)
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)
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:
import { resolvers } from '@multiformats/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>>
.
API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.