diff --git a/README.md b/README.md index 1291ae5..866704f 100644 --- a/README.md +++ b/README.md @@ -73,4 +73,4 @@ Detailed view, inside of a protocol directory: ├── next-implementation-2 ├── ExampleERC4626Vault.sol -Each protocol directory should have its own `test` with coresponding entry in `MakeFile`. Follow established naming patterns. You can create additional directories inside of a protocol directory or host your Vaults together in root directory. \ No newline at end of file +Each protocol directory should have its own `test` with corresponding entry in `MakeFile`. Follow established naming patterns. You can create additional directories inside of a protocol directory or host your Vaults together in root directory. diff --git a/src/kycdao-4626/README.md b/src/kycdao-4626/README.md index 6285b98..6f81dd0 100644 --- a/src/kycdao-4626/README.md +++ b/src/kycdao-4626/README.md @@ -9,7 +9,7 @@ Serves as an example to provide gated access to a pool. The kycDAO platform, which can be accessed at https://kycdao.xyz/, represents a compliance framework that has been natively built for web3 applications. Its primary purpose is to facilitate the use of compliant smart contracts. -In the context of this project, the kycDAO smart contracts [dynamic soulbound NFTs] have been employed to implement a gating mechanism. This mechanism restricts access to the vault to a select group of individuals who are recognized as `trusted anons` within the kycDAO community. `Trusted anons` are the compliant. `Trusted anons` are compliant users of the web3 space. +In the context of this project, the kycDAO smart contracts [dynamic soulbound NFTs] have been employed to implement a gating mechanism. This mechanism restricts access to the vault to a select group of individuals who are recognized as `trusted anons` within the kycDAO community. `Trusted anons` are compliant. `Trusted anons` are compliant users of the web3 space. To learn more about kycDAO's compliance framework : https://docs.kycdao.xyz/ diff --git a/src/uniswap-v2/README.md b/src/uniswap-v2/README.md index 70a2434..0cfc114 100644 --- a/src/uniswap-v2/README.md +++ b/src/uniswap-v2/README.md @@ -2,7 +2,7 @@ `./swap-built-in/UniswapV2ERC4626Swap.sol` -Enables users to deposit into Uniswap V2 Pools using either token0 or token1 and receive an Uniswap LP-token representation wrapped in ERC4626 interface. The Vault calculates the optimal amount for splitting the input token into the two required tokens for the deposit operation. When withdrawing, the Vault simulates the expected value of either token0 or token1 (depending on the Vault being used) within a block. The Vault then performs swapJoin() and swapExit() operations to swap the appropriate amounts of token0 and token1 required for the withdrawal. This system can be easily deployed for token0 and token1 of the UniswapV2Pair, using the UniswapV2ERC4626PoolFactory.sol. Currently `UniswapV2ERC4626PoolFactory.sol` is unfinished and therefore on-chain oracle functionality is disabled. Enabling of Factory contract will be paired with neccessary security updates to the core UniswapV2 adapter. +Enables users to deposit into Uniswap V2 Pools using either token0 or token1 and receive an Uniswap LP-token representation wrapped in ERC4626 interface. The Vault calculates the optimal amount for splitting the input token into the two required tokens for the deposit operation. When withdrawing, the Vault simulates the expected value of either token0 or token1 (depending on the Vault being used) within a block. The Vault then performs swapJoin() and swapExit() operations to swap the appropriate amounts of token0 and token1 required for the withdrawal. This system can be easily deployed for token0 and token1 of the UniswapV2Pair, using the UniswapV2ERC4626PoolFactory.sol. Currently `UniswapV2ERC4626PoolFactory.sol` is unfinished and therefore on-chain oracle functionality is disabled. Enabling of Factory contract will be paired with necessary security updates to the core UniswapV2 adapter. `./no-swap/UniswapV2.sol` @@ -15,4 +15,4 @@ It is important for users to exercise caution when integrating with this contrac # Future Work - Price manipulation protection (Both at swapJoin and addLiquidity level) -- Deposit Uniswap LP-token directly (Give ERC4626 interface to existing ERC20 Uniswap LP-Token) \ No newline at end of file +- Deposit Uniswap LP-token directly (Give ERC4626 interface to existing ERC20 Uniswap LP-Token) diff --git a/src/venus/README.md b/src/venus/README.md index 8f80851..c17b5c3 100644 --- a/src/venus/README.md +++ b/src/venus/README.md @@ -1,3 +1,3 @@ # Venus Protocol ERC4626 Adapters -`VenusERC4626Reinvest.sol` - Standard ERC4626 adapter over any available Venus Markets. Venus is a Compound fork protocol on the "market" level. Allowing to deposit and supply assets to the Venus's vTokens. Build on yield-daddy example, extended with a module for rewards harvesting. \ No newline at end of file +`VenusERC4626Reinvest.sol` - Standard ERC4626 adapter over any available Venus Markets. Venus is a Compound fork protocol on the "market" level. Allows to deposit and supply assets to the Venus's vTokens. Build on yield-daddy example, extended with a module for rewards harvesting.