Skip to content

BeanieZombie/zombiekit

Repository files navigation

ZombieKit – Local-First zk Infrastructure for Web3 Builders

🧪 Technical Preview ZombieKit is in early developer preview. APIs, modules, and usage patterns may change frequently. Production use is gated via veEQUAL or BZ token credentials. See LICENSE for terms.

ZombieKit is a local-first, zk-verifiable, and veEQUAL-governed execution stack for Web3 developers. Built for the Sonic (Optimism L2) ecosystem, it offers a reproducible, modular, and license-aware infrastructure framework that empowers contributors to prototype and deploy deterministic zapps.

It enables full-stack development for decentralized systems like DePIN, zkSPV, and FeeM-integrated routers, with explicit licensing boundaries that preserve long-term sustainability.


✨ Features

  • Dev-Ready Home-Lab Stack – Sonic archive node, indexer, Prometheus, Grafana, Traefik
  • Modular zapps CLI – Deterministic .app execution with governance-aware publish flow
  • Sonic FeeM & zkSPV Compatible – Ready for routing, fallback RPC, and ZK proof anchoring
  • Governed Access – Pro Mode gated by veEQUAL, $BZ, or limited-edition NFT (888 cap)
  • Multi-Arch Support – Targets amd64, arm64, and riscv64 (CI + runtime)
  • DevContainer Native – VS Code + Docker = full local reproducibility
  • Security-Aware Tooling – Includes ShellCheck, Trivy, Hadolint, GPG commit signing
  • GitHub Actions + act – CI/CD workflows runnable locally

🚦 Usage Tiers

ZombieKit operates in one of three access modes:

Tier Requirements Access Scope
BUIDL mode Default (no license required) Local-only dev/testing, no production
Individual 1M $BZ tokens in one wallet Personal or delegated non-commercial use
Pro Mode 20K veEQUAL OR 10M $BZ + NFT (888 planned) Full production + commercial use

🧠 The Individual tier allows building or running zapps on behalf of Pro-licensed teams, provided the 1M $BZ holder is not independently deploying or monetizing the zapp.

See the full terms in LICENSE.


📦 Project Structure

.
├── infra/           # Sonic node, indexer, observability, routing
├── core/            # Go runtime, zkSPV engine, FuseTrace, BEANIE
├── zapps/           # User-built modular `.app` packages
├── clients/         # TypeScript SDKs for RPC and zapp execution
├── .devcontainer/   # Local development environment
├── LICENSE          # BUSL-1.1 until 2028-01-09, then Apache 2.0

🚀 Getting Started

Prerequisites

Quickstart

git clone git@github.com:BeanieZombie/zombiekit.git
cd zombiekit

make bootstrap   # builds docker-compose.yml, .env.sample, and .env
make up          # starts Sonic node, indexer, Grafana, etc.

Alternatively:

docker compose -f infra/docker-compose.yml up -d

🧪 Development

ZombieKit is DevContainer-native. Open the project in VS Code and select:

> Reopen in Container

Then use the terminal inside the container:

make ci-act   # simulate CI via act
make help     # see available Make targets

Commit messages must follow Conventional Commits. See docs/Engineering.md for contribution standards and practices.


🛠️ Make Targets

Target Description
make bootstrap Generates docker-compose.yml and .env
make up Starts the full infra stack
make down Stops all containers
make logs Tails logs for all services
make ci Lints Dockerfiles, YAML, Shell scripts
make ci-act Runs CI locally using act
make scan Runs Trivy scan on built images
make clean Resets generated files and volume mounts

🤝 Contributing

  1. Fork the repo
  2. Create a feature branch: git checkout -b feat/your-feature
  3. Use Conventional Commits: type(scope): description
  4. Validate with: make ci && make ci-act
  5. Submit a pull request

All contributions must follow the terms in LICENSE and security practices defined in docs/Security.md


📜 License

ZombieKit is licensed under the Business Source License 1.1 (BUSL-1.1).

  • ✅ Free for local research, testing, and education
  • 🔐 Commercial use requires veEQUAL or BZ credentials
  • 🔓 Reverts to Apache 2.0 on 2028-01-09

See LICENSE and NOTICE for full details.


🧠 Philosophy

Real Web3 doesn't live in the cloud. ZombieKit lets builders run and prove the chain themselves—verifiably, deterministically, and governed by community-owned credentials.

About

zk-verifiable, ve-governed Web3 infra stack for local-first apps and zapps

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors