Contract Name:
ICHIVaultDepositGuard
Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/IERC20Permit.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20 token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && Address.isContract(address(token));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: Unlicense
pragma solidity >=0.8.4;
import { IICHIVaultDepositGuard } from "../interfaces/IICHIVaultDepositGuard.sol";
import { IICHIVaultFactory } from "../interfaces/IICHIVaultFactory.sol";
import { IICHIVault } from "../interfaces/IICHIVault.sol";
import { IWRAPPED_NATIVE } from "../interfaces/IWRAPPED_NATIVE.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ReentrancyGuard } from "@openzeppelin/contracts/security/ReentrancyGuard.sol";
contract ICHIVaultDepositGuard is IICHIVaultDepositGuard, ReentrancyGuard {
using SafeERC20 for IERC20;
address public immutable override ICHIVaultFactory;
address public immutable override WRAPPED_NATIVE;
address private constant NULL_ADDRESS = address(0);
/// @notice Constructs the IICHIVaultDepositGuard contract.
/// @param _ICHIVaultFactory The address of the ICHIVaultFactory.
constructor(address _ICHIVaultFactory, address _WRAPPED_NATIVE) {
require(_ICHIVaultFactory != NULL_ADDRESS, "DG.constructor: zero address");
ICHIVaultFactory = _ICHIVaultFactory;
WRAPPED_NATIVE = _WRAPPED_NATIVE;
emit Deployed(_ICHIVaultFactory, _WRAPPED_NATIVE);
}
receive() external payable {
assert(msg.sender == WRAPPED_NATIVE); // only accept ETH via fallback from the WRAPPED_NATIVE contract
}
/// @inheritdoc IICHIVaultDepositGuard
function forwardDepositToICHIVault(
address vault,
address vaultDeployer,
address token,
uint256 amount,
uint256 minimumProceeds,
address to
) external override nonReentrant returns (uint256 vaultTokens) {
vaultTokens = _forwardDeposit(vault, vaultDeployer, token, amount, minimumProceeds, to, false);
}
/// @inheritdoc IICHIVaultDepositGuard
function forwardNativeDepositToICHIVault(
address vault,
address vaultDeployer,
uint256 minimumProceeds,
address to
) external payable override nonReentrant returns (uint256 vaultTokens) {
uint256 nativeAmount = msg.value;
IWRAPPED_NATIVE(WRAPPED_NATIVE).deposit{ value: nativeAmount }();
vaultTokens = _forwardDeposit(vault, vaultDeployer, WRAPPED_NATIVE, nativeAmount, minimumProceeds, to, true);
}
/// @inheritdoc IICHIVaultDepositGuard
function forwardWithdrawFromICHIVault(
address vault,
address vaultDeployer,
uint256 shares,
address to,
uint256 minAmount0,
uint256 minAmount1
) external override nonReentrant returns (uint256 amount0, uint256 amount1) {
(amount0, amount1) = _forwardWithdraw(vault, vaultDeployer, shares, to, minAmount0, minAmount1, false);
}
/// @inheritdoc IICHIVaultDepositGuard
function forwardNativeWithdrawFromICHIVault(
address vault,
address vaultDeployer,
uint256 shares,
address to,
uint256 minAmount0,
uint256 minAmount1
) external override nonReentrant returns (uint256 amount0, uint256 amount1) {
(amount0, amount1) = _forwardWithdraw(vault, vaultDeployer, shares, to, minAmount0, minAmount1, true);
}
/// @inheritdoc IICHIVaultDepositGuard
function vaultKey(
address vaultDeployer,
address token0,
address token1,
bool allowToken0,
bool allowToken1
) public view override returns (bytes32 key) {
key = IICHIVaultFactory(ICHIVaultFactory).genKey(vaultDeployer, token0, token1, allowToken0, allowToken1);
}
function _forwardDeposit(
address vault,
address vaultDeployer,
address token,
uint256 amount,
uint256 minimumProceeds,
address to,
bool depositNative
) private returns (uint256 vaultTokens) {
_validateRecipient(to);
(IICHIVault ichiVault, address token0, address token1) = _validateVault(vault, vaultDeployer, depositNative);
require(token == token0 || token == token1, "Invalid token");
if (token == token0) {
require(ichiVault.allowToken0(), "Token0 deposits not allowed");
} else {
require(ichiVault.allowToken1(), "Token1 deposits not allowed");
}
// if deposit is a native deposit then we don't need to transfer WRAPPED_NATIVE
// since this contract receives WRAPPED_NATIVE amount on successful WRAPPED_NATIVE#deposit
if (!depositNative) {
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
}
IERC20(token).safeIncreaseAllowance(vault, amount);
uint256 token0Amount = token == token0 ? amount : 0;
uint256 token1Amount = token == token1 ? amount : 0;
vaultTokens = ichiVault.deposit(token0Amount, token1Amount, to);
require(vaultTokens >= minimumProceeds, "Slippage too great. Try again.");
emit DepositForwarded(msg.sender, vault, token, amount, vaultTokens, to);
}
function _forwardWithdraw(
address vault,
address vaultDeployer,
uint256 shares,
address to,
uint256 minAmount0,
uint256 minAmount1,
bool withdrawNative
) private returns (uint256 amount0, uint256 amount1) {
_validateRecipient(to);
(IICHIVault ichiVault, address token0, address token1) = _validateVault(vault, vaultDeployer, withdrawNative);
// - sender must grant the guard an allowance for the vault share token
// - the guard can then transfer those share tokens to itself
// - the guard then approves the vault an allowance in order to burn shares and withdraw from the vault
IERC20(vault).safeTransferFrom(msg.sender, address(this), shares);
if (withdrawNative) {
// the vault temporarily custodies the withdrawn amounts
(amount0, amount1) = ichiVault.withdraw(shares, address(this));
if (token0 == WRAPPED_NATIVE) {
IWRAPPED_NATIVE(WRAPPED_NATIVE).withdraw(amount0);
payable(to).transfer(amount0);
IERC20(token1).safeTransfer(to, amount1);
} else {
IWRAPPED_NATIVE(WRAPPED_NATIVE).withdraw(amount1);
payable(to).transfer(amount1);
IERC20(token0).safeTransfer(to, amount0);
}
} else {
(amount0, amount1) = ichiVault.withdraw(shares, to);
}
require(amount0 >= minAmount0 && amount1 >= minAmount1, "Insufficient out");
}
function _validateRecipient(address to) private pure {
require(to != NULL_ADDRESS, "Invalid to");
}
function _validateVault(
address vault,
address vaultDeployer,
bool validateNative
) private view returns (IICHIVault ichiVault, address token0, address token1) {
ichiVault = IICHIVault(vault);
token0 = ichiVault.token0();
token1 = ichiVault.token1();
if (validateNative) {
require(token0 == WRAPPED_NATIVE || token1 == WRAPPED_NATIVE, "Native vault");
}
bytes32 factoryVaultKey = vaultKey(
vaultDeployer,
token0,
token1,
ichiVault.allowToken0(),
ichiVault.allowToken1()
);
require(IICHIVaultFactory(ICHIVaultFactory).getICHIVault(factoryVaultKey) == vault, "Invalid vault");
}
}
// SPDX-License-Identifier: Unlicense
pragma solidity >=0.8.4;
interface IICHIVault {
function ichiVaultFactory() external view returns (address);
function pool() external view returns (address);
function token0() external view returns (address);
function allowToken0() external view returns (bool);
function token1() external view returns (address);
function allowToken1() external view returns (bool);
function fee() external view returns (uint24);
function tickSpacing() external view returns (int24);
function ammFeeRecipient() external view returns(address);
function affiliate() external view returns (address);
function baseLower() external view returns (int24);
function baseUpper() external view returns (int24);
function limitLower() external view returns (int24);
function limitUpper() external view returns (int24);
/// @notice NFT ID of the base position. If 0, the base position is not initialized.
function basePositionId() external view returns (uint256);
/// @notice NFT ID of the limit position. If 0, the limit position is not initialized.
function limitPositionId() external view returns (uint256);
function deposit0Max() external view returns (uint256);
function deposit1Max() external view returns (uint256);
function hysteresis() external view returns (uint256);
function twapPeriod() external view returns (uint32);
function auxTwapPeriod() external view returns (uint32);
function getTotalAmounts() external view returns (uint256, uint256);
function getBasePosition() external view returns (uint128, uint256, uint256);
function getLimitPosition() external view returns (uint128, uint256, uint256);
function deposit(uint256, uint256, address) external returns (uint256);
function withdraw(uint256, address) external returns (uint256, uint256);
function currentTick() external view returns (int24);
function resetAllowances() external;
function rebalance(
int24 _baseLower,
int24 _baseUpper,
int24 _limitLower,
int24 _limitUpper,
int256 swapQuantity
) external;
function collectFees() external returns (uint256 fees0, uint256 fees1);
function setDepositMax(uint256 _deposit0Max, uint256 _deposit1Max) external;
function setHysteresis(uint256 _hysteresis) external;
function setAmmFeeRecipient(address _ammFeeRecipient) external;
function setAffiliate(address _affiliate) external;
function setTwapPeriod(uint32 newTwapPeriod) external;
function setAuxTwapPeriod(uint32 newAuxTwapPeriod) external;
event DeployICHIVault(
address indexed sender,
address indexed pool,
bool allowToken0,
bool allowToken1,
address owner,
uint256 twapPeriod
);
event SetTwapPeriod(address sender, uint32 newTwapPeriod);
event SetAuxTwapPeriod(address sender, uint32 newAuxTwapPeriod);
event Deposit(address indexed sender, address indexed to, uint256 shares, uint256 amount0, uint256 amount1);
event Withdraw(address indexed sender, address indexed to, uint256 shares, uint256 amount0, uint256 amount1);
event Rebalance(
int24 tick,
uint256 totalAmount0,
uint256 totalAmount1,
uint256 feeAmount0,
uint256 feeAmount1,
uint256 totalSupply
);
event CollectFees(address indexed sender, uint256 feeAmount0, uint256 feeAmount1);
event Hysteresis(address indexed sender, uint256 hysteresis);
event DepositMax(address indexed sender, uint256 deposit0Max, uint256 deposit1Max);
event AmmFeeRecipient(address indexed sender, address ammFeeRecipient);
event Affiliate(address indexed sender, address affiliate);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity >=0.8.4;
interface IICHIVaultDepositGuard {
/// @notice Emitted when the contract is deployed.
/// @param _ICHIVaultFactory Address of the ICHIVaultFactory.
/// @param _WETH Address of the Wrapped ETH token.
event Deployed(address _ICHIVaultFactory, address _WETH);
/// @notice Emitted when a deposit is forwarded to an ICHIVault.
/// @param sender The address initiating the deposit.
/// @param vault The ICHIVault receiving the deposit.
/// @param token The token being deposited.
/// @param amount The amount of the token being deposited.
/// @param shares The amount of shares issued in the vault as a result of the deposit.
/// @param to The address receiving the vault shares.
event DepositForwarded(
address indexed sender,
address indexed vault,
address indexed token,
uint256 amount,
uint256 shares,
address to
);
/// @notice Retrieves the address of the ICHIVaultFactory.
/// @return Address of the ICHIVaultFactory.
function ICHIVaultFactory() external view returns (address);
/// @notice Retrieves the address of the Wrapped Native Token (e.g., WETH).
/// @return Address of the Wrapped Native Token.
function WRAPPED_NATIVE() external view returns (address);
/// @notice Forwards a deposit to the specified ICHIVault after input validation.
/// @dev Emits a DepositForwarded event upon success.
/// @param vault The address of the ICHIVault to deposit into.
/// @param vaultDeployer The address of the vault deployer.
/// @param token The address of the token being deposited.
/// @param amount The amount of the token being deposited.
/// @param minimumProceeds The minimum amount of vault tokens to be received.
/// @param to The address to receive the vault tokens.
/// @return vaultTokens The number of vault tokens received.
function forwardDepositToICHIVault(
address vault,
address vaultDeployer,
address token,
uint256 amount,
uint256 minimumProceeds,
address to
) external returns (uint256 vaultTokens);
/// @notice Forwards a native currency (e.g., ETH) deposit to an ICHIVault.
/// @dev Converts the native currency to Wrapped Native Token before deposit.
/// @param vault The address of the ICHIVault to deposit into.
/// @param vaultDeployer The address of the vault deployer.
/// @param minimumProceeds The minimum amount of vault tokens to be received.
/// @param to The address to receive the vault tokens.
/// @return vaultTokens The number of vault tokens received.
function forwardNativeDepositToICHIVault(
address vault,
address vaultDeployer,
uint256 minimumProceeds,
address to
) external payable returns (uint256 vaultTokens);
/// @notice Forwards a request to withdraw from an ICHIVault.
/// @param vault The address of the ICHIVault to withdraw from.
/// @param vaultDeployer The address of the vault deployer.
/// @param shares The amount of shares to withdraw.
/// @param to The address to receive the withdrawn tokens.
/// @param minAmount0 The minimum amount of token0 expected to receive.
/// @param minAmount1 The minimum amount of token1 expected to receive.
/// @return amount0 The amount of token0 received.
/// @return amount1 The amount of token1 received.
function forwardWithdrawFromICHIVault(
address vault,
address vaultDeployer,
uint256 shares,
address to,
uint256 minAmount0,
uint256 minAmount1
) external returns (uint256 amount0, uint256 amount1);
/// @notice Forwards a request to withdraw native currency from an ICHIVault.
/// @dev Converts the Wrapped Native Tokens back to native currency on withdrawal.
/// @param vault The address of the ICHIVault to withdraw from.
/// @param vaultDeployer The address of the vault deployer.
/// @param shares The amount of shares to withdraw.
/// @param to The address to receive the withdrawn native currency.
/// @param minAmount0 The minimum amount of token0 expected to receive.
/// @param minAmount1 The minimum amount of token1 expected to receive.
/// @return amount0 The amount of token0 received.
/// @return amount1 The amount of token1 received.
function forwardNativeWithdrawFromICHIVault(
address vault,
address vaultDeployer,
uint256 shares,
address to,
uint256 minAmount0,
uint256 minAmount1
) external returns (uint256 amount0, uint256 amount1);
/// @notice Computes the unique key for a vault based on given parameters.
/// @param vaultDeployer The address of the vault deployer.
/// @param token0 The address of the first token in the vault.
/// @param token1 The address of the second token in the vault.
/// @param allowToken0 Boolean indicating if token0 is allowed in the vault.
/// @param allowToken1 Boolean indicating if token1 is allowed in the vault.
/// @return key The computed unique key for the vault.
function vaultKey(
address vaultDeployer,
address token0,
address token1,
bool allowToken0,
bool allowToken1
) external view returns (bytes32 key);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity >=0.8.4;
interface IICHIVaultFactory {
event FeeRecipient(address indexed sender, address feeRecipient);
event AmmFee(address indexed sender, uint256 ammFee);
event BaseFee(address indexed sender, uint256 baseFee);
event BaseFeeSplit(address indexed sender, uint256 baseFeeSplit);
event DeployICHIVaultFactory(address indexed sender, address algebraFactory);
event ICHIVaultCreated(
address indexed sender,
address ichiVault,
address tokenA,
bool allowTokenA,
address tokenB,
bool allowTokenB,
uint256 count
);
function getICHIVault(bytes32 vaultKey) external view returns(address);
function algebraFactory() external view returns (address);
function nftManager() external view returns (address);
function ammName() external view returns (string memory);
function feeRecipient() external view returns (address);
function ammFee() external view returns (uint256);
function baseFee() external view returns (uint256);
function baseFeeSplit() external view returns (uint256);
function setFeeRecipient(address _feeRecipient) external;
function setAmmFee(uint256 _ammFee) external;
function setBaseFee(uint256 _baseFee) external;
function setBaseFeeSplit(uint256 _baseFeeSplit) external;
function createICHIVault(
address tokenA,
bool allowTokenA,
address tokenB,
bool allowTokenB
) external returns (address ichiVault);
function genKey(
address deployer,
address token0,
address token1,
bool allowToken0,
bool allowToken1
) external pure returns (bytes32 key);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity >=0.8.4;
interface IWRAPPED_NATIVE {
function deposit() external payable;
function transfer(address to, uint value) external returns (bool);
function withdraw(uint) external;
}