fluencelabs/js-libp2p-utils
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-utils synced 2025-04-25 15:22:34 +00:00
Code Issues Projects Releases Wiki Activity

chore: update multiaddr to 9

Browse Source
This commit is contained in:
Vasco Santos 2021-04-08 18:34:20 +02:00
parent 4326d714d9
commit 9d8114e201
11 changed files with 80 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
package.json
View File

@ -44,10 +44,10 @@
"homepage": "https://github.com/libp2p/js-libp2p-utils#readme", "homepage": "https://github.com/libp2p/js-libp2p-utils#readme",
"devDependencies": { "devDependencies": {
"@types/debug": "^4.1.5", "@types/debug": "^4.1.5",
"aegir": "^32.1.0", "aegir": "^33.0.0",
"it-pair": "^1.0.0", "it-pair": "^1.0.0",
"it-pipe": "^1.1.0", "it-pipe": "^1.1.0",
"libp2p-interfaces": "^0.9.0", "libp2p-interfaces": "libp2p/js-libp2p-interfaces#chore/update-pubsub-interface",
"streaming-iterables": "^5.0.3", "streaming-iterables": "^5.0.3",
"util": "^0.12.3" "util": "^0.12.3"
}, },
@ -57,7 +57,7 @@
"err-code": "^3.0.1", "err-code": "^3.0.1",
"ip-address": "^7.1.0", "ip-address": "^7.1.0",
"is-loopback-addr": "^1.0.0", "is-loopback-addr": "^1.0.0",
"multiaddr": "^8.1.2", "multiaddr": "^9.0.1",
"private-ip": "^2.1.1" "private-ip": "^2.1.1"
}, },
"contributors": [ "contributors": [

2
src/address-sort.js
View File

@ -3,7 +3,7 @@
const isPrivate = require('./multiaddr/is-private') const isPrivate = require('./multiaddr/is-private')
/** /**
* @typedef {import('multiaddr')} Multiaddr * @typedef {import('multiaddr').Multiaddr} Multiaddr
*/ */
/** /**

8
src/ip-port-to-multiaddr.js
View File

@ -4,7 +4,7 @@ const debug = require('debug')
const log = Object.assign(debug('libp2p:ip-port-to-multiaddr'), { const log = Object.assign(debug('libp2p:ip-port-to-multiaddr'), {
error: debug('libp2p:ip-port-to-multiaddr:err') error: debug('libp2p:ip-port-to-multiaddr:err')
}) })
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const errCode = require('err-code') const errCode = require('err-code')
const { Address4, Address6 } = require('ip-address') const { Address4, Address6 } = require('ip-address')
@ -36,15 +36,15 @@ function ipPortToMultiaddr (ip, port) {
try { try {
// Test valid IPv4 // Test valid IPv4
new Address4(ip) // eslint-disable-line no-new new Address4(ip) // eslint-disable-line no-new
return multiaddr(`/ip4/${ip}/tcp/${port}`) return new Multiaddr(`/ip4/${ip}/tcp/${port}`)
} catch {} } catch {}
try { try {
// Test valid IPv6 // Test valid IPv6
const ip6 = new Address6(ip) const ip6 = new Address6(ip)
return ip6.is4() return ip6.is4()
? multiaddr(`/ip4/${ip6.to4().correctForm()}/tcp/${port}`) ? new Multiaddr(`/ip4/${ip6.to4().correctForm()}/tcp/${port}`)
: multiaddr(`/ip6/${ip}/tcp/${port}`) : new Multiaddr(`/ip6/${ip}/tcp/${port}`)
} catch (err) { } catch (err) {
const errMsg = `invalid ip:port for creating a multiaddr: ${ip}:${port}` const errMsg = `invalid ip:port for creating a multiaddr: ${ip}:${port}`
log.error(errMsg) log.error(errMsg)

2
src/multiaddr/is-loopback.js
View File

@ -4,7 +4,7 @@
const isLoopbackAddr = require('is-loopback-addr') const isLoopbackAddr = require('is-loopback-addr')
/** /**
* @typedef {import('multiaddr')} Multiaddr * @typedef {import('multiaddr').Multiaddr} Multiaddr
*/ */
/** /**

2
src/multiaddr/is-private.js
View File

@ -4,7 +4,7 @@
const isIpPrivate = require('private-ip') const isIpPrivate = require('private-ip')
/** /**
* @typedef {import('multiaddr')} Multiaddr * @typedef {import('multiaddr').Multiaddr} Multiaddr
*/ */
/** /**

2
src/stream-to-ma-conn.js
View File

@ -5,7 +5,7 @@ const debug = require('debug')
const log = debug('libp2p:stream:converter') const log = debug('libp2p:stream:converter')
/** /**
* @typedef {import('multiaddr')} Multiaddr * @typedef {import('multiaddr').Multiaddr} Multiaddr
* @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
* *
* @typedef {Object} Timeline * @typedef {Object} Timeline

26
test/address-sort.spec.js
View File

@ -2,7 +2,7 @@
/* eslint-env mocha */ /* eslint-env mocha */
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const { publicAddressesFirst } = require('../src/address-sort') const { publicAddressesFirst } = require('../src/address-sort')
@ -10,44 +10,44 @@ describe('address-sort', () => {
it('should sort public addresses first', () => { it('should sort public addresses first', () => {
const addresses = [ const addresses = [
{ {
multiaddr: multiaddr('/ip4/127.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/127.0.0.1/tcp/4000'),
isCertified: false isCertified: false
}, },
{ {
multiaddr: multiaddr('/ip4/30.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/30.0.0.1/tcp/4000'),
isCertified: false isCertified: false
}, },
{ {
multiaddr: multiaddr('/ip4/31.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/31.0.0.1/tcp/4000'),
isCertified: false isCertified: false
} }
] ]
const sortedAddresses = publicAddressesFirst(addresses) const sortedAddresses = publicAddressesFirst(addresses)
expect(sortedAddresses[0].multiaddr.equals(multiaddr('/ip4/30.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[0].multiaddr.equals(new Multiaddr('/ip4/30.0.0.1/tcp/4000'))).to.eql(true)
expect(sortedAddresses[1].multiaddr.equals(multiaddr('/ip4/31.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[1].multiaddr.equals(new Multiaddr('/ip4/31.0.0.1/tcp/4000'))).to.eql(true)
expect(sortedAddresses[2].multiaddr.equals(multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[2].multiaddr.equals(new Multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
}) })
it('should sort public certified addresses first', () => { it('should sort public certified addresses first', () => {
const addresses = [ const addresses = [
{ {
multiaddr: multiaddr('/ip4/127.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/127.0.0.1/tcp/4000'),
isCertified: false isCertified: false
}, },
{ {
multiaddr: multiaddr('/ip4/30.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/30.0.0.1/tcp/4000'),
isCertified: false isCertified: false
}, },
{ {
multiaddr: multiaddr('/ip4/31.0.0.1/tcp/4000'), multiaddr: new Multiaddr('/ip4/31.0.0.1/tcp/4000'),
isCertified: true isCertified: true
} }
] ]
const sortedAddresses = publicAddressesFirst(addresses) const sortedAddresses = publicAddressesFirst(addresses)
expect(sortedAddresses[0].multiaddr.equals(multiaddr('/ip4/31.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[0].multiaddr.equals(new Multiaddr('/ip4/31.0.0.1/tcp/4000'))).to.eql(true)
expect(sortedAddresses[1].multiaddr.equals(multiaddr('/ip4/30.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[1].multiaddr.equals(new Multiaddr('/ip4/30.0.0.1/tcp/4000'))).to.eql(true)
expect(sortedAddresses[2].multiaddr.equals(multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true) expect(sortedAddresses[2].multiaddr.equals(new Multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
}) })
}) })

48
test/array-equals.spec.js
View File

@ -2,22 +2,22 @@
'use strict' 'use strict'
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const arrayEquals = require('../src/array-equals') const arrayEquals = require('../src/array-equals')
describe('non primitive array equals', () => { describe('non primitive array equals', () => {
it('returns true if two arrays of multiaddrs are equal', () => { it('returns true if two arrays of multiaddrs are equal', () => {
const a = [ const a = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
const b = [ const b = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
expect(arrayEquals(a, b)).to.eql(true) expect(arrayEquals(a, b)).to.eql(true)
@ -25,15 +25,15 @@ describe('non primitive array equals', () => {
it('returns true if two arrays of multiaddrs have the same content but different orders', () => { it('returns true if two arrays of multiaddrs have the same content but different orders', () => {
const a = [ const a = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
const b = [ const b = [
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
expect(arrayEquals(a, b)).to.eql(true) expect(arrayEquals(a, b)).to.eql(true)
@ -41,15 +41,15 @@ describe('non primitive array equals', () => {
it('returns false if two arrays of multiaddrs are different', () => { it('returns false if two arrays of multiaddrs are different', () => {
const a = [ const a = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
const b = [ const b = [
multiaddr('/ip4/127.0.0.1/tcp/8001'), new Multiaddr('/ip4/127.0.0.1/tcp/8001'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
expect(arrayEquals(a, b)).to.eql(false) expect(arrayEquals(a, b)).to.eql(false)
@ -57,14 +57,14 @@ describe('non primitive array equals', () => {
it('returns false if two arrays of multiaddrs are partially equal, but different lengths', () => { it('returns false if two arrays of multiaddrs are partially equal, but different lengths', () => {
const a = [ const a = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/ip4/127.0.0.1/tcp/3000/ws'), new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
const b = [ const b = [
multiaddr('/ip4/127.0.0.1/tcp/8000'), new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
multiaddr('/dns4/test.libp2p.io') new Multiaddr('/dns4/test.libp2p.io')
] ]
expect(arrayEquals(a, b)).to.eql(false) expect(arrayEquals(a, b)).to.eql(false)

28
test/multiaddr/is-loopback.spec.js
View File

@ -2,17 +2,17 @@
'use strict' 'use strict'
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const isLoopback = require('../../src/multiaddr/is-loopback') const isLoopback = require('../../src/multiaddr/is-loopback')
describe('multiaddr isLoopback', () => { describe('multiaddr isLoopback', () => {
it('identifies loopback ip4 multiaddrs', () => { it('identifies loopback ip4 multiaddrs', () => {
[ [
multiaddr('/ip4/127.0.0.1/tcp/1000'), new Multiaddr('/ip4/127.0.0.1/tcp/1000'),
multiaddr('/ip4/127.0.1.1/tcp/1000'), new Multiaddr('/ip4/127.0.1.1/tcp/1000'),
multiaddr('/ip4/127.1.1.1/tcp/1000'), new Multiaddr('/ip4/127.1.1.1/tcp/1000'),
multiaddr('/ip4/127.255.255.255/tcp/1000') new Multiaddr('/ip4/127.255.255.255/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isLoopback(ma)).to.eql(true) expect(isLoopback(ma)).to.eql(true)
}) })
@ -20,10 +20,10 @@ describe('multiaddr isLoopback', () => {
it('identifies non loopback ip4 multiaddrs', () => { it('identifies non loopback ip4 multiaddrs', () => {
[ [
multiaddr('/ip4/101.0.26.90/tcp/1000'), new Multiaddr('/ip4/101.0.26.90/tcp/1000'),
multiaddr('/ip4/10.0.0.1/tcp/1000'), new Multiaddr('/ip4/10.0.0.1/tcp/1000'),
multiaddr('/ip4/192.168.0.1/tcp/1000'), new Multiaddr('/ip4/192.168.0.1/tcp/1000'),
multiaddr('/ip4/172.16.0.1/tcp/1000') new Multiaddr('/ip4/172.16.0.1/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isLoopback(ma)).to.eql(false) expect(isLoopback(ma)).to.eql(false)
}) })
@ -31,7 +31,7 @@ describe('multiaddr isLoopback', () => {
it('identifies loopback ip6 multiaddrs', () => { it('identifies loopback ip6 multiaddrs', () => {
[ [
multiaddr('/ip6/::1/tcp/1000') new Multiaddr('/ip6/::1/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isLoopback(ma)).to.eql(true) expect(isLoopback(ma)).to.eql(true)
}) })
@ -39,8 +39,8 @@ describe('multiaddr isLoopback', () => {
it('identifies non loopback ip6 multiaddrs', () => { it('identifies non loopback ip6 multiaddrs', () => {
[ [
multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'), new Multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'),
multiaddr('/ip6/::/tcp/1000') new Multiaddr('/ip6/::/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isLoopback(ma)).to.eql(false) expect(isLoopback(ma)).to.eql(false)
}) })
@ -48,8 +48,8 @@ describe('multiaddr isLoopback', () => {
it('identifies other multiaddrs as not loopback addresses', () => { it('identifies other multiaddrs as not loopback addresses', () => {
[ [
multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'), new Multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'),
multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443') new Multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443')
].forEach(ma => { ].forEach(ma => {
expect(isLoopback(ma)).to.eql(false) expect(isLoopback(ma)).to.eql(false)
}) })

30
test/multiaddr/is-private.spec.js
View File

@ -2,17 +2,17 @@
'use strict' 'use strict'
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const isPrivate = require('../../src/multiaddr/is-private') const isPrivate = require('../../src/multiaddr/is-private')
describe('multiaddr isPrivate', () => { describe('multiaddr isPrivate', () => {
it('identifies private ip4 multiaddrs', () => { it('identifies private ip4 multiaddrs', () => {
[ [
multiaddr('/ip4/127.0.0.1/tcp/1000'), new Multiaddr('/ip4/127.0.0.1/tcp/1000'),
multiaddr('/ip4/10.0.0.1/tcp/1000'), new Multiaddr('/ip4/10.0.0.1/tcp/1000'),
multiaddr('/ip4/192.168.0.1/tcp/1000'), new Multiaddr('/ip4/192.168.0.1/tcp/1000'),
multiaddr('/ip4/172.16.0.1/tcp/1000') new Multiaddr('/ip4/172.16.0.1/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isPrivate(ma)).to.eql(true) expect(isPrivate(ma)).to.eql(true)
}) })
@ -20,10 +20,10 @@ describe('multiaddr isPrivate', () => {
it('identifies public ip4 multiaddrs', () => { it('identifies public ip4 multiaddrs', () => {
[ [
multiaddr('/ip4/101.0.26.90/tcp/1000'), new Multiaddr('/ip4/101.0.26.90/tcp/1000'),
multiaddr('/ip4/40.1.20.9/tcp/1000'), new Multiaddr('/ip4/40.1.20.9/tcp/1000'),
multiaddr('/ip4/92.168.0.1/tcp/1000'), new Multiaddr('/ip4/92.168.0.1/tcp/1000'),
multiaddr('/ip4/2.16.0.1/tcp/1000') new Multiaddr('/ip4/2.16.0.1/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isPrivate(ma)).to.eql(false) expect(isPrivate(ma)).to.eql(false)
}) })
@ -31,8 +31,8 @@ describe('multiaddr isPrivate', () => {
it('identifies private ip6 multiaddrs', () => { it('identifies private ip6 multiaddrs', () => {
[ [
multiaddr('/ip6/fd52:8342:fc46:6c91:3ac9:86ff:fe31:7095/tcp/1000'), new Multiaddr('/ip6/fd52:8342:fc46:6c91:3ac9:86ff:fe31:7095/tcp/1000'),
multiaddr('/ip6/fd52:8342:fc46:6c91:3ac9:86ff:fe31:1/tcp/1000') new Multiaddr('/ip6/fd52:8342:fc46:6c91:3ac9:86ff:fe31:1/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isPrivate(ma)).to.eql(true) expect(isPrivate(ma)).to.eql(true)
}) })
@ -40,8 +40,8 @@ describe('multiaddr isPrivate', () => {
it('identifies public ip6 multiaddrs', () => { it('identifies public ip6 multiaddrs', () => {
[ [
multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'), new Multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'),
multiaddr('/ip6/2000:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000') new Multiaddr('/ip6/2000:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000')
].forEach(ma => { ].forEach(ma => {
expect(isPrivate(ma)).to.eql(false) expect(isPrivate(ma)).to.eql(false)
}) })
@ -49,8 +49,8 @@ describe('multiaddr isPrivate', () => {
it('identifies other multiaddrs as not private addresses', () => { it('identifies other multiaddrs as not private addresses', () => {
[ [
multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'), new Multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'),
multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443') new Multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443')
].forEach(ma => { ].forEach(ma => {
expect(isPrivate(ma)).to.eql(false) expect(isPrivate(ma)).to.eql(false)
}) })

6
test/stream-to-ma-conn.spec.js
View File

@ -5,15 +5,15 @@ const { expect } = require('aegir/utils/chai')
const pair = require('it-pair') const pair = require('it-pair')
const pipe = require('it-pipe') const pipe = require('it-pipe')
const { collect } = require('streaming-iterables') const { collect } = require('streaming-iterables')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const streamToMaConn = require('../src/stream-to-ma-conn') const streamToMaConn = require('../src/stream-to-ma-conn')
describe('Convert stream into a multiaddr connection', () => { describe('Convert stream into a multiaddr connection', () => {
it('converts a stream and adds the provided metadata', () => { it('converts a stream and adds the provided metadata', () => {
const stream = pair() const stream = pair()
const localAddr = multiaddr('/ip4/101.45.75.219/tcp/6000') const localAddr = new Multiaddr('/ip4/101.45.75.219/tcp/6000')
const remoteAddr = multiaddr('/ip4/100.46.74.201/tcp/6002') const remoteAddr = new Multiaddr('/ip4/100.46.74.201/tcp/6002')
const maConn = streamToMaConn({ const maConn = streamToMaConn({
stream, stream,