https://github.com/aave/aave-token
AAVE token implementation
https://github.com/aave/aave-token
Last synced: 2 months ago
JSON representation
AAVE token implementation
- Host: GitHub
- URL: https://github.com/aave/aave-token
- Owner: aave
- License: other
- Created: 2020-09-21T07:01:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-25T16:02:24.000Z (over 4 years ago)
- Last Synced: 2025-04-12T10:04:57.756Z (2 months ago)
- Language: TypeScript
- Size: 583 KB
- Stars: 24
- Watchers: 8
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Audit: audits/AaveTokenReport_CertiK.pdf
Awesome Lists containing this project
README
# Aave Token design
AAVE is an ERC-20 compatible token. It implements governance-inspired features, and will allow Aave to bootstrap the rewards program for safety and ecosystem growth.
The following document explains the main features of AAVE, it’s monetary policy, and the redemption process from LEND.
## Roles
The initial AAVE token implementation does not have any admin roles configured. The contract will be proxied using the Openzeppelin implementation of the EIP-1967 Transparent Proxy pattern. The proxy has an Admin role, and the Admin of the proxy contract will be set upon deployment to the Aave governance contracts.
## ERC-20
The AAVE token implements the standard methods of the ERC-20 interface. A balance snapshot feature has been added to keep track of the balances of the users at specific block heights. This will help with the Aave governance integration of AAVE.
AAVE also integrates the EIP 2612 `permit` function, that will allow gasless transaction and one tx approval/transfer.
# LendToAaveMigrator
Smart contract for LEND token holders to execute the migration to the AAVE token, using part of the initial emission of AAVE for it.
The contract is covered by a proxy, whose owner will be the AAVE governance. Once the governance passes the corresponding proposal, the proxy will be connected to the implementation and LEND holders will be able to call the `migrateFromLend()` function, which, after LEND approval, will pull LEND from the holder wallet and transfer back an equivalent AAVE amount defined by the `LEND_AAVE_RATIO` constant.
One tradeOff of `migrateFromLend()` is that, as the AAVE total supply will be lower than LEND, the `LEND_AAVE_RATIO` will be always > 1, causing a loss of precision for amounts of LEND that are not multiple of `LEND_AAVE_RATIO`. E.g. a person sending 1.000000000000000022 LEND, with a `LEND_AAVE_RATIO` == 100, will receive 0.01 AAVE, losing the value of the last 22 small units of LEND.
Taking into account the current value of LEND and the future value of AAVE, a lack of precision for less than LEND_AAVE_RATIO small units represents a value several orders of magnitude smaller than 0.01\$. We evaluated some potential solutions for this, specifically:
1. Rounding half up the amount of AAVE returned from the migration. This opens up to potential attacks where users might purposely migrate less than LEND_AAVE_RATIO to obtain more AAVE as a result of the round up.
2. Returning back the excess LEND: this would leave LEND in circulation forever, which is not the expected end result of the migration.
3. Require the users to migrate only amounts that are multiple of LEND_AAVE_RATIO: This presents considerable UX friction.
None of those present a better outcome than the implemented solution.
## The Redemption process
The first step to bootstrap the AAVE emission is to deploy the AAVE token contract and the LendToAaveMigrator contract. This task will be performed by the Aave team. Upon deployment, the ownership of the Proxy of the AAVE contract and the LendToAaveMigrator will be set to the Aave Governance. To start the LEND redemption process at that point, the Aave team will create an AIP (Aave Improvement Proposal) and submit a proposal to the Aave governance. The proposal will, once approved, activate the LEND/AAVE redemption process and the ecosystem incentives, which will mark the initial emission of AAVE on the market.
The result of the migration procedure will see the supply of LEND being progressively locked within the new AAVE smart contract, while at the same time an equivalent amount of AAVE is being issued.
The amount of AAVE equivalent to the LEND tokens burned in the initial phase of the AAVE protocol will remain locked in the LendToAaveMigrator contract.
## Technical implementation
### Changes to the Openzeppelin original contracts
In the context of this implementation, we needed apply the following changes to the OpenZepplin implementation:
- In `/contracts/open-zeppelin/ERC20.sol`, line 44 and 45, `_name` and `_symbol` have been changed from `private` to `internal`
- We extended the original `Initializable` class from the Openzeppelin contracts and created a `VersionedInitializable` contract. The main differences compared to the `Initializable` are:
1. The boolean `initialized` has been replaced with a `uint256 latestInitializedRevision`.
2. The `initializer()` modifier fetch the revision of the implementation using a `getRevision()` function defined in the implementation contract. The `initializer` modifier forces that an implementation
3. with a bigger revision number than the current one is being initialized
The change allows us to call `initialize()` on multiple implementations, that was not possible with the original `Initializable` implementation from OZ.
### \_beforeTokenTransfer hook
We override the \_beforeTokenTransfer function on the OZ base ERC20 implementation in order to include the following features:
1. Snapshotting of balances every time an action involved a transfer happens (mint, burn, transfer or transferFrom). If the account does a transfer to itself, no new snapshot is done.
2. Call to the Aave governance contract forwarding the same input parameters of the `_beforeTokenTransfer` hook. Its an assumption that the Aave governance contract is a trustable party, being its responsibility to control all potential reentrancies if calling back the AaveToken. If the account does a transfer to itself, no interaction with the Aave governance contract should happen.
## Development deployment
For development purposes, you can deploy AaveToken and LendToAaveMigrator to a local network via the following command:
```
npm run dev:deployment
```
For any other network, you can run the deployment in the following way
```
npm run ropsten:deployment
```
You can also set an optional `$AAVE_ADMIN` enviroment variable to set an ETH address as the admin of the AaveToken and LendToAaveMigrator proxies. If not set, the deployment will set the second account of the `accounts` network configuration at `buidler.config.ts`.
## Mainnet deployment
You can deploy AaveToken and LendToAaveMigrator to the mainnet network via the following command:
```
AAVE_ADMIN=governance_or_ETH_address
LEND_TOKEN=lend_token_address
npm run main:deployment
```
The `$AAVE_ADMIN` enviroment variable is required to run, set an ETH address as the admin of the AaveToken and LendToAaveMigrator proxies. Check `buidler.config.ts` for more required enviroment variables for Mainnet deployment.
The proxies will be initialized during the deployment with the `$AAVE_ADMIN` address, but the smart contracts implementations will not be initialized.
## Enviroment Variables
| Variable | Description |
| ----------------------- | ----------------------------------------------------------------------------------- |
| \$AAVE_ADMIN | ETH Address of the admin of Proxy contracts. Optional for development. |
| \$LEND_TOKEN | ETH Address of the LEND token. Optional for development. |
| \$INFURA_KEY | Infura key, only required when using a network different than local network. |
| \$MNEMONIC\_\ | Mnemonic phrase, only required when using a network different than local network. |
| \$ETHERESCAN_KEY | Etherscan key, not currently used, but will be required for contracts verification. |
## Audits
The Solidity code in this repository has undergone 2 traditional smart contracts' audits by Consensys Diligence and Certik, and properties' verification process by Certora. The reports are:
- [Consensys Diligence](https://diligence.consensys.net/audits/2020/07/aave-token/)
- [Certik](audits/AaveTokenReport_CertiK.pdf)
- [Certora](audits/AaveTokenVerification_by_Certora.pdf)
## Current Mainnet contracts (25/09/2020)
- **AaveToken proxy**: [0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9](https://etherscan.io/address/0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9)
- **AaveToken implementation**: [0xea86074fdac85e6a605cd418668c63d2716cdfbc](https://etherscan.io/address/0xea86074fdac85e6a605cd418668c63d2716cdfbc)
- **LendToAaveMigrator proxy**: [0x317625234562b1526ea2fac4030ea499c5291de4](https://etherscan.io/address/0x317625234562b1526ea2fac4030ea499c5291de4)
- **LendToAaveMigrator implementation**: [0x86241b6c526998582556f7c0342d8863b604b17b](https://etherscan.io/address/0x86241b6c526998582556f7c0342d8863b604b17b)
## Credits
For the proxy-related contracts, we have used the implementation of our friend from [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-sdk/).
## License
The contents of this repository are under the AGPLv3 license.