Skip to content
free2zPublic

Repository files navigation

ZUU

The Zcash User Universe is a multipurpose monorepo for applications, protocol libraries, developer SDKs, experiments, and shared tooling. Projects have their own runtime, dependency graph, release process, and license.

Upstream repositories are tracked as Git submodules under z/. Projects that consume them build against source; initialize only the submodules your project needs. AGENTS.md describes the upstream and contribution workflow.

Project index

Project or collection Entry point
Free2Z app suite Architecture, status, development for the ZUULI wallet authority, Free2Z content app, and E2E2Z messaging app
ZUULI wallet/zuuli/, readiness, build infrastructure
Zuuallet wallet/zuuallet/, a separate wallet application
Free2Z developer SDK and metered AI SDK contract and integration, gateway architecture, f2z-sdk
Free2Z MCP Setup and usage: local assistant access to the Free2Z API with explicit named accounts
Free2Z messaging and key transparency Protocol documentation, Rust libraries
Free2Z cross-app intent bridge Protocol and authority boundaries
Free2Z web clients React, Svelte
Free2Z backend and workers py/free2z/: Django API, migrations, workers, and application libraries
Free2Z public documentation site docs/about-free2z/
Reusable Tauri plugins wallet/plugins/: named packages with independent consumers and lockfiles
Zcash Payment Hooks rs/zcash-payment-hooks/: receive-only daemon, private journal, durable executable hooks
Rust libraries and services rs/: named f2z-* crates and their own workspace
Zcash retrieval experiment py/experiments/zcash-rag/: experimental Python code, independent of the shipping apps
Upstream projects z/; .gitmodules records repository ownership and tracking branches

The app-suite architecture applies to those named applications. It does not assign every project a wallet role or make every SDK depend on a Zcash wallet. Current product capabilities and acceptance evidence belong in the relevant project's documentation.

Working in this repository

Read AGENTS.md and the selected project's local instructions. Use isolated worktrees, issues, reviewed PRs, and the required CI gates; local main is a clean fast-forward mirror of the remote.

Choose the project first, then follow its build instructions. For example, the ZUULI browser UI mock runs without native SDKs or submodules:

git clone https://github.com/free2z/zuu.git
cd zuu/wallet/zuuli
npm ci
VITE_MOCK=1 npm run dev

That command demonstrates ZUULI's fixture-backed UI. Other projects have their own entry points; it does not validate a wallet, SDK, or service end to end.

Licensing

Licenses are package-specific. Read the selected package's LICENSE and manifest and the upstream project's license for code under z/. This repository includes MIT and AGPL-licensed components; the root LICENSE is not a claim that every project or dependency uses one license.

Used by

Contributors

Languages