Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
illia-fz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,20 @@
# Flash Loan Provider Example
# Flash Loan Sample

## IFlashLoanProvider.sol
This repository contains a simple implementation of a flash loan provider and flash loan user using a Fake USDT ERC20 token. It provides example Solidity contracts and tests demonstrating how flash loans work.

This is an interface for the flash loan provider.
## Contracts

## IFlashLoanUser.sol

This is an interface for the flash loan user.

## FlashLoanProvider.sol

This is a concrete implementation of a flash loan provider. We use the FakeUSDT ERC20 token to provide an initial balance for testing.

## FlashLoanUser.sol

This is a concrete implementation of a flash loan user.

## FakeUSDT.sol

This contract is used to provide a balance to the flash loan provider.
- `IFlashLoanProvider.sol`: Interface for the flash loan provider.
- `IFlashLoanUser.sol`: Interface for the flash loan user.
- `FlashLoanProvider.sol`: Concrete implementation of a flash loan provider. Uses the FakeUSDT ERC20 token to provide an initial balance for testing.
- `FlashLoanUser.sol`: Concrete implementation of a flash loan user.
- `FakeUSDT.sol`: ERC20 token used to provide a balance to the flash loan provider.

## Test

In the test folder, you can can find a test file (TestFlashLoan.js) which shows the usage of the flash loan provider from a flash loan user.
In the `test` folder, you can find a test file (`TestFlashLoan.js`) which shows how the flash loan provider is used by a flash loan user.

## Requirements

- Truffle
- OpenZeppelin Contracts
- Blockchain Environment - Eg: Ganache