Install and integrate

Install and integrate Zerynex

Try Zerynex without installing anything: Open the browser workbench. For application integration, see SDK and lightweight installation and confirm publication status before copying registry commands.

Zerynex is a local-first Rust privacy policy engine for Zcash PCZT workflows. A node, wallet, hosted account or API token is not needed for synthetic PCZT linting or role-handoff regression tests.

Choose an integration

Interface	For	Current state
Rust CLI and library	Wallets, CI, Rust programs	Supported from source
PCZT role scenario runner	Offline wallet developer acceptance tests	Supported from source
TypeScript/WASM SDK	React/Next.js and browser wallet UIs	Repository-local; not published
Python SDK	Automation and Python test suites	Calls trusted Rust CLI
GitHub Action	Repository pull-request checks	Supported with synthetic fixtures
MCP and Agent Skill	Read-only agent workflows	Optional and local
Go SDK	Go wallet and infrastructure applications	Source SDK: see Go guide
Zebra/Z3	Local node-readiness checks	Partial
ZK/prover structural handoffs	ZK and privacy engineers	Partial: see ZK guide
Live Zallet RPC, Zaino, proof adapters	Wallet/prover/indexer teams	Not yet supported

Install Rust CLI

Requires a compatible Rust toolchain.

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

Or clone and build both Rust executables:

git clone https://github.com/Oluwa-Laughter/zerynex
cd zerynex
cargo build --locked --release --bins

Check a synthetic fixture:

./target/release/zerynex apps/web/public/examples/clean-v6.bin --policy-file policies/shielded-only.json --json

Exit codes: 0 selected checks passed, 2 findings, 1 input error.

Python SDK

Requires Python 3.11+ and local Rust CLI.

python -m venv .venv
.venv/bin/python -m pip install ./packages/python

Python example:

from zerynex_py import ZerynexClient, Policy
client = ZerynexClient(cli="./target/release/zerynex")
report = client.analyze_file("apps/web/public/examples/transparent-v6.bin",
                             Policy(deny_transparent=True))
print(report.agent_summary())

The package is not yet published to PyPI.

TypeScript/WASM SDK

The SDK is in packages/sdk and shares the Rust core compiled to WASM. The package is not yet published to npm. Development supports npm, Yarn and pnpm. See Package managers.

Offline PCZT role-handoff harness

cargo run --locked --bin zerynex-handoff -- --manifest tests/fixtures/role-handoff/scenario.json --json

See Role-handoff harness for fixture expectations.

GitHub Actions

No app-level SDK installation is required.

- uses: actions/checkout@v4
- uses: Oluwa-Laughter/zerynex@main
  with:
    pczt-path: tests/fixtures/synthetic.pczt
    policy-path: policies/shielded-only.json

Pin a reviewed commit SHA instead of main for production, and use synthetic, nonspendable fixture data only. See GitHub Actions.

Privacy boundaries

Zerynex does not sign transactions, generate or verify proofs, or guarantee anonymity. Do not send wallet secrets, real PCZTs or addresses to public CI, external LLMs or issue trackers. The browser inspector processes files locally through Rust/WASM. See Privacy model.