fluencelabs/js-multiaddr-to-uri
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-multiaddr-to-uri synced 2024-12-04 10:30:34 +00:00
Code Issues Projects Releases Wiki Activity
24 Commits 6 Branches 8 Tags 415 KiB
JavaScript 100%
3021c00543
Go to file
Alan Shaw 3021c00543
feat: retain aliased protocols (#11) 
The upgrade to multiaddr 7 brings with it a change that means multiaddrs with libp2p peer ID keys like `/ipfs/QmXXX` will be transformed to `/p
2p/QmXXX` when converted from a string, to a multiaddr instance and back to a string.

This is because `p2p` and `ipfs` are name aliases for the same codec. `p2p` has now become the default and older `ipfs` names do not round trip(they are converted to `p2p` - as stated above).

This change allows us to use the new multiaddr 7 lib but retain backward compatibility by ensuring the protocol specified in a string multiaddr is the protocol used in the resulting URI.
2020-01-01 22:29:49 +00:00
.gitignore initial commit 2018-03-20 14:39:26 +00:00
.travis.yml chore: update travis config 2019-08-21 11:14:58 +01:00
index.js feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00
LICENSE initial commit 2018-03-20 14:39:26 +00:00
package-lock.json feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00
package.json feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00
README.md chore: update repo URL 2019-08-21 11:13:53 +01:00
test.js feat: retain aliased protocols (#11) 2020-01-01 22:29:49 +00:00

README.md

multiaddr-to-uri

Build Status dependencies Status JavaScript Style Guide

Convert a Multiaddr to a URI /dnsaddr/ipfs.io/http -> http://ipfs.io

Install

npm install multiaddr-to-uri

Usage

const toUri = require('multiaddr-to-uri')

console.log(toUri('/dnsaddr/protocol.ai/https'))
// -> https://protocol.ai

console.log(toUri('/ip4/127.0.0.1/tcp/8080'))
// -> http://127.0.0.1:8080

console.log(toUri('/ip4/127.0.0.1/tcp/8080', { assumeHttp: false }))
// -> tcp://127.0.0.1:8080

Note:

  • When /tcp is the last (terminating) protocol HTTP is assumed by default (implicit assumeHttp: true)
    • this means produced URIs will start with http:// instead of tcp://
    • passing { assumeHttp: false } disables this behavior
  • Might be lossy - e.g. a DNSv6 multiaddr
  • Can throw if the passed multiaddr:
    • is not a valid multiaddr
    • is not supported as a URI e.g. circuit

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Alan Shaw