aave-protocol-v2/contracts/tokenization/interfaces/IVariableDebtToken.sol

58 lines
1.5 KiB
Solidity

// SPDX-License-Identifier: agpl-3.0
pragma solidity ^0.6.8;
/**
* @title interface IVariableDebtToken
* @author Aave
* @notice defines the basic interface for a variable debt token.
* @dev does not inherit from IERC20 to save in contract size
**/
interface IVariableDebtToken {
/**
* @dev emitted when new variable debt is minted
* @param user the user receiving the debt
* @param amount the amount of debt being minted
* @param index the index of the user
**/
event MintDebt(
address user,
uint256 amount,
uint256 index
);
/**
* @dev emitted when variable debt is burnt
* @param user the user which debt has been burned
* @param amount the amount of debt being burned
* @param index the index of the user
**/
event BurnDebt(
address user,
uint256 amount,
uint256 index
);
/**
* @dev mints new variable debt
* @param user the user receiving the debt
* @param amount the amount of debt being minted
* @param index the variable debt index of the reserve
**/
function mint(address user, uint256 amount, uint256 index) external;
/**
* @dev burns user variable debt
* @param user the user which debt is burnt
* @param amount the amount of debt being burned
* @param index the variable debt index of the reserve
**/
function burn(address user, uint256 amount, uint256 index) external;
/**
* @dev returns the scaled balance of the variable debt token
* @param user the user
**/
function scaledBalanceOf(address user) external view returns(uint256);
}