Skip to content

Commit 7681a19

Browse files
vasco-santosjacobheun
authored andcommitted
chore: add notice for addressBook.set
1 parent c7e93a5 commit 7681a19

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

doc/API.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -814,7 +814,8 @@ peerStore.addressBook.getMultiaddrsForPeer(peerId)
814814

815815
### peerStore.addressBook.set
816816

817-
Set known `multiaddrs` of a given peer.
817+
Set known `multiaddrs` of a given peer. This will replace previously stored multiaddrs, if available.
818+
Replacing stored multiaddrs might result in losing obtained certified addresses, which is not desirable.
818819

819820
`peerStore.addressBook.set(peerId, multiaddrs)`
820821

src/peer-store/address-book.js

+2
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ class AddressBook extends Book {
158158

159159
/**
160160
* Set known multiaddrs of a provided peer.
161+
* This will replace previously stored multiaddrs, if available.
162+
* Replacing stored multiaddrs might result in losing obtained certified addresses.
161163
* @override
162164
* @param {PeerId} peerId
163165
* @param {Array<Multiaddr>} multiaddrs

0 commit comments

Comments
 (0)