// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)pragmasolidity ^0.8.20;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/errorAddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/errorAddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/errorFailedInnerCall();
/**
* @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].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
if (address(this).balance< amount) {
revert AddressInsufficientBalance(address(this));
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert FailedInnerCall();
}
}
/**
* @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
* {FailedInnerCall} 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.
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
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`.
*/functionfunctionCallWithValue(address target, bytesmemory data, uint256 value) internalreturns (bytesmemory) {
if (address(this).balance< value) {
revert AddressInsufficientBalance(address(this));
}
(bool success, bytesmemory 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.
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
(bool success, bytesmemory 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 {FailedInnerCall}) in case of an
* unsuccessful call.
*/functionverifyCallResultFromTarget(address target,
bool success,
bytesmemory returndata
) internalviewreturns (bytesmemory) {
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 contractif (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 {FailedInnerCall} error.
*/functionverifyCallResult(bool success, bytesmemory returndata) internalpurereturns (bytesmemory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
*/function_revert(bytesmemory returndata) privatepure{
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly/// @solidity memory-safe-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}
Contract Source Code
File 2 of 14: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Context.sol)pragmasolidity ^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.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 3 of 14: ERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/ERC20.sol)pragmasolidity ^0.8.20;import {IERC20} from"./IERC20.sol";
import {IERC20Metadata} from"./extensions/IERC20Metadata.sol";
import {Context} from"../../utils/Context.sol";
import {IERC20Errors} from"../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*/abstractcontractERC20isContext, IERC20, IERC20Metadata, IERC20Errors{
mapping(address account =>uint256) private _balances;
mapping(address account =>mapping(address spender =>uint256)) private _allowances;
uint256private _totalSupply;
stringprivate _name;
stringprivate _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/constructor(stringmemory name_, stringmemory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/functionname() publicviewvirtualreturns (stringmemory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/functionsymbol() publicviewvirtualreturns (stringmemory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/functiondecimals() publicviewvirtualreturns (uint8) {
return18;
}
/**
* @dev See {IERC20-totalSupply}.
*/functiontotalSupply() publicviewvirtualreturns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/functionbalanceOf(address account) publicviewvirtualreturns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/functiontransfer(address to, uint256 value) publicvirtualreturns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
returntrue;
}
/**
* @dev See {IERC20-allowance}.
*/functionallowance(address owner, address spender) publicviewvirtualreturns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/functionapprove(address spender, uint256 value) publicvirtualreturns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
returntrue;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/functiontransferFrom(addressfrom, address to, uint256 value) publicvirtualreturns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
returntrue;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/function_transfer(addressfrom, address to, uint256 value) internal{
if (from==address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to ==address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/function_update(addressfrom, address to, uint256 value) internalvirtual{
if (from==address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to ==address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/function_mint(address account, uint256 value) internal{
if (account ==address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/function_burn(address account, uint256 value) internal{
if (account ==address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/function_approve(address owner, address spender, uint256 value) internal{
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
* ```
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/function_approve(address owner, address spender, uint256 value, bool emitEvent) internalvirtual{
if (owner ==address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender ==address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/function_spendAllowance(address owner, address spender, uint256 value) internalvirtual{
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance !=type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}
Contract Source Code
File 4 of 14: ERC20Burnable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Burnable.sol)pragmasolidity ^0.8.20;import {ERC20} from"../ERC20.sol";
import {Context} from"../../../utils/Context.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/abstractcontractERC20BurnableisContext, ERC20{
/**
* @dev Destroys a `value` amount of tokens from the caller.
*
* See {ERC20-_burn}.
*/functionburn(uint256 value) publicvirtual{
_burn(_msgSender(), value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, deducting from
* the caller's allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `value`.
*/functionburnFrom(address account, uint256 value) publicvirtual{
_spendAllowance(account, _msgSender(), value);
_burn(account, value);
}
}
Contract Source Code
File 5 of 14: IERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)pragmasolidity ^0.8.20;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed 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.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (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.
*/functiontransfer(address to, uint256 value) externalreturns (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.
*/functionallowance(address owner, address spender) externalviewreturns (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.
*/functionapprove(address spender, uint256 value) externalreturns (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.
*/functiontransferFrom(addressfrom, address to, uint256 value) externalreturns (bool);
}
Contract Source Code
File 6 of 14: IERC20Metadata.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)pragmasolidity ^0.8.20;import {IERC20} from"../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*/interfaceIERC20MetadataisIERC20{
/**
* @dev Returns the name of the token.
*/functionname() externalviewreturns (stringmemory);
/**
* @dev Returns the symbol of the token.
*/functionsymbol() externalviewreturns (stringmemory);
/**
* @dev Returns the decimals places of the token.
*/functiondecimals() externalviewreturns (uint8);
}
Contract Source Code
File 7 of 14: IERC20Permit.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)pragmasolidity ^0.8.20;/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/interfaceIERC20Permit{
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/functionpermit(address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/functionnonces(address owner) externalviewreturns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/// solhint-disable-next-line func-name-mixedcasefunctionDOMAIN_SEPARATOR() externalviewreturns (bytes32);
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)pragmasolidity ^0.8.20;import {Context} from"../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/errorOwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/errorOwnableInvalidOwner(address owner);
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/constructor(address initialOwner) {
if (initialOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
if (newOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 12 of 14: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^0.8.20;import {IERC20} from"../IERC20.sol";
import {IERC20Permit} from"../extensions/IERC20Permit.sol";
import {Address} from"../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/librarySafeERC20{
usingAddressforaddress;
/**
* @dev An operation with an ERC20 token failed.
*/errorSafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/errorSafeERC20FailedDecreaseAllowance(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.
*/functionsafeTransfer(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.
*/functionsafeTransferFrom(IERC20 token, addressfrom, 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.
*/functionsafeIncreaseAllowance(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.
*/functionsafeDecreaseAllowance(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.
*/functionforceApprove(IERC20 token, address spender, uint256 value) internal{
bytesmemory approvalCall =abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/function_callOptionalReturn(IERC20 token, bytesmemory data) private{
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that// the target address contains contract code and also asserts for success in the low-level call.bytesmemory returndata =address(token).functionCall(data);
if (returndata.length!=0&&!abi.decode(returndata, (bool))) {
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 silents catches all reverts and returns a bool instead.
*/function_callOptionalReturnBool(IERC20 token, bytesmemory data) privatereturns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false// and not revert is the subcall reverts.
(bool success, bytesmemory returndata) =address(token).call(data);
return success && (returndata.length==0||abi.decode(returndata, (bool))) &&address(token).code.length>0;
}
}
Contract Source Code
File 13 of 14: YieldMagnetToken.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.20;import"@openzeppelin/contracts/token/ERC20/ERC20.sol";
import"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import"@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
import"@openzeppelin/contracts/access/Ownable.sol";
import"@uniswap/v2-periphery/contracts/interfaces/IUniswapV2Router02.sol";
import"@uniswap/v2-core/contracts/interfaces/IUniswapV2Factory.sol";
/// @title This is official MAGNET Token contract ERC20 used in the Yield Magnet platform/// @author Yield Magnet TeamstructStakingContract {
address contractAddress;
uint8 percentage;
}
contractYieldMagnetTokenisERC20, Ownable{
usingSafeERC20forIERC20;
/*//////////////////////////////////////////////////////////////
TAX VARIABLES
//////////////////////////////////////////////////////////////*/structWalletState {
bool isMarketPair;
bool isExemptFromTax;
}
// Saves gas!mapping(address=> WalletState) public walletStates;
// Set to 10/10 when trading is open. SetTaxes can only set it// up to 10/10.uint8public buyTax =0;
uint8public sellTax =0;
// Must always add up to 100.uint8public platformPercentage =60;
uint8public stakerPercentage =20;
uint8public lpPercentage =20;
// When set is true, tax will no longer be change-able.boolprivate _isTaxRenounced =false;
boolprivate _isTaxEnabled =true;
/*//////////////////////////////////////////////////////////////
CONTRACT SWAP
//////////////////////////////////////////////////////////////*/// Once switched on, can never be switched off.boolpublic isTradingOpen =false;
boolprivate _inSwap =false;
uint256public taxDistributionThreshold =5_000_000*10**18;
/*//////////////////////////////////////////////////////////////
UNISWAP
//////////////////////////////////////////////////////////////*/
IUniswapV2Router02 public uniswapV2Router;
/*//////////////////////////////////////////////////////////////
TAX RECIPIENTS
//////////////////////////////////////////////////////////////*/// Platform cut will be sent to this address.// Defaults to contract creator.addresspublic taxAddress;
// LP tokens will be sent to this address.// Defaults to contract creator.addresspublic lpAddress;
// Staking cut will be distributed to these contracts.// The percentages must always add up to 100.
StakingContract[] private _stakingContracts;
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/eventTaxDistributed(uint256 platformCut,
uint256 stakersCut,
uint256 liquidityCut
);
eventLiquidityAdded(uint256 tokenAmount, uint256 ethAmount);
eventPlatformTaxDistributed(uint256 amount);
eventUniswapRouterUpdated(address newRouter);
eventExcludedFromFeesUpdated(address wallet, bool isExcluded);
eventMarketPairUpdated(address pair, bool isMarketPair);
eventStakingContractsUpdated(address[] stakingContracts,
uint8[] percentages
);
eventTaxAddressUpdated(address newTaxAddress);
eventLpAddressUpdated(address newLpAddress);
eventTradingOpen();
eventTaxRenounced();
eventTaxStatusUpdated(bool isTaxEnabled);
eventTaxesUpdated(uint8 buyTax, uint8 sellTax);
eventDistributionThresholdUpdated(uint256 newThreshold);
eventDistributionPercentagesUpdated(uint8 platformPercentage,
uint8 stakerPercentage,
uint8 lpPercentage
);
/*//////////////////////////////////////////////////////////////
MAIN LOGIC
//////////////////////////////////////////////////////////////*/constructor() ERC20("Yield Magnet", "MAGNET") Ownable(msg.sender) {
super._update(address(0), msg.sender, (1_000_000_000*10**18));
address uniswapV2Router02Address =0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D;
IUniswapV2Router02 _uniswapV2Router = IUniswapV2Router02(
uniswapV2Router02Address
);
// Create the pair and mark it as a market pair to enable taxes.address uniswapV2Pair = IUniswapV2Factory(_uniswapV2Router.factory())
.createPair(address(this), _uniswapV2Router.WETH());
uniswapV2Router = _uniswapV2Router;
_approve(address(this), uniswapV2Router02Address, type(uint256).max);
setMarketPair(uniswapV2Pair, true);
taxAddress =msg.sender;
lpAddress =msg.sender;
// Exclude owner, this contract and Uniswap router from fees.
walletStates[msg.sender] = WalletState({
isMarketPair: false,
isExemptFromTax: true
});
emit ExcludedFromFeesUpdated(msg.sender, true);
walletStates[address(this)] = WalletState({
isMarketPair: false,
isExemptFromTax: true
});
emit ExcludedFromFeesUpdated(address(this), true);
walletStates[uniswapV2Router02Address] = WalletState({
isMarketPair: false,
isExemptFromTax: true
});
emit ExcludedFromFeesUpdated(uniswapV2Router02Address, true);
}
receive() externalpayable{}
/// @notice Returns if an address is excluded from tax.functionisTaxExempt(address account_) externalviewreturns (bool) {
return walletStates[account_].isExemptFromTax;
}
/// @notice Returns if the tax is enabled or not. Tax only exists on market pairs.functionisTaxEnabled() externalviewreturns (bool) {
return _isTaxEnabled;
}
/// @notice Returns if tax is renounced, meaning that the taxes cannot be changed.functionisTaxRenounced() externalviewreturns (bool) {
return _isTaxRenounced;
}
/// @notice _update function overrides the _update function from the perent contract and contains logic for tax and tax distribution/// @dev this override function will be called from the top level transfer and transferFrom function whenever user initates transfer or buy and sell happens/// @dev this function breaks _mint. Use super._update instead./// @param from address from the amount will be transfered/// @param to address to where the amount will be transfered/// @param amount number of tokens to transferfunction_update(addressfrom,
address to,
uint256 amount
) internaloverride{
// Parent ERC20 already checks that from/to are not zero address.uint256 fromBalance = balanceOf(from);
require(
fromBalance >= amount,
"ERC20: transfer amount exceeds balance"
);
WalletState memory fromState = walletStates[from];
WalletState memory toState = walletStates[to];
bool isTaxExempt_ = (fromState.isExemptFromTax || toState.isExemptFromTax);
uint256 taxAmount;
if(fromState.isMarketPair || toState.isMarketPair) {
require(isTradingOpen ||msg.sender== owner() ||tx.origin== owner(), "Trading not open yet");
}
if (fromState.isMarketPair && isTaxExempt_ ==false&& _isTaxEnabled) {
taxAmount = (amount * buyTax) /100;
} elseif (
toState.isMarketPair && isTaxExempt_ ==false&& _isTaxEnabled
) {
taxAmount = (amount * sellTax) /100;
} else {
taxAmount =0;
}
if (
balanceOf(address(this)) > taxDistributionThreshold &&
_inSwap ==false&&
fromState.isMarketPair ==false&&// Don't swap on buys.
toState.isMarketPair ==true// Only swap on sells.
) {
trythis.distributeTax() {} catch(bytesmemory) {}
}
if (taxAmount !=0&& _inSwap ==false) {
super._update(from, to, amount - taxAmount);
super._update(from, address(this), taxAmount);
} else {
super._update(from, to, amount);
}
}
modifierlockTheSwap{
_inSwap =true;
_;
_inSwap =false;
}
/// @notice Distributes the collected tax to the platform, stakers and liquidity.functiondistributeTax() externallockTheSwap{
require(msg.sender==address(this) ||msg.sender== owner(), "owner/contract only");
uint256 contractBalance = balanceOf(address(this));
uint256 platformCut = (contractBalance * platformPercentage) /100;
uint256 stakerCut = (contractBalance * stakerPercentage) /100;
uint256 lpCut = (contractBalance * lpPercentage) /100;
require(
(platformCut + stakerCut + lpCut) <= balanceOf(address(this)),
"YieldMagnet: Can't distribute the funds"
);
_distributeStakersCut(stakerCut);
_handleLiquidityAndPlatformCut(platformCut, lpCut);
emit TaxDistributed(platformCut, stakerCut, lpCut);
}
/// @notice Distributes the stakers cut to the staking contracts./// @dev All staking contract's percentages must add up to exactly 100.function_distributeStakersCut(uint256 stakersCut_) private{
for (uint256 i =0; i < _stakingContracts.length; i++) {
StakingContract memory sc = _stakingContracts[i];
uint256 stakerContractCut = (sc.percentage * stakersCut_) /100;
super._update(address(this), sc.contractAddress, stakerContractCut);
}
}
/// @notice Distributes liquidity and platform cut. Swaps both to ETH, adds liquidity, and sends the remaining ETH to the tax address./// @param platformCut amount of tokens to swap and send as ETH to taxAddress./// @param lpCut half tokens are swapped, half added to liquidity.function_handleLiquidityAndPlatformCut(uint256 platformCut, uint256 lpCut) private{
uint256 initBal =address(this).balance;
_swapTokensForEth(lpCut/2-1+ platformCut);
if(lpCut >0) {
uint256 receiveBalance =address(this).balance- initBal;
uint256 ethForLiq = receiveBalance * lpCut / (lpCut + platformCut);
_addLiquidity(lpCut/2, ethForLiq);
emit LiquidityAdded(lpCut/2, ethForLiq);
}
// Send any remaining ETH to the tax address. This will equal to the platform cut.uint256 amount =address(this).balance;
(bool success,) = taxAddress.call{value: amount}("");
require(success, "YieldMagnet: Failed to send ETH to tax address");
emit PlatformTaxDistributed(amount);
}
/// @notice Swaps the token amount to ETH using the Uniswap V2 router.function_swapTokensForEth(uint256 tokenAmount_) private{
address[] memory path =newaddress[](2);
path[0] =address(this);
path[1] = uniswapV2Router.WETH();
require(
tokenAmount_ >0,
"YieldMagnet: Token amount less then 0 for token swap"
);
uniswapV2Router.swapExactTokensForETHSupportingFeeOnTransferTokens(
tokenAmount_,
0,
path,
address(this),
block.timestamp
);
}
/// @notice Adds liquidity to the Uniswap V2 pair. LP tokens are sent to the lpAddress./// @dev Approvals happen when setting the router address.function_addLiquidity(uint256 tokenAmount_, uint256 ethAmount_) private{
uniswapV2Router.addLiquidityETH{value: ethAmount_}(
address(this),
tokenAmount_,
0,
0,
lpAddress,
block.timestamp
);
}
/*//////////////////////////////////////////////////////////////
STAKING CONTRACTS
//////////////////////////////////////////////////////////////*//// @notice Retrieves the Staking contract address and their percentages.functiongetStakingContracts()
publicviewreturns (StakingContract[] memory)
{
return _stakingContracts;
}
/// @notice Sets the staking contracts and their respective percentages. Percentages must add up to 100./// @dev Deletes any previous _stakingContracts./// @param stakingContracts_ The array of Staking contract addresses/// @param percentages_ The array of Staking contract distribution perccentagesfunctionupdateStakingContracts(address[] memory stakingContracts_,
uint8[] memory percentages_
) externalonlyOwner{
require(
stakingContracts_.length== percentages_.length,
"YieldMagnet: No of address and No of Percentages doesn't match!"
);
require(stakingContracts_.length<=10, "YieldMagnet: Max 10 staking contracts allowed!");
// Clear the existing staking contracts.delete _stakingContracts;
uint8 totalPercent =0;
for (uint256 i =0; i < stakingContracts_.length; i++) {
require(
percentages_[i] >=0&& percentages_[i] <=100,
"YieldMagnet: percentage should be between 0 to 100!"
);
require(
stakingContracts_[i] !=address(0),
"YieldMagnet: Staking contract may not be 0x0"
);
_stakingContracts.push(
StakingContract(stakingContracts_[i], percentages_[i])
);
totalPercent += percentages_[i];
}
require(
totalPercent ==100,
"YieldMagnet: Total Percentage should be 100."
);
emit StakingContractsUpdated(stakingContracts_, percentages_);
}
/*//////////////////////////////////////////////////////////////
OWNER FUNCTIONS
//////////////////////////////////////////////////////////////*//// @notice Opens the trading, enabling taxes. Can only be called once.functionopenTrading() externalonlyOwner{
require(isTradingOpen ==false, "Trading already open");
isTradingOpen =true;
buyTax =10;
sellTax =10;
emit TradingOpen();
}
/// @notice Renounces the tax, meaning that it can never be changed again.functionrenounceTax() publiconlyOwner{
_isTaxRenounced =true;
emit TaxRenounced();
}
/// @notice Sets the Uniswap router address to use for swapping taxes and adding liquidity.functionupdateUniswapRouter(address newRouter) externalonlyOwner{
address oldAddress =address(uniswapV2Router);
require(oldAddress != newRouter, "Address already set");
_approve(address(this), oldAddress, 0);
_approve(address(this), newRouter, type(uint256).max);
uniswapV2Router = IUniswapV2Router02(newRouter);
emit UniswapRouterUpdated(newRouter);
}
/// @notice Sets an address's tax exempt status.functionsetTaxExempt(address account, bool isExempt) externalonlyOwner{
require(account !=address(this), "Can't change contract");
WalletState memory state = walletStates[account];
state.isExemptFromTax = isExempt;
walletStates[account] = state;
emit ExcludedFromFeesUpdated(account, isExempt);
}
/// @notice Toggles if tax is enabled or not.functionsetTaxEnabled(bool taxStatus_) externalonlyOwner{
_isTaxEnabled = taxStatus_;
emit TaxStatusUpdated(taxStatus_);
}
/// @notice Set the receiver of platform taxes.functionsetTaxAddress(address newTaxAddress_) externalonlyOwner{
taxAddress = newTaxAddress_;
emit TaxAddressUpdated(newTaxAddress_);
}
/// @notice Sets the address that will receive LP tokens from liquidity adds.functionsetLpAddress(address newLpAddress_) externalonlyOwner{
lpAddress = newLpAddress_;
emit LpAddressUpdated(newLpAddress_);
}
/// @notice Sets the tax percentages for buy and sell. Can only be called before tax is renounced./// @dev it sets buyTax to the newBuyTax_ and sellTax to the newSellTax_/// @param newBuyTax_ new buy tax. Cannot exceed 10./// @param newSellTax_ new sell tax. Cannot exceed 10.functionsetTaxAmount(uint8 newBuyTax_,
uint8 newSellTax_
) externalonlyOwner{
require(_isTaxRenounced ==false, "YieldMagnet: Tax is renounced!");
require(
newBuyTax_ <=10&& newSellTax_ <=10,
"YieldMagnet: Tax Should be less then 10!"
);
buyTax = newBuyTax_;
sellTax = newSellTax_;
emit TaxesUpdated(newBuyTax_, newSellTax_);
}
/// @notice setMarketPair updates the market pair status. Taxes apply from/to market pairs.functionsetMarketPair(address account, bool value) publiconlyOwner{
require(account !=address(this), "cant change contract");
WalletState memory state = walletStates[account];
state.isMarketPair = value;
walletStates[account] = state;
emit MarketPairUpdated(account, value);
}
/// @notice Updates the tax distribution percentage between platform, stakers and liquidity./// @dev sum of all three percentage must be == 100 for proper distribution./// @param platformPercentage_ percentage for the platform/// @param stakerPercentage_ percentage for the stakers/// @param lpPercentage_ percentage for the liquidityfunctionsetDistributionPercentage(uint8 platformPercentage_,
uint8 stakerPercentage_,
uint8 lpPercentage_
) externalonlyOwner{
require(
(platformPercentage_ + stakerPercentage_ + lpPercentage_) ==100,
"YieldMagnet: Percentage should sum to 100!"
);
platformPercentage = platformPercentage_;
stakerPercentage = stakerPercentage_;
lpPercentage = lpPercentage_;
emit DistributionPercentagesUpdated(
platformPercentage_,
stakerPercentage_,
lpPercentage_
);
}
/// @notice Changes the balance threshold for when tax is distributed./// @dev it sets taxDistributionThreshold to newTaxDistributionThreshold_ also multiply it with the decimals/// @param newTaxDistributionThreshold_ number of whole tokens for the threshold. Decimals are added automatically.functionchangeTaxDistributionThreshold(uint256 newTaxDistributionThreshold_
) externalonlyOwner{
require(
newTaxDistributionThreshold_ >0,
"YieldMagnet: Threshold can't be 0"
);
taxDistributionThreshold = newTaxDistributionThreshold_ *10**18;
emit DistributionThresholdUpdated(newTaxDistributionThreshold_);
}
/// @notice Rescue any tokens that are stuck in the contract.functionrescueStuckTokens(address tokenAddress_,
uint256 amount_
) externalonlyOwner{
require(amount_ >0, "YieldMagnet: amount can't be 0");
IERC20 token = IERC20(tokenAddress_);
token.safeTransfer(msg.sender, amount_);
}
/// @notice Rescues any ETH that are stuck in the contract.functionrescueStuckETH(uint256 amount_) externalonlyOwner{
require(amount_ >0, "YieldMagnet: amount can't be 0");
(bool success,) =msg.sender.call{value: amount_}("");
require(success, "failed to send eth");
}
}
Contract Source Code
File 14 of 14: draft-IERC6093.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)pragmasolidity ^0.8.20;/**
* @dev Standard ERC20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens.
*/interfaceIERC20Errors{
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/errorERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/errorERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/errorERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/errorERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/errorERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/errorERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens.
*/interfaceIERC721Errors{
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/errorERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/errorERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/errorERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/errorERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/errorERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/errorERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/errorERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/errorERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 tokens.
*/interfaceIERC1155Errors{
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/errorERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/errorERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/errorERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/errorERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/errorERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/errorERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/errorERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}