Yearn Strategy Foundry Mix

What you'll find here

• Basic Solidity Smart Contract for creating your own Yearn Strategy (contracts/Strategy.sol)

• Configured github template with Foundry framework for starting your yearn strategy project.

• Sample test suite. (tests/)

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(vault.address, 100).

Then Alice will call Vault.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. To install with Foundry.

2. Fork this repository and create a new repository using it as template. Create from template

3. Clone your newly created repository recursively to include modules.

git clone --recursive https://github.com/myuser/foundry-yearn-strategy

cd foundry-yearn-strategy

4. Build the project.

make build

5. Run tests

make test

6. Sign up for Infura and generate an API key. Store it in the WEB3_INFURA_PROJECT_ID environment variable.

export WEB3_INFURA_PROJECT_ID=YourProjectID

7. Sign up for Etherscan 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.

export ETHERSCAN_TOKEN=YourApiToken

• Optional Use .env file
  1. Make a copy of .env.example
  2. Add the values for ETHERSCAN_TOKEN and WEB3_INFURA_PROJECT_ID NOTE: If you set up a global environment variable, that will take precedence

Basic Use

To deploy the demo Yearn Strategy in a development environment:

TODO

Implementing Strategy Logic

contracts/Strategy.sol is where you implement your own logic for your strategy. In particular:

• Create a descriptive name for your strategy via Strategy.name().
• Invest your want tokens via Strategy.adjustPosition().
• Take profits and report losses via Strategy.prepareReturn().
• Unwind enough of your position to payback withdrawals via Strategy.liquidatePosition().
• Unwind all of your positions via Strategy.exitPosition().
• Fill in a way to estimate the total want tokens managed by the strategy via Strategy.estimatedTotalAssets().
• Migrate all the positions managed by your strategy via Strategy.prepareMigration().
• Make a list of all position tokens that should be protected against movements via Strategy.protectedTokens().

Testing

To run the tests:

make test

Resources

• Yearn Discord channel
• Getting help on Foundy
• Awesome Foundry
• Foundry Book