{"id":25633071,"url":"https://github.com/zkemail/email-gpu-prover","last_synced_at":"2025-07-24T21:33:51.760Z","repository":{"id":260989972,"uuid":"882858172","full_name":"zkemail/email-gpu-prover","owner":"zkemail","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-23T08:01:50.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-23T10:07:27.332Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zkemail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-03T23:31:15.000Z","updated_at":"2025-07-23T08:01:54.000Z","dependencies_parsed_at":"2024-11-04T04:23:18.879Z","dependency_job_id":"91cda6f3-95fe-47af-a9c5-89bfc7254110","html_url":"https://github.com/zkemail/email-gpu-prover","commit_stats":null,"previous_names":["zkemail/email-gpu-prover"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zkemail/email-gpu-prover","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Femail-gpu-prover","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Femail-gpu-prover/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Femail-gpu-prover/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Femail-gpu-prover/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkemail","download_url":"https://codeload.github.com/zkemail/email-gpu-prover/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkemail%2Femail-gpu-prover/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266905449,"owners_count":24004145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-22T21:27:53.815Z","updated_at":"2025-07-24T21:33:51.750Z","avatar_url":"https://github.com/zkemail.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZK Email GPU Prover\n\nA GPU-accelerated service for generating zero-knowledge proofs for the ZK Email protocol.\n\n## Overview\n\nThis service provides an API for generating zero-knowledge proofs using GPU acceleration via CUDA. It's built using Rust and integrates with the Rapidsnark prover for efficient proof generation.\n\n## Features\n\n- GPU-accelerated ZK proof generation\n- RESTful API for proof requests\n- Caching of circuit components and proving keys\n- Automatic artifact cleanup\n- Kubernetes deployment configuration\n- API key authentication\n\n## Prerequisites\n\n- NVIDIA GPU with CUDA support\n- Rust and Cargo\n- CUDA 12.2 or higher\n- Docker (for containerized deployment)\n- Unzip\n\n## Environment Variables\n\n- `PORT`: Server port (default: 3000)\n- `API_KEY`: Required API key for authentication\n\n## Installation\n\n### Using Docker\n\n```bash\n# Build the Docker image\ndocker build -t zkemail-gpu-prover .\n\n# Run the container\ndocker run -d \\\n  -p 3000:3000 \\\n  -e API_KEY=your_api_key \\\n  --gpus all \\\n  zkemail-gpu-prover\n```\n\n### Manual Installation\n\n1. Install Rust and required dependencies:\n\n```bash\napt-get update \u0026\u0026 apt-get install -y cmake build-essential pkg-config \\\n  libssl-dev libgmp-dev libffi-dev libsodium-dev nasm git \\\n  nodejs npm curl unzip\n```\n\n2. Install Rapidsnark:\n\n```bash\ngit clone https://github.com/Orbiter-Finance/rapidsnark.git\ncd rapidsnark\ngit submodule init\ngit submodule update\n./build_gmp.sh host\nmkdir build_prover\ncd build_prover\ncmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../package -DNVML_LIBRARY=/usr/local/cuda-12.2/targets/x86_64-linux/lib/stubs/libnvidia-ml.so\nmake -j$(nproc) \u0026\u0026 make install\nchmod +x ../package/bin/prover_cuda\nln -s /path/to/rapidsnark/package/bin/prover_cuda /usr/local/bin/prover\n```\n\n3. Clone and build the project:\n\n```bash\ngit clone https://github.com/zkemail/email-gpu-prover.git\ncd email-gpu-prover\ncargo build --release\n```\n\n4. Create a `.env` file:\n\n```\nAPI_KEY=your_secure_api_key\nPORT=3000\n```\n\n5. Run the server:\n\n```bash\ncargo run --release\n```\n\n## API Documentation\n\n### Health Check\n\n```\nGET /api/healthz\n```\n\nReturns a simple JSON response to check if the server is running.\n\n**Response:**\n\n```json\n{\n  \"status\": \"success\",\n  \"message\": \"Hello from ZK Email!\"\n}\n```\n\n### Generate Proof\n\n```\nPOST /api/prove\n```\n\nGenerates a zero-knowledge proof for the provided input.\n\n**Headers:**\n\n- `x-api-key`: Your API key (required)\n- `Content-Type`: application/json\n\n**Request Body:**\n\n```json\n{\n  \"blueprintId\": \"string\", // client generated random ID. Should be unique for each circuit (zkey and cpp witness generator)\n  \"proofId\": \"string\",\n  \"input\": {\n    // Circuit-specific input data (JSON object)\n  },\n  \"zkeyDownloadUrl\": \"string\",\n  \"circuitCppDownloadUrl\": \"string\"\n}\n```\n\n**Response:**\n\n```json\n{\n  \"proof\": {\n    \"pi_a\": [\"string\", \"string\", \"string\"],\n    \"pi_b\": [\n      [\"string\", \"string\"],\n      [\"string\", \"string\"],\n      [\"string\", \"string\"]\n    ],\n    \"pi_c\": [\"string\", \"string\", \"string\"],\n    \"protocol\": \"string\"\n  },\n  \"publicOutputs\": [\"string\", \"string\", \"...\"]\n}\n```\n\n## Kubernetes Deployment\n\nThe repository includes Kubernetes configuration files for GKE deployment. Follow these steps to deploy to your GKE cluster:\n\n### Prerequisites\n\n- Google Kubernetes Engine (GKE) cluster with GPU node pools\n- kubectl configured with your cluster context\n- A static IP address reserved in Google Cloud\n- Domain DNS pointing to the static IP\n\n### Deployment Steps\n\n1. **Create the PersistentVolumeClaim:**\n   ```bash\n   kubectl apply -f - --context=your-gke-context \u003c\u003cEOF\n   apiVersion: v1\n   kind: PersistentVolumeClaim\n   metadata:\n     name: prover-pvc\n     namespace: sdk\n   spec:\n     accessModes:\n       - ReadWriteOnce\n     resources:\n       requests:\n         storage: 50Gi\n   EOF\n   ```\n\n2. **Create the Kubernetes Secret with API key:**\n   ```bash\n   kubectl create secret generic k8s-gpu-prover-secret \\\n     --from-literal=API_KEY=your-api-key \\\n     --namespace=sdk \\\n     --context=your-gke-context\n   ```\n\n3. **Create the Service:**\n   ```bash\n   kubectl apply -f - --context=your-gke-context \u003c\u003cEOF\n   apiVersion: v1\n   kind: Service\n   metadata:\n     name: k8s-gpu-prover-svc\n     namespace: sdk\n   spec:\n     selector:\n       app: prover\n     ports:\n       - protocol: TCP\n         port: 443\n         targetPort: 3000\n     type: ClusterIP\n   EOF\n   ```\n\n4. **Apply the Kubernetes manifests in order:**\n   ```bash\n   # Apply managed certificate\n   kubectl apply -f kubernetes/managed-cert.yml --context=your-gke-context\n   \n   # Apply deployment\n   kubectl apply -f kubernetes/prover.yml --context=your-gke-context\n   \n   # Apply ingress\n   kubectl apply -f kubernetes/ingress.yml --context=your-gke-context\n   ```\n\n5. **Update deployment strategy for ReadWriteOnce volumes:**\n   ```bash\n   kubectl patch deployment k8s-gpu-prover -n sdk --context=your-gke-context \\\n     --type='merge' -p '{\"spec\":{\"strategy\":{\"type\":\"Recreate\",\"rollingUpdate\":null}}}'\n   ```\n\n### Verification\n\n1. **Check deployment status:**\n   ```bash\n   kubectl get pods -n sdk --context=your-gke-context -l app=prover\n   ```\n\n2. **Check managed certificate status:**\n   ```bash\n   kubectl get managedcertificate -n sdk --context=your-gke-context\n   ```\n\n3. **Check ingress IP:**\n   ```bash\n   kubectl get ingress -n sdk --context=your-gke-context\n   ```\n\n4. **Test the API:**\n   ```bash\n   curl -X POST https://your-domain.com/api/prove \\\n     -H \"x-api-key: your-api-key\" \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\"blueprintId\": \"test\", \"proofId\": \"test\"}'\n   ```\n\n### Important Notes\n\n- The deployment uses `Recreate` strategy due to ReadWriteOnce PVC constraints\n- Google managed certificates can take 10-60 minutes to provision\n- Ensure your domain DNS points to the static IP before certificate provisioning\n- The deployment requires GPU nodes with NVIDIA Tesla T4 or compatible GPUs\n\n## Error Handling\n\nThe service returns appropriate HTTP status codes with error messages:\n\n- `400 Bad Request`: Invalid input parameters\n- `401 Unauthorized`: Invalid or missing API key\n- `500 Internal Server Error`: Server-side errors during proof generation\n\n## License\n\nThis project is part of the ZK Email ecosystem. See the license file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Femail-gpu-prover","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzkemail%2Femail-gpu-prover","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzkemail%2Femail-gpu-prover/lists"}