@libp2p/daemon-client 8.0.6 → 9.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/daemon-client",
-  "version": "8.0.6",
+  "version": "9.0.1",
   "description": "libp2p-daemon client implementation",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-daemon/tree/main/packages/libp2p-daemon-client#readme",
@@ -46,24 +46,25 @@
     "build": "aegir build",
     "pretest": "npm run build",
     "test": "aegir test -t node",
-    "test:node": "aegir test -t node"
+    "test:node": "aegir test -t node",
+    "release": "aegir release"
   },
   "dependencies": {
     "@libp2p/daemon-protocol": "^6.0.0",
-    "@libp2p/interface": "^1.1.2",
-    "@libp2p/logger": "^4.0.5",
-    "@libp2p/peer-id": "^4.0.5",
-    "@libp2p/tcp": "^9.0.13",
+    "@libp2p/interface": "^2.0.0",
+    "@libp2p/logger": "^5.0.0",
+    "@libp2p/peer-id": "^5.0.0",
+    "@libp2p/tcp": "^10.0.0",
     "@multiformats/multiaddr": "^12.1.14",
     "it-protobuf-stream": "^1.1.2",
     "multiformats": "^13.0.1"
   },
   "devDependencies": {
-    "@chainsafe/libp2p-gossipsub": "^13.0.0",
+    "@chainsafe/libp2p-gossipsub": "^14.0.0",
     "@libp2p/daemon-server": "^7.0.0",
-    "@libp2p/interface-compliance-tests": "^5.2.0",
-    "@libp2p/kad-dht": "^12.0.5",
-    "aegir": "^42.2.3",
+    "@libp2p/interface-compliance-tests": "^6.0.0",
+    "@libp2p/kad-dht": "^13.0.0",
+    "aegir": "^44.1.0",
     "it-all": "^3.0.4",
     "it-pipe": "^3.0.1",
     "sinon": "^18.0.0",

package/src/dht.ts

@@ -4,13 +4,14 @@ import {
   DHTRequest,
   DHTResponse
 } from '@libp2p/daemon-protocol'
-import { CodeError } from '@libp2p/interface'
+import { InvalidMessageError, InvalidParametersError, ProtocolError } from '@libp2p/interface'
 import { isPeerId, type PeerId, type PeerInfo } from '@libp2p/interface'
 import { logger } from '@libp2p/logger'
-import { peerIdFromBytes } from '@libp2p/peer-id'
+import { peerIdFromMultihash } from '@libp2p/peer-id'
 import { multiaddr } from '@multiformats/multiaddr'
 import { CID } from 'multiformats/cid'
-import type { DaemonClient } from './index.js'
+import * as Digest from 'multiformats/hashes/digest'
+import { OperationFailedError, type DaemonClient } from './index.js'
 
 const log = logger('libp2p:daemon-client:dht')
 
@@ -26,11 +27,11 @@ export class DHT {
    */
   async put (key: Uint8Array, value: Uint8Array): Promise<void> {
     if (!(key instanceof Uint8Array)) {
-      throw new CodeError('invalid key received', 'ERR_INVALID_KEY')
+      throw new InvalidParametersError('invalid key received')
     }
 
     if (!(value instanceof Uint8Array)) {
-      throw new CodeError('value received is not a Uint8Array', 'ERR_INVALID_VALUE')
+      throw new InvalidParametersError('value received is not a Uint8Array')
     }
 
     const sh = await this.client.send({
@@ -49,7 +50,7 @@ export class DHT {
     await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
-      throw new CodeError(response.error?.msg ?? 'DHT put failed', 'ERR_DHT_PUT_FAILED')
+      throw new ProtocolError(response.error?.msg ?? 'DHT put failed')
     }
   }
 
@@ -58,7 +59,7 @@ export class DHT {
    */
   async get (key: Uint8Array): Promise<Uint8Array> {
     if (!(key instanceof Uint8Array)) {
-      throw new CodeError('invalid key received', 'ERR_INVALID_KEY')
+      throw new InvalidParametersError('invalid key received')
     }
 
     const sh = await this.client.send({
@@ -74,11 +75,11 @@ export class DHT {
     await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
-      throw new CodeError(response.error?.msg ?? 'DHT get failed', 'ERR_DHT_GET_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT get failed')
     }
 
-    if (response.dht == null || response.dht.value == null) {
-      throw new CodeError('Invalid DHT get response', 'ERR_DHT_GET_FAILED')
+    if (response.dht?.value == null) {
+      throw new OperationFailedError('Invalid DHT get response')
     }
 
     return response.dht.value
@@ -89,14 +90,14 @@ export class DHT {
    */
   async findPeer (peerId: PeerId): Promise<PeerInfo> {
     if (!isPeerId(peerId)) {
-      throw new CodeError('invalid peer id received', 'ERR_INVALID_PEER_ID')
+      throw new InvalidParametersError('invalid peer id received')
     }
 
     const sh = await this.client.send({
       type: Request.Type.DHT,
       dht: {
         type: DHTRequest.Type.FIND_PEER,
-        peer: peerId.toBytes()
+        peer: peerId.toMultihash().bytes
       }
     })
 
@@ -105,15 +106,15 @@ export class DHT {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT find peer failed')
     }
 
-    if (response.dht == null || response.dht.peer == null || response.dht.peer.addrs == null) {
-      throw new CodeError('Invalid response', 'ERR_DHT_FIND_PEER_FAILED')
+    if (response.dht?.peer?.addrs == null) {
+      throw new OperationFailedError('Invalid response')
     }
 
     return {
-      id: peerIdFromBytes(response.dht.peer.id),
+      id: peerIdFromMultihash(Digest.decode(response.dht.peer.id)),
       multiaddrs: response.dht.peer.addrs.map((a) => multiaddr(a))
     }
   }
@@ -123,7 +124,7 @@ export class DHT {
    */
   async provide (cid: CID): Promise<void> {
     if (cid == null || CID.asCID(cid) == null) {
-      throw new CodeError('invalid cid received', 'ERR_INVALID_CID')
+      throw new InvalidParametersError('invalid cid received')
     }
 
     const sh = await this.client.send({
@@ -139,7 +140,7 @@ export class DHT {
     await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
-      throw new CodeError(response.error?.msg ?? 'DHT provide failed', 'ERR_DHT_PROVIDE_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT provide failed')
     }
   }
 
@@ -148,7 +149,7 @@ export class DHT {
    */
   async * findProviders (cid: CID, count: number = 1): AsyncIterable<PeerInfo> {
     if (cid == null || CID.asCID(cid) == null) {
-      throw new CodeError('invalid cid received', 'ERR_INVALID_CID')
+      throw new InvalidParametersError('invalid cid received')
     }
 
     const sh = await this.client.send({
@@ -165,7 +166,7 @@ export class DHT {
 
     if (response.type !== Response.Type.OK) {
       await sh.unwrap().close()
-      throw new CodeError(response.error?.msg ?? 'DHT find providers failed', 'ERR_DHT_FIND_PROVIDERS_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT find providers failed')
     }
 
     while (true) {
@@ -178,15 +179,15 @@ export class DHT {
       }
 
       // Stream values
-      if (dhtResponse.type === DHTResponse.Type.VALUE && dhtResponse.peer != null && dhtResponse.peer?.addrs != null) {
+      if (dhtResponse.type === DHTResponse.Type.VALUE && dhtResponse.peer?.addrs != null) {
         yield {
-          id: peerIdFromBytes(dhtResponse.peer.id),
+          id: peerIdFromMultihash(Digest.decode(dhtResponse.peer.id)),
           multiaddrs: dhtResponse.peer.addrs.map((a) => multiaddr(a))
         }
       } else {
         // Unexpected message received
         await sh.unwrap().close()
-        throw new CodeError('unexpected message received', 'ERR_UNEXPECTED_MESSAGE_RECEIVED')
+        throw new ProtocolError('unexpected message received')
       }
     }
   }
@@ -196,7 +197,7 @@ export class DHT {
    */
   async * getClosestPeers (key: Uint8Array): AsyncIterable<PeerInfo> {
     if (!(key instanceof Uint8Array)) {
-      throw new CodeError('invalid key received', 'ERR_INVALID_KEY')
+      throw new InvalidParametersError('invalid key received')
     }
 
     const sh = await this.client.send({
@@ -212,7 +213,7 @@ export class DHT {
 
     if (response.type !== Response.Type.OK) {
       await sh.unwrap().close()
-      throw new CodeError(response.error?.msg ?? 'DHT find providers failed', 'ERR_DHT_FIND_PROVIDERS_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT find providers failed')
     }
 
     while (true) {
@@ -226,7 +227,7 @@ export class DHT {
 
       // Stream values
       if (dhtResponse.type === DHTResponse.Type.VALUE && dhtResponse.value != null) {
-        const peerId = peerIdFromBytes(dhtResponse.value)
+        const peerId = peerIdFromMultihash(Digest.decode(dhtResponse.value))
 
         yield {
           id: peerId,
@@ -235,7 +236,7 @@ export class DHT {
       } else {
         // Unexpected message received
         await sh.unwrap().close()
-        throw new CodeError('unexpected message received', 'ERR_UNEXPECTED_MESSAGE_RECEIVED')
+        throw new InvalidMessageError('unexpected message received')
       }
     }
   }
@@ -245,14 +246,14 @@ export class DHT {
    */
   async getPublicKey (peerId: PeerId): Promise<Uint8Array | undefined> {
     if (!isPeerId(peerId)) {
-      throw new CodeError('invalid peer id received', 'ERR_INVALID_PEER_ID')
+      throw new InvalidParametersError('invalid peer id received')
     }
 
     const sh = await this.client.send({
       type: Request.Type.DHT,
       dht: {
         type: DHTRequest.Type.GET_PUBLIC_KEY,
-        peer: peerId.toBytes()
+        peer: peerId.toMultihash().bytes
       }
     })
 
@@ -261,11 +262,11 @@ export class DHT {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'DHT get public key failed')
     }
 
     if (response.dht == null) {
-      throw new CodeError('Invalid response', 'ERR_DHT_GET_PUBLIC_KEY_FAILED')
+      throw new InvalidMessageError('Invalid response')
     }
 
     return response.dht.value

package/src/index.ts

@@ -1,12 +1,13 @@
 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, isPeerId } from '@libp2p/interface'
+import { InvalidParametersError, isPeerId } from '@libp2p/interface'
 import { defaultLogger, logger } from '@libp2p/logger'
-import { peerIdFromBytes } from '@libp2p/peer-id'
+import { peerIdFromMultihash } from '@libp2p/peer-id'
 import { tcp } from '@libp2p/tcp'
 import { multiaddr, isMultiaddr } from '@multiformats/multiaddr'
 import { pbStream, type ProtobufStream } from 'it-protobuf-stream'
+import * as Digest from 'multiformats/hashes/digest'
 import { DHT } from './dht.js'
 import { Pubsub } from './pubsub.js'
 import type { Stream, PeerId, MultiaddrConnection, PeerInfo, Transport } from '@libp2p/interface'
@@ -15,6 +16,13 @@ import type { CID } from 'multiformats/cid'
 
 const log = logger('libp2p:daemon-client')
 
+export class OperationFailedError extends Error {
+  constructor (message = 'Operation failed') {
+    super(message)
+    this.name = 'OperationFailedError'
+  }
+}
+
 class Client implements DaemonClient {
   private readonly multiaddr: Multiaddr
   public dht: DHT
@@ -66,23 +74,23 @@ class Client implements DaemonClient {
    */
   async connect (peerId: PeerId, addrs: Multiaddr[]): Promise<void> {
     if (!isPeerId(peerId)) {
-      throw new CodeError('invalid peer id received', 'ERR_INVALID_PEER_ID')
+      throw new InvalidParametersError('invalid peer id received')
     }
 
     if (!Array.isArray(addrs)) {
-      throw new CodeError('addrs received are not in an array', 'ERR_INVALID_ADDRS_TYPE')
+      throw new InvalidParametersError('addrs received are not in an array')
     }
 
     addrs.forEach((addr) => {
       if (!isMultiaddr(addr)) {
-        throw new CodeError('received an address that is not a multiaddr', 'ERR_NO_MULTIADDR_RECEIVED')
+        throw new InvalidParametersError('received an address that is not a multiaddr')
       }
     })
 
     const sh = await this.send({
       type: Request.Type.CONNECT,
       connect: {
-        peer: peerId.toBytes(),
+        peer: peerId.toMultihash().bytes,
         addrs: addrs.map((a) => a.bytes)
       }
     })
@@ -91,7 +99,7 @@ class Client implements DaemonClient {
 
     if (response.type !== Response.Type.OK) {
       const errResponse = response.error ?? { msg: 'unspecified' }
-      throw new CodeError(errResponse.msg ?? 'unspecified', 'ERR_CONNECT_FAILED')
+      throw new OperationFailedError(errResponse.msg ?? 'unspecified')
     }
 
     await sh.unwrap().close()
@@ -114,14 +122,14 @@ class Client implements DaemonClient {
     const response = await sh.read(Response)
 
     if (response.type !== Response.Type.OK) {
-      throw new CodeError(response.error?.msg ?? 'Identify failed', 'ERR_IDENTIFY_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'Identify failed')
     }
 
-    if (response.identify == null || response.identify.addrs == null) {
-      throw new CodeError('Invalid response', 'ERR_IDENTIFY_FAILED')
+    if (response.identify?.addrs == null) {
+      throw new OperationFailedError('Invalid response')
     }
 
-    const peerId = peerIdFromBytes(response.identify?.id)
+    const peerId = peerIdFromMultihash(Digest.decode(response.identify?.id))
     const addrs = response.identify.addrs.map((a) => multiaddr(a))
 
     await sh.unwrap().close()
@@ -140,12 +148,12 @@ class Client implements DaemonClient {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'List peers failed')
     }
 
     await sh.unwrap().close()
 
-    return response.peers.map((peer) => peerIdFromBytes(peer.id))
+    return response.peers.map((peer) => peerIdFromMultihash(Digest.decode(peer.id)))
   }
 
   /**
@@ -153,17 +161,17 @@ class Client implements DaemonClient {
    */
   async openStream (peerId: PeerId, protocol: string): Promise<MultiaddrConnection> {
     if (!isPeerId(peerId)) {
-      throw new CodeError('invalid peer id received', 'ERR_INVALID_PEER_ID')
+      throw new InvalidParametersError('invalid peer id received')
     }
 
     if (typeof protocol !== 'string') {
-      throw new CodeError('invalid protocol received', 'ERR_INVALID_PROTOCOL')
+      throw new InvalidParametersError('invalid protocol received')
     }
 
     const sh = await this.send({
       type: Request.Type.STREAM_OPEN,
       streamOpen: {
-        peer: peerId.toBytes(),
+        peer: peerId.toMultihash().bytes,
         proto: [protocol]
       }
     })
@@ -172,7 +180,7 @@ class Client implements DaemonClient {
 
     if (response.type !== Response.Type.OK) {
       await sh.unwrap().close()
-      throw new CodeError(response.error?.msg ?? 'Open stream failed', 'ERR_OPEN_STREAM_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'Open stream failed')
     }
 
     return sh.unwrap()
@@ -183,7 +191,7 @@ class Client implements DaemonClient {
    */
   async registerStreamHandler (protocol: string, handler: StreamHandlerFunction): Promise<void> {
     if (typeof protocol !== 'string') {
-      throw new CodeError('invalid protocol received', 'ERR_INVALID_PROTOCOL')
+      throw new InvalidParametersError('invalid protocol received')
     }
 
     // open a tcp port, pipe any data from it to the handler function
@@ -199,18 +207,21 @@ class Client implements DaemonClient {
             const message = await sh.read()
 
             if (message == null) {
-              throw new CodeError('Could not read open stream response', 'ERR_OPEN_STREAM_FAILED')
+              throw new OperationFailedError('Could not read open stream response')
             }
 
             const response = StreamInfo.decode(message)
 
             if (response.proto !== protocol) {
-              throw new CodeError('Incorrect protocol', 'ERR_OPEN_STREAM_FAILED')
+              throw new OperationFailedError('Incorrect protocol')
             }
 
             // @ts-expect-error because we are using a passthrough upgrader, this is a MultiaddrConnection
             await handler(sh.rest())
           })
+          .catch(err => {
+            connection.abort(err)
+          })
           .finally(() => {
             connection.close()
               .catch(err => {
@@ -227,7 +238,7 @@ class Client implements DaemonClient {
     const address = listener.getAddrs()[0]
 
     if (address == null) {
-      throw new CodeError('Could not listen on port', 'ERR_REGISTER_STREAM_HANDLER_FAILED')
+      throw new OperationFailedError('Could not listen on port')
     }
 
     const sh = await this.send({
@@ -243,7 +254,7 @@ class Client implements DaemonClient {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'Register stream handler failed')
     }
   }
 }

package/src/pubsub.ts

@@ -4,9 +4,10 @@ import {
   PSRequest,
   PSMessage
 } from '@libp2p/daemon-protocol'
-import { CodeError } from '@libp2p/interface'
-import { peerIdFromBytes } from '@libp2p/peer-id'
-import type { DaemonClient, Subscription } from './index.js'
+import { InvalidParametersError } from '@libp2p/interface'
+import { peerIdFromMultihash } from '@libp2p/peer-id'
+import * as Digest from 'multiformats/hashes/digest'
+import { OperationFailedError, type DaemonClient, type Subscription } from './index.js'
 import type { PeerId } from '@libp2p/interface'
 
 export class Pubsub {
@@ -34,11 +35,11 @@ export class Pubsub {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'Pubsub get topics failed')
     }
 
-    if (response.pubsub == null || response.pubsub.topics == null) {
-      throw new CodeError('Invalid response', 'ERR_PUBSUB_GET_TOPICS_FAILED')
+    if (response.pubsub?.topics == null) {
+      throw new OperationFailedError('Invalid response')
     }
 
     return response.pubsub.topics
@@ -49,11 +50,11 @@ export class Pubsub {
    */
   async publish (topic: string, data: Uint8Array): Promise<void> {
     if (typeof topic !== 'string') {
-      throw new CodeError('invalid topic received', 'ERR_INVALID_TOPIC')
+      throw new InvalidParametersError('invalid topic received')
     }
 
     if (!(data instanceof Uint8Array)) {
-      throw new CodeError('data received is not a Uint8Array', 'ERR_INVALID_DATA')
+      throw new InvalidParametersError('data received is not a Uint8Array')
     }
 
     const sh = await this.client.send({
@@ -70,7 +71,7 @@ export class Pubsub {
     await sh.unwrap().close()
 
     if (response.type !== Response.Type.OK) {
-      throw new CodeError(response.error?.msg ?? 'Pubsub publish failed', 'ERR_PUBSUB_PUBLISH_FAILED')
+      throw new OperationFailedError(response.error?.msg ?? 'Pubsub publish failed')
     }
   }
 
@@ -79,7 +80,7 @@ export class Pubsub {
    */
   async subscribe (topic: string): Promise<Subscription> {
     if (typeof topic !== 'string') {
-      throw new CodeError('invalid topic received', 'ERR_INVALID_TOPIC')
+      throw new InvalidParametersError('invalid topic received')
     }
 
     const sh = await this.client.send({
@@ -93,7 +94,7 @@ export class Pubsub {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'Pubsub publish failed')
     }
 
     let subscribed = true
@@ -115,7 +116,7 @@ export class Pubsub {
 
   async getSubscribers (topic: string): Promise<PeerId[]> {
     if (typeof topic !== 'string') {
-      throw new CodeError('invalid topic received', 'ERR_INVALID_TOPIC')
+      throw new InvalidParametersError('invalid topic received')
     }
 
     const sh = await this.client.send({
@@ -131,13 +132,13 @@ export class Pubsub {
     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')
+      throw new OperationFailedError(response.error?.msg ?? 'Pubsub get subscribers failed')
     }
 
-    if (response.pubsub == null || response.pubsub.topics == null) {
-      throw new CodeError('Invalid response', 'ERR_PUBSUB_GET_SUBSCRIBERS_FAILED')
+    if (response.pubsub?.topics == null) {
+      throw new OperationFailedError('Invalid response')
     }
 
-    return response.pubsub.peerIDs.map(buf => peerIdFromBytes(buf))
+    return response.pubsub.peerIDs.map(buf => peerIdFromMultihash(Digest.decode(buf)))
   }
 }