Repository files navigation

A corestore networking module that useshyperswarm to discovery peers. This module powers the networking portion of theHyperspace.

Calls toconfigure will not be persisted across restarts, so you'll need to use a separate database that maps discovery keys to network configurations. The Hyperdrive daemon usesLevel for this.

Since corestore has an all-to-all replication model (any shared cores between two peers will be automatically replicated), only one connection needs to be maintained per peer. If multiple connections are opened to a single peer as a result of that peer announcing many keys, then these connections will be automatically deduplicated by comparing NOISE keypairs.

This module's going through a major change + a rename as part of our push to developHyperspace. With these updates,@corestore/networker and Hyperspace'snetwork APIs are now interchangeable!

If you've previously been usingcorestore-swarm-networking and you'd like to upgrade,UPGRADE.md explains the changes.

npm i @corestore/networker

constNetworker=require('@corestore/networker')constCorestore=require('corestore')constram=require('random-access-memory')conststore=newCorestore(ram)awaitstore.ready()constnetworker=newNetworker(store)// Start announcing or lookup up a discovery key on the DHT.awaitnetworker.configure(discoveryKey,{announce:true,lookup:true})// Stop announcing or looking up a discovery key.networker.configure(discoveryKey,{announce:false,lookup:false})// Shut down the swarm (and unnanounce all keys)awaitnetworker.close()

Creates a new SwarmNetworker that will open replication streams on thecorestore instance argument.

networkOpts is an options map that can include allhyperswarm options (which will be passed to the internal swarm instance) as well as:

{id:crypto.randomBytes(32),// A randomly-generated peer ID,keyPair:HypercoreProtocol.keyPair(),// A NOISE keypair that's used across all connections.onauthenticate:(remotePublicKey,cb)=>{cb()},// A NOISE keypair authentication hookswarm:hyperswarm(),// A hyperswarm instance to use (e.g., hyperswarm-web in the browser)}

The list of currently-connected peers. Each Peer object has the form:

{  remotePublicKey: 0xabc..., // The remote peer's NOISE key.  remoteAddress: '10.23.4...:8080', // The remote peer's host/port.  type: 'tcp' | 'utp', // The connection type  stream // The connection's HypercoreProtocol stream}

Emitted when a new connection has been established withpeer.

Emitted whenpeer's connection has been closed.

Join or leave the swarm with thediscoveryKey argument as the topic.

If this is the first timeconfigure has been called, the swarm instance will be created automatically.

Waits for the topic to be fully joined/left before resolving.

opts is an options map of network configuration options that can include:

  announce:true,// Announce the discovery key on the swarmlookup:true// Look up the discovery key on the swarm,  flush:true// Wait for a complete swarm flush before resolving.

Returnstrue if that discovery key is being swarmed.

Returns true if the swarm has discovered and attempted to connect to all peers announcingdiscoveryKey.

Starts listening for connections on Hyperswarm's default port.

This is called automatically before the first call toconfigure.

Shut down the swarm networker.

This will close all replication streams and then destroy the swarm instance. It will wait for all topics to be unannounced, so it might take some time.

@corestore/networker introduces stream-level extensions that operate on each connection. They adhere to Hypercore'sextension API.

Registers an extension with namename.

Theonmessage andonerror handlers are both optional methods.onerror is an errback, andonmessage must have the signature:

functiononmessage(msg,peer){// `msg` is the (optionally-decoded) message that was received from `peer`.// `peer` is a `Peer` object (described above in `networker.peers`)}

Sendmsg (which will optionally be encoded by the extension's encoding opt) topeer.peer must be a Peer object taken fromnetworker.peers or emitted by the networker'speer-add event.

Broadcastmsg to all currently-connected peers.

Destroy the extension and unregister it from all connections.

MIT