-
Notifications
You must be signed in to change notification settings - Fork 190
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #840 from lidofinance/readme-deprecation
update Readme: repo archived
- Loading branch information
Showing
1 changed file
with
4 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,130 +1,6 @@ | ||
|  | ||
| ⚠️ Repository Archived! | ||
|
|
||
| <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/> | ||
| Important Notice! | ||
| This repository has been archived and is no longer actively maintained. For the latest version of the Lido on Ethereum protocol, please visit the new official repository: [Lido core](https://github.com/lidofinance/core). | ||
|
|
||
| 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, and node operators never have direct access to the users' assets. | ||
|
|
||
| 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. | ||
|
|
||
| **NB:** It's advised to read [Documentation](https://docs.lido.fi/) before getting started with this repo. | ||
|
|
||
| ## Lido DAO | ||
|
|
||
| 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. | ||
|
|
||
| The Lido DAO charges service fees that support infrastructure maintenance, research, development, protocol upgrades, and potential loss coverage. | ||
|
|
||
| The Lido DAO was built using the [Aragon DAO]((https://aragon.org/dao)) framework. | ||
|
|
||
| ## 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. | ||
|
|
||
| ## Deployments | ||
|
|
||
| For the protocol contracts addresses see <https://docs.lido.fi/deployed-contracts/> | ||
|
|
||
| ## Development | ||
|
|
||
| ### Requirements | ||
|
|
||
| * shell - bash or zsh | ||
| * find | ||
| * sed | ||
| * jq | ||
| * curl | ||
| * cut | ||
| * node.js v18 | ||
| * (optional) Lerna | ||
| * (optional) Foundry | ||
|
|
||
| ### Installing Aragon & other deps | ||
|
|
||
| Installation is local and doesn't require root privileges. | ||
|
|
||
| If you have `yarn` installed globally: | ||
|
|
||
| ```bash | ||
| yarn | ||
| ``` | ||
|
|
||
| otherwise: | ||
|
|
||
| ```bash | ||
| npx yarn | ||
| ``` | ||
|
|
||
| ### Build & test | ||
|
|
||
| Run unit tests: | ||
|
|
||
| ```bash | ||
| yarn test | ||
| ``` | ||
|
|
||
| Run unit tests and report gas used by each Solidity function: | ||
|
|
||
| ```bash | ||
| yarn test:gas | ||
| ``` | ||
|
|
||
| Generate unit test coverage report: | ||
|
|
||
| ```bash | ||
| 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 | ||
| 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. | ||
|
|
||
| [solidity-coverage#219]: https://github.com/sc-forks/solidity-coverage/issues/269 | ||
|
|
||
| Run fuzzing tests with foundry: | ||
|
|
||
| ```bash | ||
| curl -L https://foundry.paradigm.xyz | bash | ||
| foundryup | ||
| forge test | ||
| ``` | ||
|
|
||
| ## Deploying | ||
|
|
||
| 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 | ||
|
|
||
| 2023 Lido <[email protected]> | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, version 3 of the License, or any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
|
|
||
| You should have received a copy of the [GNU General Public License](LICENSE) | ||
| along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| All future updates, issues, and pull requests should be directed to the new repository. |