[Remix] Zokrates Plugin

yann300 commented 5 years ago

Zokrates Plugin

(subject to change)

Funded $500
See https://github.com/ethberlin-hackathon/ETHBerlin-Teambuilding/blob/master/RemixHackathon.md for more info about the Remix hackathon. Please be sure to read it before starting.
Some infos about Remix: https://remix.readthedocs.io/en/latest/
Online version: http://remix.ethereum.org

We've been releasing an API (available in http://remix-alpha.ethereum.org) which allows developing plugin for Remix. (See https://github.com/ethereum/remix/blob/master/docs/remix_plugin.md and https://github.com/ethereum/remix/blob/master/docs/remix_plugin_api.md) Checkout https://remix-alpha.ethereum.org / settings tab / Oraclize for a live example.

This issue is specifically about developing a Zokrates Plugin.

Proposal for implementation

(You don't need to strictly follow this proposal, we would like to have your feedback) Zokrates is a toolbox that aims at bringing better privacy and scalability to Ethereum using zkSNARKs.

It enables developers to design programs whose correct execution can be checked on chain, optionally hiding some of the inputs fed into the program.

You can watch an introduction to the toolbox, see the code and see an example of ZoKrates program.

This plugin aims to put Zokrates in a JavaScript like environment.

The develop branch will be used to generate the wasm library usable in the browser.

The suggested approach is the following:

Use the zokrates-core crate and check that you can compile it to wasm
The first features to integrate are likely to be compile which you can find in zokrates-code/src/compile.rs. Feel free to set resolve_option to None at first, which will disable import statements in ZoKrates code.
Possibly use the zokrates-wasm-wrapper crate on this (outdated) branch if you need Javascript bindings
Then move to compute-witness which runs the ZoKrates program given inputs

Then we can use the library:

Plugin UI:

should listen on *.code file being displayed, run the compilation, display an error if any, or compilation succeed with infos.
should accept input parameter, and execute the code

Some further tasks:

Move over to setup and generate-proof which are the intensive tasks of the pipeline. You can checkout the work done in this issue HarryR/ethsnarks#7
Write a github resolver to reenable imports, following the example of zokrates_fs_resolver

Team

We are the team behind Remix IDE and related libraries, using this hackathon as a kickstart for the Remix API. We've setup an extended team for helping you during this event

Remix team - @ninabreznik @serapath @ryestew @yann300 @iurimatias
Go team - @ligi @holiman
Solidity team - @leonardoalt @chriseth
C++, ewasm - @chfast @axic

Beside normal funding, we will at the end of the event select 4 teams that will receive sponsorship from the Ethereum Foundation.

Be sure to contact us at any time online or grab us directly at the event.

Skills wanted

JavaScript / Ethereum

Communication

We will be around giving advice and helping if needed. And in any case just drop your thoughts there ;)

https://gitter.im/ethereum/remix-dev-plugin

How to get started:

Clone https://github.com/yann300/remix-plugin , go to src folder
Serve the folder through local web server
Go to remix-alpha.ethereum.org
Settings tab / Plugin section

Input Description:

{
“title”: “<name of plugin>”,
“url”: “http://127.0.0.1:<port>”
}

Load and Start using it.

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

This issue now has a funding of 500.0 DAI (500.0 USD @ $1.0/DAI) attached to it.

If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
- Want to chip in? Add your own contribution here.
- Questions? Checkout Gitcoin Help or the Gitcoin Slack
- $31,630.88 more funded OSS Work available on the Gitcoin Issue Explorer