ZERYNEX
Documentation/Start here/Quickstart: first privacy check
START HERE / ALL DEVELOPERS

Quickstart: first privacy check

Run your first analysis and inspect an expected disclosure finding using synthetic fixtures.

Quickstart: your first PCZT privacy check

Zerynex analyzes selected disclosure-policy rules in a local Zcash Partially Constructed Zcash Transaction (PCZT). Start with a generated, nonspendable test fixture—no wallet connection, private key, account, or RPC endpoint is required.

1. Try it instantly

Open the privacy workbench. Select Transparent v6 and choose Run privacy analysis. The Rust engine runs through WebAssembly in your browser, and the fixture intentionally includes a transparent output.

Expected finding: PCZT-TRANSPARENT-OUTPUTS, under a policy that denies transparent components. This is an intentional failing fixture, not a failed installation.

2. Install the local CLI

You need a compatible Rust toolchain for source installation:

BASH
cargo install --git https://github.com/Oluwa-Laughter/zerynex --locked --bin zerynex
zerynex --capabilities

The command reports the installed version, supported operations, input formats, size limits and exit codes without opening a transaction file. For prebuilt downloadable artifacts and actual publication status, see Releases.

3. Check a fixture offline

From a local clone of this repository:

BASH
cargo run --locked -- \
  apps/web/public/examples/clean-v6.bin \
  --deny-transparent --json

Expected: zero policy findings, exit code 0. Next run:

BASH
cargo run --locked -- \
  apps/web/public/examples/transparent-v6.bin \
  --deny-transparent --json

Expected: PCZT-TRANSPARENT-OUTPUTS, exit code 2. Exit 1 instead means the CLI could not evaluate the input, and the caller must not treat it as a clean transaction.

4. Connect Zerynex to your own codebase

The homepage example uses a bundled fixture, not an automatic scan of your project. Use the interactive integration guide to choose the CLI, TypeScript/WASM, Python, GitHub Actions, or local MCP, and then supply your own files explicitly.

5. Choose your next integration

What a passing check means

Only the selected, implemented policy rules found no violations in the given intermediate PCZT. It does not verify proofs, signatures, transaction equivalence, wallet authorization, Zcash consensus correctness or complete anonymity. Never paste confidential PCZT bytes, wallet addresses or keys into public CI, issue reports, or AI conversations. Read the privacy and trust model before working with real wallet data locally.

Offline integration check in your own project

Use zerynex-project init --project /path/to/app --ci and zerynex-project verify --project /path/to/app --cli /path/to/zerynex --json from a trusted installed Python wheel and Rust CLI. Both runs use reviewed nonspendable fixtures; see integration instructions.

Public guides document shipped APIs and clearly identify partial integrations. Internal design, deployment and research notes remain in the source repository. Documentation index