Alex Potsides 978eb3676f
feat: async peerstore backed by datastores (#1058)
We have a peerstore that keeps all data for all observed peers in memory with no eviction.

This is fine when you don't discover many peers but when using the DHT you encounter a significant number of peers so our peer storage grows and grows over time.

We have a persistent peer store, but it just periodically writes peers into the datastore to be read at startup, still keeping them in memory.

It also means a restart doesn't give you any temporary reprieve from the memory leak as the previously observed peer data is read into memory at startup.

This change refactors the peerstore to use a datastore by default, reading and writing peer info as it arrives.  It can be configured with a MemoryDatastore if desired.

It was necessary to change the peerstore and *book interfaces to be asynchronous since the datastore api is asynchronous.

BREAKING CHANGE: `libp2p.handle`, `libp2p.registrar.register` and the peerstore methods have become async
2022-01-20 12:03:35 +00:00
..
2020-01-24 14:40:40 +01:00
2021-08-20 09:13:21 +02:00
2021-08-20 09:13:21 +02:00
2020-01-24 14:40:40 +01:00

Private Networking

This example shows how to set up a private network of libp2p nodes.

Setup

  1. Install the modules in the libp2p root directory, npm install.

Run

Running the example will cause two nodes with the same swarm key to be started and exchange basic information.

node index.js

Using different keys

This example includes TASK comments that can be used to try the example with different swarm keys. This will allow you to see how nodes will fail to connect if they are on different private networks and try to connect to one another.

To change the swarm key of one of the nodes, look through index.js for comments starting with TASK to indicate where lines are that pertain to changing the swarm key of node 2.

Exploring the repos

Once you've run the example you can take a look at the repos in the ./tmp directory to see how they differ, including the swarm keys. You should see a swarm.key file in each of the repos and when the nodes are on the same private network this contents of the swarm.key files should be the same.