lighthouse-pulse/README.md

# Lighthouse-Pulse: A PulseChain Consensus Client Written in Rust

This is the core repository for Lighthouse-Pulse, a [Rust](https://www.rust-lang.org/) implementation of the [Ethereum Consensus](https://ethereum.org/en/eth2/) specification, originally developed by [Sigma Prime](https://sigmaprime.io/) and modified for usage with [PulseChain](https://pulsechain.com/). See the [Changelog](https://gitlab.com/pulsechaincom/lighthouse-pulse/-/releases) for details of the latest releases and upcoming breaking changes.

> Credit to the [Sigma Prime](https://sigmaprime.io/) team for the original implementation of [Lighthouse](https://github.com/sigp/lighthouse).

[Documentation](https://lighthouse-book.sigmaprime.io)

## Overview

Lighthouse-Pulse is:

- Ready for use on Ethereum consensus mainnet & PulseChain consensus testnets/mainnet.
- Fully open-source, licensed under Apache 2.0.
- Security-focused. Fuzzing techniques have been continuously applied and several external security reviews have been performed.
- Built in [Rust](https://www.rust-lang.org), a modern language providing unique safety guarantees and
	excellent performance (comparable to C++).

## Staking Deposit Contract

The PulseChain team acknowledges `0x3693693693693693693693693693693693693693` as the canonical staking deposit contract address.

## Documentation

The upstream [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and
developers.

## Contact

For additional support, feel free to join [the PulseChain telegram channel](https://t.me/PulseDEV).

## License

[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
Update readme 2023-02-01 21:42:16 +00:00			`# Lighthouse-Pulse: A PulseChain Consensus Client Written in Rust`
Update readme 2019-06-25 04:02:19 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`This is the core repository for Lighthouse-Pulse, a [Rust](https://www.rust-lang.org/) implementation of the [Ethereum Consensus](https://ethereum.org/en/eth2/) specification, originally developed by [Sigma Prime](https://sigmaprime.io/) and modified for usage with [PulseChain](https://pulsechain.com/). See the [Changelog](https://gitlab.com/pulsechaincom/lighthouse-pulse/-/releases) for details of the latest releases and upcoming breaking changes.`
Initial commit 2018-07-06 07:54:07 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`> Credit to the [Sigma Prime](https://sigmaprime.io/) team for the original implementation of [Lighthouse](https://github.com/sigp/lighthouse).`
Refactor docs into mdbook (#547) * Refactor documentation, ef_tests makefile * Add makefile to root * Tidy readme * Fix readme badges * Tidy logs * Add terminalize gif * Update readme image * Update readme image * Tidy logs * Update readme image * Update readme * Update readme * Fix book link * Update makefiles * Update book * Fix link in book * Add readme for book * Remove old docs, move api spec YAML * Fix eth2/ dir readme * Add readme for lcli * Add about this book section * Minor formatting improvements * Address mehdi's comments 2019-10-02 01:04:56 +00:00
Changed http:// to https:// on some links (#1869) Changed http:// to https:// on some links in README.md 2020-11-09 01:28:39 +00:00			`[Documentation](https://lighthouse-book.sigmaprime.io)`
Validator on-boarding docs (#656) * Add first draft of validator onboarding * Update docs * Add documentation link to main README * Continue docs development * Update book readme * Update docs * Allow vc to run without testnet subcommand * Small change to onboarding docs * Tidy CLI help messages * Update docs * Add check to val client see if beacon node is synced * Add notifier service to validator client * Re-order onboarding steps * Update deposit contract address * Update testnet dir * Add note about public eth1 node * Set default eth1 endpoint to sigp * Fix broken test * Try fix eth1 cache locking * Be more specific about eth1 endpoint * Increase gas limit for deposit * Fix default deposit amount 2019-12-09 11:42:36 +00:00
Update readme 2019-06-25 04:02:19 +00:00			`## Overview`

Update readme 2023-02-01 21:42:16 +00:00			`Lighthouse-Pulse is:`
Update readme 2019-06-25 04:02:19 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`- Ready for use on Ethereum consensus mainnet & PulseChain consensus testnets/mainnet.`
Update readme 2019-06-25 04:02:19 +00:00			`- Fully open-source, licensed under Apache 2.0.`
Update security details in README (#1956) ## Proposed Changes Introduces a few minor changes to the README, mainly updating mentions about security. 2020-11-24 10:29:39 +00:00			`- Security-focused. Fuzzing techniques have been continuously applied and several external security reviews have been performed.`
Changed http:// to https:// on some links (#1869) Changed http:// to https:// on some links in README.md 2020-11-09 01:28:39 +00:00			`- Built in [Rust](https://www.rust-lang.org), a modern language providing unique safety guarantees and`
Update readme 2019-06-25 04:02:19 +00:00			`excellent performance (comparable to C++).`

Rename Eth1/Eth2 in documents (#3021) ## Issue Addressed Resolves https://github.com/sigp/lighthouse/issues/3019 ## Proposed Changes - Eth2 Eth2.0 Ethereum 2.0 -> Ethereum consensus - Eth2 network -> consensus layer - Ethereum 2.0 specification -> Ethereum proof-of-stake consensus specification - Eth2 deposit contract -> Staking deposit contract - Eth1 -> execution client ## Additional Info The description needs to be updated by someone who has permission to do. 📝 <img width="487" alt="image" src="https://user-images.githubusercontent.com/1885716/153995211-816d9561-751e-4810-abb9-83d979379783.png"> 2022-03-02 01:05:08 +00:00			`## Staking Deposit Contract`
Add warnings for deposits (#1858) ## Issue Addressed NA ## Proposed Changes Add some warnings to discourage users to user Lighthouse for mainnet. ## Additional Info NA 2020-11-04 19:46:42 +00:00
Update readme 2023-02-01 21:42:16 +00:00			The PulseChain team acknowledges `0x3693693693693693693693693693693693693693` as the canonical staking deposit contract address.
Add warnings for deposits (#1858) ## Issue Addressed NA ## Proposed Changes Add some warnings to discourage users to user Lighthouse for mainnet. ## Additional Info NA 2020-11-04 19:46:42 +00:00
Update validator guide for mainnet (#1951) ## Issue Addressed NA ## Proposed Changes Updates the validator guide to provide instructions for mainnet users. ## Additional Info - ~~Blocked on #1751~~ 2020-11-24 04:42:17 +00:00			`## Documentation`
Update readme 2019-06-25 04:02:19 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`The upstream [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and`
Update validator guide for mainnet (#1951) ## Issue Addressed NA ## Proposed Changes Updates the validator guide to provide instructions for mainnet users. ## Additional Info - ~~Blocked on #1751~~ 2020-11-24 04:42:17 +00:00			`developers.`
Update readme 2019-06-25 04:02:19 +00:00
Initial commit 2018-07-06 07:54:07 +00:00			`## Contact`

Update readme 2023-02-01 21:42:16 +00:00			`For additional support, feel free to join [the PulseChain telegram channel](https://t.me/PulseDEV).`
Update README.md 2018-12-19 01:54:31 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`## License`
Update README.md 2018-12-19 01:54:31 +00:00
Update readme 2023-02-01 21:42:16 +00:00			`[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)`