@libp2p/peer-store 1.0.4 → 1.0.7

package/src/metadata-book.ts

@@ -5,7 +5,7 @@ import { peerIdFromPeerId } from '@libp2p/peer-id'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { CustomEvent } from '@libp2p/interfaces'
 import type { Store } from './store.js'
-import type { PeerStore, MetadataBook } from '@libp2p/interfaces/src/peer-store'
+import type { PeerStore, MetadataBook, PeerMetadataChangeData, Peer } from '@libp2p/interfaces/peer-store'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:metadata-book')
@@ -31,9 +31,9 @@ export class PeerStoreMetadataBook implements MetadataBook {
   async get (peerId: PeerId) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('get await read lock')
+    log.trace('get await read lock')
     const release = await this.store.lock.readLock()
-    log('get got read lock')
+    log.trace('get got read lock')
 
     try {
       const peer = await this.store.load(peerId)
@@ -44,7 +44,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
         throw err
       }
     } finally {
-      log('get release read lock')
+      log.trace('get release read lock')
       release()
     }
 
@@ -57,9 +57,9 @@ export class PeerStoreMetadataBook implements MetadataBook {
   async getValue (peerId: PeerId, key: string) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('getValue await read lock')
+    log.trace('getValue await read lock')
     const release = await this.store.lock.readLock()
-    log('getValue got read lock')
+    log.trace('getValue got read lock')
 
     try {
       const peer = await this.store.load(peerId)
@@ -70,7 +70,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
         throw err
       }
     } finally {
-      log('getValue release write lock')
+      log.trace('getValue release write lock')
       release()
     }
   }
@@ -83,21 +83,35 @@ export class PeerStoreMetadataBook implements MetadataBook {
       throw errcode(new Error('valid metadata must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    log('set await write lock')
+    log.trace('set await write lock')
     const release = await this.store.lock.writeLock()
-    log('set got write lock')
+    log.trace('set got write lock')
+
+    let peer: Peer | undefined
 
     try {
+      try {
+        peer = await this.store.load(peerId)
+      } catch (err: any) {
+        if (err.code !== codes.ERR_NOT_FOUND) {
+          throw err
+        }
+      }
+
       await this.store.mergeOrCreate(peerId, {
         metadata
       })
     } finally {
-      log('set release write lock')
+      log.trace('set release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, metadata }
+    this.dispatchEvent(new CustomEvent<PeerMetadataChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        metadata,
+        oldMetadata: peer == null ? new Map() : peer.metadata
+      }
     }))
   }
 
@@ -112,16 +126,17 @@ export class PeerStoreMetadataBook implements MetadataBook {
       throw errcode(new Error('valid key and value must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    log('setValue await write lock')
+    log.trace('setValue await write lock')
     const release = await this.store.lock.writeLock()
-    log('setValue got write lock')
+    log.trace('setValue got write lock')
 
+    let peer: Peer | undefined
     let updatedPeer
 
     try {
       try {
-        const existingPeer = await this.store.load(peerId)
-        const existingValue = existingPeer.metadata.get(key)
+        peer = await this.store.load(peerId)
+        const existingValue = peer.metadata.get(key)
 
         if (existingValue != null && uint8ArrayEquals(value, existingValue)) {
           return
@@ -136,40 +151,54 @@ export class PeerStoreMetadataBook implements MetadataBook {
         metadata: new Map([[key, value]])
       })
     } finally {
-      log('setValue release write lock')
+      log.trace('setValue release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, metadata: updatedPeer.metadata }
+    this.dispatchEvent(new CustomEvent<PeerMetadataChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        metadata: updatedPeer.metadata,
+        oldMetadata: peer == null ? new Map() : peer.metadata
+      }
     }))
   }
 
   async delete (peerId: PeerId) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('delete await write lock')
+    log.trace('delete await write lock')
     const release = await this.store.lock.writeLock()
-    log('delete got write lock')
+    log.trace('delete got write lock')
 
-    let has
+    let peer: Peer | undefined
 
     try {
-      has = await this.store.has(peerId)
+      try {
+        peer = await this.store.load(peerId)
+      } catch (err: any) {
+        if (err.code !== codes.ERR_NOT_FOUND) {
+          throw err
+        }
+      }
 
-      if (has) {
+      if (peer != null) {
         await this.store.patch(peerId, {
           metadata: new Map()
         })
       }
     } finally {
-      log('delete release write lock')
+      log.trace('delete release write lock')
       release()
     }
 
-    if (has) {
-      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-        detail: { peerId, metadata: new Map() }
+    if (peer != null) {
+      this.dispatchEvent(new CustomEvent<PeerMetadataChangeData>(EVENT_NAME, {
+        detail: {
+          peerId,
+          metadata: new Map(),
+          oldMetadata: peer.metadata
+        }
       }))
     }
   }
@@ -177,14 +206,15 @@ export class PeerStoreMetadataBook implements MetadataBook {
   async deleteValue (peerId: PeerId, key: string) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('deleteValue await write lock')
+    log.trace('deleteValue await write lock')
     const release = await this.store.lock.writeLock()
-    log('deleteValue got write lock')
+    log.trace('deleteValue got write lock')
 
     let metadata
+    let peer: Peer | undefined
 
     try {
-      const peer = await this.store.load(peerId)
+      peer = await this.store.load(peerId)
       metadata = peer.metadata
 
       metadata.delete(key)
@@ -197,13 +227,17 @@ export class PeerStoreMetadataBook implements MetadataBook {
         throw err
       }
     } finally {
-      log('deleteValue release write lock')
+      log.trace('deleteValue release write lock')
       release()
     }
 
     if (metadata != null) {
-      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-        detail: { peerId, metadata }
+      this.dispatchEvent(new CustomEvent<PeerMetadataChangeData>(EVENT_NAME, {
+        detail: {
+          peerId,
+          metadata,
+          oldMetadata: peer == null ? new Map() : peer.metadata
+        }
       }))
     }
   }

package/src/proto-book.ts

@@ -2,10 +2,9 @@ import { logger } from '@libp2p/logger'
 import errcode from 'err-code'
 import { codes } from './errors.js'
 import { peerIdFromPeerId } from '@libp2p/peer-id'
-import { base58btc } from 'multiformats/bases/base58'
 import { CustomEvent } from '@libp2p/interfaces'
 import type { Store } from './store.js'
-import type { PeerStore, ProtoBook } from '@libp2p/interfaces/src/peer-store'
+import type { Peer, PeerProtocolsChangeData, PeerStore, ProtoBook } from '@libp2p/interfaces/peer-store'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:proto-book')
@@ -26,9 +25,9 @@ export class PeerStoreProtoBook implements ProtoBook {
   }
 
   async get (peerId: PeerId) {
-    log('get wait for read lock')
+    log.trace('get wait for read lock')
     const release = await this.store.lock.readLock()
-    log('get got read lock')
+    log.trace('get got read lock')
 
     try {
       const peer = await this.store.load(peerId)
@@ -39,7 +38,7 @@ export class PeerStoreProtoBook implements ProtoBook {
         throw err
       }
     } finally {
-      log('get release read lock')
+      log.trace('get release read lock')
       release()
     }
 
@@ -54,15 +53,16 @@ export class PeerStoreProtoBook implements ProtoBook {
       throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    log('set await write lock')
+    log.trace('set await write lock')
     const release = await this.store.lock.writeLock()
-    log('set got write lock')
+    log.trace('set got write lock')
 
+    let peer
     let updatedPeer
 
     try {
       try {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
 
         if (new Set([
           ...protocols
@@ -79,14 +79,18 @@ export class PeerStoreProtoBook implements ProtoBook {
         protocols
       })
 
-      log(`stored provided protocols for ${peerId.toString(base58btc)}`)
+      log('stored provided protocols for %p', peerId)
     } finally {
-      log('set release write lock')
+      log.trace('set release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, protocols: updatedPeer.protocols }
+    this.dispatchEvent(new CustomEvent<PeerProtocolsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        protocols: updatedPeer.protocols,
+        oldProtocols: peer == null ? [] : peer.protocols
+      }
     }))
   }
 
@@ -98,15 +102,16 @@ export class PeerStoreProtoBook implements ProtoBook {
       throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    log('add await write lock')
+    log.trace('add await write lock')
     const release = await this.store.lock.writeLock()
-    log('add got write lock')
+    log.trace('add got write lock')
 
+    let peer: Peer | undefined
     let updatedPeer
 
     try {
       try {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
 
         if (new Set([
           ...peer.protocols,
@@ -124,14 +129,18 @@ export class PeerStoreProtoBook implements ProtoBook {
         protocols
       })
 
-      log(`added provided protocols for ${peerId.toString(base58btc)}`)
+      log('added provided protocols for %p', peerId)
     } finally {
-      log('add release write lock')
+      log.trace('add release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, protocols: updatedPeer.protocols }
+    this.dispatchEvent(new CustomEvent<PeerProtocolsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        protocols: updatedPeer.protocols,
+        oldProtocols: peer == null ? [] : peer.protocols
+      }
     }))
   }
 
@@ -143,15 +152,16 @@ export class PeerStoreProtoBook implements ProtoBook {
       throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    log('remove await write lock')
+    log.trace('remove await write lock')
     const release = await this.store.lock.writeLock()
-    log('remove got write lock')
+    log.trace('remove got write lock')
 
-    let updatedPeer
+    let peer: Peer | undefined
+    let updatedPeer: Peer
 
     try {
       try {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
         const protocolSet = new Set(peer.protocols)
 
         for (const protocol of protocols) {
@@ -173,41 +183,51 @@ export class PeerStoreProtoBook implements ProtoBook {
         protocols
       })
     } finally {
-      log('remove release write lock')
+      log.trace('remove release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, protocols: updatedPeer.protocols }
+    this.dispatchEvent(new CustomEvent<PeerProtocolsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        protocols: updatedPeer.protocols,
+        oldProtocols: peer == null ? [] : peer.protocols
+      }
     }))
   }
 
   async delete (peerId: PeerId) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('delete await write lock')
+    log.trace('delete await write lock')
     const release = await this.store.lock.writeLock()
-    log('delete got write lock')
-    let has
+    log.trace('delete got write lock')
+    let peer: Peer | undefined
 
     try {
-      has = await this.store.has(peerId)
+      try {
+        peer = await this.store.load(peerId)
+      } catch (err: any) {
+        if (err.code !== codes.ERR_NOT_FOUND) {
+          throw err
+        }
+      }
 
       await this.store.patchOrCreate(peerId, {
         protocols: []
       })
-    } catch (err: any) {
-      if (err.code !== codes.ERR_NOT_FOUND) {
-        throw err
-      }
     } finally {
-      log('delete release write lock')
+      log.trace('delete release write lock')
       release()
     }
 
-    if (has === true) {
-      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-        detail: { peerId, protocols: [] }
+    if (peer != null) {
+      this.dispatchEvent(new CustomEvent<PeerProtocolsChangeData>(EVENT_NAME, {
+        detail: {
+          peerId,
+          protocols: [],
+          oldProtocols: peer.protocols
+        }
       }))
     }
   }

package/src/store.ts

@@ -51,8 +51,8 @@ export class PersistentStore {
       throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS)
     }
 
-    const b32key = peerId.toString(base32)
-    return new Key(`${NAMESPACE_COMMON}b${b32key}`)
+    const b32key = base32.encode(peerId.toBytes())
+    return new Key(`${NAMESPACE_COMMON}${b32key}`)
   }
 
   async has (peerId: PeerId) {
@@ -93,24 +93,25 @@ export class PersistentStore {
 
     // dedupe addresses
     const addressSet = new Set()
+    const addresses = peer.addresses
+      .filter(address => {
+        if (addressSet.has(address.multiaddr.toString())) {
+          return false
+        }
+
+        addressSet.add(address.multiaddr.toString())
+        return true
+      })
+      .sort((a, b) => {
+        return a.multiaddr.toString().localeCompare(b.multiaddr.toString())
+      })
+      .map(({ multiaddr, isCertified }) => ({
+        multiaddr: multiaddr.bytes,
+        isCertified
+      }))
 
     const buf = PeerPB.encode({
-      addresses: peer.addresses
-        .filter(address => {
-          if (addressSet.has(address.multiaddr.toString())) {
-            return false
-          }
-
-          addressSet.add(address.multiaddr.toString())
-          return true
-        })
-        .sort((a, b) => {
-          return a.multiaddr.toString().localeCompare(b.multiaddr.toString())
-        })
-        .map(({ multiaddr, isCertified }) => ({
-          multiaddr: multiaddr.bytes,
-          isCertified
-        })),
+      addresses,
       protocols: peer.protocols.sort(),
       pubKey: peer.pubKey,
       metadata: [...peer.metadata.keys()].sort().map(key => ({ key, value: peer.metadata.get(key) })),
@@ -178,16 +179,19 @@ export class PersistentStore {
   async _merge (peerId: PeerId, data: Partial<Peer>, peer: Peer) {
     // if the peer has certified addresses, use those in
     // favour of the supplied versions
-    /** @type {Map<string, boolean>} */
-    const addresses = new Map()
+    const addresses = new Map<string, boolean>()
 
-    ;(data.addresses ?? []).forEach(addr => {
+    peer.addresses.forEach((addr) => {
       addresses.set(addr.multiaddr.toString(), addr.isCertified)
     })
 
-    peer.addresses.forEach(({ multiaddr, isCertified }) => {
-      const addrStr = multiaddr.toString()
-      addresses.set(addrStr, Boolean(addresses.has(addrStr) ?? isCertified))
+    ;(data.addresses ?? []).forEach(addr => {
+      const addrString = addr.multiaddr.toString()
+      const isAlreadyCertified = Boolean(addresses.get(addrString))
+
+      const isCertified = isAlreadyCertified || addr.isCertified
+
+      addresses.set(addrString, isCertified)
     })
 
     return await this.save({