feat!: update libp2p interfaces (#345)

BREAKING CHANGE: uses new single-issue libp2p interface modules

Author: achingbrain

README.md

@@ -1,24 +1,16 @@
-# js-libp2p-kad-dht <!-- omit in toc -->
+# @libp2p/kad-dht <!-- omit in toc -->
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
-[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
-[![Build Status](https://github.com/libp2p/js-libp2p-kad-dht/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-kad-dht/actions/workflows/js-test-and-release.yml)
-[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-kad-dht/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-kad-dht?branch=master)
-[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht)
-[![Bundle Size](https://flat.badgen.net/bundlephobia/minzip/libp2p-kad-dht)](https://bundlephobia.com/result?p=libp2p-kad-dht)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
-[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
+[![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-kad-dht.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht)
+[![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-kad-dht/actions/workflows/js-test-and-release.yml)
 
-> JavaScript implementation of the Kademlia DHT for libp2p, based on [go-libp2p-kad-dht](https://github.com/libp2p/go-libp2p-kad-dht).
+> JavaScript implementation of the Kad-DHT for libp2p
 
-## Table of Contents  <!-- omit in toc -->
+## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
-  - [npm](#npm)
   - [Use in Node.js](#use-in-nodejs)
 - [API](#api)
   - [Custom secondary DHT in libp2p](#custom-secondary-dht-in-libp2p)
@@ -28,10 +20,13 @@
 - [Spec](#spec)
 - [Contribute](#contribute)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
+
 ## Install
 
-### npm
+```console
+$ npm i @libp2p/kad-dht
+```
 
 ```sh
 > npm i @libp2p/kad-dht
@@ -45,7 +40,7 @@ import { create } from '@libp2p/kad-dht'
 
 ## API
 
-See https://libp2p.github.io/js-libp2p-kad-dht for the auto generated docs.
+See <https://libp2p.github.io/js-libp2p-kad-dht> for the auto generated docs.
 
 The libp2p-kad-dht module offers 3 APIs: Peer Routing, Content Routing and Peer Discovery.
 
@@ -69,6 +64,7 @@ async function addDHT(libp2p) {
 ```
 
 Note that you may want to supply your own peer discovery function and datastore
+
 ### Peer Routing
 
 [![](https://raw.githubusercontent.com/libp2p/interface-peer-routing/master/img/badge.png)](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/peer-routing)
@@ -97,9 +93,9 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 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)
+- 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
+## 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

@@ -28,6 +28,7 @@
   ],
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     }
   },
@@ -132,12 +133,22 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/crypto": "^0.22.12",
-    "@libp2p/interfaces": "^2.0.2",
-    "@libp2p/logger": "^1.1.4",
-    "@libp2p/peer-id": "^1.1.10",
-    "@libp2p/record": "^1.0.4",
-    "@libp2p/topology": "^1.1.7",
+    "@libp2p/components": "^1.0.0",
+    "@libp2p/crypto": "^1.0.0",
+    "@libp2p/interface-address-manager": "^1.0.1",
+    "@libp2p/interface-connection": "^1.0.1",
+    "@libp2p/interface-connection-manager": "^1.0.0",
+    "@libp2p/interface-dht": "^1.0.0",
+    "@libp2p/interface-peer-discovery": "^1.0.0",
+    "@libp2p/interface-peer-id": "^1.0.2",
+    "@libp2p/interface-peer-info": "^1.0.1",
+    "@libp2p/interface-peer-store": "^1.0.0",
+    "@libp2p/interface-registrar": "^1.0.0",
+    "@libp2p/interfaces": "^3.0.2",
+    "@libp2p/logger": "^1.1.6",
+    "@libp2p/peer-id": "^1.1.13",
+    "@libp2p/record": "^2.0.0",
+    "@libp2p/topology": "^2.0.0",
     "@multiformats/multiaddr": "^10.1.5",
     "abortable-iterator": "^4.0.2",
     "any-signal": "^3.0.0",
@@ -167,9 +178,9 @@
     "varint": "^6.0.0"
   },
   "devDependencies": {
-    "@libp2p/interface-compliance-tests": "^2.0.3",
+    "@libp2p/interface-mocks": "^1.0.1",
     "@libp2p/peer-id-factory": "^1.0.9",
-    "@libp2p/peer-store": "^1.0.11",
+    "@libp2p/peer-store": "^2.0.0",
     "@types/lodash.random": "^3.2.6",
     "@types/lodash.range": "^3.2.6",
     "@types/varint": "^6.0.0",

src/content-fetching/index.ts

@@ -16,15 +16,15 @@ import {
 } from '../constants.js'
 import { createPutRecord, convertBuffer, bufferToRecordKey } from '../utils.js'
 import { logger } from '@libp2p/logger'
-import type { Validators, Selectors, ValueEvent, QueryOptions } from '@libp2p/interfaces/dht'
+import type { Validators, Selectors, ValueEvent, QueryOptions } from '@libp2p/interface-dht'
 import type { PeerRouting } from '../peer-routing/index.js'
 import type { QueryManager } from '../query/manager.js'
 import type { RoutingTable } from '../routing-table/index.js'
 import type { Network } from '../network.js'
 import type { Logger } from '@libp2p/logger'
 import type { AbortOptions } from '@libp2p/interfaces'
 import type { QueryFunc } from '../query/types.js'
-import { Components, Initializable } from '@libp2p/interfaces/components'
+import { Components, Initializable } from '@libp2p/components'
 
 export interface ContentFetchingInit {
   validators: Validators

src/content-routing/index.ts

@@ -10,7 +10,7 @@ import {
   providerEvent
 } from '../query/events.js'
 import { logger } from '@libp2p/logger'
-import type { QueryEvent, QueryOptions } from '@libp2p/interfaces/dht'
+import type { QueryEvent, QueryOptions } from '@libp2p/interface-dht'
 import type { PeerRouting } from '../peer-routing/index.js'
 import type { QueryManager } from '../query/manager.js'
 import type { RoutingTable } from '../routing-table/index.js'
@@ -21,8 +21,8 @@ import type { QueryFunc } from '../query/types.js'
 import type { CID } from 'multiformats/cid'
 import type { AbortOptions } from '@libp2p/interfaces'
 import type { Multiaddr } from '@multiformats/multiaddr'
-import type { PeerInfo } from '@libp2p/interfaces/peer-info'
-import { Components, Initializable } from '@libp2p/interfaces/components'
+import type { PeerInfo } from '@libp2p/interface-peer-info'
+import { Components, Initializable } from '@libp2p/components'
 
 export interface ContentRoutingInit {
   network: Network

src/dual-kad-dht.ts

@@ -3,14 +3,14 @@ import errCode from 'err-code'
 import merge from 'it-merge'
 import { queryErrorEvent } from './query/events.js'
 import type { KadDHT } from './kad-dht.js'
-import type { DualDHT, QueryOptions } from '@libp2p/interfaces/dht'
+import type { DualDHT, QueryOptions } from '@libp2p/interface-dht'
 import type { AbortOptions } from '@libp2p/interfaces'
 import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
 import type { CID } from 'multiformats'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
-import type { PeerDiscoveryEvents } from '@libp2p/interfaces/peer-discovery'
-import { Components, Initializable } from '@libp2p/interfaces/components'
-import { symbol } from '@libp2p/interfaces/peer-discovery'
+import type { PeerId } from '@libp2p/interface-peer-id'
+import type { PeerDiscoveryEvents } from '@libp2p/interface-peer-discovery'
+import { Components, Initializable } from '@libp2p/components'
+import { symbol } from '@libp2p/interface-peer-discovery'
 
 const log = logger('libp2p:kad-dht')
 

src/index.ts

@@ -1,6 +1,6 @@
 import { KadDHT as SingleKadDHT } from './kad-dht.js'
 import { DualKadDHT } from './dual-kad-dht.js'
-import type { Selectors, Validators } from '@libp2p/interfaces/dht'
+import type { Selectors, Validators } from '@libp2p/interface-dht'
 
 export interface KadDHTInit {
   /**

src/kad-dht.ts

@@ -14,17 +14,17 @@ import {
   removePublicAddresses
 } from './utils.js'
 import { Logger, logger } from '@libp2p/logger'
-import type { QueryOptions, Validators, Selectors, DHT } from '@libp2p/interfaces/dht'
-import type { PeerInfo } from '@libp2p/interfaces/peer-info'
+import type { QueryOptions, Validators, Selectors, DHT } from '@libp2p/interface-dht'
+import type { PeerInfo } from '@libp2p/interface-peer-info'
 import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import type { CID } from 'multiformats/cid'
-import type { PeerDiscoveryEvents } from '@libp2p/interfaces/peer-discovery'
-import { Components, Initializable } from '@libp2p/interfaces/components'
+import type { PeerDiscoveryEvents } from '@libp2p/interface-peer-discovery'
+import { Components, Initializable } from '@libp2p/components'
 import type { KadDHTInit } from './index.js'
 import { validators as recordValidators } from '@libp2p/record/validators'
 import { selectors as recordSelectors } from '@libp2p/record/selectors'
-import { symbol } from '@libp2p/interfaces/peer-discovery'
+import { symbol } from '@libp2p/interface-peer-discovery'
 import { PROTOCOL_DHT, PROTOCOL_PREFIX, LAN_PREFIX } from './constants.js'
 
 export interface SingleKadDHTInit extends KadDHTInit {

src/message/index.ts

@@ -2,7 +2,7 @@ import { peerIdFromBytes } from '@libp2p/peer-id'
 import { Multiaddr } from '@multiformats/multiaddr'
 import { Libp2pRecord } from '@libp2p/record'
 import { Message as PBMessage } from './dht.js'
-import type { PeerInfo } from '@libp2p/interfaces/peer-info'
+import type { PeerInfo } from '@libp2p/interface-peer-info'
 
 export const MESSAGE_TYPE = PBMessage.MessageType
 export const CONNECTION_TYPE = PBMessage.ConnectionType

src/network.ts

@@ -12,14 +12,14 @@ import {
   queryErrorEvent
 } from './query/events.js'
 import { logger } from '@libp2p/logger'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import type { AbortOptions } from '@libp2p/interfaces'
 import type { Startable } from '@libp2p/interfaces/startable'
 import type { Logger } from '@libp2p/logger'
 import type { Duplex } from 'it-stream-types'
-import type { PeerInfo } from '@libp2p/interfaces/peer-info'
-import { Components, Initializable } from '@libp2p/interfaces/components'
-import type { Stream } from '@libp2p/interfaces/connection'
+import type { PeerInfo } from '@libp2p/interface-peer-info'
+import { Components, Initializable } from '@libp2p/components'
+import type { Stream } from '@libp2p/interface-connection'
 import { abortableDuplex } from 'abortable-iterator'
 
 export interface NetworkInit {

src/peer-list/index.ts

@@ -1,4 +1,4 @@
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 
 /**
  * A list of unique peers.