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

@appliedblockchain/b-privacy

v1.3.0

Published

B Privacy js library, supported runtimes: nodejs, react-native and browser.

Downloads

38

Readme

Summary

B Privacy js library, supported runtimes: nodejs, react-native and browser.

Supports:

  • generating new accounts new B({ mnemonic: B.generateMnemonicPhrase() })
  • restoring accounts from mnemonic new B({ mnemonic })
  • access to mnemonic, private key, public key and ethereum address [a.mnemonic, a.privateKey, a.publicKey, a.address]
  • asymmetric encryption a.encrypt(msg, b.publicKey)
  • asymmetric decryption b.decrypt(msg, a.publicKey)
  • signing a.ecsign(B.keccak256(msg))
  • deriving address from public key B.publicKeyToAddress(publicKey)
  • See usage for examples

Conventions

We call bytes any byte representation: buffer, hex0x or hex.

bytesTo* family functions convert from one of known byte representations to specified one.

to* family functions will try to convert from any input into desired byte representation, when possible making the same conversions as seen in solidity, ie.:

toBuffer('hello') // returns buffer with utf8 representation of the input string
toBuffer(true) // returns 32 byte, big-endian number 1
toBuffer(false) // returns 32 byte number 0
toBuffer(null) // throws
toBuffer('0x01') // returns one byte buffer
toBuffer('ffff') // returns two byte buffer

Installation

npm i --save @appliedblockchain/b-privacy

Usage

const assert = require('assert')
const B = require('@appliedblockchain/b-privacy')

const simon = new B({ mnemonic: B.generateMnemonicPhrase() })

// sign a message from an account
const helloHash = B.keccak256('hello')
const helloSig = simon.ecsign(helloHash)

// verify that i said hello
const didISayHello = simon.ecverify(helloHash, helloSig)
assert.equal(didISayHello, true)

// anyone can verify i said hello if they have my publicKey or address
const recoveredPublicKey = B.ecrecover(helloHash, helloSig)
assert.equal(recoveredPublicKey, simon.getPublicKey())
const recoveredAddress = B.ecrecoverAddress(helloHash, helloSig)
assert.equal(recoveredAddress, simon.address)

const mike = new B({ mnemonic: B.generateMnemonicPhrase() })
const hiMike = simon.encrypt({
  message: 'hello',
  another: 'key'
}, mike.publicKey)

const mikesMessage = mike.decrypt(hiMike, simon.publicKey)
assert.deepEqual(mikesMessage, { message: 'hello', another: 'key' })

const helloEveryone = { hello: 'everyone!' }
const [ sharedBlob, readerBlob ] = simon.encryptShared(helloEveryone)

// i can decrypt my own shared message, other people can't without calling shareSecret
assert.deepEqual(simon.decryptShared(sharedBlob, readerBlob), helloEveryone)

// providing a mnemonic is optional, if nothing provided then one will be generated
const bob = new B()
const bobReaderBlob = simon.shareSecret(readerBlob, bob.publicKey)

// bob can now decrypt the shared message
const bobsMessage = bob.decryptShared(sharedBlob, bobReaderBlob)
assert.deepEqual(bobsMessage, helloEveryone)

// bob can now pass the message on securely
const alice = new B()
const aliceReaderBlob = bob.shareSecret(bobReaderBlob, alice.publicKey)

const alicesMessage = alice.decryptShared(sharedBlob, aliceReaderBlob)
assert.deepEqual(alicesMessage, helloEveryone)

For more usage examples please refer to tests in test directory.


We'll need to clean-up below docs

Blockchain Privacy JS library

Provides an easy way to interact with keys and sign messages (note: storage of keys should be handled outside this library)

Development

npm run dev

Build

Package the library for release (browser/node)

npm run build

Testing

npm test

or:

npm i -g jest

jest

Browser Usage

Please require dist/b-privacy.js, that's the browser-ready version.

You also need to include bitcore-lib manually before that. See test/browser.index.html for a working example.

To make the example work you need to build bitcore-lib for the browser, run:

cd node_modules/bitcore-lib
npm i
gulp browser