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

swarmlog

v1.4.0

Published

create a p2p webrtc swarm around a hyperlog

Downloads

27

Readme

swarmlog

create a p2p webrtc swarm around a hyperlog

example

first generate some ed25519 keys:

$ node -pe "JSON.stringify(require('ssb-keys').generate())" > keys.json

now create a hyperlog publisher that will write a new message every second:

publish.js:

var swarmlog = require('swarmlog')
var memdb = require('memdb')

var log = swarmlog({
  keys: require('./keys.json'),
  sodium: require('chloride/browser'),
  db: memdb(),
  valueEncoding: 'json',
  hubs: [ 'https://signalhub.mafintosh.com' ]
})

var times = 0
setInterval(function () {
  log.append({ time: Date.now(), msg: 'HELLO!x' + times })
  times++
}, 1000)

and a follower that will consume the log:

var swarmlog = require('swarmlog')
var memdb = require('memdb')

var log = swarmlog({
  publicKey: require('./keys.json').public,
  sodium: require('chloride/browser'),
  db: memdb(),
  valueEncoding: 'json',
  hubs: [ 'https://signalhub.mafintosh.com' ]
})

log.createReadStream({ live: true })
  .on('data', function (data) {
    console.log('RECEIVED', data)
  })

api

var swarmlog = require('swarmlog')

var log = swarmlog(opts)

Create a hyperlog instance log from:

  • opts.sodium - a sodium instance: require('sodium') in node or require('chloride/browser') in the browser
  • opts.db - a leveldb instance (use level-browserify in the browser)
  • opts.valueEncoding - valueEncoding to use for the hyperlog
  • opts.hubs - array of signalhub hubs to use
  • opts.publicKey - (or opts.public) - ed25519 public key
  • opts.secretKey - (or opts.private) - ed25519 private key
  • opts.keys - object, another place to put publicKey/public and secretKey/privateKey/private
  • opts.peerStream(peer) - optional function that should return the stream to use for a peer swarm connection. Use this if you want to multiplex some other protocols on the same swarm alongside the hyperlog replication.

Public and private keys are either a hex string, a binary Buffer, or a base64-encoded string ending with '.ed25519' (ssb-keys style).

If opts is a string it will be interpreted as the opts.publicKey for easier following.

Optionally provide a wrtc instance as opts.wrtc to create a swarmlog in node.

log.swarm

the underlying webrtc-swarm instance

log.hub

the underlying signalhub instance

p2p

Currently the swarm relies on signalhub to assist in the webrtc swarm setup, but ideally in the future this could be replaced or augmented with a webrtc DHT.

install

npm install swarmlog

license

BSD