feat: Update function calculations

This commit is contained in:
Shriya Tyagi 2023-08-21 17:37:10 +05:30
parent 4f2b61d4d4
commit ddaec8d11a
2 changed files with 344 additions and 310 deletions

View File

@ -1,38 +1,42 @@
//SPDX-License-Identifier: MIT //SPDX-License-Identifier: MIT
pragma solidity ^0.7.0; pragma solidity ^0.7.0;
contract Events { contract Events {
event LogDeposit( event LogDeposit(
address indexed token, address indexed token,
uint256 underlyingAmt, uint256 underlyingAmt,
uint256 minSharesPerToken, uint256 minSharesPerToken,
uint256 getId, uint256 sharesReceieved,
uint256 setId uint256 getId,
); uint256 setId
);
event LogMint(
address indexed token, event LogMint(
uint256 shareAmt, address indexed token,
uint256 maxTokenPerShares, uint256 shareAmt,
uint256 getId, uint256 maxTokenPerShares,
uint256 setId uint256 underlyingTokenAmount,
); uint256 getId,
uint256 setId
event LogWithdraw( );
address indexed token,
uint256 underlyingAmt, event LogWithdraw(
uint256 maxSharesPerToken, address indexed token,
address indexed to, uint256 underlyingAmt,
uint256 getId, uint256 maxSharesPerToken,
uint256 setId uint256 sharedBurned,
); address indexed to,
uint256 getId,
event LogRedeem( uint256 setId
address indexed token, );
uint256 shareAmt,
uint256 minTokenPerShares, event LogRedeem(
address to, address indexed token,
uint256 getId, uint256 shareAmt,
uint256 setId uint256 minTokenPerShares,
); uint256 underlyingAmtReceieved,
} address to,
uint256 getId,
uint256 setId
);
}

View File

@ -1,272 +1,302 @@
//SPDX-License-Identifier: MIT //SPDX-License-Identifier: MIT
pragma solidity ^0.7.0; pragma solidity ^0.7.0;
/** /**
* @title Basic D. * @title Basic D.
* @dev Deposit, Mint, Withdraw, & Redeem from ERC4626 DSA. * @dev Deposit, Mint, Withdraw, & Redeem from ERC4626 DSA.
*/ */
import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { IERC4626 } from "./interface.sol"; import { IERC4626 } from "./interface.sol";
import { TokenInterface } from "../../common/interfaces.sol"; import { TokenInterface } from "../../common/interfaces.sol";
import { DSMath } from "../../common/math.sol"; import { DSMath } from "../../common/math.sol";
import { Basic } from "../../common/basic.sol"; import { Basic } from "../../common/basic.sol";
import { Events } from "./events.sol"; import { Events } from "./events.sol";
abstract contract BasicConnector is Events, DSMath, Basic { abstract contract BasicConnector is Events, DSMath, Basic {
/** /**
* @dev Deposit underlying asset to ERC4626 Vault. * @dev Deposit underlying asset to ERC4626 Vault.
* @notice Mints vault shares by depositing exactly amount of underlying assets * @notice Mints vault shares by depositing exactly amount of underlying assets
* @param token ERC4626 Token address. * @param vaultToken ERC4626 Token address.
* @param underlyingAmt The amount of the underlying asset to deposit. (For max: `uint256(-1)`) * @param underlyingAmt The amount of the underlying asset to deposit. (For max: `uint256(-1)`)
* @param minSharesPerToken The min share rate of deposit * @param minSharesPerToken The min share rate of deposit. Should always be in 18 decimals.
* @param getId ID to retrieve amt. * @param getId ID to retrieve amt.
* @param setId ID stores the amount of tokens deposited. * @param setId ID stores the amount of tokens deposited.
*/ */
function deposit(
function deposit( address vaultToken,
address token, uint256 underlyingAmt,
uint256 underlyingAmt, uint256 minSharesPerToken,
uint256 minSharesPerToken, uint256 getId,
uint256 getId, uint256 setId
uint256 setId ) public returns (string memory _eventName, bytes memory _eventParam) {
) public returns (string memory _eventName, bytes memory _eventParam) { uint256 _underlyingAmt = getUint(getId, underlyingAmt);
uint256 _underlyingAmt = getUint(getId, underlyingAmt);
IERC4626 vaultTokenContract = IERC4626(token); IERC4626 vaultTokenContract = IERC4626(vaultToken);
TokenInterface _underlyingTokenContract = TokenInterface(
address _underlyingToken = vaultTokenContract.asset(); vaultTokenContract.asset()
uint8 _vaultShareDecimal = vaultTokenContract.decimals(); );
TokenInterface underlyingTokenContract = TokenInterface(
_underlyingToken _underlyingAmt = _underlyingAmt == uint256(-1)
); ? _underlyingTokenContract.balanceOf(address(this))
: _underlyingAmt;
_underlyingAmt = _underlyingAmt == uint256(-1)
? underlyingTokenContract.balanceOf(address(this)) // Making sure that the underlying amount is always in 18 decimals.
: _underlyingAmt; uint256 _underlyingAmt18 = convertTo18(
_underlyingTokenContract.decimals(),
uint256 _minShares = convert18ToDec( _underlyingAmt
_vaultShareDecimal, );
wmul(minSharesPerToken, _underlyingAmt)
); uint256 _minShares = convert18ToDec(
vaultTokenContract.decimals(),
uint256 _initialVaultBal = vaultTokenContract.balanceOf(address(this)); wmul(minSharesPerToken, _underlyingAmt18) // Returns final amount in the floor value of the two token decimals.
);
approve(underlyingTokenContract, token, _underlyingAmt);
vaultTokenContract.deposit(_underlyingAmt, address(this)); uint256 _initialVaultBal = vaultTokenContract.balanceOf(address(this));
uint256 _finalVaultBal = vaultTokenContract.balanceOf(address(this)); approve(_underlyingTokenContract, vaultToken, _underlyingAmt);
vaultTokenContract.deposit(_underlyingAmt, address(this));
require(
_minShares <= sub(_finalVaultBal, _initialVaultBal), uint256 _sharesReceieved = sub(
"minShares-exceeds" vaultTokenContract.balanceOf(address(this)),
); _initialVaultBal
);
setUint(setId, _underlyingAmt);
require(_minShares <= _sharesReceieved, "Less shares received");
_eventName = "LogDeposit(address,uint256,uint256,uint256,uint256)";
_eventParam = abi.encode( setUint(setId, _sharesReceieved);
token,
_underlyingAmt, _eventName = "LogDeposit(address,uint256,uint256,uint256,uint256,uint256)";
minSharesPerToken, _eventParam = abi.encode(
getId, vaultToken,
setId _underlyingAmt,
); minSharesPerToken,
} _sharesReceieved,
getId,
/** setId
* @dev Mint underlying asset to ERC4626 Vault. );
* @notice Mints vault shares by minting exactly amount of underlying assets }
* @param token ERC4626 Token address.
* @param shareAmt The amount of the share to mint. (For max: `uint256(-1)`) /**
* @param maxTokenPerShares The max underyling token rate of mint * @dev Mint underlying asset to ERC4626 Vault.
* @param getId ID to retrieve amt. * @notice Mints vault shares by minting exactly amount of underlying assets
* @param setId ID stores the amount of tokens minted. * @param vaultToken ERC4626 Token address.
*/ * @param shareAmt The amount of the share to mint. (For max: `uint256(-1)`)
* @param maxTokenPerShares The max underyling token rate of mint. Always in 18 decimals.
function mint( * @param getId ID to retrieve amt.
address token, * @param setId ID stores the amount of tokens minted.
uint256 shareAmt, */
uint256 maxTokenPerShares, function mint(
uint256 getId, address vaultToken,
uint256 setId uint256 shareAmt,
) public returns (string memory _eventName, bytes memory _eventParam) { uint256 maxTokenPerShares,
uint256 _shareAmt = getUint(getId, shareAmt); uint256 getId,
IERC4626 vaultTokenContract = IERC4626(token); uint256 setId
) public returns (string memory _eventName, bytes memory _eventParam) {
address _underlyingToken = vaultTokenContract.asset(); uint256 _shareAmt = getUint(getId, shareAmt);
uint8 _vaultShareDecimal = vaultTokenContract.decimals();
TokenInterface underlyingTokenContract = TokenInterface( IERC4626 vaultTokenContract = IERC4626(vaultToken);
_underlyingToken TokenInterface underlyingTokenContract = TokenInterface(
); vaultTokenContract.asset()
);
_shareAmt = _shareAmt == uint256(-1)
? vaultTokenContract.balanceOf(address(this)) // In vault token decimals
: _shareAmt; _shareAmt = _shareAmt == uint256(-1)
? vaultTokenContract.balanceOf(address(this))
maxTokenPerShares = convertTo18( : _shareAmt;
_vaultShareDecimal,
wmul(maxTokenPerShares, _shareAmt) // In 18 decimals
); maxTokenPerShares = convertTo18(
vaultTokenContract.decimals(),
uint256 _approveUnderlyingTokenAmount = vaultTokenContract.previewMint( wmul(maxTokenPerShares, _shareAmt) // Returns final amount in the vault token decimals.
_shareAmt );
);
// In token decimals
uint256 _initalUnderlyingBal = IERC20(_underlyingToken).balanceOf( maxTokenPerShares = convert18ToDec(
address(this) underlyingTokenContract.decimals(),
); maxTokenPerShares
);
approve(underlyingTokenContract, token, _approveUnderlyingTokenAmount);
// In token decimals
vaultTokenContract.mint(_shareAmt, address(this)); uint256 _underlyingTokenAmount = vaultTokenContract.previewMint(
_shareAmt
uint256 _finalUnderlyingBal = IERC20(_underlyingToken).balanceOf( );
address(this)
); // In token decimals
uint256 _initalUnderlyingBal = underlyingTokenContract.balanceOf(
require( address(this)
maxTokenPerShares >= sub(_initalUnderlyingBal, _finalUnderlyingBal), );
"maxTokenPerShares-exceeds"
); approve(underlyingTokenContract, vaultToken, _underlyingTokenAmount);
setUint(setId, _shareAmt); vaultTokenContract.mint(_shareAmt, address(this));
_eventName = "LogMint(address,uint256,uint256,uint256,uint256)"; // In token decimals
_eventParam = abi.encode( uint256 _finalUnderlyingBal = underlyingTokenContract.balanceOf(
token, address(this)
_shareAmt, );
maxTokenPerShares,
getId, require(
setId maxTokenPerShares >= sub(_initalUnderlyingBal, _finalUnderlyingBal),
); "maxTokenPerShares-exceeds"
} );
/** setUint(setId, _shareAmt);
* @dev Withdraw underlying asset from ERC4626 Vault.
* @notice Withdraw vault shares with exactly amount of underlying assets _eventName = "LogMint(address,uint256,uint256,uint256,uint256,uint256)";
* @param token ERC4626 Token address. _eventParam = abi.encode(
* @param underlyingAmt The amount of the token to withdraw. (For max: `uint256(-1)`) vaultToken,
* @param maxSharesPerToken The max share rate of withdrawn amount. _shareAmt,
* @param to The address of receiver. maxTokenPerShares,
* @param getId ID to retrieve amt. _underlyingTokenAmount,
* @param setId ID stores the amount of tokens withdrawn. getId,
*/ setId
);
function withdraw( }
address token,
uint256 underlyingAmt, /**
uint256 maxSharesPerToken, * @dev Withdraw underlying asset from ERC4626 Vault.
address payable to, * @notice Withdraw vault shares with exactly amount of underlying assets
uint256 getId, * @param vaultToken ERC4626 Token address.
uint256 setId * @param underlyingAmt The amount of the token to withdraw. (For max: `uint256(-1)`)
) public returns (string memory _eventName, bytes memory _eventParam) { * @param maxSharesPerToken The max share rate of withdrawn amount. Always send in 18 decimals.
uint256 _underlyingAmt = getUint(getId, underlyingAmt); * @param to The address of receiver.
IERC4626 vaultTokenContract = IERC4626(token); * @param getId ID to retrieve amt.
* @param setId ID stores the amount of tokens withdrawn.
address _underlyingToken = vaultTokenContract.asset(); */
uint8 _vaultShareDecimal = vaultTokenContract.decimals(); function withdraw(
TokenInterface underlyingTokenContract = TokenInterface( address vaultToken,
_underlyingToken uint256 underlyingAmt,
); uint256 maxSharesPerToken,
address payable to,
_underlyingAmt = _underlyingAmt == uint256(-1) uint256 getId,
? underlyingTokenContract.balanceOf(address(this)) uint256 setId
: _underlyingAmt; ) public returns (string memory _eventName, bytes memory _eventParam) {
uint256 _underlyingAmt = getUint(getId, underlyingAmt);
uint256 _maxShares = convert18ToDec(
_vaultShareDecimal, IERC4626 vaultTokenContract = IERC4626(vaultToken);
wmul(maxSharesPerToken, _underlyingAmt) TokenInterface underlyingTokenContract = TokenInterface(
); vaultTokenContract.asset()
);
uint256 _initialVaultBal = vaultTokenContract.balanceOf(to);
// In token decimals
vaultTokenContract.withdraw(_underlyingAmt, to, address(this)); _underlyingAmt = _underlyingAmt == uint256(-1)
? underlyingTokenContract.balanceOf(address(this))
uint256 _finalVaultBal = vaultTokenContract.balanceOf(to); : _underlyingAmt;
require( // In 18 decimals
_maxShares >= sub(_finalVaultBal, _initialVaultBal), _underlyingAmt = convertTo18(
"maxShares-exceeds" underlyingTokenContract.decimals(),
); _underlyingAmt
);
setUint(setId, _underlyingAmt);
// In vault token decimals
_eventName = "LogWithdraw(address,uint256,uint256,address,uint256,uint256)"; uint256 _maxShares = convert18ToDec(
_eventParam = abi.encode( vaultTokenContract.decimals(),
token, wmul(maxSharesPerToken, _underlyingAmt) // In 18 decimals
_underlyingAmt, );
maxSharesPerToken,
to, // In vault token decimals
getId, uint256 _initialVaultBal = vaultTokenContract.balanceOf(to);
setId
); vaultTokenContract.withdraw(_underlyingAmt, to, address(this));
}
// In vault token decimals
/** uint256 _finalVaultBal = vaultTokenContract.balanceOf(to);
* @dev Redeem underlying asset from ERC4626 Vault.
* @notice Redeem vault shares with exactly amount of underlying assets // In vault token decimals
* @param token ERC4626 Token address. uint256 _sharesBurned = sub(_initialVaultBal, _finalVaultBal);
* @param shareAmt The amount of the token to redeem. (For max: `uint256(-1)`)
* @param minTokenPerShares The min underlying token rate of withdraw. require(_maxShares >= _sharesBurned, "maxShares-exceeds");
* @param to The address of receiver.
* @param getId ID to retrieve amt. setUint(setId, _underlyingAmt);
* @param setId ID stores the amount of tokens redeem.
*/ _eventName = "LogWithdraw(address,uint256,uint256,uint256,address,uint256,uint256)";
_eventParam = abi.encode(
function redeem( vaultToken,
address token, _underlyingAmt,
uint256 shareAmt, maxSharesPerToken,
uint256 minTokenPerShares, _sharesBurned,
address payable to, to,
uint256 getId, getId,
uint256 setId setId
) public returns (string memory _eventName, bytes memory _eventParam) { );
uint256 _shareAmt = getUint(getId, shareAmt); }
IERC4626 vaultTokenContract = IERC4626(token);
/**
address _underlyingToken = vaultTokenContract.asset(); * @dev Redeem underlying asset from ERC4626 Vault.
uint8 _vaultShareDecimal = vaultTokenContract.decimals(); * @notice Redeem vault shares with exactly amount of underlying assets
TokenInterface underlyingTokenContract = TokenInterface( * @param vaultToken ERC4626 Token address.
_underlyingToken * @param shareAmt The amount of the token to redeem. (For max: `uint256(-1)`)
); * @param minTokenPerShares The min underlying token rate of withdraw. Always in 18 decimals.
* @param to The address of receiver.
_shareAmt = _shareAmt == uint256(-1) * @param getId ID to retrieve amt.
? vaultTokenContract.balanceOf(address(this)) * @param setId ID stores the amount of tokens redeem.
: _shareAmt; */
uint256 _minUnderlyingAmt = convert18ToDec( function redeem(
_vaultShareDecimal, address vaultToken,
wmul(minTokenPerShares, _shareAmt) uint256 shareAmt,
); uint256 minTokenPerShares,
address payable to,
uint256 _initalUnderlyingBal = IERC20(_underlyingToken).balanceOf( uint256 getId,
to uint256 setId
); ) public returns (string memory _eventName, bytes memory _eventParam) {
uint256 _shareAmt = getUint(getId, shareAmt);
vaultTokenContract.redeem(_shareAmt, to, address(this));
IERC4626 vaultTokenContract = IERC4626(vaultToken);
uint256 _finalUnderlyingBal = IERC20(_underlyingToken).balanceOf( TokenInterface underlyingTokenContract = TokenInterface(
to vaultTokenContract.asset()
); );
require( // In vault token decimals
_minUnderlyingAmt <= sub(_finalUnderlyingBal, _initalUnderlyingBal), _shareAmt = _shareAmt == uint256(-1)
"_minUnderlyingAmt-exceeds" ? vaultTokenContract.balanceOf(address(this))
); : _shareAmt;
setUint(setId, _shareAmt);
// In 18 decimals
_eventName = "LogRedeem(address,uint256,uint256,address,uint256,uint256)"; _shareAmt = convertTo18(vaultTokenContract.decimals(), _shareAmt);
_eventParam = abi.encode(
token, // In token decimals
_shareAmt, uint256 _minUnderlyingAmt = convert18ToDec(
minTokenPerShares, underlyingTokenContract.decimals(),
to, wmul(minTokenPerShares, _shareAmt) // In 18 decimals
getId, );
setId
); // In token decimals
} uint256 _initalUnderlyingBal = underlyingTokenContract.balanceOf(to);
}
vaultTokenContract.redeem(_shareAmt, to, address(this));
contract ConnectV2BasicERC4626 is BasicConnector {
string public constant name = "BASIC-ERC4626-v1.0"; // In token decimals
} uint256 _finalUnderlyingBal = underlyingTokenContract.balanceOf(to);
// In token decimals
uint256 _underlyingAmtReceieved = sub(
_finalUnderlyingBal,
_initalUnderlyingBal
);
require(
_minUnderlyingAmt <= _underlyingAmtReceieved,
"_minUnderlyingAmt-exceeds"
);
setUint(setId, _shareAmt);
_eventName = "LogRedeem(address,uint256,uint256,uint256,address,uint256,uint256)";
_eventParam = abi.encode(
vaultToken,
_shareAmt,
minTokenPerShares,
_underlyingAmtReceieved,
to,
getId,
setId
);
}
}
contract ConnectV2BasicERC4626 is BasicConnector {
string public constant name = "BASIC-ERC4626-v1.0";
}