ATokenVault

The ATokenVault contract is an ERC-4626 compliant yield-bearing vault designed for Aave V3. It allows users to supply and withdraw ERC-20 tokens supported by Aave V3, automatically managing asset supply and withdrawal within the Aave Protocol. This vault also enables managers to collect a fee on the yield generated.

The smart contract source code is available on GitHub.

function initialize(    address owner,    uint256 initialFee,    string memory shareName,    string memory shareSymbol,    uint256 initialLockDeposit) external initializer

Initializes the vault, setting its initial parameters and initializing inherited contracts. An initial non-zero deposit (in underlying tokens) is required to prevent frontrunning attacks. It does not initialize the OwnableUpgradeable contract to avoid setting the proxy admin as the owner.

function deposit(uint256 assets, address receiver) public override returns (uint256)

Deposits assets (underlying tokens) into the vault and mints a corresponding amount of vault shares to the receiver.

function depositATokens(uint256 assets, address receiver) public override returns (uint256)

Deposits assets (aTokens) directly into the vault and mints a corresponding amount of vault shares to the receiver.

function depositWithSig(    uint256 assets,    address receiver,    address depositor,    EIP712Signature calldata sig) public override returns (uint256)

Deposits assets (underlying tokens) into the vault on behalf of a depositor, authenticated by an EIP-712 signature. Vault shares are minted to the receiver.

function depositATokensWithSig(    uint256 assets,    address receiver,    address depositor,    EIP712Signature calldata sig) public override returns (uint256)

Deposits assets (aTokens) directly into the vault on behalf of a depositor, authenticated by an EIP-712 signature. Vault shares are minted to the receiver.

function mint(uint256 shares, address receiver) public override returns (uint256)

Mints an exact amount of shares (vault shares) to the receiver by depositing the calculated amount of underlying assets.

function mintWithATokens(uint256 shares, address receiver) public override returns (uint256)

Mints an exact amount of shares (vault shares) to the receiver by depositing the calculated amount of aTokens.

function mintWithSig(    uint256 shares,    address receiver,    address depositor,    EIP712Signature calldata sig) public override returns (uint256)

Mints an exact amount of shares (vault shares) to the receiver on behalf of a depositor, authenticated by an EIP-712 signature, by depositing the calculated amount of underlying assets.

function mintWithATokensWithSig(    uint256 shares,    address receiver,    address depositor,    EIP712Signature calldata sig) public override returns (uint256)

Mints an exact amount of shares (vault shares) to the receiver on behalf of a depositor, authenticated by an EIP-712 signature, by depositing the calculated amount of aTokens.

function withdraw(    uint256 assets,    address receiver,    address owner) public override returns (uint256)

Withdraws assets (underlying tokens) from the vault and sends them to the receiver. The corresponding vault shares are burned from the owner.

function withdrawATokens(uint256 assets, address receiver, address owner) public override returns (uint256)

Withdraws assets (aTokens) directly from the vault and sends them to the receiver. The corresponding vault shares are burned from the owner.

function withdrawWithSig(    uint256 assets,    address receiver,    address owner,    EIP712Signature calldata sig) public override returns (uint256)

Withdraws assets (underlying tokens) from the vault and sends them to the receiver. The corresponding vault shares are burned from the owner, authenticated by an EIP-712 signature.

function withdrawATokensWithSig(    uint256 assets,    address receiver,    address owner,    EIP712Signature calldata sig) public override returns (uint256)

Withdraws assets (aTokens) directly from the vault and sends them to the receiver. The corresponding vault shares are burned from the owner, authenticated by an EIP-712 signature.

function redeem(    uint256 shares,    address receiver,    address owner) public override returns (uint256)

Redeems shares (vault shares) for the underlying assets, which are sent to the receiver. The shares are burned from the owner.

function redeemAsATokens(uint256 shares, address receiver, address owner) public override returns (uint256)

Redeems shares (vault shares) for aTokens, which are sent to the receiver. The shares are burned from the owner.

function redeemWithSig(    uint256 shares,    address receiver,    address owner,    EIP712Signature calldata sig) public override returns (uint256)

Redeems shares (vault shares) for the underlying assets, which are sent to the receiver. The shares are burned from the owner, authenticated by an EIP-712 signature.

function redeemWithATokensWithSig(    uint256 shares,    address receiver,    address owner,    EIP712Signature calldata sig) public override returns (uint256)

Redeems shares (vault shares) for aTokens, which are sent to the receiver. The shares are burned from the owner, authenticated by an EIP-712 signature.

function setFee(uint256 newFee) public override onlyOwner

Sets a new fee percentage for the vault. This function can only be called by the vault owner. Accrues current yield before updating the fee.

function withdrawFees(address to, uint256 amount) public override onlyOwner

Withdraws amount of accumulated fees (in aTokens) to the specified to address. This function can only be called by the vault owner. Accrues current yield before withdrawing fees.

function claimRewards(address to) public override onlyOwner

Claims any pending rewards accumulated by the vault and sends them to the specified to address. This function can only be called by the vault owner.

function emergencyRescue(    address token,    address to,    uint256 amount) public override onlyOwner

Allows the vault owner to rescue an arbitrary amount of an ERC-20 token that was mistakenly sent to the vault, transferring it to the to address. This function cannot be used to rescue the AToken that the vault is designed to hold.

function maxDeposit(address) public view override returns (uint256)

Returns the maximum amount of underlying assets that can be deposited into the vault. This is determined by the Aave protocol's supply cap and the current supplied amount.

function maxMint(address) public view override returns (uint256)

Returns the maximum amount of vault shares that can be minted. This is derived from the maximum suppliable assets converted to shares.

function maxWithdraw(address owner) public view override returns (uint256)

Returns the maximum amount of underlying assets that can be withdrawn by a specific owner. This is limited by the vault's balance and Aave's available liquidity.

function maxRedeem(address owner) public view override returns (uint256)

Returns the maximum amount of vault shares that can be redeemed by a specific owner. This is limited by the vault's balance and Aave's available liquidity.

function previewDeposit(uint256 assets) public view override returns (uint256)

Provides a preview of the amount of vault shares that would be minted for a given assets deposit.

function previewMint(uint256 shares) public view override returns (uint256)

Provides a preview of the amount of underlying assets that would be required to mint a given shares amount of vault shares.

function previewWithdraw(uint256 assets) public view override returns (uint256)

Provides a preview of the amount of vault shares that would be burned for a given assets withdrawal.

function previewRedeem(uint256 shares) public view override returns (uint256)

Provides a preview of the amount of underlying assets that would be received for a given shares redemption.

function domainSeparator() public view override returns (bytes32)

Returns the EIP-712 domain separator for this contract.

function totalAssets() public view override returns (uint256)

Reports the total assets managed by the vault, net of fees, for vault share logic.

function getClaimableFees() public view override returns (uint256)

Calculates and returns the total amount of fees that are currently claimable by the vault manager.

function getSigNonce(address signer) public view override returns (uint256)

Returns the current nonce for a given signer address, used for EIP-712 signatures to prevent replay attacks.

function getLastVaultBalance() public view override returns (uint256)

Returns the last recorded balance of the vault's AToken. This value is updated when yield is accrued.

function getFee() public view override returns (uint256)

Returns the current fee percentage set for the vault.