chore: add notice for addressBook.set

This commit is contained in:
Vasco Santos
2020-07-22 16:31:24 +02:00
committed by Jacob Heun
parent ca57e65ecc
commit cd09327eb6
2 changed files with 4 additions and 1 deletions

View File

@@ -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)`