npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dwebstore-swarm-networking

v2.0.0

Published

A dwebstore networker based on dwebswarm

Downloads

2

Readme

dwebstore-swarm-networking

Build Status

A dwebstore networking module that uses dwebswarm to discovery peers. This module powers the networking portion of the patriotsve daemon.

Calls to seed or unseed will not be persisted across restarts, so you'll need to use a separate dwebxabase that maps discovery keys to network configurations. The patriotsve daemon uses Level for this.

Since dwebstore 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.

Installation

npm i dwebstore-swarm-networking -g

Usage

const SwarmNetworker = require('dwebstore-swarm-networking')
const dwebstore = require('dwebstore')
const ram = require('random-access-memory')

const store = new dwebstore(ram)
await store.ready()

const networker = new SwarmNetworker(store)

// Start announcing or lookup up a discovery key on the DHT.
await networker.join(discoveryKey, { announce: true, lookup: true })

// Stop announcing or looking up a discovery key.
networker.leave(discoveryKey)

// Shut down the swarm (and unnanounce all keys)
await networker.close()

API

const networker = new SwarmNetworker(dwebstore, networkingOptions = {})

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

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

{
  id: crypto.randomBytes(32), // A randomly-generated peer ID,
  keyPair: ddatabaseProtocol.keyPair(), // A NOISE keypair that's used across all connections.
}

await networker.join(discoveryKey, opts = {})

Join the swarm with the discoveryKey argument as the topic.

If this is the first time a join or leave has been called, the swarm instance will be created automatically.

Waits for the topic to be fully joined before resolving.

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

  announce: true, // Announce the discovery key on the swarm
  lookup: true  // Look up the discovery key on the swarm

networker.joined(discoveryKey)

Returns true if that discovery key is being swarmed.

networker.flushed(discoveryKey)

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

await networker.leave(discoveryKey)

Stop announcing or looking up the discovery key topic.

Waits for the key to be fully unannounced before resolving.

await networker.close()

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.

License

MIT