feat: certified addressbook

.aegir.js

@@ -45,7 +45,7 @@ const after = async () => {
 }
 
 module.exports = {
-  bundlesize: { maxSize: '202kB' },
+  bundlesize: { maxSize: '205kB' },
   hooks: {
     pre: before,
     post: after

doc/API.md

@@ -814,7 +814,9 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
 
 ### peerStore.addressBook.set
 
-Set known `multiaddrs` of a given peer.
+Set known `multiaddrs` of a given peer. This will replace previously stored multiaddrs, if available.
+Replacing stored multiaddrs might result in losing obtained certified addresses, which is not desirable.
+Consider using `addressBook.add()` if you're not sure this is what you want to do.
 
 `peerStore.addressBook.set(peerId, multiaddrs)`
 

src/identify/index.js

@@ -82,9 +82,6 @@ class IdentifyService {
     this._protocols = protocols
 
     this.handleMessage = this.handleMessage.bind(this)
-
-    // TODO: this should be stored in the certified AddressBook in follow up PR
-    this._selfRecord = undefined
   }
 
   /**
@@ -184,22 +181,19 @@ class IdentifyService {
     // Get the observedAddr if there is one
     observedAddr = IdentifyService.getCleanMultiaddr(observedAddr)
 
-    let addresses
-
     try {
       const envelope = await Envelope.openAndCertify(signedPeerRecord, PeerRecord.DOMAIN)
-      const peerRecord = await PeerRecord.createFromProtobuf(envelope.payload)
-
-      addresses = peerRecord.multiaddrs
+      if (this.peerStore.addressBook.consumePeerRecord(envelope)) {
+        this.peerStore.protoBook.set(id, protocols)
+        return
+      }
     } catch (err) {
       log('received invalid envelope, discard it and fallback to listenAddrs is available', err)
-      // Try Legacy
-      addresses = listenAddrs
     }
 
-    // Update peers data in PeerStore
+    // LEGACY: Update peers data in PeerStore
     try {
-      this.peerStore.addressBook.set(id, addresses.map((addr) => multiaddr(addr)))
+      this.peerStore.addressBook.set(id, listenAddrs.map((addr) => multiaddr(addr)))
     } catch (err) {
       log.error('received invalid addrs', err)
     }
@@ -293,21 +287,19 @@ class IdentifyService {
 
     const id = connection.remotePeer
 
-    let addresses
-
     try {
       const envelope = await Envelope.openAndCertify(message.signedPeerRecord, PeerRecord.DOMAIN)
-      const peerRecord = await PeerRecord.createFromProtobuf(envelope.payload)
-
-      addresses = peerRecord.multiaddrs
+      if (this.peerStore.addressBook.consumePeerRecord(envelope)) {
+        this.peerStore.protoBook.set(id, message.protocols)
+        return
+      }
     } catch (err) {
       log('received invalid envelope, discard it and fallback to listenAddrs is available', err)
-      // Try Legacy
-      addresses = message.listenAddrs
     }
 
+    // LEGACY: Update peers data in PeerStore
     try {
-      this.peerStore.addressBook.set(id, addresses.map((addr) => multiaddr(addr)))
+      this.peerStore.addressBook.set(id, message.listenAddrs.map((addr) => multiaddr(addr)))
     } catch (err) {
       log.error('received invalid addrs', err)
     }
@@ -321,9 +313,11 @@ class IdentifyService {
    * @return {Buffer}
    */
   async _getSelfPeerRecord () {
+    const selfSignedPeerRecord = this.peerStore.addressBook.getRawEnvelope(this.peerId)
+
     // TODO: support invalidation when dynamic multiaddrs are supported
-    if (this._selfRecord) {
-      return this._selfRecord
+    if (selfSignedPeerRecord) {
+      return selfSignedPeerRecord
     }
 
     try {
@@ -332,10 +326,9 @@ class IdentifyService {
         multiaddrs: this._libp2p.multiaddrs
       })
       const envelope = await Envelope.seal(peerRecord, this.peerId)
+      this.peerStore.addressBook.consumePeerRecord(envelope)
 
-      this._selfRecord = envelope.marshal()
-
-      return this._selfRecord
+      return this.peerStore.addressBook.getRawEnvelope(this.peerId)
     } catch (err) {
       log.error('failed to get self peer record')
     }

src/index.js

@@ -51,10 +51,11 @@ class Libp2p extends EventEmitter {
 
     this.peerStore = (this.datastore && this._options.peerStore.persistence)
       ? new PersistentPeerStore({
+        peerId: this.peerId,
         datastore: this.datastore,
         ...this._options.peerStore
       })
-      : new PeerStore()
+      : new PeerStore({ peerId: this.peerId })
 
     // Addresses {listen, announce, noAnnounce}
     this.addresses = this._options.addresses