@libp2p/peer-store 6.0.1 → 6.0.3

package/src/metadata-book.ts

@@ -28,7 +28,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
   /**
    * Get the known data of a provided peer
    */
-  async get (peerId: PeerId) {
+  async get (peerId: PeerId): Promise<Map<string, Uint8Array>> {
     peerId = peerIdFromPeerId(peerId)
 
     log.trace('get await read lock')
@@ -54,7 +54,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
   /**
    * Get specific metadata value, if it exists
    */
-  async getValue (peerId: PeerId, key: string) {
+  async getValue (peerId: PeerId, key: string): Promise<Uint8Array | undefined> {
     peerId = peerIdFromPeerId(peerId)
 
     log.trace('getValue await read lock')
@@ -75,7 +75,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
     }
   }
 
-  async set (peerId: PeerId, metadata: Map<string, Uint8Array>) {
+  async set (peerId: PeerId, metadata: Map<string, Uint8Array>): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     if (!(metadata instanceof Map)) {
@@ -118,7 +118,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
   /**
    * Set metadata key and value of a provided peer
    */
-  async setValue (peerId: PeerId, key: string, value: Uint8Array) {
+  async setValue (peerId: PeerId, key: string, value: Uint8Array): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     if (typeof key !== 'string' || !(value instanceof Uint8Array)) {
@@ -164,7 +164,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
     }))
   }
 
-  async delete (peerId: PeerId) {
+  async delete (peerId: PeerId): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     log.trace('delete await write lock')
@@ -203,7 +203,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
     }
   }
 
-  async deleteValue (peerId: PeerId, key: string) {
+  async deleteValue (peerId: PeerId, key: string): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     log.trace('deleteValue await write lock')

package/src/pb/peer.ts

@@ -2,10 +2,11 @@
 /* eslint-disable complexity */
 /* eslint-disable @typescript-eslint/no-namespace */
 /* eslint-disable @typescript-eslint/no-unnecessary-boolean-literal-compare */
+/* eslint-disable @typescript-eslint/no-empty-interface */
 
 import { encodeMessage, decodeMessage, message } from 'protons-runtime'
-import type { Uint8ArrayList } from 'uint8arraylist'
 import type { Codec } from 'protons-runtime'
+import type { Uint8ArrayList } from 'uint8arraylist'
 
 export interface Peer {
   addresses: Address[]
@@ -28,9 +29,7 @@ export namespace Peer {
         if (obj.addresses != null) {
           for (const value of obj.addresses) {
             w.uint32(10)
-            Address.codec().encode(value, w, {
-              writeDefaults: true
-            })
+            Address.codec().encode(value, w)
           }
         }
 
@@ -44,9 +43,7 @@ export namespace Peer {
         if (obj.metadata != null) {
           for (const value of obj.metadata) {
             w.uint32(26)
-            Metadata.codec().encode(value, w, {
-              writeDefaults: true
-            })
+            Metadata.codec().encode(value, w)
           }
         }
 
@@ -104,7 +101,7 @@ export namespace Peer {
     return _codec
   }
 
-  export const encode = (obj: Peer): Uint8Array => {
+  export const encode = (obj: Partial<Peer>): Uint8Array => {
     return encodeMessage(obj, Peer.codec())
   }
 
@@ -128,7 +125,7 @@ export namespace Address {
           w.fork()
         }
 
-        if (opts.writeDefaults === true || (obj.multiaddr != null && obj.multiaddr.byteLength > 0)) {
+        if ((obj.multiaddr != null && obj.multiaddr.byteLength > 0)) {
           w.uint32(10)
           w.bytes(obj.multiaddr)
         }
@@ -171,7 +168,7 @@ export namespace Address {
     return _codec
   }
 
-  export const encode = (obj: Address): Uint8Array => {
+  export const encode = (obj: Partial<Address>): Uint8Array => {
     return encodeMessage(obj, Address.codec())
   }
 
@@ -195,12 +192,12 @@ export namespace Metadata {
           w.fork()
         }
 
-        if (opts.writeDefaults === true || obj.key !== '') {
+        if ((obj.key != null && obj.key !== '')) {
           w.uint32(10)
           w.string(obj.key)
         }
 
-        if (opts.writeDefaults === true || (obj.value != null && obj.value.byteLength > 0)) {
+        if ((obj.value != null && obj.value.byteLength > 0)) {
           w.uint32(18)
           w.bytes(obj.value)
         }
@@ -239,7 +236,7 @@ export namespace Metadata {
     return _codec
   }
 
-  export const encode = (obj: Metadata): Uint8Array => {
+  export const encode = (obj: Partial<Metadata>): Uint8Array => {
     return encodeMessage(obj, Metadata.codec())
   }
 

package/src/pb/tags.ts

@@ -2,10 +2,11 @@
 /* eslint-disable complexity */
 /* eslint-disable @typescript-eslint/no-namespace */
 /* eslint-disable @typescript-eslint/no-unnecessary-boolean-literal-compare */
+/* eslint-disable @typescript-eslint/no-empty-interface */
 
 import { encodeMessage, decodeMessage, message } from 'protons-runtime'
-import type { Uint8ArrayList } from 'uint8arraylist'
 import type { Codec } from 'protons-runtime'
+import type { Uint8ArrayList } from 'uint8arraylist'
 
 export interface Tags {
   tags: Tag[]
@@ -24,9 +25,7 @@ export namespace Tags {
         if (obj.tags != null) {
           for (const value of obj.tags) {
             w.uint32(10)
-            Tag.codec().encode(value, w, {
-              writeDefaults: true
-            })
+            Tag.codec().encode(value, w)
           }
         }
 
@@ -60,7 +59,7 @@ export namespace Tags {
     return _codec
   }
 
-  export const encode = (obj: Tags): Uint8Array => {
+  export const encode = (obj: Partial<Tags>): Uint8Array => {
     return encodeMessage(obj, Tags.codec())
   }
 
@@ -85,7 +84,7 @@ export namespace Tag {
           w.fork()
         }
 
-        if (opts.writeDefaults === true || obj.name !== '') {
+        if ((obj.name != null && obj.name !== '')) {
           w.uint32(10)
           w.string(obj.name)
         }
@@ -136,7 +135,7 @@ export namespace Tag {
     return _codec
   }
 
-  export const encode = (obj: Tag): Uint8Array => {
+  export const encode = (obj: Partial<Tag>): Uint8Array => {
     return encodeMessage(obj, Tag.codec())
   }
 

package/src/proto-book.ts

@@ -24,7 +24,7 @@ export class PeerStoreProtoBook implements ProtoBook {
     this.store = store
   }
 
-  async get (peerId: PeerId) {
+  async get (peerId: PeerId): Promise<string[]> {
     log.trace('get wait for read lock')
     const release = await this.store.lock.readLock()
     log.trace('get got read lock')
@@ -45,7 +45,7 @@ export class PeerStoreProtoBook implements ProtoBook {
     return []
   }
 
-  async set (peerId: PeerId, protocols: string[]) {
+  async set (peerId: PeerId, protocols: string[]): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
@@ -94,7 +94,7 @@ export class PeerStoreProtoBook implements ProtoBook {
     }))
   }
 
-  async add (peerId: PeerId, protocols: string[]) {
+  async add (peerId: PeerId, protocols: string[]): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
@@ -144,7 +144,7 @@ export class PeerStoreProtoBook implements ProtoBook {
     }))
   }
 
-  async remove (peerId: PeerId, protocols: string[]) {
+  async remove (peerId: PeerId, protocols: string[]): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     if (!Array.isArray(protocols)) {
@@ -196,7 +196,7 @@ export class PeerStoreProtoBook implements ProtoBook {
     }))
   }
 
-  async delete (peerId: PeerId) {
+  async delete (peerId: PeerId): Promise<void> {
     peerId = peerIdFromPeerId(peerId)
 
     log.trace('delete await write lock')

package/src/store.ts

@@ -45,7 +45,7 @@ export class PersistentStore {
     })
   }
 
-  _peerIdToDatastoreKey (peerId: PeerId) {
+  _peerIdToDatastoreKey (peerId: PeerId): Key {
     if (peerId.type == null) {
       log.error('peerId must be an instance of peer-id to store data')
       throw new CodeError('peerId must be an instance of peer-id', codes.ERR_INVALID_PARAMETERS)
@@ -55,11 +55,11 @@ export class PersistentStore {
     return new Key(`${NAMESPACE_COMMON}${b32key}`)
   }
 
-  async has (peerId: PeerId) {
+  async has (peerId: PeerId): Promise<boolean> {
     return await this.components.datastore.has(this._peerIdToDatastoreKey(peerId))
   }
 
-  async delete (peerId: PeerId) {
+  async delete (peerId: PeerId): Promise<void> {
     await this.components.datastore.delete(this._peerIdToDatastoreKey(peerId))
   }
 
@@ -87,7 +87,7 @@ export class PersistentStore {
     }
   }
 
-  async save (peer: Peer) {
+  async save (peer: Peer): Promise<Peer> {
     if (peer.pubKey != null && peer.id.publicKey != null && !uint8arrayEquals(peer.pubKey, peer.id.publicKey)) {
       log.error('peer publicKey bytes do not match peer id publicKey bytes')
       throw new CodeError('publicKey bytes do not match peer id publicKey bytes', codes.ERR_INVALID_PARAMETERS)
@@ -135,13 +135,13 @@ export class PersistentStore {
     return await this.load(peer.id)
   }
 
-  async patch (peerId: PeerId, data: Partial<Peer>) {
+  async patch (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
     const peer = await this.load(peerId)
 
     return await this._patch(peerId, data, peer)
   }
 
-  async patchOrCreate (peerId: PeerId, data: Partial<Peer>) {
+  async patchOrCreate (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
     let peer: Peer
 
     try {
@@ -157,7 +157,7 @@ export class PersistentStore {
     return await this._patch(peerId, data, peer)
   }
 
-  async _patch (peerId: PeerId, data: Partial<Peer>, peer: Peer) {
+  async _patch (peerId: PeerId, data: Partial<Peer>, peer: Peer): Promise<Peer> {
     return await this.save({
       ...peer,
       ...data,
@@ -165,13 +165,13 @@ export class PersistentStore {
     })
   }
 
-  async merge (peerId: PeerId, data: Partial<Peer>) {
+  async merge (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
     const peer = await this.load(peerId)
 
     return await this._merge(peerId, data, peer)
   }
 
-  async mergeOrCreate (peerId: PeerId, data: Partial<Peer>) {
+  async mergeOrCreate (peerId: PeerId, data: Partial<Peer>): Promise<Peer> {
     /** @type {Peer} */
     let peer
 
@@ -188,7 +188,7 @@ export class PersistentStore {
     return await this._merge(peerId, data, peer)
   }
 
-  async _merge (peerId: PeerId, data: Partial<Peer>, peer: Peer) {
+  async _merge (peerId: PeerId, data: Partial<Peer>, peer: Peer): Promise<Peer> {
     // if the peer has certified addresses, use those in
     // favour of the supplied versions
     const addresses = new Map<string, boolean>()
@@ -227,7 +227,7 @@ export class PersistentStore {
     })
   }
 
-  async * all () {
+  async * all (): AsyncGenerator<Peer, void, unknown> {
     for await (const key of this.components.datastore.queryKeys({
       prefix: NAMESPACE_COMMON
     })) {