feat!: update to latest libp2p interfaces (#76)

BREAKING CHANGE: uses new single-issue libp2p interface modules

Author: achingbrain

README.md

@@ -1,23 +1,30 @@
-# js-libp2p-delegated-peer-routing <!-- omit in toc -->
+# @libp2p/delegated-peer-routing <!-- 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-delegated-peer-routing.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing)
-[![Build Status](https://github.com/libp2p/js-libp2p-delegated-peer-routing/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-delegated-peer-routing/actions/workflows/js-test-and-release.yml)
-[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing)
+[![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-delegated-peer-routing.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing)
+[![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-delegated-peer-routing/actions/workflows/js-test-and-release.yml)
 
-Leverage other peers in the network to perform Peer Routing calls.
-
-Requires access to `/api/v0/dht/findpeer` and `/api/v0/dht/query` HTTP API endpoints of the delegate node.
+> Leverage other peers in the libp2p network to perform Peer Routing calls.
 
 ## Table of contents <!-- omit in toc -->
 
+- [Install](#install)
 - [Requirements](#requirements)
 - [Example](#example)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribution](#contribution)
+
+## Install
+
+```console
+$ npm i @libp2p/delegated-peer-routing
+```
+
+Leverage other peers in the network to perform Peer Routing calls.
+
+Requires access to `/api/v0/dht/findpeer` and `/api/v0/dht/query` HTTP API endpoints of the delegate node.
 
 ## Requirements
 
@@ -60,9 +67,9 @@ for await (const event of routing.getClosestPeers(peerId.id)) {
 
 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

@@ -25,6 +25,7 @@
   ],
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     }
   },
@@ -130,7 +131,10 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interfaces": "^2.0.3",
+    "@libp2p/interface-peer-id": "^1.0.2",
+    "@libp2p/interface-peer-info": "^1.0.1",
+    "@libp2p/interface-peer-routing": "^1.0.0",
+    "@libp2p/interfaces": "^3.0.2",
     "@libp2p/logger": "^1.1.5",
     "@libp2p/peer-id": "^1.1.11",
     "@multiformats/multiaddr": "^10.1.8",
@@ -142,8 +146,8 @@
   },
   "devDependencies": {
     "@libp2p/peer-id-factory": "^1.0.11",
-    "aegir": "^37.0.15",
-    "go-ipfs": "^0.12.0",
+    "aegir": "^37.2.0",
+    "go-ipfs": "^0.13.0",
     "ipfs-http-client": "^57.0.1",
     "ipfsd-ctl": "^11.0.1",
     "it-all": "^1.0.6",

src/index.ts

@@ -3,13 +3,13 @@ import { CID } from 'multiformats/cid'
 import PQueue from 'p-queue'
 import defer from 'p-defer'
 import errCode from 'err-code'
-import { Multiaddr } from '@multiformats/multiaddr'
+import { multiaddr } from '@multiformats/multiaddr'
 import anySignal from 'any-signal'
-import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import type { IPFSHTTPClient, HTTPClientExtraOptions } from 'ipfs-http-client'
 import type { AbortOptions } from 'ipfs-core-types/src/utils'
-import type { PeerRouting } from '@libp2p/interfaces/peer-routing'
-import type { PeerInfo } from '@libp2p/interfaces/peer-info'
+import type { PeerRouting } from '@libp2p/interface-peer-routing'
+import type { PeerInfo } from '@libp2p/interface-peer-info'
 import type { Startable } from '@libp2p/interfaces/startable'
 import { peerIdFromBytes } from '@libp2p/peer-id'
 
@@ -89,7 +89,8 @@ export class DelegatedPeerRouting implements PeerRouting, Startable {
         if (event.name === 'FINAL_PEER') {
           const peerInfo: PeerInfo = {
             id: event.peer.id,
-            multiaddrs: event.peer.multiaddrs.map(ma => new Multiaddr(ma.toString())),
+            // @ts-expect-error ipfs-core types need updating
+            multiaddrs: event.peer.multiaddrs.map(ma => multiaddr(ma.toString())),
             protocols: []
           }
 
@@ -140,7 +141,8 @@ export class DelegatedPeerRouting implements PeerRouting, Startable {
         if (event.name === 'PEER_RESPONSE') {
           yield * event.closer.map(closer => ({
             id: closer.id,
-            multiaddrs: closer.multiaddrs.map(ma => new Multiaddr(ma.toString())),
+            // @ts-expect-error ipfs-core types need updating
+            multiaddrs: closer.multiaddrs.map(ma => multiaddr(ma.toString())),
             protocols: []
           }))
         }