fix: make pubsub message types consistent (#4145)

From field should be a peer id as per the types.

Author: achingbrain

docs/core-api/PUBSUB.md

@@ -32,7 +32,7 @@
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | topic | `String` | The topic name |
-| handler | `Function<(msg) => {}>` | Event handler which will be called with a message object everytime one is received. The `msg` has the format `{from: String, sequenceNumber: bigint, data: Uint8Array, topicIDs: Array<String>}` |
+| handler | `Function<(msg) => {}>` | Event handler which will be called with a message object everytime one is received. The `msg` has the format `{from: PeerId, sequenceNumber: bigint, data: Uint8Array, topicIDs: Array<String>}` |
 
 ### Options
 

packages/interface-ipfs-core/package.json

@@ -66,6 +66,7 @@
     "@ipld/dag-cbor": "^7.0.0",
     "@ipld/dag-pb": "^2.1.3",
     "@libp2p/crypto": "^0.22.9",
+    "@libp2p/interfaces": "^2.0.4",
     "@libp2p/peer-id": "^1.1.10",
     "@libp2p/peer-id-factory": "^1.0.10",
     "@libp2p/websockets": "^1.0.8",

packages/interface-ipfs-core/src/pubsub/subscribe.js

@@ -13,6 +13,7 @@ import { isWebWorker, isNode } from 'ipfs-utils/src/env.js'
 import sinon from 'sinon'
 import defer from 'p-defer'
 import pWaitFor from 'p-wait-for'
+import { isPeerId } from '@libp2p/interfaces/peer-id'
 
 /**
  * @typedef {import('ipfsd-ctl').Factory} Factory
@@ -87,6 +88,7 @@ export function testSubscribe (factory, options) {
         expect(msg).to.have.property('sequenceNumber')
         expect(msg.sequenceNumber).to.be.a('BigInt')
         expect(msg.topic).to.eq(topic)
+        expect(isPeerId(msg.from)).to.be.true()
         expect(msg.from.toString()).to.equal(ipfs1Id.id.toString())
       })
 

packages/ipfs-core/package.json

@@ -75,7 +75,7 @@
     "@libp2p/crypto": "^0.22.9",
     "@libp2p/delegated-content-routing": "^1.0.3",
     "@libp2p/delegated-peer-routing": "^1.0.3",
-    "@libp2p/interfaces": "^2.0.2",
+    "@libp2p/interfaces": "^2.0.4",
     "@libp2p/kad-dht": "^1.0.3",
     "@libp2p/logger": "^1.1.4",
     "@libp2p/mplex": "^1.0.5",

packages/ipfs-grpc-client/package.json

@@ -51,6 +51,7 @@
   "dependencies": {
     "@improbable-eng/grpc-web": "^0.15.0",
     "@libp2p/logger": "^1.1.4",
+    "@libp2p/peer-id": "^1.1.10",
     "change-case": "^4.1.1",
     "err-code": "^3.0.1",
     "ipfs-core-types": "^0.11.1",

packages/ipfs-grpc-client/src/core-api/pubsub/subscribe.js

@@ -3,6 +3,7 @@ import { withTimeoutOption } from 'ipfs-core-utils/with-timeout-option'
 import { subscriptions } from './subscriptions.js'
 import defer from 'p-defer'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import { peerIdFromString } from '@libp2p/peer-id'
 
 /**
  * @param {import('@improbable-eng/grpc-web').grpc} grpc
@@ -37,7 +38,7 @@ export function grpcPubsubSubscribe (grpc, service, opts) {
           } else {
             /** @type {import('@libp2p/interfaces/pubsub').Message} */
             const msg = {
-              from: result.from,
+              from: peerIdFromString(result.from),
               sequenceNumber: result.sequenceNumber == null ? undefined : BigInt(`0x${uint8ArrayToString(result.sequenceNumber, 'base16')}`),
               data: result.data,
               topic: result.topic

packages/ipfs-http-client/src/pubsub/subscribe.js

@@ -2,6 +2,7 @@ import { logger } from '@libp2p/logger'
 import { configure } from '../lib/configure.js'
 import { toUrlSearchParams } from '../lib/to-url-search-params.js'
 import { textToUrlSafeRpc, rpcToText, rpcToBytes, rpcToBigInt } from '../lib/http-rpc-wire-format.js'
+import { peerIdFromString } from '@libp2p/peer-id'
 const log = logger('ipfs-http-client:pubsub:subscribe')
 
 /**
@@ -107,7 +108,7 @@ async function readMessages (response, { onMessage, onEnd, onError }) {
         }
 
         onMessage({
-          from: msg.from,
+          from: peerIdFromString(msg.from),
           data: rpcToBytes(msg.data),
           sequenceNumber: rpcToBigInt(msg.seqno),
           topic: rpcToText(msg.topicIDs[0])

packages/ipfs-http-server/package.json

@@ -45,7 +45,7 @@
     "@hapi/content": "^5.0.2",
     "@hapi/hapi": "^20.0.0",
     "@ipld/dag-pb": "^2.1.3",
-    "@libp2p/interfaces": "^2.0.2",
+    "@libp2p/interfaces": "^2.0.4",
     "@libp2p/logger": "^1.1.4",
     "@libp2p/peer-id": "^1.1.10",
     "any-signal": "^3.0.0",