DePINZcash

https://github.com/zcashdepin/depinzcash
Admin
Decentralized incentive layer for Zcash nodes that rewards operators in $ZePIN tokens on Solana for...
Tokens:9,556
Snippets:136
Trust Score:1.7
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Prerequisites

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Installs the necessary command-line tools for Fly.io and Vercel, and logs into both services. This is a one-time setup.

```bash
# install once
curl -L https://fly.io/install.sh | sh    # flyctl
npm i -g vercel                            # vercel CLI

# auth (browser flow)
flyctl auth login
vercel login
```

```bash
openssl rand -hex 32
```

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

### Kani Formal Verification Setup

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Install Kani verifier and its setup, then run the formal verification harnesses. These harnesses are gated by the 'kani' cfg and are skipped during normal 'cargo test' execution.

```bash
cargo install --locked kani-verifier && cargo kani setup

# Then run the harnesses:
# cargo kani
```

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

### Manual Reward Calculation Example 2

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Manual verification of reward calculation for a partial setup scenario: 85% sync, 7 days uptime, and no peers.

```text
Sync bonus: 0.25 ZEC (75-89% tier)
Uptime reward: 168 × 0.001 = 0.168 ZEC
Multiplier: 1.0x (no peers)
Final uptime: 0.168 × 1.0 = 0.168 ZEC

Total: 0.25 + 0.168 = 0.418 ZEC ✓
```

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

### Manual Reward Calculation Example 1

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Manual verification of reward calculation for a full setup scenario: 100% sync, 30 days uptime, and serving peers.

```text
Sync bonus: 0.5 ZEC
Uptime reward: 720 × 0.001 = 0.72 ZEC
Multiplier: 1.5x (has peers)
Final uptime: 0.72 × 1.5 = 1.08 ZEC

Total: 0.5 + 1.08 = 1.58 ZEC ✓
```

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

### Install Clang on Linux

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Instructions for installing Clang on Linux using apt.

```bash
sudo apt install clang
```

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

### Install Clang on Mac

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Instructions for installing Clang on macOS using Homebrew.

```bash
brew install llvm
```

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

### Install LLVM/Clang on Windows

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

On Windows, RocksDB tests require LLVM/Clang. Install it from the official releases or use Chocolatey.

```bash
choco install llvm
```

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

### GET /healthz, /readyz

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Liveness and readiness probes for the server.

```APIDOC
## GET /healthz, /readyz

### Description
Liveness and readiness probes for the server.

### Method
GET

### Endpoint
/healthz, /readyz

### Response
#### Success Response (200)
- **status** (string) - Indicates the health status (e.g., "ok").
```

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

### Rust Unit Test Example

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

An example of how to structure unit tests within a Rust file using the `#[cfg(test)]` attribute and `#[test]` macro.

```rust
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_reward_calculation() {
        // Test implementation
    }
}
```

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

### Clone and Set Up DePINZcash Repository

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Steps to fork, clone, and set up the DePINZcash project locally, including adding the upstream remote and installing dependencies.

```bash
# Fork the repository on GitHub

# Clone your fork
git clone https://github.com/YOUR_USERNAME/DePINZcash
cd DePINZcash

# Add upstream remote
git remote add upstream https://github.com/depinzcash/DePINZcash

# Install dependencies
./scripts/setup.sh

# Build the project
cd prover
cargo build

# Run tests
cargo test
```

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

### Rust Doc Comment Example

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Example of Rust documentation comments (`///`) used to document functions, including arguments, return values, and potential errors.

```rust
/// Generates a zero-knowledge proof of node operation.
///
/// # Arguments
///
/// * `metrics` - Node metrics to prove
///
/// # Returns
///
/// A `Proof` object containing the Halo 2 proof
///
/// # Errors
///
/// Returns error if proof generation fails
pub async fn generate_proof(&self, metrics: &NodeMetrics) -> Result<Proof> {
    // Implementation
}
```

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

### Rust Integration Test Example

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Illustrates where to place integration tests in a Rust project, typically within the `tests/` directory.

```rust
// tests/proof_generation.rs

#[test]
fn test_full_proof_flow() {
    // End-to-end test
}
```

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

### Example Conventional Commit Message

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

An example of a commit message following the conventional commits format, detailing a new feature for testnet proof generation.

```text
feat(prover): add support for testnet proofs

Implement testnet proof generation alongside mainnet.
Users can now specify --network flag to generate testnet proofs.

Closes #42
```

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

### Fetch Leaderboard Statistics

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Use this command to retrieve the network leaderboard. This is a basic GET request to the API.

```bash
curl http://127.0.0.1:3000/api/stats/leaderboard
```

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

### Run DePINZcash Server Locally

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Starts the DePINZcash server, which writes to a local SQLite database and listens on port 3000. Ensure environment variables like ADMIN_API_KEY and TRUSTED_RPCS are configured.

```bash
cd ../server
cp .env.example .env   # edit ADMIN_API_KEY, TRUSTED_RPCS, SPL_MINT
./target/release/depinzcash-server
```

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

### Start Relay Watch Mode

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

This command starts the depinzcash relay in watch mode for continuous operation. It specifies the interval, API endpoint, keypair, and proof file location.

```bash
depinzcash-relay watch --interval-secs 300 \
    --api http://127.0.0.1:3000 \
    --keypair config/solana-keypair.json \
    --proof-file proofs/latest.json
```

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

### Add New Test Function

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Example of how to define a new test function using the `#[test]` attribute and `assert_eq!` for verification.

```rust
#[test]
fn test_new_feature() {
    let result = calculate_something(10);
    assert_eq!(result, 20);
}
```

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

### GET /api/snapshots/latest

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves summary information about the latest published Merkle snapshot.

```APIDOC
## GET /api/snapshots/latest

### Description
Retrieves the latest published snapshot summary.

### Method
GET

### Endpoint
/api/snapshots/latest

### Response
#### Success Response (200)
- **snapshot_summary** (object) - Summary of the latest snapshot.
```

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

### GET /api/stats/leaderboard

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves the leaderboard, showing top wallets ranked by points.

```APIDOC
## GET /api/stats/leaderboard

### Description
Retrieves the leaderboard, showing top wallets ranked by points.

### Method
GET

### Endpoint
/api/stats/leaderboard

### Response
#### Success Response (200)
- **field1** (type) - Description
```

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

### GET /api/wallet/:wallet/proofs

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves a list of recent proofs submitted by a specific wallet.

```APIDOC
## GET /api/wallet/:wallet/proofs

### Description
Retrieves recent proofs submitted by a specific wallet.

### Method
GET

### Endpoint
/api/wallet/:wallet/proofs

### Parameters
#### Path Parameters
- **wallet** (string) - Required - The wallet address.

### Response
#### Success Response (200)
- **proofs** (array) - A list of recent proofs.
```

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

### GET /api/info

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves general information about the API, including version, network, and registration message format.

```APIDOC
## GET /api/info

### Description
Retrieves version, network, registration message format, and $ZePIN mint information.

### Method
GET

### Endpoint
/api/info

### Response
#### Success Response (200)
- **version** (string) - The API version.
- **network** (string) - The network the API is running on.
- **registration_message_format** (string) - The format of the registration message.
- **zepn_mint** (string) - The $ZePIN mint address.
```

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

### Conventional Commit Message Format

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

An example illustrating the conventional commits format for commit messages, including type, scope, subject, body, and footer.

```text
type(scope): subject

body

footer
```

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

### GET /api/stats/network

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves network-wide statistics, such as total points and uptime.

```APIDOC
## GET /api/stats/network

### Description
Retrieves network-wide statistics.

### Method
GET

### Endpoint
/api/stats/network

### Response
#### Success Response (200)
- **field1** (type) - Description
```

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

### Fetch Network Statistics

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Use this command to retrieve overall network statistics. This is a basic GET request to the API.

```bash
curl http://127.0.0.1:3000/api/stats/network
```

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

### GET /api/nodes/:id

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves public information about a specific node.

```APIDOC
## GET /api/nodes/:id

### Description
Retrieves public information about a specific node.

### Method
GET

### Endpoint
/api/nodes/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the node.

### Response
#### Success Response (200)
- **node_info** (object) - Public information about the node.
```

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

### GET /api/wallet/:wallet/nodes

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves a list of nodes owned by a specific wallet.

```APIDOC
## GET /api/wallet/:wallet/nodes

### Description
Retrieves a list of nodes owned by a specific wallet.

### Method
GET

### Endpoint
/api/wallet/:wallet/nodes

### Parameters
#### Path Parameters
- **wallet** (string) - Required - The wallet address.

### Response
#### Success Response (200)
- **nodes** (array) - A list of node IDs owned by the wallet.
```

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

### GET /api/wallet/:wallet/claim/latest

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Fetches the latest Merkle claim payload for a given wallet.

```APIDOC
## GET /api/wallet/:wallet/claim/latest

### Description
Operators fetch their latest Merkle claim payload.

### Method
GET

### Endpoint
/api/wallet/:wallet/claim/latest

### Parameters
#### Path Parameters
- **wallet** (string) - Required - The Solana public key of the wallet.

### Response
#### Success Response (200)
- **field1** (type) - Description
```

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

### GET /api/wallet/<your-wallet>/stats

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Retrieves aggregate statistics for a specific wallet, including points and uptime.

```APIDOC
## GET /api/wallet/:wallet/stats

### Description
Retrieves aggregate points and uptime for a specific wallet.

### Method
GET

### Endpoint
/api/wallet/:wallet/stats

### Parameters
#### Path Parameters
- **wallet** (string) - Required - The wallet address to retrieve stats for.

### Response
#### Success Response (200)
- **field1** (type) - Description
```

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

### Basic Rust Test Function

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Example of a simple unit test function in Rust. Tests are defined using the `#[test]` attribute.

```rust
#[test]
fn test_my_feature() {
    // Your test code
    assert_eq!(1 + 1, 2);
}
```

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

### Fetch Latest Merkle Claim

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

This GET request retrieves the latest Merkle claim payload for a given Solana public key. This is used by operators to fetch their proof.

```http
GET /api/wallet/<solana-pubkey>/claim/latest
```

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

### Run Simple Tests (No RocksDB)

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Navigate to the 'prover' directory and run tests that do not require RocksDB.

```bash
cd prover
cargo test --test reward_tests
```

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

### Configure and Deploy Frontend to Vercel

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Links the frontend directory to a Vercel project, sets build-time environment variables for API URL and network settings, and deploys the application.

```bash
cd web

# Link this directory to a new Vercel project.
vercel link

# Set the build-time env vars (these get baked into the static bundle).
vercel env add VITE_API_URL production
# paste: https://api.zcashdepin.com

vercel env add VITE_ZCASH_NETWORK production
# paste: mainnet

vercel env add VITE_SOLANA_CLUSTER production
# paste: devnet     (later: mainnet-beta once $ZePIN is on Solana mainnet)

# Deploy.
vercel --prod
# returns a https://depinzcash.vercel.app (or similar) URL
```

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

### Create Fly.io Backend App

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Creates a new application on Fly.io, sets up a persistent volume for the database, and configures encrypted secrets. Use `--no-deploy` if the app already exists.

```bash
cd server

# Create the app (skip if 'depinzcash-server' already exists).
# --no-deploy because we need to create the volume first.
flyctl apps create depinzcash-server

# Persistent volume for the SQLite database.
flyctl volumes create depinzcash_data --region iad --size 1 --yes

# Secrets — these are encrypted at rest on Fly.
flyctl secrets set \
  ADMIN_API_KEY="$(openssl rand -hex 32)" \
  TRUSTED_RPCS="" \
  SPL_MINT=""

# Deploy. --remote-only uses Fly's builders so you don't need local Docker.
flyctl deploy --remote-only

# Verify
flyctl status
curl https://depinzcash-server.fly.dev/healthz
curl https://depinzcash-server.fly.dev/api/info | jq
```

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

### Deploy Frontend Updates

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Instructions for deploying frontend updates. This can be done automatically via Git push to Vercel or manually using the Vercel CLI.

```bash
push to GitHub (Vercel auto-deploys main), or vercel --prod
```

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

### Build and Deploy ZePIN Claim Program

Source: https://github.com/zcashdepin/depinzcash/blob/main/programs/zepin-claim/README.md

Commands to build and deploy the ZePIN claim program using Anchor on a Solana devnet cluster. Remember to update the program ID after deployment.

```bash
# inside programs/zepin-claim/
anchor build
anchor deploy --provider.cluster devnet

# replace declare_id! with the deployed program id, rebuild, redeploy.
solana address -k target/deploy/zepin_claim-keypair.json
```

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

### Build Server and Relay Binaries

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Builds the server and depinzcash-relay binaries for local prototyping. Requires Rust 1.70+.

```bash
cd server && cargo build --release
cd ../prover && cargo build --release --bin depinzcash-relay
```

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

### Run Server and Prover Tests

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Navigate to the respective directories and execute the cargo test command to run the test suites for the server and prover components.

```bash
cd server && cargo test
cd prover && cargo test
```

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

### Run All Tests

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Execute all tests within the prover directory. Ensure you are in the 'prover' directory before running.

```bash
cd prover
cargo test
```

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

### Troubleshoot 404 on Claim Endpoint

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Explains that a 404 error on the `/api/wallet/<addr>/claim/latest` endpoint means no snapshot has been published yet, and provides the command to publish one.

```bash
# `/api/wallet/<addr>/claim/latest` is 404 — no snapshot has been published yet. Hit `POST /api/admin/snapshot/publish` with `x-admin-key`.
```

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

### Test DePINZcash Binary

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Commands to build the release version of the DePINZcash binary and run its help command to verify the build.

```bash
# Test the binary
cargo build --release
./target/release/depinzcash-prover --help
```

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

### Troubleshoot Phantom Signing Issues

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Addresses problems with Phantom wallet signing returning nothing, often caused by wallet adapter version mismatches or ad blockers.

```bash
# Phantom signing returns nothing — wallet adapter version mismatch; verify `@solana/wallet-adapter-react-ui` is loaded (Network tab) and Phantom isn't blocked by an ad blocker.
```

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

### Rust Test Using Mock Helpers

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Demonstrates using helper functions from `test_helpers.rs` to generate mock data for testing. Import necessary helpers before use.

```rust
use test_helpers::*

#[test]
fn my_test() {
    let metrics = mock_node_metrics();
    // Test with metrics
}
```

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

### Fetch Wallet Statistics

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Use this command to retrieve statistics for a specific wallet. Replace <your-wallet> with the actual wallet address.

```bash
curl http://127.0.0.1:3000/api/wallet/<your-wallet>/stats
```

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

### Troubleshoot Pending Certificates

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Provides guidance for certificates stuck in a 'pending' state, indicating a DNS propagation issue.

```bash
# Cert stuck "pending" — DNS hasn't propagated; `flyctl certs check api.zcashdepin.com` and wait.
```

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

### Run a Specific Test Function

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Execute a single, named test function. Replace 'test_proof_generation_basic' with the exact name of the test function.

```bash
cargo test test_proof_generation_basic
```

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

### Initialize Distributor PDA and Vault

Source: https://github.com/zcashdepin/depinzcash/blob/main/programs/zepin-claim/README.md

Initializes the Distributor PDA and sets up the vault account for token transfers. This function is authority-only and binds the distributor to a mint and vault.

```typescript
// pseudo-flow; see ../../web/src/lib/claim.ts for the production client.

const distributor = PublicKey.findProgramAddressSync(
  [Buffer.from("distributor"), u64ToLeBytes(cycle)],
  programId,
)[0];

// Create the vault as an ATA-style account owned by `distributor` and fund it.
await program.methods
  .initializeDistributor(new BN(cycle), Array.from(rootBytes), new BN(payoutPerPoint))
  .accounts({ authority, distributor, mint, vault, tokenProgram, systemProgram })
  .rpc();
```

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

### Generate Solana Keypair and Register Node

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Generates a Solana keypair and registers a node with the DePINZcash server. This is a prerequisite for submitting node-state proofs.

```bash
cd /tmp/operator
/path/to/depinzcash-relay keygen --out config/solana-keypair.json
/path/to/depinzcash-relay register \
    --api http://127.0.0.1:3000 \
    --keypair config/solana-keypair.json \
    --kind zebra-full \
    --label primary
```

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

### Configure DNS Records

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Sets up the necessary DNS records for the API subdomain and the apex/www domains to point to the Fly.io backend and Vercel frontend respectively. The exact targets are obtained from `flyctl certs show` and Vercel's domain UI.

```bash
# Outputs DNS records to add — see DNS section below.
```

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

### Troubleshoot Fly.io Volume Deployment

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Addresses a common issue where `flyctl deploy` fails due to volume problems. Ensures the volume exists in the same region as the app.

```bash
# flyctl deploy fails on volume — make sure `depinzcash_data` exists in the same region as the app (`iad`).
```

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

### POST /api/admin/snapshot/publish

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Force-publishes a new Merkle snapshot. Requires an admin API key.

```APIDOC
## POST /api/admin/snapshot/publish

### Description
Force-publishes a new Merkle snapshot. Requires `x-admin-key` header.

### Method
POST

### Endpoint
/api/admin/snapshot/publish

### Headers
- **x-admin-key** (string) - Required - The admin API key.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the publish operation.
```

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

### Run Specific Test File

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Execute tests contained within a specific integration test file. Replace 'integration_test' with the desired file name.

```bash
cargo test --test integration_test
```

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

### POST /api/proofs/submit

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Submits a signed proof for verification.

```APIDOC
## POST /api/proofs/submit

### Description
Submits a signed proof for verification.

### Method
POST

### Endpoint
/api/proofs/submit

### Request Body
- **signed_proof** (string) - Required - The signed proof submission.

### Response
#### Success Response (200)
- **field1** (type) - Description
```

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

### Ensure Stable Rust Toolchain

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

If tests fail in CI but pass locally, ensure you are using the stable Rust toolchain.

```bash
rustup default stable
```

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

### Run Tests with Output Capture

Source: https://github.com/zcashdepin/depinzcash/blob/main/prover/tests/README.md

Execute tests and capture their standard output. This is useful for debugging and observing test execution details.

```bash
cargo test -- --nocapture
```

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

### Deploy Backend Updates

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Command to deploy changes to the backend application after code modifications. It uses Fly.io's remote building capabilities.

```bash
cd server && flyctl deploy --remote-only
```

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

### Run All Cargo Tests

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Command to execute all tests within a Rust project managed by Cargo. Use `-- --nocapture` to see test output.

```bash
# All tests
cargo test

# Specific test
cargo test test_reward_calculation

# With output
cargo test -- --nocapture

# Documentation tests
cargo test --doc
```

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

### Rollback Fly.io Deployment

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Lists available releases for the Fly.io application and allows rolling back to a previous version.

```bash
flyctl releases list
flyctl releases rollback <version>
```

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

### Skip Slow Integration Tests

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

Use the `--lib` flag with `cargo test` to skip integration tests and only run library tests.

```bash
cargo test --lib
```

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

### Run a Specific New Test

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

After adding a new test function, you can run it individually using `cargo test` followed by the test function name.

```bash
cargo test test_new_feature
```

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

### Commit Changes

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Standard Git commands to stage all changes and create a commit with a conventional message.

```bash
git add .
git commit -m "feat: add awesome feature"
```

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

### Submit Node-State Proof

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Submits a node-state proof to the DePINZcash server. This can be done directly with block details or by referencing a Halo 2 proof JSON file.

```bash
/path/to/depinzcash-relay submit \
    --api http://127.0.0.1:3000 \
    --keypair config/solana-keypair.json \
    --height 2500001 \
    --block-hash 0000000000... \
    --uptime-seconds 7200 --peers 12
```

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

### Add Custom Domains to Vercel

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Adds custom domains to the Vercel deployment, allowing users to access the frontend via `zcashdepin.com` and `www.zcashdepin.com`.

```bash
vercel domains add zcashdepin.com
vercel domains add www.zcashdepin.com
```

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

### Format and Lint Rust Code

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Commands to format Rust code using `cargo fmt` and check for linting errors with `cargo clippy`. It's recommended to run these before committing.

```bash
# Format code
cargo fmt

# Lint
cargo clippy

# Before committing
cargo fmt --check
cargo clippy -- -D warnings
cargo test
```

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

### Bug Report Template

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

A Markdown template for reporting bugs in DePINZcash, including sections for description, steps to reproduce, expected/actual behavior, environment details, and logs.

```markdown
## Bug Description
Brief description of the bug

## Steps to Reproduce
1. Step one
2. Step two
3. ...

## Expected Behavior
What should happen

## Actual Behavior
What actually happens

## Environment
- OS: Ubuntu 22.04
- DePINZcash version: 0.1.0
- Zebra version: 1.5.0
- Rust version: 1.75.0

## Logs
```
paste relevant logs here
```
```

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

### Expected Test Output

Source: https://github.com/zcashdepin/depinzcash/blob/main/TESTING.md

This is the expected output when running the tests, indicating all tests passed successfully.

```text
running 5 tests
test reward_tests::test_basic_reward_math ... ok
test reward_tests::test_uptime_rewards ... ok
test reward_tests::test_peer_multiplier ... ok
test reward_tests::test_full_scenario ... ok
test reward_tests::test_partial_sync_scenario ... ok

test result: ok. 5 passed; 0 failed; 0 ignored; 0 measured
```

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

### Create a Feature Branch

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Command to create a new Git branch for a feature or fix, using a prefix convention like `feature/` or `fix/`.

```bash
git checkout -b feature/your-feature-name
```

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

### POST /api/challenges/request

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Requests a random-depth block-hash challenge from the server.

```APIDOC
## POST /api/challenges/request

### Description
Requests a random-depth challenge from the server.

### Method
POST

### Endpoint
/api/challenges/request

### Response
#### Success Response (200)
- **challenge** (object) - The challenge details.
  - **block_height** (integer) - The random block height.
  - **block_hash** (string) - The hash of the specified block.
```

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

### POST /api/nodes/register

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Registers a node by submitting a signed registration message. Returns the node ID and authentication token.

```APIDOC
## POST /api/nodes/register

### Description
Registers a node with signed registration. Returns `node_id` and `auth_token`.

### Method
POST

### Endpoint
/api/nodes/register

### Request Body
- **signed_registration** (string) - Required - The signed registration message.

### Response
#### Success Response (200)
- **node_id** (string) - The ID of the registered node.
- **auth_token** (string) - The authentication token for the node.
```

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

### Rollback Vercel Deployment

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Command to roll back a Vercel deployment to a previous state. Requires the deployment URL.

```bash
vercel rollback <deployment-url>
```

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

### Troubleshoot CORS Errors

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Explains the cause of CORS errors in the browser and the required format for `CORS_ALLOWED_ORIGINS` to resolve them.

```bash
# CORS error in browser — `CORS_ALLOWED_ORIGINS` must match the exact origin including scheme + port. No trailing slash.
```

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

### End-to-End Smoke Tests

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Performs a series of checks to ensure the entire deployment is functioning correctly, including API health, info endpoint, CORS headers, and a basic frontend interaction.

```bash
# api up?
curl -s https://api.zcashdepin.com/healthz
# {"status":"ok"}

# info reports the right network + mint?
curl -s https://api.zcashdepin.com/api/info | jq

# website loads + CORS works?
curl -s -H "Origin: https://zcashdepin.com" -I https://api.zcashdepin.com/api/info \
  | grep -i access-control-allow-origin
# access-control-allow-origin: https://zcashdepin.com
```

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

### Push Branch to Remote

Source: https://github.com/zcashdepin/depinzcash/blob/main/CONTRIBUTING.md

Command to push the local feature branch to the remote repository.

```bash
git push origin feature/your-feature-name
```

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

### Extend Volume Size

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Command to increase the size of a persistent volume on Fly.io. Requires the volume ID.

```bash
flyctl volumes extend <id> --size <gb>
```

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

### Claim ZePIN Rewards

Source: https://github.com/zcashdepin/depinzcash/blob/main/programs/zepin-claim/README.md

Allows anyone to claim ZePIN rewards by providing wallet information, points, and a Merkle proof. This process verifies the proof, initializes a claim receipt, and transfers tokens from the vault to the claimer's ATA.

```typescript
// Pull the claim payload from the server: GET /api/wallet/<wallet>/claim/latest
const payload = await api.latestClaim(walletStr);
const siblings = payload.proof.siblings.map((hex) => Buffer.from(hex, "hex"));

await program.methods
  .claim(walletStr, new BN(payload.points), siblings.map((b) => Array.from(b)))
  .accounts({
    claimer,
    distributor,
    vault,
    claimerAta,
    receipt: claimReceiptPda(distributor, claimer),
    tokenProgram,
    systemProgram,
  })
  .rpc();
```

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

### Verify DNS Propagation and Certificate Status

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Checks if the DNS records have propagated correctly and if the TLS certificate for the API subdomain has been issued. Also performs basic health checks against the deployed services.

```bash
flyctl certs check api.zcashdepin.com    # status: issued
curl https://api.zcashdepin.com/healthz
curl https://zcashdepin.com
```

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

### POST /api/challenges/submit

Source: https://github.com/zcashdepin/depinzcash/blob/main/README.md

Submits an answer to a previously requested challenge.

```APIDOC
## POST /api/challenges/submit

### Description
Submits an answer to a previously requested challenge.

### Method
POST

### Endpoint
/api/challenges/submit

### Request Body
- **challenge_answer** (object) - Required - The answer to the challenge.
  - **block_height** (integer) - The block height from the challenge.
  - **block_hash** (string) - The claimed block hash.
  - **signature** (string) - The signature proving ownership.

### Response
#### Success Response (200)
- **status** (string) - The status of the challenge submission.
```

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

### Add API Subdomain Certificate

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Adds a TLS certificate for the API subdomain to secure traffic. The command outputs DNS records that need to be added to your DNS provider.

```bash
flyctl certs add api.zcashdepin.com
# Outputs DNS records to add — see DNS section below.
```

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

### Update Secrets

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Command to update encrypted secrets on Fly.io. Changing a secret triggers a restart of the backend application.

```bash
flyctl secrets set KEY=value
```

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

### Update CORS Allowed Origins

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Updates the `CORS_ALLOWED_ORIGINS` secret on Fly.io to include the live frontend domains. This ensures the frontend can make requests to the backend API.

```bash
flyctl secrets set CORS_ALLOWED_ORIGINS="https://zcashdepin.com,https://www.zcashdepin.com"
```

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

### Update Trusted RPCs Secret

Source: https://github.com/zcashdepin/depinzcash/blob/main/docs/DEPLOY.md

Updates the `TRUSTED_RPCS` secret on Fly.io. This is typically done when you have real Zcash JSON-RPC endpoints to use.

```bash
flyctl secrets set TRUSTED_RPCS="https://rpc1.example,https://rpc2.example,https://rpc3.example"
```
Tokens:
Raw