https://github.com/kaonone/yearn-router
https://github.com/kaonone/yearn-router
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaonone/yearn-router
- Owner: kaonone
- License: gpl-3.0
- Created: 2022-04-05T10:52:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-07T09:51:42.000Z (almost 3 years ago)
- Last Synced: 2025-01-24T06:12:44.095Z (4 months ago)
- Language: Python
- Size: 144 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yearn-router
A routing contract for Yearn vaults.
For more on this please see [Yearn Documentation](https://docs.yearn.finance/partners/integration_guide#delegated-deposit).
## Development
### Clone repository
- clone using HTTPS
```bash
git clone https://github.com/akropolisio/yearn-proxy.git
```
- or SSH
```bash
[email protected]:akropolisio/yearn-proxy.git
```
- change directory to yearn-proxy
```bash
cd yearn-proxy
```
### Setup environment
#### VSCode + Docker (recommended)
- install [Docker](https://docs.docker.com/get-docker/)
- install [VSCode](https://code.visualstudio.com/)
- install [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode extension
- open cloned repository in VSCode
- click F1 and run `>Remote-Containers: Reopen in Container`
- wait until all dependencies are installed (you will see the message "Done. Press any key to close the terminal." in the terminal `Configuring`)
#### Local
- you will need Python 3.8 and Node.js >=14.x
- install dependencies:
```bash
make clean && make install-all
```
### Setup .env
- run `cp .example.env .env`
- insert keys into `.env`
### Run tests
- to run tests, "-s" will provide print outputs which this test suite uses to visualize yield:
```bash
brownie test -s
```