@libp2p/peer-store 10.1.5 → 11.0.0-18dd3cb26

package/src/utils/bytes-to-peer.ts

@@ -1,4 +1,5 @@
-import { peerIdFromPeerId } from '@libp2p/peer-id'
+import { publicKeyFromProtobuf } from '@libp2p/crypto/keys'
+import { peerIdFromPublicKey } from '@libp2p/peer-id'
 import { multiaddr } from '@multiformats/multiaddr'
 import { Peer as PeerPB } from '../pb/peer.js'
 import type { PeerId, Peer, Tag } from '@libp2p/interface'
@@ -7,10 +8,8 @@ export function bytesToPeer (peerId: PeerId, buf: Uint8Array): Peer {
   const peer = PeerPB.decode(buf)
 
   if (peer.publicKey != null && peerId.publicKey == null) {
-    peerId = peerIdFromPeerId({
-      ...peerId,
-      publicKey: peerId.publicKey
-    })
+    const publicKey = publicKeyFromProtobuf(peer.publicKey)
+    peerId = peerIdFromPublicKey(publicKey)
   }
 
   const tags = new Map<string, Tag>()

package/src/utils/dedupe-addresses.ts

@@ -1,6 +1,5 @@
-import { CodeError } from '@libp2p/interface'
+import { InvalidParametersError } from '@libp2p/interface'
 import { isMultiaddr, multiaddr } from '@multiformats/multiaddr'
-import { codes } from '../errors.js'
 import type { AddressFilter } from '../index.js'
 import type { Address as AddressPB } from '../pb/peer.js'
 import type { PeerId, Address } from '@libp2p/interface'
@@ -18,7 +17,7 @@ export async function dedupeFilterAndSortAddresses (peerId: PeerId, filter: Addr
     }
 
     if (!isMultiaddr(addr.multiaddr)) {
-      throw new CodeError('Multiaddr was invalid', codes.ERR_INVALID_PARAMETERS)
+      throw new InvalidParametersError('Multiaddr was invalid')
     }
 
     if (!(await filter(peerId, addr.multiaddr))) {

package/src/utils/peer-data-to-datastore-peer.ts

@@ -1,17 +1,16 @@
-import { CodeError } from '@libp2p/interface'
+import { publicKeyToProtobuf } from '@libp2p/crypto/keys'
+import { InvalidParametersError } from '@libp2p/interface'
 import { isMultiaddr } from '@multiformats/multiaddr'
-import { equals as uint8arrayEquals } from 'uint8arrays/equals'
-import { codes } from '../errors.js'
 import type { Peer as PeerPB } from '../pb/peer.js'
 import type { PeerId, PeerData } from '@libp2p/interface'
 
 export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
   if (data == null) {
-    throw new CodeError('Invalid PeerData', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Invalid PeerData')
   }
 
-  if (data.publicKey != null && peerId.publicKey != null && !uint8arrayEquals(data.publicKey, peerId.publicKey)) {
-    throw new CodeError('publicKey bytes do not match peer id publicKey bytes', codes.ERR_INVALID_PARAMETERS)
+  if (data.publicKey != null && peerId.publicKey != null && !data.publicKey.equals(peerId.publicKey)) {
+    throw new InvalidParametersError('publicKey bytes do not match peer id publicKey bytes')
   }
 
   // merge addresses and multiaddrs, and dedupe
@@ -22,7 +21,7 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
       .concat((data.multiaddrs ?? []).map(multiaddr => ({ multiaddr, isCertified: false })))
       .filter(address => {
         if (!isMultiaddr(address.multiaddr)) {
-          throw new CodeError('Invalid mulitaddr', codes.ERR_INVALID_PARAMETERS)
+          throw new InvalidParametersError('Invalid mulitaddr')
         }
 
         if (addressSet.has(address.multiaddr.toString())) {
@@ -42,7 +41,7 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
     protocols: (data.protocols ?? []).sort(),
     metadata: new Map(),
     tags: new Map(),
-    publicKey: data.publicKey,
+    publicKey: data.publicKey != null ? publicKeyToProtobuf(data.publicKey) : undefined,
     peerRecordEnvelope: data.peerRecordEnvelope
   }
 
@@ -52,7 +51,7 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
 
     for (const [key, value] of metadataEntries) {
       if (typeof key !== 'string') {
-        throw new CodeError('Peer metadata keys must be strings', codes.ERR_INVALID_PARAMETERS)
+        throw new InvalidParametersError('Peer metadata keys must be strings')
       }
 
       if (value == null) {
@@ -60,7 +59,7 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
       }
 
       if (!(value instanceof Uint8Array)) {
-        throw new CodeError('Peer metadata values must be Uint8Arrays', codes.ERR_INVALID_PARAMETERS)
+        throw new InvalidParametersError('Peer metadata values must be Uint8Arrays')
       }
 
       output.metadata.set(key, value)
@@ -72,7 +71,7 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
 
     for (const [key, value] of tagsEntries) {
       if (typeof key !== 'string') {
-        throw new CodeError('Peer tag keys must be strings', codes.ERR_INVALID_PARAMETERS)
+        throw new InvalidParametersError('Peer tag keys must be strings')
       }
 
       if (value == null) {
@@ -86,20 +85,20 @@ export function toDatastorePeer (peerId: PeerId, data: PeerData): PeerPB {
       }
 
       if (tag.value < 0 || tag.value > 100) {
-        throw new CodeError('Tag value must be between 0-100', codes.ERR_INVALID_PARAMETERS)
+        throw new InvalidParametersError('Tag value must be between 0-100')
       }
 
       if (parseInt(`${tag.value}`, 10) !== tag.value) {
-        throw new CodeError('Tag value must be an integer', codes.ERR_INVALID_PARAMETERS)
+        throw new InvalidParametersError('Tag value must be an integer')
       }
 
       if (tag.ttl != null) {
         if (tag.ttl < 0) {
-          throw new CodeError('Tag ttl must be between greater than 0', codes.ERR_INVALID_PARAMETERS)
+          throw new InvalidParametersError('Tag ttl must be between greater than 0')
         }
 
         if (parseInt(`${tag.ttl}`, 10) !== tag.ttl) {
-          throw new CodeError('Tag ttl must be an integer', codes.ERR_INVALID_PARAMETERS)
+          throw new InvalidParametersError('Tag ttl must be an integer')
         }
       }
 

package/src/utils/peer-id-to-datastore-key.ts

@@ -1,13 +1,12 @@
-import { CodeError } from '@libp2p/interface'
+import { InvalidParametersError } from '@libp2p/interface'
 import { isPeerId, type PeerId } from '@libp2p/interface'
 import { Key } from 'interface-datastore/key'
-import { codes } from '../errors.js'
 
 export const NAMESPACE_COMMON = '/peers/'
 
 export function peerIdToDatastoreKey (peerId: PeerId): Key {
   if (!isPeerId(peerId) || peerId.type == null) {
-    throw new CodeError('Invalid PeerId', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Invalid PeerId')
   }
 
   const b32key = peerId.toCID().toString()

package/src/utils/to-peer-pb.ts

@@ -1,6 +1,5 @@
-import { CodeError } from '@libp2p/interface'
-import { equals as uint8arrayEquals } from 'uint8arrays/equals'
-import { codes } from '../errors.js'
+import { publicKeyToProtobuf } from '@libp2p/crypto/keys'
+import { InvalidParametersError } from '@libp2p/interface'
 import { dedupeFilterAndSortAddresses } from './dedupe-addresses.js'
 import type { AddressFilter } from '../index.js'
 import type { Tag, Peer as PeerPB } from '../pb/peer.js'
@@ -13,17 +12,17 @@ export interface ToPBPeerOptions {
 
 export async function toPeerPB (peerId: PeerId, data: Partial<PeerData>, strategy: 'merge' | 'patch', options: ToPBPeerOptions): Promise<PeerPB> {
   if (data == null) {
-    throw new CodeError('Invalid PeerData', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Invalid PeerData')
   }
 
-  if (data.publicKey != null && peerId.publicKey != null && !uint8arrayEquals(data.publicKey, peerId.publicKey)) {
-    throw new CodeError('publicKey bytes do not match peer id publicKey bytes', codes.ERR_INVALID_PARAMETERS)
+  if (data.publicKey != null && peerId.publicKey != null && !data.publicKey.equals(peerId.publicKey)) {
+    throw new InvalidParametersError('publicKey bytes do not match peer id publicKey bytes')
   }
 
   const existingPeer = options.existingPeer
 
   if (existingPeer != null && !peerId.equals(existingPeer.id)) {
-    throw new CodeError('peer id did not match existing peer id', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('peer id did not match existing peer id')
   }
 
   let addresses: Address[] = existingPeer?.addresses ?? []
@@ -131,6 +130,16 @@ export async function toPeerPB (peerId: PeerId, data: Partial<PeerData>, strateg
     }
   }
 
+  let publicKey: Uint8Array | undefined
+
+  if (existingPeer?.id.publicKey != null) {
+    publicKey = publicKeyToProtobuf(existingPeer.id.publicKey)
+  } else if (data.publicKey != null) {
+    publicKey = publicKeyToProtobuf(data.publicKey)
+  } else if (peerId.publicKey != null) {
+    publicKey = publicKeyToProtobuf(peerId.publicKey)
+  }
+
   const output: PeerPB = {
     addresses: await dedupeFilterAndSortAddresses(peerId, options.addressFilter ?? (async () => true), addresses),
     protocols: [...protocols.values()].sort((a, b) => {
@@ -138,8 +147,7 @@ export async function toPeerPB (peerId: PeerId, data: Partial<PeerData>, strateg
     }),
     metadata,
     tags,
-
-    publicKey: existingPeer?.id.publicKey ?? data.publicKey ?? peerId.publicKey,
+    publicKey,
     peerRecordEnvelope
   }
 
@@ -184,36 +192,36 @@ function createSortedMap <V, R = V> (entries: Array<[string, V | undefined]>, op
 
 function validateMetadata (key: string, value: Uint8Array): void {
   if (typeof key !== 'string') {
-    throw new CodeError('Metadata key must be a string', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Metadata key must be a string')
   }
 
   if (!(value instanceof Uint8Array)) {
-    throw new CodeError('Metadata value must be a Uint8Array', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Metadata value must be a Uint8Array')
   }
 }
 
 function validateTag (key: string, tag: TagOptions): void {
   if (typeof key !== 'string') {
-    throw new CodeError('Tag name must be a string', codes.ERR_INVALID_PARAMETERS)
+    throw new InvalidParametersError('Tag name must be a string')
   }
 
   if (tag.value != null) {
     if (parseInt(`${tag.value}`, 10) !== tag.value) {
-      throw new CodeError('Tag value must be an integer', codes.ERR_INVALID_PARAMETERS)
+      throw new InvalidParametersError('Tag value must be an integer')
     }
 
     if (tag.value < 0 || tag.value > 100) {
-      throw new CodeError('Tag value must be between 0-100', codes.ERR_INVALID_PARAMETERS)
+      throw new InvalidParametersError('Tag value must be between 0-100')
     }
   }
 
   if (tag.ttl != null) {
     if (parseInt(`${tag.ttl}`, 10) !== tag.ttl) {
-      throw new CodeError('Tag ttl must be an integer', codes.ERR_INVALID_PARAMETERS)
+      throw new InvalidParametersError('Tag ttl must be an integer')
     }
 
     if (tag.ttl < 0) {
-      throw new CodeError('Tag ttl must be between greater than 0', codes.ERR_INVALID_PARAMETERS)
+      throw new InvalidParametersError('Tag ttl must be between greater than 0')
     }
   }
 }

package/dist/src/errors.d.ts

@@ -1,4 +0,0 @@
-export declare const codes: {
-    ERR_INVALID_PARAMETERS: string;
-};
-//# sourceMappingURL=errors.d.ts.map

package/dist/src/errors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;;CAEjB,CAAA"}

package/dist/src/errors.js

@@ -1,4 +0,0 @@
-export const codes = {
-    ERR_INVALID_PARAMETERS: 'ERR_INVALID_PARAMETERS'
-};
-//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,sBAAsB,EAAE,wBAAwB;CACjD,CAAA"}

package/dist/typedoc-urls.json

@@ -1,10 +0,0 @@
-{
-  "PersistentPeerStore": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_store.PersistentPeerStore.html",
-  ".:PersistentPeerStore": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_store.PersistentPeerStore.html",
-  "AddressFilter": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.AddressFilter.html",
-  ".:AddressFilter": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.AddressFilter.html",
-  "PersistentPeerStoreComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html",
-  ".:PersistentPeerStoreComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.PersistentPeerStoreComponents.html",
-  "PersistentPeerStoreInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html",
-  ".:PersistentPeerStoreInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_peer_store.PersistentPeerStoreInit.html"
-}

package/src/errors.ts

@@ -1,3 +0,0 @@
-export const codes = {
-  ERR_INVALID_PARAMETERS: 'ERR_INVALID_PARAMETERS'
-}