Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beefyfinance/beefy-cowllector
the one that harvest all the beefy vaults
https://github.com/beefyfinance/beefy-cowllector
beefy beefyfinance bot harvester
Last synced: 10 days ago
JSON representation
the one that harvest all the beefy vaults
- Host: GitHub
- URL: https://github.com/beefyfinance/beefy-cowllector
- Owner: beefyfinance
- Created: 2021-01-10T18:43:07.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-08T11:04:08.000Z (about 1 year ago)
- Last Synced: 2024-04-23T02:27:47.335Z (7 months ago)
- Topics: beefy, beefyfinance, bot, harvester
- Language: JavaScript
- Homepage:
- Size: 12.4 MB
- Stars: 10
- Watchers: 8
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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](https://discord.com/channels/755231190134554696/914666606641184768)
# 📖 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:
```shell
yarn
```
To start harvest all chains in parallel:
```shell
yarn harvest
```
To start harvest one chain:
```shell
node ./scripts/harvest_child.js
```
# 🔑 Enviroment
See [enviroment variable example](./.env.example) file for ENV required to run cowllector
# 🤝 Contributing
We encourage you to contribute to Cowllector!
We recommend to use [this commit convention](https://github.com/conventional-commits/conventionalcommits.org) 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](https://discord.gg/yq8wfHd).
- Want to up to date with Beefy? Follow us in [Twitter](https://twitter.com/beefyfinance).