Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos, grammatical errors, and update URLs in documentation #78

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@
* [Github](https://github.com/beefyfinance)
* [Media Kit](https://beefy.com/media-kit/)
* [Telegram](https://t.me/beefyfinance)
* [Twitter](https://twitter.com/beefyfinance)
* [Twitter](https://x.com/beefyfinance)
10 changes: 5 additions & 5 deletions beefy-products/beefy-escrowed-tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: 'Last Update: October 2022'

## What is Escrow?

An escrow mechanism is where one party holds another's rights or assets in custody for them, pending fulfilment of a specific condition (e.g. safe receipt of goods purchased with those assets). In DeFi, escrow mechanisms involve you providing your tokens to a third party (e.g. Beefy) to allow them to implement some functionality with those tokens on your behalf. As such, all escrow mechanisms are typically built around some token economic (**"tokenomic"**) design in the tokens you hold.
An escrow mechanism is where one party holds another's rights or assets in custody for them, pending fulfillment of a specific condition (e.g. safe receipt of goods purchased with those assets). In DeFi, escrow mechanisms involve you providing your tokens to a third party (e.g. Beefy) to allow them to implement some functionality with those tokens on your behalf. As such, all escrow mechanisms are typically built around some token economic (**"tokenomics"**) design in the tokens you hold.

For example, a blockchain's native token (e.g. Fantom's FTM) may be used for staking purposes to secure a blockchain by fairly and safely validating its transactions. The tokenomic design allows users to stake their tokens in order to earn transaction fees from users of the blockchain, giving the native token an ability to earn or generate value for the holder. However, staking is complicated and has trade offs, like locking your tokens and limiting your ability to trade in them. So third party escrow solutions (e.g. Beefy's beFTM) have been created to allow you to access the benefits of tokenomics (i.e. staking your FTM) without having to manage the staking yourself, and whilst allowing you to still trade your interest in the locked tokens.
For example, a blockchain's native token (e.g. Fantom's FTM) may be used for staking purposes to secure a blockchain by fairly and safely validating its transactions. The tokenomics design allows users to stake their tokens in order to earn transaction fees from users of the blockchain, giving the native token an ability to earn or generate value for the holder. However, staking is complicated and has trade offs, like locking your tokens and limiting your ability to trade in them. So third party escrow solutions (e.g. Beefy's beFTM) have been created to allow you to access the benefits of tokenomics (i.e. staking your FTM) without having to manage the staking yourself, and whilst allowing you to still trade your interest in the locked tokens.

## What is Vote Escrow?

A vote escrow mechanism is a form of tokenomic escrow design which aims to reward long term holders of a protocol's governance tokens with more voting power, to favour their interests in governance matters over short term holders. This is achieved by holders staking and typically locking their governance tokens with the protocol (typically for a return from protocol earnings), thereby limiting their ability to deal in those tokens. In doing so, the holder either unlocks voting rights (which are otherwise not available to holders) or boosts their existing voting power, typically in line with the amount of time that their tokens are staked/locked for. This voting power is often used to direct the economics of the relevant protocol, like by having users vote on how to distribute newly issued tokens as additional incentives among the protocol's liquidity pools.
A vote escrow mechanism is a form of tokenomics escrow design which aims to reward long term holders of a protocol's governance tokens with more voting power, to favour their interests in governance matters over short term holders. This is achieved by holders staking and typically locking their governance tokens with the protocol (typically for a return from protocol earnings), thereby limiting their ability to deal in those tokens. In doing so, the holder either unlocks voting rights (which are otherwise not available to holders) or boosts their existing voting power, typically in line with the amount of time that their tokens are staked/locked for. This voting power is often used to direct the economics of the relevant protocol, like by having users vote on how to distribute newly issued tokens as additional incentives among the protocol's liquidity pools.

The vote escrow system was pioneered in DeFi by Curve Finance's CRV and veCRV token design (hosted on Ethereum). Other notable examples of escrow designs include Convex's veCVX (Ethereum), Balancer's veBAL (Ethereum), Frax's veFXS (Ethereum), Mai Finance's eQI (Polygon), Trader Joe's veJOE (Avalanche), Platypus's vePTP (Avalanche), Velodrome's veVELO (Optimism).

Expand Down Expand Up @@ -42,9 +42,9 @@ After a year of boosted voting, the holder's lock period would have decreased to

Beefy-escrowed token ("**beTokens**") are wrapper tokens, designed and implemented by Beefy to unlock the benefits of escrow tokenomics whilst enabling our users to trade their interests in the partners' governance tokens. Effectively, we put in place an interim smart contract which can hold the governance tokens, lock them with the partner protocol for the maximum possible lock and gain access to the benefits of the escrow model. In addition, we add extra value by combining these features with issuing a new ERC20 beToken to you which you can then exchange to exit the lock at any time.

Each beToken is uniquely designed around the different veTokenomic model of our partner protocols, so they come with a range of different possible features. These can include: withdrawal reserves; supported DEX liquidity; pegged or free-floating pricing; a Beefy voting process for allocating votes on the underlying protocol; user-led or Beefy-led bribes; and boosts to associated Beefy vaults. 
Each beToken is uniquely designed around the different veTokenomics model of our partner protocols, so they come with a range of different possible features. These can include: withdrawal reserves; supported DEX liquidity; pegged or free-floating pricing; a Beefy voting process for allocating votes on the underlying protocol; user-led or Beefy-led bribes; and boosts to associated Beefy vaults. 

Beefy always support our beTokens with vaults on the Beefy platform, where you can stake your beTokens to earn a return. This may be in the form of an autocompounding beToken Vault (i.e. earn more beTokens) or an Earnings Pool (i.e. earning more of the underlying governance token). In either case, you're free to withdraw from your staking at any time, to trade in your beToken and exit your position.
Beefy always supports our beTokens with vaults on the Beefy platform, where you can stake your beTokens to earn returns. This may be in the form of an autocompounding beToken Vault (i.e. earn more beTokens) or an Earnings Pool (i.e. earning more of the underlying governance token). In either case, you're free to withdraw from your stake at any time, to trade in your beToken and exit your position.

## What Beefy-escrowed Tokens are there?

Expand Down
2 changes: 1 addition & 1 deletion beefy-products/beefy-escrowed-tokens/beftm.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ beFTM can also be manually purchased on many DEXes such as Solidly, BeethovenX,

## How does beFTM delegation work? 

The collective pool of FTM is delegated to [Beefy’s Validator Node](https://ftmscan.com/address/0xe97a5292248c2647466222dc58563046b3e34b18#validatorinfo) and perpetually locked as long as possible (51 weeks) to earn maximum validator rewards. We supply 1/15 of the deposit to our validator so we never hit the delegation limit. By staking our users’ FTM together, the Cowmoonity enjoys a much higher rate of return. 
The collective pool of FTM is delegated to [Beefy’s Validator Node](https://ftmscan.com/address/0xe97a5292248c2647466222dc58563046b3e34b18#validatorinfo) and perpetually locked as long as possible (51 weeks) to earn maximum validator rewards. We supply 1/15 of the deposit to our validator so we never hit the delegation limit. By staking our users’ FTM together, the Community enjoys a much higher rate of return. 

## beFTM Earnings Pool and beFTM Vault

Expand Down
12 changes: 6 additions & 6 deletions beefy-products/boost.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ As The Multichain Yield Optimizer, Beefy always wants to make sure that the user

## What is a Boost?

When you deposit in a Beefy vault, you receive a 'receipt' token prefixed with 'moo' in your wallet. When a Boost is available, you may stake that token in the Boost to receive the extra earnings benefit. You earn extra yield on top of your vault earnings!
When you deposit in a Beefy vault, you receive a 'receipt token prefixed with 'moo' in your wallet. When a Boost is available, you may stake that token in the Boost to receive the extra earnings benefit. You earn extra yield on top of your vault earnings!

## How do I use Beefy Boost?

First, look for a boosted vault in our main app and deposit the tokens that are asked for in the vault. Then, proceed to the Boost section to stake your [mooToken](boost.md#what-are-mootokens) "deposit receipts". Stake these [mooTokens](boost.md#what-are-mootokens) and you are all done! You can easily come back here to check on your earned partner tokens and withdraw at any time.
First, look for a boosted vault in our main app and deposit the tokens that are asked for in your vault. Then, proceed to the Boost section to stake your [mooToken](boost.md#what-are-mootokens) "deposit receipts". Stake these [mooTokens](boost.md#what-are-mootokens) and you are all done! You can easily come back here to check your earned partner tokens and withdraw at any time.

## How do I see my earned tokens?

Enter the vault where you deposited your [mooTokens](boost.md#what-are-mootokens) and it will show you a nice summary of your earned tokens.
Enter your vault where you deposited your [mooTokens](boost.md#what-are-mootokens) and it will show you a nice summary of your earned tokens.

## What are mooTokens?

Expand All @@ -31,7 +31,7 @@ A mooToken is an interest-bearing, tokenized proof of deposit that you will rece

There is a timer shown in the Boost section for each boosted vault. This is nothing you really need to keep track of since you can always come back after a vault is finished and withdraw then.

## Do I have to manually unstake from the Boost when it is finished?
## Do I have to manually unstake from the Boost when it finishes?

Yes, this is a mandatory user action when the Boost ends. For safety reasons, Beefy can not move your tokens back to your wallet. You can just come back after the Boost is finished to unstake your [mooTokens](boost.md#what-are-mootokens) together with the partner tokens, at any time, by hitting "Claim & Unstake".

Expand All @@ -45,7 +45,7 @@ Yes! Beefy always develops with _safety_ in mind and has made sure the boosted v

## If I enter a partner vault with my mooTokens, will I still earn the ordinary vault reward?

Yes! The ordinary tokens you deposited in our main vaults will earn the ordinary rewards and be compounded as usual, even if it is boosted. This is because the [mooTokens](boost.md#what-are-mootokens) you deposit to enter the Launchpool boost are _interest-bearing_. By using the boosted vault, you earn both the vault tokens and partner tokens as a boost.
Yes! The ordinary tokens you deposited in our main vaults will earn the ordinary rewards and be compounded as usual, even if it is boosted. This is because the [mooTokens](boost.md#what-are-mootokens) you deposit to enter the Launchpool boost are _interest-bearing_. By using the boosted vault, you earn both your vault tokens and partner tokens as a boost.

## Is there any fee on the Beefy Boosts? 

Expand All @@ -57,7 +57,7 @@ This means there is an upcoming boost for this vault. You can stake your mooTok

## How come the APY shown at launch is not the same as it is now?

APY is the “annual percentage yield” and is calculated by compounding your yield interest daily. The daily yield in turn is based on factors such as the reward rate and the total amount of deposited tokens that share the rewards. When more people and in turn tokens enter the pool, the fixed yield is shared by more people (tokens) hence the daily yield will become lower and in turn, lower the APY. In the same way, if people (tokens) exit the vault, there are fewer people (tokens) sharing the fixed reward and the daily yield will increase and in turn, APY will increase.
APY is the “annual percentage yield” and is calculated by compounding your yield interest daily. The daily yield in turn is based on factors such as the reward rate and the total amount of deposited tokens that share the rewards. When more people and in turn tokens enter the pool, the fixed yield is shared by more people (tokens) hence the daily yield will become lower and in turn, lower the APY. In the same way, if people (tokens) exit your vault, there are fewer people (tokens) sharing the fixed reward and the daily yield will increase and in turn, APY will increase.

## Are the promoted project and its tokens safe?

Expand Down
6 changes: 3 additions & 3 deletions beefy-products/clm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'Last Update: August 2024'

### What is CLM?

CLM stands for _"cowcentrated liquidity manager"_, which is Beefy's liquidity management product for concentrated liquidity (_**"CL"**_) pools. In essence, CLM allows day-to-day users to access the enormous opportunities of CL technology, without the effort and user-error risks that come from managing their own positions. The CLM contract issues depositors with an ERC-20 _"Cow Token",_ [_"Reward Cow Token"_ ](clm.md#how-does-the-clm-reward-pool-work) or [_"Moo Beefy Token"_](clm.md#how-does-the-clm-vault-work), reflecting their share of the pooled CLM funds being deposited into the CL position.
CLM stands for _"Concentrated liquidity manager"_, which is Beefy's liquidity management product for concentrated liquidity (_**"CL"**_) pools. In essence, CLM allows day-to-day users to access the enormous opportunities of CL technology, without the effort and user-error risks that come from managing their own positions. The CLM contract issues depositors with an ERC-20 _"CowToken",_ [_"Reward CowToken"_ ](clm.md#how-does-the-clm-reward-pool-work) or [_"MooBeefyToken"_](clm.md#how-does-the-clm-vault-work), reflecting their share of the pooled CLM funds being deposited into the CL position.

As with all other Beefy products, CLM automates complex onchain activities and aggregates scale across users to bring down the average cost for everyone. This means users get higher rates of return with far less effort when compared with handling the process yourself. 

Expand Down Expand Up @@ -196,9 +196,9 @@ To improve the user experience, Beefy's popular ZAP tooling has been brought to

### What happens when I withdraw from CLM?

The CLM withdraw workflow involves the vault contract taking back the deposit tokens that the user received for their deposit (meaning users need to approve access to the token from their wallet). Because of this, it's vital that users do not incidentally move or manipulate their cow or reward cow tokens for the duration of their deposit. Once the tokens are returned, they are immediately burned and exchanged for a proportional share of the tokens held by the CLM product which are sent back to the user. 
The CLM withdraw workflow involves the vault contract taking back the deposit tokens that the user received for their deposit (meaning users need to approve access to the token from their wallet). Because of this, it's vital that users do not incidentally move or manipulate their cow or reward CowTokens for the duration of their deposit. Once the tokens are returned, they are immediately burned and exchanged for a proportional share of the tokens held by the CLM product which are sent back to the user. 

For example, if a user has 1 cow token, from a total of 10 tokens issued, the user is entitled to 10% (= 1/10) of the tokens in the CLM product. If the product currently has 1 $ETH and 10,000 $USDC, the user will receive roughly 0.1 $ETH and 1,000 $USDC. This can be a totally different quantity to the user's original deposit; for instance, the user could have deposited 0.15 $ETH and 500 $USDC, in which case appreciation in the price of $ETH has significantly impacted the final tokens received. 
For example, if a user has 1 CowToken, from a total of 10 tokens issued, the user is entitled to 10% (= 1/10) of the tokens in the CLM product. If the product currently has 1 $ETH and 10,000 $USDC, the user will receive roughly 0.1 $ETH and 1,000 $USDC. This can be a totally different quantity to the user's original deposit; for instance, the user could have deposited 0.15 $ETH and 500 $USDC, in which case appreciation in the price of $ETH has significantly impacted the final tokens received. 

With ZAP tooling, users can also withdraw into any token of their choice, using DEX aggregators to automatically swap out the different tokens included into the position.

Expand Down
2 changes: 1 addition & 1 deletion community-governance/partnerships.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Even with our dedicated team, we're still inundated with partnerships requests.

Prospective partners should head to the #🕵-partnership-vetting channel on the [Beefy Discord server](https://discord.gg/yq8wfHd), to introduce yourself to our Cowmoonity. The channel is a dedicated space to discuss new and existing partnership opportunities, and for prospective partners to introduce themselves and their projects to our Cowmoonity.

Alternatively, if you prefer not to reach out via Discord, you can contact us through any of our other social media channels (including [Twitter](https://twitter.com/beefyfinance), [Reddit](https://www.reddit.com/r/Beefy/) and [Telegram](https://t.me/beefyfinance)), and we'll put you in touch with our vetting assistants.
Alternatively, if you prefer not to reach out via Discord, you can contact us through any of our other social media channels (including [Twitter](https://x.com/beefyfinance), [Reddit](https://www.reddit.com/r/Beefy/) and [Telegram](https://t.me/beefyfinance)), and we'll put you in touch with our vetting assistants.

## What does vetting consist of?

Expand Down
2 changes: 1 addition & 1 deletion dao/partnerships.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Even with our dedicated team, we're still inundated with partnerships requests.

Prospective partners should head to the #🕵-partnership-vetting channel on the [Beefy Discord server](https://discord.gg/yq8wfHd), to introduce yourself to our Cowmoonity. The channel is a dedicated space to discuss new and existing partnership opportunities, and for prospective partners to introduce themselves and their projects to our Cowmoonity.

Alternatively, if you prefer not to reach out via Discord, you can contact us through any of our other social media channels (including [Twitter](https://twitter.com/beefyfinance), [Reddit](https://www.reddit.com/r/Beefy/) and [Telegram](https://t.me/beefyfinance)), and we'll put you in touch with our vetting assistants.
Alternatively, if you prefer not to reach out via Discord, you can contact us through any of our other social media channels (including [Twitter](https://x.com/beefyfinance), [Reddit](https://www.reddit.com/r/Beefy/) and [Telegram](https://t.me/beefyfinance)), and we'll put you in touch with our vetting assistants.

## What does vetting consist of?

Expand Down
2 changes: 1 addition & 1 deletion developer-documentation/beefy-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ Provides information required by [CoinMarketCap](https://coinmarketcap.com/) in
"links": [
{
"title": "Twitter",
"link": "https://twitter.com/beefyfinance"
"link": "https://x.com/beefyfinance"
},
{
"title": "Telegram",
Expand Down
Loading