Verifiable JS

JavaScript/TypeScript WebAssembly bindings for the Parity Verifiable crate.

Anonymous membership proofs using ring VRFs on the Bandersnatch elliptic curve. Prove you belong to a group without revealing which member you are.

Full documentation, API reference, and examples: github.com/paritytech/verifiable-js

Installation

npm install verifiablejs

Quick Start

import { member_from_entropy, one_shot, validate } from 'verifiablejs/nodejs'
// or 'verifiablejs/bundler' for browsers

// Create a ring of members
const members = []
for (let i = 0; i < 10; i++) {
  members.push(member_from_entropy(new Uint8Array(32).fill(i)))
}
const encodedMembers = encodeMembers(members) // SCALE-encode (see full docs)

// Create an anonymous ring proof
const entropy = new Uint8Array(32).fill(5)
const context = new TextEncoder().encode('my-app')
const message = new TextEncoder().encode('hello')

const result = one_shot(11, entropy, encodedMembers, context, message)

// Verify the proof
const alias = validate(11, result.proof, encodedMembers, context, message)

API Overview

| Function | Description | | ------------------------ | -------------------------------------- | | member_from_entropy | Derive a public key from entropy | | is_member_valid | Check if a public key is valid | | one_shot | Create an anonymous ring proof | | validate | Validate a proof, extract alias | | is_valid | Check proof validity with known alias | | create_multi_context | Proof covering multiple contexts | | validate_multi_context | Validate a multi-context proof | | is_valid_multi_context | Check multi-context proof validity | | batch_validate | Validate multiple proofs efficiently | | alias_in_context | Compute alias without a proof | | sign | Non-anonymous message signature | | verify_signature | Verify a signature | | members_root | Compute ring commitment (768 bytes) | | members_intermediate | Compute intermediate state (848 bytes) |

All ring functions require a domain_size parameter: 11 (~255 members), 12 (~767), or 16 (~16,127).

License

GPL-3.0-or-later WITH Classpath-exception-2.0