Interfaces

Should return whether the signature provided is valid for the provided data

Moves a value amount of tokens from the caller's account to to and then calls IERC1363Receiver.onTransferReceived on to.

Moves a value amount of tokens from the caller's account to to and then calls IERC1363Receiver.onTransferReceived on to.

Moves a value amount of tokens from from to to using the allowance mechanism and then calls IERC1363Receiver.onTransferReceived on to.

Moves a value amount of tokens from from to to using the allowance mechanism and then calls IERC1363Receiver.onTransferReceived on to.

Sets a value amount of tokens as the allowance of spender over the caller's tokens and then calls IERC1363Spender.onApprovalReceived on spender.

Sets a value amount of tokens as the allowance of spender over the caller's tokens and then calls IERC1363Spender.onApprovalReceived on spender.

Whenever ERC-1363 tokens are transferred to this contract via transferAndCall or transferFromAndCall by operator from from, this function is called.

NOTE: To accept the transfer, this must return bytes4(keccak256("onTransferReceived(address,address,uint256,bytes)")) (i.e. 0x88a7ca5c, or its own function selector).

Whenever an ERC-1363 token owner approves this contract via approveAndCall to spend their tokens, this function is called.

NOTE: To accept the approval, this must return bytes4(keccak256("onApprovalReceived(address,uint256,bytes)")) (i.e. 0x7b04a2d0, or its own function selector).

Returns a special value (ERC1820_ACCEPT_MAGIC) if this contract implements interfaceHash for account.

See IERC1820Registry.setInterfaceImplementer.

Sets newManager as the manager for account. A manager of an account is able to set interface implementers for it.

By default, each account is its own manager. Passing a value of 0x0 in newManager will reset the manager to this initial state.

Emits a IERC1820Registry.ManagerChanged event.

Requirements:

• the caller must be the current manager for account.

Returns the manager for account.

See IERC1820Registry.setManager.

Sets the implementer contract as account's implementer for interfaceHash.

account being the zero address is an alias for the caller's address. The zero address can also be used in implementer to remove an old one.

See IERC1820Registry.interfaceHash to learn how these are created.

Emits an IERC1820Registry.InterfaceImplementerSet event.

Requirements:

• the caller must be the current manager for account.
• interfaceHash must not be an IERC165 interface id (i.e. it must not end in 28 zeroes).
• implementer must implement IERC1820Implementer and return true when queried for support, unless implementer is the caller. See IERC1820Implementer.canImplementInterfaceForAddress.

Returns the implementer of interfaceHash for account. If no such implementer is registered, returns the zero address.

If interfaceHash is an IERC165 interface id (i.e. it ends with 28 zeroes), account will be queried for support of it.

account being the zero address is an alias for the caller's address.

Returns the interface hash for an interfaceName, as defined in the corresponding section of the ERC.

Emitted when the implementation is upgraded.

Emitted when the admin account has changed.

Emitted when the beacon is changed.

Emitted when the tokens from fromTokenId to toTokenId are transferred from fromAddress to toAddress.

Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of exchange. The royalty amount is denominated and should be paid in that same unit of exchange.

NOTE: ERC-2981 allows setting the royalty to 100% of the price. In that case all the price would be sent to the royalty receiver and 0 tokens to the seller. Contracts dealing with royalty should consider empty transfers.

Receive a flash loan.

The amount of currency available to be lended.

The fee to be charged for a given loan.

Initiate a flash loan.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Allows an on-chain or off-chain user to simulate the effects of their redemption 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.

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.

This event emits when the metadata of a token is changed. So that the third-party platforms such as NFT market could timely update the images and related attributes of the NFT.

This event emits when the metadata of a range of tokens is changed. So that the third-party platforms such as NFT market could timely update the images and related attributes of the NFTs.

returns the fields and values that describe the domain separator used by this contract for EIP-712 signature.

MAY be emitted to signal that the domain could have changed.

Gets the address of the owner.

Clock used for flagging checkpoints. Can be overridden to implement timestamp based checkpoints (and voting).

Description of the clock

Returns the name of the token.

Returns the symbol of the token, usually a shorter version of the name.

Returns the smallest part of the token that is not divisible. This means all token operations (creation, movement and destruction) must have amounts that are a multiple of this number.

For most token contracts, this value will equal 1.

Returns the amount of tokens in existence.

Returns the amount of tokens owned by an account (owner).

Moves amount tokens from the caller's account to recipient.

If send or receive hooks are registered for the caller and recipient, the corresponding functions will be called with data and empty operatorData. See IERC777Sender and IERC777Recipient.

Emits a IERC777.Sent event.

Requirements

• the caller must have at least amount tokens.
• recipient cannot be the zero address.
• if recipient is a contract, it must implement the IERC777Recipient interface.

Destroys amount tokens from the caller's account, reducing the total supply.

If a send hook is registered for the caller, the corresponding function will be called with data and empty operatorData. See IERC777Sender.

Emits a IERC777.Burned event.

Requirements

• the caller must have at least amount tokens.

Returns true if an account is an operator of tokenHolder. Operators can send and burn tokens on behalf of their owners. All accounts are their own operator.

See IERC777.operatorSend and IERC777.operatorBurn.

Make an account an operator of the caller.

See IERC777.isOperatorFor.

Emits an IERC777.AuthorizedOperator event.

Requirements

• operator cannot be calling address.

Revoke an account's operator status for the caller.

See IERC777.isOperatorFor and IERC777.defaultOperators.

Emits a IERC777.RevokedOperator event.

Requirements

• operator cannot be calling address.

Returns the list of default operators. These accounts are operators for all token holders, even if IERC777.authorizeOperator was never called on them.

This list is immutable, but individual holders may revoke these via IERC777.revokeOperator, in which case IERC777.isOperatorFor will return false.

Moves amount tokens from sender to recipient. The caller must be an operator of sender.

If send or receive hooks are registered for sender and recipient, the corresponding functions will be called with data and operatorData. See IERC777Sender and IERC777Recipient.

Emits a IERC777.Sent event.

Requirements

• sender cannot be the zero address.
• sender must have at least amount tokens.
• the caller must be an operator for sender.
• recipient cannot be the zero address.
• if recipient is a contract, it must implement the IERC777Recipient interface.

Destroys amount tokens from account, reducing the total supply. The caller must be an operator of account.

If a send hook is registered for account, the corresponding function will be called with data and operatorData. See IERC777Sender.

Emits a IERC777.Burned event.

Requirements

• account cannot be the zero address.
• account must have at least amount tokens.
• the caller must be an operator for account.

Emitted when amount tokens are created by operator and assigned to to.

Note that some additional user data and operatorData can be logged in the event.

Emitted when operator destroys amount tokens from account.

Note that some additional user data and operatorData can be logged in the event.

Emitted when operator is made operator for tokenHolder.

Emitted when operator is revoked its operator status for tokenHolder.

Called by an IERC777 token contract whenever tokens are being moved or created into a registered account (to). The type of operation is conveyed by from being the zero address or not.

This call occurs after the token contract's state is updated, so IERC777.balanceOf, etc., can be used to query the post-operation state.

This function may revert to prevent the operation from being executed.

Called by an IERC777 token contract whenever a registered holder's (from) tokens are about to be moved or destroyed. The type of operation is conveyed by to being the zero address or not.

This call occurs before the token contract's state is updated, so IERC777.balanceOf, etc., can be used to query the pre-operation state.

This function may revert to prevent the operation from being executed.

Verifies signature as a valid signature of hash by key.

MUST return the bytes4 magic value IERC7913SignatureVerifier.verify.selector if the signature is valid. SHOULD return 0xffffffff or revert if the signature is not valid. SHOULD return 0xffffffff or revert if the key is empty

Returns the storage slot that the proxiable contract assumes is being used to store the implementation address.

bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this function revert if invoked through a proxy.

Validates the signature for a user operation. Returns an alternative signature that should be used during bundling.

Returns an aggregated signature for a batch of user operation's signatures.

Validates that the aggregated signature is valid for the user operations.

Requirements:

• The aggregated signature MUST match the given list of operations.

Returns the nonce for a sender account and a key.

Nonces for a certain key are always increasing.

Returns the balance of the account.

Deposits msg.value to the account.

Withdraws withdrawAmount from the account to withdrawAddress.

Adds stake to the account with an unstake delay of unstakeDelaySec.

Unlocks the stake of the account.

Withdraws the stake of the account to withdrawAddress.

Executes a batch of user operations.

Executes a batch of aggregated user operations per aggregator.

A user operation at opIndex failed with reason.

A user operation at opIndex failed with reason and inner returned data.

Validates a user operation.

• MUST validate the caller is a trusted EntryPoint
• MUST validate that the signature is a valid signature of the userOpHash, and SHOULD return SIG_VALIDATION_FAILED (and not revert) on signature mismatch. Any other error MUST revert.
• MUST pay the entryPoint (caller) at least the “missingAccountFunds” (which might be zero, in case the current account’s deposit is high enough)

Returns an encoded packed validation data that is composed of the following elements:

• authorizer (address): 0 for success, 1 for failure, otherwise the address of an authorizer contract
• validUntil (uint48): The UserOp is valid only up to this time. Zero for “infinite”.
• validAfter (uint48): The UserOp is valid only after this time.

Executes a user operation.

Validates whether the paymaster is willing to pay for the user operation. See IAccount.validateUserOp for additional information on the return value.

NOTE: Bundlers will reject this method if it modifies the state, unless it's whitelisted.

Verifies the sender is the entrypoint.

Indicates an error related to the current balance of a sender. Used in transfers.

Indicates a failure with the token sender. Used in transfers.

Indicates a failure with the token receiver. Used in transfers.

Indicates a failure with the spender’s allowance. Used in transfers.

Indicates a failure with the approver of a token to be approved. Used in approvals.

Indicates a failure with the spender to be approved. Used in approvals.

Indicates that an address can't be an owner. For example, address(0) is a forbidden owner in ERC-20. Used in balance queries.

Indicates a tokenId whose owner is the zero address.

Indicates an error related to the ownership over a particular token. Used in transfers.

Indicates a failure with the token sender. Used in transfers.

Indicates a failure with the token receiver. Used in transfers.

Indicates a failure with the operator’s approval. Used in transfers.

Indicates a failure with the approver of a token to be approved. Used in approvals.

Indicates a failure with the operator to be approved. Used in approvals.

Indicates an error related to the current balance of a sender. Used in transfers.

Indicates a failure with the token sender. Used in transfers.

Indicates a failure with the token receiver. Used in transfers.

Indicates a failure with the operator’s approval. Used in transfers.

Indicates a failure with the approver of a token to be approved. Used in approvals.

Indicates a failure with the operator to be approved. Used in approvals.

Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation. Used in batch transfers.

Returns the amount of tokens of type id owned by owner.

Returns the amount of tokens of type id that spender is allowed to spend on behalf of owner.

NOTE: Does not include operator allowances.

Returns true if spender is set as an operator for owner.

Sets an approval to spender for amount of tokens of type id from the caller's tokens. An amount of type(uint256).max signifies an unlimited approval.

Must return true.

Grants or revokes unlimited transfer permission of any token id to spender for the caller's tokens.

Must return true.

Transfers amount of token type id from the caller's account to receiver.

Must return true.

Transfers amount of token type id from sender to receiver.

Must return true.

Emitted when the allowance of a spender for an owner is set for a token of type id. The new allowance is amount.

Emitted when owner grants or revokes operator status for a spender.

Emitted when amount tokens of type id are moved from sender to receiver initiated by caller.

Returns the name of the token of type id.

Returns the ticker symbol of the token of type id.

Returns the number of decimals for the token of type id.

Returns URI for the contract.

Returns the URI for the token of type id.

Returns the total supply of the token of type id.

This function is called by the smart account during installation of the module

This function is called by the smart account during uninstallation of the module

Returns boolean value if module is a certain type

Validates a UserOperation

Validates a signature using ERC-1271

Called by the smart account before execution

Called by the smart account after execution

Executes a transaction on behalf of the account.

Executes a transaction on behalf of the account. This function is intended to be called by Executor Modules

Returns the account id of the smart account

Function to check if the account supports a certain execution mode (see above)

Function to check if the account supports a certain module typeId

Installs a Module of a certain type on the smart account

Uninstalls a Module of a certain type on the smart account

Returns whether a module is installed on the smart account

Set the temporary allowance, allowing spender to withdraw (within the same transaction) assets held by the caller.

Getter to check whether an attribute is supported or not.

Endpoint for creating a new message. If the message requires further (gateway specific) processing before it can be sent to the destination chain, then a non-zero outboxId must be returned. Otherwise, the message MUST be sent and this function must return 0.

• MUST emit a IERC7786GatewaySource.MessageSent event.

If any of the attributes is not supported, this function SHOULD revert with an IERC7786GatewaySource.UnsupportedAttribute error. Other errors SHOULD revert with errors not specified in ERC-7786.

Event emitted when a message is created. If outboxId is zero, no further processing is necessary. If outboxId is not zero, then further (gateway specific, and non-standardized) action is required.

This error is thrown when a message creation fails because of an unsupported attribute being specified.

Endpoint for receiving cross-chain message.

This function may be called directly by the gateway.

Executes the calls in executionData. Reverts and bubbles up error if any call fails.

executionData encoding:

• If opData is empty, executionData is simply abi.encode(calls).
• Else, executionData is abi.encode(calls, opData). See: https://eips.ethereum.org/EIPS/eip-7579

Supported modes:

• bytes32(0x01000000000000000000...): does not support optional opData.
• bytes32(0x01000000000078210001...): supports optional opData.

Authorization checks:

• If opData is empty, the implementation SHOULD require that msg.sender == address(this).
• If opData is not empty, the implementation SHOULD use the signature encoded in opData to determine if the caller can perform the execution.

opData may be used to store additional data for authentication, paymaster data, gas limits, etc.

For calldata compression efficiency, if a Call.to is address(0), it will be replaced with address(this).

This function is provided for frontends to detect support. Only returns true for:

• bytes32(0x01000000000000000000...): does not support optional opData.
• bytes32(0x01000000000078210001...): supports optional opData.