Helio Docs
English
Search…
⌃K

Flash Loan

Flash Loans are uncollateralized loans that allow the user to borrow HAY as long as the borrowed amount (and a fee) is returned before the end of the transaction.
To use Flash Loans and get profit from them, you need a good understanding of BNB Chain (and Smart Chain), programming, and smart contracts.

Application of Flash Loans

There are various applications of Flash Loans.
An obvious example is arbitrage between assets, where the user can flash-loan HAY to purchase BNB in a Dutch auction that happens during somebody's HAY loan liquidation, immediately swap HAY for another asset on a DEX, then immediately swap the obtained asset for HAY on another DEX where the asset's ratio is higher, and repay Helio the flash loan + interest, keeping the difference — all within one loan transaction.

Involved entities

  1. 1.
    flashLender — Helio's smart contract implementing the "server side" of the flash loans functionality.
  2. 2.
    flashBorrower — the smart contract implementing the "client side", which EOA can copy, modify, and deploy to interact through with flashLender. A stub example of the smart contract is available later on this page.
  3. 3.
    EOA (Externally Owned Account) — an account that interacts with the copy of flashBorrower they deploy. Effectively, EOA is a developer who copies flashBorrower, modifies, and deploys it on BSC to interact with flashLender through.
flashLender can be used to borrow (mint) and repay (burn) HAY destablecoins, with a fee, in one transaction. EOA needs to interact with their own deployed copy of flashBorrower, which in turn interacts with flashLender.

Flash Loan Fee

To get the fee, call the flashFee(address token, uint256 amount) function that returns the fee amount in 18 Decimals.

Code example

flashLender — flash.sol
flashBorrower — flashBorrower.sol

Step-by-step

1. Set up your flashBorrower contract

Your contract must conform to the ERC3156FlashBorrower interface by implementing the onFlashLoan() function.
To interact with flashLender, your contract must implement flashBorrow(token, amount) and onFlashLoan(initiator, token, amount, fee, data), which is a callback function called during the execution of flashLoan().
Implement any custom logic within onFlashLoan().
Here's an example stub contract you can look through to better understand how to implement flashBorrower.
pragma solidity ^0.8.10;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "../interfaces/IERC3156FlashBorrower.sol";
import "../interfaces/IERC3156FlashLender.sol";
contract FlashBorrower is IERC3156FlashBorrower {
enum Action {NORMAL, OTHER}
IERC3156FlashLender lender;
constructor (IERC3156FlashLender lender_) {
lender = lender_;
}
/// @dev ERC-3156 Flash loan callback
function onFlashLoan(
address initiator,
address token,
uint256 amount,
uint256 fee,
bytes calldata data
) external override returns(bytes32) {
require(
msg.sender == address(lender),
"FlashBorrower: Untrusted lender"
);
require(
initiator == address(this),
"FlashBorrower: Untrusted loan initiator"
);
(Action action) = abi.decode(data, (Action));
if (action == Action.NORMAL) {
// do one thing
} else if (action == Action.OTHER) {
// do another
}
return keccak256("ERC3156FlashBorrower.onFlashLoan");
}
/// @dev Initiate a flash loan
function flashBorrow(
address token,
uint256 amount
) public {
bytes memory data = abi.encode(Action.NORMAL);
uint256 _allowance = IERC20(token).allowance(address(this), address(lender));
uint256 _fee = lender.flashFee(token, amount);
uint256 _repayment = amount + _fee;
IERC20(token).approve(address(lender), _allowance + _repayment);
lender.flashLoan(this, token, amount, data);
}
}

2. Understand how to interact with flashLender

Understand the parameters used in flashLender:
  1. 1.
    CALLBACK_SUCCESS — Hash of custom string, returned on success.
  2. 2.
    token (address) — address of the BNB ERC-20 token that EOA flash-loans.
  3. 3.
    amount (uint256) — amount of the flash loan.
  4. 4.
    receiver (IERC3156FlashBorrower) — address of the flashBorrowed deployed by the EOA.
  5. 5.
    data (bytes calldata) — rudimentary non-used parameter left not to change the flashLoan() signature.
Understand the functions you want to interact with:
  1. 1.
    maxFlashLoan(address token) — returns “max” if token is supported destablecoin.
  2. 2.
    flashFee(address token, uint256 amount) — applies “toll” on amount and returns if token is a supported destablecoin.
  3. 3.
    flashLoan(IERC3156FlashBorrower receiver, address token, uint256 amount, bytes calldata data) — mints token amount to receiver with extra data (if any), and expects a return equal to CALLBACK_SUCCESS.
  4. 4.
    function accrue() — sends the surplus fee to vow.sol.
If you're curious, understand the MakerDao parameters/constants used in the flash.sol.
  1. 1.
    vat — Address of vat.sol.
  2. 2.
    hayJoin — Address of hayJoin.sol.
  3. 3.
    hay — Address of hay.sol.
  4. 4.
    vow — Address of vow.sol.
  5. 5.
    max — Maximum allowed borrowable amount.
  6. 6.
    toll — Fee on return of loan.
  7. 7.
    WAD — 18 Decimals.
  8. 8.
    RAY — 27 Decimals.
  9. 9.
    RAD — 45 Decimals.
  10. 10.
    CALLBACK_SUCCESS — Hash of custom string, returned on success.
For a deeper understanding of the MakerDao contract, such as var, hay, vow, etc, start with the vat docs and proceed to other smart contracts documented there.

3. Interact with flashLender

flashLender is available by the following addresses:
A typical interaction follows this workflow:
  1. 1.
    An EOA calls flashBorrow(token, amount) on a borrowing contract flashBorrower.sol.
  2. 2.
    flashBorrower approves flashLender in advance to repay the loan with a fee. Then it calls the flashLoan(receiver, token, amount, data) function on flashLender which mints a specified amount to the flashBorrower.
  3. 3.
    The same function flashLoan(receiver, token, amount, data) then calls (CALLBACK) the the onFlashLoan(initiator, token, amount, fee, data) function on the flashBorrower, which implements the custom logic of whatever the EOA wants to do with the borrowed HAY, then onFlashLoan() returns the KECCAK256 of “ERC3156FlashBorrower.onFlashLoan" if its execution was successful. The custom logic is thought-up and implemented completely by the EOA.
  4. 4.
    flashLender then burns the minted loan and stores the fee as surplus.

Close-to-life usage example

Look into the tests to find a close-to-life usage example.