|
11 | 11 |
|
12 | 12 | ## TL;DR |
13 | 13 |
|
14 | | -This is the primary place where [Optimism](https://optimism.io) works on stuff related to [Optimistic Ethereum](https://research.paradigm.xyz/optimism). |
| 14 | +This is the primary place where [Optimism](https://optimism.io) works on stuff related to [Optimistic Ethereum](https://optimistic.etherscan.io/). |
15 | 15 |
|
16 | 16 | ## Documentation |
17 | 17 |
|
18 | 18 | Extensive documentation is available [here](http://community.optimism.io/). |
19 | 19 |
|
20 | 20 | ## Community |
21 | 21 |
|
22 | | -* [Come hang on discord](https://discord.optimism.io) |
| 22 | +Come hang on our very active [discord](https://discord.optimism.io) 🔴✨ |
23 | 23 |
|
24 | 24 | ## Contributing |
25 | 25 |
|
26 | 26 | Read through [CONTRIBUTING.md](./CONTRIBUTING.md) for a general overview of our contribution process. |
| 27 | +Then check out our list of [good first issues](https://github.com/ethereum-optimism/optimism/contribute) to find something fun to work on! |
27 | 28 |
|
28 | 29 | ## Directory Structure |
29 | 30 |
|
30 | | -* [`packages`](./packages): Contains all the typescript packages and contracts |
31 | | - * [`contracts`](./packages/contracts): Solidity smart contracts implementing the OVM |
32 | | - * [`core-utils`](./packages/core-utils): Low-level utilities and encoding packages |
33 | | - * [`common-ts`](./packages/common-ts): Common tools for TypeScript code that runs in Node |
34 | | - * [`data-transport-layer`](./packages/data-transport-layer): Event indexer, allowing the `l2geth` node to access L1 data |
35 | | - * [`batch-submitter`](./packages/batch-submitter): Daemon for submitting L2 transaction and state root batches to L1 |
36 | | - * [`message-relayer`](./packages/message-relayer): Service for relaying L2 messages to L1 |
37 | | - * [`replica-healthcheck`](./packages/replica-healthcheck): Service to monitor the health of different replica deployments |
38 | | -* [`l2geth`](./l2geth): Fork of [go-ethereum v1.9.10](https://github.com/ethereum/go-ethereum/tree/v1.9.10) implementing the [OVM](https://research.paradigm.xyz/optimism#optimistic-geth). |
39 | | -* [`integration-tests`](./integration-tests): Integration tests between a L1 testnet, `l2geth`, |
40 | | -* [`ops`](./ops): Contains Dockerfiles for containerizing each service involved in the protocol, |
41 | | -as well as a docker-compose file for bringing up local testnets easily |
42 | | - |
| 31 | +<pre> |
| 32 | +root |
| 33 | +├── <a href="./packages">packages</a> |
| 34 | +│ ├── <a href="./packages/contracts">contracts</a>: L1 and L2 smart contracts for Optimistic Ethereum |
| 35 | +│ └── <a href="./packages/core-utils">core-utils</a>: Low-level utilities that make building Optimistic Ethereum easier |
| 36 | +│ └── <a href="./packages/common-ts">common-ts</a>: Common tools for building apps in TypeScript |
| 37 | +│ └── <a href="./packages/data-transport-layer">data-transport-layer</a>: Service for indexing Optimistic Ethereum-related L1 data |
| 38 | +│ └── <a href="./packages/batch-submitter">batch-submitter</a>: Service for submitting batches of transactions and results to L1 |
| 39 | +│ └── <a href="./packages/message-relayer">message-relayer</a>: Tool for automatically relaying L1<>L2 messages in development |
| 40 | +│ └── <a href="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node |
| 41 | +├── <a href="./l2geth">l2geth</a>: Optimistic Ethereum client software, a fork of <a href="https://github.com/ethereum/go-ethereum/tree/v1.9.10">geth v1.9.10</a> |
| 42 | +├── <a href="./integration-tests">integration-tests</a>: Various integration tests for an Optimistic Ethereum network |
| 43 | +└── <a href="./ops">ops</a>: Tools for running Optimistic Ethereum nodes and networks |
| 44 | +</pre> |
43 | 45 |
|
44 | 46 | ## Branching Model and Releases |
45 | 47 |
|
|
0 commit comments