-
Notifications
You must be signed in to change notification settings - Fork 10
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 #43 from lidofinance/develop
Weekly PR to master #35
- Loading branch information
Showing
47 changed files
with
3,411 additions
and
1,026 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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# top-most EditorConfig file | ||
root = true | ||
|
||
[*] | ||
end_of_line = lf | ||
insert_final_newline = true | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 4 | ||
|
||
[*.{js,yml,json,cjs,ts}] | ||
indent_size = 2 |
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
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
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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: Tests | ||
|
||
on: | ||
pull_request: | ||
branches: [master, develop] | ||
|
||
jobs: | ||
coverage: | ||
name: Solidity coverage | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
persist-credentials: false | ||
|
||
- run: corepack enable | ||
|
||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: 20 | ||
cache: "pnpm" | ||
|
||
- name: Install dependencies | ||
run: pnpm install | ||
|
||
- name: Run Solidity coverage | ||
run: pnpm test:coverage | ||
|
||
- name: Produce the coverage report | ||
uses: insightsengineering/coverage-action@v2 | ||
with: | ||
path: ./coverage/cobertura-coverage.xml | ||
publish: true | ||
diff: true | ||
diff-branch: master | ||
diff-storage: _core_coverage_reports | ||
coverage-summary-title: "Code Coverage Summary" |
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
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,40 +1,65 @@ | ||
# Lido Core | ||
<div style="display: flex; flex-direction: column; align-items: center; justify-content: center;"> | ||
<img alt="Lido on Ethereum Logo" src="./docs/assets/lido.png" width="500"/> | ||
</div> | ||
|
||
## Develop | ||
**Lido on Ethereum** is a liquid-staking protocol allowing anyone to earn staking rewards without locking ether or maintaining infrastructure. | ||
|
||
```sh | ||
# install deps | ||
pnpm install | ||
Key features: | ||
|
||
# run tests | ||
pnpm test | ||
- No minimum deposit amount, | ||
- Instant rewards within 24 hours of deposit, | ||
- stETH, an LST with the deepest liquidity in DeFi, | ||
- In-protocol automated withdrawals, | ||
- Governed by Lido DAO. | ||
|
||
Learn more: | ||
|
||
- [Lido DAO](https://docs.lido.fi/lido-dao) | ||
- [Contracts](https://docs.lido.fi/contracts/lido) | ||
- [Addresses](https://docs.lido.fi/deployed-contracts/) | ||
- [Protocol levers](https://docs.lido.fi/guides/protocol-levers/) | ||
|
||
## Development | ||
|
||
**NB:** Please read [Documentation](https://docs.lido.fi/) before getting started. | ||
|
||
### Requirements | ||
|
||
- Shell - bash or zsh | ||
- [Node.js v20](https://nodejs.org/en) | ||
- [Pnpm](https://pnpm.io/) | ||
- [Foundry](https://book.getfoundry.sh/) | ||
|
||
### Setup | ||
|
||
> Installation is local and doesn't require root privileges. | ||
Install dependencies | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
## Setup | ||
### Test | ||
|
||
- node.js v20 | ||
- pnpm | ||
- hardhat | ||
- ethers v6 | ||
- typechain | ||
- commitlint | ||
- lint-staged | ||
- eslint | ||
- prettier | ||
- solhint | ||
- slither | ||
Run tests | ||
|
||
## Todos | ||
```bash | ||
pnpm test | ||
``` | ||
|
||
- anvil | ||
- readme | ||
# License | ||
|
||
## Conventions | ||
2023 Lido <[email protected]> | ||
|
||
- use the `batch` helper to resolve multiple promises in parallel | ||
- use `Snapshot` helper to restore the state at the end of suite | ||
- use `expect` statements instead of `assert` | ||
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. | ||
|
||
### Pending | ||
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. | ||
|
||
- test optional ERC-20 methods | ||
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/>. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Oops, something went wrong.