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

@dswarm/discovery

v1.0.0

Published

The dSwarm discovery stack.

Downloads

9

Readme

@dswarm/discovery

The dSwarm peer discovery module

npm install @dswarm/discovery

Usage

const discovery = require('@dswarm/discovery')
const crypto = require('crypto')

const d = discovery()
const key = crypto.randomBytes(32)

const ann = d.announce(key, {
  port: 10000
})

const lookup = d.lookup(key)

// emitted when a peer is found
lookup.on('peer', console.log)

API

d = discovery([options])

Create a new discovery instance

Options include:

{
  // Optionally overwrite the default set of bootstrap servers
  bootstrap: [addresses],
  // Set to false if this is a long running instance on a server
  // When running in ephemeral mode you don't join the DHT but just 
  // query it instead. If unset, or set to a non-boolean (default undefined)
  // then the node will start in short-lived (ephemeral) mode and switch 
  // to long-lived (non-ephemeral) mode after a certain period of uptime
  ephemeral: undefined,
  // Pass in your own udp/utp socket (needed for hole punching)
  socket: (a udp or utp socket)
}

topic = d.lookup(key)

Start looking for peers shared on key, which should be a 32 byte buffer.

  • topic.destroy() - Call this to stop looking for peers
  • topic.update() - Call this to force update
  • topic.on('update') - Emitted when a peer discovery cycle has finished
  • topic.on('peer', peer) - Emitted when a peer is found
  • topic.on('close') - Emitted when this topic is fully closed

It is up to you to call .destroy() when you don't wanna look for anymore peers. Note that the same peer might be emitted multiple times.

An update cycle indicates that you are done querying the DHT and that the topic instance will sleep for a bit (~5-10min) before querying it again

topic = d.announce(key, options)

Start announcing a key. topic has the same API as lookup.

Options include:

{
  // If you set port: 0 the port of the discovery socket is used.
  port: (port you want to announce),
  localPort: (LAN port you wanna announce),
  // Set to true to also do a lookup in parallel.
  // More efficient than calling .lookup() in parallel yourself.
  lookup: false
}

When the topic is destroyed the port will be explicitly unannounced from the network as well

d.lookupOne(key, cb)

Find a single peer and returns that to the callback.

d.ping(cb)

Ping all bootstrap servers. Returns an array of results:

[
  {
    bootstrap: (bootstrap node that replied),
    rtt: (round trip time in ms),
    pong: {
      host: (your ip),
      port: (your port)
    }
  }
]

If your IP and port is consistent across the bootstrap nodes holepunching usually works.

d.holepunch(peer, cb)

UDP holepunch to another peer.

d.flush(cb)

Call the callback when all pending DHT operations are fully flushed.

d.destroy()

Fully destroy the discovery instance, and it's underlying resources. Will also destroy the socket you passed in the constructor.

All running announces will be unannounced as well.

Will emit close when the instance if fully closed.

License

MIT