README
¶
About Kroma
Kroma is the first universal stage 2 Layer 2 (L2) on Ethereum. Kroma has been developed based on Optimism Bedrock architecture, and aims to be a universal ZK rollup. Currently, Kroma operates as an Optimistic rollup with ZK fault proofs, utilizing a zkEVM based on Scroll. The goal of Kroma is to eventually transition to a ZK rollup once the generation of ZK proofs becomes more cost-efficient and faster.
Kroma offers lower transactions fees compared to the Ethereum mainnet, with native Ethereum security and EVM equivalence. Our roadmap to transition from Optimistic rollup to ZK rollup sets Kroma apart from other L2 networks. Additionally, Kroma is advancing towards decentralization. As an initial step for this, Kroma has introduced a permissionless validator and challenge system.
For more detailed information about Kroma, check Kroma docs (or spec docs).
Links
- Official Website: Kroma
- Documentation: Kroma Docs
- Blog: Kroma Medium
- Discord: Kroma Discord
- X (Twitter): Kroma X
Contributing
Read through CONTRIBUTING.md for a general overview of our contribution process. Use the Developer Quick Start to get your development environment set up to start working on the Kroma repository. Then check out our list of Good First Issues to find something fun to work on!
Security Policy
Please refer to the canonical Security Policy document for detailed information about how to report vulnerabilities in this codebase.
License
All files within this repository are licensed under the MIT License unless stated otherwise.
Directories
¶
| Path | Synopsis |
|---|---|
|
components
|
|
|
node/heartbeat
Package heartbeat provides a service for sending heartbeats to a server.
|
Package heartbeat provides a service for sending heartbeats to a server. |
|
node/metrics
Package metrics provides a set of metrics for the kroma-node.
|
Package metrics provides a set of metrics for the kroma-node. |
|
node/rollup/derive
Package derive provides the data transformation functions that take L1 data and turn it into L2 blocks and results.
|
Package derive provides the data transformation functions that take L1 data and turn it into L2 blocks and results. |
|
node/rollup/sync
Package sync is responsible for reconciling L1 and L2.
|
Package sync is responsible for reconciling L1 and L2. |
|
node/sources
Package sources exports a number of clients used to access ethereum chain data.
|
Package sources exports a number of clients used to access ethereum chain data. |
|
node/testlog
Package testlog provides a log handler for unit tests.
|
Package testlog provides a log handler for unit tests. |
|
packages
|
|
|
service/clock
Package clock provides an abstraction for time to enable testing of functionality that uses time as an input.
|
Package clock provides an abstraction for time to enable testing of functionality that uses time as an input. |
|
service/tls
This file contains CLI and env TLS configurations that can be used by clients or servers
|
This file contains CLI and env TLS configurations that can be used by clients or servers |
|
service/tls/certman
Package certman provides live reloading of the certificate and key files used by the standard library http.Server.
|
Package certman provides live reloading of the certificate and key files used by the standard library http.Server. |