Specular

Specular is an L2 system designed to scale Ethereum securely, with minimal additional trust assumptions. Specifically, it is an EVM-native optimistic rollup, relying on existing Ethereum infrastructure both to bootstrap protocol security and to enable native compatibility for all existing Ethereum applications & tooling.

This repository contains the L1 protocol contracts and L2 node software. The source is licensed under the Apache License 2.0 (unless otherwise specified)—see LICENSE for details.

Warning: This repository is a prototype and should not be used in production yet.

For developers

See system.md for a system overview and development.md for further information on how to deploy the system, test changes and contribute to the repository.

Build from source

Install the following dependencies:

Then to build, run:

# Fetch the repository and its submodules.
git clone https://github.com/specularl2/specular
cd specular && git submodule update --init --recursive
# Install dependencies and build binaries
pnpm install && make

Note: the commands that follow below assume you are in the project root directory.

Quick-start with Docker

The simplest way to run a local L2 devent is to use the provided docker-compose.

mkdir workspace
cp -a config/local_docker/. workspace/ # copy all config files
docker compose -f docker/docker-compose-test.yml build
docker compose -f docker/docker-compose-test.yml up

Running a local devnet

This section will walk you through how to set up a local L2 devnet (containing an L2 sequencer and validator), running over a local L1 network.

Configure network

To configure a local devnet, you can just use an existing example from config as-is.

mkdir workspace
cp -a config/local_devnet/. workspace/ # copy all config files

Start L1

Run the below scripts to initialize a new local L1 chain.

cd workspace
../sbin/generate_secrets.sh -d && ../sbin/start_l1.sh -c -d # Terminal 1

Start an L2 node

Deploy the L1 contracts on the newly started chain, and spin up all services required to run an L2 node.

../sbin/start_sp_geth.sh # Terminal 2
../sbin/start_sp_magi.sh # Terminal 3
../sbin/start_sidecar.sh # Terminal 4

At this point, you'll have two chains started with the following parameters

L2: chain ID 13527, with a sequencer exposed on ports 4011 (http) and 4012 (ws).
L1: chain ID 31337, on port 8545 (ws). To re-run the network from clean state, make sure to use the -c flag: ../sbin/deploy_l1_contracts.sh -c && ../sbin/start_sp_geth.sh -c.

For users