From cd09327eb6906e4c25dbd869839c0dd9c66ae8c5 Mon Sep 17 00:00:00 2001 From: Vasco Santos Date: Wed, 22 Jul 2020 16:31:24 +0200 Subject: [PATCH] chore: add notice for addressBook.set --- doc/API.md | 3 ++- src/peer-store/address-book.js | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/API.md b/doc/API.md index 32a8c96f..78c22385 100644 --- a/doc/API.md +++ b/doc/API.md @@ -814,7 +814,8 @@ 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. `peerStore.addressBook.set(peerId, multiaddrs)` diff --git a/src/peer-store/address-book.js b/src/peer-store/address-book.js index be75698f..9b049aeb 100644 --- a/src/peer-store/address-book.js +++ b/src/peer-store/address-book.js @@ -158,6 +158,8 @@ class AddressBook extends Book { /** * Set known multiaddrs of a provided peer. + * This will replace previously stored multiaddrs, if available. + * Replacing stored multiaddrs might result in losing obtained certified addresses. * @override * @param {PeerId} peerId * @param {Array} multiaddrs