Description:
Multi-signature wallet contract requiring multiple confirmations for transaction execution.
Blockchain: Ethereum
Source Code: View Code On The Blockchain
Solidity Source Code:
{{
"language": "Solidity",
"settings": {
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs",
"useLiteralContent": true
},
"optimizer": {
"enabled": true,
"runs": 99999
},
"remappings": [],
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
},
"sources": {
"@openzeppelin/contracts/interfaces/IERC1363.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}
"
},
"@openzeppelin/contracts/interfaces/IERC165.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";
"
},
"@openzeppelin/contracts/interfaces/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";
"
},
"@openzeppelin/contracts/token/ERC20/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
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 value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of 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 value) 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 a `value` amount of tokens 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 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` 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 value) external returns (bool);
}
"
},
"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 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 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @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.encodeCall(token.transfer, (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.encodeCall(token.transferFrom, (from, to, 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.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @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.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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 {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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 silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}
"
},
"@openzeppelin/contracts/utils/Address.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @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.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, bytes memory returndata) = recipient.call{value: amount}("");
if (!success) {
_revert(returndata);
}
}
/**
* @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 or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {Errors.FailedCall} error.
*
* 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.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @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`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
* of an unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {Errors.FailedCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {Errors.FailedCall}.
*/
function _revert(bytes memory returndata) 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
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}
"
},
"@openzeppelin/contracts/utils/Context.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
"
},
"@openzeppelin/contracts/utils/Errors.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}
"
},
"@openzeppelin/contracts/utils/StorageSlot.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.20;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC-1967 implementation slot:
* ```solidity
* contract ERC1967 {
* // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(newImplementation.code.length > 0);
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* TIP: Consider using this library along with {SlotDerivation}.
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct Int256Slot {
int256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `Int256Slot` with member `value` located at `slot`.
*/
function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns a `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
/**
* @dev Returns a `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
assembly ("memory-safe") {
r.slot := store.slot
}
}
}
"
},
"@openzeppelin/contracts/utils/introspection/IERC165.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
"
},
"contracts/CommonErrors.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Thrown when trying to transfer tokens without calldata to the contract.
error EtherReceptionDisabled();
/// @notice Thrown when the multiple related arrays have different lengths.
error InconsistentArrayLengths();
/// @notice Thrown when an ETH transfer has failed.
error TransferFailed();
"
},
"contracts/access/ContractOwnership.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {ContractOwnershipStorage} from "./libraries/ContractOwnershipStorage.sol";
import {ContractOwnershipBase} from "./base/ContractOwnershipBase.sol";
import {InterfaceDetection} from "./../introspection/InterfaceDetection.sol";
/// @title ERC173 Contract Ownership Standard (immutable version).
/// @dev See https://eips.ethereum.org/EIPS/eip-173
/// @dev This contract is to be used via inheritance in an immutable (non-proxied) implementation.
abstract contract ContractOwnership is ContractOwnershipBase, InterfaceDetection {
using ContractOwnershipStorage for ContractOwnershipStorage.Layout;
/// @notice Initializes the storage with an initial contract owner.
/// @notice Marks the following ERC165 interface(s) as supported: ERC173.
/// @dev Emits an {OwnershipTransferred} if `initialOwner` is not the zero address.
/// @param initialOwner the initial contract owner.
constructor(address initialOwner) {
ContractOwnershipStorage.layout().constructorInit(initialOwner);
}
}
"
},
"contracts/access/base/ContractOwnershipBase.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IERC173} from "./../interfaces/IERC173.sol";
import {ContractOwnershipStorage} from "./../libraries/ContractOwnershipStorage.sol";
import {Context} from "@openzeppelin/contracts/utils/Context.sol";
/// @title ERC173 Contract Ownership Standard (proxiable version).
/// @dev See https://eips.ethereum.org/EIPS/eip-173
/// @dev This contract is to be used via inheritance in a proxied implementation.
/// @dev Note: This contract requires ERC165 (Interface Detection Standard).
abstract contract ContractOwnershipBase is IERC173, Context {
using ContractOwnershipStorage for ContractOwnershipStorage.Layout;
/// @inheritdoc IERC173
function owner() public view virtual returns (address) {
return ContractOwnershipStorage.layout().owner();
}
/// @inheritdoc IERC173
function transferOwnership(address newOwner) public virtual {
ContractOwnershipStorage.layout().transferOwnership(_msgSender(), newOwner);
}
}
"
},
"contracts/access/errors/Common.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Thrown when the target contract is actually not a contract.
/// @param targetContract The contract that was checked
error TargetIsNotAContract(address targetContract);
"
},
"contracts/access/errors/ContractOwnershipErrors.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Thrown when an account is not the contract owner but is required to.
/// @param account The account that was checked.
error NotContractOwner(address account);
/// @notice Thrown when an account is not the pending contract owner but is required to.
/// @param account The account that was checked.
error NotPendingContractOwner(address account);
/// @notice Thrown when an account is not the target contract owner but is required to.
/// @param targetContract The contract that was checked.
/// @param account The account that was checked.
error NotTargetContractOwner(address targetContract, address account);
"
},
"contracts/access/events/ERC173Events.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Emitted when the contract ownership changes.
/// @param previousOwner the previous contract owner.
/// @param newOwner the new contract owner.
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/// @notice Emitted when a new contract owner is pending.
/// @param pendingOwner the address of the new contract owner.
event OwnershipTransferPending(address indexed pendingOwner);
"
},
"contracts/access/interfaces/IERC173.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @title ERC-173 Contract Ownership Standard (functions)
/// @dev See https://eips.ethereum.org/EIPS/eip-173
/// @dev Note: the ERC-165 identifier for this interface is 0x7f5828d0
interface IERC173 {
/// @notice Sets the address of the new contract owner.
/// @dev Reverts if the sender is not the contract owner.
/// @dev Emits an {OwnershipTransferred} event if `newOwner` is different from the current contract owner.
/// @param newOwner The address of the new contract owner. Using the zero address means renouncing ownership.
function transferOwnership(address newOwner) external;
/// @notice Gets the address of the contract owner.
/// @return contractOwner The address of the contract owner.
function owner() external view returns (address contractOwner);
}
"
},
"contracts/access/libraries/ContractOwnershipStorage.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {NotContractOwner, NotTargetContractOwner} from "./../errors/ContractOwnershipErrors.sol";
import {TargetIsNotAContract} from "./../errors/Common.sol";
import {OwnershipTransferred} from "./../events/ERC173Events.sol";
import {IERC173} from "./../interfaces/IERC173.sol";
import {Address} from "./../../utils/libraries/Address.sol";
import {ProxyInitialization} from "./../../proxy/libraries/ProxyInitialization.sol";
import {InterfaceDetectionStorage} from "./../../introspection/libraries/InterfaceDetectionStorage.sol";
library ContractOwnershipStorage {
using Address for address;
using ContractOwnershipStorage for ContractOwnershipStorage.Layout;
using InterfaceDetectionStorage for InterfaceDetectionStorage.Layout;
struct Layout {
address contractOwner;
}
bytes32 internal constant LAYOUT_STORAGE_SLOT = bytes32(uint256(keccak256("animoca.core.access.ContractOwnership.storage")) - 1);
bytes32 internal constant PROXY_INIT_PHASE_SLOT = bytes32(uint256(keccak256("animoca.core.access.ContractOwnership.phase")) - 1);
/// @notice Initializes the storage with an initial contract owner (immutable version).
/// @notice Marks the following ERC165 interface(s) as supported: ERC173.
/// @dev Note: This function should be called ONLY in the constructor of an immutable (non-proxied) contract.
/// @dev Emits an {OwnershipTransferred} if `initialOwner` is not the zero address.
/// @param initialOwner The initial contract owner.
function constructorInit(Layout storage s, address initialOwner) internal {
if (initialOwner != address(0)) {
s.contractOwner = initialOwner;
emit OwnershipTransferred(address(0), initialOwner);
}
InterfaceDetectionStorage.layout().setSupportedInterface(type(IERC173).interfaceId, true);
}
/// @notice Initializes the storage with an initial contract owner (proxied version).
/// @notice Sets the proxy initialization phase to `1`.
/// @notice Marks the following ERC165 interface(s) as supported: ERC173.
/// @dev Note: This function should be called ONLY in the init function of a proxied contract.
/// @dev Reverts with {InitializationPhaseAlreadyReached} if the proxy initialization phase is set to `1` or above.
/// @dev Emits an {OwnershipTransferred} if `initialOwner` is not the zero address.
/// @param initialOwner The initial contract owner.
function proxyInit(Layout storage s, address initialOwner) internal {
ProxyInitialization.setPhase(PROXY_INIT_PHASE_SLOT, 1);
s.constructorInit(initialOwner);
}
/// @notice Sets the address of the new contract owner.
/// @dev Reverts with {NotContractOwner} if `sender` is not the contract owner.
/// @dev Emits an {OwnershipTransferred} event if `newOwner` is different from the current contract owner.
/// @param newOwner The address of the new contract owner. Using the zero address means renouncing ownership.
function transferOwnership(Layout storage s, address sender, address newOwner) internal {
address previousOwner = s.contractOwner;
if (sender != previousOwner) revert NotContractOwner(sender);
if (previousOwner != newOwner) {
s.contractOwner = newOwner;
emit OwnershipTransferred(previousOwner, newOwner);
}
}
/// @notice Gets the address of the contract owner.
/// @return contractOwner The address of the contract owner.
function owner(Layout storage s) internal view returns (address contractOwner) {
return s.contractOwner;
}
/// @notice Checks whether an account is the owner of a target contract.
/// @param targetContract The contract to check.
/// @param account The account to check.
/// @return isTargetContractOwner_ Whether `account` is the owner of `targetContract`.
function isTargetContractOwner(address targetContract, address account) internal view returns (bool isTargetContractOwner_) {
if (!targetContract.hasBytecode()) revert TargetIsNotAContract(targetContract);
return IERC173(targetContract).owner() == account;
}
/// @notice Ensures that an account is the contract owner.
/// @dev Reverts with {NotContractOwner} if `account` is not the contract owner.
/// @param account The account.
function enforceIsContractOwner(Layout storage s, address account) internal view {
if (account != s.contractOwner) revert NotContractOwner(account);
}
/// @notice Enforces that an account is the owner of a target contract.
/// @dev Reverts with {NotTheTargetContractOwner} if the account is not the owner.
/// @param targetContract The contract to check.
/// @param account The account to check.
function enforceIsTargetContractOwner(address targetContract, address account) internal view {
if (!isTargetContractOwner(targetContract, account)) revert NotTargetContractOwner(targetContract, account);
}
function layout() internal pure returns (Layout storage s) {
bytes32 position = LAYOUT_STORAGE_SLOT;
assembly {
s.slot := position
}
}
}
"
},
"contracts/introspection/InterfaceDetection.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IERC165} from "./interfaces/IERC165.sol";
import {InterfaceDetectionStorage} from "./libraries/InterfaceDetectionStorage.sol";
/// @title ERC165 Interface Detection Standard (immutable or proxiable version).
/// @dev This contract is to be used via inheritance in an immutable (non-proxied) or proxied implementation.
abstract contract InterfaceDetection is IERC165 {
using InterfaceDetectionStorage for InterfaceDetectionStorage.Layout;
/// @inheritdoc IERC165
function supportsInterface(bytes4 interfaceId) external view returns (bool) {
return InterfaceDetectionStorage.layout().supportsInterface(interfaceId);
}
}
"
},
"contracts/introspection/errors/InterfaceDetectionErrors.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Thrown when setting the illegal interfaceId 0xffffffff.
error IllegalInterfaceId();
"
},
"contracts/introspection/interfaces/IERC165.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @title ERC165 Interface Detection Standard.
/// @dev See https://eips.ethereum.org/EIPS/eip-165.
/// @dev Note: The ERC-165 identifier for this interface is 0x01ffc9a7.
interface IERC165 {
/// @notice Returns whether this contract implements a given interface.
/// @dev Note: This function call must use less than 30 000 gas.
/// @param interfaceId the interface identifier to test.
/// @return supported True if the interface is supported, false if `interfaceId` is `0xffffffff` or if the interface is not supported.
function supportsInterface(bytes4 interfaceId) external view returns (bool supported);
}
"
},
"contracts/introspection/libraries/InterfaceDetectionStorage.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IllegalInterfaceId} from "./../errors/InterfaceDetectionErrors.sol";
import {IERC165} from "./../interfaces/IERC165.sol";
library InterfaceDetectionStorage {
struct Layout {
mapping(bytes4 => bool) supportedInterfaces;
}
bytes32 internal constant LAYOUT_STORAGE_SLOT = bytes32(uint256(keccak256("animoca.core.introspection.InterfaceDetection.storage")) - 1);
bytes4 internal constant ILLEGAL_INTERFACE_ID = 0xffffffff;
/// @notice Sets or unsets an ERC165 interface.
/// @dev Revertswith {IllegalInterfaceId} if `interfaceId` is `0xffffffff`.
/// @param interfaceId the interface identifier.
/// @param supported True to set the interface, false to unset it.
function setSupportedInterface(Layout storage s, bytes4 interfaceId, bool supported) internal {
if (interfaceId == ILLEGAL_INTERFACE_ID) revert IllegalInterfaceId();
s.supportedInterfaces[interfaceId] = supported;
}
/// @notice Returns whether this contract implements a given interface.
/// @dev Note: This function call must use less than 30 000 gas.
/// @param interfaceId The interface identifier to test.
/// @return supported True if the interface is supported, false if `interfaceId` is `0xffffffff` or if the interface is not supported.
function supportsInterface(Layout storage s, bytes4 interfaceId) internal view returns (bool supported) {
if (interfaceId == ILLEGAL_INTERFACE_ID) {
return false;
}
if (interfaceId == type(IERC165).interfaceId) {
return true;
}
return s.supportedInterfaces[interfaceId];
}
function layout() internal pure returns (Layout storage s) {
bytes32 position = LAYOUT_STORAGE_SLOT;
assembly {
s.slot := position
}
}
}
"
},
"contracts/metatx/ForwarderRegistryContext.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IForwarderRegistry} from "./interfaces/IForwarderRegistry.sol";
import {IERC2771} from "./interfaces/IERC2771.sol";
import {ForwarderRegistryContextBase} from "./base/ForwarderRegistryContextBase.sol";
/// @title Meta-Transactions Forwarder Registry Context (immutable version).
/// @dev This contract is to be used via inheritance in an immutable (non-proxied) implementation.
/// @dev Derived from https://github.com/wighawag/universal-forwarder (MIT licence)
abstract contract ForwarderRegistryContext is ForwarderRegistryContextBase, IERC2771 {
constructor(IForwarderRegistry forwarderRegistry_) ForwarderRegistryContextBase(forwarderRegistry_) {}
function forwarderRegistry() external view returns (IForwarderRegistry) {
return _FORWARDER_REGISTRY;
}
/// @inheritdoc IERC2771
function isTrustedForwarder(address forwarder) external view virtual returns (bool) {
return forwarder == address(_FORWARDER_REGISTRY);
}
}
"
},
"contracts/metatx/base/ForwarderRegistryContextBase.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IForwarderRegistry} from "./../interfaces/IForwarderRegistry.sol";
import {ERC2771Calldata} from "./../libraries/ERC2771Calldata.sol";
/// @title Meta-Transactions Forwarder Registry Context (proxiable version).
/// @dev This contract is to be used via inheritance in a proxied implementation.
/// @dev Derived from https://github.com/wighawag/universal-forwarder (MIT licence)
abstract contract ForwarderRegistryContextBase {
IForwarderRegistry internal immutable _FORWARDER_REGISTRY;
constructor(IForwarderRegistry forwarderRegistry) {
_FORWARDER_REGISTRY = forwarderRegistry;
}
/// @notice Returns the message sender depending on the ForwarderRegistry-based meta-transaction context.
function _msgSender() internal view virtual returns (address) {
// Optimised path in case of an EOA-initiated direct tx to the contract or a call from a contract not complying with EIP-2771
// solhint-disable-next-line avoid-tx-origin
if (msg.sender == tx.origin || msg.data.length < 24) {
return msg.sender;
}
address sender = ERC2771Calldata.msgSender();
// Return the EIP-2771 calldata-appended sender address if the message was forwarded by the ForwarderRegistry or an approved forwarder
if (msg.sender == address(_FORWARDER_REGISTRY) || _FORWARDER_REGISTRY.isApprovedForwarder(sender, msg.sender, address(this))) {
return sender;
}
return msg.sender;
}
/// @notice Returns the message data depending on the ForwarderRegistry-based meta-transaction context.
function _msgData() internal view virtual returns (bytes calldata) {
// Optimised path in case of an EOA-initiated direct tx to the contract or a call from a contract not complying with EIP-2771
// solhint-disable-next-line avoid-tx-origin
if (msg.sender == tx.origin || msg.data.length < 24) {
return msg.data;
}
// Return the EIP-2771 calldata (minus the appended sender) if the message was forwarded by the ForwarderRegistry or an approved forwarder
if (
msg.sender == address(_FORWARDER_REGISTRY) ||
_FORWARDER_REGISTRY.isApprovedForwarder(ERC2771Calldata.msgSender(), msg.sender, address(this))
) {
return ERC2771Calldata.msgData();
}
return msg.data;
}
}
"
},
"contracts/metatx/interfaces/IERC2771.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @title Secure Protocol for Native Meta Transactions.
/// @dev See https://eips.ethereum.org/EIPS/eip-2771
interface IERC2771 {
/// @notice Checks whether a forwarder is trusted.
/// @param forwarder The forwarder to check.
/// @return isTrusted True if `forwarder` is trusted, false if not.
function isTrustedForwarder(address forwarder) external view returns (bool isTrusted);
}
"
},
"contracts/metatx/interfaces/IForwarderRegistry.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @title Meta-Transactions Forwarder Registry.
interface IForwarderRegistry {
/// @notice Checks whether an account is as an approved meta-transaction forwarder for a sender account to a target contract.
/// @param sender The sender account.
/// @param forwarder The forwarder account.
/// @param target The target contract.
/// @return isApproved True if `forwarder` is an approved meta-transaction forwarder for `sender` to `target`, false otherwise.
function isApprovedForwarder(address sender, address forwarder, address target) external view returns (bool isApproved);
}
"
},
"contracts/metatx/libraries/ERC2771Calldata.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @dev Derived from https://github.com/OpenZeppelin/openzeppelin-contracts (MIT licence)
/// @dev See https://eips.ethereum.org/EIPS/eip-2771
library ERC2771Calldata {
/// @notice Returns the sender address appended at the end of the calldata, as specified in EIP-2771.
function msgSender() internal pure returns (address sender) {
assembly {
sender := shr(96, calldataload(sub(calldatasize(), 20)))
}
}
/// @notice Returns the calldata while omitting the appended sender address, as specified in EIP-2771.
function msgData() internal pure returns (bytes calldata data) {
unchecked {
return msg.data[:msg.data.length - 20];
}
}
}
"
},
"contracts/proxy/errors/ProxyInitializationErrors.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
/// @notice Emitted when trying to set a phase value that has already been reached.
/// @param currentPhase The current phase.
/// @param newPhase The new phase trying to be set.
error InitializationPhaseAlreadyReached(uint256 currentPhase, uint256 newPhase);
"
},
"contracts/proxy/libraries/ProxyInitialization.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {InitializationPhaseAlreadyReached} from "./../errors/ProxyInitializationErrors.sol";
import {StorageSlot} from "@openzeppelin/contracts/utils/StorageSlot.sol";
/// @notice Multiple calls protection for storage-modifying proxy initialization functions.
library ProxyInitialization {
/// @notice Sets the initialization phase during a storage-modifying proxy initialization function.
/// @dev Reverts with {InitializationPhaseAlreadyReached} if `phase` has been reached already.
/// @param storageSlot the storage slot where `phase` is stored.
/// @param phase the initialization phase.
function setPhase(bytes32 storageSlot, uint256 phase) internal {
StorageSlot.Uint256Slot storage currentVersion = StorageSlot.getUint256Slot(storageSlot);
uint256 currentPhase = currentVersion.value;
if (currentPhase >= phase) revert InitializationPhaseAlreadyReached(currentPhase, phase);
currentVersion.value = phase;
}
}
"
},
"contracts/security/TokenRecovery.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {TokenRecoveryBase} from "./base/TokenRecoveryBase.sol";
import {ContractOwnership} from "./../access/ContractOwnership.sol";
/// @title Recovery mechanism for ETH/ERC20/ERC721 tokens accidentally sent to this contract (immutable version).
/// @dev This contract is to be used via inheritance in an immutable (non-proxied) implementation.
abstract contract TokenRecovery is TokenRecoveryBase, ContractOwnership {}
"
},
"contracts/security/base/TokenRecoveryBase.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
import {IERC721} from "./../../token/ERC721/interfaces/IERC721.sol";
import {ITokenRecovery} from "./../interfaces/ITokenRecovery.sol";
import {ContractOwnershipStorage} from "./../../access/libraries/ContractOwnershipStorage.sol";
import {TokenRecoveryLibrary} from "./../libraries/TokenRecoveryLibrary.sol";
import {Context} from "@openzeppelin/contracts/utils/Context.sol";
/// @title Recovery mechanism for ETH/ERC20/ERC721 tokens accidentally sent to this contract (proxiable version).
/// @dev This contract is to be used via inheritance in a proxied implementation.
/// @dev Note: This contract requires ERC173 (Contract Ownership standard).
abstract contract TokenRecoveryBase is ITokenRecovery, Context {
using ContractOwnershipStorage for ContractOwnershipStorage.Layout;
/// @inheritdoc ITokenRecovery
/// @dev Reverts with {NotContractOwner} if the sender is not the contract owner.
/// @dev Reverts with {InconsistentArrayLengths} `accounts` and `amounts` do not have the same length.
/// @dev Reverts if one of the ETH transfers fails for any reason.
function recoverETH(address payable[] calldata accounts, uint256[] calldata amounts) public virtual {
ContractOwnershipStorage.layout().enforceIsContractOwner(_msgSender());
TokenRecoveryLibrary.recoverETH(accounts, amounts);
}
/// @inheritdoc ITokenRecovery
/// @dev Reverts with {NotContractOwner} if the sender is not the contract owner.
/// @dev Reverts with {InconsistentArrayLengths} if `accounts`, `tokens` and `amounts` do not have the same length.
/// @dev Reverts if one of the ERC20 transfers fails for any reason.
function recoverERC20s(address[] calldata accounts, IERC20[] calldata tokens, uint256[] calldata amounts) public virtual {
ContractOwnershipStorage.layout().enforceIsContractOwner(_msgSender());
TokenRecoveryLibrary.recoverERC20s(accounts, tokens, amounts);
}
/// @inheritdoc ITokenRecovery
/// @dev Reverts with {NotContractOwner} if the sender is not the contract owner.
/// @dev Reverts with {InconsistentArrayLengths} if `accounts`, `contracts` and `amounts` do not have the same length.
/// @dev Reverts if one of the ERC721 transfers fails for any reason.
function recoverERC721s(address[] calldata accounts, IERC721[] calldata contracts, uint256[] calldata tokenIds) public virtual {
ContractOwnershipStorage.layout().enforceIsContractOwner(_msgSender());
TokenRecoveryLibrary.recoverERC721s(accounts, contracts, tokenIds);
}
}
"
},
"contracts/security/interfaces/ITokenRecovery.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
import {IERC721} from "./../../token/ERC721/interfaces/IERC721.sol";
/// @title Uniquely identified seals management.
interface ITokenRecovery {
/// @notice Extract ETH tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Note: While contracts can generally prevent accidental ETH transfer by implementating a reverting
/// `receive()` function, this can still be bypassed in a `selfdestruct(address)` scenario.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ETH tokens
/// so that the extraction is limited to only amounts sent accidentally.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param amounts the list of token amounts to transfer.
function recoverETH(address payable[] calldata accounts, uint256[] calldata amounts) external;
/// @notice Extract ERC20 tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ERC20 tokens
/// so that the extraction is limited to only amounts sent accidentally.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param tokens the list of ERC20 token addresses.
/// @param amounts the list of token amounts to transfer.
function recoverERC20s(address[] calldata accounts, IERC20[] calldata tokens, uint256[] calldata amounts) external;
/// @notice Extract ERC721 tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ERC721 tokens
/// so that the extraction is limited to only tokens sent accidentally.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param contracts the list of ERC721 contract addresses.
/// @param tokenIds the list of token ids to transfer.
function recoverERC721s(address[] calldata accounts, IERC721[] calldata contracts, uint256[] calldata tokenIds) external;
}
"
},
"contracts/security/libraries/TokenRecoveryLibrary.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {InconsistentArrayLengths} from "./../../CommonErrors.sol";
import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
import {IERC721} from "./../../token/ERC721/interfaces/IERC721.sol";
import {IERC165} from "./../../introspection/interfaces/IERC165.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Address} from "@openzeppelin/contracts/utils/Address.sol";
library TokenRecoveryLibrary {
using SafeERC20 for IERC20;
using Address for address payable;
/// @notice Thrown when trying to recover a token of the wrong contract type.
/// @param tokenContract The token contract being recovered.
error IncorrectTokenContractType(address tokenContract);
/// @notice Extract ETH tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Note: While contracts can generally prevent accidental ETH transfer by implementating a reverting
/// `receive()` function, this can still be bypassed in a `selfdestruct(address)` scenario.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ETH tokens
/// so that the extraction is limited to only amounts sent accidentally.
/// @dev Reverts with {InconsistentArrayLengths} `accounts` and `amounts` do not have the same length.
/// @dev Reverts if one of the ETH transfers fails for any reason.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param amounts the list of token amounts to transfer.
function recoverETH(address payable[] calldata accounts, uint256[] calldata amounts) internal {
uint256 length = accounts.length;
if (length != amounts.length) revert InconsistentArrayLengths();
for (uint256 i; i < length; ++i) {
accounts[i].sendValue(amounts[i]);
}
}
/// @notice Extract ERC20 tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ERC20 tokens
/// so that the extraction is limited to only amounts sent accidentally.
/// @dev Reverts with {InconsistentArrayLengths} if `accounts`, `tokens` and `amounts` do not have the same length.
/// @dev Reverts if one of the ERC20 transfers fails for any reason.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param tokens the list of ERC20 token addresses.
/// @param amounts the list of token amounts to transfer.
function recoverERC20s(address[] calldata accounts, IERC20[] calldata tokens, uint256[] calldata amounts) internal {
uint256 length = accounts.length;
if (length != tokens.length || length != amounts.length) revert InconsistentArrayLengths();
for (uint256 i; i < length; ++i) {
tokens[i].safeTransfer(accounts[i], amounts[i]);
}
}
/// @notice Extract ERC721 tokens which were accidentally sent to the contract to a list of accounts.
/// @dev Warning: this function should be overriden for contracts which are supposed to hold ERC721 tokens
/// so that the extraction is limited to only tokens sent accidentally.
/// @dev Reverts with {InconsistentArrayLengths} if `accounts`, `contracts` and `amounts` do not have the same length.
/// @dev Reverts if one of the ERC721 transfers fails for any reason.
/// @param accounts the list of accounts to transfer the tokens to.
/// @param contracts the list of ERC721 contract addresses.
/// @param tokenIds the list of token ids to transfer.
function recoverERC721s(address[] calldata accounts, IERC721[] calldata contracts, uint256[] calldata tokenIds) internal {
uint256 length = accounts.length;
if (length != contracts.length || length != tokenIds.length) revert InconsistentArrayLengths();
for (uint256 i; i < length; ++i) {
IERC721 tokenContract = contracts[i];
if (!IERC165(address(tokenContract)).supportsInterface(type(IERC721).interfaceId)) {
revert IncorrectTokenContractType(address(tokenContract));
}
contracts[i].safeTransferFrom(address(this), accounts[i], tokenIds[i]);
}
}
}
"
},
"contracts/token/ERC20/ERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {ERC20Storage} from "./libraries/ERC20Storage.sol";
import {ERC20Base} from "./base/ERC20Base.sol";
import {InterfaceDetection} from "./../../introspection/InterfaceDetection.sol";
/// @title ERC20 Fungible Token Standard (immutable version).
/// @dev This contract is to be used via inheritance in an immutable (non-proxied) implementation.
abstract contract ERC20 is ERC20Base, InterfaceDetection {
/// @notice Marks the following ERC165 interface(s) as supported: ERC20, ERC20Allowance.
constructor() {
ERC20Storage.init();
}
}
"
},
"contracts/token/ERC20/ERC20BatchTransfers.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;
import {ERC20Storage} from "./libraries/ERC20Storage.soSubmitted on: 2025-10-28 12:11:59
Comments
Log in to comment.
No comments yet.