@helia/bitswap 1.0.1 → 1.1.0-55b9650

package/src/utils/split-message.ts

@@ -2,6 +2,7 @@
 import { CodeError } from '@libp2p/interface'
 import { encodingLength } from 'uint8-varint'
 import { BitswapMessage, Block, BlockPresence, WantlistEntry } from '../pb/message.js'
+import type { QueuedBitswapMessage } from './bitswap-message.js'
 
 /**
  * https://github.com/ipfs/kubo/issues/4473#issuecomment-350390693
@@ -20,10 +21,10 @@ const MAX_ENCODED_BLOCK_SIZE = MAX_BLOCK_SIZE + 16
  * If a block is encountered that is larger than the max message size an error
  * will be thrown.
  */
-export async function * splitMessage (message: BitswapMessage, maxSize: number): AsyncGenerator<Uint8Array> {
-  const wantListEntries = message.wantlist?.entries ?? []
-  const blockPresences = message.blockPresences
-  const blocks = message.blocks
+export function * splitMessage (message: QueuedBitswapMessage, maxSize: number): Generator<Uint8Array> {
+  const wantListEntries = [...message.wantlist.values()]
+  const blockPresences = [...message.blockPresences.values()]
+  const blocks = [...message.blocks.values()]
 
   let wantListIndex = 0
   let blockPresencesIndex = 0
@@ -33,7 +34,7 @@ export async function * splitMessage (message: BitswapMessage, maxSize: number):
   while (true) {
     const subMessage: Required<BitswapMessage> = {
       wantlist: {
-        full: message.wantlist?.full ?? false,
+        full: message.full ?? false,
         entries: []
       },
       blockPresences: [],

package/src/want-list.ts

@@ -1,10 +1,6 @@
 import { TypedEventEmitter, setMaxListeners } from '@libp2p/interface'
 import { trackedPeerMap } from '@libp2p/peer-collections'
 import { trackedMap } from '@libp2p/utils/tracked-map'
-import all from 'it-all'
-import filter from 'it-filter'
-import map from 'it-map'
-import { pipe } from 'it-pipe'
 import { CID } from 'multiformats/cid'
 import { sha256 } from 'multiformats/hashes/sha2'
 import pDefer from 'p-defer'
@@ -13,11 +9,12 @@ import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { DEFAULT_MESSAGE_SEND_DELAY } from './constants.js'
 import { BlockPresenceType, WantType } from './pb/message.js'
+import { QueuedBitswapMessage } from './utils/bitswap-message.js'
 import vd from './utils/varint-decoder.js'
 import type { BitswapNotifyProgressEvents, MultihashHasherLoader } from './index.js'
 import type { BitswapNetworkWantProgressEvents, Network } from './network.js'
 import type { BitswapMessage } from './pb/message.js'
-import type { ComponentLogger, PeerId, Startable, AbortOptions, Libp2p, TypedEventTarget } from '@libp2p/interface'
+import type { ComponentLogger, PeerId, Startable, AbortOptions, Libp2p, TypedEventTarget, Metrics } from '@libp2p/interface'
 import type { Logger } from '@libp2p/logger'
 import type { PeerMap } from '@libp2p/peer-collections'
 import type { DeferredPromise } from 'p-defer'
@@ -27,6 +24,7 @@ export interface WantListComponents {
   network: Network
   logger: ComponentLogger
   libp2p: Libp2p
+  metrics?: Metrics
 }
 
 export interface WantListInit {
@@ -114,11 +112,11 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
     setMaxListeners(Infinity, this)
     this.peers = trackedPeerMap({
       name: 'helia_bitswap_peers',
-      metrics: components.libp2p.metrics
+      metrics: components.metrics
     })
     this.wants = trackedMap({
       name: 'helia_bitswap_wantlist',
-      metrics: components.libp2p.metrics
+      metrics: components.metrics
     })
     this.network = components.network
     this.sendMessagesDelay = init.sendMessagesDelay ?? DEFAULT_MESSAGE_SEND_DELAY
@@ -218,39 +216,29 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
     await Promise.all(
       [...this.peers.entries()].map(async ([peerId, sentWants]) => {
         const sent = new Set<string>()
-        const message: Partial<BitswapMessage> = {
-          wantlist: {
-            full: false,
-            entries: pipe(
-              this.wants.entries(),
-              (source) => filter(source, ([key, entry]) => {
-                const sentPreviously = sentWants.has(key)
-
-                // don't cancel if we've not sent it to them before
-                if (entry.cancel) {
-                  return sentPreviously
-                }
-
-                // only send if we've not sent it to them before
-                return !sentPreviously
-              }),
-              (source) => map(source, ([key, entry]) => {
-                sent.add(key)
-
-                return {
-                  cid: entry.cid.bytes,
-                  priority: entry.priority,
-                  wantType: entry.wantType,
-                  cancel: entry.cancel,
-                  sendDontHave: entry.sendDontHave
-                }
-              }),
-              (source) => all(source)
-            )
+        const message = new QueuedBitswapMessage()
+
+        for (const [key, entry] of this.wants.entries()) {
+          const sentPreviously = sentWants.has(key)
+
+          // only send if either we've not sent it before, or we haven't sent it
+          // but we're also cancelling the want.
+          if (sentPreviously || entry.cancel) {
+            continue
           }
+
+          sent.add(key)
+
+          message.addWantlistEntry(entry.cid, {
+            cid: entry.cid.bytes,
+            priority: entry.priority,
+            wantType: entry.wantType,
+            cancel: entry.cancel,
+            sendDontHave: entry.sendDontHave
+          })
         }
 
-        if (message.wantlist?.entries.length === 0) {
+        if (message.wantlist.size === 0) {
           return
         }
 
@@ -294,19 +282,17 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
    * Add a CID to the wantlist
    */
   async wantSessionPresence (cid: CID, peerId: PeerId, options: WantOptions = {}): Promise<WantPresenceResult> {
-    // sending WantHave directly to peer
-    await this.network.sendMessage(peerId, {
-      wantlist: {
-        full: false,
-        entries: [{
-          cid: cid.bytes,
-          sendDontHave: true,
-          wantType: WantType.WantHave,
-          priority: 1
-        }]
-      }
+    const message = new QueuedBitswapMessage()
+    message.addWantlistEntry(cid, {
+      cid: cid.bytes,
+      sendDontHave: true,
+      wantType: WantType.WantHave,
+      priority: 1
     })
 
+    // sending WantHave directly to peer
+    await this.network.sendMessage(peerId, message)
+
     // wait for peer response
     const event = await raceEvent<CustomEvent<WantHaveResult | WantDontHaveResult>>(this, 'presence', options.signal, {
       filter: (event) => {
@@ -331,19 +317,17 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
    * Add a CID to the wantlist
    */
   async wantSessionBlock (cid: CID, peerId: PeerId, options: WantOptions = {}): Promise<WantPresenceResult> {
-    // sending WantBlockResult directly to peer
-    await this.network.sendMessage(peerId, {
-      wantlist: {
-        full: false,
-        entries: [{
-          cid: cid.bytes,
-          sendDontHave: true,
-          wantType: WantType.WantBlock,
-          priority: 1
-        }]
-      }
+    const message = new QueuedBitswapMessage()
+    message.addWantlistEntry(cid, {
+      cid: cid.bytes,
+      sendDontHave: true,
+      wantType: WantType.WantBlock,
+      priority: 1
     })
 
+    // sending WantBlockResult directly to peer
+    await this.network.sendMessage(peerId, message)
+
     // wait for peer response
     const event = await raceEvent<CustomEvent<WantPresenceResult>>(this, 'presence', options.signal, {
       filter: (event) => {
@@ -375,7 +359,7 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
    * Invoked when a message is received from a bitswap peer
    */
   private async receiveMessage (sender: PeerId, message: BitswapMessage): Promise<void> {
-    this.log('received message %d from %p with %d blocks', sender, message.blocks.length)
+    this.log('received message from %p with %d blocks', sender, message.blocks.length)
     let blocksCancelled = false
 
     // process blocks
@@ -463,32 +447,27 @@ export class WantList extends TypedEventEmitter<WantListEvents> implements Start
    */
   async peerConnected (peerId: PeerId): Promise<void> {
     const sentWants = new Set<string>()
+    const message = new QueuedBitswapMessage(true)
 
     // new peer, give them the full wantlist
-    const message: Partial<BitswapMessage> = {
-      wantlist: {
-        full: true,
-        entries: pipe(
-          this.wants.entries(),
-          (source) => filter(source, ([key, entry]) => !entry.cancel),
-          (source) => map(source, ([key, entry]) => {
-            sentWants.add(key)
-
-            return {
-              cid: entry.cid.bytes,
-              priority: 1,
-              wantType: WantType.WantBlock,
-              cancel: false,
-              sendDontHave: false
-            }
-          }),
-          (source) => all(source)
-        )
+    for (const [key, entry] of this.wants.entries()) {
+      if (entry.cancel) {
+        continue
       }
+
+      sentWants.add(key)
+
+      message.addWantlistEntry(entry.cid, {
+        cid: entry.cid.bytes,
+        priority: 1,
+        wantType: WantType.WantBlock,
+        cancel: false,
+        sendDontHave: false
+      })
     }
 
     // only send the wantlist if we have something to send
-    if (message.wantlist?.entries.length === 0) {
+    if (message.wantlist.size === 0) {
       this.peers.set(peerId, sentWants)
 
       return

package/dist/typedoc-urls.json

@@ -1,20 +0,0 @@
-{
-  "Bitswap": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.Bitswap.html",
-  ".:Bitswap": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.Bitswap.html",
-  "BitswapComponents": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.BitswapComponents.html",
-  ".:BitswapComponents": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.BitswapComponents.html",
-  "BitswapOptions": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.BitswapOptions.html",
-  ".:BitswapOptions": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.BitswapOptions.html",
-  "MultihashHasherLoader": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.MultihashHasherLoader.html",
-  ".:MultihashHasherLoader": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.MultihashHasherLoader.html",
-  "WantListEntry": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.WantListEntry.html",
-  ".:WantListEntry": "https://ipfs.github.io/helia/interfaces/_helia_bitswap.WantListEntry.html",
-  "BitswapNotifyProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapNotifyProgressEvents.html",
-  ".:BitswapNotifyProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapNotifyProgressEvents.html",
-  "BitswapWantBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapWantBlockProgressEvents.html",
-  ".:BitswapWantBlockProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapWantBlockProgressEvents.html",
-  "BitswapWantProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapWantProgressEvents.html",
-  ".:BitswapWantProgressEvents": "https://ipfs.github.io/helia/types/_helia_bitswap.BitswapWantProgressEvents.html",
-  "createBitswap": "https://ipfs.github.io/helia/functions/_helia_bitswap.createBitswap.html",
-  ".:createBitswap": "https://ipfs.github.io/helia/functions/_helia_bitswap.createBitswap.html"
-}