feat!: update libp2p interfaces (#47)

BREAKING CHANGE: uses new single-issue libp2p interface modules

Author: achingbrain

README.md

@@ -1,18 +1,30 @@
-# js-libp2p-utils
+# @libp2p/utils <!-- omit in toc -->
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
-[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-utils.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-utils)
-[![](https://img.shields.io/travis/libp2p/js-libp2p-utils.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-utils)
-[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-utils.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utils)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-utils.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-utils)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-utils/actions/workflows/js-test-and-release.yml)
 
-> This package serves as a central repository for shared logic and dependencies for all libp2p packages, using `libp2p-utils` helps to easily re-use small scoped blocks of logic across all libp2p modules and also as a dependency proxy (think `aegir` for domain logic dependencies).
+> Package to aggregate shared logic and dependencies for the libp2p ecosystem
 
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Lead Maintainer](#lead-maintainer)
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [License](#license)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/utils
+```
 
 The libp2p ecosystem has lots of repos with it comes several problems like:
+
 - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
 - Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.
 
@@ -22,14 +34,8 @@ These problems are the motivation for this package, having shared logic in this
 
 [Vasco Santos](https://github.com/vasco-santos)
 
-## Install
-
-
-```bash
-$ npm install --save @libp2p/utils
-```
-
 ## Usage
+
 Each function should be imported directly.
 
 ```js
@@ -48,4 +54,11 @@ Check out our [contributing document](https://github.com/ipfs/community/blob/mas
 
 ## License
 
-[MIT](LICENSE) © Protocol Labs Inc.
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-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.

package.json

@@ -41,31 +41,32 @@
   ],
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     },
     "./address-sort": {
-      "import": "./dist/src/address-sort.js",
-      "types": "./dist/src/address-sort.d.ts"
+      "types": "./dist/src/address-sort.d.ts",
+      "import": "./dist/src/address-sort.js"
     },
     "./array-equals": {
-      "import": "./dist/src/array-equals.js",
-      "types": "./dist/src/array-equals.d.ts"
+      "types": "./dist/src/array-equals.d.ts",
+      "import": "./dist/src/array-equals.js"
     },
     "./ip-port-to-multiaddr": {
-      "import": "./dist/src/ip-port-to-multiaddr.js",
-      "types": "./dist/src/ip-port-to-multiaddr.d.ts"
+      "types": "./dist/src/ip-port-to-multiaddr.d.ts",
+      "import": "./dist/src/ip-port-to-multiaddr.js"
     },
     "./multiaddr/is-loopback": {
-      "import": "./dist/src/multiaddr/is-loopback.js",
-      "types": "./dist/src/multiaddr/is-loopback.d.ts"
+      "types": "./dist/src/multiaddr/is-loopback.d.ts",
+      "import": "./dist/src/multiaddr/is-loopback.js"
     },
     "./multiaddr/is-private": {
-      "import": "./dist/src/multiaddr/is-private.js",
-      "types": "./dist/src/multiaddr/is-private.d.ts"
+      "types": "./dist/src/multiaddr/is-private.d.ts",
+      "import": "./dist/src/multiaddr/is-private.js"
     },
     "./stream-to-ma-conn": {
-      "import": "./dist/src/stream-to-ma-conn.js",
-      "types": "./dist/src/stream-to-ma-conn.d.ts"
+      "types": "./dist/src/stream-to-ma-conn.d.ts",
+      "import": "./dist/src/stream-to-ma-conn.js"
     }
   },
   "eslintConfig": {
@@ -171,19 +172,20 @@
   },
   "dependencies": {
     "@achingbrain/ip-address": "^8.1.0",
-    "@libp2p/logger": "^1.0.1",
+    "@libp2p/interface-connection": "^1.0.1",
+    "@libp2p/interface-peer-store": "^1.0.0",
+    "@libp2p/interface-transport": "^1.0.0",
+    "@libp2p/logger": "^2.0.0",
     "@multiformats/multiaddr": "^10.1.1",
     "abortable-iterator": "^4.0.2",
     "err-code": "^3.0.1",
     "is-loopback-addr": "^2.0.1",
     "it-stream-types": "^1.0.4",
-    "private-ip": "^2.1.1",
-    "ts-mocha": "^9.0.2",
-    "ts-node": "^10.7.0"
+    "private-ip": "^2.1.1"
   },
   "devDependencies": {
     "@libp2p/interfaces": "^1.0.3",
-    "aegir": "^37.0.4",
+    "aegir": "^37.2.0",
     "it-all": "^1.0.6",
     "it-pair": "^2.0.2",
     "it-pipe": "^2.0.2",

src/address-sort.ts

@@ -1,4 +1,4 @@
-import type { Address } from '@libp2p/interfaces/peer-store'
+import type { Address } from '@libp2p/interface-peer-store'
 import { isPrivate } from './multiaddr/is-private.js'
 
 /**

src/stream-to-ma-conn.ts

@@ -1,7 +1,7 @@
 import { abortableSource } from 'abortable-iterator'
 import { logger } from '@libp2p/logger'
 import type { Multiaddr } from '@multiformats/multiaddr'
-import type { MultiaddrConnection } from '@libp2p/interfaces/transport'
+import type { MultiaddrConnection } from '@libp2p/interface-connection'
 import type { Duplex } from 'it-stream-types'
 
 const log = logger('libp2p:stream:converter')

test/address-sort.spec.ts

@@ -1,51 +1,51 @@
 /* eslint-env mocha */
 
 import { expect } from 'aegir/chai'
-import { Multiaddr } from '@multiformats/multiaddr'
+import { multiaddr } from '@multiformats/multiaddr'
 import { publicAddressesFirst } from '../src/address-sort.js'
 
 describe('address-sort', () => {
   it('should sort public addresses first', () => {
     const addresses = [
       {
-        multiaddr: new Multiaddr('/ip4/127.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/127.0.0.1/tcp/4000'),
         isCertified: false
       },
       {
-        multiaddr: new Multiaddr('/ip4/30.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/30.0.0.1/tcp/4000'),
         isCertified: false
       },
       {
-        multiaddr: new Multiaddr('/ip4/31.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/31.0.0.1/tcp/4000'),
         isCertified: false
       }
     ]
 
     const sortedAddresses = addresses.sort(publicAddressesFirst)
-    expect(sortedAddresses[0].multiaddr.equals(new Multiaddr('/ip4/30.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(new Multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
+    expect(sortedAddresses[0].multiaddr.equals(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[2].multiaddr.equals(multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
   })
 
   it('should sort public certified addresses first', () => {
     const addresses = [
       {
-        multiaddr: new Multiaddr('/ip4/127.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/127.0.0.1/tcp/4000'),
         isCertified: false
       },
       {
-        multiaddr: new Multiaddr('/ip4/30.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/30.0.0.1/tcp/4000'),
         isCertified: false
       },
       {
-        multiaddr: new Multiaddr('/ip4/31.0.0.1/tcp/4000'),
+        multiaddr: multiaddr('/ip4/31.0.0.1/tcp/4000'),
         isCertified: true
       }
     ]
 
     const sortedAddresses = addresses.sort(publicAddressesFirst)
-    expect(sortedAddresses[0].multiaddr.equals(new Multiaddr('/ip4/31.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(new Multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
+    expect(sortedAddresses[0].multiaddr.equals(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[2].multiaddr.equals(multiaddr('/ip4/127.0.0.1/tcp/4000'))).to.eql(true)
   })
 })

test/array-equals.spec.ts

@@ -1,68 +1,68 @@
 /* eslint-env mocha */
 
 import { expect } from 'aegir/chai'
-import { Multiaddr } from '@multiformats/multiaddr'
+import { multiaddr } from '@multiformats/multiaddr'
 import { arrayEquals } from '../src/array-equals.js'
 
 describe('non primitive array equals', () => {
   it('returns true if two arrays of multiaddrs are equal', () => {
     const a = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     const b = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     expect(arrayEquals(a, b)).to.eql(true)
   })
 
   it('returns true if two arrays of multiaddrs have the same content but different orders', () => {
     const a = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     const b = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     expect(arrayEquals(a, b)).to.eql(true)
   })
 
   it('returns false if two arrays of multiaddrs are different', () => {
     const a = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     const b = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8001'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8001'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     expect(arrayEquals(a, b)).to.eql(false)
   })
 
   it('returns false if two arrays of multiaddrs are partially equal, but different lengths', () => {
     const a = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/ip4/127.0.0.1/tcp/3000/ws'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     const b = [
-      new Multiaddr('/ip4/127.0.0.1/tcp/8000'),
-      new Multiaddr('/dns4/test.libp2p.io')
+      multiaddr('/ip4/127.0.0.1/tcp/8000'),
+      multiaddr('/dns4/test.libp2p.io')
     ]
 
     expect(arrayEquals(a, b)).to.eql(false)

test/multiaddr/is-loopback.spec.ts

@@ -1,53 +1,53 @@
 /* eslint-env mocha */
 
 import { expect } from 'aegir/chai'
-import { Multiaddr } from '@multiformats/multiaddr'
+import { multiaddr } from '@multiformats/multiaddr'
 import { isLoopback } from '../../src/multiaddr/is-loopback.js'
 
 describe('multiaddr isLoopback', () => {
   it('identifies loopback ip4 multiaddrs', () => {
     [
-      new Multiaddr('/ip4/127.0.0.1/tcp/1000'),
-      new Multiaddr('/ip4/127.0.1.1/tcp/1000'),
-      new Multiaddr('/ip4/127.1.1.1/tcp/1000'),
-      new Multiaddr('/ip4/127.255.255.255/tcp/1000')
+      multiaddr('/ip4/127.0.0.1/tcp/1000'),
+      multiaddr('/ip4/127.0.1.1/tcp/1000'),
+      multiaddr('/ip4/127.1.1.1/tcp/1000'),
+      multiaddr('/ip4/127.255.255.255/tcp/1000')
     ].forEach(ma => {
       expect(isLoopback(ma)).to.eql(true)
     })
   })
 
   it('identifies non loopback ip4 multiaddrs', () => {
     [
-      new Multiaddr('/ip4/101.0.26.90/tcp/1000'),
-      new Multiaddr('/ip4/10.0.0.1/tcp/1000'),
-      new Multiaddr('/ip4/192.168.0.1/tcp/1000'),
-      new Multiaddr('/ip4/172.16.0.1/tcp/1000')
+      multiaddr('/ip4/101.0.26.90/tcp/1000'),
+      multiaddr('/ip4/10.0.0.1/tcp/1000'),
+      multiaddr('/ip4/192.168.0.1/tcp/1000'),
+      multiaddr('/ip4/172.16.0.1/tcp/1000')
     ].forEach(ma => {
       expect(isLoopback(ma)).to.eql(false)
     })
   })
 
   it('identifies loopback ip6 multiaddrs', () => {
     [
-      new Multiaddr('/ip6/::1/tcp/1000')
+      multiaddr('/ip6/::1/tcp/1000')
     ].forEach(ma => {
       expect(isLoopback(ma)).to.eql(true)
     })
   })
 
   it('identifies non loopback ip6 multiaddrs', () => {
     [
-      new Multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'),
-      new Multiaddr('/ip6/::/tcp/1000')
+      multiaddr('/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/1000'),
+      multiaddr('/ip6/::/tcp/1000')
     ].forEach(ma => {
       expect(isLoopback(ma)).to.eql(false)
     })
   })
 
   it('identifies other multiaddrs as not loopback addresses', () => {
     [
-      new Multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'),
-      new Multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443')
+      multiaddr('/dns4/wss0.bootstrap.libp2p.io/tcp/443'),
+      multiaddr('/dns6/wss0.bootstrap.libp2p.io/tcp/443')
     ].forEach(ma => {
       expect(isLoopback(ma)).to.eql(false)
     })