// SPDX-License-Identifier: MIT
// File @openzeppelin/contracts/token/ERC20/IERC20.sol@v4.9.6
// Original license: 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);
}
// File @openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol@v4.9.6
// Original license: SPDX_License_Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// File @openzeppelin/contracts/interfaces/IERC20Metadata.sol@v4.9.6
// Original license: SPDX_License_Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (interfaces/IERC20Metadata.sol)
pragma solidity ^0.8.0;
// File @openzeppelin/contracts/interfaces/IERC4626.sol@v4.9.6
// Original license: SPDX_License_Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC4626.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC4626 "Tokenized Vault Standard", as defined in
* https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
*
* _Available since v4.7._
*/
interface IERC4626 is IERC20, IERC20Metadata {
event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
event Withdraw(
address indexed sender,
address indexed receiver,
address indexed owner,
uint256 assets,
uint256 shares
);
/**
* @dev Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
*
* - MUST be an ERC-20 token contract.
* - MUST NOT revert.
*/
function asset() external view returns (address assetTokenAddress);
/**
* @dev Returns the total amount of the underlying asset that is “managed” by Vault.
*
* - SHOULD include any compounding that occurs from yield.
* - MUST be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT revert.
*/
function totalAssets() external view returns (uint256 totalManagedAssets);
/**
* @dev Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToShares(uint256 assets) external view returns (uint256 shares);
/**
* @dev Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToAssets(uint256 shares) external view returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver,
* through a deposit call.
*
* - MUST return a limited value if receiver is subject to some deposit limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
* - MUST NOT revert.
*/
function maxDeposit(address receiver) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit
* call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called
* in the same transaction.
* - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the
* deposit would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewDeposit(uint256 assets) external view returns (uint256 shares);
/**
* @dev Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* deposit execution, and are accounted for during deposit.
* - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function deposit(uint256 assets, address receiver) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
* - MUST return a limited value if receiver is subject to some mint limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
* - MUST NOT revert.
*/
function maxMint(address receiver) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call
* in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the
* same transaction.
* - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint
* would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by minting.
*/
function previewMint(uint256 shares) external view returns (uint256 assets);
/**
* @dev Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint
* execution, and are accounted for during mint.
* - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function mint(uint256 shares, address receiver) external returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
* Vault, through a withdraw call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxWithdraw(address owner) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw
* call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if
* called
* in the same transaction.
* - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though
* the withdrawal would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewWithdraw(uint256 assets) external view returns (uint256 shares);
/**
* @dev Burns shares from owner and sends exactly assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* withdraw execution, and are accounted for during withdraw.
* - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault,
* through a redeem call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxRedeem(address owner) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
* in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the
* same transaction.
* - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the
* redemption would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by redeeming.
*/
function previewRedeem(uint256 shares) external view returns (uint256 assets);
/**
* @dev Burns exactly shares from owner and sends assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* redeem execution, and are accounted for during redeem.
* - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
}
// File @openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol@v4.9.6
// Original license: SPDX_License_Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (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.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
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].
*
* CAUTION: See Security Considerations above.
*/
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);
}
// File @openzeppelin/contracts/utils/Address.sol@v4.9.6
// Original license: 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);
}
}
}
// File @openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol@v4.9.6
// Original license: SPDX_License_Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
/**
* @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));
}
}
// File src/intf/IImpactVault.sol
// Original license: SPDX_License_Identifier: MIT
pragma solidity 0.8.19;
// █████████ ███████████ █████████ ███████████ ███████████ █████████ ██████ █████ █████ ████ █████████ █████ ███ █████ █████ ███████████ ███████████ ██████████ ███████████ █████ █████████ ██████ █████ ██████████
// ███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░██████ ░░███ ░░███ ███░ ███░░░░░███░░███ ░███ ░░███ ░░███ ░█░░░███░░░█░█░░░░░░███ ░░███░░░░░█░░███░░░░░███ ░░███ ███░░░░░███ ░░██████ ░░███ ░░███░░░░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ███ ░███ ░░░ ░███ ░███ ░███ ░███ ░ ░███ ░ ░ ███░ ░███ █ ░ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ░░███
// ░███████████ ░██████████ ░███████████ ░██████████ ░██████████ ░███████████ ░███░░███░███ ░███████ ░░█████████ ░███ ░███ ░███ ░███ ░███ ███ ░██████ ░██████████ ░███ ░███████████ ░███░░███░███ ░███ ░███
// ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███ ░░██████ ░███░░███ ░░░░░░░░███ ░░███ █████ ███ ░███ ░███ ███ ░███░░█ ░███░░░░░███ ░███ ░███░░░░░███ ░███ ░░██████ ░███ ░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░░█████ ░███ ░░███ ███ ░███ ░░░█████░█████░ ░███ ░███ ████ █ ░███ ░ █ ░███ ░███ ░███ █ ░███ ░███ ░███ ░░█████ ░███ ███
// █████ █████ █████ █████ █████ █████ ███████████ ███████████ █████ █████ █████ ░░█████ █████ ░░████ ░░█████████ ░░███ ░░███ █████ █████ ███████████ ██████████ █████ █████ ███████████ █████ █████ █████ ░░█████ ██████████
// ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░ ░░░░░░░░░ ░░░ ░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░
//
//
// ,ad8888ba, db 88888888ba, 88b d88 ,ad8888ba, ad88888ba
// d8"' `"8b d88b 88 `"8b 888b d888 d8"' `"8b d8" "8b
// d8' d8'`8b 88 `8b 88`8b d8'88 d8' `8b Y8,
// 88 d8' `8b 88 88 88 `8b d8' 88 88 88 `Y8aaaaa,
// 88 d8YaaaaY8b 88 88 88 `8b d8' 88 88 88 `"""""8b,
// Y8, d8""""""""8b 88 8P 88 `8b d8' 88 Y8, ,8P `8b
// Y8a. .a8P d8' `8b 88 .a8P 88 `888' 88 Y8a. .a8P Y8a a8P
// `"Y8888Y"' d8' `8b 88888888Y"' 88 `8' 88 `"Y8888Y"' "Y88888P"
//
// ===============================================================================================
// ===================================== IImpactVault ==========================================
// ===============================================================================================
// ARAB BANK SWITZZERLAND: https://github.com/ArabBankSwitzerland
// CADMOS: https://github.com/Cadmos-finance
// Primary Author(s)
// N.B.: https://github.com/nboueri
// J.A.T: https://github.com/jat9292
/// @title Interface of the ImpactVault Contract
/// @author N.B.
/// @notice Used to donate gains stemming from a positively rebasing token
interface IImpactVault is IERC20Metadata {
error DepositTooLow();
struct TimelockedSurplus {
uint128 surplus; // TimeLocked surplus - distributable at timelock expiry (1 day)
uint64 timestamp; // Ok until 2554 - timestamp when surplus was timelocked
uint64 minimalCollectAmount; // Minimal Amount to auto-Collect at each deposit/ withdrawal - can be set by _owner
}
/* ========== MUTATIVE FUNCTIONS ========== */
/// @notice Collects Asset Surplus as a donation for Owner - Does not collect if surplus is less than minimalTransfer
function collectDonations(
uint64 minimalTransfer
)
external
returns (
uint128 collectedAmount,
uint256 netWealth,
uint256 totalSupply
);
/* ========== RESTRICTED FUNCTIONS ========== */
/// @notice Allows Owner to set minimalCollectAmount
function setAutoCollectThreshold(uint64 newMinimalCollectAmount) external;
/* ========== EVENTS ========== */
event SetAutoCollectThreshold(
uint64 newMinimalCollectAmount,
uint64 oldMinimalCollectAmount
);
}
// File src/intf/IImpactVaultDepositor.sol
// Original license: SPDX_License_Identifier: MIT
pragma solidity 0.8.19;
// █████████ ███████████ █████████ ███████████ ███████████ █████████ ██████ █████ █████ ████ █████████ █████ ███ █████ █████ ███████████ ███████████ ██████████ ███████████ █████ █████████ ██████ █████ ██████████
// ███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░██████ ░░███ ░░███ ███░ ███░░░░░███░░███ ░███ ░░███ ░░███ ░█░░░███░░░█░█░░░░░░███ ░░███░░░░░█░░███░░░░░███ ░░███ ███░░░░░███ ░░██████ ░░███ ░░███░░░░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ███ ░███ ░░░ ░███ ░███ ░███ ░███ ░ ░███ ░ ░ ███░ ░███ █ ░ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ░░███
// ░███████████ ░██████████ ░███████████ ░██████████ ░██████████ ░███████████ ░███░░███░███ ░███████ ░░█████████ ░███ ░███ ░███ ░███ ░███ ███ ░██████ ░██████████ ░███ ░███████████ ░███░░███░███ ░███ ░███
// ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███ ░░██████ ░███░░███ ░░░░░░░░███ ░░███ █████ ███ ░███ ░███ ███ ░███░░█ ░███░░░░░███ ░███ ░███░░░░░███ ░███ ░░██████ ░███ ░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░░█████ ░███ ░░███ ███ ░███ ░░░█████░█████░ ░███ ░███ ████ █ ░███ ░ █ ░███ ░███ ░███ █ ░███ ░███ ░███ ░░█████ ░███ ███
// █████ █████ █████ █████ █████ █████ ███████████ ███████████ █████ █████ █████ ░░█████ █████ ░░████ ░░█████████ ░░███ ░░███ █████ █████ ███████████ ██████████ █████ █████ ███████████ █████ █████ █████ ░░█████ ██████████
// ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░ ░░░░░░░░░ ░░░ ░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░
//
//
// ,ad8888ba, db 88888888ba, 88b d88 ,ad8888ba, ad88888ba
// d8"' `"8b d88b 88 `"8b 888b d888 d8"' `"8b d8" "8b
// d8' d8'`8b 88 `8b 88`8b d8'88 d8' `8b Y8,
// 88 d8' `8b 88 88 88 `8b d8' 88 88 88 `Y8aaaaa,
// 88 d8YaaaaY8b 88 88 88 `8b d8' 88 88 88 `"""""8b,
// Y8, d8""""""""8b 88 8P 88 `8b d8' 88 Y8, ,8P `8b
// Y8a. .a8P d8' `8b 88 .a8P 88 `888' 88 Y8a. .a8P Y8a a8P
// `"Y8888Y"' d8' `8b 88888888Y"' 88 `8' 88 `"Y8888Y"' "Y88888P"
//
// ===============================================================================================
// ================================= IImpactVaultDepositor =====================================
// ===============================================================================================
// ARAB BANK SWITZZERLAND: https://github.com/ArabBankSwitzerland
// CADMOS: https://github.com/Cadmos-finance
// Primary Author(s)
// N.B.: https://github.com/nboueri
// J.A.T: https://github.com/jat9292
/// @title Interface of the ImpactVaultDepositor Contract
/// @author N.B.
/// @notice Abstract Intermediate contract to deposit non native asset in an Impact Vault
interface IImpactVaultDepositor {
/* ========== VIEWS ========== */
/// @notice address of the ImpactVault associated to the ImpactVaultDepositor
function ImpactVault() external view returns (address);
/// @notice address of the positively rebasing asset associated to the ImpactVault
function asset() external view returns (address);
/* ========== MUTATIVE FUNCTIONS ========== */
/// @notice Deposit amount of asset into the ImpactVault
/// @dev redundant with ImpactVault deposit method - used to offer a single entry point
/// @param depositAmount Amount of Asset to Deposit
function depositAsset(
uint256 depositAmount
) external returns (uint256 sharesCreated);
/// @notice Convert amount of token into asset and deposits depositProportion (in wad) of it into the ImpactVault. Remainder is sent back to msg.sender
/// @param amount Amount of token considered
/// @param token address of the token to convert-and-deposit
/// @param depositProportion Proportion of obtained asset to deposit into the impact vault (in wad). Remainder is sent back to msg.sender
function depositToken(
uint256 amount,
address token,
uint256 depositProportion
) external returns (uint256 sharesCreated, uint256 assetReturned);
/// @notice Convert amount of ETH into asset and deposits depositProportion (in wad) of it into the ImpactVault. Remainder is sent back to msg.sender
/// @param depositProportion Proportion of obatined asset to deposit into the impact vault (in wad). Remainder is sent back to msg.sender
function depositETH(
uint256 depositProportion
) external payable returns (uint256 sharesCreated, uint256 assetReturned);
/// @notice On standard receive() converts and deposits all received ETH
receive() external payable;
}
// File src/ImpactVaultDepositor.sol
// Original license: SPDX_License_Identifier: MIT
pragma solidity 0.8.19;
// █████████ ███████████ █████████ ███████████ ███████████ █████████ ██████ █████ █████ ████ █████████ █████ ███ █████ █████ ███████████ ███████████ ██████████ ███████████ █████ █████████ ██████ █████ ██████████
// ███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░██████ ░░███ ░░███ ███░ ███░░░░░███░░███ ░███ ░░███ ░░███ ░█░░░███░░░█░█░░░░░░███ ░░███░░░░░█░░███░░░░░███ ░░███ ███░░░░░███ ░░██████ ░░███ ░░███░░░░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ███ ░███ ░░░ ░███ ░███ ░███ ░███ ░ ░███ ░ ░ ███░ ░███ █ ░ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ░░███
// ░███████████ ░██████████ ░███████████ ░██████████ ░██████████ ░███████████ ░███░░███░███ ░███████ ░░█████████ ░███ ░███ ░███ ░███ ░███ ███ ░██████ ░██████████ ░███ ░███████████ ░███░░███░███ ░███ ░███
// ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███ ░░██████ ░███░░███ ░░░░░░░░███ ░░███ █████ ███ ░███ ░███ ███ ░███░░█ ░███░░░░░███ ░███ ░███░░░░░███ ░███ ░░██████ ░███ ░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░░█████ ░███ ░░███ ███ ░███ ░░░█████░█████░ ░███ ░███ ████ █ ░███ ░ █ ░███ ░███ ░███ █ ░███ ░███ ░███ ░░█████ ░███ ███
// █████ █████ █████ █████ █████ █████ ███████████ ███████████ █████ █████ █████ ░░█████ █████ ░░████ ░░█████████ ░░███ ░░███ █████ █████ ███████████ ██████████ █████ █████ ███████████ █████ █████ █████ ░░█████ ██████████
// ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░ ░░░░░░░░░ ░░░ ░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░
//
//
// ,ad8888ba, db 88888888ba, 88b d88 ,ad8888ba, ad88888ba
// d8"' `"8b d88b 88 `"8b 888b d888 d8"' `"8b d8" "8b
// d8' d8'`8b 88 `8b 88`8b d8'88 d8' `8b Y8,
// 88 d8' `8b 88 88 88 `8b d8' 88 88 88 `Y8aaaaa,
// 88 d8YaaaaY8b 88 88 88 `8b d8' 88 88 88 `"""""8b,
// Y8, d8""""""""8b 88 8P 88 `8b d8' 88 Y8, ,8P `8b
// Y8a. .a8P d8' `8b 88 .a8P 88 `888' 88 Y8a. .a8P Y8a a8P
// `"Y8888Y"' d8' `8b 88888888Y"' 88 `8' 88 `"Y8888Y"' "Y88888P"
//
// ===============================================================================================
// ================================== ImpactVaultDepositor =====================================
// ===============================================================================================
// ARAB BANK SWITZZERLAND: https://github.com/ArabBankSwitzerland
// CADMOS: https://github.com/Cadmos-finance
// Primary Author(s)
// N.B.: https://github.com/nboueri
// J.A.T: https://github.com/jat9292
/// @title ImpactVaultDepositor
/// @author N.B.
/// @notice Abstract Intermediate contract to deposit non native asset in an Impact Vault
abstract contract ImpactVaultDepositor is IImpactVaultDepositor {
using SafeERC20 for IERC20;
address public immutable override(IImpactVaultDepositor) ImpactVault;
address public immutable override(IImpactVaultDepositor) asset;
uint256 private constant wad = 1e18;
uint256 private constant maxUint = type(uint256).max;
/* ========== CONSTRUCTOR ========== */
constructor(address ImpactVault_) {
ImpactVault = ImpactVault_;
address asset_ = IERC4626(ImpactVault_).asset();
asset = asset_;
IERC20(asset_).approve(ImpactVault_, maxUint);
}
/* ========== INTERNAL FUNCTIONS ========== */
function _deposit(
uint256 depositAmount
) internal returns (uint256 sharesCreated) {
sharesCreated = IERC4626(ImpactVault).deposit(
depositAmount,
msg.sender
);
}
function _convertToken(
uint256 amount,
address token
) internal virtual returns (uint256 assetAmount);
function _convertETH() internal virtual returns (uint256 assetAmount);
/* ========== MUTATIVE FUNCTIONS ========== */
/// @notice Deposit amount of asset into the ImpactVault
/// @dev redundant with ImpactVault deposit method - used to offer a single entry point
/// @param depositAmount Amount of Asset to Deposit
function depositAsset(
uint256 depositAmount
) external override(IImpactVaultDepositor) returns (uint256 sharesCreated) {
IERC20(asset).safeTransferFrom(
msg.sender,
address(this),
depositAmount
);
sharesCreated = _deposit(depositAmount);
}
/// @notice Convert amount of token into asset and deposits depositProportion (in wad) of it into the ImpactVault. Remainder is sent back to msg.sender
/// @param amount Amount of token considered
/// @param token address of the token to convert-and-deposit
/// @param depositProportion Proportion of obtained asset to deposit into the impact vault (in wad). Remainder is sent back to msg.sender
function depositToken(
uint256 amount,
address token,
uint256 depositProportion
)
external
override(IImpactVaultDepositor)
returns (uint256 sharesCreated, uint256 assetReturned)
{
uint256 assetAmount = _convertToken(amount, token);
uint256 toDeposit = (depositProportion * assetAmount) / wad;
sharesCreated = _deposit(toDeposit);
assetReturned = assetAmount - toDeposit;
IERC20(asset).safeTransfer(msg.sender, assetReturned);
}
/// @notice Convert amount of ETH into asset and deposits depositProportion (in wad) of it into the ImpactVault. Remainder is sent back to msg.sender
/// @param depositProportion Proportion of obtained asset to deposit into the impact vault (in wad). Remainder is sent back to msg.sender
function depositETH(
uint256 depositProportion
)
public
payable
override(IImpactVaultDepositor)
returns (uint256 sharesCreated, uint256 assetReturned)
{
uint256 assetAmount = _convertETH();
uint256 toDeposit = (depositProportion * assetAmount) / wad;
sharesCreated = _deposit(toDeposit);
assetReturned = assetAmount - toDeposit;
IERC20(asset).safeTransfer(msg.sender, assetReturned);
}
/// @notice On standard receive() converts and deposits all received ETH
receive() external payable override(IImpactVaultDepositor) {
depositETH(wad);
}
}
// File src/LidoImpactVaultDepositor.sol
// Original license: SPDX_License_Identifier: MIT
pragma solidity 0.8.19;
// █████████ ███████████ █████████ ███████████ ███████████ █████████ ██████ █████ █████ ████ █████████ █████ ███ █████ █████ ███████████ ███████████ ██████████ ███████████ █████ █████████ ██████ █████ ██████████
// ███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░███░░░░░███ ░░███░░░░░███ ███░░░░░███ ░░██████ ░░███ ░░███ ███░ ███░░░░░███░░███ ░███ ░░███ ░░███ ░█░░░███░░░█░█░░░░░░███ ░░███░░░░░█░░███░░░░░███ ░░███ ███░░░░░███ ░░██████ ░░███ ░░███░░░░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ███ ░███ ░░░ ░███ ░███ ░███ ░███ ░ ░███ ░ ░ ███░ ░███ █ ░ ░███ ░███ ░███ ░███ ░███ ░███░███ ░███ ░███ ░░███
// ░███████████ ░██████████ ░███████████ ░██████████ ░██████████ ░███████████ ░███░░███░███ ░███████ ░░█████████ ░███ ░███ ░███ ░███ ░███ ███ ░██████ ░██████████ ░███ ░███████████ ░███░░███░███ ░███ ░███
// ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███░░░░░███ ░███ ░░██████ ░███░░███ ░░░░░░░░███ ░░███ █████ ███ ░███ ░███ ███ ░███░░█ ░███░░░░░███ ░███ ░███░░░░░███ ░███ ░░██████ ░███ ░███
// ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░░█████ ░███ ░░███ ███ ░███ ░░░█████░█████░ ░███ ░███ ████ █ ░███ ░ █ ░███ ░███ ░███ █ ░███ ░███ ░███ ░░█████ ░███ ███
// █████ █████ █████ █████ █████ █████ ███████████ ███████████ █████ █████ █████ ░░█████ █████ ░░████ ░░█████████ ░░███ ░░███ █████ █████ ███████████ ██████████ █████ █████ ███████████ █████ █████ █████ ░░█████ ██████████
// ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░ ░░░░░░░░░ ░░░ ░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░░░░░
//
//
// ,ad8888ba, db 88888888ba, 88b d88 ,ad8888ba, ad88888ba
// d8"' `"8b d88b 88 `"8b 888b d888 d8"' `"8b d8" "8b
// d8' d8'`8b 88 `8b 88`8b d8'88 d8' `8b Y8,
// 88 d8' `8b 88 88 88 `8b d8' 88 88 88 `Y8aaaaa,
// 88 d8YaaaaY8b 88 88 88 `8b d8' 88 88 88 `"""""8b,
// Y8, d8""""""""8b 88 8P 88 `8b d8' 88 Y8, ,8P `8b
// Y8a. .a8P d8' `8b 88 .a8P 88 `888' 88 Y8a. .a8P Y8a a8P
// `"Y8888Y"' d8' `8b 88888888Y"' 88 `8' 88 `"Y8888Y"' "Y88888P"
//
// ===============================================================================================
// ================================ LidoImpactVaultDepositor ===================================
// ===============================================================================================
// ARAB BANK SWITZZERLAND: https://github.com/ArabBankSwitzerland
// CADMOS: https://github.com/Cadmos-finance
// Primary Author(s)
// N.B.: https://github.com/nboueri
// J.A.T: https://github.com/jat9292
interface Lido {
function submit(
address referral
) external payable returns (uint256 assetAmount);
}
/// @title LidoImpactVaultDepositor
/// @author N.B.
/// @notice ImpactVaultDepositor for the Lido Impact Vault
contract LidoImpactVaultDepositor is ImpactVaultDepositor {
address private immutable _lidoReferral; //Referral parameter to pass to Lido when depositing ETH
error NotImplementedError();
/* ========== CONSTRUCTOR ========== */
constructor(
address lidoReferral_,
address impactVault_
) ImpactVaultDepositor(impactVault_) {
_lidoReferral = lidoReferral_;
}
/* ========== INTERNAL FUNCTIONS ========== */
/// @dev Only supported deposit are ETH and STETH
function _convertToken(
uint256,
address
) internal pure override(ImpactVaultDepositor) returns (uint256) {
revert NotImplementedError();
}
/// @dev deposits ETH within Lido to obtain STETH
function _convertETH()
internal
override(ImpactVaultDepositor)
returns (uint256 assetAmount)
{
Lido(asset).submit{value: msg.value}(_lidoReferral);
assetAmount = IERC20(asset).balanceOf(address(this));
}
}
{
"compilationTarget": {
"LidoImpactVaultDepositor.sol": "LidoImpactVaultDepositor"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 1000
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"lidoReferral_","type":"address"},{"internalType":"address","name":"impactVault_","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"NotImplementedError","type":"error"},{"inputs":[],"name":"ImpactVault","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"asset","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"depositAmount","type":"uint256"}],"name":"depositAsset","outputs":[{"internalType":"uint256","name":"sharesCreated","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"depositProportion","type":"uint256"}],"name":"depositETH","outputs":[{"internalType":"uint256","name":"sharesCreated","type":"uint256"},{"internalType":"uint256","name":"assetReturned","type":"uint256"}],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"depositProportion","type":"uint256"}],"name":"depositToken","outputs":[{"internalType":"uint256","name":"sharesCreated","type":"uint256"},{"internalType":"uint256","name":"assetReturned","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"stateMutability":"payable","type":"receive"}]