... with Truffle

Truffle is the most popular development environment for Ethereum developers, part of the Truffle suite and supported by Consensys.

If you are new to Truffle, we'd recommend you have a look at one of the many tutorials on the basics of Truffle. The official tutorials are here, although some of them may be outdated.

Flash Loan Truffle Box

Known issue with the latest version of Truffle v.5.1.24 and v.5.1.25.

To use the this Truffle Box successfully, please use a lower version such as Truffle v.5.1.0

Get up and running in a 'flash'⚡️by using our official Truffle box, which contains everything you need to perform your first flash loan, with Solidity ^0.6.6.

If you're already familiar with Truffle, then we'd recommend you start with our Flash Loan starter template.

If you prefer to work with the older Solidity ^0.5.15, see Flash loan starter template.

Installation and Setup

  1. Install Truffle globally, if not already installed.

    npm install -g truffle
  2. Download the box.

    truffle unbox aave/flashloan-box
  3. Rename the env file and edit the following values in the file:

    • Sign up for Infura (or a similar provider) and replace YOUR_INFURA_KEY with an API key for your project.

    • Replace YOUR_ACCOUNT_KEY_FOR_DEPLOYMENT with the private key of the ethereum account you will be using to deploy the contracts. This account will become the owner of the contract.

  4. Ensure your ethereum account has some ETH to deploy the contract.

  5. In your terminal, navigate to your repo directory and install the dependencies (if not already done):

    npm install
  6. In the same terminal, replace NAME_OF_YOUR_NETWORK with either kovan, ropsten, or mainnet (depending on where you want to deploy the contract):

    truffle console --network NAME_OF_YOUR_NETWORK
  7. You are now connected to the network you chose. In the same terminal window:

    migrate --reset
  8. After a few minutes, your contract will be deployed on your chosen network.

    • If you have not added any profitable logic to Flashloan.sol line 23, then you will need to fund your contract with the desired asset.

    • See our documentation for token address and faucets.

  9. Call your contract's flashloan function within the truffle console, replacing RESERVE_ADDRESS with the reserve address found in our documentation:

    let f = await Flashloan.deployed()
    await f.flashloan(RESERVE_ADDRESS)
    • if the above operation takes an unreasonably long time or times-out, try CTRL+C to exit the Truffle console, repeat step 5, then try this step agin. You may need to wait a few blocks before your node can 'see' the deployed contract.

  10. If you've successfully followed the above steps, then congratulations, you've just made a flash loan.

    • For reference, here is an example transaction that followed the above steps on Kovan using Dai.

    • For reference, here is an example transaction that followed the above steps on Kovan using ETH.

Setup for cross protocol flash lending

If you are working across protocols, such as using the flash loaned amount on another #DeFi protocol, sometimes it is easier to fork mainnet and use each protocol's production contracts and production ERC20 tokens.

  1. Follow the steps 0 --> step 4 from above.

  2. (Install and) Run Ganache, preferably the CLI version

  3. In truffle-config.js, ensure the details for the development network match up with your running Ganache instance.

  4. To minimise set up steps with Aave's lending pools, use Ganache's fork feature. This will 'fork' mainnet into your Ganache instance. Open terminal, replace YOUR_INFURA_KEY in the following and run:

    ganache-cli --fork https://mainnet.infura.io/v3/YOUR_INFURA_KEY -i 1
  5. In a new terminal window in your repo directory, run:

    truffle console
  6. Migrate your Flashloan contract to your instance of Ganache with:

    migrate --reset
  7. After a few minutes, your contract will be deployed.

    • If you have not added any profitable logic to Flashloan.sol line 23, then you will need to fund your contract with the desired asset.

    • See our documentation for token address and faucets.

  8. Your contract is now deployed on your local Ganache, which is mirroring mainnet. Call your contract's flashloan function within the truffle console, replacing RESERVE_ADDRESS with the reserve address found in our documentation:

    let f = await Flashloan.deployed()
    await f.flashloan(RESERVE_ADDRESS)

    Be patient as your ganache instance works its magic.

  9. If your implementation is correct, then the transaction will succeed. If it fails/reverts, a reason will be given.

Known issues

No access to archive state errors

If you are using Ganache to fork a network, then you may have issues with the blockchain archive state every 30 minutes. This is due to your node provider (i.e. Infura) only allowing free users access to 30 minutes of archive state. To solve this, upgrade to a paid plan, or simply restart your ganache instance and redploy your contracts.

Unable to debug executeOperation() with mainnet ganache fork

The Truffle debugger does not work too well with proxy / complex calls. You may find that the Truffle debugger returns an error such as:

TypeError: Cannot read property 'version' of undefined
at ...
  • In this case you can try calling your executeOperation() function directly, instead of having Aave's LendingPool contract invoke the function. This will allow you to debug the function directly, however you will need to supply the relevant parameters (e.g. _amount, _fee, _reserve, etc).

  • Alternatively, see the 'Troubleshooting' link.

Troubleshooting

See our Troubleshooting Errors documentation.

Flash loan starter template

To implement a Flash Loan with Truffle, using Solidity ^0.5.15, see the starter template found here.

The README.MD contains all the necessary information you need to set up and run your Truffle project.

If you need development support, join the #developers channel on our Aave community Discord server.