https://github.com/scrypt-inc/zokrates

A zero-knowledge proof toolbox on Bitcoin. A fork of zokrates (https://github.com/Zokrates/ZoKrates).
https://github.com/scrypt-inc/zokrates

Last synced: 2 months ago
JSON representation

A zero-knowledge proof toolbox on Bitcoin. A fork of zokrates (https://github.com/Zokrates/ZoKrates).

• Host: GitHub
• URL: https://github.com/scrypt-inc/zokrates
• Owner: sCrypt-Inc
• License: lgpl-3.0
• Created: 2021-06-24T06:12:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-08T18:21:30.000Z (11 months ago)
• Last Synced: 2024-11-05T03:36:36.814Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 13.1 MB
• Stars: 15
• Watchers: 5
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG-scrypt.md
  • License: LICENSE

Awesome Lists containing this project

README

        



# ZoKrates

[![Join the chat at https://gitter.im/ZoKrates/Lobby](https://badges.gitter.im/ZoKrates/Lobby.svg)](https://gitter.im/ZoKrates/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![CircleCI develop](https://img.shields.io/circleci/project/github/Zokrates/ZoKrates/develop.svg?label=develop)](https://circleci.com/gh/Zokrates/ZoKrates/tree/develop)

ZoKrates is a toolbox for zkSNARKs on Ethereum.

_This is a proof-of-concept implementation. It has not been tested for production._

## Getting Started

Install the ZoKrates CLI:

```bash

curl -Ls https://scrypt.io/scripts/setup-zokrates.sh | sh

```

Have a look at the [documentation](https://zokrates.github.io/) for more information about using ZoKrates.

[Get started](https://zokrates.github.io/gettingstarted.html), then try a [tutorial](https://zokrates.github.io/examples/rng_tutorial.html)!

## Getting Help

If you run into problems, ZoKrates has a [Gitter](https://gitter.im/ZoKrates/Lobby) room.

## License

ZoKrates is released under the GNU Lesser General Public License v3.

## Contributing

We happily welcome contributions. You can either pick an existing issue or reach out on [Gitter](https://gitter.im/ZoKrates/Lobby).

Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in the work shall be licensed as above, without any additional terms or conditions.

### Git Hooks

You can enable zokrates git hooks locally by running:

```sh

git config core.hooksPath .githooks

```

### Workflow

A circuit:

```python

def main(private field p, private field q, field n) {

    assert(p * q == n);

    assert(p > 1);

    assert(q > 1);

    return;

}

```

```bash

zokrates compile -i root.zok

# perform the setup phase

zokrates setup

# execute the program

zokrates compute-witness -a 2 2 4

# generate a proof of computation

zokrates generate-proof

# export an sCrypt verifier

zokrates export-verifier-scrypt

# or verify natively

zokrates verify

```

-------------------------

[1] we use bellman as default backend.