Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Beacy authored Feb 14, 2023
1 parent 62b30f0 commit c0b95d2
Showing 1 changed file with 35 additions and 37 deletions.
72 changes: 35 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,61 +7,59 @@
<a href="https://goreportcard.com/report/github.com/obolnetwork/charon"><img src="https://goreportcard.com/badge/github.com/obolnetwork/charon"></a>
<a href="https://github.com/ObolNetwork/charon/actions/workflows/golangci-lint.yml"><img src="https://github.com/obolnetwork/charon/workflows/golangci-lint/badge.svg"></a></p>

This repo contains the source code for the distributed validator client _Charon_ (pronounced 'kharon'); a HTTP middleware client for Ethereum Staking that enables you to safely run a single validator across a group of independent nodes.
Ця репозиторія містить вихідний код розподіленого клієнта валідатора _Charon_ (вимовляється як "харон") - HTTP-клієнта проміжного програмного забезпечення для стейкінга Ethereum, який дозволяє безпечно запускати один валідатор на групі незалежних вузлів.

Charon is accompanied by a webapp called the [Distributed Validator Launchpad](https://goerli.launchpad.obol.tech/) for distributed validator key creation.
Charon супроводжується веб-додатком під назвою [Distributed Validator Launchpad](https://goerli.launchpad.obol.tech/) для розподіленого створення ключів валідаторів.

Charon is used by stakers to distribute the responsibility of running Ethereum Validators across a number of different instances and client implementations.
Charon використовується стейкерами для розподілу відповідальності за запуск валідаторів Ethereum між різними екземплярами і клієнтськими реалізаціями.

![Example Obol Cluster](./docs/images/DVCluster.png)

###### A Distributed Validator Cluster that uses the Charon client to hedge client and hardware failure risks
###### Розподілений кластер валідаторів, який використовує клієнт Charon для хеджування ризиків відмов клієнта та обладнання

## Quickstart
## Початок роботи

The easiest way to test out charon is with the [charon-distributed-validator-cluster](https://github.com/ObolNetwork/charon-distributed-validator-cluster) repo
which contains a docker compose setup for running a full charon cluster on your local machine.
Найпростіший спосіб протестувати Charon - це за допомогою [charon-distributed-validator-cluster](https://github.com/ObolNetwork/charon-distributed-validator-cluster) репозиторій який містить налаштування docker compose для запуску повного кластера charon на вашому локальному комп'ютері.
## Документація

## Documentation
Веб-сайт [Obol Docs] (https://docs.obol.tech/) - найкраще місце для початку роботи.
Важливими розділами є [вступ] (https://docs.obol.tech/docs/intro),
[ключові поняття] (https://docs.obol.tech/docs/int/key-concepts) та [charon] (https://docs.obol.tech/docs/dv/introducing-charon).

The [Obol Docs](https://docs.obol.tech/) website is the best place to get started.
The important sections are [intro](https://docs.obol.tech/docs/intro),
[key concepts](https://docs.obol.tech/docs/int/key-concepts) and [charon](https://docs.obol.tech/docs/dv/introducing-charon).
Детальна документація по цьому репо знаходиться в папці [docs](docs):

For detailed documentation on this repo, see the [docs](docs) folder:
- [Конфігурація](docs/configuration.md): Налаштування вузла charon
- [Архітектура](docs/architecture.md): Огляд архітектури кластерів та вузлів charon
- [Структура проекту](docs/structure.md): Структура теки проекту
- [Модель розгалужень та релізів](docs/branching.md): Модель розгалуження та релізів у Git'і
- [Настанови щодо переходу](docs/goguidelines.md): Настанови та принципи, що стосуються розробки на основі go
- [Внесок](docs/contributing.md): Як зробити внесок у charon; githooks, шаблони PR тощо.

- [Configuration](docs/configuration.md): Configuring a charon node
- [Architecture](docs/architecture.md): Overview of charon cluster and node architecture
- [Project Structure](docs/structure.md): Project folder structure
- [Branching and Release Model](docs/branching.md): Git branching and release model
- [Go Guidelines](docs/goguidelines.md): Guidelines and principals relating to go development
- [Contributing](docs/contributing.md): How to contribute to charon; githooks, PR templates, etc.
Завжди є [charon godocs](https://pkg.go.dev/github.com/obolnetwork/charon) для документації з вихідного коду.

There is always the [charon godocs](https://pkg.go.dev/github.com/obolnetwork/charon) for the source code documentation.
## Підтримувані клієнти рівня консенсусу

## Supported Consensus Layer Clients
Charon інтегрується в стек консенсусу Ethereum в якості проміжного програмного забезпечення між клієнтом валідатора
і вузлом-маяком через офіційний [Eth Beacon Node REST API] (https://ethereum.github.io/beacon-APIs/#/).
Charon підтримує будь-який висхідний вузол-маяк, який обслуговує Beacon API.
Charon прагне підтримувати будь-який наступний автономний клієнт валідатора, який використовує Beacon API.

Charon integrates into the Ethereum consensus stack as a middleware between the validator client
and the beacon node via the official [Eth Beacon Node REST API](https://ethereum.github.io/beacon-APIs/#/).
Charon supports any upstream beacon node that serves the Beacon API.
Charon aims to support any downstream standalone validator client that consumes the Beacon API.

| Client | Beacon Node | Validator Client | Notes |
| Клієнт | Маяковий вузол| Клієнт валідатора | Примітки |
| -------------------------------------------------- | :---------: | :--------------: |-----------------------------------------|
| [Teku](https://github.com/ConsenSys/teku) ||| Fully supported |
| [Lighthouse](https://github.com/sigp/lighthouse) ||| Fully supported |
| [Lodestar](https://github.com/ChainSafe/lodestar) || \*️⃣ | DVT compatibility issue |
| [Vouch](https://github.com/attestantio/vouch) | \*️⃣ || Only validator client provided |
| [Prysm](https://github.com/prysmaticlabs/prysm) || 🛑 | Validator client requires gRPC API |
| [Nimbus](https://github.com/status-im/nimbus-eth2) ||| Soon to be supported |
| [Teku](https://github.com/ConsenSys/teku) ||| Повністю підтримується |
| [Lighthouse](https://github.com/sigp/lighthouse) ||| Повністю підтримується |
| [Lodestar](https://github.com/ChainSafe/lodestar) || \*️⃣ | Проблема сумісності з DVT |
| [Vouch](https://github.com/attestantio/vouch) | \*️⃣ || Надається тільки клієнт валідатора |
| [Prysm](https://github.com/prysmaticlabs/prysm) || 🛑 | Клієнту валідатора потрібен gRPC API |
| [Nimbus](https://github.com/status-im/nimbus-eth2) |||Незабаром буде підтримуватися |

## Project Status
## Статус проекту

It is still early days for the Obol Network and things are under active development.
We are moving fast so check back in regularly to track the progress.
Мережа Obol ще тільки починає свою діяльність і знаходиться в стадії активного розвитку.
Ми рухаємося швидко, тому регулярно заглядайте до нас, щоб відслідковувати прогрес.

Charon is a distributed validator, so its main responsibility is performing validation duties.
The following table outlines which clients have produced which duties on a public testnet, and which are still under construction (🚧 )
Charon є розподіленим валідатором, тому його основним обов'язком є виконання обов'язків валідації.
У наступній таблиці показано, які клієнти створили певні обов'язки у загальнодоступній тестовій мережі, а які все ще перебувають на стадії розробки (🚧 )

| Duty \ Client | Teku | Lighthouse | Lodestar | Nimbus | Vouch | Prysm |
|--------------------------------------|:----------------------------------------------:|:------------------------------------------------:|:--------:|:------:|:-----:|:-----:|
Expand Down

0 comments on commit c0b95d2

Please sign in to comment.