optimism

Optimism is Ethereum, scaled.

Table of Contents

• What is Optimism?
• Documentation
• Specification
• Community
• Contributing
• Security Policy and Vulnerability Reporting
• Directory Structure
• Development and Release Process
  • Overview
  • Production Releases
  • Development branch
• License

What is Optimism?

Optimism is a project dedicated to scaling Ethereum's technology and expanding its ability to coordinate people from across the world to build effective decentralized economies and governance systems. The Optimism Collective builds open-source software that powers scalable blockchains and aims to address key governance and economic challenges in the wider Ethereum ecosystem. Optimism operates on the principle of impact=profit, the idea that individuals who positively impact the Collective should be proportionally rewarded with profit. Change the incentives and you change the world.

In this repository you'll find numerous core components of the OP Stack, the decentralized software stack maintained by the Optimism Collective that powers Optimism and forms the backbone of blockchains like OP Mainnet and Base. The OP Stack is designed to be aggressively open-source — you are welcome to explore, modify, and extend this code.

Documentation

• If you want to build on top of OP Mainnet, refer to the Optimism Documentation
• If you want to build your own OP Stack based blockchain, refer to the OP Stack Guide and make sure to understand this repository's Development and Release Process

Specification

Detailed specifications for the OP Stack can be found within the OP Stack Specs repository.

Community

General discussion happens most frequently on the Optimism discord. Governance discussion can also be found on the Optimism Governance Forum.

Contributing

The OP Stack is a collaborative project. By collaborating on free, open software and shared standards, the Optimism Collective aims to prevent siloed software development and rapidly accelerate the development of the Ethereum ecosystem. Come contribute, build the future, and redefine power, together.

CONTRIBUTING.md contains a detailed explanation of the contributing process for this repository. Make sure to use the Developer Quick Start to properly set up your development environment.

Good First Issues are a great place to look for tasks to tackle if you're not sure where to start, and see CONTRIBUTING.md for info on larger projects.

Security Policy and Vulnerability Reporting

Please refer to the canonical Security Policy document for detailed information about how to report vulnerabilities in this codebase. Bounty hunters are encouraged to check out the Optimism Immunefi bug bounty program. The Optimism Immunefi program offers up to $2,000,042 for in-scope critical vulnerabilities.

Directory Structure

├── cannon: Onchain MIPS instruction emulator for fault proofs
├── docs: A collection of documents including audits and post-mortems
│   └── public-docs: Public developer documentation for docs.optimism.io
├── op-acceptance-tests: Acceptance tests and configuration for OP Stack
├── op-alt-da: Alternative Data Availability mode (beta)
├── op-batcher: L2-Batch Submitter, submits bundles of batches to L1
├── op-chain-ops: State surgery utilities
├── op-challenger: Dispute game challenge agent
├── op-conductor: High-availability sequencer service
├── op-deployer: CLI tool for deploying and upgrading OP Stack smart contracts
├── op-devstack: Flexible test frontend for integration and acceptance testing
├── op-dispute-mon: Off-chain service to monitor dispute games
├── op-dripper: Controlled token distribution service
├── op-e2e: End-to-End testing of all bedrock components in Go
├── op-faucet: Dev-faucet with support for multiple chains
├── op-fetcher: Data fetching utilities
├── op-interop-mon: Interoperability monitoring service
├── op-node: Rollup consensus-layer client
├── op-preimage: Go bindings for Preimage Oracle
├── op-proposer: L2-Output Submitter, submits proposals to L1
├── op-service: Common codebase utilities
├── op-supervisor: Service to monitor chains and determine cross-chain message safety
├── op-sync-tester: Sync testing utilities
├── op-test-sequencer: Test sequencer for development
├── op-up: Deployment and management utilities
├── op-wheel: Database utilities
├── ops: Various operational packages
├── packages
│   ├── contracts-bedrock: OP Stack smart contracts

Development and Release Process

Overview

Please read this section carefully if you're planning to fork or make frequent PRs into this repository.

Production Releases

Production releases are always tags, versioned as <component-name>/v<semver>. For example, an op-node release might be versioned as op-node/v1.1.2, and smart contract releases might be versioned as op-contracts/v1.0.0. Release candidates are versioned in the format op-node/v1.1.2-rc.1. We always start with rc.1 rather than rc.

For contract releases, refer to the GitHub release notes for a given release which will list the specific contracts being released. Not all contracts are considered production ready within a release and many are under active development.

Tags of the form v<semver>, such as v1.1.4, indicate releases of all Go code only, and DO NOT include smart contracts. This naming scheme is required by Golang. In the above list, this means these v<semver> releases contain all op-* components and exclude all contracts-* components.

op-geth embeds upstream geth’s version inside its own version as follows: vMAJOR.GETH_MAJOR GETH_MINOR GETH_PATCH.PATCH. Basically, geth’s version is our minor version. For example if geth is at v1.12.0, the corresponding op-geth version would be v1.101200.0. Note that we pad out to three characters for the geth minor version and two characters for the geth patch version. Since we cannot left-pad with zeroes, the geth major version is not padded.

See the GitHub releases page for more information about releases for the latest node components.

The full set of components that have releases are:

• op-batcher
• op-contracts
• op-challenger
• op-node
• op-proposer

All other components and packages should be considered development components only and do not have releases.

Development branch

The primary development branch is develop. develop contains the most up-to-date software that remains backwards compatible with the latest experimental network deployments. If you're making a backwards compatible change, please direct your pull request towards develop.

Changes to contracts within packages/contracts-bedrock/src are usually NOT considered backwards compatible. Some exceptions to this rule exist for cases in which we absolutely must deploy some new contract after a tag has already been fully deployed. If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using a feature branch. Feature branches are typically used when there are conflicts between 2 projects touching the same code, to avoid conflicts from merging both into develop.

Downloading & Shallow-Cloning the Monorepo

If you want to use the monorepo as a dependency, e.g. in CI, you can greatly speed up the fetching process by either downloading it directly as an archive from Github instead of cloning as a git repository or shallow-cloning it. This avoids downloading the full monorepo git history, which is unfortunately a few GBs in size, but which also isn't needed for many use cases, like CI.

To fetch the monorepo at a specific commit/branch/tag $REF, download and unpack with

curl -L https://github.com/ethereum-optimism/optimism/archive/$REF.tar.gz | tar xz

Note that if you need any of its submodules, you'd need to manually download those too.

If you want a shallow git clone of latest develop, you can just do

git clone --depth 1 --shallow-submodules https://github.com/ethereum-optimism/optimism.git

which takes only a few seconds on a good internet connection.

If you want to shallow-checkout a specific branch or tag $REF, do

git clone --no-checkout --depth 1 --shallow-submodules https://github.com/ethereum-optimism/optimism.git
cd optimism
git fetch --depth 1 origin "$REF"
git checkout "$REF"

which should also only take a few seconds.

License

All other files within this repository are licensed under the MIT License unless stated otherwise.