<aside> 🚨 As of August 29, 2024, further updates to this guide will be made on the SDK Draft Documentation.

Please reference this guide for running the devnet, as many items here are out of date.

</aside>

Overview

This guide should get you started with running a local Scroll SDK devnet on your mac laptop with an arm64 processor.

This guide assumes you’ve taken a look at the Early Access document and have access to the scroll-sdk github repo using your local machine.

We’ve written this guide because local deployments for Kubernetes clusters can be finicky.

By the end of the guide, you should have a Scroll SDK running with a block explorer, RPC, webUI, monitoring and metrics, and a local L1 — all accessible to wallets, browsers, and applications running on your local machine.

<aside> 🚧 This software is still experimental, and we’d appreciate any feedback about this document, the codebase, or additional features.

</aside>

<aside> ⚠️ This guide does not include running the coordinator or a prover. The coordinator currently requires 20GB of RAM to run, so we disable it by default, and provers need dedicated machines to run and require additional configuration.

</aside>

Updates to Guide

• August 29, 2024
  • Updates now made to this guide
• June 26, 2024
  • Minor typography fixes i.e. docker v to docker -v
• June 19, 2024
  • Removed external bjw-s dependency and prerequisite
  • Removed manual modification of .env.frontends
  • Updated docker image name used in generating config files
• June 18, 2024
  • Fixed minikube addons enable commands (missing “addons”)

Prerequisites

• Clone the repo onto your local machine.
• Install dependencies (using brew is strongly recommended):
  • Brew (optional)
    • /bin/bash -c "$(curl -fsSL [<https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh>](<https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh>))"
  • Docker Desktop
    • brew install --cask docker
  • kubectl
    • brew install kubectl
  • minikube
    • brew install minikube
  • Helm
    • brew install helm
  • docker-mac-net-connect
    • brew install chipmk/tap/docker-mac-net-connect
• You should now be able to open a terminal and run the following:
  • docker -v
  • kubectl version
  • minikube status
  • helm version

Starting minikube

To start minikube, run: