diff --git a/README.md b/README.md index 9f9f65d..3721d19 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,9 @@ ![workflow](https://github.com/FilosofiaCodigo/Biblioteca/actions/workflows/unit-tests.yml/badge.svg) -A library for interoperable smart contract development**. Build smart contracts integrated to a variety of decentralized protocols. -**Integrations library for smart contracts**. Build interopable smart contracts connected to a variety of decentralized protocols. +Maximize interoperability for your smart contracts with the integrations library for decentralized protocols. -## Contracts +# Contracts | Origin | Contract | Released | Has video | Unit Tests | Audit | |-----|----------|----------|-----------|------------|-------| @@ -18,19 +17,19 @@ A library for interoperable smart contract development**. Build smart contracts | | Aave Interface | ❌ | ❌ | ❌ | ❌ | | | Sudoswap Interface | ❌ | ❌ | ❌ | ❌ | -## 📝 Keep in mind +# 📝 Keep in mind * This contracts are based on OpenZeppelin libraries but changed `private` variables to `internal` for flexibility * All contracts are `Ownable` * All percentage numbers are 2 digit decimals (e.g. 150 percent is 1.5%) -## ⚠️ Important! +# ⚠️ Important! Many libraries are not audited. Use at your own risk! Also, PRs and upstream changes very welcome. -## 🪙 ERC20 Tokens +# 🪙 ERC20 Tokens -### Uniswap V2 Fee Token +## Uniswap V2 Fee Token ERC20 token that takes fees on P2P, buy and sell on Uniswap V2 and transfer them to a Vault. @@ -55,7 +54,7 @@ contract MyUniswapV2FeeToken is UniswapV2FeeToken ``` -### Uniswap V2 AutoSwap Token +## Uniswap V2 AutoSwap Token ERC20 token that takes fees on P2P, buy and sell on Uniswap V2, converts them to Base Tokens and transfer them to a Vault. @@ -80,7 +79,7 @@ contract MyUniswapV2AutoSwapToken is UniswapV2AutoSwapToken } ``` -### Balancer V2 Fee Token +## Balancer V2 Fee Token ERC20 token that takes fees on P2P, buy and sell on Balancer and transfer them to a Vault. @@ -102,7 +101,7 @@ contract MyBalancerFeeToken is BalancerV2FeeToken } ``` -### Uniswap V3 Fee Token +## Uniswap V3 Fee Token ERC20 token that takes fees on P2P, and buy on Uniswap V3 and transfer them to a Vault. @@ -126,9 +125,9 @@ contract MyUniswapV3FeeToken is UniswapV3FeeToken } ``` -## 🖼️ NFT Collections +# 🖼️ NFT Collections -### OpenZeppelin NFT Collection +## OpenZeppelin NFT Collection NFT collection with a mint price and max supply. Uses OpenZeppelin library wich is more adopted and save transfer gas fees compared to Azuki's ERC721a. @@ -150,7 +149,7 @@ contract MyOpenZeppelinNFTCollection is OpenZeppelinNFTCollection } ``` -### Azuki ERC721a NFT Collection +## Azuki ERC721a NFT Collection NFT collection with a mint price and max supply. Uses ERC721a library wich is more newer and save batch mint gas fees compared to OpenZeppelin's ERC721 implementation. diff --git a/img/icons/azuki.png b/img/icons/azuki.png index 1f18b10..48efac3 100644 Binary files a/img/icons/azuki.png and b/img/icons/azuki.png differ diff --git a/img/icons/balancer.png b/img/icons/balancer.png index 9da6d83..b2e1251 100644 Binary files a/img/icons/balancer.png and b/img/icons/balancer.png differ diff --git a/img/icons/openzeppelin.png b/img/icons/openzeppelin.png index 9c6b6ad..27fe72a 100644 Binary files a/img/icons/openzeppelin.png and b/img/icons/openzeppelin.png differ diff --git a/img/icons/uniswap.png b/img/icons/uniswap.png index 830b79d..f428270 100644 Binary files a/img/icons/uniswap.png and b/img/icons/uniswap.png differ diff --git a/img/vectors.svg b/img/vectors.svg index afc6cbe..327a66d 100644 --- a/img/vectors.svg +++ b/img/vectors.svg @@ -24,16 +24,16 @@ inkscape:pagecheckerboard="0" inkscape:document-units="mm" showgrid="false" - inkscape:zoom="0.77428426" - inkscape:cx="169.18851" - inkscape:cy="52.952129" + inkscape:zoom="0.59648701" + inkscape:cx="149.20694" + inkscape:cy="-155.91287" inkscape:window-width="1920" inkscape:window-height="1011" inkscape:window-x="0" inkscape:window-y="0" inkscape:window-maximized="1" inkscape:current-layer="layer1" - inkscape:snap-global="false" /> + inkscape:snap-global="true" /> + + + - - - + y="-38.53334" + rx="7.9888864" + ry="7.9888864" />