https://github.com/ZoKrates/ZoKrates

A toolbox for zkSNARKs on Ethereum
https://github.com/ZoKrates/ZoKrates

ethereum language snark verifiable-computation zero-knowledge zksnarks

Last synced: 25 days ago
JSON representation

A toolbox for zkSNARKs on Ethereum

• Host: GitHub
• URL: https://github.com/ZoKrates/ZoKrates
• Owner: Zokrates
• License: lgpl-3.0
• Created: 2017-10-23T08:18:23.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-08-01T16:50:35.000Z (4 months ago)
• Last Synced: 2024-11-17T02:35:53.391Z (25 days ago)
• Topics: ethereum, language, snark, verifiable-computation, zero-knowledge, zksnarks
• Language: Rust
• Homepage: https://zokrates.github.io
• Size: 18.1 MB
• Stars: 1,828
• Watchers: 42
• Forks: 361
• Open Issues: 98
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pest - ZoKrates - A toolbox for zkSNARKs on Ethereum. (Projects)

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

Load the ZoKrates Plugin on [Remix](https://remix.ethereum.org) to write your first SNARK program!

Alternatively, you can install the ZoKrates CLI:

```bash

curl -LSfs get.zokrat.es | 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

```

### `{js,json,ts}` formatting

We enforce strict formatting of `.{js,json,ts}` files in CI. This check is not included in the git hooks. If you modify such a file, you can ensure its formatting is correct by running:

```

npm i -g prettier

prettier --write "./**/*.{js,ts,json}" --ignore-path .gitignore

```