Zev Toolkit

A modern, visual developer toolkit that makes Zcash development as easy as Ethereum development

Zev Toolkit combines local testnet orchestration, transaction visualization, and interactive debugging in one cohesive tool. Built to dramatically reduce the barrier to entry for Zcash development.

Features

• 🚀 One-Command Setup - Local Zcash testnet running in <5 minutes
• 🔍 Transaction Inspector - Visual breakdown of shielded transactions
• 🧪 Test Harness - Integration with darksidewalletd for deterministic testing
• 📊 Network Monitor - Real-time view of local network activity
• 🛠️ CLI Tools - Interactive transaction builder and address manager
• 📚 Developer-Friendly - Clear documentation and examples

Quick Start

Prerequisites

• Rust 1.70+ (install)
• Docker and Docker Compose (install)
• 8GB+ RAM, 20GB+ disk space

Installation

# Clone the repository
git clone https://github.com/your-org/zev-toolkit
cd zev-toolkit

# Build from source
cargo build --release

# Install globally
cargo install --path crates/cli

Usage

# Initialize a new Zev environment
zev init

# Start the local Zcash network
zev start

# Check network status
zev status

# Open the transaction inspector UI
zev ui

# Stop the network
zev stop

# Clean up all data
zev clean

Project Structure

zev-toolkit/
├── crates/
│   ├── cli/          # Command-line interface
│   ├── core/         # Core library (network, RPC, transactions)
│   ├── types/        # Shared types
│   └── web/          # Web API for UI
├── docker/           # Docker configurations
├── docs/             # Documentation
└── web-ui/           # React frontend (coming soon)

Available Commands

Network Management

• zev init - Initialize Zev environment
• zev start - Start local Zcash network
• zev stop - Stop local network
• zev status - Show network status
• zev clean - Clean up all data

Transaction Operations

• zev tx create - Interactive transaction builder
• zev tx send - Send a transaction
• zev tx decode <txid> - Decode and inspect transaction
• zev tx simulate - Simulate transaction without broadcasting

Address Management

• zev addr generate - Generate new address
• zev addr validate <addr> - Validate address format
• zev addr balance <addr> - Check address balance

Testing

• zev test start - Start test harness
• zev test scenario <name> - Run test scenario
• zev test reorg <height> - Trigger chain reorganization
• zev test mine <count> - Mine blocks

Configuration

• zev config --show - Display configuration
• zev config --edit - Edit configuration

Architecture

Zev Toolkit is built with a modular architecture inspired by tools like surfpool:

• CLI Layer: User-facing commands with rich terminal UI
• Core Library: Network management, RPC client, transaction parsing
• Docker Orchestration: Containerized Zebra/zcashd + lightwalletd
• Web API: REST endpoints for transaction inspector UI
• Event-Driven: Asynchronous communication via channels

Development Status

🚧 Early Development - This project is actively being built!

Implemented

• ✅ Project structure and workspace setup
• ✅ Basic CLI commands framework
• ✅ Configuration system
• ✅ Docker Compose setup
• ✅ RPC client foundation

In Progress

• 🔨 Transaction parser using zcash_primitives
• 🔨 Interactive TUI with ratatui
• 🔨 Web UI for transaction inspector

Planned

• 📋 Test harness integration
• 📋 Address book manager
• 📋 Performance profiler
• 📋 Network monitor dashboard

Configuration

Configuration is stored in .zev/config.toml:

[network]
node_type = "Zebra"  # or "Zcashd"
chain = "Regtest"    # or "Testnet", "Mainnet"
mining_interval = 2
prefunded_accounts = 5

[rpc]
host = "127.0.0.1"
port = 18232
lightwalletd_port = 9067

[web_ui]
enabled = true
host = "127.0.0.1"
port = 3000

Contributing

Contributions are welcome! This project is being developed for the Zcash Privacy Infrastructure & Developer Tools bounty.

Building from Source

# Clone the repo
git clone https://github.com/your-org/zev-toolkit
cd zev-toolkit

# Build all crates
cargo build

# Run tests
cargo test

# Run the CLI
cargo run --bin zev -- --help

Why Zev Toolkit?

The Problem

Zcash development has a steep learning curve:

• Complex setup for shielded transactions
• Opaque zero-knowledge proofs
• Fragmented tooling
• Poor debugging visibility

The Solution

Zev Toolkit makes Zcash development accessible:

• One-command setup - No manual node configuration
• Visual tools - Understand shielded transactions visually
• Unified interface - Everything in one tool
• Interactive - Build and test transactions interactively

Roadmap

• Phase 1: Foundation (Weeks 1-3)

  • Project structure
  • Basic CLI
  • Docker setup
  • Transaction parsing

• Phase 2: Core Features (Weeks 4-6)

  • Transaction inspector
  • Transaction builder
  • Test harness integration
  • Web UI

• Phase 3: Polish (Weeks 7-9)

  • Performance profiler
  • Network monitor
  • Address book
  • Documentation

• Phase 4: Launch (Weeks 10-12)

  • Beta testing
  • Video demo
  • Bounty submission

License

Licensed under either of:

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Acknowledgments

• Inspired by surfpool for Solana
• Built for the Zcash Privacy Infrastructure & Developer Tools bounty
• Uses official Zcash libraries: zcash_primitives, zcash_client_backend, orchard

Links

• Documentation (coming soon)
• PRD
• Issues
• Zcash Community Forum