feat: example full flow of using aligned (#482)

Co-authored-by: Mariano A. Nicolini <[email protected]>
Co-authored-by: Mauro Toscano <[email protected]>

Author: 3 people

.gitmodules

@@ -7,3 +7,9 @@
 [submodule "examples/verify/lib/forge-std"]
 	path = examples/verify/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "examples/zkquiz/contracts/lib/forge-std"]
+	path = examples/zkquiz/contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "examples/zkquiz/contracts/lib/openzeppelin-contracts"]
+	path = examples/zkquiz/contracts/lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

examples/zkquiz/.gitignore

@@ -0,0 +1,18 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+# Python
+venv
+__pycache__

examples/zkquiz/Makefile

@@ -0,0 +1,39 @@
+deps: venv
+
+venv: venv/touchfile
+
+venv/touchfile: requirements.txt
+	@python3 -m venv venv
+	@. venv/bin/activate && pip install -r requirements.txt
+	@touch venv/touchfile
+
+deploy_verifier:
+	@./contracts/deploy.sh
+
+answer_quiz:
+	@cd quiz/script && cargo run -r
+
+ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+
+submit_proof:
+	@aligned submit \
+    --proving_system SP1 \
+    --proof quiz/script/proof-with-io.json \
+    --vm_program quiz/program/elf/riscv32im-succinct-zkvm-elf \
+    --proof_generator_addr $(ADDRESS) \
+    --conn wss://batcher.alignedlayer.com
+
+CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
+RPC_URL=https://ethereum-holesky-rpc.publicnode.com
+VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json
+PRIVATE_KEY=ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+
+encode_verification_data: venv
+	@. venv/bin/activate; python3 encode_verification_data.py --aligned-verification-data $(VERIFICATION_DATA)
+
+verify_and_get_reward: venv
+	@cast send \
+		--rpc-url $(RPC_URL) \
+		--private-key $(PRIVATE_KEY) \
+		$(CONTRACT_ADDRESS) \
+		$(shell source venv/bin/activate && python3 encode_verification_data.py --aligned-verification-data $(VERIFICATION_DATA))

examples/zkquiz/README.md

@@ -0,0 +1,41 @@
+# ZK Aligned Quiz
+
+## Requirements
+
+1. [Rust](https://www.rust-lang.org/tools/install)
+2. [Python](https://www.python.org/downloads/)
+3. [Aligned](https://github.com/yetanotherco/aligned_layer)
+4. [Foundry](https://getfoundry.sh)
+
+## Usage
+
+First, install dependencies by running:
+```bash
+make deps
+```
+This will create a virtual environment and install python dependencies.
+
+To answer quiz and generate proof run:
+```bash
+make answer_quiz
+```
+
+This will ask questions and generate a proof if you answer correctly.
+
+To submit the proof to aligned for verification run:
+```bash
+make submit_proof ADDRESS=<your_address>
+```
+
+Make sure to use your own address as this is the address that will receive the reward.
+
+Head to [Aligned Explorer](https://explorer.alignedlayer.com/batches) and wait for the batch to be verified.
+
+Then to verify the proof was verified on aligned, and mint your nft run:
+```bash
+make verify_and_get_reward VERIFICATION_DATA=<path_to_aligned_verification_data> PRIVATE_KEY=<your_private_key>
+```
+Note that the path to your proof verification data will be printed out when you submit the proof.
+
+This will verify the proof and mint your nft. 
+You can check your nft on the [Chainlens Explorer](https://holesky.chainlens.com/nfts/0x8dB9e6f1393c3486F30181d606312ec632189621).

examples/zkquiz/contracts/.env.example

@@ -0,0 +1,4 @@
+RPC_URL=<rpc_url>
+PRIVATE_KEY=<private_key>
+ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
+ETHERSCAN_API_KEY=<etherscan_api_key>

examples/zkquiz/contracts/.gitignore

@@ -0,0 +1,12 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+broadcast
+
+# Docs
+docs/
+
+# Dotenv file
+.env

examples/zkquiz/contracts/deploy.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# cd to the directory of this script so that this can be run from anywhere
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" || exit 1 ; pwd -P )
+
+# At this point we are in examples/zkquiz
+cd "$parent_path" || exit 1
+
+source .env
+
+if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
+    echo "ALIGNED_SERVICE_MANAGER_ADDRESS is not set. Please set it in .env"
+    exit 1
+fi
+
+if [ -z "$RPC_URL" ]; then
+    echo "RPC_URL is not set. Please set it in .env"
+    exit 1
+fi
+
+if [ -z "$PRIVATE_KEY" ]; then
+    echo "PRIVATE_KEY is not set. Please set it in .env"
+    exit 1
+fi
+
+forge install
+
+forge script script/Deployer.s.sol \
+    "$ALIGNED_SERVICE_MANAGER_ADDRESS" \
+    --rpc-url "$RPC_URL" \
+    --private-key "$PRIVATE_KEY" \
+    --verify \
+    --etherscan-api-key "$ETHERSCAN_API_KEY" \
+    --broadcast \
+    --sig "run(address _alignedServiceManager)"

examples/zkquiz/contracts/foundry.toml

@@ -0,0 +1,7 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+remappings = ["@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/"]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options