Aave's V3 Protocol on Aptos

This is the official Aptos version of the Aave V3 Protocol.

Aptos Packages Overview

├── aave-acl           // Access control list Package
├── aave-bridge        // Bridge Package
├── aave-config        // Configurator Package
├── aave-flash-loan    // Flash loan Package
├── aave-math          // Math library Package
├── aave-oracle        // Chainlink Oracle Package
├── aave-pool          // Pool Package
├── aave-supply-borrow // Supply-Borrow Package
├── aave-tokens        // Tokens Package
├── aave-periphery     // Periphery Package

Dependencies for all packages:

  flowchart TD

    AaveOracle --> AaveAcl
    AaveOracle --> AaveConfig

    AaveMockOracle --> AaveAcl
    AaveMockOracle --> AaveConfig

    AaveTokens --> AaveAcl
    AaveTokens --> AaveConfig
    AaveTokens --> AaveMath

    AavePeriphery --> AaveMockOracle
    AavePeriphery --> AaveTokens

    AavePool ---> AaveAcl
    AavePool ---> AaveConfig
    AavePool ---> AaveMath
    AavePool --> AaveMockOracle
    AavePool --> AaveTokens

    AaveSupplyBorrow ----> AaveConfig
    AaveSupplyBorrow ----> AaveMath
    AaveSupplyBorrow ---> AaveMockOracle
    AaveSupplyBorrow --> AavePool
    AaveSupplyBorrow ---> AaveTokens

    AaveBridge -----> AaveAcl
    AaveBridge -----> AaveConfig
    AaveBridge -----> AaveMath
    AaveBridge ---> AavePool
    AaveBridge --> AaveSupplyBorrow
    AaveBridge ----> AaveTokens

    AaveFlashLoan -----> AaveAcl
    AaveFlashLoan -----> AaveConfig
    AaveFlashLoan -----> AaveMath
    AaveFlashLoan ---> AavePool
    AaveFlashLoan ---> AaveSupplyBorrow
    AaveFlashLoan ----> AaveTokens

Loading

1. Clone the code

git clone (aave-aptos-v3)(https://github.com/aave/aptos-v3) && cd into it

Make sure you have the following installed and configured:

• Aptos-Cli see here
• Yq tool: see here
• NodeJS/pnpm/npm/yarn see here
• Codespell see here
• Pre-commit see here
• Python3 see here

2. Local Testnet using Makefile

Local testnet commands are all bundled inside a Makefile at the root.

There is a .env.template template at the root that we recommend renaming to .env and adjusting the values of before executing the remaining steps.

Prior to all, run:

make local-testnet

to start the local testnet without indexer. It usually takes about 10 seconds for the local testnet to be fully operational.

Once local testnet is running, in another terminal do:

make init-profiles && make init-test-profiles && make fund-profiles && make fund-test-profiles

This will create all needed accounts for publishing Aave V3 and save them under a file under .aptos/config.yaml at the workspace root. The accounts will be prefunded with APT too.

All aave packages can be now compiled using the command:

make compile-all

and subsequently deployed to local testnet via:

make publish-all

If needed one could also run all aptos unit tests via:

make test-all

To view transactions or query any data deployed on the local testnet you can use the following url:

https://explorer.aptoslabs.com/?network=local

3. Local Testnet using Apterly

Apterly is a tool that mimics some of the functionalities that Tenderly offers. You can read more about it under Apterly. Follow the Readme if you want to deploy the protocol using docker-compose.

4. Checking contracts in explorer

For each published package, get the transaction id YOUR_TX_ID and replace it in the url below to see more data. Also make sure you are using the correct network in the url - devnet or testnet.

https://explorer.aptoslabs.com/txn/{YOUR_TX_ID}?network=NETWORK_NAME

5. Running Aptos Unit Tests

These tests do not require any published data and can thus be executed every time, prerequisite being we have all named addresses set:

make test-all

6. Running Typescript Integration/e2e Tests

These tests are only to be run after having successfully published all packages:

make ts-test

7. Creating Aptos Documentation

To create extensive Aptos documentation for all modules usually generated under the doc folder of each package, run:

make doc-all