Equalizer - Smart Contracts V1
Project Summary
Equalizer Vaults/Flash Loan Contracts
Version: V1
Explore the docs »
Table of Contents
Getting Started
In order you get started you have to install NodeJs and Yarn
Installation
- Clone the repo
- Copy
.env.sample
file to.env
- Fill the variables from .env file:
ETHERSCAN_API_KEY
,WALLET_PRIV_KEY
,RPC_URL
- Run
yarn install
Build
yarn compile
Deploy
For deployment you have to check the available scripts. The pattern for using a scripts is:
npx hardhat run scripts/<script_name>.ts --network <rinkeby/mainnet>
In order to make the deployment process you have to run in order:
deployVaultFactory.ts
;deployFlashLoanProvider.ts
;initializeVaultFactory.ts
;deployTokens.ts
deployVaults.ts
;deployFlashBorrowerTestnet.ts
NOTE
In each step you have to check the script you are running and change the config needed. For example deployFlashLoanProvider.ts
(step 1)
requires the VaultFactory
contract address from step 1.
Testing
yarn test
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the BSL 1.1 License. See LICENSE
for more information.
Contact
Equalizer - @EqualizerFlash - info (a) equalizer.finance
Project Link: https://github.com/Equalizer-Finance/equalizer-smart-contracts-v1