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

Standardize Token Name to $aHONEY Across Documentation #330

Open
wants to merge 1 commit into
base: main
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
4 changes: 2 additions & 2 deletions apps/bend/content/developers/contracts/pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Users can:

Supplies an `amount` of underlying asset into the reserve, receiving in return overlying aTokens.

- E.g. User supplies 100 `$HONEY` and gets in return 100 `a$HONEY`
- E.g. User supplies 100 `$HONEY` and gets in return 100 `$aHONEY`

```solidity
function supply(address asset, uint256 amount, address onBehalfOf, uint16 referralCode) public virtual override;
Expand Down Expand Up @@ -64,7 +64,7 @@ function supplyWithPermit(
### withdraw

Withdraws an `amount` of underlying asset from the reserve, burning the equivalent aTokens owned
E.g. User has 100 `a$HONEY`, calls withdraw() and receives 100 `$HONEY`, burning the 100 `$aHONEY`
E.g. User has 100 `$aHONEY`, calls withdraw() and receives 100 `$HONEY`, burning the 100 `$aHONEY`

```solidity
function withdraw(address asset, uint256 amount, address to) public virtual override returns (uint256);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ To learn more about depositing assets, check out [Depositing](/learn/guides/depo
The diagram above captures the sequence of function calls that occurs when a user **adds liquidity** to Bend:

1. User supplies liquidity (e.g 100 `$HONEY`) to the protocol via the `supply()` function of Pool.sol
2. The `supply()` function then calls the `mint()` function of the corresponding receipt token smart contract, which following our example will be `a$HONEY`.sol
3. The `mint()` function then mints the same amount of receipt tokens (e.g. 100 `a$HONEY`) to the user. Note that the amount of aTokens minted is always 1:1 with the amount supplied.
2. The `supply()` function then calls the `mint()` function of the corresponding receipt token smart contract, which following our example will be `$aHONEY`.sol
3. The `mint()` function then mints the same amount of receipt tokens (e.g. 100 `$aHONEY`) to the user. Note that the amount of aTokens minted is always 1:1 with the amount supplied.

This is why the aTokens are referred to as the receipt tokens. They are receipts that the user has indeed provided X amount of tokens to token Y’s liquidity pool.

Expand All @@ -32,9 +32,9 @@ This is why the aTokens are referred to as the receipt tokens. They are receipts

The diagram above captures the sequence of function calls that occurs when a user **removes liquidity** from Bend:

1. User removes liquidity (e.g. 100 `a$HONEY`) from the protocol via the `withdraw()` function of Pool.sol
1. User removes liquidity (e.g. 100 `$aHONEY`) from the protocol via the `withdraw()` function of Pool.sol
2. The `withdraw()` function then calls the `burn()` function of the receipt token
3. The `burn()` function burns the receipt tokens received (100 `a$HONEY`) and transfers the underlying asset (`$HONEY`) to the user.
3. The `burn()` function burns the receipt tokens received (100 `$aHONEY`) and transfers the underlying asset (`$HONEY`) to the user.

### Recap

Expand Down
2 changes: 1 addition & 1 deletion apps/bend/content/learn/tokens/atoken.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**aTokens** are tokens minted and burnt upon supply and withdraw of assets to a Bend market.

Users receive a corresponding amount of aTokens in return when depositing a token, e.g., deposit `$HONEY` and get `a$HONEY`. These aTokens represent the user’s share of the total pool deposit and accrue interest over time.
Users receive a corresponding amount of aTokens in return when depositing a token, e.g., deposit `$HONEY` and get `$aHONEY`. These aTokens represent the user’s share of the total pool deposit and accrue interest over time.

Users can hold, transfer, or even use these aTokens as collateral for borrowing additional assets within the Bend ecosystem.

Expand Down