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

@dfares/snarks

v7.1.4

Published

This package contains `.wasm` compiled SNARK circuits and `.zkey` proving/verifier keys for the Dark Forest SNARKs. It also contains typescript types for inputs and outputs to the SnarkJS functions we use to calculate Dark Forest SNARK proofs, as well as

Downloads

12

Readme

@dfares/snarks

This package contains .wasm compiled SNARK circuits and .zkey proving/verifier keys for the Dark Forest SNARKs. It also contains typescript types for inputs and outputs to the SnarkJS functions we use to calculate Dark Forest SNARK proofs, as well as conversion methods that convert between SnarkJS outputs and Dark Forest contract call args.

Installation

You can install this package using npm or yarn by running:

npm install --save @dfares/snarks
yarn add @dfares/snarks

When using this in a plugin, you might want to load it with skypack

import * as snarks from 'http://cdn.skypack.dev/@dfares/snarks';

Table of contents

Interfaces

Type aliases

Functions

Type aliases

BiomebaseSnarkContractCallArgs

Ƭ BiomebaseSnarkContractCallArgs: [[string, string], [[string, string], [string, string]], [string, string], [string, string, string, string, string, string, string]]

Shape of the args for findArtifact DarkForest contract call.


ContractCallArgs

Ƭ ContractCallArgs: RevealSnarkContractCallArgs | InitSnarkContractCallArgs | MoveSnarkContractCallArgs | BiomebaseSnarkContractCallArgs | WhitelistSnarkContractCallArgs

Type representing the shape of args that are passed into DarkForest functions that require zkSNARK verification.


InitSnarkContractCallArgs

Ƭ InitSnarkContractCallArgs: [[string, string], [[string, string], [string, string]], [string, string], [string, string, string, string, string, string, string, string, string]]

Shape of the args for the initializePlayer DarkForest contract call


MoveSnarkContractCallArgs

Ƭ MoveSnarkContractCallArgs: [[string, string], [[string, string], [string, string]], [string, string], [string, string, string, string, string, string, string, string, string, string, string]]

(Almost) shape of the args for move DarkForest contract call. The fourth array element additionally needs shipsMoved, silverMoved, and artifactIdMoved before it can be passed as args to move, but those values are not part of the zkSNARK.


RevealSnarkContractCallArgs

Ƭ RevealSnarkContractCallArgs: [[string, string], [[string, string], [string, string]], [string, string], [string, string, string, string, string, string, string, string, string]]

Shape of the args for revealLocation DarkForest contract call


WhitelistSnarkContractCallArgs

Ƭ WhitelistSnarkContractCallArgs: [[string, string], [[string, string], [string, string]], [string, string], [string, string]]

Shape of the args for whitelistRegister DarkForest contract call.

Functions

buildContractCallArgs

buildContractCallArgs(snarkProof, publicSignals): ContractCallArgs

Method for converting the output of snarkJS fullProve into args that can be passed into DarkForest smart contract functions which perform zk proof verification.

Parameters

| Name | Type | Description | | :-------------- | :------------------------------------------- | :-------------------------------------------------------------------------- | | snarkProof | SnarkJSProof | the SNARK proof | | publicSignals | string[] | the circuit's public signals (i.e. output signals and public input signals) |

Returns

ContractCallArgs