Create ERC-4626.md

This commit is contained in:
mia von steinkirch, phd 2022-12-22 16:18:55 -08:00 committed by GitHub
parent daa16bd4cc
commit 977086546d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -0,0 +1,20 @@
## Notes on ERC-4626
### tl; dr
* standard to optimize and unify the technical parameters of yield bearing vaults, i.e. vaults that represent shares of a single ERC20 token.
* it offers a API for depositing, withdrawing tokens, and reading balances:
* methods: `asset`, `totalAsset`, `convertToShares`, `convertToAssets`, `maxDeposit`, `previewDeposit`, `deposit`, `maxMint`, `previewMint`, `mint`, `maxWithdraw`, `previewWithdraw`, `withdraw`, `maxRedeem`, `previewRedeem`, `redeem`, `totalSupply`, `balanceOf`.
* events: `Deposit`, `Withdraw`.
<br>
---
### resources
* [EIP-4626: Tokenized Vaults](https://eips.ethereum.org/EIPS/eip-4626)
* [code on solmate](https://github.com/transmissions11/solmate/blob/main/src/mixins/ERC4626.sol)
* [ethereum.org on erc-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/)