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

Update docs for assetsBalanceOf and maxWithdraw override #412

Merged
merged 4 commits into from
May 10, 2024

Conversation

nkuba
Copy link
Member

@nkuba nkuba commented May 9, 2024

This PR contains two changes:

  1. Improve documentation of assetsBalanceOf function
    The function is used to show accounts' position in the dApp. It should
    not include any fees, just the conversion of shares to assets.

  2. Define maxWithdraw as a public function
    To match ERC4626Upgradable contract implementation we use the same name
    of the maxWithdraw function to correctly override it in ERC4626Fees
    contract.

nkuba added 2 commits May 9, 2024 16:38
The function is used to show accounts position in the dApp. It should
not include any fees, just conversion of shares to assets.
To match ERC4626Upgradable contract implementation we use the same name
of the `maxWithdraw` function to correctly override it in ERC4626Fees
contract.
@nkuba nkuba requested a review from dimpar May 9, 2024 14:41
@nkuba nkuba self-assigned this May 9, 2024
Copy link

netlify bot commented May 9, 2024

‼️ Deploy request for acre-dapp-testnet rejected.

Learn more in the Netlify docs

Name Link
🔨 Latest commit 548a0fc

@nkuba nkuba changed the title Update docs for assetsBalanceOf and maxWithdrawal override Update docs for assetsBalanceOf and maxWithdraw override May 9, 2024
@dimpar dimpar enabled auto-merge May 10, 2024 12:37
@dimpar dimpar merged commit cf23ff9 into main May 10, 2024
21 checks passed
@dimpar dimpar deleted the minor-improvements branch May 10, 2024 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants