@libp2p/peer-store 0.0.0 → 1.0.3

package/src/index.ts

@@ -1,11 +1,11 @@
 import { logger } from '@libp2p/logger'
-import { EventEmitter } from 'events'
+import { EventEmitter } from '@libp2p/interfaces'
 import { PeerStoreAddressBook } from './address-book.js'
 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 } from '@libp2p/interfaces/peer-store'
+import type { PeerStore, Address, AddressBook, KeyBook, MetadataBook, ProtoBook, PeerStoreEvents } 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'
@@ -30,14 +30,14 @@ export interface PeerStoreOptions {
 /**
  * An implementation of PeerStore that stores data in a Datastore
  */
-export class DefaultPeerStore extends EventEmitter implements PeerStore {
+export class PeerStoreImpl extends EventEmitter<PeerStoreEvents> implements PeerStore {
   public addressBook: AddressBook
   public keyBook: KeyBook
   public metadataBook: MetadataBook
   public protoBook: ProtoBook
 
-  private peerId: PeerId
-  private store: Store
+  private readonly peerId: PeerId
+  private readonly store: Store
 
   constructor (options: PeerStoreOptions) {
     super()
@@ -47,10 +47,10 @@ export class DefaultPeerStore extends EventEmitter implements PeerStore {
     this.peerId = peerId
     this.store = new PersistentStore(datastore)
 
-    this.addressBook = new PeerStoreAddressBook(this.emit.bind(this), this.store, addressFilter)
-    this.keyBook = new PeerStoreKeyBook(this.emit.bind(this), this.store)
-    this.metadataBook = new PeerStoreMetadataBook(this.emit.bind(this), this.store)
-    this.protoBook = new PeerStoreProtoBook(this.emit.bind(this), this.store)
+    this.addressBook = new PeerStoreAddressBook(this.dispatchEvent.bind(this), this.store, addressFilter)
+    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 () {
@@ -98,7 +98,7 @@ export class DefaultPeerStore extends EventEmitter implements PeerStore {
     log('get got read lock')
 
     try {
-      return this.store.load(peerId)
+      return await this.store.load(peerId)
     } finally {
       log('get release read lock')
       release()
@@ -114,10 +114,14 @@ export class DefaultPeerStore extends EventEmitter implements PeerStore {
     log('has got read lock')
 
     try {
-      return this.store.has(peerId)
+      return await this.store.has(peerId)
     } finally {
       log('has release read lock')
       release()
     }
   }
 }
+
+export function createPeerStore (opts: PeerStoreOptions): PeerStore {
+  return new PeerStoreImpl(opts)
+}

package/src/key-book.ts

@@ -1,30 +1,26 @@
 import { logger } from '@libp2p/logger'
 import errcode from 'err-code'
 import { codes } from './errors.js'
-import { PeerId } from '@libp2p/peer-id'
+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'
-
-/**
- * @typedef {import('./types').PeerStore} PeerStore
- * @typedef {import('./types').KeyBook} KeyBook
- * @typedef {import('libp2p-interfaces/src/keys/types').PublicKey} PublicKey
- */
+import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:key-book')
 
 const EVENT_NAME = 'change:pubkey'
 
 export class PeerStoreKeyBook implements KeyBook {
-  private emit: PeerStore["emit"]
-  private store: Store
+  private readonly dispatchEvent: PeerStore['dispatchEvent']
+  private readonly store: Store
 
   /**
    * The KeyBook is responsible for keeping the known public keys of a peer
    */
-  constructor (emit: PeerStore["emit"], store: Store) {
-    this.emit = emit
+  constructor (dispatchEvent: PeerStore['dispatchEvent'], store: Store) {
+    this.dispatchEvent = dispatchEvent
     this.store = store
   }
 
@@ -32,10 +28,10 @@ export class PeerStoreKeyBook implements KeyBook {
    * Set the Peer public key
    */
   async set (peerId: PeerId, publicKey: Uint8Array) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
-    if (!publicKey) {
-      log.error('publicKey must be an instance of PublicKey to store data')
+    if (!(publicKey instanceof Uint8Array)) {
+      log.error('publicKey must be an instance of Uint8Array to store data')
       throw errcode(new Error('publicKey must be an instance of PublicKey'), codes.ERR_INVALID_PARAMETERS)
     }
 
@@ -49,7 +45,7 @@ export class PeerStoreKeyBook implements KeyBook {
       try {
         const existing = await this.store.load(peerId)
 
-        if (existing.pubKey && uint8arrayEquals(existing.pubKey, publicKey)) {
+        if ((existing.pubKey != null) && uint8arrayEquals(existing.pubKey, publicKey)) {
           return
         }
       } catch (err: any) {
@@ -68,7 +64,9 @@ export class PeerStoreKeyBook implements KeyBook {
     }
 
     if (updatedKey) {
-      this.emit(EVENT_NAME, { peerId, pubKey: publicKey })
+      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+        detail: { peerId, pubKey: publicKey }
+      }))
     }
   }
 
@@ -76,7 +74,7 @@ export class PeerStoreKeyBook implements KeyBook {
    * Get Public key of the given PeerId, if stored
    */
   async get (peerId: PeerId) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('get await write lock')
     const release = await this.store.lock.readLock()
@@ -97,7 +95,7 @@ export class PeerStoreKeyBook implements KeyBook {
   }
 
   async delete (peerId: PeerId) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('delete await write lock')
     const release = await this.store.lock.writeLock()
@@ -112,6 +110,8 @@ export class PeerStoreKeyBook implements KeyBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, pubKey: undefined })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, pubKey: undefined }
+    }))
   }
 }

package/src/metadata-book.ts

@@ -1,25 +1,27 @@
 import { logger } from '@libp2p/logger'
 import errcode from 'err-code'
 import { codes } from './errors.js'
-import { PeerId } from '@libp2p/peer-id'
+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 { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:metadata-book')
 
 const EVENT_NAME = 'change:metadata'
 
 export class PeerStoreMetadataBook implements MetadataBook {
-  private emit: PeerStore["emit"]
-  private store: Store
+  private readonly dispatchEvent: PeerStore['dispatchEvent']
+  private readonly store: Store
 
   /**
    * The MetadataBook is responsible for keeping metadata
    * about known peers
    */
-  constructor (emit: PeerStore["emit"], store: Store) {
-    this.emit = emit
+  constructor (dispatchEvent: PeerStore['dispatchEvent'], store: Store) {
+    this.dispatchEvent = dispatchEvent
     this.store = store
   }
 
@@ -27,7 +29,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
    * Get the known data of a provided peer
    */
   async get (peerId: PeerId) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('get await read lock')
     const release = await this.store.lock.readLock()
@@ -53,7 +55,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
    * Get specific metadata value, if it exists
    */
   async getValue (peerId: PeerId, key: string) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('getValue await read lock')
     const release = await this.store.lock.readLock()
@@ -74,9 +76,9 @@ export class PeerStoreMetadataBook implements MetadataBook {
   }
 
   async set (peerId: PeerId, metadata: Map<string, Uint8Array>) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
-    if (!metadata || !(metadata instanceof Map)) {
+    if (!(metadata instanceof Map)) {
       log.error('valid metadata must be provided to store data')
       throw errcode(new Error('valid metadata must be provided'), codes.ERR_INVALID_PARAMETERS)
     }
@@ -94,14 +96,16 @@ export class PeerStoreMetadataBook implements MetadataBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, metadata })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, metadata }
+    }))
   }
 
   /**
    * Set metadata key and value of a provided peer
    */
   async setValue (peerId: PeerId, key: string, value: Uint8Array) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     if (typeof key !== 'string' || !(value instanceof Uint8Array)) {
       log.error('valid key and value must be provided to store data')
@@ -136,11 +140,13 @@ export class PeerStoreMetadataBook implements MetadataBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, metadata: updatedPeer.metadata })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, metadata: updatedPeer.metadata }
+    }))
   }
 
   async delete (peerId: PeerId) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('delete await write lock')
     const release = await this.store.lock.writeLock()
@@ -162,12 +168,14 @@ export class PeerStoreMetadataBook implements MetadataBook {
     }
 
     if (has) {
-      this.emit(EVENT_NAME, { peerId, metadata: new Map() })
+      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+        detail: { peerId, metadata: new Map() }
+      }))
     }
   }
 
   async deleteValue (peerId: PeerId, key: string) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('deleteValue await write lock')
     const release = await this.store.lock.writeLock()
@@ -193,8 +201,10 @@ export class PeerStoreMetadataBook implements MetadataBook {
       release()
     }
 
-    if (metadata) {
-      this.emit(EVENT_NAME, { peerId, metadata })
+    if (metadata != null) {
+      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+        detail: { peerId, metadata }
+      }))
     }
   }
 }

package/src/proto-book.ts

@@ -1,25 +1,27 @@
 import { logger } from '@libp2p/logger'
 import errcode from 'err-code'
 import { codes } from './errors.js'
-import { PeerId } from '@libp2p/peer-id'
+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 { base58btc } from 'multiformats/bases/base58'
+import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:proto-book')
 
 const EVENT_NAME = 'change:protocols'
 
 export class PeerStoreProtoBook implements ProtoBook {
-  private emit: PeerStore["emit"]
-  private store: Store
+  private readonly dispatchEvent: PeerStore['dispatchEvent']
+  private readonly store: Store
 
   /**
    * The ProtoBook is responsible for keeping the known supported
    * protocols of a peer
    */
-  constructor (emit: PeerStore["emit"], store: Store) {
-    this.emit = emit
+  constructor (dispatchEvent: PeerStore['dispatchEvent'], store: Store) {
+    this.dispatchEvent = dispatchEvent
     this.store = store
   }
 
@@ -45,7 +47,7 @@ export class PeerStoreProtoBook implements ProtoBook {
   }
 
   async set (peerId: PeerId, protocols: string[]) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
@@ -83,11 +85,13 @@ export class PeerStoreProtoBook implements ProtoBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, protocols: updatedPeer.protocols })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, protocols: updatedPeer.protocols }
+    }))
   }
 
   async add (peerId: PeerId, protocols: string[]) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
@@ -126,11 +130,13 @@ export class PeerStoreProtoBook implements ProtoBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, protocols: updatedPeer.protocols })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, protocols: updatedPeer.protocols }
+    }))
   }
 
   async remove (peerId: PeerId, protocols: string[]) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
@@ -171,11 +177,13 @@ export class PeerStoreProtoBook implements ProtoBook {
       release()
     }
 
-    this.emit(EVENT_NAME, { peerId, protocols: updatedPeer.protocols })
+    this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+      detail: { peerId, protocols: updatedPeer.protocols }
+    }))
   }
 
   async delete (peerId: PeerId) {
-    peerId = PeerId.fromPeerId(peerId)
+    peerId = peerIdFromPeerId(peerId)
 
     log('delete await write lock')
     const release = await this.store.lock.writeLock()
@@ -197,8 +205,10 @@ export class PeerStoreProtoBook implements ProtoBook {
       release()
     }
 
-    if (has) {
-      this.emit(EVENT_NAME, { peerId, protocols: [] })
+    if (has === true) {
+      this.dispatchEvent(new CustomEvent(EVENT_NAME, {
+        detail: { peerId, protocols: [] }
+      }))
     }
   }
 }

package/src/store.ts

@@ -1,5 +1,5 @@
 import { logger } from '@libp2p/logger'
-import { PeerId } from '@libp2p/peer-id'
+import { peerIdFromBytes } from '@libp2p/peer-id'
 import errcode from 'err-code'
 import { codes } from './errors.js'
 import { Key } from 'interface-datastore/key'
@@ -10,6 +10,7 @@ import mortice from 'mortice'
 import { equals as uint8arrayEquals } from 'uint8arrays/equals'
 import type { Peer } from '@libp2p/interfaces/peer-store'
 import type { Datastore } from 'interface-datastore'
+import type { PeerId } from '@libp2p/interfaces/peer-id'
 
 const log = logger('libp2p:peer-store:store')
 
@@ -19,7 +20,7 @@ export interface Store {
   has: (peerId: PeerId) => Promise<boolean>
   save: (peer: Peer) => Promise<Peer>
   load: (peerId: PeerId) => Promise<Peer>
-  delete (peerId: PeerId): Promise<void>
+  delete: (peerId: PeerId) => Promise<void>
   merge: (peerId: PeerId, data: Partial<Peer>) => Promise<Peer>
   mergeOrCreate: (peerId: PeerId, data: Partial<Peer>) => Promise<Peer>
   patch: (peerId: PeerId, data: Partial<Peer>) => Promise<Peer>
@@ -32,9 +33,8 @@ export interface Store {
   }
 }
 
-
 export class PersistentStore {
-  private datastore: Datastore
+  private readonly datastore: Datastore
   public lock: any
 
   constructor (datastore: Datastore) {
@@ -56,14 +56,14 @@ export class PersistentStore {
   }
 
   async has (peerId: PeerId) {
-    return this.datastore.has(this._peerIdToDatastoreKey(peerId))
+    return await this.datastore.has(this._peerIdToDatastoreKey(peerId))
   }
 
   async delete (peerId: PeerId) {
     await this.datastore.delete(this._peerIdToDatastoreKey(peerId))
   }
 
-  async load (peerId: PeerId) {
+  async load (peerId: PeerId): Promise<Peer> {
     const buf = await this.datastore.get(this._peerIdToDatastoreKey(peerId))
     const peer = PeerPB.decode(buf)
     const metadata = new Map()
@@ -77,11 +77,12 @@ export class PersistentStore {
       id: peerId,
       addresses: peer.addresses.map(({ multiaddr, isCertified }) => ({
         multiaddr: new Multiaddr(multiaddr),
-        isCertified: isCertified || false
+        isCertified: isCertified ?? false
       })),
       metadata,
-      peerRecordEnvelope: peer.peerRecordEnvelope || undefined
-    } as Peer
+      pubKey: peer.pubKey ?? undefined,
+      peerRecordEnvelope: peer.peerRecordEnvelope ?? undefined
+    }
   }
 
   async save (peer: Peer) {
@@ -118,7 +119,7 @@ export class PersistentStore {
 
     await this.datastore.put(this._peerIdToDatastoreKey(peer.id), buf)
 
-    return this.load(peer.id)
+    return await this.load(peer.id)
   }
 
   async patch (peerId: PeerId, data: Partial<Peer>) {
@@ -154,7 +155,7 @@ export class PersistentStore {
   async merge (peerId: PeerId, data: Partial<Peer>) {
     const peer = await this.load(peerId)
 
-    return this._merge(peerId, data, peer)
+    return await this._merge(peerId, data, peer)
   }
 
   async mergeOrCreate (peerId: PeerId, data: Partial<Peer>) {
@@ -180,13 +181,13 @@ export class PersistentStore {
     /** @type {Map<string, boolean>} */
     const addresses = new Map()
 
-    ;(data.addresses || []).forEach(addr => {
+    ;(data.addresses ?? []).forEach(addr => {
       addresses.set(addr.multiaddr.toString(), addr.isCertified)
     })
 
     peer.addresses.forEach(({ multiaddr, isCertified }) => {
       const addrStr = multiaddr.toString()
-      addresses.set(addrStr, Boolean(addresses.get(addrStr) || isCertified))
+      addresses.set(addrStr, Boolean(addresses.has(addrStr) ?? isCertified))
     })
 
     return await this.save({
@@ -198,15 +199,15 @@ export class PersistentStore {
         }
       }),
       protocols: Array.from(new Set([
-        ...(peer.protocols || []),
-        ...(data.protocols || [])
+        ...(peer.protocols ?? []),
+        ...(data.protocols ?? [])
       ])),
       metadata: new Map([
-        ...(peer.metadata ? peer.metadata.entries() : []),
-        ...(data.metadata ? data.metadata.entries() : [])
+        ...(peer.metadata?.entries() ?? []),
+        ...(data.metadata?.entries() ?? [])
       ]),
-      pubKey: data.pubKey || (peer != null ? peer.pubKey : undefined),
-      peerRecordEnvelope: data.peerRecordEnvelope || (peer != null ? peer.peerRecordEnvelope : undefined)
+      pubKey: data.pubKey ?? (peer != null ? peer.pubKey : undefined),
+      peerRecordEnvelope: data.peerRecordEnvelope ?? (peer != null ? peer.peerRecordEnvelope : undefined)
     })
   }
 
@@ -218,7 +219,7 @@ export class PersistentStore {
       const base32Str = key.toString().split('/')[2]
       const buf = base32.decode(base32Str)
 
-      yield this.load(PeerId.fromBytes(buf))
+      yield this.load(peerIdFromBytes(buf))
     }
   }
 }