Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: readme refresh #814

Merged
merged 5 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
# Lido Ethereum Liquid Staking Protocol

[![Tests](https://github.com/lidofinance/lido-dao/workflows/Tests/badge.svg)](https://github.com/lidofinance/lido-dao/actions)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

The Lido Ethereum Liquid Staking Protocol allows their users to earn staking rewards on the Beacon chain without locking Ether or maintaining staking infrastructure.
![Lido on Ethereum Logo](./assets/img/lido.png)

<div style="display: flex;" align="center">
<img alt="GitHub license" src="https://img.shields.io/github/license/lidofinance/lido-dao?color=orange">
<img alt="NodeJS" src="https://img.shields.io/badge/Node_JS-18-blue">
<img alt="Solidity" src="https://img.shields.io/badge/solidity-multiver-blue">
<img alt="Hardhat" src="https://img.shields.io/badge/hardhat-^2.12-blue">
<img alt="Aragon OS" src="https://img.shields.io/badge/Aragon_OS-4.4.0-blue">
<img alt="GitHub tests" src="https://img.shields.io/github/actions/workflow/status/lidofinance/lido-dao/linters.yml?label=tests">
<img alt="GitHub code analysis" src="https://img.shields.io/github/actions/workflow/status/lidofinance/lido-dao/analyse.yml?label=code analysis">
<img alt="GitHub Bytecode" src="https://img.shields.io/github/actions/workflow/status/lidofinance/lido-dao/assert-bytecode.yml?label=assert bytecode">
</div>
<br/>

The **Lido on Ethereum Liquid Staking Protocol** allows their users to earn staking rewards on the Beacon chain without locking Ether or maintaining staking infrastructure.

Users can deposit Ether to the Lido smart contract and receive stETH tokens in return. The smart contract then stakes tokens with the DAO-picked node operators. Users' deposited funds are pooled by the DAO, node operators never have direct access to the users' assets.

TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
Unlike staked ether, the stETH token is free from the limitations associated with a lack of liquidity and can be transferred at any time. The stETH token balance corresponds to the amount of Ether that the holder could request to withdraw.

TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
Before getting started with this repo, please read:

* [Documentation](https://docs.lido.fi/)
**NB:** It's advised to read [Documentation](https://docs.lido.fi/) before getting started with this repo.

## Lido DAO

The Lido DAO is a Decentralized Autonomous Organization that manages the liquid staking protocol by deciding on key parameters (e.g., setting fees, assigning node operators and oracles, etc.) through the voting power of governance token (DPG) holders.
The [Lido DAO](https://docs.lido.fi/lido-dao) is a Decentralized Autonomous Organization that manages the liquid staking protocol by deciding on key parameters (e.g., setting fees, assigning node operators and oracles, performing upgrades, etc.) through the voting power of governance token (LDO) holders.

Also, the DAO will accumulate service fees and spend them on insurance, research, development, and protocol upgrades. Initial DAO members will take part in the threshold signature for Ethereum 2.0 by making BLS threshold signatures.
Also, the Lido DAO accumulates service fees and spends them on research, development, protocol upgrades execution, and hypothetical coverage applications.

TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
The Lido DAO is an [Aragon organization](https://aragon.org/dao). Since Aragon provides a full end-to-end framework to build DAOs, we use its standard tools. The protocol smart contracts extend AragonApp base contract and can be managed by the DAO.
The Lido DAO is an [Aragon organization](https://aragon.org/dao).

TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
## Protocol levers

A full list of protocol levers that are controllable by the Aragon DAO can be found [here](https://docs.lido.fi/guides/protocol-levers/).

## Contracts

For the contracts description see https://docs.lido.fi/ contracts section.
For the contracts description see <https://docs.lido.fi/> contracts section.

## Deployments

For the protocol contracts addresses see https://docs.lido.fi/deployed-contracts/
For the protocol contracts addresses see <https://docs.lido.fi/deployed-contracts/>

## Development

Expand All @@ -45,7 +52,7 @@ For the protocol contracts addresses see https://docs.lido.fi/deployed-contracts
* curl
* cut
* docker
* node.js v16
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
* node.js v18
* (optional) Lerna
* (optional) Foundry

Expand Down Expand Up @@ -88,7 +95,7 @@ yarn test:coverage
Test coverage is reported to `coverage.json` and `coverage/index.html` files located
inside each app's folder.

Keep in mind that the code uses `assert`s to check invariants that should always be kept
> Keep in mind that the code uses `assert`s to check invariants that should always be kept
unless the code is buggy (in contrast to `require` statements which check pre-conditions),
so full branch coverage will never be reported until
[solidity-coverage#219] is implemented.
Expand All @@ -105,14 +112,8 @@ forge test

## Deploying

We have several ways to deploy lido smart-contracts and run DAO locally, you can find documents here:

`lido-aragon` [documentation](/docs/lido-aragon.md)

For local development, please see [local documentation](/docs/dev-local.md)

To develop/test on fork, please see [fork documentation](/docs/dev-fork.md)

To deploy the smart contracts and run the protocol instance either locally or on a new testnet,
please proceed to the following [scratch deploy documentation](/docs/scratch-deploy.md)

# License

Expand Down
Binary file added assets/img/lido.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading