Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Setup

Prerequisites

Before starting, ensure you have:

  • Rust toolchain (use rustup for easiest setup)
  • Foundry (for compiling, testing, and deploying EVM smart contracts)
  • Docker
  • Docker Compose (usually included with Docker Desktop)
  • Make (typically pre-installed on Linux/macOS; Windows users can use WSL)
  • Git (for cloning the repository)

Verify installations:

rustc --version   # Should show rustc 1.85+
docker --version # Should show Docker 20.10+
make --version   # Should show GNU Make

Installation

git clone https://github.com/informalsystems/emerald.git
cd emerald
make build

Note

For building in release mode, use make release.