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

@sismo-core/hydra-s2

v1.0.0

Published

Hydra S2 Proving scheme

Downloads

3

Readme

Installation

$ yarn add @sismo-core/hydra-s2

Prover js (HydraS2Prover)


const prover = new HydraS2Prover(
    registryTree,
    commitmentMapperPubKey,
    // + Optional override of the circuit path for ES module (see below for more information)
    {
        wasmPath: "https://[Your server].hydra-s2.wasm",
        zkeyPath: "https://[Your server].hydra-s2.zkey"
    }
); 

| Params | Type | Description | | ---------- | -------------- | ------------- | | registryTree | MerkleTree | Registry Merkle tree that contain the Accounts Merkle tree | | commitmentMapperPubKey | EddsaPublicKey | Pub key of the CommitmentMapper |

To generate the proof, we need to provide a .wasm and a .zkey to the witness calculator. For CommonJS modules we add theses files directly in the package and we resolve the path. For ES module we can't do that, that's why we choose to host files on an S3.

If this solution doesn't suite you or if you want to optimize the download time, you can override S3 paths by adding a third params in the HydraS2Prover constructor and host files wherever you want.

ES modules (which can be overridden)

export const wasmPath = "https://static.sismo.io/hydra-s2-zkps/v1/hydra-s2.wasm";
export const zkeyPath = "https://static.sismo.io/hydra-s2-zkps/v1/hydra-s2.zkey";

CommonJS

export const wasmPath = require.resolve('./hydra-s2.wasm');
export const zkeyPath = require.resolve('./hydra-s2.zkey');

Generate Snark Proof


const source: HydraS2Account = {
    identifier: address,
    secret,
    commitmentReceipt
}

const destination: DestinationInput = {
    identifier: address,
    secret,
    commitmentReceipt,
    chainId: 1,
}

const statement: StatementInput = {
    value?: BigNumberish;
    // A comparator of 0 means the accounts value in the tree can be more than the value in the statement
    // A comparator of 1 means the accounts value in the tree must be equal to the value in the statement
    comparator?: number;
    registryTree: KVMerkleTree;
    accountsTree: KVMerkleTree;
}

const params = {
    vault,
    source,
    destination,
    statement,
    requestIdentifier
}

const snarkProof = await prover.generateSnarkProof(params);

// Generate inputs
// This function is automatically called by generateSnarkProof but you can call it in your tests
const { privateInputs, publicInputs } = await prover.generateInputs(params);

// Throw human readable errors
// This function is automatically called by generateSnarkProof but you can call it in your tests
try {
    await prover.userParamsValidation(params);
} catch (e) {
    console.log(e);
}

| Params | Type | Description | | ---------- | -------------- | ------------- | | source | HydraS2Account | Source account | | destination | HydraS2Account | Destination account | | statementValue | BigNumberish | Must be 0 <= statementValue <= accountValue if statementComparator is false or statementValue = accountValue if statementComparator is true | | chainId | BigNumberish | Chain id | | accountsTree | MerkleTree | Merkle tree constituted which include the source and a value | | requestIdentifier | BigNumberish | proofIdentifier = hash((hash(source.secret, 1), requestIdentifier) | | statementComparator | boolean | Define if the value is strict or not |

export type HydraS2Account = { 
  identifier: BigNumberish,
  secret: BigNumberish,
  commitmentReceipt: [BigNumberish, BigNumberish, BigNumberish]
};

Verifier js (HydraS2Verifier)

import { HydraS2Verifier } from "@sismo-core/hydra-s2";

const isValid = await HydraS2Verifier.verifyProof(snarkProof.a, snarkProof.b, snarkProof.c, snarkProof.input);

Verifier contract (HydraS2Verifier)

import {HydraS2Verifier} from "@sismo-core/hydra-s2/contracts/HydraS2Verifier.sol";

struct ZKProof {
    uint256[2] a;
    uint256[2][2] b;
    uint256[2] c; 
    uint256[10] input; 
}

contract HydraS2Attester {
    HydraS2Verifier internal _verifier;

    error InvalidSnarkProof(uint256[10] publicInputs);

    constructor(
        HydraS2Verifier hydraS2Verifier
    ) {
        _verifier = hydraS2Verifier;
    }

    function attest(ZKProof calldata proof) external {
        if(! _verifier.verifyProof(proof.a, proof.b, proof.c, proof.input)) {
            revert InvalidSnarkProof(proof.input);
        }
    }
}

License

Distributed under the MIT License.

Contribute

Please, feel free to open issues, PRs or simply provide feedback!

Contact

Prefer Discord or Twitter