Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.89 KB

AGENTS.md

File metadata and controls

68 lines (44 loc) · 2.89 KB

Optimism Monorepo

This is the primary monorepo for the OP Stack, maintained by the Optimism Collective. The OP Stack is a decentralized software stack that powers Optimism and forms the backbone of blockchains like OP Mainnet and Base.

Improving This Documentation

If during a session you learn something that would have helped you from the start, suggest updating these docs. Examples:

  • User corrects an outdated or wrong command you tried
  • User shows a better way to run tests, build, or debug
  • User explains a pattern or convention not documented here
  • Something you assumed from the docs turns out to be incorrect

When this happens, offer to submit the improvement to the relevant file in docs/ai/ or to this file. If the topic doesn't fit existing docs (e.g., CI workflows, debugging techniques), suggest creating a new focused document. Keep these docs tight and well-scoped rather than sprawling. Small, incremental improvements compound over time.

Repository Overview

This repository contains multiple components spanning different technologies:

Go Services

The rollup node software and associated services, including:

  • op-node: Rollup consensus-layer client
  • op-batcher: L2 batch submitter
  • op-proposer: L2 output submitter
  • op-challenger: Dispute game challenge agent
  • op-conductor: High-availability sequencer service
  • op-supervisor: Cross-chain message safety monitor (DEPRECATED)

Smart Contracts (packages/contracts-bedrock)

Solidity smart contracts for the OP Stack, including the core protocol contracts deployed on L1 and L2.

Rust Components

The OP Stack includes significant Rust implementations:

  • kona: Rust implementation of the OP Stack rollup state transition, including fault proof program, rollup node, and supervisor
  • op-reth: OP Stack execution client built on reth
  • op-alloy: Rust crates providing OP Stack types and providers for the alloy ecosystem
  • alloy-op-hardforks / alloy-op-evm: OP Stack hardfork and EVM support for alloy

Fault Proof System

  • cannon: Onchain MIPS instruction emulator (in Go)
  • op-program: Fault proof program (in Go)

Development and Testing Infrastructure

  • devnet-sdk: Toolkit for devnet interactions
  • kurtosis-devnet: Kurtosis-based devnet environment (DEPRECATED)
  • op-e2e: End-to-end testing framework
  • op-acceptance-tests: Acceptance test suite

Additional Documentation

More detailed guidance for AI agents can be found in:

External References