diff --git a/script/storage.sh b/script/storage.sh
new file mode 100644
index 0000000..5056c3b
--- /dev/null
+++ b/script/storage.sh
@@ -0,0 +1,13 @@
+
+echo "ERC20:"
+# keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC20")) - 1)) & ~bytes32(uint256(0xff))
+
+echo "vault:"
+cast keccak "yieldnest.storage.vault"
+
+echo "asset:"
+cast keccak "yieldnest.storage.asset"
+
+echo "strat:"
+cast keccak "yieldnest.storage.strat"
+
diff --git a/src/Common.sol b/src/Common.sol
index 0e80bb6..783972b 100644
--- a/src/Common.sol
+++ b/src/Common.sol
@@ -7,14 +7,14 @@ import {Address} from "lib/openzeppelin-contracts/contracts/utils/Address.sol";
import {ERC20} from "lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol";
import {ERC20PermitUpgradeable} from
"lib/openzeppelin-contracts-upgradeable/contracts/token/ERC20/extensions/ERC20PermitUpgradeable.sol";
+import {ERC20Upgradeable} from
+ "lib/openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
import {ETHRateProvider} from "src/module/ETHRateProvider.sol";
import {IAccessControl} from "lib/openzeppelin-contracts/contracts/access/IAccessControl.sol";
import {IERC20} from "lib/openzeppelin-contracts/contracts/interfaces/IERC20.sol";
import {IERC20Metadata} from "lib/openzeppelin-contracts/contracts/interfaces/IERC20Metadata.sol";
import {IERC20Permit} from "lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Permit.sol";
import {IStakeManager} from "lib/synclub-contracts/contracts/interfaces/IStakeManager.sol";
-import {IRateProvider} from "src/interface/IRateProvider.sol";
-import {IVault} from "src/interface/IVault.sol";
import {Math} from "lib/openzeppelin-contracts/contracts/utils/math/Math.sol";
import {ProxyAdmin} from "lib/openzeppelin-contracts/contracts/proxy/transparent/ProxyAdmin.sol";
import {ReentrancyGuardUpgradeable} from
@@ -25,7 +25,7 @@ import {TimelockControllerUpgradeable} from
"lib/openzeppelin-contracts-upgradeable/contracts/governance/TimelockControllerUpgradeable.sol";
import {TransparentUpgradeableProxy} from
"lib/openzeppelin-contracts/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {IERC165} from "lib/openzeppelin-contracts/contracts/interfaces/IERC165.sol";
-import {Storage} from "src/Storage.sol";
contract Common {}
diff --git a/src/Storage.sol b/src/Storage.sol
index 4168127..2506473 100644
--- a/src/Storage.sol
+++ b/src/Storage.sol
@@ -2,36 +2,122 @@
pragma solidity ^0.8.24;
import {IVault} from "src/interface/IVault.sol";
+import {IRateProvider} from "src/interface/IRateProvider.sol";
+import {Math, ERC20Upgradeable} from "src/Common.sol";
library Storage {
- bytes32 private constant VAULT_STORAGE_POSITION = keccak256("yieldnest.storage.vault");
- bytes32 private constant ASSET_STORAGE_POSITION = keccak256("yieldnest.storage.asset");
- bytes32 private constant STRAT_STORAGE_POSITION = keccak256("yieldnest.storage.strat");
+ using Math for uint256;
- bytes32 private constant ERC20_STORAGE_POSITION =
- keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC20")) - 1)) & ~bytes32(uint256(0xff));
-
- function _getVaultStorage() internal pure returns (IVault.VaultStorage storage $) {
+ function getVaultStorage() internal pure returns (IVault.VaultStorage storage $) {
assembly {
- $.slot := VAULT_STORAGE_POSITION
+ $.slot := 0x22cdba5640455d74cb7564fb236bbbbaf66b93a0cc1bd221f1ee2a6b2d0a2427
}
}
- function _getAssetStorage() internal pure returns (IVault.AssetStorage storage $) {
+ function getAssetStorage() internal pure returns (IVault.AssetStorage storage $) {
assembly {
- $.slot := ASSET_STORAGE_POSITION
+ $.slot := 0x2dd192a2474c87efcf5ffda906a4b4f8a678b0e41f9245666251cfed8041e680
}
}
- function _getStrategyStorage() internal pure returns (IVault.StrategyStorage storage $) {
+ function getStrategyStorage() internal pure returns (IVault.StrategyStorage storage $) {
assembly {
- $.slot := STRAT_STORAGE_POSITION
+ $.slot := 0x36e313fea70c5f83d23dd12fc41865566e392cbac4c21baf7972d39f7af1774d
}
}
- function _getERC20Storage() internal pure returns (IVault.ERC20Storage storage $) {
+ function getERC20Storage() internal pure returns (ERC20Upgradeable.ERC20Storage storage $) {
assembly {
- $.slot := ERC20_STORAGE_POSITION
+ $.slot := 0x52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00
+ }
+ }
+
+ function getBaseAsset() internal view returns (address) {
+ IVault.AssetStorage storage assetStorage = getAssetStorage();
+ return address(assetStorage.list[0]);
+ }
+
+ function getTotalAssets() internal view returns (uint256) {
+ IVault.VaultStorage storage vaultStorage = getVaultStorage();
+ return vaultStorage.totalAssets;
+ }
+
+ function getRateProvider() internal view returns (address) {
+ IVault.VaultStorage storage vaultStorage = getVaultStorage();
+ return vaultStorage.rateProvider;
+ }
+
+ function getPaused() internal view returns (bool) {
+ IVault.VaultStorage storage vaultStorage = getVaultStorage();
+ return vaultStorage.paused;
+ }
+
+ function getAsset(address asset_) internal view returns (IVault.AssetParams memory) {
+ IVault.AssetStorage storage assetStorage = getAssetStorage();
+ return assetStorage.assets[asset_];
+ }
+
+ function getBaseDecimals() internal view returns (uint8) {
+ IVault.AssetStorage storage assetStorage = getAssetStorage();
+ return assetStorage.assets[getBaseAsset()].decimals + decimalsOffset();
+ }
+
+ function getAllAssets() internal view returns (address[] memory assets_) {
+ IVault.AssetStorage storage assetStorage = Storage.getAssetStorage();
+ uint256 assetListLength = assetStorage.list.length;
+ assets_ = new address[](assetListLength);
+ for (uint256 i = 0; i < assetListLength; i++) {
+ assets_[i] = address(assetStorage.list[i]);
}
}
+
+ function getMaxDeposit() internal pure returns (uint256) {
+ return type(uint256).max;
+ }
+
+ function getMaxMint() internal pure returns (uint256) {
+ return type(uint256).max;
+ }
+
+ function getRate(address asset_) internal view returns (uint256) {
+ return IRateProvider(getRateProvider()).getRate(asset_);
+ }
+
+ function convertAssetsToBase(address asset_, uint256 assets_) internal view returns (uint256) {
+ return (assets_ * getRate(asset_)) / 1e18;
+ }
+
+ function convertBaseToAssets(address asset_, uint256 assets_) internal view returns (uint256) {
+ return (assets_ * 1e18) / getRate(asset_);
+ }
+
+ function convertToAssets(address asset, uint256 shares, Math.Rounding rounding)
+ internal
+ view
+ returns (uint256)
+ {
+ uint256 convertedShares = convertBaseToAssets(asset, shares);
+ return convertedShares.mulDiv(getTotalSupply() + 10 ** decimalsOffset(), getTotalAssets() + 1, rounding);
+ }
+
+ function convertToShares(address asset_, uint256 assets_, Math.Rounding rounding)
+ internal
+ view
+ returns (uint256)
+ {
+ uint256 convertedAssets = convertAssetsToBase(asset_, assets_);
+ return convertedAssets.mulDiv(getTotalSupply() + 10 ** decimalsOffset(), getTotalAssets() + 1, rounding);
+ }
+
+ function decimalsOffset() internal pure returns (uint8) {
+ return 0;
+ }
+
+ // ERC20
+
+ function getTotalSupply() internal view returns (uint256) {
+ ERC20Upgradeable.ERC20Storage storage erc20Storage = getERC20Storage();
+ return erc20Storage._totalSupply;
+ }
+
}
diff --git a/src/Vault.sol b/src/Vault.sol
index fedf435..bca209a 100644
--- a/src/Vault.sol
+++ b/src/Vault.sol
@@ -4,151 +4,129 @@ pragma solidity ^0.8.24;
import {
Address,
IERC20,
- IVault,
Math,
- IRateProvider,
+ IERC20,
IERC20Metadata,
SafeERC20,
- Storage,
AccessControlUpgradeable,
ERC20PermitUpgradeable,
ReentrancyGuardUpgradeable
} from "./Common.sol";
+import {Storage} from "src/Storage.sol";
+import {IRateProvider} from "src/interface/IRateProvider.sol";
+import {IVault} from "src/interface/IVault.sol";
+
contract Vault is IVault, ERC20PermitUpgradeable, AccessControlUpgradeable, ReentrancyGuardUpgradeable {
using SafeERC20 for IERC20;
using Address for address;
- function asset() public view virtual returns (address) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- return assetStorage.list[0];
+ function asset() public view returns (address) {
+ return Storage.getBaseAsset();
}
function assets() public view returns (address[] memory assets_) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- uint256 assetListLength = assetStorage.list.length;
- assets_ = new address[](assetListLength);
- for (uint256 i = 0; i < assetListLength; i++) {
- assets_[i] = assetStorage.list[i];
- }
+ return Storage.getAllAssets();
+ }
+ function decimals() public view virtual override returns (uint8) {
+ return Storage.getBaseDecimals();
+ }
+
+ function totalAssets() public view returns (uint256) {
+ return Storage.getTotalAssets();
}
- function decimals() public view virtual override(IERC20Metadata, ERC20PermitUpgradeable) returns (uint8) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- // QUESTION: Do we need this decimals offset?
- return assetStorage.assets[assetStorage.list[0]].decimals + _decimalsOffset();
+ function paused() public view returns (bool) {
+ return Storage.getPaused();
}
- function totalAssets() public view virtual returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- return vaultStorage.totalAssets;
+ function rateProvider() public view returns (address) {
+ return Storage.getRateProvider();
}
- function maxDeposit(address) public view virtual returns (uint256) {
- return type(uint256).max;
+ function maxDeposit(address) public pure returns (uint256) {
+ return Storage.getMaxDeposit();
}
- function maxMint(address) public view virtual returns (uint256) {
- return type(uint256).max;
+ function maxMint(address) public pure returns (uint256) {
+ return Storage.getMaxMint();
}
// QUESTION: How to handle this in v1 with async withdraws.
- function maxWithdraw(address owner) public view virtual returns (uint256) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- return _convertToAssets(assetStorage.list[0], balanceOf(owner), Math.Rounding.Floor);
+ function maxWithdraw(address owner) public view returns (uint256) {
+ return Storage.convertToAssets(asset(), balanceOf(owner), Math.Rounding.Floor);
}
// QUESTION: How to handle this in v1 with async withdraws.
- function maxRedeem(address owner) public view virtual returns (uint256) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- return assetStorage.list[0].balanceOf(owner);
+ function maxRedeem(address owner) public view returns (uint256) {
+ return IERC20(asset()).balanceOf(owner);
+ }
+
+ function previewDeposit(uint256 assets_) public view returns (uint256) {
+ return Storage.convertToShares(asset(), assets_, Math.Rounding.Floor);
+ }
+
+ function previewDepositAsset(address asset_, uint256 assets_) public view returns (uint256) {
+ return Storage.convertToShares(asset_, assets_, Math.Rounding.Floor);
}
- function previewDeposit(uint256 assetAmount) public view virtual returns (uint256) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- return _convertToShares(assetStorage.list[0], assetAmount, Math.Rounding.Floor);
+ function previewMint(uint256 shares_) public view returns (uint256) {
+ return Storage.convertToAssets(asset(), shares_, Math.Rounding.Ceil);
}
- function previewDepositAsset(address assetAddress, uint256 assetAmount) public view virtual returns (uint256) {
- return _convertToShares(assetAddress, assetAmount, Math.Rounding.Floor);
+ function previewMintAsset(address asset_, uint256 shares_) public view returns (uint256) {
+ return Storage.convertToAssets(asset_, shares_, Math.Rounding.Ceil);
}
- function previewMint(uint256 shares) public view virtual returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- return _convertToAssets(vaultStorage.asset, shares, Math.Rounding.Ceil);
+ function convertToShares(uint256 assets_) public view returns (uint256) {
+ return Storage.convertToShares(asset(), assets_, Math.Rounding.Floor);
}
- function previewMintAsset(address assetAddress, uint256 shareAmount) public view virtual returns (uint256) {
- return _convertToAssets(assetAddress, shareAmount, Math.Rounding.Ceil);
+ function convertToAssets(uint256 shares) public view returns (uint256) {
+ return Storage.convertToAssets(asset(), shares, Math.Rounding.Floor);
}
// QUESTION: How to handle this? Start disabled, come back later
// This would have to be it's own Liquidity and Risk Module
// that calculates the asset ratios and figure out the debt ratio
- function previewWithdraw(uint256 assetAmount) public view virtual returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- return _convertToShares(vaultStorage.asset, assetAmount, Math.Rounding.Ceil);
+ function previewWithdraw(uint256 assets_) public view returns (uint256) {
+ return Storage.convertToShares(asset(), assets_, Math.Rounding.Ceil);
}
- function previewRedeem(uint256 shares) public view virtual returns (uint256) {
- return _convertToAssets(shares, Math.Rounding.Floor);
+ // QUESTION: How do we handle this?
+ function previewRedeem(uint256 shares_) public view returns (uint256) {
+ return Storage.convertToAssets(asset(), shares_, Math.Rounding.Floor);
}
- /**
- * @dev See {IERC4626-deposit}.
- */
- function deposit(uint256 assetAmount, address receiver) public virtual returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- if (vaultStorage.paused) revert Paused();
-
- uint256 maxAssets = maxDeposit(receiver);
- if (assetAmount > maxAssets) {
- revert ExceededMaxDeposit(receiver, assetAmount, maxAssets);
- }
+ function deposit(uint256 assets_, address receiver) public returns (uint256) {
+ if (paused()) revert Paused();
- uint256 shares = previewDeposit(assetAmount);
- _deposit(vaultStorage.asset, _msgSender(), receiver, assetAmount, shares);
+ uint256 shares = previewDeposit(assets_);
+ _deposit(asset(), _msgSender(), receiver, assets_, shares);
return shares;
}
- /**
- * @dev See {IAssetVault-depositAsset}.
- */
- function depositAsset(address assetAddress, uint256 amount, address receiver) public virtual returns (uint256) {
- // uint256 maxAssets = maxDeposit(receiver);
- // if (assets > maxAssets) {
- // revert ERC4626ExceededMaxDeposit(receiver, assets, maxAssets);
- // }
+ function depositAsset(address asset_, uint256 assets_, address receiver) public returns (uint256) {
+ if (paused()) revert Paused();
- // uint256 shares = previewDeposit(assets);
- // _deposit(_msgSender(), receiver, assets, shares);
+ uint256 shares = previewDepositAsset(asset_, assets_);
+ _deposit(asset_, _msgSender(), receiver, assets_, shares);
- // return shares;
+ return shares;
}
- /**
- * @dev See {IERC4626-mint}.
- *
- * As opposed to {deposit}, minting is allowed even if the vault is in a state where the price of a share is zero.
- * In this case, the shares will be minted without requiring any assets to be deposited.
- */
function mint(uint256 shares, address receiver) public virtual returns (uint256) {
- // uint256 maxShares = maxMint(receiver);
- // if (shares > maxShares) {
- // revert ERC4626ExceededMaxMint(receiver, shares, maxShares);
- // }
+ if (paused()) revert Paused();
- // uint256 assets = previewMint(shares);
- // _deposit(_msgSender(), receiver, assets, shares);
+ uint256 assets_ = previewMint(shares);
+ _deposit(asset(), _msgSender(), receiver, assets_, shares);
- // return assets;
+ return assets_;
}
- /**
- * @dev See {IERC4626-withdraw}.
- */
- function withdraw(uint256 assetAmount, address receiver, address owner) public virtual returns (uint256) {
+ // QUESTION: How to handle this in v1 if no sync withdraws
+ function withdraw(uint256 assets_, address receiver, address owner) public virtual returns (uint256) {
// uint256 maxAssets = maxWithdraw(owner);
// if (assets > maxAssets) {
// revert ERC4626ExceededMaxWithdraw(owner, assets, maxAssets);
@@ -160,10 +138,8 @@ contract Vault is IVault, ERC20PermitUpgradeable, AccessControlUpgradeable, Reen
// return shares;
}
- /**
- * @dev See {IERC4626-redeem}.
- */
- function redeem(uint256 shares, address receiver, address owner) public virtual returns (uint256) {
+ // QUESTION: How to handle this in v1 with async withdraws
+ function redeem(uint256 shares_, address receiver, address owner) public virtual returns (uint256) {
// uint256 maxShares = maxRedeem(owner);
// if (shares > maxShares) {
// revert ERC4626ExceededMaxRedeem(owner, shares, maxShares);
@@ -175,78 +151,20 @@ contract Vault is IVault, ERC20PermitUpgradeable, AccessControlUpgradeable, Reen
// return assets;
}
- /**
- * @dev Converts assets to shares with support for rounding direction.
- *
- * This function first converts the assets to a base asset value using `_convertAssetToBase`, then scales this value
- * based on the total supply and total assets of the vault, with the option to round up or down.
- *
- * @param asset The address of the asset to convert.
- * @param assets The amount of assets to convert.
- * @param rounding The rounding direction to use for the conversion.
- * @return The converted share value.
- */
- function _convertToShares(address assetAddress, uint256 assetAmount, Math.Rounding rounding)
- internal
- view
- virtual
- returns (uint256)
- {
- uint256 convertedAssets = _convertAssetsToBase(assetAddress, assetAmount);
- return convertedAssets.mulDiv(totalSupply() + 10 ** _decimalsOffset(), totalAssets() + 1, rounding);
- }
-
- function _convertAssetsToBase(address assetAddress, uint256 assetAmount) internal view returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- uint256 rate = IRateProvider(vaultStorage).rateProvider.getRate(assetAddress);
- return (assetAmount * rate) / 1e18;
- }
-
- /**
- * @dev Converts shares to assets with support for rounding direction.
- *
- * This function takes an asset address, a number of shares, and a rounding direction as input.
- * It first converts the shares to a base asset value using `_convertBaseToAssets`, then scales this value
- * based on the total supply and total assets of the vault, with the option to round up or down.
- *
- * @param asset The address of the asset to convert shares to.
- * @param shares The number of shares to convert.
- * @param rounding The rounding direction to use for the conversion.
- * @return The converted asset value.
- */
- function _convertToAssets(address assetAddress, uint256 shareAmount, Math.Rounding rounding)
- internal
- view
- virtual
- returns (uint256)
- {
- uint256 convertedAssets = _convertBaseToAssets(assetAddress, shareAmount);
- return convertedAssets.mulDiv(totalSupply() + 10 ** _decimalsOffset(), totalAssets() + 1, rounding);
- }
-
- function _convertBaseToAssets(address assetAddress, uint256 baseAmount) internal view returns (uint256) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- uint256 rate = IRateProvider(vaultStorage.rateProvider).getRate(assetAddress);
- return (baseAmount * 1e18) / rate;
- }
-
- /**
- * @dev Being Multi asset, we need to add the asset param here to deposit the user's asset accordingly.
- */
- function _deposit(address assetAddress, address caller, address receiver, uint256 assetAmount, uint256 shares)
+ /// @dev Being Multi asset, we need to add the asset param here to deposit the user's asset accordingly.
+ function _deposit(address asset_, address caller, address receiver, uint256 assets_, uint256 shares)
internal
virtual
{
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- vaultStorage.totalAssets += _convertAssetsToBase(assetAddress, assetAmount);
- SafeERC20.safeTransferFrom(assetAddress, caller, address(this), assetAmount);
+ VaultStorage storage vaultStorage = Storage.getVaultStorage();
+ vaultStorage.totalAssets += Storage.convertAssetsToBase(asset_, assets_);
+ SafeERC20.safeTransferFrom(IERC20(asset_), caller, address(this), assets_);
_mint(receiver, shares);
- emit Deposit(caller, receiver, assetAmount, shares);
+ emit Deposit(caller, receiver, assets_, shares);
}
- /**
- * @dev Withdraw/redeem common workflow.
- */
+
+ // QUESTION: How might we
function _withdraw(address caller, address receiver, address owner, uint256 assetAmount, uint256 shares)
internal
virtual
@@ -268,12 +186,6 @@ contract Vault is IVault, ERC20PermitUpgradeable, AccessControlUpgradeable, Reen
// emit Withdraw(caller, receiver, owner, assets, shares);
}
- function _decimalsOffset() internal view virtual returns (uint8) {
- return 0;
- }
-
- // Admin functions
-
// QUESTION: Start with Strategies or add them later
// vault starts paused because the rate provider and assets / strategies haven't been set
function initialize(address admin, string memory name, string memory symbol) public initializer {
@@ -283,51 +195,51 @@ contract Vault is IVault, ERC20PermitUpgradeable, AccessControlUpgradeable, Reen
__ReentrancyGuard_init();
_grantRole(DEFAULT_ADMIN_ROLE, admin);
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
+ VaultStorage storage vaultStorage = Storage.getVaultStorage();
vaultStorage.paused = true;
}
// QUESTION: Measure the gas difference between IERC20 or address when casting / saving to storage
- function setRateProvider(address rateProvider) public onlyRole(DEFAULT_ADMIN_ROLE) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- vaultStorage.rateProvider = rateProvider;
- emit SetRateProvider(rateProvider);
+ function setRateProvider(address rateProvider_) public onlyRole(DEFAULT_ADMIN_ROLE) {
+ VaultStorage storage vaultStorage = Storage.getVaultStorage();
+ vaultStorage.rateProvider = rateProvider_;
+ emit SetRateProvider(rateProvider_);
}
- function addAsset(address assetAddress, uint256 assetDecimals) public onlyRole(DEFAULT_ADMIN_ROLE) {
- if (assetAddress == address(0)) revert ZeroAddress();
- if (assetDecimals > 18) revert InvalidDecimals();
+ function addAsset(address asset_, uint8 decimals_) public onlyRole(DEFAULT_ADMIN_ROLE) {
+ if (asset_ == address(0)) revert ZeroAddress();
+ if (decimals_ > 18) revert InvalidDecimals();
+
+ AssetStorage storage assetStorage = Storage.getAssetStorage();
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- if (assetStorage.assets[assetAddress].asset != address(0)) revert InvalidAsset();
+ if (assetStorage.assets[asset_].decimals != 0) revert InvalidAsset();
uint256 newIndex = assetStorage.list.length;
- assetStorage.assets[assetAddress] = AssetParams({
- asset: assetAddress,
+ assetStorage.assets[asset_] = AssetParams({
active: true,
index: newIndex,
- decimals: assetDecimals,
+ decimals: decimals_,
idleAssets: 0,
deployedAssets: 0
});
- assetStorage.list.push(assetAddress);
+ assetStorage.list.push(asset_);
- emit AddAsset(assetAddress, assetDecimals, newIndex);
+ emit AddAsset(asset_, decimals_, newIndex);
}
function toggleAsset(address asset_, bool active) public onlyRole(DEFAULT_ADMIN_ROLE) {
- AssetStorage storage assetStorage = Storage._getAssetStorage();
- if (assetStorage.assets[asset_].asset == address(0)) revert AssetNotFound();
+ AssetStorage storage assetStorage = Storage.getAssetStorage();
+ if (assetStorage.assets[asset_].decimals == 0) revert AssetNotFound();
assetStorage.assets[asset_].active = active;
emit ToggleAsset(asset_, active);
}
- function pause(bool paused) public onlyRole(DEFAULT_ADMIN_ROLE) {
- VaultStorage storage vaultStorage = Storage._getVaultStorage();
- vaultStorage.paused = paused;
- emit Pause(paused);
+ function pause(bool paused_) public onlyRole(DEFAULT_ADMIN_ROLE) {
+ VaultStorage storage vaultStorage = Storage.getVaultStorage();
+ vaultStorage.paused = paused_;
+ emit Pause(paused_);
}
// QUESTION: What params should be used here? strategy, asset, etc.
diff --git a/src/interface/IVault.sol b/src/interface/IVault.sol
index 409a502..e8491e1 100644
--- a/src/interface/IVault.sol
+++ b/src/interface/IVault.sol
@@ -18,50 +18,29 @@ interface IVault {
event Pause(bool paused);
event Deposit(address indexed caller, address indexed owner, uint256 assets, uint256 shares);
- // Internal storage vs balanceOf storage
- // QUESTION: What issues are there with lending markets or other issues
struct VaultStorage {
- // Balance of total assets priced in base asset
uint256 totalAssets;
- // The price provider for asset conversions to the base asset
address rateProvider;
- // If the vault is paused or not
bool paused;
}
- // QUESTION: Update the rate instead of the totalAssets?
- // QUESTION: How to avoid recalculating everything everytime
struct AssetParams {
- // Activated or Deactivated
bool active;
- // Index of this asset in the mapping
uint256 index;
- // The decmials of the asset
- uint256 decimals;
- // Current vault deposit balance of this asset
+ uint8 decimals;
uint256 idleAssets;
- // deployedBalance
- // QUESTION: Is this required? We are counting this balance in
- // the strategy.assets
uint256 deployedAssets;
}
struct AssetStorage {
mapping(address => AssetParams) assets;
- IERC20[] list;
+ address[] list;
}
struct StrategyParams {
- // Address of the Strategy
- address strategy;
- // Activated or Deactivated
bool active;
- // The index of this strategy in the map
uint256 index;
- // The percent in 100 * 100 Basis
- // QUESTION: Should this be on the Vault storage?
uint256 ratio;
- // The Asset Address and allocated balance.
mapping(address => uint256) assets;
}
@@ -70,7 +49,7 @@ interface IVault {
address[] list;
}
- // 4626
+ function initialize(address admin_, string memory name_, string memory symbol_) external;
function asset() external view returns (address);
function totalAssets() external view returns (uint256);
function convertToShares(uint256 assets) external view returns (uint256);
@@ -79,44 +58,26 @@ interface IVault {
function maxMint(address) external view returns (uint256);
function maxWithdraw(address owner) external view returns (uint256);
function maxRedeem(address owner) external view returns (uint256);
- function previewWithdraw(uint256 assets) external view returns (uint256);
+ function previewDeposit(uint256 assetAmount) external view returns (uint256);
+ function previewMint(uint256 shares) external view returns (uint256);
+ function previewWithdraw(uint256 assetAmount) external view returns (uint256);
function previewRedeem(uint256 shares) external view returns (uint256);
-
- function deposit(uint256 assets, address receiver) external returns (uint256);
+ function deposit(uint256 assetAmount, address receiver) external returns (uint256);
function mint(uint256 shares, address receiver) external returns (uint256);
- function withdraw(uint256 assets, address receiver, address owner) external returns (uint256);
+ function withdraw(uint256 assetAmount, address receiver, address owner) external returns (uint256);
function redeem(uint256 shares, address receiver, address owner) external returns (uint256);
-
- // multi asset
function assets() external view returns (address[] memory assets_);
- function convertToSharesAsset(address, uint256 assets) external view returns (uint256);
- function convertAssetToAssets(address, uint256 shares) external view returns (uint256);
- function maxDepositAsset(address, address) external view returns (uint256);
- function maxMintAsset(address, address) external view returns (uint256);
- function previewDepositAsset(uint256 assets) external view returns (uint256);
- function previewMintAsset(uint256 shares) external view returns (uint256);
-
- function depositAsset(address asset, uint256 assets, address receiver) external returns (uint256);
- function mintAsset(address asset, uint256 shares, address receiver) external returns (uint256);
-
- function getStrategies() external view returns (address[] memory);
- function getAssets() external view returns (address[] memory);
- function isStrategyActive(address strategy) external view returns (bool);
-
- // admin
- function initialize(address admin_, string memory name_, string memory symbol_) external;
- function addStrategy(address strategy) external;
- function removeStrategy(address strategy) external;
- function processAccounting() external returns (uint256);
+
+ // function maxMintAsset(address assetAddress, address) external view returns (uint256);
+ function previewDepositAsset(address assetAddress, uint256 assetAmount) external view returns (uint256);
+ function previewMintAsset(address assetAddress, uint256 shares) external view returns (uint256);
+ function depositAsset(address assetAddress, uint256 amount, address receiver) external returns (uint256);
+ // function getStrategies() external view returns (address[] memory);
+ // function isStrategyActive(address strategy) external view returns (bool);
+ // function addStrategy(address strategy) external;
+ // function processAccounting() external returns (uint256);
function setRateProvider(address rateProvider) external;
- function addAsset(address assetAddress, uint256 assetDecimals) external;
- function toggleAsset(address asset, bool active) external;
-
- struct ERC20Storage {
- mapping(address => uint256) balances;
- mapping(address => mapping(address => uint256)) allowances;
- uint256 totalSupply;
- string name;
- string symbol;
- }
+ function addAsset(address assetAddress, uint8 assetDecimals) external;
+ function toggleAsset(address assetAddress, bool active) external;
+ function pause(bool paused) external;
}
diff --git a/test/helpers/Etches.sol b/test/helpers/Etches.sol
index 057ebbe..42be316 100644
--- a/test/helpers/Etches.sol
+++ b/test/helpers/Etches.sol
@@ -2,12 +2,15 @@
pragma solidity ^0.8.24;
import {MockStakeManager} from "test/mocks/MockListaStakeManager.sol";
+import {WETH9} from "test/mocks/MockWETH.sol";
+import {MainnetContracts} from "script/Contracts.sol";
+
import "forge-std/Test.sol";
-contract Etches is Test {
- function mockListaStakeManager() public {
- MockStakeManager stakeManager = new MockStakeManager();
- bytes memory code = address(stakeManager).code;
- vm.etch(0x1adB950d8bB3dA4bE104211D5AB038628e477fE6, code);
+contract Etches is Test, MainnetContracts {
+ function mockWETH9() public {
+ WETH9 weth = new WETH9();
+ bytes memory code = address(weth).code;
+ vm.etch(WETH, code);
}
}
diff --git a/test/mocks/MockWETH.sol b/test/mocks/MockWETH.sol
index 4b47fc9..3d69b74 100644
--- a/test/mocks/MockWETH.sol
+++ b/test/mocks/MockWETH.sol
@@ -1,10 +1,757 @@
-// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (C) 2015, 2016, 2017 Dapphub
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see .
+
pragma solidity ^0.8.24;
-import {ERC20} from "lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol";
+contract WETH9 {
+ string public name = "Wrapped Ether";
+ string public symbol = "WETH";
+ uint8 public decimals = 18;
+
+ event Approval(address indexed src, address indexed guy, uint wad);
+ event Transfer(address indexed src, address indexed dst, uint wad);
+ event Deposit(address indexed dst, uint wad);
+ event Withdrawal(address indexed src, uint wad);
-contract MockWETH is ERC20 {
- constructor() ERC20("Wrapped Ether", "WETH") {
- _mint(msg.sender, 1000000 * 10 ** 18); // Mint 1 million WETH
+ mapping (address => uint) public balanceOf;
+ mapping (address => mapping (address => uint)) public allowance;
+
+ receive() external payable {
+ deposit();
+ }
+
+ function deposit() public payable {
+ balanceOf[msg.sender] += msg.value;
+ emit Deposit(msg.sender, msg.value);
+ }
+ function withdraw(uint wad) public {
+ require(balanceOf[msg.sender] >= wad);
+ balanceOf[msg.sender] -= wad;
+ payable(msg.sender).transfer(wad);
+ emit Withdrawal(msg.sender, wad);
+ }
+
+ function totalSupply() public view returns (uint) {
+ return address(this).balance;
+ }
+
+ function approve(address guy, uint wad) public returns (bool) {
+ allowance[msg.sender][guy] = wad;
+ emit Approval(msg.sender, guy, wad);
+ return true;
+ }
+
+ function transfer(address dst, uint wad) public returns (bool) {
+ return transferFrom(msg.sender, dst, wad);
+ }
+
+ function transferFrom(address src, address dst, uint wad)
+ public
+ returns (bool)
+ {
+ require(balanceOf[src] >= wad);
+
+ if (src != msg.sender && allowance[src][msg.sender] != type(uint256).max) {
+ require(allowance[src][msg.sender] >= wad);
+ allowance[src][msg.sender] -= wad;
+ }
+
+ balanceOf[src] -= wad;
+ balanceOf[dst] += wad;
+
+ emit Transfer(src, dst, wad);
+
+ return true;
}
}
+
+
+/*
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
+
+*/
\ No newline at end of file
diff --git a/test/unit/deposit.t.sol b/test/unit/deposit.t.sol
index 37d75b0..02c2b9a 100644
--- a/test/unit/deposit.t.sol
+++ b/test/unit/deposit.t.sol
@@ -2,32 +2,35 @@
pragma solidity ^0.8.24;
import "forge-std/Test.sol";
-import {Vault} from "src/Vault.sol";
-import {ETHRateProvider, ProxyAdmin, TransparentUpgradeableProxy, IVault} from "src/Common.sol";
-import {MockWETH} from "test/mocks/MockWETH.sol";
+import {Vault,IVault} from "src/Vault.sol";
+import {ETHRateProvider, IERC20, TransparentUpgradeableProxy} from "src/Common.sol";
+import {MainnetContracts} from "script/Contracts.sol";
+import {Etches} from "test/helpers/Etches.sol";
+import {WETH9} from "test/mocks/MockWETH.sol";
-contract Vault_Deposit_Unit_Test is Test {
+contract Vault_Deposit_Unit_Test is Test, MainnetContracts, Etches {
Vault public vaultImplementation;
TransparentUpgradeableProxy public vaultProxy;
Vault public vault;
- ProxyAdmin public proxyAdmin;
- MockWETH public mockWETH;
+ WETH9 public weth;
ETHRateProvider public rateProvider;
address public alice = address(0x1);
uint256 public constant INITIAL_BALANCE = 1000 * 10 ** 18;
function setUp() public {
- mockWETH = new MockWETH();
+ weth = WETH9(payable(WETH));
vaultImplementation = new Vault();
- proxyAdmin = new ProxyAdmin();
rateProvider = new ETHRateProvider();
-
+
+ // etch to mock the mainnet contracts address
+ mockWETH9();
+
// Deploy the proxy
bytes memory initData = abi.encodeWithSelector(Vault.initialize.selector, address(this), "Vault Token", "VTK");
- vaultProxy = new TransparentUpgradeableProxy(address(vaultImplementation), address(proxyAdmin), initData);
+ vaultProxy = new TransparentUpgradeableProxy(address(vaultImplementation), address(this), initData);
// Create a Vault interface pointing to the proxy
vault = Vault(address(vaultProxy));
@@ -36,14 +39,16 @@ contract Vault_Deposit_Unit_Test is Test {
vault.setRateProvider(address(rateProvider));
// Add WETH as an asset
- vault.addAsset(address(mockWETH), 18);
+ vault.addAsset(address(weth), 18);
// Give Alice some tokens
- mockWETH.transfer(alice, INITIAL_BALANCE);
+ deal(alice, INITIAL_BALANCE);
+ weth.deposit{value: INITIAL_BALANCE}();
+ weth.transfer(alice, INITIAL_BALANCE);
// Approve vault to spend Alice's tokens
vm.prank(alice);
- mockWETH.approve(address(vault), type(uint256).max);
+ weth.approve(address(vault), type(uint256).max);
// Unpause the vault
vault.pause(false);
@@ -59,11 +64,11 @@ contract Vault_Deposit_Unit_Test is Test {
assertGt(sharesMinted, 0, "No shares were minted");
// Check that the vault received the tokens
- assertEq(mockWETH.balanceOf(address(vault)), depositAmount, "Vault did not receive tokens");
+ assertEq(weth.balanceOf(address(vault)), depositAmount, "Vault did not receive tokens");
// Check that Alice's token balance decreased
assertEq(
- mockWETH.balanceOf(alice), INITIAL_BALANCE - depositAmount, "Alice's balance did not decrease correctly"
+ weth.balanceOf(alice), INITIAL_BALANCE - depositAmount, "Alice's balance did not decrease correctly"
);
// Check that Alice received the correct amount of shares
@@ -87,19 +92,4 @@ contract Vault_Deposit_Unit_Test is Test {
vm.expectRevert(); // Expect the transaction to revert
vault.deposit(excessiveAmount, alice);
}
-
- function testUpgrade() public {
- // Deploy a new implementation
- Vault newImplementation = new Vault();
-
- // Upgrade the proxy to the new implementation
- proxyAdmin.upgrade(TransparentUpgradeableProxy(payable(address(vaultProxy))), address(newImplementation));
-
- // Verify the upgrade
- assertEq(
- proxyAdmin.getProxyImplementation(TransparentUpgradeableProxy(payable(address(vaultProxy)))),
- address(newImplementation),
- "Upgrade failed"
- );
- }
}