@libp2p/gossipsub 16.0.5 → 16.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/gossipsub",
-  "version": "16.0.5",
+  "version": "16.1.0",
   "description": "A typescript implementation of gossipsub",
   "files": [
     "src",
@@ -81,9 +81,9 @@
   "dependencies": {
     "@libp2p/crypto": "^5.1.21",
     "@libp2p/interface": "^3.2.5",
-    "@libp2p/interface-internal": "^3.1.9",
-    "@libp2p/peer-id": "^6.0.12",
-    "@libp2p/utils": "^7.3.0",
+    "@libp2p/interface-internal": "^3.1.10",
+    "@libp2p/peer-id": "^6.0.13",
+    "@libp2p/utils": "^7.3.1",
     "@multiformats/multiaddr": "^13.0.3",
     "denque": "^2.1.0",
     "it-length-prefixed": "^11.0.1",
@@ -96,11 +96,11 @@
   },
   "devDependencies": {
     "@chainsafe/as-sha256": "^1.2.0",
-    "@libp2p/floodsub": "^11.0.26",
-    "@libp2p/logger": "^6.2.10",
-    "@libp2p/peer-store": "^12.0.24",
+    "@libp2p/floodsub": "^11.0.27",
+    "@libp2p/logger": "^6.2.11",
+    "@libp2p/peer-store": "^12.0.25",
     "@types/benchmark": "^2.1.5",
-    "@types/sinon": "^21.0.1",
+    "@types/sinon": "^22.0.0",
     "abortable-iterator": "^5.1.0",
     "aegir": "^48.1.1",
     "benchmark": "^2.1.4",
@@ -113,7 +113,7 @@
     "p-retry": "^8.0.0",
     "p-wait-for": "^6.0.0",
     "protons": "^9.0.1",
-    "sinon": "^21.0.0",
+    "sinon": "^22.0.0",
     "sinon-ts": "^2.0.0",
     "time-cache": "^0.3.0"
   },

package/src/gossipsub.ts

@@ -972,6 +972,8 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
       // update peer subscriptions
 
       const subscriptions: Array<{ topic: TopicStr, subscribe: boolean }> = []
+      const fromStr = from.toString()
+      const graftTopics: TopicStr[] = []
 
       rpc.subscriptions.forEach((subOpt) => {
         const topic = subOpt.topic
@@ -986,10 +988,21 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
 
           this.handleReceivedSubscription(from, topic, subscribe)
 
+          // graft the peer into the mesh now rather than waiting for the next
+          // heartbeat, so a message published right after subscribing is not dropped
+          if (subscribe && this.graftOnSubscribe(fromStr, topic)) {
+            graftTopics.push(topic)
+          }
+
           subscriptions.push({ topic, subscribe })
         }
       })
 
+      // send one batched GRAFT covering every topic grafted while handling this RPC
+      if (graftTopics.length > 0) {
+        this.sendGraft(fromStr, graftTopics)
+      }
+
       this.safeDispatchEvent<SubscriptionChangeData>('subscription-change', {
         detail: { peerId: from, subscriptions }
       })
@@ -1539,10 +1552,7 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
         // valid graft
       } else {
         this.log('GRAFT: Add mesh link from %s in %s', id, topicID)
-        this.score.graft(id, topicID)
-        peersInMesh.add(id)
-
-        this.metrics?.onAddToMesh(topicID, InclusionReason.Subscribed, 1)
+        this.addToMesh(id, topicID, InclusionReason.Subscribed)
       }
 
       this.safeDispatchEvent<MeshPeer>('gossipsub:graft', { detail: { peerId: id, topic: topicID, direction: 'inbound' } })
@@ -1877,7 +1887,7 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
 
     toAdd.forEach((id) => {
       this.log('JOIN: Add mesh link to %s in %s', id, topic)
-      this.sendGraft(id, topic)
+      this.sendGraft(id, [topic])
 
       // rust-libp2p
       // - peer_score.graft()
@@ -2276,16 +2286,55 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
   /**
    * Sends a GRAFT message to a peer
    */
-  private sendGraft (id: PeerIdStr, topic: string): void {
-    const graft = [
-      {
-        topicID: topic
-      }
-    ]
+  private sendGraft (id: PeerIdStr, topics: string[]): void {
+    const graft = topics.map((topicID) => ({ topicID }))
     const out = createGossipRpc([], { graft })
     this.sendRpc(id, out)
   }
 
+  /**
+   * Add a peer to a topic mesh, updating peer score, mesh membership and metrics.
+   * Sending the GRAFT is left to the caller: the heartbeat and graft-on-subscribe
+   * send one, which dispatches the outbound gossipsub:graft event via sendRpc,
+   * while the inbound GRAFT handler sends none and dispatches its own event.
+   */
+  private addToMesh (id: PeerIdStr, topic: TopicStr, reason: InclusionReason): void {
+    this.score.graft(id, topic)
+    this.mesh.get(topic)?.add(id)
+    this.metrics?.onAddToMesh(topic, reason, 1)
+  }
+
+  /**
+   * When a peer subscribes to a topic we are meshed on, graft it into the mesh
+   * immediately if there is room, instead of waiting for the next heartbeat.
+   * Without this, a message published before the mesh has formed is forwarded to
+   * nobody and silently dropped. Returns true if the peer was grafted, so the
+   * caller can send one batched GRAFT for every topic grafted from an RPC.
+   */
+  private graftOnSubscribe (id: PeerIdStr, topic: TopicStr): boolean {
+    const mesh = this.mesh.get(topic)
+
+    // only fill a mesh we belong to, and only while it is below the low-water mark
+    if (mesh == null || mesh.has(id) || mesh.size >= this.opts.Dlo) {
+      return false
+    }
+
+    // require an outbound stream on one of our protocols, the same check the
+    // heartbeat applies when selecting mesh peers
+    const peerStreams = this.streamsOutbound.get(id)
+    if (peerStreams == null || !this.protocols.includes(peerStreams.protocol)) {
+      return false
+    }
+
+    // do not graft direct peers, negatively scored peers or backed off peers
+    if (this.direct.has(id) || this.score.score(id) < 0 || (this.backoff.get(topic)?.has(id) ?? false)) {
+      return false
+    }
+
+    this.addToMesh(id, topic, InclusionReason.Subscribed)
+    return true
+  }
+
   /**
    * Sends a PRUNE message to a peer
    */
@@ -2752,13 +2801,9 @@ export class GossipSub extends TypedEventEmitter<GossipSubEvents> implements Typ
 
       const graftPeer = (id: PeerIdStr, reason: InclusionReason): void => {
         this.log('HEARTBEAT: Add mesh link to %s in %s', id, topic)
-        // update peer score
-        this.score.graft(id, topic)
-        // add peer to mesh
-        peers.add(id)
+        this.addToMesh(id, topic, reason)
         // when we add a new mesh peer, we don't want to gossip messages to it
         peersToGossip.delete(id)
-        this.metrics?.onAddToMesh(topic, reason, 1)
         // add to tograft
         const topics = tograft.get(id)
         if (topics == null) {