Getting Started
Quick Start
Build cipher-core, run the test suite, and join devnet.
Prerequisites
| Requirement | |
|---|---|
| OS | Linux, macOS or Windows (WSL2) |
| Rust | 1.78+ (rustup default stable) |
| Base tooling | Foundry — only for building the on-chain contract |
| RAM | 8 GB minimum (16 GB recommended for the full test suite) |
| Disk | 20 GB free (RocksDB, build artifacts, test ledger) |
1. Clone
git clone https://github.com/cipher-labs/cipher-core.git cd cipher-core
2. Build
The L2 Rust workspace and the on-chain Solidity contract build separately.
# L2 / validator binaries cargo build --release # On-chain contract (optional) cd contracts/cipher && forge build && cd ../..
| Binary | Purpose |
|---|---|
| cipher | Unified CLI — validator, wallet and compute subcommands |
| cipher-ceremony-contribute | MPC contribution tool |
| cipher-ceremony-verify | MPC transcript verifier |
| cipher-ceremony-finalize | Extracts proving keys from the finalised transcript |
3. Run the test suite
cargo test --all --all-targets # test result: ok. 407 passed; 0 failed; 0 ignored
4. Pick a path
Run a validator on devnet
Build, fund a wallet, register on-chain, start the node. ~30 minutes end-to-end.
Contribute to the MPC ceremony
Add randomness to the trusted setup. ~10 minutes per circuit.
Run privacy E2E locally
Spin up a 5-validator localnet and exercise deposit → transfer → withdraw.
Try private compute (alpha)
Submit a WASM job to the network and read the verified result.