Skip to content

Commit

Permalink
Merge pull request ethereum-optimism#40 from ethereum-optimism/reset-…
Browse files Browse the repository at this point in the history
…main

Reset repo to restart from scratch
  • Loading branch information
norswap authored Nov 24, 2021
2 parents 278ac67 + 7564324 commit 078f9d4
Show file tree
Hide file tree
Showing 25 changed files with 29 additions and 1,135 deletions.
75 changes: 29 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,47 @@
# The Optimistic Ethereum Spec

This repository holds the open-source specification for Optimistic Ethereum, an ultra-minimal optimistic rollup protocol that maintains 1:1 compatibility with Ethereum.
This repository holds the work-in-progress specification for the next version of
Optimistic Ethereum.

## Work in Progress

Please note that this specification is currently heavily under construction.
You will find that several pages are incomplete or [under discussion](https://github.com/ethereum-optimism/optimistic-specs/issues).

## Specification structure

- [Introduction](./introduction.md)
- [Overview](./overview.md)
- [Roadmap](./roadmap.md)
- Components:
- [Layer 1 Contracts](./components/layer1.md)
- [Rollup Client](./components/rollup_client.md)
- [Execution Engine](./components/exec_engine.md)
- [Batch Submitter](./components/batch_submitter.md)
- [Witness Generator](./components/witness_gen.md)
- [Challenge Agent](./components/challenge_agent.md)
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).

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

We believe that **the best optimistic rollup design needs to be minimal, open, and accessible.**
## Work in Progress

### Minimalism
Please note that this specification is currently under heavy construction.

Ethereum-focused optimistic rollups should be minimal to best take advantage of the battle-tested infrastructure (like Geth) that already runs Ethereum.
An ideal optimistic rollup design should be representable as a *diff* against Ethereum client software.
We imagine a world in which any Ethereum client can, with only minor modifications, participate in an Optimistic Ethereum network.
## Contributing

### Openness
### Basic Contributions

We think it's time to coordinate the Ethereum community around a well-specified optimistic rollup design.
We acknowledge that this is only possible if the design process remains open to the feedback of the many teams already working on optimistic rollup architectures.
We aim to make this both this specification and the process by which this specification is built available to anyone interesting in building their own ORU system.
Contributing to the Optimistic Ethereum specification is easy.

Anyone interested in contributing to this specification should refer to the [Contributing](#contributing) section.
You will find multiple options for contributing to this project.
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].

This repository is distributed under the [Creative Commons Zero v1.0 Universal](https://github.com/ethereum-optimism/optimistic-specs/blob/main/LICENSE) license which dedicates this work to the public domain.
An MIT licensed implementation of this protocol can be found [here](https://github.com/ethereum-optimism/optimism).
[Discussions]: https://github.com/ethereum-optimism/optimistic-specs/discussions
[Issues]: https://github.com/ethereum-optimism/optimistic-specs/issues
[pull request]: https://github.com/ethereum-optimism/optimistic-specs/pulls

### Accessibility
### R&D Calls

Users, developers, and protocol designers need to be confident that a given optimistic rollup is robust and secure.
We believe that this confidence can only truly come from an accessible specification and codebase that developers can reasonably be expected to understand.
Without this accessibility we'll always fundamentally have to trust the knowledge and competence of a very small group of core developers, a fact antithetical to the ideal decentralized nature of these systems.
We hold bi-weekly R&D calls that are open to anyone interested in contributing
to the Optimistic Ethereum spec.

## Contributing
### Basic Contributions
Contributing to the Optimistic Ethereum specification is easy.
You'll find a list of open questions and active research topics over on the [Fellowship of Ethereum Magicians](https://ethereum-magicians.org) forum.
Specific tasks and TODOs can be found on the [Issues](https://github.com/ethereum-optimism/optimistic-specs/issues) page.
You can edit content or add new pages by creating a [Pull Request](https://github.com/ethereum-optimism/optimistic-specs/pulls).
Contact [@karlfloersch], [@protolambda], [@kelvinfichter] or [@norswap] if you'd
like to join these calls. Please note that these calls may be recorded and
shared publicly (we will ask for consent before recording).

### R&D Calls
We hold weekly R&D calls that are open to anyone interested in contributing to the Optimistic Ethereum spec.
Contact [@karlfloersch](https://twitter.com/karl_dot_tech/), [@protolambda](https://github.com/protolambda/), or [@kelvinfichter](https://twitter.com/kelvinfichter) if you'd like to join these calls.
Please note that these calls may be recorded and shared publicly (we will ask for consent before recording).
[@karlfloersch]: https://twitter.com/karl_dot_tech/
[@protolambda]: https://github.com/protolambda/
[@kelvinfichter]: https://twitter.com/kelvinfichter
[@norswap]: https://twitter.com/norswap

## License

Expand Down
4 changes: 0 additions & 4 deletions assets/architecture.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/network-participants-overview.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/roadmap.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/sequencer-block-gen.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/sequencer-handling-deposits-and-transactions.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/simple-block-gen.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/user-withdrawing-to-l1.svg

This file was deleted.

4 changes: 0 additions & 4 deletions assets/verifier-executing-fraud-proof.svg

This file was deleted.

1 change: 0 additions & 1 deletion components/challenge_agent.md

This file was deleted.

43 changes: 0 additions & 43 deletions components/fraud-proof-vm/fraud_proof_program.md

This file was deleted.

50 changes: 0 additions & 50 deletions components/fraud-proof-vm/fraud_proof_vm.md

This file was deleted.

122 changes: 0 additions & 122 deletions components/rollup_node/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions components/rollup_node/batch_submitter.md

This file was deleted.

Loading

0 comments on commit 078f9d4

Please sign in to comment.