Getting Started
This guide will help you understand the core concepts and get started with Kaizen Core.
Quick Start with Docker (Recommended)
The easiest way to run the full stack:
# Clone the repository
git clone https://github.com/mitosis-org/kaizen-core.git
cd kaizen-core
# Start all services
docker compose up -d
# Check status
docker compose psThis starts:
- write-node (
:8545) - Sequencer - read-node-aggressive (
:8547) - Low-latency queries - read-node-archive (
:8548) - Full history - proxy (
:8546) - Unified RPC/WS endpoint - tester (
:3000) - Frontend app - grafana (
:3003) - Monitoring dashboards
Access the tester at http://localhost:3000 and Grafana at http://localhost:3003
Prerequisites (Manual Setup)
- Rust toolchain (stable)
- RocksDB dependencies
- Node.js 22+ (for frontend/oracle tools)
- pnpm (for TypeScript packages)
Manual Setup
1. Clone the Repository
git clone https://github.com/mitosis-org/kaizen-core.git
cd kaizen-core2. Build the Project
cargo build --release3. Run a Write Node
./target/release/kaizen-node --config config.toml --json-logs4. Run a Read Node
./target/release/kaizen-node --config read-config.toml --json-logsProject Structure
kaizen-core/
├── apps/
│ ├── cli/ # Kata CLI tool (binary: kata)
│ ├── node/ # Kaizen Node (binary: kaizen-node)
│ ├── settler/ # Settler service
│ ├── tester/ # Frontend testing app
│ ├── oracle/ # Oracle service
│ ├── mock-solver/ # Mock solver service
│ ├── proxy/ # RPC proxy (Rust)
│ └── mock-bridge/ # Mock bridge relayer
├── crates/
│ ├── app/ # Application layer (RPC, WebSocket, Block Producer)
│ ├── core/ # Core abstractions (Payload, Storage traits)
│ ├── engine/ # STF executors (Account, RFQ, Oracle, Admin)
│ ├── state/ # State management (RocksDB, JMT)
│ ├── tx/ # Transaction handling
│ ├── types/ # Domain types
│ ├── auth/ # Authentication (EIP-712, API wallets)
│ └── metrics/ # Prometheus metrics
├── sdk/ # TypeScript SDK
└── docs/ # Documentation (you are here)Next Steps
- Architecture - Understand the system design
- API Reference - Explore the JSON-RPC and WebSocket APIs
- SDK Guide - TypeScript SDK for integration
