ozazel/equalizer-smart-contracts-v1

Equalizer smart-contracts v1

Equalizer - Smart Contracts V1

Project Summary

Equalizer Vaults/Flash Loan Contracts
Version: V1
Explore the docs »

Table of Contents

1. Getting Started
   • Installation
   • Build
   • Running/Deploy guide
   • Testing/Debugging/Troubleshooting
2. Roadmap
3. Contributing
4. License
5. Contact

Getting Started

In order you get started you have to install NodeJs and Yarn

Installation

1. Clone the repo
2. Copy .env.sample file to .env
3. Fill the variables from .env file: ETHERSCAN_API_KEY, WALLET_PRIV_KEY, RPC_URL
4. 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:

1. deployVaultFactory.ts;
2. deployFlashLoanProvider.ts;
3. initializeVaultFactory.ts;
4. deployTokens.ts
5. deployVaults.ts;
6. 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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. 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