zkverify

https://github.com/zkverify/zkverify-docs
Admin
This project documents the zkverify platform, a system built with Docusaurus for generating static...
Tokens:102,184
Snippets:367
Trust Score:7.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install jq on Linux

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Installs the jq tool on Debian-based Linux distributions using apt.

```bash
sudo apt install jq
```

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

### Install jq on macOS

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Installs the jq tool on macOS using Homebrew.

```bash
brew install jq
```

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

### Install Clang Compiler

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Installs the 'clang' compiler, which is a dependency for certain build processes.

```bash
sudo apt install clang
```

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

### Install Rustup

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Installs the Rustup toolchain manager for Rust programming language. This is a prerequisite for building zkVerify.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

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

### Install Protobuf Compiler

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Installs the 'protoc' compiler, required for processing Protocol Buffers definitions used in the project.

```bash
sudo apt install protobuf-compiler
```

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

### zkVerify Repository Branches

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/03-add-new-verifier/02-getting_started.md

Provides links to the specific branches in the zkVerify GitHub repository for WASM and NATIVE implementations, useful for following the tutorial.

```bash
git clone https://github.com/zkVerify/zkVerify.git
cd zkVerify
git checkout docs/new_verifier_tutorial_wasm  # For WASM implementation
# or
git checkout docs/new_verifier_tutorial_native # For NATIVE implementation
```

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

### Install gnu-sed on macOS

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Installs the gnu-sed tool on macOS using Homebrew.

```bash
brew install gsed
```

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

### Initialize zkVerify Environment

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

The `init.sh` script is the primary tool for preparing the zkVerify environment. It guides the user through requirement collection and file preparation. For Windows users, ensure Docker is running and that `.sh` scripts can be executed, preferably by installing Git.

```shell
#!/bin/bash
# This script initializes the zkVerify environment.
# It collects requirements and prepares necessary files.

# Example usage:
# ./scripts/init.sh
```

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

### Clone zkVerify Repository

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Clones the zkVerify repository from GitHub. It's recommended to use the latest tag for the most updated software.

```bash
git clone --branch latest_tag https://github.com/zkVerify/zkVerify.git
```

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

### Project Setup Commands

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/05-relayer.md

Commands to create a new project directory, navigate into it, initialize an NPM project, and install necessary dependencies like axios and dotenv.

```bash
mkdir proof-submission
cd proof-submission
npm init -y && npm pkg set type=module
npm i axios dotenv
```

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

### Project Setup and Package Installation

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/02-galxe-identity.md

Commands to create a new project directory, navigate into it, and initialize npm with module support, followed by installing the required packages for the Galxe Identity Protocol with zkVerifyJS.

```bash
# This will create a new directory for our project
mkdir galxe-identity-zkVerify

# Moving inside our directory
cd galxe-identity-zkVerify

# Initializing our project
npm init -y && npm pkg set type=module

```

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

### zkv-relay Build-Spec

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Allows the creation of chain-spec files for the zkVerify network. Use the --help flag for detailed options.

```bash
target/production/zkv-relay build-spec --help
```

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

### zkv-relay Help Command

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Displays detailed descriptions for all command-line arguments supported by the zkv-relay node. This is useful for understanding the full range of configuration options available.

```bash
target/production/zkv-relay --help
```

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

### Clean Build Artifacts

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Cleans the build workspace by removing previous build outputs. This is useful for starting a fresh build.

```bash
cargo clean
```

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

### Check Docker Version

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Verifies if Docker is installed and its version. This is a prerequisite for running zkVerify with Docker.

```bash
docker --version
```

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

### Clone zkVerify Compose Repository

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Clones the zkVerify compose repository from GitHub. It allows checking out a specific branch, recommended to use the latest tag.

```bash
git clone --branch latest_tag https://github.com/zkVerify/compose-zkverify-simplified.git
```

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

### Check jq Tool Availability

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Checks if the jq tool is installed on the system. jq is a lightweight and flexible command-line JSON processor.

```bash
jq --version
```

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

### Build zkVerify Binaries (Production)

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Builds the zkVerify node binaries for production. This command compiles the 'zkv-relay' crate with the 'production' profile.

```bash
cargo build -p zkv-relay --profile production
```

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

### Add Rust Source and Wasm Target

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Adds the Rust source code and the Wasm target to the Rust toolchain, which are necessary for building.

```bash
rustup component add rust-src
rustup target add wasm32-unknown-unknown
```

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

### Check Docker Compose Version

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Verifies if Docker Compose is installed and its version. This is a prerequisite for running zkVerify with Docker.

```bash
docker compose version
```

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

### zkVerify Docker Image

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

The `horizenlabs/zkverify` Docker image contains the zkVerify software, ensuring consistent execution across different platforms. The recommended tag is `latest`. The image can be automatically downloaded by Docker Compose or built from the provided Dockerfile.

```docker
FROM ubuntu:latest

# Install dependencies and zkVerify software here

# Example: RUN apt-get update && apt-get install -y <dependencies>
# Example: COPY . /app
# Example: WORKDIR /app

# Recommended tag: latest
# Dockerfile location: https://github.com/zkVerify/zkVerify/blob/main/docker/dockerfiles/hl-node.Dockerfile
```

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

### Install noirup

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Installs the Noir language server and tooling using the noirup script.

```bash
curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash
```

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

### Project Setup and Package Installation

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/01-zkemail.md

Commands to create a new project directory, initialize npm, set the module type, and install the necessary packages: @zk-email/sdk and zkverifyjs.

```bash
# This will create a new directory for our project
mkdir zkEmail-zkVerify

# Moving inside our directory
cd zkEmail-zkVerify

# Initializing our project
npm init -y && npm pkg set type=module

# Installing required packages
npm i @zk-email/sdk zkverifyjs
```

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

### Start a zkverify RPC Node

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/02-run_rpc_node.md

Example command to start a zkverify RPC node with specified configurations for name, data path, chain, ports, external access, CORS, methods, and pruning.

```bash
target/production/zkv-relay --name MyZkVerifyRpcNode --base-path /home/your_user/rpc_node_data --chain test --port 30555 --rpc-port 9944 --rpc-external --rpc-cors all --rpc-methods safe --pruning archive
```

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

### zkv-relay Key Management

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Provides utilities for managing account and node keys. Subcommands include 'generate', 'inspect', 'insert' for account keys, and 'generate-node-key', 'inspect-node-key' for node keys.

```bash
target/production/zkv-relay key --help
```

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

### Install bbup

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Installs the Barretenberg backend (bbup) for Noir, required for proof generation.

```bash
curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash
```

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

### Install Noir and Barretenberg Backend

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Installs the Noir toolkit using noirup and the Barretenberg backend using bbup. These are essential for generating Noir proofs.

```bash
curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash
noirup
curl -L https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/master/barretenberg/bbup/install | bash
bbup -v <version>
```

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

### zkv-relay Common Command-Line Arguments

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Details common command-line arguments for zkv-relay nodes, including their purpose, expected values, and usage. These arguments are essential for setting up the node regardless of its specific role.

```APIDOC
zkv-relay Common Configuration:

--name <name>
  Description: The human-readable name for this node. It's used as the network node name.
  Value: Whatever you want.

--base-path <path>
  Description: Specify custom base path.
  Value: Absolute or relative path.

--chain <chain_spec>
  Description: Specify the chain specification. It can be one of the predefined ones (dev, local, or staging) or a path to a file with the chainspec.
  Value: `test` for joining zkVerify testnet.

--port <port_number>
  Description: Specify p2p protocol TCP port.
  Value: Any number, but make sure the port is not already in use on your machine.
```

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

### Build zkVerify Binaries (Debug)

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/01-getting_started_binaries.md

Builds the zkVerify node binaries for debugging purposes. This command compiles the 'zkv-relay' crate without a specific profile, defaulting to debug.

```bash
cargo build -p zkv-relay
```

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

### Verifier Library Structure

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/03-add-new-verifier/02-getting_started.md

Describes the typical components of a verifier library, including verification key, raw proof, public inputs, and the verification function. It also highlights the importance of `no_std` compatibility for WASM integration.

```rust
struct Verifier {
    vk: Vec<u8>,
    proof: Vec<u8>,
    pubs: Vec<u8>,
}

fn verify(verifier: &Verifier) -> bool {
    // Implementation details...
    true
}
```

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

### Install Dependencies (Yarn)

Source: https://github.com/zkverify/zkverify-docs/blob/main/README.md

Installs project dependencies using Yarn. This is typically the first step before running any other commands.

```shell
yarn
```

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

### zkv-relay Command for Boot Node

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/03-run_using_binaries/03-run_boot_node.md

Example command to start a zkverify boot node using the zkv-relay binary. This command specifies the node's name, data path, chain, port, and listen addresses for both p2p and p2p/ws connections.

```bash
target/production/zkv-relay --name MyZkVerifyBootNode --base-path /home/your_user/boot_node_data --chain test --port 30333 --listen-addr /ip4/0.0.0.0/tcp/30333 --listen-addr /ip4/0.0.0.0/tcp/30334/ws
```

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

### Install Dependencies

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/10-tutorials/02-nextjs-noir.md

Installs necessary packages for the NextJS application, including axios, Noir.js, and bb.js.

```bash
cd your-project-name
npm i axios @noir-lang/noir_js@1.0.0-beta.6 @aztec/bb.js@0.84.0
```

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

### Running the Next.js Application

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/10-tutorials/02-nextjs-noir.md

This command starts the Next.js development server, allowing you to view and interact with the zkVerify application.

```bash
npm run dev
```

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

### Install zkVerify SDK Packages

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/02-galxe-identity.md

Installs the necessary SDK packages using npm for integration with your project.

```bash
npm i @galxe-identity-protocol/sdk ethers zkverifyjs
```

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

### Start Local Development Server (Yarn)

Source: https://github.com/zkverify/zkverify-docs/blob/main/README.md

Starts the Docusaurus development server, allowing for live preview of website changes. Changes are reflected without a server restart.

```shell
yarn start
```

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

### Install zkVerifyJS and dotenv

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/06-zkverify-js.md

Installs the necessary zkverifyjs and dotenv packages for Node.js projects. Ensures your project can interact with zkVerify services and manage environment variables.

```bash
npm i zkverifyjs dotenv
```

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

### Check gnu-sed Version on macOS

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/02-run_using_docker/01-getting_started_docker.md

Checks if the gnu-sed tool is installed on macOS. This is required for certain operations on macOS.

```bash
gsed --version
```

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

### Create Noir Project

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Creates a new Noir project with a default 'hello_world' template.

```bash
nargo new hello_world
```

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

### Initialize Risc0 Project

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Creates a new Risc0 project with a specified guest name and navigates into the project directory.

```bash
cargo risczero new hasher --guest-name hasher_guest
cd hasher
```

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

### Create a new Noir project

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Creates a new Noir project named 'hello_world' using the nargo CLI. This project will be used to generate proofs.

```bash
nargo new hello_world
```

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

### zkVerify Node Hardware Requirements

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/node-operators/01-getting_started.md

Specifies the minimum hardware requirements for running RPC, Boot, and Validator nodes in the zkVerify network, including CPU, memory, bandwidth, and storage.

```markdown
| Requirement           | RPC node                                  | Boot node | Validator node |
|-----------------------|-------------------------------------------|-----------|----------------|
| Core                  | 4                                         | 4         | 8              |
| Threads per core      | 2                                         | 2         | 2              |
| Clock speed (GHz)     | ≥ 2.5                                     | ≥ 2.2     | ≥ 3.5          |
| Memory (GiB)          | 16                                        | 16        | 32             |
| Bandwidth (Gbps)      | ≥ 1                                       | ≥ 1       | ≥ 1            |
| Storage Fast NVMe(GB) | ≥ 500 (archive)<br/> ≥ 200 (with pruning) | ≥ 100     | ≥ 500          |
```

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

### Importing Proof Files (Risc Zero)

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/05-relayer.md

Loads the proof file for the Risc Zero proving system, following the structure from the Risc Zero tutorial.

```javascript
const proof = JSON.parse(fs.readFileSync("../my_project/proof.json")); // Following the Risc Zero tutorial
```

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

### Initialize SDK and Constants

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/02-galxe-identity.md

Imports required modules from '@galxe-identity-protocol/sdk' and 'zkverifyjs', sets up the Ethereum mainnet RPC provider, and defines a dummy issuer EVM address for testing.

```javascript
import { prepare, credential, evm, credType, errors, user, issuer, utils, babyzkTypes } from "@galxe-identity-protocol/sdk";
import { ethers } from "ethers";
import { CurveType, Library, ZkVerifyEvents, zkVerifySession } from "zkverifyjs";

const unwrap = errors.unwrap;

const MAINNET_RPC = "https://1rpc.io/eth";

const provider = new ethers.JsonRpcProvider(MAINNET_RPC);

// This is a dummy issuer's EVM address that has been registered on mainnet.
// Because it authroize the private key that is public to everyone,
// it should not be used in production!
const dummyIssuerEvmAddr = "0x15f4a32c40152a0f48E61B7aed455702D1Ea725e";
```

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

### Run Project to Generate ZK Proofs

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/03-tee-proof.md

Commands to set up the environment and run the compiled project to generate ZK proofs.

```bash
source .env
./target/release/zkverify-tee-r0
```

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

### Build the Risc0 Project

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Builds the Risc0 project in release mode from the terminal.

```bash
cargo build --release
```

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

### Test Runtime Benchmarks

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/03-add-new-verifier/04-runtime_inclusion/02-hands_on.md

Command to build the source code and run tests and benchmarks, ensuring the integrated pallet functions correctly.

```bash
cargo test --features=runtime-benchmarks
```

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

### Importing Proof Files (SP1)

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/05-relayer.md

Loads the proof file for the SP1 proving system, following the structure from the SP1 tutorial.

```javascript
const proof = JSON.parse(fs.readFileSync("../my_project/proof.json")); // Following the SP1 tutorial
```

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

### Verify Node.js and npm Installation

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/04-zkverifyjs.md

Checks if Node.js and npm are installed correctly by displaying their version numbers. This is a prerequisite for using the zkverifyjs package.

```shell
node -v
npm -v
```

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

### Manage bbup versions

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Allows switching to a specific version of bbup, recommended for compatibility with older Noir projects.

```bash
bbup -v <version>
```

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

### Install Dependencies

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/10-tutorials/01-nextjs-circom.md

Installs necessary npm packages, including axios for HTTP requests and snarkjs for ZK proof generation and verification.

```bash
cd your-project-name

npm i axios snarkjs
```

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

### Initialize zkVerify Session

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/06-zkverify-js.md

Starts a zkVerify session using the Volta testnet and authenticates with an account using a seed phrase from environment variables. This prepares the session for submitting proofs.

```javascript
const session = await zkVerifySession.start().Volta().withAccount(process.env.SEED_PHRASE);
```

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

### zkVerify Usage Example

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/09-explorations/02-galxe-identity.md

This TypeScript code snippet demonstrates the usage of zkVerify for issuing a credential, generating a zero-knowledge proof, and verifying it. It serves as a practical example for users following the tutorial.

```typescript
import { useZkVerify } from "@zk-verify/react";

// Example usage within a React component
function MyComponent() {
  const { issueCredential, generateProof, verifyProof } = useZkVerify();

  const handleVerification = async () => {
    try {
      // Assume credentialData and proofRequest are defined elsewhere
      const credential = await issueCredential(credentialData);
      const proof = await generateProof(credential, proofRequest);
      const isValid = await verifyProof(proof);
      console.log("Proof is valid:", isValid);
    } catch (error) {
      console.error("Error during zkVerify process:", error);
    }
  };

  return (
    <button onClick={handleVerification}>Verify Credential</button>
  );
}
```

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

### Groth16 Input Example for Circom Circuit

Source: https://github.com/zkverify/zkverify-docs/blob/main/docs/overview/02-getting-started/04-generating-proof.md

Example input structure for the Circom circuit, specifying the private input 'a' and the public hash 'b'. This is used during circuit compilation and proof generation.

```json
{
   "a": "5",
   "b": "19065150524771031435284970883882288895168425523179566388456001105768498065277"
}
```
Tokens:
Raw