fix: expose getPublicKey (#1188)

This is used externally by IPFS so expose the method

src/dialer/index.ts

@@ -244,9 +244,6 @@ export class DefaultDialer implements Dialer, Startable {
     const addrs: Multiaddr[] = []
     for (const a of knownAddrs) {
       const resolvedAddrs = await this._resolve(a)
-
-      log('resolved %s to %s', a, resolvedAddrs)
-
       resolvedAddrs.forEach(ra => addrs.push(ra))
     }
 

src/index.ts

@@ -223,6 +223,12 @@ export interface Libp2p extends Startable, EventEmitter<Libp2pEvents> {
    * Sends a request to fetch the value associated with the given key from the given peer.
    */
   fetch: (peer: PeerId | Multiaddr | string, key: string) => Promise<Uint8Array | null>
+
+  /**
+   * Returns the public key for the passed PeerId. If the PeerId is of the 'RSA' type
+   * this may mean searching the DHT if the key is not present in the KeyStore.
+   */
+  getPublicKey: (peer: PeerId, options?: AbortOptions) => Promise<Uint8Array>
 }
 
 export type Libp2pOptions = RecursivePartial<Libp2pInit>

src/libp2p.ts

@@ -412,9 +412,13 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
   /**
    * Get the public key for the given peer id
    */
-  async getPublicKey (peer: PeerId, options: AbortOptions = {}) {
+  async getPublicKey (peer: PeerId, options: AbortOptions = {}): Promise<Uint8Array> {
     log('getPublicKey %p', peer)
 
+    if (peer.publicKey != null) {
+      return peer.publicKey
+    }
+
     const peerInfo = await this.peerStore.get(peer)
 
     if (peerInfo.pubKey != null) {
@@ -437,7 +441,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
 
         await this.peerStore.keyBook.set(peer, event.value)
 
-        return key
+        return key.bytes
       }
     }
 

test/core/get-public-key.spec.ts

@@ -0,0 +1,78 @@
+/* eslint-env mocha */
+
+import { expect } from 'aegir/chai'
+import { WebSockets } from '@libp2p/websockets'
+import { NOISE } from '@chainsafe/libp2p-noise'
+import { createPeerId } from '../utils/creators/peer.js'
+import { createLibp2pNode, Libp2pNode } from '../../src/libp2p.js'
+import type { Libp2pOptions } from '../../src/index.js'
+import sinon from 'sinon'
+import { KadDHT } from '@libp2p/kad-dht'
+
+describe('getPublicKey', () => {
+  let libp2p: Libp2pNode
+
+  beforeEach(async () => {
+    const peerId = await createPeerId()
+    const config: Libp2pOptions = {
+      peerId,
+      transports: [
+        new WebSockets()
+      ],
+      connectionEncryption: [
+        NOISE
+      ],
+      dht: new KadDHT()
+    }
+    libp2p = await createLibp2pNode(config)
+
+    await libp2p.start()
+  })
+
+  afterEach(async () => {
+    await libp2p.stop()
+  })
+
+  it('should extract embedded public key', async () => {
+    const otherPeer = await createPeerId()
+
+    const key = await libp2p.getPublicKey(otherPeer)
+
+    expect(otherPeer.publicKey).to.equalBytes(key)
+  })
+
+  it('should get key from the keystore', async () => {
+    const otherPeer = await createPeerId({ opts: { type: 'rsa' } })
+
+    if (otherPeer.publicKey == null) {
+      throw new Error('Public key was missing')
+    }
+
+    await libp2p.peerStore.keyBook.set(otherPeer, otherPeer.publicKey)
+
+    const key = await libp2p.getPublicKey(otherPeer)
+
+    expect(otherPeer.publicKey).to.equalBytes(key)
+  })
+
+  it('should query the DHT when the key is not in the keystore', async () => {
+    const otherPeer = await createPeerId({ opts: { type: 'rsa' } })
+
+    if (otherPeer.publicKey == null) {
+      throw new Error('Public key was missing')
+    }
+
+    if (libp2p.dht == null) {
+      throw new Error('DHT was not configured')
+    }
+
+    libp2p.dht.get = sinon.stub().returns([{
+      name: 'VALUE',
+      value: otherPeer.publicKey
+    }])
+
+    const key = await libp2p.getPublicKey(otherPeer)
+
+    expect(otherPeer.publicKey).to.equalBytes(key)
+  })
+})