Skip to content

Forward messages to floodsub peers #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 23, 2022
Merged

Forward messages to floodsub peers #214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20ddde3
Forward messages to floodsub peers
twoeths Mar 23, 2022
47d32d3
Add comments
dapplion Mar 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 32 additions & 14 deletions ts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ export default class Gossipsub extends EventEmitter {
/** Direct peers */
private readonly direct = new Set<PeerIdStr>()

/** Floodsub peers */
private readonly floodsubPeers = new Set<PeerIdStr>()

/** Cache of seen messages */
private readonly seenCache: SimpleTimeCache<void>

Expand Down Expand Up @@ -595,29 +598,33 @@ export default class Gossipsub extends EventEmitter {
* Add a peer to the router
*/
private addPeer(peerId: PeerId, protocol: string, direction: ConnectionDirection): PeerStreams {
let peerStreams = this.peers.get(peerId.toB58String())
const peerIdStr = peerId.toB58String()
let peerStreams = this.peers.get(peerIdStr)

// If peer streams already exists, do nothing
if (peerStreams === undefined) {
// else create a new peer streams
this.log('new peer %s', peerId.toB58String())
this.log('new peer %s', peerIdStr)

peerStreams = new PeerStreams({
id: peerId,
protocol
})

this.peers.set(peerId.toB58String(), peerStreams)
this.peers.set(peerIdStr, peerStreams)
peerStreams.addListener('close', () => this.removePeer(peerId))
}

// Add to peer scoring
this.score.addPeer(peerId.toB58String())
this.score.addPeer(peerIdStr)
if (protocol === constants.FloodsubID) {
this.floodsubPeers.add(peerIdStr)
}
this.metrics?.peersPerProtocol.inc({ protocol }, 1)

// track the connection direction. Don't allow to unset outbound
if (!this.outbound.get(peerId.toB58String())) {
this.outbound.set(peerId.toB58String(), direction === 'outbound')
if (!this.outbound.get(peerIdStr)) {
this.outbound.set(peerIdStr, direction === 'outbound')
}

return peerStreams
Expand Down Expand Up @@ -660,6 +667,8 @@ export default class Gossipsub extends EventEmitter {
peers.delete(id)
}

// Remove from floodsubPeers
this.floodsubPeers.delete(id)
// Remove from gossip mapping
this.gossip.delete(id)
// Remove from control mapping
Expand Down Expand Up @@ -1617,6 +1626,20 @@ export default class Gossipsub extends EventEmitter {
tosend.add(peer)
}
})

// As of Mar 2022, spec + golang-libp2p include this while rust-libp2p does not
// rust-libp2p: https://github.com/libp2p/rust-libp2p/blob/6cc3b4ec52c922bfcf562a29b5805c3150e37c75/protocols/gossipsub/src/behaviour.rs#L2693
// spec: https://github.com/libp2p/specs/blob/10712c55ab309086a52eec7d25f294df4fa96528/pubsub/gossipsub/gossipsub-v1.0.md?plain=1#L361
this.floodsubPeers.forEach((peer) => {
if (
peersInTopic.has(peer) &&
propagationSource !== peer &&
!excludePeers?.has(peer) &&
this.score.score(peer) >= this.opts.scoreThresholds.publishThreshold
) {
tosend.add(peer)
}
})
}

// add mesh peers
Expand Down Expand Up @@ -1673,14 +1696,9 @@ export default class Gossipsub extends EventEmitter {
})

// floodsub peers
peersInTopic.forEach((id) => {
const peerStreams = this.peers.get(id)

if (
peerStreams &&
peerStreams.protocol === constants.FloodsubID &&
this.score.score(id) >= this.opts.scoreThresholds.publishThreshold
) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some notes

  • If there is no floodsub peers, we save a loop through topic peers
  • One difference is the check of peersInTopic.has(id), master has this but rust-libp2p does not have

// Note: if there are no floodsub peers, we save a loop through peersInTopic Map
this.floodsubPeers.forEach((id) => {
if (peersInTopic.has(id) && this.score.score(id) >= this.opts.scoreThresholds.publishThreshold) {
tosend.add(id)
tosendCount.floodsub++
}
Expand Down