@libp2p/daemon-client 7.0.3 → 8.0.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@libp2p/daemon-client",
-  "version": "7.0.3",
+  "version": "8.0.0",
   "description": "libp2p-daemon client implementation",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-daemon/tree/master/packages/libp2p-daemon-client#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-daemon/tree/main/packages/libp2p-daemon-client#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/libp2p/js-libp2p-daemon.git"
@@ -11,6 +11,10 @@
   "bugs": {
     "url": "https://github.com/libp2p/js-libp2p-daemon/issues"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "keywords": [
     "libp2p"
   ],
@@ -37,7 +41,7 @@
   },
   "release": {
     "branches": [
-      "master"
+      "main"
     ],
     "plugins": [
       [
@@ -132,20 +136,20 @@
   },
   "dependencies": {
     "@chainsafe/libp2p-gossipsub": "^10.0.0",
-    "@libp2p/daemon-protocol": "^5.0.0",
-    "@libp2p/interface": "^0.1.0",
-    "@libp2p/kad-dht": "^10.0.0",
-    "@libp2p/logger": "^3.0.0",
-    "@libp2p/peer-id": "^3.0.0",
-    "@libp2p/tcp": "^8.0.0",
+    "@libp2p/daemon-protocol": "^6.0.0",
+    "@libp2p/interface": "^1.0.0",
+    "@libp2p/kad-dht": "^11.0.0",
+    "@libp2p/logger": "^4.0.0",
+    "@libp2p/peer-id": "^4.0.0",
+    "@libp2p/tcp": "^9.0.0",
     "@multiformats/multiaddr": "^12.1.3",
-    "it-stream-types": "^2.0.1",
+    "it-protobuf-stream": "^1.1.1",
     "multiformats": "^12.0.1",
     "uint8arraylist": "^2.4.3"
   },
   "devDependencies": {
-    "@libp2p/daemon-server": "^6.0.0",
-    "@libp2p/interface-compliance-tests": "^4.0.0",
+    "@libp2p/daemon-server": "^7.0.0",
+    "@libp2p/interface-compliance-tests": "^5.0.0",
     "aegir": "^41.1.6",
     "it-all": "^3.0.1",
     "it-pipe": "^3.0.1",

package/src/dht.ts

@@ -4,13 +4,15 @@ import {
   DHTRequest,
   DHTResponse
 } from '@libp2p/daemon-protocol'
-import { CodeError } from '@libp2p/interface/errors'
-import { isPeerId, type PeerId } from '@libp2p/interface/peer-id'
+import { CodeError } from '@libp2p/interface'
+import { isPeerId, type PeerId, type PeerInfo } from '@libp2p/interface'
+import { logger } from '@libp2p/logger'
 import { peerIdFromBytes } from '@libp2p/peer-id'
 import { multiaddr } from '@multiformats/multiaddr'
 import { CID } from 'multiformats/cid'
 import type { DaemonClient } from './index.js'
-import type { PeerInfo } from '@libp2p/interface/peer-info'
+
+const log = logger('libp2p:daemon-client:dht')
 
 export class DHT {
   private readonly client: DaemonClient
@@ -40,15 +42,11 @@ export class DHT {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
+    const response = await sh.read(Response)
 
-    const response = Response.decode(message)
+    log('read', response)
 
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'DHT put failed', 'ERR_DHT_PUT_FAILED')
@@ -71,15 +69,9 @@ export class DHT {
       }
     })
 
-    const message = await sh.read()
+    const response = await sh.read(Response)
 
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
-
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'DHT get failed', 'ERR_DHT_GET_FAILED')
@@ -108,15 +100,9 @@ export class DHT {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'DHT find peer failed', 'ERR_DHT_FIND_PEER_FAILED')
@@ -128,8 +114,7 @@ export class DHT {
 
     return {
       id: peerIdFromBytes(response.dht.peer.id),
-      multiaddrs: response.dht.peer.addrs.map((a) => multiaddr(a)),
-      protocols: []
+      multiaddrs: response.dht.peer.addrs.map((a) => multiaddr(a))
     }
   }
 
@@ -149,15 +134,9 @@ export class DHT {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
+    const response = await sh.read(Response)
 
-    const response = Response.decode(message)
-
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'DHT provide failed', 'ERR_DHT_PROVIDE_FAILED')
@@ -181,45 +160,32 @@ export class DHT {
       }
     })
 
-    let message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
     // stream begin message
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
-      await sh.close()
+      await sh.unwrap().close()
       throw new CodeError(response.error?.msg ?? 'DHT find providers failed', 'ERR_DHT_FIND_PROVIDERS_FAILED')
     }
 
     while (true) {
-      message = await sh.read()
-
-      if (message == null) {
-        throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-      }
-
-      const response = DHTResponse.decode(message)
+      const dhtResponse = await sh.read(DHTResponse)
 
       // Stream end
-      if (response.type === DHTResponse.Type.END) {
-        await sh.close()
+      if (dhtResponse.type === DHTResponse.Type.END) {
+        await sh.unwrap().close()
         return
       }
 
       // Stream values
-      if (response.type === DHTResponse.Type.VALUE && response.peer != null && response.peer?.addrs != null) {
+      if (dhtResponse.type === DHTResponse.Type.VALUE && dhtResponse.peer != null && dhtResponse.peer?.addrs != null) {
         yield {
-          id: peerIdFromBytes(response.peer.id),
-          multiaddrs: response.peer.addrs.map((a) => multiaddr(a)),
-          protocols: []
+          id: peerIdFromBytes(dhtResponse.peer.id),
+          multiaddrs: dhtResponse.peer.addrs.map((a) => multiaddr(a))
         }
       } else {
         // Unexpected message received
-        await sh.close()
+        await sh.unwrap().close()
         throw new CodeError('unexpected message received', 'ERR_UNEXPECTED_MESSAGE_RECEIVED')
       }
     }
@@ -242,46 +208,33 @@ export class DHT {
     })
 
     // stream begin message
-    let message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
-      await sh.close()
+      await sh.unwrap().close()
       throw new CodeError(response.error?.msg ?? 'DHT find providers failed', 'ERR_DHT_FIND_PROVIDERS_FAILED')
     }
 
     while (true) {
-      message = await sh.read()
-
-      if (message == null) {
-        throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-      }
-
-      const response = DHTResponse.decode(message)
+      const dhtResponse = await sh.read(DHTResponse)
 
       // Stream end
-      if (response.type === DHTResponse.Type.END) {
-        await sh.close()
+      if (dhtResponse.type === DHTResponse.Type.END) {
+        await sh.unwrap().close()
         return
       }
 
       // Stream values
-      if (response.type === DHTResponse.Type.VALUE && response.value != null) {
-        const peerId = peerIdFromBytes(response.value)
+      if (dhtResponse.type === DHTResponse.Type.VALUE && dhtResponse.value != null) {
+        const peerId = peerIdFromBytes(dhtResponse.value)
 
         yield {
           id: peerId,
-          multiaddrs: [],
-          protocols: []
+          multiaddrs: []
         }
       } else {
         // Unexpected message received
-        await sh.close()
+        await sh.unwrap().close()
         throw new CodeError('unexpected message received', 'ERR_UNEXPECTED_MESSAGE_RECEIVED')
       }
     }
@@ -303,15 +256,9 @@ export class DHT {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'DHT get public key failed', 'ERR_DHT_GET_PUBLIC_KEY_FAILED')

package/src/index.ts

@@ -1,21 +1,17 @@
 import { type PSMessage, Request, Response, StreamInfo } from '@libp2p/daemon-protocol'
 import { StreamHandler } from '@libp2p/daemon-protocol/stream-handler'
 import { passThroughUpgrader } from '@libp2p/daemon-protocol/upgrader'
-import { CodeError } from '@libp2p/interface/errors'
-import { isPeerId, type PeerId } from '@libp2p/interface/peer-id'
+import { CodeError, isPeerId } from '@libp2p/interface'
 import { defaultLogger, logger } from '@libp2p/logger'
 import { peerIdFromBytes } from '@libp2p/peer-id'
 import { tcp } from '@libp2p/tcp'
 import { multiaddr, isMultiaddr } from '@multiformats/multiaddr'
+import { pbStream, type ProtobufStream } from 'it-protobuf-stream'
 import { DHT } from './dht.js'
 import { Pubsub } from './pubsub.js'
-import type { MultiaddrConnection } from '@libp2p/interface/connection'
-import type { PeerInfo } from '@libp2p/interface/peer-info'
-import type { Transport } from '@libp2p/interface/transport'
+import type { Stream, PeerId, MultiaddrConnection, PeerInfo, Transport } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Duplex, Source } from 'it-stream-types'
 import type { CID } from 'multiformats/cid'
-import type { Uint8ArrayList } from 'uint8arraylist'
 
 const log = logger('libp2p:daemon-client')
 
@@ -28,7 +24,6 @@ class Client implements DaemonClient {
   constructor (addr: Multiaddr) {
     this.multiaddr = addr
     this.tcp = tcp()({
-      // @ts-expect-error this field will be present post v1
       logger: defaultLogger()
     })
     this.dht = new DHT(this)
@@ -54,15 +49,16 @@ class Client implements DaemonClient {
    * Sends the request to the daemon and returns a stream. This
    * should only be used when sending daemon requests.
    */
-  async send (request: Request): Promise<StreamHandler> {
+  async send (request: Request): Promise<ProtobufStream<MultiaddrConnection>> {
     const maConn = await this.connectDaemon()
 
     const subtype = request.pubsub?.type ?? request.dht?.type ?? request.peerStore?.type ?? ''
     log('send', request.type, subtype)
 
-    const streamHandler = new StreamHandler({ stream: maConn })
-    streamHandler.write(Request.encode(request))
-    return streamHandler
+    const pb = pbStream(maConn)
+    await pb.write(request, Request)
+
+    return pb
   }
 
   /**
@@ -91,18 +87,14 @@ class Client implements DaemonClient {
       }
     })
 
-    const message = await sh.read()
-    if (message == null) {
-      throw new CodeError('unspecified', 'ERR_CONNECT_FAILED')
-    }
+    const response = await sh.read(Response)
 
-    const response = Response.decode(message)
     if (response.type !== Response.Type.OK) {
       const errResponse = response.error ?? { msg: 'unspecified' }
       throw new CodeError(errResponse.msg ?? 'unspecified', 'ERR_CONNECT_FAILED')
     }
 
-    await sh.close()
+    await sh.unwrap().close()
   }
 
   /**
@@ -119,13 +111,7 @@ class Client implements DaemonClient {
       type: Request.Type.IDENTIFY
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Identify failed', 'ERR_IDENTIFY_FAILED')
@@ -138,7 +124,7 @@ class Client implements DaemonClient {
     const peerId = peerIdFromBytes(response.identify?.id)
     const addrs = response.identify.addrs.map((a) => multiaddr(a))
 
-    await sh.close()
+    await sh.unwrap().close()
 
     return ({ peerId, addrs })
   }
@@ -151,19 +137,13 @@ class Client implements DaemonClient {
       type: Request.Type.LIST_PEERS
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'List peers failed', 'ERR_LIST_PEERS_FAILED')
     }
 
-    await sh.close()
+    await sh.unwrap().close()
 
     return response.peers.map((peer) => peerIdFromBytes(peer.id))
   }
@@ -171,7 +151,7 @@ class Client implements DaemonClient {
   /**
    * Initiate an outbound stream to a peer on one of a set of protocols.
    */
-  async openStream (peerId: PeerId, protocol: string): Promise<Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>, Source<Uint8Array>, Promise<void>>> {
+  async openStream (peerId: PeerId, protocol: string): Promise<MultiaddrConnection> {
     if (!isPeerId(peerId)) {
       throw new CodeError('invalid peer id received', 'ERR_INVALID_PEER_ID')
     }
@@ -188,20 +168,14 @@ class Client implements DaemonClient {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
-      await sh.close()
+      await sh.unwrap().close()
       throw new CodeError(response.error?.msg ?? 'Open stream failed', 'ERR_OPEN_STREAM_FAILED')
     }
 
-    return sh.rest()
+    return sh.unwrap()
   }
 
   /**
@@ -215,11 +189,11 @@ class Client implements DaemonClient {
     // open a tcp port, pipe any data from it to the handler function
     const listener = this.tcp.createListener({
       upgrader: passThroughUpgrader,
-      handler: (connection) => {
+      // @ts-expect-error because we are using a passthrough upgrader, this is a MultiaddrConnection
+      handler: (connection: MultiaddrConnection) => {
         Promise.resolve()
           .then(async () => {
             const sh = new StreamHandler({
-              // @ts-expect-error because we are using a passthrough upgrader, this is a MultiaddrConnection
               stream: connection
             })
             const message = await sh.read()
@@ -234,6 +208,7 @@ class Client implements DaemonClient {
               throw new CodeError('Incorrect protocol', 'ERR_OPEN_STREAM_FAILED')
             }
 
+            // @ts-expect-error because we are using a passthrough upgrader, this is a MultiaddrConnection
             await handler(sh.rest())
           })
           .finally(() => {
@@ -263,15 +238,9 @@ class Client implements DaemonClient {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Register stream handler failed', 'ERR_REGISTER_STREAM_HANDLER_FAILED')
@@ -285,7 +254,7 @@ export interface IdentifyResult {
 }
 
 export interface StreamHandlerFunction {
-  (stream: Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>, Source<Uint8Array>, Promise<void>>): Promise<void>
+  (stream: Stream): Promise<void>
 }
 
 export interface DHTClient {
@@ -316,8 +285,8 @@ export interface DaemonClient {
   dht: DHTClient
   pubsub: PubSubClient
 
-  send(request: Request): Promise<StreamHandler>
-  openStream(peerId: PeerId, protocol: string): Promise<Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>, Source<Uint8Array>, Promise<void>>>
+  send(request: Request): Promise<ProtobufStream<MultiaddrConnection>>
+  openStream(peerId: PeerId, protocol: string): Promise<MultiaddrConnection>
   registerStreamHandler(protocol: string, handler: StreamHandlerFunction): Promise<void>
 }
 

package/src/pubsub.ts

@@ -4,10 +4,10 @@ import {
   PSRequest,
   PSMessage
 } from '@libp2p/daemon-protocol'
-import { CodeError } from '@libp2p/interface/errors'
+import { CodeError } from '@libp2p/interface'
 import { peerIdFromBytes } from '@libp2p/peer-id'
 import type { DaemonClient, Subscription } from './index.js'
-import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerId } from '@libp2p/interface'
 
 export class Pubsub {
   private readonly client: DaemonClient
@@ -29,15 +29,9 @@ export class Pubsub {
       }
     })
 
-    const message = await sh.read()
+    const response = await sh.read(Response)
 
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
-
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Pubsub get topics failed', 'ERR_PUBSUB_GET_TOPICS_FAILED')
@@ -71,15 +65,9 @@ export class Pubsub {
       }
     })
 
-    const message = await sh.read()
+    const response = await sh.read(Response)
 
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
-
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Pubsub publish failed', 'ERR_PUBSUB_PUBLISH_FAILED')
@@ -102,13 +90,7 @@ export class Pubsub {
       }
     })
 
-    let message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Pubsub publish failed', 'ERR_PUBSUB_PUBLISH_FAILED')
@@ -119,18 +101,12 @@ export class Pubsub {
     const subscription: Subscription = {
       async * messages () {
         while (subscribed) { // eslint-disable-line no-unmodified-loop-condition
-          message = await sh.read()
-
-          if (message == null) {
-            throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-          }
-
-          yield PSMessage.decode(message)
+          yield await sh.read(PSMessage)
         }
       },
       async cancel () {
         subscribed = false
-        await sh.close()
+        await sh.unwrap().close()
       }
     }
 
@@ -150,15 +126,9 @@ export class Pubsub {
       }
     })
 
-    const message = await sh.read()
-
-    if (message == null) {
-      throw new CodeError('Empty response from remote', 'ERR_EMPTY_RESPONSE')
-    }
-
-    const response = Response.decode(message)
+    const response = await sh.read(Response)
 
-    await sh.close()
+    await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
       throw new CodeError(response.error?.msg ?? 'Pubsub get subscribers failed', 'ERR_PUBSUB_GET_SUBSCRIBERS_FAILED')