Interface PeerStore

Returns all peers in the peer store.

Example

for (const peer of await peerStore.all()) {
  // ...
}

Unmarshal and verify a signed peer record, extract the multiaddrs and overwrite the stored addresses for the peer.

Optionally pass an expected PeerId to verify that the peer record was signed by that peer.

Example

await peerStore.consumePeerRecord(buf, expectedPeer)

Delete all data stored for the passed peer

Example

await peerStore.addressBook.set(peerId, multiaddrs)
await peerStore.addressBook.get(peerId)
// multiaddrs[]

await peerStore.delete(peerId)

await peerStore.addressBook.get(peerId)
// []

Loop over every peer - the looping is async because we read from a datastore but the peer operation is sync, this is to prevent long-lived peer operations causing deadlocks over the datastore which can happen if they try to access the peer store during the loop

Example

await peerStore.forEach(peer => {
  // ...
})

Returns all data stored for the passed PeerId

Example

const peer = await peerStore.get(peerId)
// { .. }

Returns true if the passed PeerId is in the peer store

Example

await peerStore.has(peerId)
// false
await peerStore.addressBook.add(peerId, multiaddrs)
await peerStore.has(peerId)
// true

Adds a peer to the peer store, deeply merging any existing data.

Example

await peerStore.merge(peerId, {
  multiaddrs
})

Adds a peer to the peer store, overwriting only the passed fields

Example

await peerStore.patch(peerId, {
  multiaddrs
})

Adds a peer to the peer store, overwriting any existing data

Example

await peerStore.save(peerId, {
  multiaddrs
})