Newlyweds Proposing Marriage

    @aave/core-v3

    1.13.1 • Public • Published

    Build pass codecov

            .///.                .///.     //.            .//  `/////////////-
           `++:++`              .++:++`    :++`          `++:  `++:......---.`
          `/+: -+/`            `++- :+/`    /+/         `/+/   `++.
          /+/   :+/            /+:   /+/    `/+/        /+/`   `++.
      -::/++::`  /+:       -::/++::` `/+:    `++:      :++`    `++/:::::::::.
      -:+++::-`  `/+:      --++/---`  `++-    .++-    -++.     `++/:::::::::.
       -++.       .++-      -++`       .++.    .++.  .++-      `++.
      .++-         -++.    .++.         -++.    -++``++-       `++.
     `++:           :++`  .++-           :++`    :+//+:        `++:----------`
     -/:             :/-  -/:             :/.     ://:         `/////////////-
    

    Aave Protocol v3

    This repository contains the smart contracts source code and markets configuration for Aave Protocol V3. The repository uses Docker Compose and Hardhat as development environment for compilation, testing and deployment tasks.

    What is Aave?

    Aave is a decentralized non-custodial liquidity markets protocol where users can participate as suppliers or borrowers. Suppliers provide liquidity to the market to earn a passive income, while borrowers are able to borrow in an overcollateralized (perpetually) or undercollateralized (one-block liquidity) fashion.

    Documentation

    See the link to the technical paper or visit the Aave Developer docs

    Audits and Formal Verification

    You can find all audit reports under the audits folder

    Round 1 - October 2021

    Round 2 - December 2021

    Formal Verification

    Connect with the community

    You can join at the Discord channel or at the Governance Forum for asking questions about the protocol or talk about Aave with other peers.

    Getting Started

    You can install @aave/aave-v3-core as an NPM package in your Hardhat or Truffle project to import the contracts and interfaces:

    npm install @aave/aave-v3-core

    Import at Solidity files:

    import {IPool} from "@aave/aave-v3-core/contracts/interfaces/IPool.sol";
    
    contract Misc {
    
      function supply(address pool, address token, address user, uint256 amount) public {
        IPool(pool).supply(token, amount, user, 0);
        {...}
      }
    }
    

    The JSON artifacts with the ABI and Bytecode are also included into the bundled NPM package at artifacts/ directory.

    Import JSON file via Node JS require:

    const PoolV3Artifact = require('@aave/aave-v3-core/artifacts/contracts/protocol/pool/Pool.sol/Pool.json');
    
    // Log the ABI into console
    console.log(PoolV3Artifact.abi)
    

    Setup

    The repository uses Docker Compose to manage sensitive keys and load the configuration. Prior any action like test or deploy, you must run docker-compose up to start the contracts-env container, and then connect to the container console via docker-compose exec contracts-env bash.

    Follow the next steps to setup the repository:

    • Install docker and docker-compose
    • Create an enviroment file named .env and fill the next enviroment variables
    # Add Alchemy or Infura provider keys, alchemy takes preference at the config level
    ALCHEMY_KEY=""
    INFURA_KEY=""
    
    
    # Optional, if you plan to use Tenderly scripts
    TENDERLY_PROJECT=""
    TENDERLY_USERNAME=""
    
    

    Test

    You can run the full test suite with the following commands:

    # In one terminal
    docker-compose up
    
    # Open another tab or terminal
    docker-compose exec contracts-env bash
    
    # A new Bash terminal is prompted, connected to the container
    npm run test
    

    Install

    npm i @aave/core-v3

    DownloadsWeekly Downloads

    1,155

    Version

    1.13.1

    License

    AGPLv3

    Unpacked Size

    2.67 MB

    Total Files

    357

    Last publish

    Collaborators

    • miguel-martinez-aave
    • donosonaumczuk
    • aavesome
    • david-racero-aave
    • sakulstra