@libp2p/peer-store 6.0.0 → 6.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/peer-store",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "Stores information about peers libp2p knows on the network",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-peer-store#readme",
@@ -148,12 +148,11 @@
     "@libp2p/interface-peer-info": "^1.0.3",
     "@libp2p/interface-peer-store": "^1.2.2",
     "@libp2p/interface-record": "^2.0.1",
-    "@libp2p/interfaces": "^3.0.3",
+    "@libp2p/interfaces": "^3.2.0",
     "@libp2p/logger": "^2.0.0",
     "@libp2p/peer-id": "^2.0.0",
     "@libp2p/peer-record": "^5.0.0",
     "@multiformats/multiaddr": "^11.0.0",
-    "err-code": "^3.0.1",
     "interface-datastore": "^7.0.0",
     "it-all": "^2.0.0",
     "it-filter": "^2.0.0",
@@ -162,7 +161,7 @@
     "it-pipe": "^2.0.3",
     "mortice": "^3.0.0",
     "multiformats": "^11.0.0",
-    "protons-runtime": "^4.0.1",
+    "protons-runtime": "^5.0.0",
     "uint8arraylist": "^2.1.1",
     "uint8arrays": "^4.0.2"
   },
@@ -175,7 +174,7 @@
     "delay": "^5.0.0",
     "p-defer": "^4.0.0",
     "p-wait-for": "^5.0.0",
-    "protons": "^6.0.0",
+    "protons": "^7.0.2",
     "sinon": "^15.0.1"
   }
 }

package/src/address-book.ts

@@ -1,5 +1,5 @@
 import { logger } from '@libp2p/logger'
-import errcode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { isMultiaddr } from '@multiformats/multiaddr'
 import { codes } from './errors.js'
 import { PeerRecord, RecordEnvelope } from '@libp2p/peer-record'
@@ -174,7 +174,7 @@ export class PeerStoreAddressBook {
 
     if (!Array.isArray(multiaddrs)) {
       log.error('multiaddrs must be an array of Multiaddrs')
-      throw errcode(new Error('multiaddrs must be an array of Multiaddrs'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('multiaddrs must be an array of Multiaddrs', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('set await write lock')
@@ -244,7 +244,7 @@ export class PeerStoreAddressBook {
 
     if (!Array.isArray(multiaddrs)) {
       log.error('multiaddrs must be an array of Multiaddrs')
-      throw errcode(new Error('multiaddrs must be an array of Multiaddrs'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('multiaddrs must be an array of Multiaddrs', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('add await write lock')
@@ -351,7 +351,7 @@ async function filterMultiaddrs (peerId: PeerId, multiaddrs: Multiaddr[], addres
     (source) => each(source, (multiaddr) => {
       if (!isMultiaddr(multiaddr)) {
         log.error('multiaddr must be an instance of Multiaddr')
-        throw errcode(new Error('multiaddr must be an instance of Multiaddr'), codes.ERR_INVALID_PARAMETERS)
+        throw new CodeError('multiaddr must be an instance of Multiaddr', codes.ERR_INVALID_PARAMETERS)
       }
     }),
     (source) => filter(source, async (multiaddr) => await addressFilter(peerId, multiaddr)),

package/src/index.ts

@@ -7,7 +7,7 @@ import { PeerStoreProtoBook } from './proto-book.js'
 import { PersistentStore, Store } from './store.js'
 import type { PeerStore, AddressBook, KeyBook, MetadataBook, ProtoBook, PeerStoreEvents, PeerStoreInit, Peer, TagOptions } from '@libp2p/interface-peer-store'
 import type { PeerId } from '@libp2p/interface-peer-id'
-import errCode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { Tag, Tags } from './pb/tags.js'
 import type { Datastore } from 'interface-datastore'
 
@@ -125,7 +125,7 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
     const ttl = options.ttl ?? undefined
 
     if (value !== providedValue || value < 0 || value > 100) {
-      throw errCode(new Error('Tag value must be between 0-100'), 'ERR_TAG_VALUE_OUT_OF_BOUNDS')
+      throw new CodeError('Tag value must be between 0-100', 'ERR_TAG_VALUE_OUT_OF_BOUNDS')
     }
 
     const buf = await this.metadataBook.getValue(peerId, 'tags')
@@ -135,11 +135,8 @@ export class PersistentPeerStore extends EventEmitter<PeerStoreEvents> implement
       tags = Tags.decode(buf).tags
     }
 
-    for (const t of tags) {
-      if (t.name === tag) {
-        throw errCode(new Error('Peer already tagged'), 'ERR_DUPLICATE_TAG')
-      }
-    }
+    // do not allow duplicate tags
+    tags = tags.filter(t => t.name !== tag)
 
     tags.push({
       name: tag,

package/src/key-book.ts

@@ -1,5 +1,5 @@
 import { logger } from '@libp2p/logger'
-import errcode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { codes } from './errors.js'
 import { peerIdFromPeerId } from '@libp2p/peer-id'
 import { equals as uint8arrayEquals } from 'uint8arrays/equals'
@@ -32,7 +32,7 @@ export class PeerStoreKeyBook implements KeyBook {
 
     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)
+      throw new CodeError('publicKey must be an instance of PublicKey', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('set await write lock')

package/src/metadata-book.ts

@@ -1,5 +1,5 @@
 import { logger } from '@libp2p/logger'
-import errcode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { codes } from './errors.js'
 import { peerIdFromPeerId } from '@libp2p/peer-id'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
@@ -80,7 +80,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
 
     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)
+      throw new CodeError('valid metadata must be provided', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('set await write lock')
@@ -123,7 +123,7 @@ export class PeerStoreMetadataBook implements MetadataBook {
 
     if (typeof key !== 'string' || !(value instanceof Uint8Array)) {
       log.error('valid key and value must be provided to store data')
-      throw errcode(new Error('valid key and value must be provided'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('valid key and value must be provided', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('setValue 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

@@ -1,5 +1,5 @@
 import { logger } from '@libp2p/logger'
-import errcode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { codes } from './errors.js'
 import { peerIdFromPeerId } from '@libp2p/peer-id'
 import { CustomEvent } from '@libp2p/interfaces/events'
@@ -50,7 +50,7 @@ export class PeerStoreProtoBook implements ProtoBook {
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
-      throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('protocols must be provided', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('set await write lock')
@@ -99,7 +99,7 @@ export class PeerStoreProtoBook implements ProtoBook {
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
-      throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('protocols must be provided', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('add await write lock')
@@ -149,7 +149,7 @@ export class PeerStoreProtoBook implements ProtoBook {
 
     if (!Array.isArray(protocols)) {
       log.error('protocols must be provided to store data')
-      throw errcode(new Error('protocols must be provided'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('protocols must be provided', codes.ERR_INVALID_PARAMETERS)
     }
 
     log.trace('remove await write lock')

package/src/store.ts

@@ -1,6 +1,6 @@
 import { logger } from '@libp2p/logger'
 import { peerIdFromBytes } from '@libp2p/peer-id'
-import errcode from 'err-code'
+import { CodeError } from '@libp2p/interfaces/errors'
 import { codes } from './errors.js'
 import { Key } from 'interface-datastore/key'
 import { base32 } from 'multiformats/bases/base32'
@@ -48,7 +48,7 @@ export class PersistentStore {
   _peerIdToDatastoreKey (peerId: PeerId) {
     if (peerId.type == null) {
       log.error('peerId must be an instance of peer-id to store data')
-      throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('peerId must be an instance of peer-id', codes.ERR_INVALID_PARAMETERS)
     }
 
     const b32key = peerId.toCID().toString()
@@ -90,7 +90,7 @@ export class PersistentStore {
   async save (peer: 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 errcode(new Error('publicKey bytes do not match peer id publicKey bytes'), codes.ERR_INVALID_PARAMETERS)
+      throw new CodeError('publicKey bytes do not match peer id publicKey bytes', codes.ERR_INVALID_PARAMETERS)
     }
 
     // dedupe addresses