.aegir.js

@@ -1,12 +1,25 @@
 'use strict'
 
-const createServer = require('ipfsd-ctl').createServer
-
-const server = createServer()
+const { createServer } = require('ipfsd-ctl')
+let server
 
 module.exports = {
   hooks: {
-    pre: server.start.bind(server),
-    post: server.stop.bind(server)
+    browser: {
+      pre: async () => {
+        server = createServer({
+          host: '127.0.0.1',
+          port: 57483
+        }, {
+          type: 'go',
+          ipfsHttpModule: require('ipfs-http-client'),
+          ipfsBin: require('go-ipfs-dep').path(),
+          test: true
+        })
+
+        await server.start()
+      },
+      post: () => server.stop()
+    }
   }
 }

.gitignore

@@ -61,4 +61,5 @@ docs
 .env
 
 yarn.lock
-package-lock.json
+package-lock.json
+dist/

CHANGELOG.md

@@ -1,3 +1,87 @@
+<a name="0.5.0"></a>
+# [0.5.0](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.4.3...v0.5.0) (2020-04-23)
+
+
+### Chores
+
+* make ipfs-http-client a peer dependency ([#32](https://github.com/libp2p/js-libp2p-delegated-peer-routing/issues/32)) ([a1b1b5e](https://github.com/libp2p/js-libp2p-delegated-peer-routing/commit/a1b1b5e))
+* remove-peer-info-from-api ([#25](https://github.com/libp2p/js-libp2p-delegated-peer-routing/issues/25)) ([f49ddc0](https://github.com/libp2p/js-libp2p-delegated-peer-routing/commit/f49ddc0))
+
+
+### BREAKING CHANGES
+
+* The ipfs-http-client must now be installed
+as a peer dependency. It is no longer included as a dependency
+of this module.
+
+The reason the http-client should be a peerDependency and
+not a dependency is that its API requires knowledge of the
+http-client (we pass in the api endpoint details).
+* findPeer returns id and addrs properties instead of peer-info instance
+
+* chore: address review
+
+
+
+<a name="0.4.3"></a>
+## [0.4.3](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.4.2...v0.4.3) (2020-04-16)
+
+
+
+<a name="0.4.2"></a>
+## [0.4.2](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.4.1...v0.4.2) (2020-04-09)
+
+
+
+<a name="0.4.1"></a>
+## [0.4.1](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.4.0...v0.4.1) (2020-02-04)
+
+
+
+<a name="0.4.0"></a>
+# [0.4.0](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.3.1...v0.4.0) (2019-11-29)
+
+
+### Chores
+
+* rename timeout option ([#14](https://github.com/libp2p/js-libp2p-delegated-peer-routing/issues/14)) ([36d852f](https://github.com/libp2p/js-libp2p-delegated-peer-routing/commit/36d852f))
+
+
+### BREAKING CHANGES
+
+* maxTimeout option renamed to timeout
+
+
+
+<a name="0.3.1"></a>
+## [0.3.1](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.3.0...v0.3.1) (2019-07-24)
+
+
+### Bug Fixes
+
+* limit concurrent HTTP requests ([#12](https://github.com/libp2p/js-libp2p-delegated-peer-routing/issues/12)) ([e844d30](https://github.com/libp2p/js-libp2p-delegated-peer-routing/commit/e844d30))
+
+
+
+<a name="0.3.0"></a>
+# [0.3.0](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.2.3...v0.3.0) (2019-07-12)
+
+
+### Features
+
+* refactor to use async/await ([#8](https://github.com/libp2p/js-libp2p-delegated-peer-routing/issues/8)) ([1827328](https://github.com/libp2p/js-libp2p-delegated-peer-routing/commit/1827328))
+
+
+### BREAKING CHANGES
+
+* API refactored to use async/await
+
+Also upgrades all the deps, moves from `ipfs-api` to `ipfs-http-client`
+and removes a lot of results massaging that is now done in the
+http client.
+
+
+
 <a name="0.2.3"></a>
 ## [0.2.3](https://github.com/libp2p/js-libp2p-delegated-peer-routing/compare/v0.2.2...v0.2.3) (2019-07-10)
 

README.md

@@ -1,25 +1,36 @@
 # js-libp2p-delegated-peer-routing
+
 Leverage other peers in the network to perform Peer Routing calls.
 
+Requires access to `/api/v0/dht/findpeer` HTTP API endpoint of the delegate node.
+
 ## Lead Maintainer
 
 [Jacob Heun](https://github.com/jacobheun)
 
+## Requirements
+
+`libp2p-delegated-peer-routing` leverages the `ipfs-http-client` library and requires it as a peer dependency, as such, both must be installed in order for this module to work properly.
+
+```sh
+npm install ipfs-http-client libp2p-delegated-peer-routing
+```
+
 ## Example
 
 ```js
-const DelegatedPeerRouting = require('libp2p-delegated-routing')
+const DelegatedPeerRouting = require('libp2p-delegated-peer-routing')
 
 // default is to use ipfs.io
 const routing = new DelegatedPeerRouing()
 
-routing.findPeer('peerid', (err, peerInfo) => {
-  if (err) {
-    return console.error(err)
-  }
+try {
+  const { id, multiaddrs } = await routing.findPeer('peerid')
 
-  console.log('found peer details', peerInfo)
-})
+  console.log('found peer details', id, multiaddrs)
+} catch (err) {
+  console.error(err)
+}
 ```
 
 ## License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-delegated-peer-routing",
-  "version": "0.2.3",
+  "version": "0.5.0",
   "description": "Leverage other peers in the libp2p network to perform Peer Routing calls.",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -18,23 +18,30 @@
     "coverage": "aegir coverage"
   },
   "devDependencies": {
-    "aegir": "^19.0.5",
-    "async": "^3.1.0",
+    "aegir": "^21.7.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
-    "go-ipfs-dep": "^0.4.21",
-    "ipfsd-ctl": "^0.43.0"
+    "go-ipfs-dep": "0.4.23-3",
+    "ipfs-utils": "^2.2.0",
+    "ipfs-http-client": "^44.0.0",
+    "ipfsd-ctl": "^4.0.1"
+  },
+  "peerDependencies": {
+    "ipfs-http-client": "^44.0.0"
   },
   "dependencies": {
-    "ipfs-http-client": "^33.0.1",
-    "peer-id": "^0.12.2",
-    "peer-info": "^0.15.1"
+    "debug": "^4.1.1",
+    "p-queue": "^6.3.0",
+    "peer-id": "^0.13.11"
   },
   "contributors": [
+    "Jacob Heun <jacobheun@gmail.com>",
     "Alan Shaw <alan.shaw@protocol.ai>",
-    "David Dias <daviddias.p@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Alex Potsides <alex@achingbrain.net>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
-    "Jacob Heun <jacobheun@gmail.com>",
-    "Maciej Krüger <mkg20001@gmail.com>"
+    "Maciej Krüger <mkg20001@gmail.com>",
+    "Marcin Rataj <lidel@lidel.org>",
+    "David Dias <daviddias.p@gmail.com>"
   ]
 }

src/index.js

@@ -1,61 +1,72 @@
 'use strict'
 
 const PeerId = require('peer-id')
-const dht = require('ipfs-http-client/src/dht')
-const defaultConfig = require('ipfs-http-client/src/utils/default-config')
+const createFindPeer = require('ipfs-http-client/src/dht/find-peer')
+const { default: PQueue } = require('p-queue')
+const debug = require('debug')
 
-const DEFAULT_MAX_TIMEOUT = 30e3 // 30 second default
+const log = debug('libp2p-delegated-peer-routing')
+log.error = debug('libp2p-delegated-peer-routing:error')
+
+const DEFAULT_TIMEOUT = 30e3 // 30 second default
 const DEFAULT_IPFS_API = {
   protocol: 'https',
   port: 443,
-  host: 'ipfs.io'
+  host: 'node0.delegate.ipfs.io'
 }
+const CONCURRENT_HTTP_REQUESTS = 4
 
 class DelegatedPeerRouting {
   constructor (api) {
-    this.api = Object.assign({}, defaultConfig(), DEFAULT_IPFS_API, api)
-    this.dht = dht(this.api)
+    this.api = Object.assign({}, DEFAULT_IPFS_API, api)
+    this.dht = { findPeer: createFindPeer(this.api) }
+
+    // limit concurrency to avoid request flood in web browser
+    // https://github.com/libp2p/js-libp2p-delegated-content-routing/issues/12
+    this._httpQueue = new PQueue({
+      concurrency: CONCURRENT_HTTP_REQUESTS
+    })
+    log(`enabled DelegatedPeerRouting via ${this.api.protocol}://${this.api.host}:${this.api.port}`)
   }
 
   /**
    * Attempts to find the given peer
    *
    * @param {PeerID} id
    * @param {object} options
-   * @param {number} options.maxTimeout How long the query can take. Defaults to 30 seconds
-   * @param {function(Error, PeerInfo)} callback
-   * @returns {void}
+   * @param {number} options.timeout How long the query can take. Defaults to 30 seconds
+   * @returns {Promise<{ id: PeerId, multiaddrs: Multiaddr[] }>}
    */
-  findPeer (id, options, callback) {
-    if (typeof options === 'function') {
-      callback = options
-      options = {}
-    } else if (typeof options === 'number') { // This will be deprecated in a next release
-      options = {
-        maxTimeout: options
-      }
-    } else {
-      options = options || {}
+  async findPeer (id, options = {}) {
+    let idStr = id
+    if (PeerId.isPeerId(idStr)) {
+      idStr = id.toB58String()
     }
 
-    if (PeerId.isPeerId(id)) {
-      id = id.toB58String()
-    }
+    log('findPeer starts: ' + id)
+
+    options.timeout = options.timeout || DEFAULT_TIMEOUT
 
-    options.maxTimeout = options.maxTimeout || DEFAULT_MAX_TIMEOUT
+    try {
+      return await this._httpQueue.add(async () => {
+        const { addrs } = await this.dht.findPeer(idStr, {
+          timeout: options.timeout
+        })
 
-    this.dht.findPeer(id, {
-      timeout: `${options.maxTimeout}ms`// The api requires specification of the time unit (s/ms)
-    }, (err, info) => {
-      if (err) {
-        if (err.message.includes('not found')) {
-          return callback()
+        return {
+          id,
+          multiaddrs: addrs
         }
-        return callback(err)
+      })
+    } catch (err) {
+      if (err.message.includes('not found')) {
+        return undefined
       }
 
-      callback(null, info)
-    })
+      throw err
+    } finally {
+      log('findPeer finished: ' + id)
+    }
   }
 }