-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add ERC7540 and ERC7575 interfaces (#644)
This adds the interfaces for the 2 finalized extensions to ERC4626, [ERC7540](https://eips.ethereum.org/EIPS/eip-7540) and [ERC7575](https://eips.ethereum.org/EIPS/eip-7575). See https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/#introduction for details on these extensions. Adding these would be helpful for repositories that rely on the interfaces in `forge-std`. ERC7540 interfaces are split by async deposit, async redeem, and fully async vaults, per the ERC specification. This also ensures the ERC-165 ID matches for each vault type. The ERC7575 interface specifies all ERC4626 methods, rather than extending `IERC4626.sol`, because: 1. ERC20 methods need to be excluded for ERC7575. 2. This ensures `IERC7575.interfaceId` is the expected ID as specified in https://eips.ethereum.org/EIPS/eip-7575#erc-165-support, since `.interfaceID` does not account for inherited interfaces.
- Loading branch information
Showing
2 changed files
with
391 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
// SPDX-License-Identifier: MIT | ||
pragma solidity >=0.6.2; | ||
|
||
import "./IERC7575.sol"; | ||
|
||
/// @dev Interface of the base operator logic of ERC7540, as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7540 | ||
interface IERC7540Operator { | ||
/** | ||
* @dev The event emitted when an operator is set. | ||
* | ||
* @param controller The address of the controller. | ||
* @param operator The address of the operator. | ||
* @param approved The approval status. | ||
*/ | ||
event OperatorSet(address indexed controller, address indexed operator, bool approved); | ||
|
||
/** | ||
* @dev Sets or removes an operator for the caller. | ||
* | ||
* @param operator The address of the operator. | ||
* @param approved The approval status. | ||
* @return Whether the call was executed successfully or not | ||
*/ | ||
function setOperator(address operator, bool approved) external returns (bool); | ||
|
||
/** | ||
* @dev Returns `true` if the `operator` is approved as an operator for an `controller`. | ||
* | ||
* @param controller The address of the controller. | ||
* @param operator The address of the operator. | ||
* @return status The approval status | ||
*/ | ||
function isOperator(address controller, address operator) external view returns (bool status); | ||
} | ||
|
||
/// @dev Interface of the asynchronous deposit Vault interface of ERC7540, as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7540 | ||
interface IERC7540Deposit is IERC7540Operator { | ||
event DepositRequest( | ||
address indexed controller, address indexed owner, uint256 indexed requestId, address sender, uint256 assets | ||
); | ||
/** | ||
* @dev Transfers assets from sender into the Vault and submits a Request for asynchronous deposit. | ||
* | ||
* - MUST support ERC-20 approve / transferFrom on asset as a deposit Request flow. | ||
* - MUST revert if all of assets cannot be requested for deposit. | ||
* - owner MUST be msg.sender unless some unspecified explicit approval is given by the caller, | ||
* approval of ERC-20 tokens from owner to sender is NOT enough. | ||
* | ||
* @param assets the amount of deposit assets to transfer from owner | ||
* @param controller the controller of the request who will be able to operate the request | ||
* @param owner the source of the deposit assets | ||
* | ||
* NOTE: most implementations will require pre-approval of the Vault with the Vault's underlying asset token. | ||
*/ | ||
|
||
function requestDeposit(uint256 assets, address controller, address owner) external returns (uint256 requestId); | ||
|
||
/** | ||
* @dev Returns the amount of requested assets in Pending state. | ||
* | ||
* - MUST NOT include any assets in Claimable state for deposit or mint. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT revert unless due to integer overflow caused by an unreasonably large input. | ||
*/ | ||
function pendingDepositRequest(uint256 requestId, address controller) | ||
external | ||
view | ||
returns (uint256 pendingAssets); | ||
|
||
/** | ||
* @dev Returns the amount of requested assets in Claimable state for the controller to deposit or mint. | ||
* | ||
* - MUST NOT include any assets in Pending state. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT revert unless due to integer overflow caused by an unreasonably large input. | ||
*/ | ||
function claimableDepositRequest(uint256 requestId, address controller) | ||
external | ||
view | ||
returns (uint256 claimableAssets); | ||
|
||
/** | ||
* @dev Mints shares Vault shares to receiver by claiming the Request of the controller. | ||
* | ||
* - MUST emit the Deposit event. | ||
* - controller MUST equal msg.sender unless the controller has approved the msg.sender as an operator. | ||
*/ | ||
function deposit(uint256 assets, address receiver, address controller) external returns (uint256 shares); | ||
|
||
/** | ||
* @dev Mints exactly shares Vault shares to receiver by claiming the Request of the controller. | ||
* | ||
* - MUST emit the Deposit event. | ||
* - controller MUST equal msg.sender unless the controller has approved the msg.sender as an operator. | ||
*/ | ||
function mint(uint256 shares, address receiver, address controller) external returns (uint256 assets); | ||
} | ||
|
||
/// @dev Interface of the asynchronous deposit Vault interface of ERC7540, as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7540 | ||
interface IERC7540Redeem is IERC7540Operator { | ||
event RedeemRequest( | ||
address indexed controller, address indexed owner, uint256 indexed requestId, address sender, uint256 assets | ||
); | ||
|
||
/** | ||
* @dev Assumes control of shares from sender into the Vault and submits a Request for asynchronous redeem. | ||
* | ||
* - MUST support a redeem Request flow where the control of shares is taken from sender directly | ||
* where msg.sender has ERC-20 approval over the shares of owner. | ||
* - MUST revert if all of shares cannot be requested for redeem. | ||
* | ||
* @param shares the amount of shares to be redeemed to transfer from owner | ||
* @param controller the controller of the request who will be able to operate the request | ||
* @param owner the source of the shares to be redeemed | ||
* | ||
* NOTE: most implementations will require pre-approval of the Vault with the Vault's share token. | ||
*/ | ||
function requestRedeem(uint256 shares, address controller, address owner) external returns (uint256 requestId); | ||
|
||
/** | ||
* @dev Returns the amount of requested shares in Pending state. | ||
* | ||
* - MUST NOT include any shares in Claimable state for redeem or withdraw. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT revert unless due to integer overflow caused by an unreasonably large input. | ||
*/ | ||
function pendingRedeemRequest(uint256 requestId, address controller) | ||
external | ||
view | ||
returns (uint256 pendingShares); | ||
|
||
/** | ||
* @dev Returns the amount of requested shares in Claimable state for the controller to redeem or withdraw. | ||
* | ||
* - MUST NOT include any shares in Pending state for redeem or withdraw. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT revert unless due to integer overflow caused by an unreasonably large input. | ||
*/ | ||
function claimableRedeemRequest(uint256 requestId, address controller) | ||
external | ||
view | ||
returns (uint256 claimableShares); | ||
} | ||
|
||
/// @dev Interface of the fully asynchronous Vault interface of ERC7540, as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7540 | ||
interface IERC7540 is IERC7540Deposit, IERC7540Redeem, IERC7575 {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,241 @@ | ||
// SPDX-License-Identifier: MIT | ||
pragma solidity >=0.6.2; | ||
|
||
import "./IERC165.sol"; | ||
|
||
/// @dev Interface of the ERC7575 "Multi-Asset ERC-4626 Vaults", as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7575 | ||
interface IERC7575 is IERC165 { | ||
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 address of the share token | ||
* | ||
* - MUST be an ERC-20 token contract. | ||
* - MUST NOT revert. | ||
*/ | ||
function share() external view returns (address shareTokenAddress); | ||
|
||
/** | ||
* @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 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 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); | ||
} | ||
|
||
/// @dev Interface of the ERC20 share token, as defined in | ||
/// https://eips.ethereum.org/EIPS/eip-7575 | ||
interface IERC7575Share is IERC165 { | ||
event VaultUpdate(address indexed asset, address vault); | ||
|
||
/** | ||
* @dev Returns the address of the Vault for the given asset. | ||
* | ||
* @param asset the ERC-20 token to deposit with into the Vault | ||
*/ | ||
function vault(address asset) external view returns (address); | ||
} |