Skip to content

Commit 602ccaa

Browse files
vasco-santosvasco-santos
committedApr 23, 2020
chore: remove peer-info usage
BREAKING CHANGE: using new topology api with peer-id instead of peer-info and new pubsub internal peer data structure
·
v14.1.0v0.4.0
1 parent f2b67a2 commit 602ccaa

15 files changed

+121
-127
lines changed
 

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ const registrar = {
4444
}
4545
}
4646

47-
const gsub = new Gossipsub(peerInfo, registrar, options)
47+
const gsub = new Gossipsub(peerId, registrar, options)
4848

4949
await gsub.start()
5050

@@ -62,7 +62,7 @@ gsub.publish('fruit', new Buffer('banana'))
6262

6363
```js
6464
const options = {…}
65-
const gossipsub = new Gossipsub(peerInfo, registrar, options)
65+
const gossipsub = new Gossipsub(peerId, registrar, options)
6666
```
6767

6868
Options is an optional object with the following key-value pairs:

‎package.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,9 @@
3838
"err-code": "^2.0.0",
3939
"it-length-prefixed": "^3.0.0",
4040
"it-pipe": "^1.0.1",
41-
"libp2p-pubsub": "~0.4.1",
41+
"libp2p-pubsub": "^0.5.0",
4242
"p-map": "^3.0.0",
4343
"peer-id": "~0.13.3",
44-
"peer-info": "~0.17.0",
4544
"protons": "^1.0.1",
4645
"time-cache": "^0.3.0"
4746
},
@@ -55,7 +54,7 @@
5554
"detect-node": "^2.0.4",
5655
"dirty-chai": "^2.0.1",
5756
"it-pair": "^1.0.0",
58-
"libp2p-floodsub": "^0.20.0",
57+
"libp2p-floodsub": "^0.21.0",
5958
"lodash": "^4.17.15",
6059
"mocha": "^6.2.1",
6160
"p-times": "^2.1.0",

‎src/heartbeat.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class Heartbeat {
8383
return
8484
}
8585

86-
this.gossipsub.log('HEARTBEAT: Add mesh link to %s in %s', peer.info.id.toB58String(), topic)
86+
this.gossipsub.log('HEARTBEAT: Add mesh link to %s in %s', peer.id.toB58String(), topic)
8787
peers.add(peer)
8888
const peerGrafts = tograft.get(peer)
8989
if (!peerGrafts) {
@@ -102,7 +102,7 @@ class Heartbeat {
102102
peersArray = peersArray.slice(0, idontneed)
103103

104104
peersArray.forEach((peer) => {
105-
this.gossipsub.log('HEARTBEAT: Remove mesh link to %s in %s', peer.info.id.toB58String(), topic)
105+
this.gossipsub.log('HEARTBEAT: Remove mesh link to %s in %s', peer.id.toB58String(), topic)
106106
peers.delete(peer)
107107
const peerPrunes = toprune.get(peer)
108108
if (!peerPrunes) {

‎src/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
/// <reference types="node"/>
55

6-
import PeerInfo = require('peer-info');
6+
import PeerId = require('peer-id');
77

88
export interface Registrar {
99
handle: Function;
@@ -29,7 +29,7 @@ import * as Events from "events";
2929
interface GossipSub extends Events.EventEmitter {}
3030

3131
declare class GossipSub {
32-
constructor(peerInfo: PeerInfo, registrar: Registrar, options: Options);
32+
constructor(peerId: PeerId, registrar: Registrar, options: Options);
3333
publish(topic: string, data: Buffer): Promise<void>;
3434
start(): Promise<void>;
3535
stop(): Promise<void>;

‎src/index.js

+21-21
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
const { utils } = require('libp2p-pubsub')
44

5-
const PeerInfo = require('peer-info')
5+
const PeerId = require('peer-id')
66

77
const BasicPubsub = require('./pubsub')
88
const { MessageCache } = require('./messageCache')
@@ -13,7 +13,7 @@ const Heartbeat = require('./heartbeat')
1313

1414
class GossipSub extends BasicPubsub {
1515
/**
16-
* @param {PeerInfo} peerInfo instance of the peer's PeerInfo
16+
* @param {PeerId} peerId instance of the peer's PeerId
1717
* @param {Object} registrar
1818
* @param {function} registrar.handle
1919
* @param {function} registrar.register
@@ -26,15 +26,15 @@ class GossipSub extends BasicPubsub {
2626
* @param {Object} [options.messageCache] override the default MessageCache
2727
* @constructor
2828
*/
29-
constructor (peerInfo, registrar, options = {}) {
30-
if (!PeerInfo.isPeerInfo(peerInfo)) {
31-
throw new Error('peer info must be an instance of `peer-info`')
29+
constructor (peerId, registrar, options = {}) {
30+
if (!PeerId.isPeerId(peerId)) {
31+
throw new Error('peerId must be an instance of `peer-id`')
3232
}
3333

3434
super({
3535
debugName: 'libp2p:gossipsub',
3636
multicodec: constants.GossipSubID,
37-
peerInfo,
37+
peerId,
3838
registrar,
3939
options
4040
})
@@ -95,7 +95,7 @@ class GossipSub extends BasicPubsub {
9595
* Removes a peer from the router
9696
* @override
9797
* @param {Peer} peer
98-
* @returns {PeerInfo}
98+
* @returns {Peer}
9999
*/
100100
_removePeer (peer) {
101101
super._removePeer(peer)
@@ -162,13 +162,13 @@ class GossipSub extends BasicPubsub {
162162

163163
// Emit to floodsub peers
164164
this.peers.forEach((peer) => {
165-
if (peer.info.protocols.has(constants.FloodSubID) &&
166-
peer.info.id.toB58String() !== msg.from &&
165+
if (peer.protocols.includes(constants.FloodSubID) &&
166+
peer.id.toB58String() !== msg.from &&
167167
utils.anyMatch(peer.topics, topics) &&
168168
peer.isWritable
169169
) {
170170
peer.sendMessages(utils.normalizeOutRpcMessages([msg]))
171-
this.log('publish msg on topics - floodsub', topics, peer.info.id.toB58String())
171+
this.log('publish msg on topics - floodsub', topics, peer.id.toB58String())
172172
}
173173
})
174174

@@ -178,11 +178,11 @@ class GossipSub extends BasicPubsub {
178178
return
179179
}
180180
this.mesh.get(topic).forEach((peer) => {
181-
if (!peer.isWritable || peer.info.id.toB58String() === msg.from) {
181+
if (!peer.isWritable || peer.id.toB58String() === msg.from) {
182182
return
183183
}
184184
peer.sendMessages(utils.normalizeOutRpcMessages([msg]))
185-
this.log('publish msg on topic - meshsub', topic, peer.info.id.toB58String())
185+
this.log('publish msg on topic - meshsub', topic, peer.id.toB58String())
186186
})
187187
})
188188
}
@@ -213,7 +213,7 @@ class GossipSub extends BasicPubsub {
213213
return
214214
}
215215

216-
this.log('IHAVE: Asking for %d messages from %s', iwant.size, peer.info.id.toB58String())
216+
this.log('IHAVE: Asking for %d messages from %s', iwant.size, peer.id.toB58String())
217217

218218
return {
219219
messageIDs: Array.from(iwant)
@@ -244,7 +244,7 @@ class GossipSub extends BasicPubsub {
244244
return
245245
}
246246

247-
this.log('IWANT: Sending %d messages to %s', ihave.size, peer.info.id.toB58String())
247+
this.log('IWANT: Sending %d messages to %s', ihave.size, peer.id.toB58String())
248248

249249
return Array.from(ihave.values())
250250
}
@@ -263,7 +263,7 @@ class GossipSub extends BasicPubsub {
263263
if (!peers) {
264264
prune.push(topicID)
265265
} else {
266-
this.log('GRAFT: Add mesh link from %s in %s', peer.info.id.toB58String(), topicID)
266+
this.log('GRAFT: Add mesh link from %s in %s', peer.id.toB58String(), topicID)
267267
peers.add(peer)
268268
peer.topics.add(topicID)
269269
this.mesh.set(topicID, peers)
@@ -293,7 +293,7 @@ class GossipSub extends BasicPubsub {
293293
prune.forEach(({ topicID }) => {
294294
const peers = this.mesh.get(topicID)
295295
if (peers) {
296-
this.log('PRUNE: Remove mesh link to %s in %s', peer.info.id.toB58String(), topicID)
296+
this.log('PRUNE: Remove mesh link to %s in %s', peer.id.toB58String(), topicID)
297297
peers.delete(peer)
298298
peer.topics.delete(topicID)
299299
}
@@ -352,7 +352,7 @@ class GossipSub extends BasicPubsub {
352352
this.mesh.set(topic, peers)
353353
}
354354
this.mesh.get(topic).forEach((peer) => {
355-
this.log('JOIN: Add mesh link to %s in %s', peer.info.id.toB58String(), topic)
355+
this.log('JOIN: Add mesh link to %s in %s', peer.id.toB58String(), topic)
356356
this._sendGraft(peer, topic)
357357
})
358358
})
@@ -373,7 +373,7 @@ class GossipSub extends BasicPubsub {
373373
const meshPeers = this.mesh.get(topic)
374374
if (meshPeers) {
375375
meshPeers.forEach((peer) => {
376-
this.log('LEAVE: Remove mesh link to %s in %s', peer.info.id.toB58String(), topic)
376+
this.log('LEAVE: Remove mesh link to %s in %s', peer.id.toB58String(), topic)
377377
this._sendPrune(peer, topic)
378378
})
379379
this.mesh.delete(topic)
@@ -405,7 +405,7 @@ class GossipSub extends BasicPubsub {
405405

406406
// floodsub peers
407407
peersInTopic.forEach((peer) => {
408-
if (peer.info.protocols.has(constants.FloodSubID)) {
408+
if (peer.protocols.includes(constants.FloodSubID)) {
409409
tosend.add(peer)
410410
}
411411
})
@@ -436,7 +436,7 @@ class GossipSub extends BasicPubsub {
436436
})
437437
// Publish messages to peers
438438
tosend.forEach((peer) => {
439-
if (peer.info.id.toB58String() === msgObj.from) {
439+
if (peer.id.toB58String() === msgObj.from) {
440440
return
441441
}
442442
this._sendRpc(peer, { msgs: [msgObj] })
@@ -591,7 +591,7 @@ class GossipSub extends BasicPubsub {
591591
* @returns {void}
592592
*/
593593
_pushGossip (peer, controlIHaveMsgs) {
594-
this.log('Add gossip to %s', peer.info.id.toB58String())
594+
this.log('Add gossip to %s', peer.id.toB58String())
595595
const gossip = this.gossip.get(peer) || []
596596
this.gossip.set(peer, gossip.concat(controlIHaveMsgs))
597597
}

‎src/pubsub.js

+15-15
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ class BasicPubSub extends Pubsub {
2020
* @param {Object} props
2121
* @param {String} props.debugName log namespace
2222
* @param {string} props.multicodec protocol identificer to connect
23-
* @param {PeerInfo} props.peerInfo peer's peerInfo
23+
* @param {PeerId} props.peerId peer's peerId
2424
* @param {Object} props.registrar registrar for libp2p protocols
2525
* @param {function} props.registrar.handle
2626
* @param {function} props.registrar.register
2727
* @param {function} props.registrar.unregister
2828
* @param {Object} [props.options]
29-
* @param {bool} [props.options.emitSelf] if publish should emit to self, if subscribed, defaults to false
30-
* @param {bool} [props.options.gossipIncoming] if incoming messages on a subscribed topic should be automatically gossiped, defaults to true
31-
* @param {bool} [props.options.fallbackToFloodsub] if dial should fallback to floodsub, defaults to true
29+
* @param {boolean} [props.options.emitSelf] if publish should emit to self, if subscribed, defaults to false
30+
* @param {boolean} [props.options.gossipIncoming] if incoming messages on a subscribed topic should be automatically gossiped, defaults to true
31+
* @param {boolean} [props.options.fallbackToFloodsub] if dial should fallback to floodsub, defaults to true
3232
* @constructor
3333
*/
34-
constructor ({ debugName, multicodec, peerInfo, registrar, options = {} }) {
34+
constructor ({ debugName, multicodec, peerId, registrar, options = {} }) {
3535
const multicodecs = [multicodec]
3636
const _options = {
3737
emitSelf: false,
@@ -48,7 +48,7 @@ class BasicPubSub extends Pubsub {
4848
super({
4949
debugName,
5050
multicodecs,
51-
peerInfo,
51+
peerId,
5252
registrar,
5353
..._options
5454
})
@@ -83,13 +83,13 @@ class BasicPubSub extends Pubsub {
8383
/**
8484
* Peer connected successfully with pubsub protocol.
8585
* @override
86-
* @param {PeerInfo} peerInfo peer info
86+
* @param {PeerId} peerId peer id
8787
* @param {Connection} conn connection to the peer
8888
* @returns {Promise<void>}
8989
*/
90-
async _onPeerConnected (peerInfo, conn) {
91-
await super._onPeerConnected(peerInfo, conn)
92-
const idB58Str = peerInfo.id.toB58String()
90+
async _onPeerConnected (peerId, conn) {
91+
await super._onPeerConnected(peerId, conn)
92+
const idB58Str = peerId.toB58String()
9393
const peer = this.peers.get(idB58Str)
9494

9595
if (peer && peer.isWritable) {
@@ -123,7 +123,7 @@ class BasicPubSub extends Pubsub {
123123
}
124124
)
125125
} catch (err) {
126-
this._onPeerDisconnected(peer.info, err)
126+
this._onPeerDisconnected(peer.id, err)
127127
}
128128
}
129129

@@ -167,7 +167,7 @@ class BasicPubSub extends Pubsub {
167167
topicSet.delete(peer)
168168
}
169169
})
170-
this.emit('pubsub:subscription-change', peer.info, peer.topics, subs)
170+
this.emit('pubsub:subscription-change', peer.id, peer.topics, subs)
171171
}
172172

173173
if (msgs.length) {
@@ -207,7 +207,7 @@ class BasicPubSub extends Pubsub {
207207
* @param {rpc.RPC.Message} msg
208208
*/
209209
_processRpcMessage (msg) {
210-
if (this.peerInfo.id.toB58String() === msg.from && !this._options.emitSelf) {
210+
if (this.peerId.toB58String() === msg.from && !this._options.emitSelf) {
211211
return
212212
}
213213

@@ -369,7 +369,7 @@ class BasicPubSub extends Pubsub {
369369
topics = utils.ensureArray(topics)
370370
messages = utils.ensureArray(messages)
371371

372-
const from = this.peerInfo.id.toB58String()
372+
const from = this.peerId.toB58String()
373373

374374
const buildMessage = (msg, cb) => {
375375
const seqno = utils.randomSeqno()
@@ -448,7 +448,7 @@ class BasicPubSub extends Pubsub {
448448
// Adds all peers using our protocol
449449
let peers = []
450450
peersInTopic.forEach((peer) => {
451-
if (peer.info.protocols.has(GossipSubID)) {
451+
if (peer.protocols.includes(GossipSubID)) {
452452
peers.push(peer)
453453
}
454454
})

‎test/2-nodes.spec.js

+14-14
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ describe('2 nodes', () => {
6767

6868
// Notice peers of connection
6969
const [d0, d1] = ConnectionPair()
70-
onConnect0(nodes[1].peerInfo, d0)
71-
onConnect1(nodes[0].peerInfo, d1)
70+
onConnect0(nodes[1].peerId, d0)
71+
onConnect1(nodes[0].peerId, d1)
7272

7373
expect(nodes[0].peers.size).to.be.eql(1)
7474
expect(nodes[1].peers.size).to.be.eql(1)
@@ -92,7 +92,7 @@ describe('2 nodes', () => {
9292
nodes[1].subscribe(topic)
9393

9494
// await subscription change
95-
const [changedPeerInfo, changedTopics, changedSubs] = await new Promise((resolve) => {
95+
const [changedPeerId, changedTopics, changedSubs] = await new Promise((resolve) => {
9696
nodes[0].once('pubsub:subscription-change', (...args) => resolve(args))
9797
})
9898

@@ -103,7 +103,7 @@ describe('2 nodes', () => {
103103
expectSet(first(nodes[0].peers).topics, [topic])
104104
expectSet(first(nodes[1].peers).topics, [topic])
105105

106-
expect(changedPeerInfo.id.toB58String()).to.equal(first(nodes[0].peers).info.id.toB58String())
106+
expect(changedPeerId.toB58String()).to.equal(first(nodes[0].peers).id.toB58String())
107107
expectSet(changedTopics, [topic])
108108
expect(changedSubs).to.be.eql([{ topicID: topic, subscribe: true }])
109109

@@ -113,8 +113,8 @@ describe('2 nodes', () => {
113113
new Promise((resolve) => nodes[1].once('gossipsub:heartbeat', resolve))
114114
])
115115

116-
expect(first(nodes[0].mesh.get(topic)).info.id.toB58String()).to.equal(first(nodes[0].peers).info.id.toB58String())
117-
expect(first(nodes[1].mesh.get(topic)).info.id.toB58String()).to.equal(first(nodes[1].peers).info.id.toB58String())
116+
expect(first(nodes[0].mesh.get(topic)).id.toB58String()).to.equal(first(nodes[0].peers).id.toB58String())
117+
expect(first(nodes[1].mesh.get(topic)).id.toB58String()).to.equal(first(nodes[1].peers).id.toB58String())
118118
})
119119
})
120120

@@ -151,7 +151,7 @@ describe('2 nodes', () => {
151151
const msg = await promise
152152

153153
expect(msg.data.toString()).to.equal('hey')
154-
expect(msg.from).to.be.eql(nodes[0].peerInfo.id.toB58String())
154+
expect(msg.from).to.be.eql(nodes[0].peerId.toB58String())
155155

156156
nodes[0].removeListener(topic, shouldNotHappen)
157157
})
@@ -165,7 +165,7 @@ describe('2 nodes', () => {
165165
const msg = await promise
166166

167167
expect(msg.data.toString()).to.equal('banana')
168-
expect(msg.from).to.be.eql(nodes[1].peerInfo.id.toB58String())
168+
expect(msg.from).to.be.eql(nodes[1].peerId.toB58String())
169169

170170
nodes[1].removeListener(topic, shouldNotHappen)
171171
})
@@ -179,7 +179,7 @@ describe('2 nodes', () => {
179179

180180
function receivedMsg (msg) {
181181
expect(msg.data.toString()).to.equal('banana')
182-
expect(msg.from).to.be.eql(nodes[1].peerInfo.id.toB58String())
182+
expect(msg.from).to.be.eql(nodes[1].peerId.toB58String())
183183
expect(Buffer.isBuffer(msg.seqno)).to.be.true()
184184
expect(msg.topicIDs).to.be.eql([topic])
185185

@@ -204,7 +204,7 @@ describe('2 nodes', () => {
204204

205205
function receivedMsg (msg) {
206206
expect(msg.data.toString()).to.equal('banana')
207-
expect(msg.from).to.be.eql(nodes[1].peerInfo.id.toB58String())
207+
expect(msg.from).to.be.eql(nodes[1].peerId.toB58String())
208208
expect(Buffer.isBuffer(msg.seqno)).to.be.true()
209209
expect(msg.topicIDs).to.be.eql([topic])
210210

@@ -251,14 +251,14 @@ describe('2 nodes', () => {
251251
nodes[0].unsubscribe(topic)
252252
expect(nodes[0].subscriptions.size).to.equal(0)
253253

254-
const [changedPeerInfo, changedTopics, changedSubs] = await new Promise((resolve) => {
254+
const [changedPeerId, changedTopics, changedSubs] = await new Promise((resolve) => {
255255
nodes[1].once('pubsub:subscription-change', (...args) => resolve(args))
256256
})
257257
await new Promise((resolve) => nodes[1].once('gossipsub:heartbeat', resolve))
258258

259259
expect(nodes[1].peers.size).to.equal(1)
260260
expectSet(first(nodes[1].peers).topics, [])
261-
expect(changedPeerInfo.id.toB58String()).to.equal(first(nodes[1].peers).info.id.toB58String())
261+
expect(changedPeerId.toB58String()).to.equal(first(nodes[1].peers).id.toB58String())
262262
expectSet(changedTopics, [])
263263
expect(changedSubs).to.be.eql([{ topicID: topic, subscribe: false }])
264264
})
@@ -316,8 +316,8 @@ describe('2 nodes', () => {
316316

317317
// Notice peers of connection
318318
const [d0, d1] = ConnectionPair()
319-
onConnect0(nodes[1].peerInfo, d0)
320-
onConnect1(nodes[0].peerInfo, d1)
319+
onConnect0(nodes[1].peerId, d0)
320+
onConnect1(nodes[0].peerId, d1)
321321

322322
await Promise.all([
323323
new Promise((resolve) => nodes[0].once('pubsub:subscription-change', resolve)),

‎test/floodsub.spec.js

+16-16
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ describe('gossipsub fallbacks to floodsub', () => {
5050

5151
// Notice peers of connection
5252
const [d0, d1] = ConnectionPair()
53-
onConnectGs(nodeFs.peerInfo, d0)
54-
onConnectFs(nodeGs.peerInfo, d1)
53+
onConnectGs(nodeFs.peerId, d0)
54+
onConnectFs(nodeGs.peerId, d1)
5555

5656
expect(nodeGs.peers.size).to.equal(1)
5757
expect(nodeFs.peers.size).to.equal(1)
@@ -114,8 +114,8 @@ describe('gossipsub fallbacks to floodsub', () => {
114114

115115
// Notice peers of connection
116116
const [d0, d1] = ConnectionPair()
117-
onConnectGs(nodeFs.peerInfo, d0)
118-
onConnectFs(nodeGs.peerInfo, d1)
117+
onConnectGs(nodeFs.peerId, d0)
118+
onConnectFs(nodeGs.peerId, d1)
119119
})
120120

121121
after(async function () {
@@ -133,7 +133,7 @@ describe('gossipsub fallbacks to floodsub', () => {
133133
nodeFs.subscribe(topic)
134134

135135
// await subscription change
136-
const [changedPeerInfo, changedTopics, changedSubs] = await new Promise((resolve) => {
136+
const [changedPeerId, changedTopics, changedSubs] = await new Promise((resolve) => {
137137
nodeGs.once('pubsub:subscription-change', (...args) => resolve(args))
138138
})
139139
await new Promise((resolve) => setTimeout(resolve, 1000))
@@ -145,7 +145,7 @@ describe('gossipsub fallbacks to floodsub', () => {
145145
expectSet(first(nodeGs.peers).topics, [topic])
146146
expectSet(first(nodeFs.peers).topics, [topic])
147147

148-
expect(changedPeerInfo.id.toB58String()).to.equal(first(nodeGs.peers).info.id.toB58String())
148+
expect(changedPeerId.toB58String()).to.equal(first(nodeGs.peers).id.toB58String())
149149
expectSet(changedTopics, [topic])
150150
expect(changedSubs).to.be.eql([{ topicID: topic, subscribe: true }])
151151
})
@@ -169,8 +169,8 @@ describe('gossipsub fallbacks to floodsub', () => {
169169

170170
// Notice peers of connection
171171
const [d0, d1] = ConnectionPair()
172-
onConnectGs(nodeFs.peerInfo, d0)
173-
onConnectFs(nodeGs.peerInfo, d1)
172+
onConnectGs(nodeFs.peerId, d0)
173+
onConnectFs(nodeGs.peerId, d1)
174174

175175
nodeGs.subscribe(topic)
176176
nodeFs.subscribe(topic)
@@ -199,7 +199,7 @@ describe('gossipsub fallbacks to floodsub', () => {
199199

200200
promise.then((msg) => {
201201
expect(msg.data.toString()).to.equal('hey')
202-
expect(msg.from).to.be.eql(nodeGs.peerInfo.id.toB58String())
202+
expect(msg.from).to.be.eql(nodeGs.peerId.toB58String())
203203

204204
nodeGs.removeListener(topic, shouldNotHappen)
205205
done()
@@ -214,7 +214,7 @@ describe('gossipsub fallbacks to floodsub', () => {
214214
const msg = await promise
215215

216216
expect(msg.data.toString()).to.equal('banana')
217-
expect(msg.from).to.be.eql(nodeFs.peerInfo.id.toB58String())
217+
expect(msg.from).to.be.eql(nodeFs.peerId.toB58String())
218218
})
219219

220220
it('Publish 10 msg to a topic', (done) => {
@@ -229,7 +229,7 @@ describe('gossipsub fallbacks to floodsub', () => {
229229

230230
function receivedMsg (msg) {
231231
expect(msg.data.toString()).to.equal('banana ' + counter)
232-
expect(msg.from).to.be.eql(nodeGs.peerInfo.id.toB58String())
232+
expect(msg.from).to.be.eql(nodeGs.peerId.toB58String())
233233
expect(Buffer.isBuffer(msg.seqno)).to.be.true()
234234
expect(msg.topicIDs).to.be.eql([topic])
235235

@@ -256,7 +256,7 @@ describe('gossipsub fallbacks to floodsub', () => {
256256

257257
function receivedMsg (msg) {
258258
expect(msg.data.toString()).to.equal('banana ' + counter)
259-
expect(msg.from).to.be.eql(nodeGs.peerInfo.id.toB58String())
259+
expect(msg.from).to.be.eql(nodeGs.peerId.toB58String())
260260
expect(Buffer.isBuffer(msg.seqno)).to.be.true()
261261
expect(msg.topicIDs).to.be.eql([topic])
262262

@@ -290,8 +290,8 @@ describe('gossipsub fallbacks to floodsub', () => {
290290

291291
// Notice peers of connection
292292
const [d0, d1] = ConnectionPair()
293-
await onConnectGs(nodeFs.peerInfo, d0)
294-
await onConnectFs(nodeGs.peerInfo, d1)
293+
await onConnectGs(nodeFs.peerId, d0)
294+
await onConnectFs(nodeGs.peerId, d1)
295295

296296
nodeGs.subscribe(topic)
297297
nodeFs.subscribe(topic)
@@ -312,13 +312,13 @@ describe('gossipsub fallbacks to floodsub', () => {
312312
nodeGs.unsubscribe(topic)
313313
expect(nodeGs.subscriptions.size).to.equal(0)
314314

315-
const [changedPeerInfo, changedTopics, changedSubs] = await new Promise((resolve) => {
315+
const [changedPeerId, changedTopics, changedSubs] = await new Promise((resolve) => {
316316
nodeFs.once('floodsub:subscription-change', (...args) => resolve(args))
317317
})
318318

319319
expect(nodeFs.peers.size).to.equal(1)
320320
expectSet(first(nodeFs.peers).topics, [])
321-
expect(changedPeerInfo.id.toB58String()).to.equal(first(nodeFs.peers).info.id.toB58String())
321+
expect(changedPeerId.toB58String()).to.equal(first(nodeFs.peers).id.toB58String())
322322
expectSet(changedTopics, [])
323323
expect(changedSubs).to.be.eql([{ topicID: topic, subscribe: false }])
324324
})

‎test/gossip-incoming.spec.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ describe('gossip incoming', () => {
4747
const msg = await promise
4848

4949
expect(msg.data.toString()).to.equal('hey')
50-
expect(msg.from).to.be.eql(nodes[0].peerInfo.id.toB58String())
50+
expect(msg.from).to.be.eql(nodes[0].peerId.toB58String())
5151

5252
nodes[0].removeListener(topic, shouldNotHappen)
5353
})

‎test/gossip.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ describe('gossip', () => {
5151
.map((call) => call.args[1])
5252
.forEach((peerId) => {
5353
nodeA.mesh.get(topic).forEach((meshPeer) => {
54-
expect(meshPeer.info.id.toB58String()).to.not.equal(peerId)
54+
expect(meshPeer.id.toB58String()).to.not.equal(peerId)
5555
})
5656
})
5757

@@ -75,7 +75,7 @@ describe('gossip', () => {
7575
await new Promise((resolve) => setTimeout(resolve, 500))
7676

7777
const peerB = first(nodeA.mesh.get(topic))
78-
const nodeB = nodes.find((n) => n.peerInfo.id.toB58String() === peerB.info.id.toB58String())
78+
const nodeB = nodes.find((n) => n.peerId.toB58String() === peerB.id.toB58String())
7979

8080
// set spy
8181
sinon.spy(nodeB, 'log')
@@ -90,7 +90,7 @@ describe('gossip', () => {
9090
// expect control message to be sent alongside published message
9191
const call = nodeB.log.getCalls().find((call) => call.args[0] === 'GRAFT: Add mesh link from %s in %s')
9292
expect(call).to.not.equal(undefined)
93-
expect(call.args[1]).to.equal(nodeA.peerInfo.id.toB58String())
93+
expect(call.args[1]).to.equal(nodeA.peerId.toB58String())
9494

9595
// unset spy
9696
nodeB.log.restore()

‎test/heartbeat.spec.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ const { expect } = require('chai')
55

66
const Gossipsub = require('../src')
77
const { GossipSubHeartbeatInterval } = require('../src/constants')
8-
const { createPeerInfo, mockRegistrar } = require('./utils')
8+
const { createPeerId, mockRegistrar } = require('./utils')
99

1010
describe('heartbeat', () => {
1111
let gossipsub
1212

1313
before(async () => {
14-
const peerInfo = await createPeerInfo()
15-
gossipsub = new Gossipsub(peerInfo, mockRegistrar, { emitSelf: true })
14+
const peerId = await createPeerId()
15+
gossipsub = new Gossipsub(peerId, mockRegistrar, { emitSelf: true })
1616
await gossipsub.start()
1717
})
1818

‎test/mesh.spec.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ describe('mesh overlay', () => {
4242

4343
// Notice peers of connection
4444
const [d0, d1] = ConnectionPair()
45-
onConnect0(nodes[n].peerInfo, d0)
46-
onConnectN(nodes[0].peerInfo, d1)
45+
onConnect0(nodes[n].peerId, d0)
46+
onConnectN(nodes[0].peerId, d1)
4747
}
4848

4949
// await mesh rebalancing
@@ -69,8 +69,8 @@ describe('mesh overlay', () => {
6969

7070
// Notice peers of connection
7171
const [d0, d1] = ConnectionPair()
72-
onConnect0(nodes[i].peerInfo, d0)
73-
onConnectN(nodes[0].peerInfo, d1)
72+
onConnect0(nodes[i].peerId, d0)
73+
onConnectN(nodes[0].peerId, d1)
7474
}
7575

7676
await new Promise((resolve) => setTimeout(resolve, 500))

‎test/multiple-nodes.spec.js

+23-23
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ describe('multiple nodes (more than 2)', () => {
4141

4242
// Notice peers of connection
4343
const [d0, d1] = ConnectionPair()
44-
onConnectA(b.peerInfo, d0)
45-
onConnectB(a.peerInfo, d1)
44+
onConnectA(b.peerId, d0)
45+
onConnectB(a.peerId, d1)
4646

4747
const [d2, d3] = ConnectionPair()
48-
onConnectB(c.peerInfo, d2)
49-
onConnectC(b.peerInfo, d3)
48+
onConnectB(c.peerId, d2)
49+
onConnectC(b.peerId, d3)
5050
})
5151

5252
after(() => Promise.all(nodes.map((n) => n.stop())))
@@ -70,9 +70,9 @@ describe('multiple nodes (more than 2)', () => {
7070
expect(b.peers.size).to.equal(2)
7171
expect(c.peers.size).to.equal(1)
7272

73-
const aPeerId = a.peerInfo.id.toB58String()
74-
const bPeerId = b.peerInfo.id.toB58String()
75-
const cPeerId = c.peerInfo.id.toB58String()
73+
const aPeerId = a.peerId.toB58String()
74+
const bPeerId = b.peerId.toB58String()
75+
const cPeerId = c.peerId.toB58String()
7676

7777
expectSet(a.peers.get(bPeerId).topics, [topic])
7878
expectSet(b.peers.get(aPeerId).topics, [topic])
@@ -106,12 +106,12 @@ describe('multiple nodes (more than 2)', () => {
106106

107107
// Notice peers of connection
108108
const [d0, d1] = ConnectionPair()
109-
onConnectA(b.peerInfo, d0)
110-
onConnectB(a.peerInfo, d1)
109+
onConnectA(b.peerId, d0)
110+
onConnectB(a.peerId, d1)
111111

112112
const [d2, d3] = ConnectionPair()
113-
onConnectB(c.peerInfo, d2)
114-
onConnectC(b.peerInfo, d3)
113+
onConnectB(c.peerId, d2)
114+
onConnectC(b.peerId, d3)
115115

116116
a.subscribe(topic)
117117
b.subscribe(topic)
@@ -201,12 +201,12 @@ describe('multiple nodes (more than 2)', () => {
201201

202202
// Notice peers of connection
203203
const [d0, d1] = ConnectionPair()
204-
onConnectA(b.peerInfo, d0)
205-
onConnectB(a.peerInfo, d1)
204+
onConnectA(b.peerId, d0)
205+
onConnectB(a.peerId, d1)
206206

207207
const [d2, d3] = ConnectionPair()
208-
onConnectB(c.peerInfo, d2)
209-
onConnectC(b.peerInfo, d3)
208+
onConnectB(c.peerId, d2)
209+
onConnectC(b.peerId, d3)
210210

211211
a.subscribe(topic)
212212
b.subscribe(topic)
@@ -266,20 +266,20 @@ describe('multiple nodes (more than 2)', () => {
266266

267267
// Notice peers of connection
268268
const [d0, d1] = ConnectionPair()
269-
onConnectA(b.peerInfo, d0)
270-
onConnectB(a.peerInfo, d1)
269+
onConnectA(b.peerId, d0)
270+
onConnectB(a.peerId, d1)
271271

272272
const [d2, d3] = ConnectionPair()
273-
onConnectB(c.peerInfo, d2)
274-
onConnectC(b.peerInfo, d3)
273+
onConnectB(c.peerId, d2)
274+
onConnectC(b.peerId, d3)
275275

276276
const [d4, d5] = ConnectionPair()
277-
onConnectC(d.peerInfo, d4)
278-
onConnectD(c.peerInfo, d5)
277+
onConnectC(d.peerId, d4)
278+
onConnectD(c.peerId, d5)
279279

280280
const [d6, d7] = ConnectionPair()
281-
onConnectD(e.peerInfo, d6)
282-
onConnectE(d.peerInfo, d7)
281+
onConnectD(e.peerId, d6)
282+
onConnectE(d.peerId, d7)
283283

284284
a.subscribe(topic)
285285
b.subscribe(topic)

‎test/pubsub.spec.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const pWaitFor = require('p-wait-for')
1111
const { utils } = require('libp2p-pubsub')
1212
const {
1313
createGossipsub,
14-
createPeerInfo,
14+
createPeerId,
1515
mockRegistrar
1616
} = require('./utils')
1717

@@ -127,7 +127,7 @@ describe('Pubsub', () => {
127127
it('should disconnect peer on stream error', async () => {
128128
sinon.spy(gossipsub, '_onPeerDisconnected')
129129

130-
const peerInfo = await createPeerInfo()
130+
const peerId = await createPeerId()
131131
const mockConn = {
132132
newStream () {
133133
return {
@@ -147,9 +147,9 @@ describe('Pubsub', () => {
147147
}
148148
}
149149

150-
gossipsub._onPeerConnected(peerInfo, mockConn)
150+
gossipsub._onPeerConnected(peerId, mockConn)
151151

152-
await pWaitFor(() => gossipsub._onPeerDisconnected.calledWith(peerInfo), { timeout: 1000 })
152+
await pWaitFor(() => gossipsub._onPeerDisconnected.calledWith(peerId), { timeout: 1000 })
153153
})
154154
})
155155
})

‎test/utils/index.js

+9-14
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,27 @@ const DuplexPair = require('it-pair/duplex')
66
const pTimes = require('p-times')
77

88
const FloodSub = require('libp2p-floodsub')
9-
const { multicodec: floodsubMulticodec } = require('libp2p-floodsub')
109
const PeerId = require('peer-id')
11-
const PeerInfo = require('peer-info')
1210

1311
const GossipSub = require('../../src')
14-
const { GossipSubID } = require('../../src/constants')
1512

1613
exports.first = (map) => map.values().next().value
1714

1815
exports.expectSet = (set, subs) => {
1916
expect(Array.from(set.values())).to.eql(subs)
2017
}
2118

22-
const createPeerInfo = async (protocol = GossipSubID) => {
19+
const createPeerId = async () => {
2320
const peerId = await PeerId.create({ bits: 1024 })
24-
const peerInfo = await PeerInfo.create(peerId)
25-
peerInfo.protocols.add(protocol)
2621

27-
return peerInfo
22+
return peerId
2823
}
2924

30-
exports.createPeerInfo = createPeerInfo
25+
exports.createPeerId = createPeerId
3126

3227
const createGossipsub = async (registrar, shouldStart = false, options) => {
33-
const peerInfo = await createPeerInfo()
34-
const gs = new GossipSub(peerInfo, registrar, options)
28+
const peerId = await createPeerId()
29+
const gs = new GossipSub(peerId, registrar, options)
3530

3631
if (shouldStart) {
3732
await gs.start()
@@ -68,8 +63,8 @@ const connectGossipsubNodes = (nodes, registrarRecords, multicodec) => {
6863

6964
// Notice peers of connection
7065
const [d0, d1] = ConnectionPair()
71-
onConnectI(nodes[j].peerInfo, d0)
72-
onConnectJ(nodes[i].peerInfo, d1)
66+
onConnectI(nodes[j].peerId, d0)
67+
onConnectJ(nodes[i].peerId, d1)
7368
}
7469
}
7570

@@ -88,8 +83,8 @@ const createGossipsubConnectedNodes = async (n, multicodec, options) => {
8883
exports.createGossipsubConnectedNodes = createGossipsubConnectedNodes
8984

9085
const createFloodsubNode = async (registrar, shouldStart = false, options) => {
91-
const peerInfo = await createPeerInfo(floodsubMulticodec)
92-
const fs = new FloodSub(peerInfo, registrar, options)
86+
const peerId = await createPeerId()
87+
const fs = new FloodSub(peerId, registrar, options)
9388

9489
if (shouldStart) {
9590
await fs.start()

0 commit comments

Comments
 (0)
Please sign in to comment.