refactor: return peer ids as strings

SPEC/MISCELLANEOUS.md

@@ -19,6 +19,14 @@
 | -------- | -------- |
 | `Promise<Object>` | An object with the Peer identity |
 
+The Peer identity has the following properties:
+
+- `id: String` - the Peer ID
+- `publicKey: String` - the public key of the peer as a base64 encoded string
+- `addresses: String[]` - A list of multiaddrs this node is listening on as strings
+- `agentVersion: String` - The agent version
+- `protocolVersion: String` - The supported protocol version
+
 **Example:**
 
 ```JavaScript

SPEC/SWARM.md

@@ -131,7 +131,7 @@ A great source of [examples][] can be found in the tests for this API.
 The returned array has the following form:
 
 - `addr: Multiaddr`
-- `peer: CID`
+- `peer: String`
 - `latency: String` - Only if `verbose: true`  was passed
 - `muxer: String` - The type of stream muxer the peer is usng
 - `streams: string[]` - Only if `verbose: true`, a list of currently open streams

package.json

@@ -40,6 +40,7 @@
   "dependencies": {
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
+    "chai-things": "^0.2.0",
     "cids": "~0.7.1",
     "delay": "^4.3.0",
     "dirty-chai": "^2.0.1",

src/miscellaneous/id.js

@@ -2,6 +2,7 @@
 'use strict'
 
 const { getDescribe, getIt, expect } = require('../utils/mocha')
+const Multiaddr = require('multiaddr')
 
 /** @typedef { import("ipfsd-ctl/src/factory") } Factory */
 /**
@@ -24,8 +25,21 @@ module.exports = (common, options) => {
 
     it('should get the node ID', async () => {
       const res = await ipfs.id()
-      expect(res).to.have.a.property('id')
+      expect(res).to.have.a.property('id').that.is.a('string')
       expect(res).to.have.a.property('publicKey')
+      expect(res).to.have.a.property('addresses').that.is.an('array').and.all.satisfy(ma => {
+        const isString = (ma instanceof String || typeof ma === 'string')
+        const asString = new Multiaddr(ma).toString()
+
+        // TODO: remove when go-IPFS returns nu-school /p2p/ multiaddrs
+        if (ma.includes('/ipfs/')) {
+          ma = ma.replace(/ipfs/g, 'p2p')
+        }
+
+        return isString && asString === ma
+      })
+      expect(res).to.have.a.property('agentVersion').that.is.a('string')
+      expect(res).to.have.a.property('protocolVersion').that.is.a('string')
     })
   })
 }

src/swarm/peers.js

@@ -2,7 +2,6 @@
 'use strict'
 
 const multiaddr = require('multiaddr')
-const CID = require('cids')
 const delay = require('delay')
 const { isNode } = require('ipfs-utils/src/env')
 const { getDescribe, getIt, expect } = require('../utils/mocha')
@@ -41,8 +40,7 @@ module.exports = (common, options) => {
 
       expect(peer).to.have.a.property('addr')
       expect(multiaddr.isMultiaddr(peer.addr)).to.equal(true)
-      expect(peer).to.have.a.property('peer')
-      expect(CID.isCID(peer.peer)).to.equal(true)
+      expect(peer).to.have.a.property('peer').that.is.a('string')
       expect(peer).to.not.have.a.property('latency')
 
       /* TODO: These assertions must be uncommented as soon as

src/utils/mocha.js

@@ -6,6 +6,7 @@ const chai = require('chai')
 // Do not reorder these statements - https://github.com/chaijs/chai/issues/1298
 chai.use(require('chai-as-promised'))
 chai.use(require('dirty-chai'))
+chai.use(require('chai-things'))
 
 module.exports.expect = chai.expect