@libp2p/peer-store 1.0.3 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/peer-store",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "Stores information about peers libp2p knows on the network",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-peer-store#readme",
@@ -140,9 +140,9 @@
     "test:electron-main": "npm run test -- -t electron-main"
   },
   "dependencies": {
-    "@libp2p/interfaces": "^1.0.0",
-    "@libp2p/logger": "^1.0.1",
-    "@libp2p/peer-record": "^1.0.1",
+    "@libp2p/interfaces": "^1.3.0",
+    "@libp2p/logger": "^1.1.0",
+    "@libp2p/peer-record": "^1.0.0",
     "@multiformats/multiaddr": "^10.1.5",
     "interface-datastore": "^6.1.0",
     "it-all": "^1.0.6",
@@ -152,13 +152,13 @@
     "it-pipe": "^2.0.3",
     "mortice": "^3.0.0",
     "multiformats": "^9.6.3",
-    "protobufjs": "^6.10.2"
+    "protobufjs": "^6.11.2"
   },
   "devDependencies": {
-    "@libp2p/interface-compliance-tests": "^1.1.2",
+    "@libp2p/interface-compliance-tests": "^1.1.0",
     "@libp2p/peer-id": "^1.1.0",
-    "@libp2p/peer-id-factory": "^1.0.3",
-    "@libp2p/utils": "^1.0.5",
+    "@libp2p/peer-id-factory": "^1.0.0",
+    "@libp2p/utils": "^1.0.9",
     "aegir": "^36.1.3",
     "datastore-core": "^7.0.1",
     "err-code": "^3.0.1",

package/src/README.md

@@ -49,7 +49,7 @@ The `addressBook` keeps the known multiaddrs of a peer. The multiaddrs of each p
 
 `Map<string, Address>`
 
-A `peerId.toString(base58btc)` identifier mapping to a `Address` object, which should have the following structure:
+A `peerId.toString()` identifier mapping to a `Address` object, which should have the following structure:
 
 ```js
 {
@@ -63,7 +63,7 @@ The `keyBook` tracks the public keys of the peers by keeping their [`PeerId`][pe
 
 `Map<string, PeerId`
 
-A `peerId.toString(base58btc)` identifier mapping to a `PeerId` of the peer. This instance contains the peer public key.
+A `peerId.toString()` identifier mapping to a `PeerId` of the peer. This instance contains the peer public key.
 
 #### Protocol Book
 
@@ -71,7 +71,7 @@ The `protoBook` holds the identifiers of the protocols supported by each peer. T
 
 `Map<string, Set<string>>`
 
-A `peerId.toString(base58btc)` identifier mapping to a `Set` of protocol identifier strings.
+A `peerId.toString()` identifier mapping to a `Set` of protocol identifier strings.
 
 #### Metadata Book
 
@@ -79,7 +79,7 @@ The `metadataBook` keeps track of the known metadata of a peer. Its metadata is
 
 `Map<string, Map<string, Uint8Array>>`
 
-A `peerId.toString(base58btc)` identifier mapping to the peer metadata Map.
+A `peerId.toString()` identifier mapping to the peer metadata Map.
 
 ### API
 

package/src/address-book.ts

@@ -8,14 +8,13 @@ import all from 'it-all'
 import filter from 'it-filter'
 import map from 'it-map'
 import each from 'it-foreach'
-import { base58btc } from 'multiformats/bases/base58'
 import { peerIdFromPeerId } from '@libp2p/peer-id'
 import { CustomEvent } from '@libp2p/interfaces'
-import type { PeerStore } from '@libp2p/interfaces/peer-store'
+import type { AddressFilter, Peer, PeerMultiaddrsChangeData, PeerStore } from '@libp2p/interfaces/peer-store'
 import type { Store } from './store.js'
-import type { AddressFilter, AddressSorter } from './index.js'
 import type { Envelope } from '@libp2p/interfaces/record'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { PeerData } from '@libp2p/interfaces/peer-data'
 
 const log = logger('libp2p:peer-store:address-book')
 const EVENT_NAME = 'change:multiaddrs'
@@ -41,11 +40,12 @@ export class PeerStoreAddressBook {
    * into the AddressBook.
    */
   async consumePeerRecord (envelope: Envelope) {
-    log('consumePeerRecord await write lock')
+    log.trace('consumePeerRecord await write lock')
     const release = await this.store.lock.writeLock()
-    log('consumePeerRecord got write lock')
+    log.trace('consumePeerRecord got write lock')
 
     let peerId
+    let peer: Peer | undefined
     let updatedPeer
 
     try {
@@ -72,7 +72,7 @@ export class PeerStoreAddressBook {
       }
 
       if (await this.store.has(peerId)) {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
 
         if (peer.peerRecordEnvelope != null) {
           const storedEnvelope = await RecordEnvelope.createFromProtobuf(peer.peerRecordEnvelope)
@@ -80,35 +80,42 @@ export class PeerStoreAddressBook {
 
           // ensure seq is greater than, or equal to, the last received
           if (storedRecord.seqNumber >= peerRecord.seqNumber) {
+            log('sequence number was lower or equal to existing sequence number - stored: %d received: %d', storedRecord.seqNumber, peerRecord.seqNumber)
             return false
           }
         }
       }
 
+      const addresses = await filterMultiaddrs(peerId, multiaddrs, this.addressFilter, true)
+
       // Replace unsigned addresses by the new ones from the record
       // TODO: Once we have ttls for the addresses, we should merge these in
       updatedPeer = await this.store.patchOrCreate(peerId, {
-        addresses: await filterMultiaddrs(peerId, multiaddrs, this.addressFilter, true),
+        addresses,
         peerRecordEnvelope: envelope.marshal()
       })
 
-      log(`stored provided peer record for ${peerRecord.peerId.toString(base58btc)}`)
+      log('stored provided peer record for %p', peerRecord.peerId)
     } finally {
-      log('consumePeerRecord release write lock')
+      log.trace('consumePeerRecord release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, multiaddrs: updatedPeer.addresses.map(({ multiaddr }) => multiaddr) }
+    this.dispatchEvent(new CustomEvent<PeerMultiaddrsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        multiaddrs: updatedPeer.addresses.map(({ multiaddr }) => multiaddr),
+        oldMultiaddrs: peer == null ? [] : peer.addresses.map(({ multiaddr }) => multiaddr)
+      }
     }))
 
     return true
   }
 
   async getRawEnvelope (peerId: PeerId) {
-    log('getRawEnvelope await read lock')
+    log.trace('getRawEnvelope await read lock')
     const release = await this.store.lock.readLock()
-    log('getRawEnvelope got read lock')
+    log.trace('getRawEnvelope got read lock')
 
     try {
       const peer = await this.store.load(peerId)
@@ -119,7 +126,7 @@ export class PeerStoreAddressBook {
         throw err
       }
     } finally {
-      log('getRawEnvelope release read lock')
+      log.trace('getRawEnvelope release read lock')
       release()
     }
   }
@@ -141,9 +148,9 @@ export class PeerStoreAddressBook {
   async get (peerId: PeerId) {
     peerId = peerIdFromPeerId(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)
@@ -154,7 +161,7 @@ export class PeerStoreAddressBook {
         throw err
       }
     } finally {
-      log('get release read lock')
+      log.trace('get release read lock')
       release()
     }
 
@@ -169,11 +176,12 @@ export class PeerStoreAddressBook {
       throw errcode(new Error('multiaddrs must be an array of Multiaddrs'), 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 hasPeer = false
+    let peer: Peer | undefined
     let updatedPeer
 
     try {
@@ -185,7 +193,7 @@ export class PeerStoreAddressBook {
       }
 
       try {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
         hasPeer = true
 
         if (new Set([
@@ -203,21 +211,28 @@ export class PeerStoreAddressBook {
 
       updatedPeer = await this.store.patchOrCreate(peerId, { addresses })
 
-      log(`set multiaddrs for ${peerId.toString(base58btc)}`)
+      log('set multiaddrs for %p', peerId)
     } finally {
+      log.trace('set multiaddrs for %p', peerId)
       log('set release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr) }
+    this.dispatchEvent(new CustomEvent<PeerMultiaddrsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr),
+        oldMultiaddrs: peer == null ? [] : peer.addresses.map(({ multiaddr }) => multiaddr)
+      }
     }))
 
     // Notify the existence of a new peer
     if (!hasPeer) {
-      this.dispatchEvent(new CustomEvent('peer', {
+      this.dispatchEvent(new CustomEvent<PeerData>('peer', {
         detail: {
-          peerId
+          id: peerId,
+          multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr),
+          protocols: updatedPeer.protocols
         }
       }))
     }
@@ -231,11 +246,12 @@ export class PeerStoreAddressBook {
       throw errcode(new Error('multiaddrs must be an array of Multiaddrs'), 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 hasPeer
+    let peer: Peer | undefined
     let updatedPeer
 
     try {
@@ -247,7 +263,7 @@ export class PeerStoreAddressBook {
       }
 
       try {
-        const peer = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
         hasPeer = true
 
         if (new Set([
@@ -264,20 +280,28 @@ export class PeerStoreAddressBook {
 
       updatedPeer = await this.store.mergeOrCreate(peerId, { addresses })
 
-      log(`added multiaddrs for ${peerId.toString(base58btc)}`)
+      log('added multiaddrs for %p', peerId)
     } finally {
-      log('set release write lock')
+      log.trace('set release write lock')
       release()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr) }
+    this.dispatchEvent(new CustomEvent<PeerMultiaddrsChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr),
+        oldMultiaddrs: peer == null ? [] : peer.addresses.map(({ multiaddr }) => multiaddr)
+      }
     }))
 
     // Notify the existence of a new peer
     if (hasPeer === true) {
-      this.dispatchEvent(new CustomEvent('peer', {
-        detail: { peerId }
+      this.dispatchEvent(new CustomEvent<PeerData>('peer', {
+        detail: {
+          id: peerId,
+          multiaddrs: updatedPeer.addresses.map(addr => addr.multiaddr),
+          protocols: updatedPeer.protocols
+        }
       }))
     }
   }
@@ -285,46 +309,39 @@ export class PeerStoreAddressBook {
   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
+        }
+      }
 
       await this.store.patchOrCreate(peerId, {
         addresses: []
       })
     } finally {
-      log('delete release write lock')
+      log.trace('delete release write lock')
       release()
     }
 
-    if (has) {
-      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-        detail: { peerId, multiaddrs: [] }
+    if (peer != null) {
+      this.dispatchEvent(new CustomEvent<PeerMultiaddrsChangeData>(EVENT_NAME, {
+        detail: {
+          peerId,
+          multiaddrs: [],
+          oldMultiaddrs: peer == null ? [] : peer.addresses.map(({ multiaddr }) => multiaddr)
+        }
       }))
     }
   }
-
-  async getMultiaddrsForPeer (peerId: PeerId, addressSorter: AddressSorter = (mas) => mas) {
-    const addresses = await this.get(peerId)
-
-    return addressSorter(
-      addresses
-    ).map((address) => {
-      const multiaddr = address.multiaddr
-      const idString = multiaddr.getPeerId()
-
-      if (idString === peerId.toString()) {
-        return multiaddr
-      }
-
-      return multiaddr.encapsulate(`/p2p/${peerId.toString(base58btc)}`)
-    })
-  }
 }
 
 async function filterMultiaddrs (peerId: PeerId, multiaddrs: Multiaddr[], addressFilter: AddressFilter, isCertified: boolean = false) {

package/src/index.ts

@@ -5,86 +5,78 @@ import { PeerStoreKeyBook } from './key-book.js'
 import { PeerStoreMetadataBook } from './metadata-book.js'
 import { PeerStoreProtoBook } from './proto-book.js'
 import { PersistentStore, Store } from './store.js'
-import type { PeerStore, Address, AddressBook, KeyBook, MetadataBook, ProtoBook, PeerStoreEvents } from '@libp2p/interfaces/peer-store'
+import type { PeerStore, AddressBook, KeyBook, MetadataBook, ProtoBook, PeerStoreEvents, PeerStoreInit, Peer } from '@libp2p/interfaces/peer-store'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
-import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Datastore } from 'interface-datastore'
-import { base58btc } from 'multiformats/bases/base58'
+import type { Components } from '@libp2p/interfaces/components'
 
 const log = logger('libp2p:peer-store')
 
-export interface AddressFilter {
-  (peerId: PeerId, multiaddr: Multiaddr): Promise<boolean>
-}
-
-export interface AddressSorter {
-  (addresses: Address[]): Address[]
-}
-
-export interface PeerStoreOptions {
-  peerId: PeerId
-  datastore: Datastore
-  addressFilter?: AddressFilter
-}
-
 /**
  * An implementation of PeerStore that stores data in a Datastore
  */
-export class PeerStoreImpl extends EventEmitter<PeerStoreEvents> implements PeerStore {
+export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implements PeerStore {
   public addressBook: AddressBook
   public keyBook: KeyBook
   public metadataBook: MetadataBook
   public protoBook: ProtoBook
 
-  private readonly peerId: PeerId
+  private readonly components: Components
   private readonly store: Store
 
-  constructor (options: PeerStoreOptions) {
+  constructor (components: Components, init: PeerStoreInit = {}) {
     super()
 
-    const { peerId, datastore, addressFilter } = options
-
-    this.peerId = peerId
-    this.store = new PersistentStore(datastore)
+    this.components = components
+    this.store = new PersistentStore(components.getDatastore())
 
-    this.addressBook = new PeerStoreAddressBook(this.dispatchEvent.bind(this), this.store, addressFilter)
+    this.addressBook = new PeerStoreAddressBook(this.dispatchEvent.bind(this), this.store, init.addressFilter ?? components.getConnectionGater().filterMultiaddrForPeer)
     this.keyBook = new PeerStoreKeyBook(this.dispatchEvent.bind(this), this.store)
     this.metadataBook = new PeerStoreMetadataBook(this.dispatchEvent.bind(this), this.store)
     this.protoBook = new PeerStoreProtoBook(this.dispatchEvent.bind(this), this.store)
   }
 
-  async * getPeers () {
-    log('getPeers await read lock')
+  async forEach (fn: (peer: Peer) => void) {
+    log.trace('getPeers await read lock')
     const release = await this.store.lock.readLock()
-    log('getPeers got read lock')
+    log.trace('getPeers got read lock')
 
     try {
       for await (const peer of this.store.all()) {
-        if (peer.id.toString(base58btc) === this.peerId.toString(base58btc)) {
-          // Remove self peer if present
+        if (peer.id.equals(this.components.getPeerId())) {
+          // Skip self peer if present
           continue
         }
 
-        yield peer
+        fn(peer)
       }
     } finally {
-      log('getPeers release read lock')
+      log.trace('getPeers release read lock')
       release()
     }
   }
 
+  async all (): Promise<Peer[]> {
+    const output: Peer[] = []
+
+    await this.forEach(peer => {
+      output.push(peer)
+    })
+
+    return output
+  }
+
   /**
    * Delete the information of the given peer in every book
    */
   async delete (peerId: 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')
 
     try {
       await this.store.delete(peerId)
     } finally {
-      log('delete release write lock')
+      log.trace('delete release write lock')
       release()
     }
   }
@@ -93,14 +85,14 @@ export class PeerStoreImpl extends EventEmitter<PeerStoreEvents> implements Peer
    * Get the stored information of a given peer
    */
   async get (peerId: 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 {
       return await this.store.load(peerId)
     } finally {
-      log('get release read lock')
+      log.trace('get release read lock')
       release()
     }
   }
@@ -109,19 +101,15 @@ export class PeerStoreImpl extends EventEmitter<PeerStoreEvents> implements Peer
    * Returns true if we have a record of the peer
    */
   async has (peerId: PeerId) {
-    log('has await read lock')
+    log.trace('has await read lock')
     const release = await this.store.lock.readLock()
-    log('has got read lock')
+    log.trace('has got read lock')
 
     try {
       return await this.store.has(peerId)
     } finally {
-      log('has release read lock')
+      log.trace('has release read lock')
       release()
     }
   }
 }
-
-export function createPeerStore (opts: PeerStoreOptions): PeerStore {
-  return new PeerStoreImpl(opts)
-}

package/src/key-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, KeyBook } from '@libp2p/interfaces/src/peer-store'
+import type { PeerStore, KeyBook, PeerPublicKeyChangeData, Peer } from '@libp2p/interfaces/peer-store'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:key-book')
@@ -35,17 +35,18 @@ export class PeerStoreKeyBook implements KeyBook {
       throw errcode(new Error('publicKey must be an instance of PublicKey'), 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 updatedKey = false
+    let peer: Peer | undefined
 
     try {
       try {
-        const existing = await this.store.load(peerId)
+        peer = await this.store.load(peerId)
 
-        if ((existing.pubKey != null) && uint8arrayEquals(existing.pubKey, publicKey)) {
+        if ((peer.pubKey != null) && uint8arrayEquals(peer.pubKey, publicKey)) {
           return
         }
       } catch (err: any) {
@@ -59,13 +60,17 @@ export class PeerStoreKeyBook implements KeyBook {
       })
       updatedKey = true
     } finally {
-      log('set release write lock')
+      log.trace('set release write lock')
       release()
     }
 
     if (updatedKey) {
-      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-        detail: { peerId, pubKey: publicKey }
+      this.dispatchEvent(new CustomEvent<PeerPublicKeyChangeData>(EVENT_NAME, {
+        detail: {
+          peerId,
+          publicKey: publicKey,
+          oldPublicKey: peer == null ? undefined : peer.pubKey
+        }
       }))
     }
   }
@@ -76,9 +81,9 @@ export class PeerStoreKeyBook implements KeyBook {
   async get (peerId: PeerId) {
     peerId = peerIdFromPeerId(peerId)
 
-    log('get await write lock')
+    log.trace('get await write lock')
     const release = await this.store.lock.readLock()
-    log('get got write lock')
+    log.trace('get got write lock')
 
     try {
       const peer = await this.store.load(peerId)
@@ -97,21 +102,39 @@ export class PeerStoreKeyBook implements KeyBook {
   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 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.patchOrCreate(peerId, {
         pubKey: undefined
       })
+    } 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()
     }
 
-    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
-      detail: { peerId, pubKey: undefined }
+    this.dispatchEvent(new CustomEvent<PeerPublicKeyChangeData>(EVENT_NAME, {
+      detail: {
+        peerId,
+        publicKey: undefined,
+        oldPublicKey: peer == null ? undefined : peer.pubKey
+      }
     }))
   }
 }