{ "language": "Solidity", "sources": { "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (access/AccessControl.sol)\n\npragma solidity ^0.8.0;\n\nimport \"./IAccessControlUpgradeable.sol\";\nimport \"../utils/ContextUpgradeable.sol\";\nimport \"../utils/StringsUpgradeable.sol\";\nimport \"../utils/introspection/ERC165Upgradeable.sol\";\nimport \"../proxy/utils/Initializable.sol\";\n\n/**\n * @dev Contract module that allows children to implement role-based access\n * control mechanisms. This is a lightweight version that doesn't allow enumerating role\n * members except through off-chain means by accessing the contract event logs. Some\n * applications may benefit from on-chain enumerability, for those cases see\n * {AccessControlEnumerable}.\n *\n * Roles are referred to by their `bytes32` identifier. These should be exposed\n * in the external API and be unique. The best way to achieve this is by\n * using `public constant` hash digests:\n *\n * ```\n * bytes32 public constant MY_ROLE = keccak256(\"MY_ROLE\");\n * ```\n *\n * Roles can be used to represent a set of permissions. To restrict access to a\n * function call, use {hasRole}:\n *\n * ```\n * function foo() public {\n * require(hasRole(MY_ROLE, msg.sender));\n * ...\n * }\n * ```\n *\n * Roles can be granted and revoked dynamically via the {grantRole} and\n * {revokeRole} functions. Each role has an associated admin role, and only\n * accounts that have a role's admin role can call {grantRole} and {revokeRole}.\n *\n * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means\n * that only accounts with this role will be able to grant or revoke other\n * roles. More complex role relationships can be created by using\n * {_setRoleAdmin}.\n *\n * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to\n * grant and revoke this role. Extra precautions should be taken to secure\n * accounts that have been granted it.\n */\nabstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {\n function __AccessControl_init() internal onlyInitializing {\n }\n\n function __AccessControl_init_unchained() internal onlyInitializing {\n }\n struct RoleData {\n mapping(address => bool) members;\n bytes32 adminRole;\n }\n\n mapping(bytes32 => RoleData) private _roles;\n\n bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;\n\n /**\n * @dev Modifier that checks that an account has a specific role. Reverts\n * with a standardized message including the required role.\n *\n * The format of the revert reason is given by the following regular expression:\n *\n * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/\n *\n * _Available since v4.1._\n */\n modifier onlyRole(bytes32 role) {\n _checkRole(role);\n _;\n }\n\n /**\n * @dev See {IERC165-supportsInterface}.\n */\n function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {\n return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);\n }\n\n /**\n * @dev Returns `true` if `account` has been granted `role`.\n */\n function hasRole(bytes32 role, address account) public view virtual override returns (bool) {\n return _roles[role].members[account];\n }\n\n /**\n * @dev Revert with a standard message if `_msgSender()` is missing `role`.\n * Overriding this function changes the behavior of the {onlyRole} modifier.\n *\n * Format of the revert message is described in {_checkRole}.\n *\n * _Available since v4.6._\n */\n function _checkRole(bytes32 role) internal view virtual {\n _checkRole(role, _msgSender());\n }\n\n /**\n * @dev Revert with a standard message if `account` is missing `role`.\n *\n * The format of the revert reason is given by the following regular expression:\n *\n * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/\n */\n function _checkRole(bytes32 role, address account) internal view virtual {\n if (!hasRole(role, account)) {\n revert(\n string(\n abi.encodePacked(\n \"AccessControl: account \",\n StringsUpgradeable.toHexString(account),\n \" is missing role \",\n StringsUpgradeable.toHexString(uint256(role), 32)\n )\n )\n );\n }\n }\n\n /**\n * @dev Returns the admin role that controls `role`. See {grantRole} and\n * {revokeRole}.\n *\n * To change a role's admin, use {_setRoleAdmin}.\n */\n function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {\n return _roles[role].adminRole;\n }\n\n /**\n * @dev Grants `role` to `account`.\n *\n * If `account` had not been already granted `role`, emits a {RoleGranted}\n * event.\n *\n * Requirements:\n *\n * - the caller must have ``role``'s admin role.\n *\n * May emit a {RoleGranted} event.\n */\n function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {\n _grantRole(role, account);\n }\n\n /**\n * @dev Revokes `role` from `account`.\n *\n * If `account` had been granted `role`, emits a {RoleRevoked} event.\n *\n * Requirements:\n *\n * - the caller must have ``role``'s admin role.\n *\n * May emit a {RoleRevoked} event.\n */\n function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {\n _revokeRole(role, account);\n }\n\n /**\n * @dev Revokes `role` from the calling account.\n *\n * Roles are often managed via {grantRole} and {revokeRole}: this function's\n * purpose is to provide a mechanism for accounts to lose their privileges\n * if they are compromised (such as when a trusted device is misplaced).\n *\n * If the calling account had been revoked `role`, emits a {RoleRevoked}\n * event.\n *\n * Requirements:\n *\n * - the caller must be `account`.\n *\n * May emit a {RoleRevoked} event.\n */\n function renounceRole(bytes32 role, address account) public virtual override {\n require(account == _msgSender(), \"AccessControl: can only renounce roles for self\");\n\n _revokeRole(role, account);\n }\n\n /**\n * @dev Grants `role` to `account`.\n *\n * If `account` had not been already granted `role`, emits a {RoleGranted}\n * event. Note that unlike {grantRole}, this function doesn't perform any\n * checks on the calling account.\n *\n * May emit a {RoleGranted} event.\n *\n * [WARNING]\n * ====\n * This function should only be called from the constructor when setting\n * up the initial roles for the system.\n *\n * Using this function in any other way is effectively circumventing the admin\n * system imposed by {AccessControl}.\n * ====\n *\n * NOTE: This function is deprecated in favor of {_grantRole}.\n */\n function _setupRole(bytes32 role, address account) internal virtual {\n _grantRole(role, account);\n }\n\n /**\n * @dev Sets `adminRole` as ``role``'s admin role.\n *\n * Emits a {RoleAdminChanged} event.\n */\n function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {\n bytes32 previousAdminRole = getRoleAdmin(role);\n _roles[role].adminRole = adminRole;\n emit RoleAdminChanged(role, previousAdminRole, adminRole);\n }\n\n /**\n * @dev Grants `role` to `account`.\n *\n * Internal function without access restriction.\n *\n * May emit a {RoleGranted} event.\n */\n function _grantRole(bytes32 role, address account) internal virtual {\n if (!hasRole(role, account)) {\n _roles[role].members[account] = true;\n emit RoleGranted(role, account, _msgSender());\n }\n }\n\n /**\n * @dev Revokes `role` from `account`.\n *\n * Internal function without access restriction.\n *\n * May emit a {RoleRevoked} event.\n */\n function _revokeRole(bytes32 role, address account) internal virtual {\n if (hasRole(role, account)) {\n _roles[role].members[account] = false;\n emit RoleRevoked(role, account, _msgSender());\n }\n }\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[49] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/access/IAccessControlUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev External interface of AccessControl declared to support ERC165 detection.\n */\ninterface IAccessControlUpgradeable {\n /**\n * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`\n *\n * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite\n * {RoleAdminChanged} not being emitted signaling this.\n *\n * _Available since v3.1._\n */\n event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);\n\n /**\n * @dev Emitted when `account` is granted `role`.\n *\n * `sender` is the account that originated the contract call, an admin role\n * bearer except when using {AccessControl-_setupRole}.\n */\n event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);\n\n /**\n * @dev Emitted when `account` is revoked `role`.\n *\n * `sender` is the account that originated the contract call:\n * - if using `revokeRole`, it is the admin role bearer\n * - if using `renounceRole`, it is the role bearer (i.e. `account`)\n */\n event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);\n\n /**\n * @dev Returns `true` if `account` has been granted `role`.\n */\n function hasRole(bytes32 role, address account) external view returns (bool);\n\n /**\n * @dev Returns the admin role that controls `role`. See {grantRole} and\n * {revokeRole}.\n *\n * To change a role's admin, use {AccessControl-_setRoleAdmin}.\n */\n function getRoleAdmin(bytes32 role) external view returns (bytes32);\n\n /**\n * @dev Grants `role` to `account`.\n *\n * If `account` had not been already granted `role`, emits a {RoleGranted}\n * event.\n *\n * Requirements:\n *\n * - the caller must have ``role``'s admin role.\n */\n function grantRole(bytes32 role, address account) external;\n\n /**\n * @dev Revokes `role` from `account`.\n *\n * If `account` had been granted `role`, emits a {RoleRevoked} event.\n *\n * Requirements:\n *\n * - the caller must have ``role``'s admin role.\n */\n function revokeRole(bytes32 role, address account) external;\n\n /**\n * @dev Revokes `role` from the calling account.\n *\n * Roles are often managed via {grantRole} and {revokeRole}: this function's\n * purpose is to provide a mechanism for accounts to lose their privileges\n * if they are compromised (such as when a trusted device is misplaced).\n *\n * If the calling account had been granted `role`, emits a {RoleRevoked}\n * event.\n *\n * Requirements:\n *\n * - the caller must be `account`.\n */\n function renounceRole(bytes32 role, address account) external;\n}\n" }, "@openzeppelin/contracts-upgradeable/interfaces/draft-IERC1822Upgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified\n * proxy whose upgrades are fully controlled by the current implementation.\n */\ninterface IERC1822ProxiableUpgradeable {\n /**\n * @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation\n * address.\n *\n * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks\n * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this\n * function revert if invoked through a proxy.\n */\n function proxiableUUID() external view returns (bytes32);\n}\n" }, "@openzeppelin/contracts-upgradeable/proxy/beacon/IBeaconUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (proxy/beacon/IBeacon.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev This is the interface that {BeaconProxy} expects of its beacon.\n */\ninterface IBeaconUpgradeable {\n /**\n * @dev Must return an address that can be used as a delegate call target.\n *\n * {BeaconProxy} will check that this address is a contract.\n */\n function implementation() external view returns (address);\n}\n" }, "@openzeppelin/contracts-upgradeable/proxy/ERC1967/ERC1967UpgradeUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.5.0) (proxy/ERC1967/ERC1967Upgrade.sol)\n\npragma solidity ^0.8.2;\n\nimport \"../beacon/IBeaconUpgradeable.sol\";\nimport \"../../interfaces/draft-IERC1822Upgradeable.sol\";\nimport \"../../utils/AddressUpgradeable.sol\";\nimport \"../../utils/StorageSlotUpgradeable.sol\";\nimport \"../utils/Initializable.sol\";\n\n/**\n * @dev This abstract contract provides getters and event emitting update functions for\n * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.\n *\n * _Available since v4.1._\n *\n * @custom:oz-upgrades-unsafe-allow delegatecall\n */\nabstract contract ERC1967UpgradeUpgradeable is Initializable {\n function __ERC1967Upgrade_init() internal onlyInitializing {\n }\n\n function __ERC1967Upgrade_init_unchained() internal onlyInitializing {\n }\n // This is the keccak-256 hash of \"eip1967.proxy.rollback\" subtracted by 1\n bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143;\n\n /**\n * @dev Storage slot with the address of the current implementation.\n * This is the keccak-256 hash of \"eip1967.proxy.implementation\" subtracted by 1, and is\n * validated in the constructor.\n */\n bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;\n\n /**\n * @dev Emitted when the implementation is upgraded.\n */\n event Upgraded(address indexed implementation);\n\n /**\n * @dev Returns the current implementation address.\n */\n function _getImplementation() internal view returns (address) {\n return StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value;\n }\n\n /**\n * @dev Stores a new address in the EIP1967 implementation slot.\n */\n function _setImplementation(address newImplementation) private {\n require(AddressUpgradeable.isContract(newImplementation), \"ERC1967: new implementation is not a contract\");\n StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;\n }\n\n /**\n * @dev Perform implementation upgrade\n *\n * Emits an {Upgraded} event.\n */\n function _upgradeTo(address newImplementation) internal {\n _setImplementation(newImplementation);\n emit Upgraded(newImplementation);\n }\n\n /**\n * @dev Perform implementation upgrade with additional setup call.\n *\n * Emits an {Upgraded} event.\n */\n function _upgradeToAndCall(\n address newImplementation,\n bytes memory data,\n bool forceCall\n ) internal {\n _upgradeTo(newImplementation);\n if (data.length > 0 || forceCall) {\n _functionDelegateCall(newImplementation, data);\n }\n }\n\n /**\n * @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call.\n *\n * Emits an {Upgraded} event.\n */\n function _upgradeToAndCallUUPS(\n address newImplementation,\n bytes memory data,\n bool forceCall\n ) internal {\n // Upgrades from old implementations will perform a rollback test. This test requires the new\n // implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing\n // this special case will break upgrade paths from old UUPS implementation to new ones.\n if (StorageSlotUpgradeable.getBooleanSlot(_ROLLBACK_SLOT).value) {\n _setImplementation(newImplementation);\n } else {\n try IERC1822ProxiableUpgradeable(newImplementation).proxiableUUID() returns (bytes32 slot) {\n require(slot == _IMPLEMENTATION_SLOT, \"ERC1967Upgrade: unsupported proxiableUUID\");\n } catch {\n revert(\"ERC1967Upgrade: new implementation is not UUPS\");\n }\n _upgradeToAndCall(newImplementation, data, forceCall);\n }\n }\n\n /**\n * @dev Storage slot with the admin of the contract.\n * This is the keccak-256 hash of \"eip1967.proxy.admin\" subtracted by 1, and is\n * validated in the constructor.\n */\n bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;\n\n /**\n * @dev Emitted when the admin account has changed.\n */\n event AdminChanged(address previousAdmin, address newAdmin);\n\n /**\n * @dev Returns the current admin.\n */\n function _getAdmin() internal view returns (address) {\n return StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value;\n }\n\n /**\n * @dev Stores a new address in the EIP1967 admin slot.\n */\n function _setAdmin(address newAdmin) private {\n require(newAdmin != address(0), \"ERC1967: new admin is the zero address\");\n StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value = newAdmin;\n }\n\n /**\n * @dev Changes the admin of the proxy.\n *\n * Emits an {AdminChanged} event.\n */\n function _changeAdmin(address newAdmin) internal {\n emit AdminChanged(_getAdmin(), newAdmin);\n _setAdmin(newAdmin);\n }\n\n /**\n * @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.\n * This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor.\n */\n bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;\n\n /**\n * @dev Emitted when the beacon is upgraded.\n */\n event BeaconUpgraded(address indexed beacon);\n\n /**\n * @dev Returns the current beacon.\n */\n function _getBeacon() internal view returns (address) {\n return StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value;\n }\n\n /**\n * @dev Stores a new beacon in the EIP1967 beacon slot.\n */\n function _setBeacon(address newBeacon) private {\n require(AddressUpgradeable.isContract(newBeacon), \"ERC1967: new beacon is not a contract\");\n require(\n AddressUpgradeable.isContract(IBeaconUpgradeable(newBeacon).implementation()),\n \"ERC1967: beacon implementation is not a contract\"\n );\n StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value = newBeacon;\n }\n\n /**\n * @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does\n * not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that).\n *\n * Emits a {BeaconUpgraded} event.\n */\n function _upgradeBeaconToAndCall(\n address newBeacon,\n bytes memory data,\n bool forceCall\n ) internal {\n _setBeacon(newBeacon);\n emit BeaconUpgraded(newBeacon);\n if (data.length > 0 || forceCall) {\n _functionDelegateCall(IBeaconUpgradeable(newBeacon).implementation(), data);\n }\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],\n * but performing a delegate call.\n *\n * _Available since v3.4._\n */\n function _functionDelegateCall(address target, bytes memory data) private returns (bytes memory) {\n require(AddressUpgradeable.isContract(target), \"Address: delegate call to non-contract\");\n\n // solhint-disable-next-line avoid-low-level-calls\n (bool success, bytes memory returndata) = target.delegatecall(data);\n return AddressUpgradeable.verifyCallResult(success, returndata, \"Address: low-level delegate call failed\");\n }\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[50] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (proxy/utils/Initializable.sol)\n\npragma solidity ^0.8.2;\n\nimport \"../../utils/AddressUpgradeable.sol\";\n\n/**\n * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed\n * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an\n * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer\n * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.\n *\n * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be\n * reused. This mechanism prevents re-execution of each \"step\" but allows the creation of new initialization steps in\n * case an upgrade adds a module that needs to be initialized.\n *\n * For example:\n *\n * [.hljs-theme-light.nopadding]\n * ```\n * contract MyToken is ERC20Upgradeable {\n * function initialize() initializer public {\n * __ERC20_init(\"MyToken\", \"MTK\");\n * }\n * }\n * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {\n * function initializeV2() reinitializer(2) public {\n * __ERC20Permit_init(\"MyToken\");\n * }\n * }\n * ```\n *\n * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as\n * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.\n *\n * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure\n * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.\n *\n * [CAUTION]\n * ====\n * Avoid leaving a contract uninitialized.\n *\n * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation\n * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke\n * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:\n *\n * [.hljs-theme-light.nopadding]\n * ```\n * /// @custom:oz-upgrades-unsafe-allow constructor\n * constructor() {\n * _disableInitializers();\n * }\n * ```\n * ====\n */\nabstract contract Initializable {\n /**\n * @dev Indicates that the contract has been initialized.\n * @custom:oz-retyped-from bool\n */\n uint8 private _initialized;\n\n /**\n * @dev Indicates that the contract is in the process of being initialized.\n */\n bool private _initializing;\n\n /**\n * @dev Triggered when the contract has been initialized or reinitialized.\n */\n event Initialized(uint8 version);\n\n /**\n * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,\n * `onlyInitializing` functions can be used to initialize parent contracts.\n *\n * Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a\n * constructor.\n *\n * Emits an {Initialized} event.\n */\n modifier initializer() {\n bool isTopLevelCall = !_initializing;\n require(\n (isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),\n \"Initializable: contract is already initialized\"\n );\n _initialized = 1;\n if (isTopLevelCall) {\n _initializing = true;\n }\n _;\n if (isTopLevelCall) {\n _initializing = false;\n emit Initialized(1);\n }\n }\n\n /**\n * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the\n * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be\n * used to initialize parent contracts.\n *\n * A reinitializer may be used after the original initialization step. This is essential to configure modules that\n * are added through upgrades and that require initialization.\n *\n * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`\n * cannot be nested. If one is invoked in the context of another, execution will revert.\n *\n * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in\n * a contract, executing them in the right order is up to the developer or operator.\n *\n * WARNING: setting the version to 255 will prevent any future reinitialization.\n *\n * Emits an {Initialized} event.\n */\n modifier reinitializer(uint8 version) {\n require(!_initializing && _initialized < version, \"Initializable: contract is already initialized\");\n _initialized = version;\n _initializing = true;\n _;\n _initializing = false;\n emit Initialized(version);\n }\n\n /**\n * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the\n * {initializer} and {reinitializer} modifiers, directly or indirectly.\n */\n modifier onlyInitializing() {\n require(_initializing, \"Initializable: contract is not initializing\");\n _;\n }\n\n /**\n * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.\n * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized\n * to any version. It is recommended to use this to lock implementation contracts that are designed to be called\n * through proxies.\n *\n * Emits an {Initialized} event the first time it is successfully executed.\n */\n function _disableInitializers() internal virtual {\n require(!_initializing, \"Initializable: contract is initializing\");\n if (_initialized < type(uint8).max) {\n _initialized = type(uint8).max;\n emit Initialized(type(uint8).max);\n }\n }\n\n /**\n * @dev Internal function that returns the initialized version. Returns `_initialized`\n */\n function _getInitializedVersion() internal view returns (uint8) {\n return _initialized;\n }\n\n /**\n * @dev Internal function that returns the initialized version. Returns `_initializing`\n */\n function _isInitializing() internal view returns (bool) {\n return _initializing;\n }\n}\n" }, "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (proxy/utils/UUPSUpgradeable.sol)\n\npragma solidity ^0.8.0;\n\nimport \"../../interfaces/draft-IERC1822Upgradeable.sol\";\nimport \"../ERC1967/ERC1967UpgradeUpgradeable.sol\";\nimport \"./Initializable.sol\";\n\n/**\n * @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an\n * {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.\n *\n * A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is\n * reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing\n * `UUPSUpgradeable` with a custom implementation of upgrades.\n *\n * The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.\n *\n * _Available since v4.1._\n */\nabstract contract UUPSUpgradeable is Initializable, IERC1822ProxiableUpgradeable, ERC1967UpgradeUpgradeable {\n function __UUPSUpgradeable_init() internal onlyInitializing {\n }\n\n function __UUPSUpgradeable_init_unchained() internal onlyInitializing {\n }\n /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment\n address private immutable __self = address(this);\n\n /**\n * @dev Check that the execution is being performed through a delegatecall call and that the execution context is\n * a proxy contract with an implementation (as defined in ERC1967) pointing to self. This should only be the case\n * for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a\n * function through ERC1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to\n * fail.\n */\n modifier onlyProxy() {\n require(address(this) != __self, \"Function must be called through delegatecall\");\n require(_getImplementation() == __self, \"Function must be called through active proxy\");\n _;\n }\n\n /**\n * @dev Check that the execution is not being performed through a delegate call. This allows a function to be\n * callable on the implementing contract but not through proxies.\n */\n modifier notDelegated() {\n require(address(this) == __self, \"UUPSUpgradeable: must not be called through delegatecall\");\n _;\n }\n\n /**\n * @dev Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the\n * implementation. It is used to validate the implementation's compatibility when performing an upgrade.\n *\n * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks\n * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this\n * function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.\n */\n function proxiableUUID() external view virtual override notDelegated returns (bytes32) {\n return _IMPLEMENTATION_SLOT;\n }\n\n /**\n * @dev Upgrade the implementation of the proxy to `newImplementation`.\n *\n * Calls {_authorizeUpgrade}.\n *\n * Emits an {Upgraded} event.\n */\n function upgradeTo(address newImplementation) external virtual onlyProxy {\n _authorizeUpgrade(newImplementation);\n _upgradeToAndCallUUPS(newImplementation, new bytes(0), false);\n }\n\n /**\n * @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call\n * encoded in `data`.\n *\n * Calls {_authorizeUpgrade}.\n *\n * Emits an {Upgraded} event.\n */\n function upgradeToAndCall(address newImplementation, bytes memory data) external payable virtual onlyProxy {\n _authorizeUpgrade(newImplementation);\n _upgradeToAndCallUUPS(newImplementation, data, true);\n }\n\n /**\n * @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by\n * {upgradeTo} and {upgradeToAndCall}.\n *\n * Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.\n *\n * ```solidity\n * function _authorizeUpgrade(address) internal override onlyOwner {}\n * ```\n */\n function _authorizeUpgrade(address newImplementation) internal virtual;\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[50] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)\n\npragma solidity ^0.8.0;\n\nimport \"./IERC20Upgradeable.sol\";\nimport \"./extensions/IERC20MetadataUpgradeable.sol\";\nimport \"../../utils/ContextUpgradeable.sol\";\nimport \"../../proxy/utils/Initializable.sol\";\n\n/**\n * @dev Implementation of the {IERC20} interface.\n *\n * This implementation is agnostic to the way tokens are created. This means\n * that a supply mechanism has to be added in a derived contract using {_mint}.\n * For a generic mechanism see {ERC20PresetMinterPauser}.\n *\n * TIP: For a detailed writeup see our guide\n * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How\n * to implement supply mechanisms].\n *\n * We have followed general OpenZeppelin Contracts guidelines: functions revert\n * instead returning `false` on failure. This behavior is nonetheless\n * conventional and does not conflict with the expectations of ERC20\n * applications.\n *\n * Additionally, an {Approval} event is emitted on calls to {transferFrom}.\n * This allows applications to reconstruct the allowance for all accounts just\n * by listening to said events. Other implementations of the EIP may not emit\n * these events, as it isn't required by the specification.\n *\n * Finally, the non-standard {decreaseAllowance} and {increaseAllowance}\n * functions have been added to mitigate the well-known issues around setting\n * allowances. See {IERC20-approve}.\n */\ncontract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20Upgradeable, IERC20MetadataUpgradeable {\n mapping(address => uint256) private _balances;\n\n mapping(address => mapping(address => uint256)) private _allowances;\n\n uint256 private _totalSupply;\n\n string private _name;\n string private _symbol;\n\n /**\n * @dev Sets the values for {name} and {symbol}.\n *\n * The default value of {decimals} is 18. To select a different value for\n * {decimals} you should overload it.\n *\n * All two of these values are immutable: they can only be set once during\n * construction.\n */\n function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {\n __ERC20_init_unchained(name_, symbol_);\n }\n\n function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {\n _name = name_;\n _symbol = symbol_;\n }\n\n /**\n * @dev Returns the name of the token.\n */\n function name() public view virtual override returns (string memory) {\n return _name;\n }\n\n /**\n * @dev Returns the symbol of the token, usually a shorter version of the\n * name.\n */\n function symbol() public view virtual override returns (string memory) {\n return _symbol;\n }\n\n /**\n * @dev Returns the number of decimals used to get its user representation.\n * For example, if `decimals` equals `2`, a balance of `505` tokens should\n * be displayed to a user as `5.05` (`505 / 10 ** 2`).\n *\n * Tokens usually opt for a value of 18, imitating the relationship between\n * Ether and Wei. This is the value {ERC20} uses, unless this function is\n * overridden;\n *\n * NOTE: This information is only used for _display_ purposes: it in\n * no way affects any of the arithmetic of the contract, including\n * {IERC20-balanceOf} and {IERC20-transfer}.\n */\n function decimals() public view virtual override returns (uint8) {\n return 18;\n }\n\n /**\n * @dev See {IERC20-totalSupply}.\n */\n function totalSupply() public view virtual override returns (uint256) {\n return _totalSupply;\n }\n\n /**\n * @dev See {IERC20-balanceOf}.\n */\n function balanceOf(address account) public view virtual override returns (uint256) {\n return _balances[account];\n }\n\n /**\n * @dev See {IERC20-transfer}.\n *\n * Requirements:\n *\n * - `to` cannot be the zero address.\n * - the caller must have a balance of at least `amount`.\n */\n function transfer(address to, uint256 amount) public virtual override returns (bool) {\n address owner = _msgSender();\n _transfer(owner, to, amount);\n return true;\n }\n\n /**\n * @dev See {IERC20-allowance}.\n */\n function allowance(address owner, address spender) public view virtual override returns (uint256) {\n return _allowances[owner][spender];\n }\n\n /**\n * @dev See {IERC20-approve}.\n *\n * NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on\n * `transferFrom`. This is semantically equivalent to an infinite approval.\n *\n * Requirements:\n *\n * - `spender` cannot be the zero address.\n */\n function approve(address spender, uint256 amount) public virtual override returns (bool) {\n address owner = _msgSender();\n _approve(owner, spender, amount);\n return true;\n }\n\n /**\n * @dev See {IERC20-transferFrom}.\n *\n * Emits an {Approval} event indicating the updated allowance. This is not\n * required by the EIP. See the note at the beginning of {ERC20}.\n *\n * NOTE: Does not update the allowance if the current allowance\n * is the maximum `uint256`.\n *\n * Requirements:\n *\n * - `from` and `to` cannot be the zero address.\n * - `from` must have a balance of at least `amount`.\n * - the caller must have allowance for ``from``'s tokens of at least\n * `amount`.\n */\n function transferFrom(\n address from,\n address to,\n uint256 amount\n ) public virtual override returns (bool) {\n address spender = _msgSender();\n _spendAllowance(from, spender, amount);\n _transfer(from, to, amount);\n return true;\n }\n\n /**\n * @dev Atomically increases the allowance granted to `spender` by the caller.\n *\n * This is an alternative to {approve} that can be used as a mitigation for\n * problems described in {IERC20-approve}.\n *\n * Emits an {Approval} event indicating the updated allowance.\n *\n * Requirements:\n *\n * - `spender` cannot be the zero address.\n */\n function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {\n address owner = _msgSender();\n _approve(owner, spender, allowance(owner, spender) + addedValue);\n return true;\n }\n\n /**\n * @dev Atomically decreases the allowance granted to `spender` by the caller.\n *\n * This is an alternative to {approve} that can be used as a mitigation for\n * problems described in {IERC20-approve}.\n *\n * Emits an {Approval} event indicating the updated allowance.\n *\n * Requirements:\n *\n * - `spender` cannot be the zero address.\n * - `spender` must have allowance for the caller of at least\n * `subtractedValue`.\n */\n function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {\n address owner = _msgSender();\n uint256 currentAllowance = allowance(owner, spender);\n require(currentAllowance >= subtractedValue, \"ERC20: decreased allowance below zero\");\n unchecked {\n _approve(owner, spender, currentAllowance - subtractedValue);\n }\n\n return true;\n }\n\n /**\n * @dev Moves `amount` of tokens from `from` to `to`.\n *\n * This internal function is equivalent to {transfer}, and can be used to\n * e.g. implement automatic token fees, slashing mechanisms, etc.\n *\n * Emits a {Transfer} event.\n *\n * Requirements:\n *\n * - `from` cannot be the zero address.\n * - `to` cannot be the zero address.\n * - `from` must have a balance of at least `amount`.\n */\n function _transfer(\n address from,\n address to,\n uint256 amount\n ) internal virtual {\n require(from != address(0), \"ERC20: transfer from the zero address\");\n require(to != address(0), \"ERC20: transfer to the zero address\");\n\n _beforeTokenTransfer(from, to, amount);\n\n uint256 fromBalance = _balances[from];\n require(fromBalance >= amount, \"ERC20: transfer amount exceeds balance\");\n unchecked {\n _balances[from] = fromBalance - amount;\n // Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by\n // decrementing then incrementing.\n _balances[to] += amount;\n }\n\n emit Transfer(from, to, amount);\n\n _afterTokenTransfer(from, to, amount);\n }\n\n /** @dev Creates `amount` tokens and assigns them to `account`, increasing\n * the total supply.\n *\n * Emits a {Transfer} event with `from` set to the zero address.\n *\n * Requirements:\n *\n * - `account` cannot be the zero address.\n */\n function _mint(address account, uint256 amount) internal virtual {\n require(account != address(0), \"ERC20: mint to the zero address\");\n\n _beforeTokenTransfer(address(0), account, amount);\n\n _totalSupply += amount;\n unchecked {\n // Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.\n _balances[account] += amount;\n }\n emit Transfer(address(0), account, amount);\n\n _afterTokenTransfer(address(0), account, amount);\n }\n\n /**\n * @dev Destroys `amount` tokens from `account`, reducing the\n * total supply.\n *\n * Emits a {Transfer} event with `to` set to the zero address.\n *\n * Requirements:\n *\n * - `account` cannot be the zero address.\n * - `account` must have at least `amount` tokens.\n */\n function _burn(address account, uint256 amount) internal virtual {\n require(account != address(0), \"ERC20: burn from the zero address\");\n\n _beforeTokenTransfer(account, address(0), amount);\n\n uint256 accountBalance = _balances[account];\n require(accountBalance >= amount, \"ERC20: burn amount exceeds balance\");\n unchecked {\n _balances[account] = accountBalance - amount;\n // Overflow not possible: amount <= accountBalance <= totalSupply.\n _totalSupply -= amount;\n }\n\n emit Transfer(account, address(0), amount);\n\n _afterTokenTransfer(account, address(0), amount);\n }\n\n /**\n * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.\n *\n * This internal function is equivalent to `approve`, and can be used to\n * e.g. set automatic allowances for certain subsystems, etc.\n *\n * Emits an {Approval} event.\n *\n * Requirements:\n *\n * - `owner` cannot be the zero address.\n * - `spender` cannot be the zero address.\n */\n function _approve(\n address owner,\n address spender,\n uint256 amount\n ) internal virtual {\n require(owner != address(0), \"ERC20: approve from the zero address\");\n require(spender != address(0), \"ERC20: approve to the zero address\");\n\n _allowances[owner][spender] = amount;\n emit Approval(owner, spender, amount);\n }\n\n /**\n * @dev Updates `owner` s allowance for `spender` based on spent `amount`.\n *\n * Does not update the allowance amount in case of infinite allowance.\n * Revert if not enough allowance is available.\n *\n * Might emit an {Approval} event.\n */\n function _spendAllowance(\n address owner,\n address spender,\n uint256 amount\n ) internal virtual {\n uint256 currentAllowance = allowance(owner, spender);\n if (currentAllowance != type(uint256).max) {\n require(currentAllowance >= amount, \"ERC20: insufficient allowance\");\n unchecked {\n _approve(owner, spender, currentAllowance - amount);\n }\n }\n }\n\n /**\n * @dev Hook that is called before any transfer of tokens. This includes\n * minting and burning.\n *\n * Calling conditions:\n *\n * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens\n * will be transferred to `to`.\n * - when `from` is zero, `amount` tokens will be minted for `to`.\n * - when `to` is zero, `amount` of ``from``'s tokens will be burned.\n * - `from` and `to` are never both zero.\n *\n * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].\n */\n function _beforeTokenTransfer(\n address from,\n address to,\n uint256 amount\n ) internal virtual {}\n\n /**\n * @dev Hook that is called after any transfer of tokens. This includes\n * minting and burning.\n *\n * Calling conditions:\n *\n * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens\n * has been transferred to `to`.\n * - when `from` is zero, `amount` tokens have been minted for `to`.\n * - when `to` is zero, `amount` of ``from``'s tokens have been burned.\n * - `from` and `to` are never both zero.\n *\n * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].\n */\n function _afterTokenTransfer(\n address from,\n address to,\n uint256 amount\n ) internal virtual {}\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[45] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)\n\npragma solidity ^0.8.0;\n\nimport \"../IERC20Upgradeable.sol\";\n\n/**\n * @dev Interface for the optional metadata functions from the ERC20 standard.\n *\n * _Available since v4.1._\n */\ninterface IERC20MetadataUpgradeable is IERC20Upgradeable {\n /**\n * @dev Returns the name of the token.\n */\n function name() external view returns (string memory);\n\n /**\n * @dev Returns the symbol of the token.\n */\n function symbol() external view returns (string memory);\n\n /**\n * @dev Returns the decimals places of the token.\n */\n function decimals() external view returns (uint8);\n}\n" }, "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Interface of the ERC20 standard as defined in the EIP.\n */\ninterface IERC20Upgradeable {\n /**\n * @dev Emitted when `value` tokens are moved from one account (`from`) to\n * another (`to`).\n *\n * Note that `value` may be zero.\n */\n event Transfer(address indexed from, address indexed to, uint256 value);\n\n /**\n * @dev Emitted when the allowance of a `spender` for an `owner` is set by\n * a call to {approve}. `value` is the new allowance.\n */\n event Approval(address indexed owner, address indexed spender, uint256 value);\n\n /**\n * @dev Returns the amount of tokens in existence.\n */\n function totalSupply() external view returns (uint256);\n\n /**\n * @dev Returns the amount of tokens owned by `account`.\n */\n function balanceOf(address account) external view returns (uint256);\n\n /**\n * @dev Moves `amount` tokens from the caller's account to `to`.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * Emits a {Transfer} event.\n */\n function transfer(address to, uint256 amount) external returns (bool);\n\n /**\n * @dev Returns the remaining number of tokens that `spender` will be\n * allowed to spend on behalf of `owner` through {transferFrom}. This is\n * zero by default.\n *\n * This value changes when {approve} or {transferFrom} are called.\n */\n function allowance(address owner, address spender) external view returns (uint256);\n\n /**\n * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * IMPORTANT: Beware that changing an allowance with this method brings the risk\n * that someone may use both the old and the new allowance by unfortunate\n * transaction ordering. One possible solution to mitigate this race\n * condition is to first reduce the spender's allowance to 0 and set the\n * desired value afterwards:\n * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729\n *\n * Emits an {Approval} event.\n */\n function approve(address spender, uint256 amount) external returns (bool);\n\n /**\n * @dev Moves `amount` tokens from `from` to `to` using the\n * allowance mechanism. `amount` is then deducted from the caller's\n * allowance.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * Emits a {Transfer} event.\n */\n function transferFrom(\n address from,\n address to,\n uint256 amount\n ) external returns (bool);\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)\n\npragma solidity ^0.8.1;\n\n/**\n * @dev Collection of functions related to the address type\n */\nlibrary AddressUpgradeable {\n /**\n * @dev Returns true if `account` is a contract.\n *\n * [IMPORTANT]\n * ====\n * It is unsafe to assume that an address for which this function returns\n * false is an externally-owned account (EOA) and not a contract.\n *\n * Among others, `isContract` will return false for the following\n * types of addresses:\n *\n * - an externally-owned account\n * - a contract in construction\n * - an address where a contract will be created\n * - an address where a contract lived, but was destroyed\n * ====\n *\n * [IMPORTANT]\n * ====\n * You shouldn't rely on `isContract` to protect against flash loan attacks!\n *\n * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets\n * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract\n * constructor.\n * ====\n */\n function isContract(address account) internal view returns (bool) {\n // This method relies on extcodesize/address.code.length, which returns 0\n // for contracts in construction, since the code is only stored at the end\n // of the constructor execution.\n\n return account.code.length > 0;\n }\n\n /**\n * @dev Replacement for Solidity's `transfer`: sends `amount` wei to\n * `recipient`, forwarding all available gas and reverting on errors.\n *\n * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost\n * of certain opcodes, possibly making contracts go over the 2300 gas limit\n * imposed by `transfer`, making them unable to receive funds via\n * `transfer`. {sendValue} removes this limitation.\n *\n * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].\n *\n * IMPORTANT: because control is transferred to `recipient`, care must be\n * taken to not create reentrancy vulnerabilities. Consider using\n * {ReentrancyGuard} or the\n * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].\n */\n function sendValue(address payable recipient, uint256 amount) internal {\n require(address(this).balance >= amount, \"Address: insufficient balance\");\n\n (bool success, ) = recipient.call{value: amount}(\"\");\n require(success, \"Address: unable to send value, recipient may have reverted\");\n }\n\n /**\n * @dev Performs a Solidity function call using a low level `call`. A\n * plain `call` is an unsafe replacement for a function call: use this\n * function instead.\n *\n * If `target` reverts with a revert reason, it is bubbled up by this\n * function (like regular Solidity function calls).\n *\n * Returns the raw returned data. To convert to the expected return value,\n * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].\n *\n * Requirements:\n *\n * - `target` must be a contract.\n * - calling `target` with `data` must not revert.\n *\n * _Available since v3.1._\n */\n function functionCall(address target, bytes memory data) internal returns (bytes memory) {\n return functionCallWithValue(target, data, 0, \"Address: low-level call failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with\n * `errorMessage` as a fallback revert reason when `target` reverts.\n *\n * _Available since v3.1._\n */\n function functionCall(\n address target,\n bytes memory data,\n string memory errorMessage\n ) internal returns (bytes memory) {\n return functionCallWithValue(target, data, 0, errorMessage);\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],\n * but also transferring `value` wei to `target`.\n *\n * Requirements:\n *\n * - the calling contract must have an ETH balance of at least `value`.\n * - the called Solidity function must be `payable`.\n *\n * _Available since v3.1._\n */\n function functionCallWithValue(\n address target,\n bytes memory data,\n uint256 value\n ) internal returns (bytes memory) {\n return functionCallWithValue(target, data, value, \"Address: low-level call with value failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but\n * with `errorMessage` as a fallback revert reason when `target` reverts.\n *\n * _Available since v3.1._\n */\n function functionCallWithValue(\n address target,\n bytes memory data,\n uint256 value,\n string memory errorMessage\n ) internal returns (bytes memory) {\n require(address(this).balance >= value, \"Address: insufficient balance for call\");\n (bool success, bytes memory returndata) = target.call{value: value}(data);\n return verifyCallResultFromTarget(target, success, returndata, errorMessage);\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],\n * but performing a static call.\n *\n * _Available since v3.3._\n */\n function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {\n return functionStaticCall(target, data, \"Address: low-level static call failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],\n * but performing a static call.\n *\n * _Available since v3.3._\n */\n function functionStaticCall(\n address target,\n bytes memory data,\n string memory errorMessage\n ) internal view returns (bytes memory) {\n (bool success, bytes memory returndata) = target.staticcall(data);\n return verifyCallResultFromTarget(target, success, returndata, errorMessage);\n }\n\n /**\n * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling\n * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.\n *\n * _Available since v4.8._\n */\n function verifyCallResultFromTarget(\n address target,\n bool success,\n bytes memory returndata,\n string memory errorMessage\n ) internal view returns (bytes memory) {\n if (success) {\n if (returndata.length == 0) {\n // only check isContract if the call was successful and the return data is empty\n // otherwise we already know that it was a contract\n require(isContract(target), \"Address: call to non-contract\");\n }\n return returndata;\n } else {\n _revert(returndata, errorMessage);\n }\n }\n\n /**\n * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the\n * revert reason or using the provided one.\n *\n * _Available since v4.3._\n */\n function verifyCallResult(\n bool success,\n bytes memory returndata,\n string memory errorMessage\n ) internal pure returns (bytes memory) {\n if (success) {\n return returndata;\n } else {\n _revert(returndata, errorMessage);\n }\n }\n\n function _revert(bytes memory returndata, string memory errorMessage) private pure {\n // Look for revert reason and bubble it up if present\n if (returndata.length > 0) {\n // The easiest way to bubble the revert reason is using memory via assembly\n /// @solidity memory-safe-assembly\n assembly {\n let returndata_size := mload(returndata)\n revert(add(32, returndata), returndata_size)\n }\n } else {\n revert(errorMessage);\n }\n }\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)\n\npragma solidity ^0.8.0;\nimport \"../proxy/utils/Initializable.sol\";\n\n/**\n * @dev Provides information about the current execution context, including the\n * sender of the transaction and its data. While these are generally available\n * via msg.sender and msg.data, they should not be accessed in such a direct\n * manner, since when dealing with meta-transactions the account sending and\n * paying for execution may not be the actual sender (as far as an application\n * is concerned).\n *\n * This contract is only required for intermediate, library-like contracts.\n */\nabstract contract ContextUpgradeable is Initializable {\n function __Context_init() internal onlyInitializing {\n }\n\n function __Context_init_unchained() internal onlyInitializing {\n }\n function _msgSender() internal view virtual returns (address) {\n return msg.sender;\n }\n\n function _msgData() internal view virtual returns (bytes calldata) {\n return msg.data;\n }\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[50] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)\n\npragma solidity ^0.8.0;\n\nimport \"./IERC165Upgradeable.sol\";\nimport \"../../proxy/utils/Initializable.sol\";\n\n/**\n * @dev Implementation of the {IERC165} interface.\n *\n * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check\n * for the additional interface id that will be supported. For example:\n *\n * ```solidity\n * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {\n * return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);\n * }\n * ```\n *\n * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.\n */\nabstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {\n function __ERC165_init() internal onlyInitializing {\n }\n\n function __ERC165_init_unchained() internal onlyInitializing {\n }\n /**\n * @dev See {IERC165-supportsInterface}.\n */\n function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {\n return interfaceId == type(IERC165Upgradeable).interfaceId;\n }\n\n /**\n * @dev This empty reserved space is put in place to allow future versions to add new\n * variables without shifting down storage in the inheritance chain.\n * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps\n */\n uint256[50] private __gap;\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/introspection/IERC165Upgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Interface of the ERC165 standard, as defined in the\n * https://eips.ethereum.org/EIPS/eip-165[EIP].\n *\n * Implementers can declare support of contract interfaces, which can then be\n * queried by others ({ERC165Checker}).\n *\n * For an implementation, see {ERC165}.\n */\ninterface IERC165Upgradeable {\n /**\n * @dev Returns true if this contract implements the interface defined by\n * `interfaceId`. See the corresponding\n * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]\n * to learn more about how these ids are created.\n *\n * This function call must use less than 30 000 gas.\n */\n function supportsInterface(bytes4 interfaceId) external view returns (bool);\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/math/MathUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/Math.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Standard math utilities missing in the Solidity language.\n */\nlibrary MathUpgradeable {\n enum Rounding {\n Down, // Toward negative infinity\n Up, // Toward infinity\n Zero // Toward zero\n }\n\n /**\n * @dev Returns the largest of two numbers.\n */\n function max(uint256 a, uint256 b) internal pure returns (uint256) {\n return a > b ? a : b;\n }\n\n /**\n * @dev Returns the smallest of two numbers.\n */\n function min(uint256 a, uint256 b) internal pure returns (uint256) {\n return a < b ? a : b;\n }\n\n /**\n * @dev Returns the average of two numbers. The result is rounded towards\n * zero.\n */\n function average(uint256 a, uint256 b) internal pure returns (uint256) {\n // (a + b) / 2 can overflow.\n return (a & b) + (a ^ b) / 2;\n }\n\n /**\n * @dev Returns the ceiling of the division of two numbers.\n *\n * This differs from standard division with `/` in that it rounds up instead\n * of rounding down.\n */\n function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {\n // (a + b - 1) / b can overflow on addition, so we distribute.\n return a == 0 ? 0 : (a - 1) / b + 1;\n }\n\n /**\n * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0\n * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)\n * with further edits by Uniswap Labs also under MIT license.\n */\n function mulDiv(\n uint256 x,\n uint256 y,\n uint256 denominator\n ) internal pure returns (uint256 result) {\n unchecked {\n // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use\n // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256\n // variables such that product = prod1 * 2^256 + prod0.\n uint256 prod0; // Least significant 256 bits of the product\n uint256 prod1; // Most significant 256 bits of the product\n assembly {\n let mm := mulmod(x, y, not(0))\n prod0 := mul(x, y)\n prod1 := sub(sub(mm, prod0), lt(mm, prod0))\n }\n\n // Handle non-overflow cases, 256 by 256 division.\n if (prod1 == 0) {\n return prod0 / denominator;\n }\n\n // Make sure the result is less than 2^256. Also prevents denominator == 0.\n require(denominator > prod1);\n\n ///////////////////////////////////////////////\n // 512 by 256 division.\n ///////////////////////////////////////////////\n\n // Make division exact by subtracting the remainder from [prod1 prod0].\n uint256 remainder;\n assembly {\n // Compute remainder using mulmod.\n remainder := mulmod(x, y, denominator)\n\n // Subtract 256 bit number from 512 bit number.\n prod1 := sub(prod1, gt(remainder, prod0))\n prod0 := sub(prod0, remainder)\n }\n\n // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.\n // See https://cs.stackexchange.com/q/138556/92363.\n\n // Does not overflow because the denominator cannot be zero at this stage in the function.\n uint256 twos = denominator & (~denominator + 1);\n assembly {\n // Divide denominator by twos.\n denominator := div(denominator, twos)\n\n // Divide [prod1 prod0] by twos.\n prod0 := div(prod0, twos)\n\n // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.\n twos := add(div(sub(0, twos), twos), 1)\n }\n\n // Shift in bits from prod1 into prod0.\n prod0 |= prod1 * twos;\n\n // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such\n // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for\n // four bits. That is, denominator * inv = 1 mod 2^4.\n uint256 inverse = (3 * denominator) ^ 2;\n\n // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works\n // in modular arithmetic, doubling the correct bits in each step.\n inverse *= 2 - denominator * inverse; // inverse mod 2^8\n inverse *= 2 - denominator * inverse; // inverse mod 2^16\n inverse *= 2 - denominator * inverse; // inverse mod 2^32\n inverse *= 2 - denominator * inverse; // inverse mod 2^64\n inverse *= 2 - denominator * inverse; // inverse mod 2^128\n inverse *= 2 - denominator * inverse; // inverse mod 2^256\n\n // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.\n // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is\n // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1\n // is no longer required.\n result = prod0 * inverse;\n return result;\n }\n }\n\n /**\n * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.\n */\n function mulDiv(\n uint256 x,\n uint256 y,\n uint256 denominator,\n Rounding rounding\n ) internal pure returns (uint256) {\n uint256 result = mulDiv(x, y, denominator);\n if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {\n result += 1;\n }\n return result;\n }\n\n /**\n * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.\n *\n * Inspired by Henry S. Warren, Jr.'s \"Hacker's Delight\" (Chapter 11).\n */\n function sqrt(uint256 a) internal pure returns (uint256) {\n if (a == 0) {\n return 0;\n }\n\n // For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.\n //\n // We know that the \"msb\" (most significant bit) of our target number `a` is a power of 2 such that we have\n // `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.\n //\n // This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`\n // → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`\n // → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`\n //\n // Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.\n uint256 result = 1 << (log2(a) >> 1);\n\n // At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,\n // since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at\n // every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision\n // into the expected uint128 result.\n unchecked {\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n result = (result + a / result) >> 1;\n return min(result, a / result);\n }\n }\n\n /**\n * @notice Calculates sqrt(a), following the selected rounding direction.\n */\n function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {\n unchecked {\n uint256 result = sqrt(a);\n return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);\n }\n }\n\n /**\n * @dev Return the log in base 2, rounded down, of a positive value.\n * Returns 0 if given 0.\n */\n function log2(uint256 value) internal pure returns (uint256) {\n uint256 result = 0;\n unchecked {\n if (value >> 128 > 0) {\n value >>= 128;\n result += 128;\n }\n if (value >> 64 > 0) {\n value >>= 64;\n result += 64;\n }\n if (value >> 32 > 0) {\n value >>= 32;\n result += 32;\n }\n if (value >> 16 > 0) {\n value >>= 16;\n result += 16;\n }\n if (value >> 8 > 0) {\n value >>= 8;\n result += 8;\n }\n if (value >> 4 > 0) {\n value >>= 4;\n result += 4;\n }\n if (value >> 2 > 0) {\n value >>= 2;\n result += 2;\n }\n if (value >> 1 > 0) {\n result += 1;\n }\n }\n return result;\n }\n\n /**\n * @dev Return the log in base 2, following the selected rounding direction, of a positive value.\n * Returns 0 if given 0.\n */\n function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {\n unchecked {\n uint256 result = log2(value);\n return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);\n }\n }\n\n /**\n * @dev Return the log in base 10, rounded down, of a positive value.\n * Returns 0 if given 0.\n */\n function log10(uint256 value) internal pure returns (uint256) {\n uint256 result = 0;\n unchecked {\n if (value >= 10**64) {\n value /= 10**64;\n result += 64;\n }\n if (value >= 10**32) {\n value /= 10**32;\n result += 32;\n }\n if (value >= 10**16) {\n value /= 10**16;\n result += 16;\n }\n if (value >= 10**8) {\n value /= 10**8;\n result += 8;\n }\n if (value >= 10**4) {\n value /= 10**4;\n result += 4;\n }\n if (value >= 10**2) {\n value /= 10**2;\n result += 2;\n }\n if (value >= 10**1) {\n result += 1;\n }\n }\n return result;\n }\n\n /**\n * @dev Return the log in base 10, following the selected rounding direction, of a positive value.\n * Returns 0 if given 0.\n */\n function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {\n unchecked {\n uint256 result = log10(value);\n return result + (rounding == Rounding.Up && 10**result < value ? 1 : 0);\n }\n }\n\n /**\n * @dev Return the log in base 256, rounded down, of a positive value.\n * Returns 0 if given 0.\n *\n * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.\n */\n function log256(uint256 value) internal pure returns (uint256) {\n uint256 result = 0;\n unchecked {\n if (value >> 128 > 0) {\n value >>= 128;\n result += 16;\n }\n if (value >> 64 > 0) {\n value >>= 64;\n result += 8;\n }\n if (value >> 32 > 0) {\n value >>= 32;\n result += 4;\n }\n if (value >> 16 > 0) {\n value >>= 16;\n result += 2;\n }\n if (value >> 8 > 0) {\n result += 1;\n }\n }\n return result;\n }\n\n /**\n * @dev Return the log in base 10, following the selected rounding direction, of a positive value.\n * Returns 0 if given 0.\n */\n function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {\n unchecked {\n uint256 result = log256(value);\n return result + (rounding == Rounding.Up && 1 << (result * 8) < value ? 1 : 0);\n }\n }\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/StorageSlotUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.7.0) (utils/StorageSlot.sol)\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Library for reading and writing primitive types to specific storage slots.\n *\n * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.\n * This library helps with reading and writing to such slots without the need for inline assembly.\n *\n * The functions in this library return Slot structs that contain a `value` member that can be used to read or write.\n *\n * Example usage to set ERC1967 implementation slot:\n * ```\n * contract ERC1967 {\n * bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;\n *\n * function _getImplementation() internal view returns (address) {\n * return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;\n * }\n *\n * function _setImplementation(address newImplementation) internal {\n * require(Address.isContract(newImplementation), \"ERC1967: new implementation is not a contract\");\n * StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;\n * }\n * }\n * ```\n *\n * _Available since v4.1 for `address`, `bool`, `bytes32`, and `uint256`._\n */\nlibrary StorageSlotUpgradeable {\n struct AddressSlot {\n address value;\n }\n\n struct BooleanSlot {\n bool value;\n }\n\n struct Bytes32Slot {\n bytes32 value;\n }\n\n struct Uint256Slot {\n uint256 value;\n }\n\n /**\n * @dev Returns an `AddressSlot` with member `value` located at `slot`.\n */\n function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {\n /// @solidity memory-safe-assembly\n assembly {\n r.slot := slot\n }\n }\n\n /**\n * @dev Returns an `BooleanSlot` with member `value` located at `slot`.\n */\n function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {\n /// @solidity memory-safe-assembly\n assembly {\n r.slot := slot\n }\n }\n\n /**\n * @dev Returns an `Bytes32Slot` with member `value` located at `slot`.\n */\n function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {\n /// @solidity memory-safe-assembly\n assembly {\n r.slot := slot\n }\n }\n\n /**\n * @dev Returns an `Uint256Slot` with member `value` located at `slot`.\n */\n function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {\n /// @solidity memory-safe-assembly\n assembly {\n r.slot := slot\n }\n }\n}\n" }, "@openzeppelin/contracts-upgradeable/utils/StringsUpgradeable.sol": { "content": "// SPDX-License-Identifier: MIT\n// OpenZeppelin Contracts (last updated v4.8.0) (utils/Strings.sol)\n\npragma solidity ^0.8.0;\n\nimport \"./math/MathUpgradeable.sol\";\n\n/**\n * @dev String operations.\n */\nlibrary StringsUpgradeable {\n bytes16 private constant _SYMBOLS = \"0123456789abcdef\";\n uint8 private constant _ADDRESS_LENGTH = 20;\n\n /**\n * @dev Converts a `uint256` to its ASCII `string` decimal representation.\n */\n function toString(uint256 value) internal pure returns (string memory) {\n unchecked {\n uint256 length = MathUpgradeable.log10(value) + 1;\n string memory buffer = new string(length);\n uint256 ptr;\n /// @solidity memory-safe-assembly\n assembly {\n ptr := add(buffer, add(32, length))\n }\n while (true) {\n ptr--;\n /// @solidity memory-safe-assembly\n assembly {\n mstore8(ptr, byte(mod(value, 10), _SYMBOLS))\n }\n value /= 10;\n if (value == 0) break;\n }\n return buffer;\n }\n }\n\n /**\n * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.\n */\n function toHexString(uint256 value) internal pure returns (string memory) {\n unchecked {\n return toHexString(value, MathUpgradeable.log256(value) + 1);\n }\n }\n\n /**\n * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.\n */\n function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {\n bytes memory buffer = new bytes(2 * length + 2);\n buffer[0] = \"0\";\n buffer[1] = \"x\";\n for (uint256 i = 2 * length + 1; i > 1; --i) {\n buffer[i] = _SYMBOLS[value & 0xf];\n value >>= 4;\n }\n require(value == 0, \"Strings: hex length insufficient\");\n return string(buffer);\n }\n\n /**\n * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.\n */\n function toHexString(address addr) internal pure returns (string memory) {\n return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);\n }\n}\n" }, "contracts/common/BaseGovernanceWithUserUpgradable.sol": { "content": "// SPDX-License-Identifier: Unlicensed\r\npragma solidity ^0.8.0;\r\n\r\nimport \"@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol\";\r\n\r\n/**\r\n * @title Base contract which can be upgraded by Governance and requires user authorization for the upgrade\r\n */\r\nabstract contract BaseGovernanceWithUserUpgradable is Initializable, ContextUpgradeable, UUPSUpgradeable, AccessControlUpgradeable {\r\n\r\n bytes32 public constant GOVERNANCE_ROLE = keccak256(\"GOVERNANCE_ROLE\");\r\n bytes32 public constant UPGRADE_MANAGER_ROLE = keccak256(\"UPGRADE_MANAGER_ROLE\");\r\n\r\n address private _proposedUpgrade;\r\n\r\n function getImplementation() public view returns(address) {\r\n return _getImplementation();\r\n }\r\n\r\n function __BaseGovernanceWithUser_init() internal onlyInitializing {\r\n __Context_init_unchained();\r\n __ERC165_init_unchained();\r\n __ERC1967Upgrade_init_unchained();\r\n __UUPSUpgradeable_init_unchained();\r\n __AccessControl_init_unchained();\r\n __BaseGovernanceWithUser_init_unchained();\r\n }\r\n\r\n function __BaseGovernanceWithUser_init_unchained() internal onlyInitializing {\r\n _setupRole(DEFAULT_ADMIN_ROLE, _msgSender()); // Grant DEFAULT_ADMIN to creator. Other role management scan be performed elswhere\r\n _setupRole(GOVERNANCE_ROLE, _msgSender());\r\n _setupRole(UPGRADE_MANAGER_ROLE, _msgSender());\r\n _setRoleAdmin(UPGRADE_MANAGER_ROLE, GOVERNANCE_ROLE);\r\n }\r\n\r\n function _authorizeUpgrade(address /*newImplementation*/) internal virtual override {\r\n require(\r\n hasRole(GOVERNANCE_ROLE, msg.sender) || hasRole(UPGRADE_MANAGER_ROLE, msg.sender), \r\n \"ERROR: Address not authorized\"\r\n );\r\n }\r\n\r\n\r\n function proposeNewImplementation(address implementationAddress) external onlyRole(GOVERNANCE_ROLE) {\r\n _proposedUpgrade = implementationAddress; \r\n }\r\n \r\n uint256[50] private __gap;\r\n}" }, "contracts/ERC20Base.sol": { "content": "// contracts/ERC20Base.sol\r\n// SPDX-License-Identifier: MIT\r\npragma solidity ^0.8.0;\r\n\r\nimport \"@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol\";\r\nimport \"./common/BaseGovernanceWithUserUpgradable.sol\";\r\n\r\nabstract contract ERC20Base is ERC20Upgradeable, BaseGovernanceWithUserUpgradable{\r\n uint8 private _decimals;\r\n\r\n function __ERC20Base_init(\r\n string memory name_, \r\n string memory symbol_, \r\n uint8 decimals_, \r\n uint256 amount_ \r\n ) internal onlyInitializing {\r\n __BaseGovernanceWithUser_init();\r\n __ERC20_init_unchained(name_, symbol_);\r\n __ERC20Base_init_unchained(decimals_, amount_);\r\n }\r\n\r\n function __ERC20Base_init_unchained(\r\n uint8 decimals_, \r\n uint256 amount_ \r\n ) internal onlyInitializing {\r\n _decimals = decimals_;\r\n _mint(_msgSender(), amount_);\r\n }\r\n\r\n function decimals() public view virtual override(ERC20Upgradeable) returns (uint8) {\r\n return _decimals;\r\n }\r\n}" }, "contracts/extensions/ERC20SnapshotRewrited.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../ERC20Base.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/utils/math/MathUpgradeable.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/utils/StorageSlotUpgradeable.sol\";\r\n\r\nimport \"../utils/ArrayStorageSlot.sol\";\r\nimport \"../utils/MappingStorageSlot.sol\";\r\n\r\n/**\r\n * This is a rewrite from OZ Contratcs to use the StorageSlot Library funcionalities, even with arrays and mappings. Enjoy!\r\n\r\n * @dev This contract extends an ERC20 token with a snapshot mechanism. When a snapshot is created, the balances and\r\n * total supply at the time are recorded for later access.\r\n *\r\n * This can be used to safely create mechanisms based on token balances such as trustless dividends or weighted voting.\r\n * In naive implementations it's possible to perform a \"double spend\" attack by reusing the same balance from different\r\n * accounts. By using snapshots to calculate dividends or voting power, those attacks no longer apply. It can also be\r\n * used to create an efficient ERC20 forking mechanism.\r\n *\r\n * Snapshots are created by the internal {_snapshot} function, which will emit the {Snapshot} event and return a\r\n * snapshot id. To get the total supply at the time of a snapshot, call the function {totalSupplyAt} with the snapshot\r\n * id. To get the balance of an account at the time of a snapshot, call the {balanceOfAt} function with the snapshot id\r\n * and the account address.\r\n *\r\n * NOTE: Snapshot policy can be customized by overriding the {_getCurrentSnapshotId} method. For example, having it\r\n * return `block.number` will trigger the creation of snapshot at the begining of each new block. When overridding this\r\n * function, be careful about the monotonicity of its result. Non-monotonic snapshot ids will break the contract.\r\n *\r\n * Implementing snapshots for every block using this method will incur significant gas costs. For a gas-efficient\r\n * alternative consider {ERC20Votes}.\r\n *\r\n * ==== Gas Costs\r\n *\r\n * Snapshots are efficient. Snapshot creation is _O(1)_. Retrieval of balances or total supply from a snapshot is _O(log\r\n * n)_ in the number of snapshots that have been created, although _n_ for a specific account will generally be much\r\n * smaller since identical balances in subsequent snapshots are stored as a single entry.\r\n *\r\n * There is a constant overhead for normal ERC20 transfers due to the additional snapshot bookkeeping. This overhead is\r\n * only significant for the first transfer that immediately follows a snapshot for a particular account. Subsequent\r\n * transfers will have normal cost until the next snapshot, and so on.\r\n */\r\n\r\nabstract contract ERC20SnapshotRewrited is ERC20Base {\r\n // Inspired by Jordi Baylina's MiniMeToken to record historical balances:\r\n // https://github.com/Giveth/minimd/blob/ea04d950eea153a04c51fa510b068b9dded390cb/contracts/MiniMeToken.sol\r\n\r\n\r\n // Snapshotted values have arrays of ids and the value corresponding to that id. These could be an array of a\r\n // Snapshot struct, but that would impede usage of functions that work on an array.\r\n struct Snapshots {\r\n uint256[] ids;\r\n uint256[] values;\r\n }\r\n\r\n bytes32 internal constant SLOT_TOTAL_SUPPLY_SNAPSHOTST_IDS= keccak256(\"polkalokr.oz.token.erc20.extensions.erc20snapshot.snapshots.ids\");\r\n bytes32 internal constant SLOT_TOTAL_SUPPLY_SNAPSHOTST_VALUES= keccak256(\"polkalokr.oz.token.erc20.extensions.erc20snapshot.snapshots.values\");\r\n\r\n bytes32 internal constant ACCOUNT_BALANCE_SNAPSHOTS_SLOT = keccak256(\"polkalokr.oz.token.erc20.extensions.erc20snapshot._accountBalanceSnapshots\");\r\n \r\n // Snapshot ids increase monotonically, with the first value being 1. An id of 0 is invalid.\r\n bytes32 internal constant CURRENT_SNAPSHOT_ID= keccak256(\"polkalokr.oz.token.erc20.extensions.erc20snapshot._currentSnapshotId\");\r\n\r\n\r\n /**\r\n * @dev Emitted by {_snapshot} when a snapshot identified by `id` is created.\r\n */\r\n event Snapshot(uint256 id);\r\n\r\n /**\r\n * @dev Creates a new snapshot and returns its snapshot id.\r\n *\r\n * Emits a {Snapshot} event that contains the same id.\r\n *\r\n * {_snapshot} is `internal` and you have to decide how to expose it externally. Its usage may be restricted to a\r\n * set of accounts, for example using {AccessControl}, or it may be open to the public.\r\n *\r\n * [WARNING]\r\n * ====\r\n * While an open way of calling {_snapshot} is required for certain trust minimization mechanisms such as forking,\r\n * you must consider that it can potentially be used by attackers in two ways.\r\n *\r\n * First, it can be used to increase the cost of retrieval of values from snapshots, although it will grow\r\n * logarithmically thus rendering this attack ineffective in the long term. Second, it can be used to target\r\n * specific accounts and increase the cost of ERC20 transfers for them, in the ways specified in the Gas Costs\r\n * section above.\r\n *\r\n * We haven't measured the actual numbers; if this is something you're interested in please reach out to us.\r\n * ====\r\n */\r\n function _snapshot() internal virtual returns (uint256) {\r\n StorageSlotUpgradeable.getUint256Slot(CURRENT_SNAPSHOT_ID).value +=1;\r\n\r\n uint256 currentId = _getCurrentSnapshotId();\r\n emit Snapshot(currentId);\r\n return currentId;\r\n }\r\n\r\n /**\r\n * @dev Get the current snapshotId\r\n */\r\n function _getCurrentSnapshotId() internal view virtual returns (uint256) {\r\n return StorageSlotUpgradeable.getUint256Slot(CURRENT_SNAPSHOT_ID).value;\r\n }\r\n\r\n /**\r\n * @dev Retrieves the balance of `account` at the time `snapshotId` was created.\r\n */\r\n function balanceOfAt(address account, uint256 snapshotId) public view virtual returns (uint256) {\r\n bytes32 slotIds = keccak256(abi.encode(account, ACCOUNT_BALANCE_SNAPSHOTS_SLOT));\r\n bytes32 slotValues = bytes32(uint256(slotIds) + 1);\r\n (bool snapshotted, uint256 value) = \r\n _valueAt(snapshotId, slotIds, slotValues);\r\n\r\n return snapshotted ? value : balanceOf(account);\r\n }\r\n\r\n /**\r\n * @dev Retrieves the total supply at the time `snapshotId` was created.\r\n */\r\n function totalSupplyAt(uint256 snapshotId) public view virtual returns (uint256) {\r\n (bool snapshotted, uint256 value) = \r\n _valueAt(snapshotId, SLOT_TOTAL_SUPPLY_SNAPSHOTST_IDS, SLOT_TOTAL_SUPPLY_SNAPSHOTST_VALUES);\r\n\r\n return snapshotted ? value : totalSupply();\r\n }\r\n\r\n // Update balance and/or total supply snapshots before the values are modified. This is implemented\r\n // in the _beforeTokenTransfer hook, which is executed for _mint, _burn, and _transfer operations.\r\n function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual override {\r\n super._beforeTokenTransfer(from, to, amount);\r\n\r\n if (from == address(0)) {\r\n // mint\r\n _updateAccountSnapshot(to);\r\n _updateTotalSupplySnapshot();\r\n } else if (to == address(0)) {\r\n // burn\r\n _updateAccountSnapshot(from);\r\n _updateTotalSupplySnapshot();\r\n } else {\r\n // transfer\r\n _updateAccountSnapshot(from);\r\n _updateAccountSnapshot(to);\r\n }\r\n }\r\n\r\n function _valueAt(uint256 snapshotId, bytes32 slotIds, bytes32 slotValues) private view returns (bool, uint256) {\r\n require(snapshotId > 0, \"ERC20Snapshot: id is 0\");\r\n require(snapshotId <= _getCurrentSnapshotId(), \"ERC20Snapshot: nonexistent id\");\r\n /*\r\n When a valid snapshot is queried, there are three possibilities:\r\n a) The queried value was not modified after the snapshot was taken. Therefore, a snapshot entry was never\r\n created for this id, and all stored snapshot ids are smaller than the requested one. The value that corresponds\r\n to this id is the current one.\r\n b) The queried value was modified after the snapshot was taken. Therefore, there will be an entry with the\r\n requested id, and its value is the one to return.\r\n c) More snapshots were created after the requested one, and the queried value was later modified. There will be\r\n no entry for the requested id: the value that corresponds to it is that of the smallest snapshot id that is\r\n larger than the requested one.\r\n \r\n In summary, we need to find an element in an array, returning the index of the smallest value that is larger if\r\n it is not found, unless said value doesn't exist (e.g. when all values are smaller). Arrays.findUpperBound does\r\n exactly this.\r\n */\r\n uint index = _findUpperBound(slotIds, snapshotId);\r\n\r\n if (index == ArrayStorageSlot.length(slotIds).value) {\r\n return (false, 0);\r\n } else {\r\n \r\n return (true, ArrayStorageSlot.getUint256Slot(slotValues, index).value);\r\n }\r\n }\r\n\r\n function _updateAccountSnapshot(address account) private {\r\n bytes32 slotIds = keccak256(abi.encode(account, ACCOUNT_BALANCE_SNAPSHOTS_SLOT));\r\n bytes32 slotValues = bytes32(uint256(slotIds) + 1);\r\n _updateSnapshot(slotIds, slotValues, balanceOf(account));\r\n }\r\n\r\n function _updateTotalSupplySnapshot() private {\r\n _updateSnapshot(SLOT_TOTAL_SUPPLY_SNAPSHOTST_IDS, SLOT_TOTAL_SUPPLY_SNAPSHOTST_VALUES, totalSupply());\r\n }\r\n\r\n function _updateSnapshot(bytes32 _slotIds, bytes32 _slotValues, uint256 currentValue) private {\r\n uint256 currentId = _getCurrentSnapshotId();\r\n if (_lastSnapshotId(_slotIds) < currentId) {\r\n ArrayStorageSlot.push(_slotIds, currentId);\r\n ArrayStorageSlot.push(_slotValues, currentValue);\r\n }\r\n }\r\n\r\n function _lastSnapshotId(bytes32 slotIds) private view returns (uint256) {\r\n uint idsLength = ArrayStorageSlot.length(slotIds).value;\r\n if (idsLength == 0) {\r\n return 0;\r\n } else {\r\n return ArrayStorageSlot.getUint256Slot(slotIds, idsLength - 1).value;\r\n }\r\n }\r\n \r\n function _findUpperBound(bytes32 slot, uint element) private view returns (uint256){\r\n uint256 low = 0;\r\n uint256 high = ArrayStorageSlot.length(slot).value;\r\n if (high == 0) {\r\n return 0;\r\n }\r\n \r\n while (low < high) {\r\n uint256 mid = MathUpgradeable.average(low, high);\r\n\r\n // Note that mid will always be strictly less than high (i.e. it will be a valid array index)\r\n // because Math.average rounds down (it does integer division with truncation).\r\n if (ArrayStorageSlot.getUint256Slot(slot, mid).value > element) {\r\n high = mid;\r\n } else {\r\n low = mid + 1;\r\n }\r\n }\r\n // At this point `low` is the exclusive upper bound. We will return the inclusive upper bound.\r\n if (low > 0 && ArrayStorageSlot.getUint256Slot(slot, low - 1).value == element) {\r\n return low - 1;\r\n } else {\r\n return low;\r\n }\r\n\r\n }\r\n}\r\n" }, "contracts/features-interfaces/IBlacklistFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\n/**\r\n * @dev ERC20 token with a blacklist feature\r\n */\r\ninterface IBlacklistFeature {\r\n\r\n /**\r\n * @dev Add to blacklist all `addresses`, should to be called by a BLACKLIST_MANAGER_ROLE.\r\n */\r\n function addAddressesToBlacklist(address[] calldata addresses) external;\r\n \r\n /**\r\n * @dev Remove from blacklist all `addresses`, should to be called by a BLACKLIST_MANAGER_ROLE.\r\n */\r\n function removeAddressesFromBlacklist(address[] calldata addresses) external;\r\n\r\n}" }, "contracts/features-interfaces/IERC20BurnFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\n/**\r\n * @dev ERC20 token with a burn feature\r\n */\r\ninterface IERC20BurnFeature {\r\n\r\n /**\r\n * @dev Destroys `amount` tokens from the caller.\r\n *\r\n * See {ERC20-_burn}.\r\n */\r\n function burn(uint256 amount) external;\r\n\r\n /**\r\n * @dev Destroys `amount` tokens from `account`, deducting from the caller's\r\n * allowance.\r\n *\r\n * See {ERC20-_burn} and {ERC20-allowance}.\r\n *\r\n * Requirements:\r\n *\r\n * - the caller must have allowance for ``accounts``'s tokens of at least\r\n * `amount`.\r\n */\r\n function burnFrom(address account, uint256 amount) external;\r\n\r\n}" }, "contracts/features-interfaces/IPausableWithWhitelistFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\npragma solidity ^0.8.0;\r\n\r\n/**\r\n * @dev ERC20 token with a Whitelist and Pause feature\r\n */\r\ninterface IPausableWithWhitelistFeature {\r\n\r\n /**\r\n * @dev Gives WHITELISTED_FROM_ROLE to `addresses`. \r\n */\r\n function addAddressesToWhitelistFrom(address[] calldata addresses) external;\r\n\r\n /**\r\n * @dev Removes WHITELISTED_FROM_ROLE from `addresses`.\r\n */\r\n function removeAddressesFromWhitelistFrom(address[] calldata addresses) external;\r\n\r\n /**\r\n * @dev Gives WHITELISTED_SENDER_ROLE to `addresses`.\r\n */\r\n function addAddressesToWhitelistSender(address[] calldata addresses) external;\r\n\r\n /**\r\n * @dev Removes WHITELISTED_SENDER_ROLE from `addresses`.\r\n */ \r\n function removeAddressesFromWhitelistSender(address[] calldata addresses) external;\r\n\r\n /**\r\n * @notice Pause the token transfers\r\n */\r\n function pause() external;\r\n\r\n /**\r\n * @notice Unpause the token transfers\r\n */\r\n function unpause() external;\r\n\r\n}\r\n" }, "contracts/features-interfaces/ISnapshotFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\npragma solidity ^0.8.0;\r\n\r\ninterface ISnapshotFeature {\r\n\r\n /**\r\n * @dev Returns the current snapshot Id.\r\n */\r\n function getCurrentSnapshotId() external view returns (uint256);\r\n\r\n /**\r\n * @dev Take a snapshot.\r\n */\r\n function snapshot() external;\r\n\r\n}" }, "contracts/features-interfaces/ITxFeeFeatureV3.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\n/**\r\n * @dev ERC20 token with a fee feature\r\n */\r\ninterface ITxFeeFeatureV3 {\r\n \r\n /**\r\n * Change the Fee amount and Beneficiary account.\r\n */\r\n function changeTxFeeProperties(uint256 newTxFee, address newTxBeneficiary) external;\r\n\r\n function transfer(address recipient, uint256 amount) external returns(bool);\r\n\r\n function transferFrom(\r\n address sender,\r\n address recipient,\r\n uint256 amount\r\n ) external returns(bool);\r\n}" }, "contracts/features/BlacklistFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../ERC20Base.sol\";\r\nimport \"../features-interfaces/IBlacklistFeature.sol\";\r\n\r\n/**\r\n * @dev ERC20 token with Blacklist feature\r\n */\r\nabstract contract BlacklistFeature is ERC20Base, IBlacklistFeature {\r\n \r\n bytes32 public constant BLACKLIST_MANAGER_ROLE = keccak256(\"BLACKLIST_MANAGER_ROLE\");\r\n bytes32 public constant BLACKLISTED_ROLE = keccak256(\"BLACKLISTED_ROLE\");\r\n\r\n function __BlacklistFeature_init_unchained() internal onlyInitializing {\r\n\t\t// Set BLACKLIST_MANAGER_ROLE to be the admin of Whitelist\r\n\t\t_setRoleAdmin(BLACKLISTED_ROLE, BLACKLIST_MANAGER_ROLE);\r\n }\r\n\r\n function addAddressesToBlacklist(address[] calldata addresses) external override onlyRole(BLACKLIST_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n _grantRole(BLACKLISTED_ROLE, addresses[i]);\r\n _revokeRole(BLACKLIST_MANAGER_ROLE, addresses[i]);\r\n _revokeRole(DEFAULT_ADMIN_ROLE, addresses[i]);\r\n _revokeRole(GOVERNANCE_ROLE, addresses[i]);\r\n _revokeRole(keccak256(\"ERC20_MINTER_ROLE\"), addresses[i]);\r\n _revokeRole(keccak256(\"PAUSE_MANAGER_ROLE\"), addresses[i]);\r\n _revokeRole(keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiaryRole\"), addresses[i]);\r\n _revokeRole(keccak256(\"UPGRADE_MANAGER_ROLE\"), addresses[i]);\r\n _revokeRole(keccak256(\"WHITELISTED_FROM_ROLE\"), addresses[i]);\r\n _revokeRole(keccak256(\"WHITELISTED_SENDER_ROLE\"), addresses[i]);\r\n _revokeRole(keccak256(\"polkalokr.features.txFeeFeature._txFee\"), addresses[i]);\r\n _revokeRole(keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiary\"), addresses[i]);\r\n _revokeRole(keccak256(\"FACTORY_MANAGER\"), addresses[i]);\r\n _revokeRole(keccak256(\"polkalokr.features.txFeeFeature._txFeeManagerRole\"), addresses[i]);\r\n }\r\n }\r\n\r\n function removeAddressesFromBlacklist(address[] calldata addresses) external override onlyRole(BLACKLIST_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n _revokeRole(BLACKLISTED_ROLE, addresses[i]);\r\n }\r\n }\r\n\r\n function grantRole_hook(bytes32 role, address account) internal virtual {\r\n if(\r\n role == BLACKLIST_MANAGER_ROLE || \r\n role == DEFAULT_ADMIN_ROLE || \r\n role == GOVERNANCE_ROLE ||\r\n role == keccak256(\"ERC20_MINTER_ROLE\") ||\r\n role == keccak256(\"PAUSE_MANAGER_ROLE\") ||\r\n role == keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiaryRole\") ||\r\n role == keccak256(\"UPGRADE_MANAGER_ROLE\") ||\r\n role == keccak256(\"WHITELISTED_FROM_ROLE\") ||\r\n role == keccak256(\"WHITELISTED_SENDER_ROLE\") ||\r\n role == keccak256(\"polkalokr.features.txFeeFeature._txFee\") ||\r\n role == keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiary\") ||\r\n role == keccak256(\"FACTORY_MANAGER\") ||\r\n role == keccak256(\"polkalokr.features.txFeeFeature._txFeeManagerRole\")\r\n \r\n \r\n ) {\r\n require(!hasRole(BLACKLISTED_ROLE, account), \"can not assign role to blacklisted\");\r\n }\r\n }\r\n\r\n\r\n function renounceRole_hook(bytes32 role, address /*account*/) internal virtual {\r\n require(role != BLACKLISTED_ROLE, \"Can not renounce blacklisted role\");\r\n }\r\n\r\n function _beforeTokenTransfer_hook(address from, address _to, uint256 /*amount*/) internal virtual {\r\n require(\r\n !_checkBlacklist(_msgSender(), from, _to), \r\n \"ERROR: Address Blacklisted\"\r\n );\r\n }\r\n\r\n function _checkBlacklist(address _sender, address _from, address _to) internal view returns(bool) {\r\n return (\r\n hasRole(BLACKLISTED_ROLE, _from) || \r\n hasRole(BLACKLISTED_ROLE, _sender) ||\r\n hasRole(BLACKLISTED_ROLE, _to)\r\n );\r\n }\r\n}" }, "contracts/features/ERC20BurnFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../ERC20Base.sol\";\r\nimport \"../features-interfaces/IERC20BurnFeature.sol\";\r\n\r\n/**\r\n * @dev ERC20 token with a burn feature\r\n */\r\nabstract contract ERC20BurnFeature is ERC20Base, IERC20BurnFeature {\r\n\r\n function __ERC20Burnable_init_unchained() internal onlyInitializing {\r\n }\r\n\r\n /**\r\n * @dev Destroys `amount` tokens from the caller.\r\n *\r\n * See {ERC20-_burn}.\r\n */\r\n function burn(uint256 amount) public override virtual {\r\n _burn(_msgSender(), amount);\r\n }\r\n\r\n /**\r\n * @dev Destroys `amount` tokens from `account`, deducting from the caller's\r\n * allowance.\r\n *\r\n * See {ERC20-_burn} and {ERC20-allowance}.\r\n *\r\n * Requirements:\r\n *\r\n * - the caller must have allowance for ``accounts``'s tokens of at least\r\n * `amount`.\r\n */\r\n function burnFrom(address account, uint256 amount) public override virtual {\r\n uint256 currentAllowance = allowance(account, _msgSender());\r\n require(currentAllowance >= amount, \"ERC20: burn amount exceeds allowance\");\r\n unchecked {\r\n _approve(account, _msgSender(), currentAllowance - amount);\r\n }\r\n _burn(account, amount);\r\n }\r\n}" }, "contracts/features/PausableWithWhitelistFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\n// Add upgradeToAndCall(address newImplementation, bytes memory data) from UUPS to upgrade\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../security/PausableUpgradeableRewrited.sol\";\r\nimport \"../features-interfaces/IPausableWithWhitelistFeature.sol\";\r\nimport \"../ERC20Base.sol\";\r\n\r\n/**\r\n * @dev ERC20 token with a Pausable feature\r\n */\r\nabstract contract PausableWithWhitelistFeature is \r\n ERC20Base, \r\n PausableUpgradeableRewrited, \r\n IPausableWithWhitelistFeature \r\n{\r\n\r\n bytes32 public constant PAUSE_MANAGER_ROLE = keccak256(\"PAUSE_MANAGER_ROLE\");\r\n bytes32 public constant WHITELISTED_FROM_ROLE = keccak256(\"WHITELISTED_FROM_ROLE\");\r\n bytes32 public constant WHITELISTED_SENDER_ROLE = keccak256(\"WHITELISTED_SENDER_ROLE\");\r\n\r\n function __PausableWithWhitelistFeature_init_unchained() internal onlyInitializing {\r\n\t\t// Set PAUSE_MANAGER_ROLE to be the admin of Whitelist\r\n\t\t_setRoleAdmin(WHITELISTED_FROM_ROLE, PAUSE_MANAGER_ROLE);\r\n\t\t_setRoleAdmin(WHITELISTED_SENDER_ROLE, PAUSE_MANAGER_ROLE);\r\n } \r\n\r\n\r\n function addAddressesToWhitelistFrom(address[] calldata addresses) external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n grantRole(WHITELISTED_FROM_ROLE, addresses[i]);\r\n }\r\n }\r\n\r\n function removeAddressesFromWhitelistFrom(address[] calldata addresses) external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n revokeRole(WHITELISTED_FROM_ROLE, addresses[i]);\r\n }\r\n }\r\n\r\n function addAddressesToWhitelistSender(address[] calldata addresses) external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n grantRole(WHITELISTED_SENDER_ROLE, addresses[i]);\r\n }\r\n }\r\n\r\n function removeAddressesFromWhitelistSender(address[] calldata addresses) external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n for(uint256 i; i < addresses.length; i++) {\r\n revokeRole(WHITELISTED_SENDER_ROLE, addresses[i]);\r\n }\r\n }\r\n\r\n /**\r\n * @notice Pause the token transfers\r\n */\r\n function pause() external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n _pause();\r\n }\r\n\r\n /**\r\n * @notice Unpause the token transfers\r\n */\r\n function unpause() external override onlyRole(PAUSE_MANAGER_ROLE) {\r\n _unpause();\r\n }\r\n\r\n\r\n function _beforeTokenTransfer_hook(address from, address /*_to*/, uint256 /*amount*/) internal virtual {\r\n require(!paused() || _checkWhitelist(from, _msgSender()), \"ERC20Pausable: token transfer while paused\");\r\n //super._beforeTokenTransfer(from, to, amount);\r\n }\r\n\r\n function _checkWhitelist(address _from, address _sender) internal view returns(bool) {\r\n return (hasRole(WHITELISTED_FROM_ROLE, _from) || hasRole(WHITELISTED_SENDER_ROLE, _sender));\r\n }\r\n\r\n}\r\n" }, "contracts/features/SnapshotFeature.sol": { "content": "// SPDX-License-Identifier: MIT\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../extensions/ERC20SnapshotRewrited.sol\";\r\nimport \"../features-interfaces/ISnapshotFeature.sol\";\r\n\r\nabstract contract SnapshotFeature is ERC20SnapshotRewrited, ISnapshotFeature {\r\n \r\n function _beforeTokenTransfer_hook(\r\n address from, \r\n address to, \r\n uint256 amount\r\n ) internal virtual {\r\n ERC20SnapshotRewrited._beforeTokenTransfer(from, to, amount);\r\n }\r\n\r\n function getCurrentSnapshotId() external override view returns (uint256) {\r\n return _getCurrentSnapshotId();\r\n }\r\n\r\n function snapshot() external override {\r\n _snapshot();\r\n }\r\n\r\n}" }, "contracts/features/TxFeeFeatureV3.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nimport \"@openzeppelin/contracts-upgradeable/utils/StorageSlotUpgradeable.sol\";\r\nimport \"../common/BaseGovernanceWithUserUpgradable.sol\";\r\nimport \"../features-interfaces/ITxFeeFeatureV3.sol\";\r\nimport \"../ERC20Base.sol\";\r\n\r\n/**\r\n * @dev ERC20 token with a Transaction Fee feature\r\n */\r\nabstract contract TxFeeFeatureV3 is ERC20Base, ITxFeeFeatureV3 {\r\n\r\n /// The fee rate of the token\r\n bytes32 internal constant TX_FEE_SLOT = keccak256(\"polkalokr.features.txFeeFeature._txFee\");\r\n /// address of the fee beneficiary\r\n bytes32 internal constant TX_FEE_BENEFICIARY_SLOT = keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiary\");\r\n ///@notice role for tax-exempt address\r\n bytes32 public constant TX_FEE_WHITELISTED_ROLE = keccak256(\"polkalokr.features.txFeeFeature._txFeeBeneficiaryRole\");\r\n //@notice role to admin the TX_FEE_WHITELISTED_ROLE\r\n bytes32 public constant TX_FEE_WHITELISTED_MANAGER = keccak256(\"polkalokr.features.txFeeFeature._txFeeManagerRole\");\r\n /// divisor for the fee calculation\r\n uint256 internal constant EXP = 1e18;\r\n\r\n function __ERC20TxFeeFeature_init_unchained(uint256 _txFee, address _txFeeBeneficiary) internal onlyInitializing {\r\n require(_txFee < EXP, \"ERROR: TX FEE CANT BE 100%\");\r\n require(_txFeeBeneficiary != address(0), \"TX FEE BENEFICIARY CANT BE ADDRESS 0\");\r\n StorageSlotUpgradeable.getUint256Slot(TX_FEE_SLOT).value = _txFee;\r\n StorageSlotUpgradeable.getAddressSlot(TX_FEE_BENEFICIARY_SLOT).value = _txFeeBeneficiary;\r\n\r\n _setRoleAdmin(TX_FEE_WHITELISTED_ROLE, TX_FEE_WHITELISTED_MANAGER);\r\n\r\n _grantRole(TX_FEE_WHITELISTED_MANAGER, _txFeeBeneficiary);\r\n\r\n if (tx.origin != _txFeeBeneficiary) {\r\n _grantRole(TX_FEE_WHITELISTED_MANAGER, tx.origin);\r\n }\r\n }\r\n\r\n /// @dev Set the tx fee and the tx fee beneficiary\r\n /// @param _txFee The tx fee in wei\r\n /// @param _txFeeBeneficiary The address of the beneficiary of the tx fee\r\n /// @notice The tx fee beneficiary must be a valid address\r\n function changeTxFeeProperties(uint256 _txFee, address _txFeeBeneficiary) external override onlyRole(DEFAULT_ADMIN_ROLE) {\r\n require(_txFee < EXP, \"ERROR: TX FEE CANT BE 100%\");\r\n require(_txFeeBeneficiary != address(0), \"TX FEE BENEFICIARY CANT BE ADDRESS 0\");\r\n /// factories or deployers will be excluded from the tx fee\r\n grantRole(TX_FEE_WHITELISTED_ROLE, _msgSender());\r\n StorageSlotUpgradeable.getUint256Slot(TX_FEE_SLOT).value = _txFee;\r\n StorageSlotUpgradeable.getAddressSlot(TX_FEE_BENEFICIARY_SLOT).value = _txFeeBeneficiary;\r\n }\r\n\r\n function _beforeTokenTransfer_hook(address from, address to, uint256 amount) internal virtual {\r\n }\r\n\r\n /// @dev called before a token transfer is made and modificated to charge the tx fee\r\n function transfer(address recipient, uint256 amount) public virtual override(ERC20Upgradeable, ITxFeeFeatureV3) returns (bool) {\r\n uint256 txFee = StorageSlotUpgradeable.getUint256Slot(TX_FEE_SLOT).value;\r\n address txFeeBeneficiary = StorageSlotUpgradeable.getAddressSlot(TX_FEE_BENEFICIARY_SLOT).value;\r\n uint256 txFeeAmount = 0;\r\n /// fee is paid to the beneficiary as an additional transaction\r\n /// charge the tx fee beneficiary while sender or recipient has not been whitelisted\r\n if( \r\n (txFee != 0 || // No txFee\r\n txFeeBeneficiary != recipient || // Send txFee itself\r\n address(0) != recipient) && // Burn\r\n !_checkTXRoles(_msgSender(), recipient)\r\n ){\r\n txFeeAmount = amount * txFee / EXP;\r\n _transfer(_msgSender(), txFeeBeneficiary, txFeeAmount);\r\n }\r\n \r\n \r\n _transfer(_msgSender(), recipient, amount - txFeeAmount);\r\n return true;\r\n }\r\n\r\n /// @dev called before a token transfer is made and modificated to charge the tx fee\r\n function transferFrom(\r\n address sender,\r\n address recipient,\r\n uint256 amount\r\n ) public virtual override(ERC20Upgradeable, ITxFeeFeatureV3) returns (bool) {\r\n uint256 txFee = StorageSlotUpgradeable.getUint256Slot(TX_FEE_SLOT).value;\r\n address txFeeBeneficiary = StorageSlotUpgradeable.getAddressSlot(TX_FEE_BENEFICIARY_SLOT).value;\r\n uint256 txFeeAmount = 0;\r\n /// fee is paid to the beneficiary as an additional transaction\r\n /// charge the tx fee beneficiary while sender or recipient has not been whitelisted\r\n if( \r\n (txFee != 0 || // No txFee\r\n txFeeBeneficiary != recipient || // Send txFee itself\r\n address(0) != recipient) && // Burn\r\n !_checkTXRoles(sender, recipient)\r\n ){\r\n txFeeAmount = amount * txFee / EXP;\r\n _transfer(sender, txFeeBeneficiary, txFeeAmount);\r\n }\r\n\r\n \r\n _transfer(sender, recipient, amount - txFeeAmount);\r\n\r\n /// handle the allowance of the sender\r\n uint256 currentAllowance = allowance(sender, _msgSender());\r\n require(currentAllowance >= amount, \"ERC20: transfer amount exceeds allowance\");\r\n unchecked {\r\n _approve(sender, _msgSender(), currentAllowance - amount);\r\n }\r\n\r\n return true;\r\n }\r\n\r\n function _checkTXRoles(address sender, address recipient) internal view returns(bool) {\r\n return(\r\n hasRole(TX_FEE_WHITELISTED_ROLE, sender) ||\r\n hasRole(TX_FEE_WHITELISTED_ROLE, recipient) ||\r\n hasRole(TX_FEE_WHITELISTED_MANAGER, _msgSender()) ||\r\n hasRole(TX_FEE_WHITELISTED_MANAGER, recipient)\r\n );\r\n }\r\n}" }, "contracts/security/PausableUpgradeableRewrited.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nimport \"@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol\";\r\nimport \"@openzeppelin/contracts-upgradeable/utils/StorageSlotUpgradeable.sol\";\r\n\r\n/**\r\n * @dev Contract module which allows children to implement an emergency stop\r\n * mechanism that can be triggered by an authorized account.\r\n *\r\n * This module is used through inheritance. It will make available the\r\n * modifiers `whenNotPaused` and `whenPaused`, which can be applied to\r\n * the functions of your contract. Note that they will not be pausable by\r\n * simply including this module, only once the modifiers are put in place.\r\n * \r\n * This is a rewrite from OZ Contratcs to use the StorageSlot Library funcionalities. Enjoy!\r\n */\r\nabstract contract PausableUpgradeableRewrited is ContextUpgradeable {\r\n /**\r\n * @dev Emitted when the pause is triggered by `account`.\r\n */\r\n event Paused(address account);\r\n\r\n /**\r\n * @dev Emitted when the pause is lifted by `account`.\r\n */\r\n event Unpaused(address account);\r\n\r\n bytes32 internal constant PAUSE_SLOT = keccak256(\"polkalokr.oz.security.pausable._paused\");\r\n\r\n /**\r\n * @dev Initializes the contract in unpaused state.\r\n */\r\n function __Pausable_init() internal initializer {\r\n __Context_init_unchained();\r\n __Pausable_init_unchained();\r\n }\r\n\r\n /**\r\n * @dev Initializes the contract in unpaused state.\r\n */\r\n function __Pausable_init_unchained() internal initializer {\r\n StorageSlotUpgradeable.getBooleanSlot(PAUSE_SLOT).value = false;\r\n }\r\n\r\n /**\r\n * @dev Returns true if the contract is paused, and false otherwise.\r\n */\r\n function paused() public view virtual returns (bool) {\r\n return StorageSlotUpgradeable.getBooleanSlot(PAUSE_SLOT).value;\r\n }\r\n\r\n /**\r\n * @dev Modifier to make a function callable only when the contract is not paused.\r\n *\r\n * Requirements:\r\n *\r\n * - The contract must not be paused.\r\n */\r\n modifier whenNotPaused() {\r\n require(!paused(), \"Pausable: paused\");\r\n _;\r\n }\r\n\r\n /**\r\n * @dev Modifier to make a function callable only when the contract is paused.\r\n *\r\n * Requirements:\r\n *\r\n * - The contract must be paused.\r\n */\r\n modifier whenPaused() {\r\n require(paused(), \"Pausable: not paused\");\r\n _;\r\n }\r\n\r\n /**\r\n * @dev Triggers stopped state.\r\n *\r\n * Requirements:\r\n *\r\n * - The contract must not be paused.\r\n */\r\n function _pause() internal virtual whenNotPaused {\r\n StorageSlotUpgradeable.getBooleanSlot(PAUSE_SLOT).value = true;\r\n emit Paused(_msgSender());\r\n }\r\n\r\n /**\r\n * @dev Returns to normal state.\r\n *\r\n * Requirements:\r\n *\r\n * - The contract must be paused.\r\n */\r\n function _unpause() internal virtual whenPaused {\r\n StorageSlotUpgradeable.getBooleanSlot(PAUSE_SLOT).value = false;\r\n emit Unpaused(_msgSender());\r\n }\r\n}\r\n" }, "contracts/templates/BlacklistBurnSnapshotTxFeeWhiteListTemplate.sol": { "content": "// SPDX-License-Identifier: MIT\r\npragma solidity ^0.8.0;\r\n\r\nimport \"../ERC20Base.sol\";\r\nimport \"../features/SnapshotFeature.sol\";\r\nimport \"../features/PausableWithWhitelistFeature.sol\";\r\nimport \"../features/BlacklistFeature.sol\";\r\nimport \"../features/TxFeeFeatureV3.sol\";\r\nimport \"../features/ERC20BurnFeature.sol\";\r\n\r\ncontract BlacklistBurnSnapshotTxFeeWhiteListTemplate is\r\n SnapshotFeature,\r\n PausableWithWhitelistFeature,\r\n BlacklistFeature,\r\n TxFeeFeatureV3,\r\n ERC20BurnFeature\r\n{\r\n function initialize(\r\n string memory name_,\r\n string memory symbol_,\r\n uint8 decimals_,\r\n uint256 amount_,\r\n uint256 txFee,\r\n address txFeeBeneficiary\r\n ) public initializer {\r\n __ERC20Base_init(name_, symbol_, decimals_, amount_);\r\n __BlacklistFeature_init_unchained();\r\n __PausableWithWhitelistFeature_init_unchained();\r\n __ERC20TxFeeFeature_init_unchained(txFee, txFeeBeneficiary);\r\n }\r\n\r\n function grantRole(bytes32 role, address account)\r\n public\r\n override(AccessControlUpgradeable)\r\n {\r\n BlacklistFeature.grantRole_hook(role, account);\r\n super.grantRole(role, account);\r\n }\r\n\r\n function renounceRole(bytes32 role, address account)\r\n public\r\n override(AccessControlUpgradeable)\r\n {\r\n BlacklistFeature.renounceRole_hook(role, account);\r\n super.renounceRole(role, account);\r\n }\r\n\r\n function _beforeTokenTransfer_hook(\r\n address from,\r\n address to,\r\n uint256 amount\r\n )\r\n internal\r\n virtual\r\n override(\r\n SnapshotFeature,\r\n PausableWithWhitelistFeature,\r\n BlacklistFeature,\r\n TxFeeFeatureV3\r\n )\r\n {\r\n SnapshotFeature._beforeTokenTransfer_hook(from, to, amount);\r\n PausableWithWhitelistFeature._beforeTokenTransfer_hook(\r\n from,\r\n to,\r\n amount\r\n );\r\n BlacklistFeature._beforeTokenTransfer_hook(from, to, amount);\r\n }\r\n\r\n function _beforeTokenTransfer(\r\n address from,\r\n address to,\r\n uint256 amount\r\n ) internal virtual override(ERC20SnapshotRewrited, ERC20Upgradeable) {\r\n _beforeTokenTransfer_hook(from, to, amount);\r\n super._beforeTokenTransfer(from, to, amount);\r\n }\r\n\r\n function transfer(address recipient, uint256 amount)\r\n public\r\n virtual\r\n override(TxFeeFeatureV3, ERC20Upgradeable)\r\n returns (bool)\r\n {\r\n return TxFeeFeatureV3.transfer(recipient, amount);\r\n }\r\n\r\n function transferFrom(\r\n address sender,\r\n address recipient,\r\n uint256 amount\r\n ) public virtual override(TxFeeFeatureV3, ERC20Upgradeable) returns (bool) {\r\n return TxFeeFeatureV3.transferFrom(sender, recipient, amount);\r\n }\r\n}\r\n" }, "contracts/utils/ArrayStorageSlot.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nlibrary ArrayStorageSlot {\r\n struct AddressSlot {\r\n address value;\r\n }\r\n\r\n struct BooleanSlot {\r\n bool value;\r\n }\r\n\r\n struct Bytes32Slot {\r\n bytes32 value;\r\n }\r\n\r\n struct Uint256Slot {\r\n uint256 value;\r\n }\r\n\r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` that represent the array length`.\r\n */\r\n function length(bytes32 slot) internal pure returns (Uint256Slot storage r) {\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `AddressSlot` with member `value` that have the uint located at `slot` + `index`.\r\n */\r\n function getAddressSlot(bytes32 slot, uint index) internal view returns (AddressSlot storage r) {\r\n require(index >= 0 && index < length(slot).value, \"ERROR: Out of bound\");\r\n slot = bytes32(uint256(keccak256(abi.encode(slot))) + index);\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `BooleanSlot` with member `value` that have the uint located at `slot` + `index`.\r\n */\r\n function getBooleanSlot(bytes32 slot, uint index) internal view returns (BooleanSlot storage r) {\r\n require(index >= 0 && index < length(slot).value, \"ERROR: Out of bound\");\r\n slot = bytes32(uint256(keccak256(abi.encode(slot))) + index);\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Bytes32Slot` with member `value` that have the uint located at `slot` + `index`.\r\n */\r\n function getBytes32Slot(bytes32 slot, uint index) internal view returns (Bytes32Slot storage r) {\r\n require(index >= 0 && index < length(slot).value, \"ERROR: Out of bound\");\r\n slot = bytes32(uint256(keccak256(abi.encode(slot))) + index);\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` that have the uint located at `slot` + `index`.\r\n */\r\n function getUint256Slot(bytes32 slot, uint index) internal view returns (Uint256Slot storage r) {\r\n require(index >= 0 && index < length(slot).value, \"ERROR: Out of bound\");\r\n slot = bytes32(uint256(keccak256(abi.encode(slot))) + index);\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Push an address to the end of the array started at `slot`. Must be used knowing the array slot\r\n */\r\n function push(bytes32 slot, address value) internal {\r\n uint lastIndex = length(slot).value;\r\n length(slot).value += 1;\r\n getAddressSlot(slot, lastIndex).value = value;\r\n }\r\n\r\n /**\r\n * @dev Push an bool to the end of the array started at `slot`. Must be used knowing the array slot\r\n */\r\n function push(bytes32 slot, bool value) internal {\r\n uint lastIndex = length(slot).value;\r\n length(slot).value += 1;\r\n getBooleanSlot(slot, lastIndex).value = value;\r\n }\r\n\r\n /**\r\n * @dev Push an bytes32 to the end of the array started at `slot`. Must be used knowing the array slot\r\n */\r\n function push(bytes32 slot, bytes32 value) internal {\r\n uint lastIndex = length(slot).value;\r\n length(slot).value += 1;\r\n getBytes32Slot(slot, lastIndex).value = value;\r\n }\r\n\r\n /**\r\n * @dev Push an uint to the end of the array started at `slot`. Must be used knowing the array slot\r\n */\r\n function push(bytes32 slot, uint value) internal {\r\n uint lastIndex = length(slot).value;\r\n length(slot).value += 1;\r\n getUint256Slot(slot, lastIndex).value = value;\r\n }\r\n}" }, "contracts/utils/MappingStorageSlot.sol": { "content": "// SPDX-License-Identifier: MIT\r\n\r\npragma solidity ^0.8.0;\r\n\r\nlibrary MappingStorageSlot {\r\n struct AddressSlot {\r\n address value;\r\n }\r\n\r\n struct BooleanSlot {\r\n bool value;\r\n }\r\n\r\n struct Bytes32Slot {\r\n bytes32 value;\r\n }\r\n\r\n struct Uint256Slot {\r\n uint256 value;\r\n }\r\n\r\n // Getting address from the slot\r\n /**\r\n * @dev Returns an `AddressSlot` with member `value` located in a mapping at a `slot` with a address as `key`.\r\n */\r\n function getAddressSlot(bytes32 mappingSlot, address key) internal pure returns (AddressSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `AddressSlot` with member `value` located in a mapping at a `slot` with a bool as `key`.\r\n */\r\n function getAddressSlot(bytes32 mappingSlot, bool key) internal pure returns (AddressSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `AddressSlot` with member `value` located in a mapping at a `slot` with a bytes32 as `key`.\r\n */\r\n function getAddressSlot(bytes32 mappingSlot, bytes32 key) internal pure returns (AddressSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `AddressSlot` with member `value` located in a mapping at a `slot` with a uint256 as `key`.\r\n */\r\n function getAddressSlot(bytes32 mappingSlot, uint256 key) internal pure returns (AddressSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n // Getting bool from the slot\r\n /**\r\n * @dev Returns an `BooleanSlot` with member `value` located in a mapping at a `slot` with a address as `key`.\r\n */\r\n function getBooleanSlot(bytes32 mappingSlot, address key) internal pure returns (BooleanSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n \r\n /**\r\n * @dev Returns an `BooleanSlot` with member `value` located in a mapping at a `slot` with a bool as `key`.\r\n */\r\n function getBooleanSlot(bytes32 mappingSlot, bool key) internal pure returns (BooleanSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `BooleanSlot` with member `value` located in a mapping at a `slot` with a bytes32 as `key`.\r\n */\r\n function getBooleanSlot(bytes32 mappingSlot, bytes32 key) internal pure returns (BooleanSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `BooleanSlot` with member `value` located in a mapping at a `slot` with a uint256 as `key`.\r\n */\r\n function getBooleanSlot(bytes32 mappingSlot, uint256 key) internal pure returns (BooleanSlot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n // Getting bytes32 from the slot\r\n /**\r\n * @dev Returns an `Bytes32Slot` with member `value` located in a mapping at a `slot` with a address as `key`.\r\n */\r\n function getBytes32Slot(bytes32 mappingSlot, address key) internal pure returns (Bytes32Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Bytes32Slot` with member `value` located in a mapping at a `slot` with a bool as `key`.\r\n */\r\n function getBytes32Slot(bytes32 mappingSlot, bool key) internal pure returns (Bytes32Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Bytes32Slot` with member `value` located in a mapping at a `slot` with a bytes32 as `key`.\r\n */\r\n function getBytes32Slot(bytes32 mappingSlot, bytes32 key) internal pure returns (Bytes32Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Bytes32Slot` with member `value` located in a mapping at a `slot` with a uint256 as `key`.\r\n */\r\n function getBytes32Slot(bytes32 mappingSlot, uint256 key) internal pure returns (Bytes32Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n // Getting uint256 from the slot\r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` located in a mapping at a `slot` with a address as `key`.\r\n */\r\n function getUint256Slot(bytes32 mappingSlot, address key) internal pure returns (Uint256Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n \r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` located in a mapping at a `slot` with a bool as `key`.\r\n */\r\n function getUint256Slot(bytes32 mappingSlot, bool key) internal pure returns (Uint256Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` located in a mapping at a `slot` with a bytes32 as `key`.\r\n */\r\n function getUint256Slot(bytes32 mappingSlot, bytes32 key) internal pure returns (Uint256Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n\r\n /**\r\n * @dev Returns an `Uint256Slot` with member `value` located in a mapping at a `slot` with a uint256 as `key`.\r\n */\r\n function getUint256Slot(bytes32 mappingSlot, uint256 key) internal pure returns (Uint256Slot storage r) {\r\n bytes32 slot = keccak256(abi.encode(key, mappingSlot));\r\n assembly {\r\n r.slot := slot\r\n }\r\n }\r\n}\r\n" } }, "settings": { "optimizer": { "enabled": true, "runs": 200 }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "libraries": {} } }