Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yearn/zaps
Repository for v2 Vaults Zaps
https://github.com/yearn/zaps
Last synced: 8 days ago
JSON representation
Repository for v2 Vaults Zaps
- Host: GitHub
- URL: https://github.com/yearn/zaps
- Owner: yearn
- License: agpl-3.0
- Created: 2021-02-11T13:32:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-29T03:33:50.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T19:34:59.045Z (over 1 year ago)
- Language: Solidity
- Size: 139 KB
- Stars: 5
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yearn Zaps
## What you'll find here
- Useful Contracts to interact with the Yearn Protocol Smart Contracts ([`contracts/`](contracts/))
- Interfaces for some of the most used DeFi protocols on ethereum mainnet. ([`interfaces/`](`interfaces/`))
- Sample test suite that runs on mainnet fork. ([`tests/`](tests))
This mix is configured for use with [Ganache](https://github.com/trufflesuite/ganache-cli) on a [forked mainnet](https://eth-brownie.readthedocs.io/en/stable/network-management.html#using-a-forked-development-network).
## How does it work for the User
Let's say Alice holds 100 DAI and wants to start earning yield % on them.
For this Alice needs to `DAI.approve(zap.address, 100)`.
Then Alice will call the Zap Contract e.g `Zap.deposit(100)`.
Vault will then transfer 100 DAI from Alice to itself, and mint Alice the corresponding shares.
Alice can then redeem those shares using `Vault.withdrawAll()` for the corresponding DAI balance (exchanged at `Vault.pricePerShare()`).
## Installation and Setup
1. [Install Brownie](https://eth-brownie.readthedocs.io/en/stable/install.html) & [Ganache-CLI](https://github.com/trufflesuite/ganache-cli), if you haven't already.
2. Sign up for [Infura](https://infura.io/) and generate an API key. Store it in the `WEB3_INFURA_PROJECT_ID` environment variable.
```bash
export WEB3_INFURA_PROJECT_ID=YourProjectID
```
3. Sign up for [Etherscan](www.etherscan.io) and generate an API key. This is required for fetching source codes of the mainnet contracts we will be interacting with. Store the API key in the `ETHERSCAN_TOKEN` environment variable.
```bash
export ETHERSCAN_TOKEN=YourApiToken
```
4. Download the mix.
```bash
brownie bake yearn-strategy
```
## Basic Use
TODO: steps for Common Zap usage
## Testing
To run the tests:
```
brownie test
```
The example tests provided in this mix start by deploying and approving your [`Zap.sol`](contracts/) contract. This ensures that the loan executes successfully without any custom logic. Once you have built your own logic, you should edit [`tests/`](tests/) and remove this initial funding logic.
See the [Brownie documentation](https://eth-brownie.readthedocs.io/en/stable/tests-pytest-intro.html) for more detailed information on testing your project.
## Debugging Failed Transactions
Use the `--interactive` flag to open a console immediately after each failing test:
```
brownie test --interactive
```
Within the console, transaction data is available in the [`history`](https://eth-brownie.readthedocs.io/en/stable/api-network.html#txhistory) container:
```python
>>> history
[,
]
```
Examine the [`TransactionReceipt`](https://eth-brownie.readthedocs.io/en/stable/api-network.html#transactionreceipt) for the failed test to determine what went wrong. For example, to view a traceback:
```python
>>> tx = history[-1]
>>> tx.traceback()
```
To view a tree map of how the transaction executed:
```python
>>> tx.call_trace()
```
See the [Brownie documentation](https://eth-brownie.readthedocs.io/en/stable/core-transactions.html) for more detailed information on debugging failed transactions.
## Known issues
### No access to archive state errors
If you are using Ganache to fork a network, then you may have issues with the blockchain archive state every 30 minutes. This is due to your node provider (i.e. Infura) only allowing free users access to 30 minutes of archive state. To solve this, upgrade to a paid plan, or simply restart your ganache instance and redeploy your contracts.
# Resources
- Yearn [Discord channel](https://discord.com/invite/6PNv2nF/)
- Brownie [Gitter channel](https://gitter.im/eth-brownie/community)