https://github.com/yearn/tokenized-strategy-ape-mix

https://github.com/yearn/tokenized-strategy-ape-mix

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/yearn/tokenized-strategy-ape-mix
• Owner: yearn
• Created: 2023-03-23T20:18:51.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-08-04T16:54:49.000Z (3 months ago)
• Last Synced: 2024-08-04T18:56:28.701Z (3 months ago)
• Language: Python
• Size: 77.1 KB
• Stars: 6
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tokenized Strategy Mix for Yearn V3 strategies

This repo will allow you to write, test and deploy V3 "Tokenized Strategies" using [Ape Worx](https://www.apeworx.io/).

You will only need to override the three functions in Strategy.sol of `_deployFunds`, `_freeFunds` and `_harvestAndReport`. With the option to also override `_tend`, `_tendTrigger`, `availableDepositLimit`, `availableWithdrawLimit` and `_emergencyWithdraw` if desired.

For a more complete overview of how the Tokenized Strategies work please visit the [TokenizedStrategy Repo](https://github.com/yearn/tokenized-strategy).

## How to start

### Requirements

    Python >=3.8.0, <=3.10

    Yarn

    Node.js >=14

    Hardhat

### Fork this repository

    git clone https://github.com/user/tokenized-strategy-ape-mix

    cd tokenized-strategy-ape-mix

### Set up your virtual environment

    python3 -m venv venv

    source venv/bin/activate

Tip: You can make them persistent by adding the variables in ~/.env (ENVVAR=... format), then adding the following in .bashrc: `set -a; source "$HOME/.env"; set +a`

### Install Ape and all dependencies

    pip install -r requirements.txt

    

    yarn

    

    ape plugins install .

    

    ape compile

    

    ape test

    

### Set your environment Variables

    export WEB3_INFURA_PROJECT_ID=your_infura_api_key

    export ETHERSCAN_API_KEY=your_api_key

Tip: You can make them persistent by adding the variables in ~/.env (ENVVAR=... format), then adding the following in .bashrc: `set -a; source "$HOME/.env"; set +a`

## Strategy Writing

For a complete guide to creating a Tokenized Strategy please visit: https://docs.yearn.fi/developers/v3/strategy_writing_guide

See the ApeWorx [documentation](https://docs.apeworx.io/ape/stable/) and [github](https://github.com/ApeWorX/ape) for more information.