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

proof-of-work

v3.3.2

Published

SHA256 + Bloom filter proof of work

Downloads

7,430

Readme

proof-of-work

Build Status NPM version

Proof of work based on SHA256 and Bloom filter.

Usage

Solver:

const pow = require('proof-of-work');

const solver = new pow.Solver();

// complexity=13 prefix=abcd
const prefix = Buffer.from('abcd', 'hex');
const nonce = solver.solve(13, /* optional */ prefix);
console.log(nonce);

Verifier:

const pow = require('proof-of-work');

const verifier = new pow.Verifier({
  // bit-size of Bloom filter
  size: 1024,

  // number of hash functions in a Bloom filter
  n: 16,

  // target complexity
  complexity: 19,

  // **recommended, but optional** nonce prefix
  // It is highly suggested to use unique nonce prefix for your application
  // to avoid nonce-reuse attack
  prefix: Buffer.from('abcd', 'hex'),

  // nonce validity time (default: one minute)
  validity: 60000
});

// Remove stale nonces from Bloom filter
setInterval(() => {
  verifier.reset();
}, 60000);

verifier.check(nonce);

// Optionally, complexity may be raised/lowered in specific cases
verifier.check(nonce, 21);

CLI

$ npm install -g proof-of-work

$ proof-of-work -h
Usage: proof-of-work [prefix] <complexity>                - generate nonce
       proof-of-work verify [prefix] <complexity> [nonce] - verify nonce

$ proof-of-work 20
0000015cb7756da0812e3b723dcdcfbd

$ proof-of-work verify 20 \
    0000015cb7756da0812e3b723dcdcfbd && \
    echo success
success

$ proof-of-work 13 | proof-of-work verify 13 && echo success
success

$ proof-of-work 0 | proof-of-work verify 32 || echo failure
failure

Technique

The generated nonce must have following structure:

[ Unsigned 64-bit Big Endian timestamp ] [ ... random bytes ]

Timestamp MUST be equal to number of milliseconds since 1970-01-01T00:00:00.000Z in UTC time.

Verifier has two Bloom filters: current and previous, and operates using following algorithm:

  1. Check that 8 < nonce.length <= 32 (byte length)
  2. Check that timestamp is within validity range: Math.abs(timestamp - Date.now()) <= validity
  3. Look up nonce in both Bloom filters. If present in any of them - fail
  4. Compute SHA256(prefix ++ nonce) and check that N = complexity most-significant bits (in Big Endian encoding) are zero
  5. Add nonce to the current Bloom filter

verifier.reset() copies current Bloom filter to previous, and resets current Bloom filter.

Complexity

Here is a chart of average time in seconds to solution vs target complexity:

timing

LICENSE

This software is licensed under the MIT License.

Copyright Fedor Indutny, 2017.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.