Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NES-211] resolve two bugs with checking balances and limiting list sizes #23

Merged
merged 2 commits into from
Sep 20, 2024
Merged

[NES-211] resolve two bugs with checking balances and limiting list sizes #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5fd3b5
[NES-211] validate that there is enough AssetToken to create new yiel…
eyqs Sep 19, 2024
6963b7e
check if the distribution already exists
eyqs Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 34 additions & 19 deletions smart-wallets/src/extensions/AssetVault.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.25;

import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";

import { IAssetToken } from "../interfaces/IAssetToken.sol";
import { IAssetVault } from "../interfaces/IAssetVault.sol";
import { AssetToken } from "../token/AssetToken.sol";

/**
* @title AssetVault
Expand Down Expand Up @@ -43,9 +43,9 @@ contract AssetVault is IAssetVault {
/// @custom:storage-location erc7201:plume.storage.AssetVault
struct AssetVaultStorage {
/// @dev Mapping of yield allowances for each asset token and beneficiary
mapping(AssetToken assetToken => mapping(address beneficiary => Yield allowance)) yieldAllowances;
mapping(IAssetToken assetToken => mapping(address beneficiary => Yield allowance)) yieldAllowances;
/// @dev Mapping of the yield distribution list for each asset token
mapping(AssetToken assetToken => YieldDistributionListItem distribution) yieldDistributions;
mapping(IAssetToken assetToken => YieldDistributionListItem distribution) yieldDistributions;
}

// keccak256(abi.encode(uint256(keccak256("plume.storage.AssetVault")) - 1)) & ~bytes32(uint256(0xff))
Expand Down Expand Up @@ -80,7 +80,7 @@ contract AssetVault is IAssetVault {
* @param expiration Timestamp at which the yield expires
*/
event YieldAllowanceUpdated(
AssetToken indexed assetToken, address indexed beneficiary, uint256 amount, uint256 expiration
IAssetToken indexed assetToken, address indexed beneficiary, uint256 amount, uint256 expiration
);

/**
Expand All @@ -91,7 +91,7 @@ contract AssetVault is IAssetVault {
* @param yieldShare Amount of currencyToken that was redistributed to the beneficiary
*/
event YieldRedistributed(
AssetToken indexed assetToken, address indexed beneficiary, ERC20 indexed currencyToken, uint256 yieldShare
IAssetToken indexed assetToken, address indexed beneficiary, IERC20 indexed currencyToken, uint256 yieldShare
);

/**
Expand All @@ -102,7 +102,7 @@ contract AssetVault is IAssetVault {
* @param expiration Timestamp at which the yield expires
*/
event YieldDistributionCreated(
AssetToken indexed assetToken, address indexed beneficiary, uint256 amount, uint256 expiration
IAssetToken indexed assetToken, address indexed beneficiary, uint256 amount, uint256 expiration
);

/**
Expand All @@ -111,14 +111,14 @@ contract AssetVault is IAssetVault {
* @param beneficiary Address of the beneficiary of the yield distribution
* @param amount Amount of AssetTokens that are renounced from the yield distributions of the beneficiary
*/
event YieldDistributionRenounced(AssetToken indexed assetToken, address indexed beneficiary, uint256 amount);
event YieldDistributionRenounced(IAssetToken indexed assetToken, address indexed beneficiary, uint256 amount);

/**
* @notice Emitted when anyone clears expired yield distributions from the linked list
* @param assetToken AssetToken from which the yield is to be redistributed
* @param amountCleared Amount of AssetTokens that were cleared from the yield distributions
*/
event YieldDistributionsCleared(AssetToken indexed assetToken, uint256 amountCleared);
event YieldDistributionsCleared(IAssetToken indexed assetToken, uint256 amountCleared);

// Errors

Expand Down Expand Up @@ -150,9 +150,16 @@ contract AssetVault is IAssetVault {
* @param amount Amount of assetTokens that the beneficiary tried to accept the yield of
*/
error InsufficientYieldAllowance(
AssetToken assetToken, address beneficiary, uint256 allowanceAmount, uint256 amount
IAssetToken assetToken, address beneficiary, uint256 allowanceAmount, uint256 amount
);

/**
* @notice Indicates a failure because the user wallet does not have enough AssetTokens
* @param assetToken AssetToken for which a new yield distribution is to be made
* @param amount Amount of assetTokens that the user wallet tried to add to the distribution
*/
error InsufficientBalance(IAssetToken assetToken, uint256 amount);

/**
* @notice Indicates a failure because the beneficiary does not have enough yield distributions
* @param assetToken AssetToken from which the yield is to be redistributed
Expand All @@ -161,7 +168,7 @@ contract AssetVault is IAssetVault {
* @param amountRenounced Amount of assetTokens that the beneficiary tried to renounce the yield of
*/
error InsufficientYieldDistributions(
AssetToken assetToken, address beneficiary, uint256 amount, uint256 amountRenounced
IAssetToken assetToken, address beneficiary, uint256 amount, uint256 amountRenounced
);

/**
Expand Down Expand Up @@ -203,7 +210,7 @@ contract AssetVault is IAssetVault {
* @param expiration Timestamp at which the yield expires
*/
function updateYieldAllowance(
AssetToken assetToken,
IAssetToken assetToken,
address beneficiary,
uint256 amount,
uint256 expiration
Expand Down Expand Up @@ -234,8 +241,8 @@ contract AssetVault is IAssetVault {
* @param currencyTokenAmount Amount of currencyToken to redistribute
*/
function redistributeYield(
AssetToken assetToken,
ERC20 currencyToken,
IAssetToken assetToken,
IERC20 currencyToken,
uint256 currencyTokenAmount
) external onlyWallet {
if (currencyTokenAmount == 0) {
Expand Down Expand Up @@ -265,7 +272,7 @@ contract AssetVault is IAssetVault {
* @notice Get the number of AssetTokens that are currently locked in the AssetVault
* @param assetToken AssetToken from which the yield is to be redistributed
*/
function getBalanceLocked(AssetToken assetToken) public view returns (uint256 balanceLocked) {
function getBalanceLocked(IAssetToken assetToken) public view returns (uint256 balanceLocked) {
// Iterate through the list and sum up the locked balance across all yield distributions
YieldDistributionListItem storage distribution = _getAssetVaultStorage().yieldDistributions[assetToken];
uint256 amountLocked = distribution.yield.amount;
Expand All @@ -285,7 +292,7 @@ contract AssetVault is IAssetVault {
* @param amount Amount of AssetTokens included in this yield allowance
* @param expiration Timestamp at which the yield expires
*/
function acceptYieldAllowance(AssetToken assetToken, uint256 amount, uint256 expiration) external {
function acceptYieldAllowance(IAssetToken assetToken, uint256 amount, uint256 expiration) external {
AssetVaultStorage storage $ = _getAssetVaultStorage();
address beneficiary = msg.sender;
Yield storage allowance = $.yieldAllowances[assetToken][beneficiary];
Expand All @@ -302,12 +309,20 @@ contract AssetVault is IAssetVault {
if (allowance.amount < amount) {
revert InsufficientYieldAllowance(assetToken, beneficiary, allowance.amount, amount);
}
if (assetToken.getBalanceAvailable(address(this)) < amount) {
revert InsufficientBalance(assetToken, amount);
}

allowance.amount -= amount;

// Append the newly created yield distribution to the end of the linked list
// Either update the existing distribution with the same expiration or append a new one
YieldDistributionListItem storage distribution = $.yieldDistributions[assetToken];
while (distribution.yield.amount > 0) {
if (distribution.beneficiary == beneficiary && distribution.yield.expiration == expiration) {
distribution.yield.amount += amount;
emit YieldDistributionCreated(assetToken, beneficiary, amount, expiration);
return;
}
distribution = distribution.next[0];
}
distribution.beneficiary = beneficiary;
Expand All @@ -327,7 +342,7 @@ contract AssetVault is IAssetVault {
* @param expiration Timestamp at which the yield expires
*/
function renounceYieldDistribution(
AssetToken assetToken,
IAssetToken assetToken,
uint256 amount,
uint256 expiration
) external returns (uint256 amountRenounced) {
Expand Down Expand Up @@ -376,7 +391,7 @@ contract AssetVault is IAssetVault {
* reaching the gas limit, and the caller must call the function again to clear more.
* @param assetToken AssetToken from which the yield is to be redistributed
*/
function clearYieldDistributions(AssetToken assetToken) external {
function clearYieldDistributions(IAssetToken assetToken) external {
uint256 amountCleared = 0;

// Iterate through the list and delete all expired yield distributions
Expand Down
18 changes: 10 additions & 8 deletions smart-wallets/src/interfaces/IAssetVault.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.25;

import { AssetToken } from "../token/AssetToken.sol";
import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";

import { IAssetToken } from "../interfaces/IAssetToken.sol";

interface IAssetVault {

function updateYieldAllowance(
AssetToken assetToken,
IAssetToken assetToken,
address beneficiary,
uint256 amount,
uint256 expiration
) external;
function redistributeYield(AssetToken assetToken, ERC20 currencyToken, uint256 currencyTokenAmount) external;
function redistributeYield(IAssetToken assetToken, IERC20 currencyToken, uint256 currencyTokenAmount) external;

function getBalanceLocked(AssetToken assetToken) external view returns (uint256 balanceLocked);
function acceptYieldAllowance(AssetToken assetToken, uint256 amount, uint256 expiration) external;
function wallet() external view returns (address wallet);
function getBalanceLocked(IAssetToken assetToken) external view returns (uint256 balanceLocked);
function acceptYieldAllowance(IAssetToken assetToken, uint256 amount, uint256 expiration) external;
function renounceYieldDistribution(
AssetToken assetToken,
IAssetToken assetToken,
uint256 amount,
uint256 expiration
) external returns (uint256 amountRenounced);
function clearYieldDistributions(AssetToken assetToken) external;
function clearYieldDistributions(IAssetToken assetToken) external;

}