mirror of
https://github.com/vacp2p/linea-monorepo.git
synced 2026-01-09 23:47:55 -05:00
5a8e26bf87
* docs: Starts fixing zk-EVM to zkEVM * docs: fixes zk-EVM and light proof * Update prover/README.md Signed-off-by: Julien Marchand <julien-marchand@users.noreply.github.com> --------- Signed-off-by: Julien Marchand <julien-marchand@users.noreply.github.com> Co-authored-by: Julien Marchand <julien-marchand@users.noreply.github.com>
60 lines
3.1 KiB
Markdown
60 lines
3.1 KiB
Markdown
# Linea zkEVM
|
|
|
|
This is the principal Linea repository. It mainly includes the smart contracts covering Linea's core functions, the prover in charge of generating ZK proofs, the coordinator responsible for multiple orchestrations, and the Postman to execute bridge messages.
|
|
|
|
It serves developers by making the Linea tech stack open source under the [Apache 2.0 license](LICENSE).
|
|
|
|
## What is Linea?
|
|
|
|
[Linea](https://linea.build) is a developer-ready layer 2 network scaling Ethereum. It's secured with a zero-knowledge rollup, built on lattice-based cryptography, and powered by [Consensys](https://consensys.io).
|
|
|
|
|
|
## Get started
|
|
|
|
If you already have an understanding of the tech stack, use our [Get Started](docs/get-started.md) guide.
|
|
|
|
## Looking for the Linea code?
|
|
|
|
Linea's stack is made up of multiple repositories, these include:
|
|
|
|
- This repo, [linea-monorepo](https://github.com/Consensys/linea-monorepo): The main repository for the Linea stack & network
|
|
- [linea-besu](https://github.com/Consensys/linea-besu): Fork of Besu to implement the Linea-Besu client
|
|
- [linea-sequencer](https://github.com/Consensys/linea-sequencer): A set of Linea-Besu plugins for the sequencer and RPC nodes
|
|
- [linea-tracer](https://github.com/Consensys/linea-tracer): Linea-Besu plugin which produces the traces that the constraint system applies and that serve as inputs to the prover
|
|
- [linea-constraints](https://github.com/Consensys/linea-constraints): Implementation of the constraint system from the specification
|
|
- [linea-specification](https://github.com/Consensys/linea-specification): Specification of the constraint system defining Linea's zkEVM
|
|
|
|
Linea abstracts away the complexity of this technical architecture to allow developers to:
|
|
|
|
- [Bridge tokens](https://docs.linea.build/developers/guides/bridge)
|
|
- [Deploy a contract](https://docs.linea.build/developers/quickstart/deploy-smart-contract)
|
|
- [Run a node](https://docs.linea.build/developers/guides/run-a-node)
|
|
|
|
... and more.
|
|
|
|
## How to contribute
|
|
|
|
Contributions of any kind are welcome!
|
|
|
|
1. [Create an issue](https://github.com/Consensys/linea-monorepo/issues)
|
|
> If the proposed update is non-trivial, also tag us for discussion.
|
|
2. Submit the update as a pull request from your [fork of this repo](https://github.com/Consensys/linea-monorepo/fork), and tag us for review.
|
|
> Include the issue number in the pull request description and (optionally) in the branch name.
|
|
|
|
Consider starting with a ["good first issue"](https://github.com/ConsenSys/linea-monorepo/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
|
|
|
Before contributing, ensure you're familiar with:
|
|
|
|
- Our [contribution guide](docs/contribute.md)
|
|
- Our [code of conduct](docs/code-of-conduct.md)
|
|
- The [Besu contribution guide](https://wiki.hyperledger.org/display/BESU/Coding+Conventions), for Besu:Linea related contributions
|
|
- Our [Security policy](docs/security.md)
|
|
|
|
### Useful links
|
|
|
|
- [Linea docs](https://docs.linea.build)
|
|
- [Linea blog](https://linea.mirror.xyz)
|
|
- [Support](https://support.linea.build)
|
|
- [Discord](https://discord.gg/linea)
|
|
- [Twitter](https://twitter.com/LineaBuild)
|