From d2461d30c8af96b943043ecc5c4b1b7f17767b11 Mon Sep 17 00:00:00 2001 From: Realasylbek4 <54204093+Realasylbek4@users.noreply.github.com> Date: Mon, 9 Dec 2024 12:37:45 +0500 Subject: [PATCH] Update README.md Signed-off-by: Realasylbek4 <54204093+Realasylbek4@users.noreply.github.com> --- README.md | 104 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index c05ca6341c..c318c2ea76 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,90 @@ -
-
- beacon-kit-banner + BeaconKit Banner
-

- A modular framework for building EVM consensus clients ⛵️✨ -

-_The project is still heavily under construction, see the [disclaimer below](#status)._ -
+

A Modular Framework for Building EVM Consensus Clients ⛵️✨

-[![CI status](https://github.com/berachain/beacon-kit/workflows/pipeline/badge.svg)](https://github.com/berachain/beacon-kit/actions/workflows/pipeline.yml) -[![CodeCov](https://codecov.io/gh/berachain/beacon-kit/graph/badge.svg?token=0l5iJ3ZbzV)](https://codecov.io/gh/berachain/beacon-kit) -[![Telegram Chat](https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fbeacon_kit)](https://t.me/beacon_kit) -[![X Follow](https://img.shields.io/twitter/follow/berachain)](https://x.com/berachain) -[![Discord](https://img.shields.io/discord/924442927399313448?label=discord)](https://discord.gg/berachain) +

+ A highly customizable framework for creating and operating EVM-based blockchains.
+ ⚠️ Project under active development — see status for details. +

+
+ + CI Status + + + Code Coverage + + + Telegram Chat + + + Follow on X + + + Join on Discord +
-## What is BeaconKit? +--- + +## 🚀 What is BeaconKit? + +[BeaconKit](https://docs.berachain.com/learn/what-is-beaconkit) is a **modular framework** designed to simplify the process of building Ethereum Virtual Machine (EVM) based consensus clients. It ensures a functionally identical execution environment to Ethereum Mainnet, offering a user-friendly approach for blockchain developers. -[BeaconKit](https://docs.berachain.com/learn/what-is-beaconkit) is a modular framework for building EVM based consensus clients. -The framework offers the most user-friendly way to build and operate an EVM blockchain, while ensuring a functionally identical execution environment to that of the Ethereum Mainnet. +--- -## Supported Execution Clients +## 💡 Supported Execution Clients -Through utilizing the [Ethereum Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine) -BeaconKit is able to support all 6 major Ethereum execution clients: +BeaconKit supports all major Ethereum execution clients through the [Ethereum Engine API](https://github.com/ethereum/execution-apis/blob/main/src/engine): -- [**Geth**](https://geth.ethereum.org/): Official Go implementation of the Ethereum protocol. -- [**Erigon**](https://erigon.tech/): More performant, feature-rich client forked from `go-ethereum`. -- [**Nethermind**](https://www.nethermind.io/): .NET based client with full support for Ethereum protocols. -- [**Besu**](https://www.lfdecentralizedtrust.org/projects/besu): Enterprise-grade client, Apache 2.0 licensed, written in Java. -- [**Reth**](https://reth.rs/): Rust-based client focusing on performance and reliability. -- [**Ethereumjs**](https://ethereumjs.readthedocs.io/en/latest/#): Javascript based client managed by the Ethereum Foundation. +- **[Geth](https://geth.ethereum.org/):** Official Go implementation of Ethereum. +- **[Erigon](https://erigon.tech/):** High-performance, feature-rich fork of Geth. +- **[Nethermind](https://www.nethermind.io/):** .NET-based client with full Ethereum protocol support. +- **[Besu](https://www.lfdecentralizedtrust.org/projects/besu):** Java-based, enterprise-grade client. +- **[Reth](https://reth.rs/):** Rust-based client focused on performance. +- **[Ethereumjs](https://ethereumjs.readthedocs.io/en/latest/#):** JavaScript-based implementation managed by the Ethereum Foundation. -## Running a Local Development Network +--- -**Prerequisites:** +## 🛠️ Running a Local Development Network + +### Prerequisites + +Ensure the following tools are installed: - [Docker](https://docs.docker.com/engine/install/) - [Golang 1.23.0+](https://go.dev/doc/install) - [Foundry](https://book.getfoundry.sh/) -Start by opening two terminals side-by-side: - -**Terminal 1:** +### Steps -```bash -# Start the sample BeaconKit Consensus Client: -make start -``` +1. **Open two terminals side-by-side.** -**Terminal 2:** + **Terminal 1:** + ```bash + # Start the sample BeaconKit Consensus Client: + make start -```bash # Start an Ethereum Execution Client: -make start-reth # or start-geth start-besu start-erigon start-nethermind start-ethereumjs -``` +make start-reth # or start-geth, start-besu, start-erigon, start-nethermind, start-ethereumjs -The account with -`private-key=0xfffdbb37105441e14b0ee6330d855d8504ff39e705c3afa8f859ac9865f99306` -corresponding with `address=0x20f33ce90a13a4b5e7697e3544c3083b8f8a51d4` is -preloaded with the native EVM token. -## Multinode Local Devnet +🔗 Multinode Local Devnet +Refer to the Kurtosis README for instructions on running a multinode local development network. -Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/blob/main/kurtosis/README.md) for more information on how to run a multinode local devnet. +⚠️ Status +This project is a work in progress. Frequent changes are expected as we finalize the system. Audits are ongoing, and BeaconKit is not yet recommended for production environments. -## Status +📄 License +BeaconKit is licensed under MIT License. -This project is work in progress and subject to frequent changes as we are still working on wiring up the final system. Audits on BeaconKit are still ongoing, and in progress at the moment. We don't recommend using BeaconKit in a production environment yet. +🛡️ Support & Community +Join us on Telegram or Discord. +Follow updates on X (formerly Twitter).