-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(README.md): update README and LICENSE (#528)
- Loading branch information
1 parent
e455167
commit 322ad9c
Showing
2 changed files
with
79 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # License | ||
|
|
||
| Copyright 2024 Consensys Software Inc. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,64 @@ | ||
| # zk-evm-notes | ||
| Home of Linea's zk-evm specification. | ||
| # Linea zk-EVM specification | ||
|
|
||
| This repository hosts the specification of the constraint system underlying Linea's zk-EVM. | ||
|
|
||
| Constraints are mathematical equations and a constraint system is a collection of such equations. Linea’s constraint system aims to capture the logic of valid EVM executions. | ||
|
|
||
| The constraints specified here are implemented in the [linea-constraints](https://github.com/Consensys/linea-constraints) repo. | ||
|
|
||
| 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 | ||
| todo --> | ||
|
|
||
|
|
||
| ## Looking for the Linea code? | ||
|
|
||
| Linea's stack is made up of multiple repositories, these include: | ||
|
|
||
| - This repo, [linea-specification](https://github.com/Consensys/linea-specification): Specification of the constraint system defining Linea's zk-EVM | ||
| - [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 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-spec/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-spec/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-spec/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). | ||
|
|
||
| Before contributing, ensure you're familiar with: | ||
|
|
||
| - Our [Linea contribution guide](https://github.com/Consensys/linea-monorepo/blob/main/docs/contribute.md) | ||
| - Our [Linea code of conduct](https://github.com/Consensys/linea-monorepo/blob/main/docs/code-of-conduct.md) | ||
| - The [Besu contribution guide](https://github.com/Consensys/linea-monorepo/blob/main/https://wiki.hyperledger.org/display/BESU/Coding+Conventions), for Besu:Linea related contributions | ||
| - Our [Security policy](https://github.com/Consensys/linea-monorepo/blob/main/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) |