tuxcanfly / optimistic-specs

Optimistic: Bedrock, is a protocol that strives to be an extremely simple optimistic rollup that maintains 1:1 compatibility with Ethereum

The Optimism Spec

This repository holds the work-in-progress specification for the next version of Optimism.

This spec is developped iteratively, specifying a rollup of increasing complexity. The current stage specifies a "rollup" whose only transactions are deposits (L2 transactions submitted on L1).

A more detailed, though potentially out of date specification can be found on the alpha branch.

Work in Progress

Please note that this specification is currently under heavy construction.

Local Devnet Setup

You can spin up a local devnet via docker-compose. For convenence, we have defined make targets to start and stop the devnet with a single command. To run the devnet, you will need docker and docker-compose installed. Then, as a precondition, make sure that you have compiled the contracts by cding into packages/contracts and running yarn followed by yarn build. You'll only need to do this if you change the contracts in the future.

Then, run the following:

make devnet-up # starts the devnet
make devnet-down # stops the devnet
make devnet-clean # removes the devnet by deleting images and persistent volumes

L1 is accessible at http://localhost:8545, and L2 is accessible at http://localhost:8546. Any Ethereum tool - Metamask, seth, etc. - can use these endpoints. Note that you will need to specify the L2 chain ID manually if you use Metamask. The devnet's L2 chain ID is 901.

The devnet comes with a pre-funded account you can use as a faucet:

• Address: 0xde3829a23df1479438622a08a116e8eb3f620bb5
• Private key: bf7604d9d3a1c7748642b1b7b05c2bd219c9faa91458b370f85e5a40f3b03af7

The faucet account exists on both L1 and L2. To deposit onto L2 from L1, you can use the deposit hardhat task. Run the following from the packags/contracts directory:

npx hardhat deposit --amount-eth <amount in eth> --to <address>

You'll need a .env with the following contents:

L1_PROVIDER_URL=http://localhost:8545
L2_PROVIDER_URL=http://localhost:8546
PRIVATE_KEY=bf7604d9d3a1c7748642b1b7b05c2bd219c9faa91458b370f85e5a40f3b03af7

Contributing

Basic Contributions

Contributing to the Optimism specification is easy.

You'll find a list of open questions and active research topics over on the Discussions page for this repo. Specific tasks and TODOs can be found on the Issues page. You can edit content or add new pages by creating a pull request.

License

Specification: CC0 1.0 Universal, see specs/LICENSE file.

Reference software: MIT, see LICENSE file.