Archived repository

This repository has been archived and is no longer maintained.

Please use https://github.com/beefyfinance/beefy-cowllector-v2 instead

🧑‍🌾 Cowllector 🌾

The path to your next Open Source cowtribution

🐮 About Cowllector

This is the bot that harvest all strategies from all Beefy's chains, also do another things like:

• Notify the BIFI rewards pool
• Harvest the Beefy fee batch from all Beefy´s chains to distribute it.

Cowllectors does NOT focus in to be profitable, so don't expect it to win some profit when it harvests. Cowllector harvest script was create it to bring resilience and consistency in all active vaults strategies, giving at least ONE harvest every 24 hour to every strat in every chain

After every run of harvests in every chain, you can find the harvest report in our discord channel #Harvester

📖 Prerequisites

In order to run the project you need node>=16.13, yarn>=1.22 installed on our development machines

🖥️ Local development

To install the application:

yarn

To start harvest all chains in parallel:

yarn harvest

To start harvest one chain:

node ./scripts/harvest_child.js <chain id>

🔑 Enviroment

See enviroment variable example file for ENV required to run cowllector

🤝 Contributing

We encourage you to contribute to Cowllector!

We recommend to use this commit convention that helps you write your commits in a way that is easy to understand and process by others.

In case you want to contribute, please follow next steps:

• fork this repo
• create a new branch and named using conventional commit reference
• commit your changes using conventional commit
• push your change in your forked repo
• createa a PR from your new branch directly to our master branch

🍕 Community

• Got Questions? Join the conversation in our Discord.
• Want to up to date with Beefy? Follow us in Twitter.