ERC-20
Overview
Max Total Supply
50,000 PGP.alpha
Holders
5
Market
Onchain Market Cap
$0.00
Circulating Supply Market Cap
-
Other Info
Token Contract (WITH 18 Decimals)
Balance
10,000 PGP.alphaValue
$0.00Loading...
Loading
Loading...
Loading
Loading...
Loading
# | Exchange | Pair | Price | 24H Volume | % Volume |
---|
Contract Name:
TrustToken
Compiler Version
v0.8.15+commit.e14f2714
Contract Source Code (Solidity Standard Json-Input format)
//SPDX-License-Identifier: MIT pragma solidity 0.8.15; import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol"; import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol"; import { CitizenAlpha } from "../CitizenAlpha.sol"; import { ObservationLib } from "../libraries/twab/ObservationLib.sol"; import { TwabLib } from "../libraries/twab/TwabLib.sol"; import { ExtendedSafeCastLib } from "../libraries/twab/ExtendedSafeCastLib.sol"; /** * @title TrustToken * @author Kames Geraghty * @notice TrustToken is a Web3 of Trust experiment: implementing time-weighted average balances. Credit: PoolTogether Inc (Brendan Asselstine) */ contract TrustToken is ERC20Permit { using SafeERC20 for IERC20; using ExtendedSafeCastLib for uint256; CitizenAlpha private citizenAlpha; uint256 private distribution = 10000e18; mapping(address => bool) private _claimed; bytes32 private immutable _DELEGATE_TYPEHASH = keccak256("Delegate(address user,address delegate,uint256 nonce,uint256 deadline)"); /// @notice Record of token holders TWABs for each account. mapping(address => TwabLib.Account) internal userTwabs; /// @notice Record of tickets total supply and ring buff parameters used for observation. TwabLib.Account internal totalSupplyTwab; /// @notice Mapping of delegates. Each address can delegate their ticket power to another. mapping(address => address) internal delegates; /** * @notice Emitted when TWAB balance has been delegated to another user. * @param delegator Address of the delegator. * @param delegate Address of the delegate. */ event Delegated(address indexed delegator, address indexed delegate); /** * @notice Emitted when a new TWAB has been recorded. * @param delegate The recipient of the ticket power (may be the same as the user). * @param newTwab Updated TWAB of a ticket holder after a successful TWAB recording. */ event NewUserTwab(address indexed delegate, ObservationLib.Observation newTwab); /** * @notice Emitted when a new total supply TWAB has been recorded. * @param newTotalSupplyTwab Updated TWAB of tickets total supply after a successful total supply TWAB recording. */ event NewTotalSupplyTwab(ObservationLib.Observation newTotalSupplyTwab); constructor( CitizenAlpha citizenAlpha_, string memory name, string memory symbol ) ERC20Permit("Web3Citizen TrustToken") ERC20(name, symbol) { citizenAlpha = citizenAlpha_; } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ function claim() external { require(citizenAlpha.isCitizen(msg.sender), "TrustToken:not-trusted"); require(!_claimed[msg.sender], "TrustToken:trust-previously-issued"); _claimed[msg.sender] = true; _mint(msg.sender, distribution); } function getAccountDetails(address _user) external view returns (TwabLib.AccountDetails memory) { return userTwabs[_user].details; } function getTwab(address _user, uint16 _index) external view returns (ObservationLib.Observation memory) { return userTwabs[_user].twabs[_index]; } function getBalanceAt(address _user, uint64 _target) external view returns (uint256) { TwabLib.Account storage account = userTwabs[_user]; return TwabLib.getBalanceAt( account.twabs, account.details, uint32(_target), uint32(block.timestamp) ); } function getAverageBalancesBetween( address _user, uint64[] calldata _startTimes, uint64[] calldata _endTimes ) external view returns (uint256[] memory) { return _getAverageBalancesBetween(userTwabs[_user], _startTimes, _endTimes); } function getAverageTotalSuppliesBetween( uint64[] calldata _startTimes, uint64[] calldata _endTimes ) external view returns (uint256[] memory) { return _getAverageBalancesBetween(totalSupplyTwab, _startTimes, _endTimes); } function getAverageBalanceBetween( address _user, uint64 _startTime, uint64 _endTime ) external view returns (uint256) { TwabLib.Account storage account = userTwabs[_user]; return TwabLib.getAverageBalanceBetween( account.twabs, account.details, uint32(_startTime), uint32(_endTime), uint32(block.timestamp) ); } function getBalancesAt(address _user, uint64[] calldata _targets) external view returns (uint256[] memory) { uint256 length = _targets.length; uint256[] memory _balances = new uint256[](length); TwabLib.Account storage twabContext = userTwabs[_user]; TwabLib.AccountDetails memory details = twabContext.details; for (uint256 i = 0; i < length; i++) { _balances[i] = TwabLib.getBalanceAt( twabContext.twabs, details, uint32(_targets[i]), uint32(block.timestamp) ); } return _balances; } function getTotalSupplyAt(uint64 _target) external view returns (uint256) { return TwabLib.getBalanceAt( totalSupplyTwab.twabs, totalSupplyTwab.details, uint32(_target), uint32(block.timestamp) ); } function getTotalSuppliesAt(uint64[] calldata _targets) external view returns (uint256[] memory) { uint256 length = _targets.length; uint256[] memory totalSupplies = new uint256[](length); TwabLib.AccountDetails memory details = totalSupplyTwab.details; for (uint256 i = 0; i < length; i++) { totalSupplies[i] = TwabLib.getBalanceAt( totalSupplyTwab.twabs, details, uint32(_targets[i]), uint32(block.timestamp) ); } return totalSupplies; } function delegateOf(address _user) external view returns (address) { return delegates[_user]; } function delegateWithSignature( address _user, address _newDelegate, uint256 _deadline, uint8 _v, bytes32 _r, bytes32 _s ) external virtual { require(block.timestamp <= _deadline, "Ticket/delegate-expired-deadline"); bytes32 structHash = keccak256( abi.encode(_DELEGATE_TYPEHASH, _user, _newDelegate, _useNonce(_user), _deadline) ); bytes32 hash = _hashTypedDataV4(structHash); address signer = ECDSA.recover(hash, _v, _r, _s); require(signer == _user, "Ticket/delegate-invalid-signature"); _delegate(_user, _newDelegate); } function delegate(address _to) external virtual { _delegate(msg.sender, _to); } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ /// @notice Delegates a users chance to another /// @param _user The user whose balance should be delegated /// @param _to The delegate function _delegate(address _user, address _to) internal { uint256 balance = balanceOf(_user); address currentDelegate = delegates[_user]; if (currentDelegate == _to) { return; } delegates[_user] = _to; _transferTwab(currentDelegate, _to, balance); emit Delegated(_user, _to); } /** * @notice Retrieves the average balances held by a user for a given time frame. * @param _account The user whose balance is checked. * @param _startTimes The start time of the time frame. * @param _endTimes The end time of the time frame. * @return The average balance that the user held during the time frame. */ function _getAverageBalancesBetween( TwabLib.Account storage _account, uint64[] calldata _startTimes, uint64[] calldata _endTimes ) internal view returns (uint256[] memory) { uint256 startTimesLength = _startTimes.length; require(startTimesLength == _endTimes.length, "Ticket/start-end-times-length-match"); TwabLib.AccountDetails memory accountDetails = _account.details; uint256[] memory averageBalances = new uint256[](startTimesLength); uint32 currentTimestamp = uint32(block.timestamp); for (uint256 i = 0; i < startTimesLength; i++) { averageBalances[i] = TwabLib.getAverageBalanceBetween( _account.twabs, accountDetails, uint32(_startTimes[i]), uint32(_endTimes[i]), currentTimestamp ); } return averageBalances; } /// @notice Transfers the given TWAB balance from one user to another /// @param _from The user to transfer the balance from. May be zero in the event of a mint. /// @param _to The user to transfer the balance to. May be zero in the event of a burn. /// @param _amount The balance that is being transferred. function _transferTwab( address _from, address _to, uint256 _amount ) internal { // If we are transferring tokens from a delegated account to an undelegated account if (_from != address(0)) { _decreaseUserTwab(_from, _amount); if (_to == address(0)) { _decreaseTotalSupplyTwab(_amount); } } // If we are transferring tokens from an undelegated account to a delegated account if (_to != address(0)) { _increaseUserTwab(_to, _amount); if (_from == address(0)) { _increaseTotalSupplyTwab(_amount); } } } /** * @notice Increase `_to` TWAB balance. * @param _to Address of the delegate. * @param _amount Amount of tokens to be added to `_to` TWAB balance. */ function _increaseUserTwab(address _to, uint256 _amount) internal { if (_amount == 0) { return; } TwabLib.Account storage _account = userTwabs[_to]; ( TwabLib.AccountDetails memory accountDetails, ObservationLib.Observation memory twab, bool isNew ) = TwabLib.increaseBalance(_account, _amount.toUint208(), uint32(block.timestamp)); _account.details = accountDetails; if (isNew) { emit NewUserTwab(_to, twab); } } /** * @notice Decrease `_to` TWAB balance. * @param _to Address of the delegate. * @param _amount Amount of tokens to be added to `_to` TWAB balance. */ function _decreaseUserTwab(address _to, uint256 _amount) internal { if (_amount == 0) { return; } TwabLib.Account storage _account = userTwabs[_to]; ( TwabLib.AccountDetails memory accountDetails, ObservationLib.Observation memory twab, bool isNew ) = TwabLib.decreaseBalance( _account, _amount.toUint208(), "Ticket/twab-burn-lt-balance", uint32(block.timestamp) ); _account.details = accountDetails; if (isNew) { emit NewUserTwab(_to, twab); } } /// @notice Decreases the total supply twab. Should be called anytime a balance moves from delegated to undelegated /// @param _amount The amount to decrease the total by function _decreaseTotalSupplyTwab(uint256 _amount) internal { if (_amount == 0) { return; } ( TwabLib.AccountDetails memory accountDetails, ObservationLib.Observation memory tsTwab, bool tsIsNew ) = TwabLib.decreaseBalance( totalSupplyTwab, _amount.toUint208(), "Ticket/burn-amount-exceeds-total-supply-twab", uint32(block.timestamp) ); totalSupplyTwab.details = accountDetails; if (tsIsNew) { emit NewTotalSupplyTwab(tsTwab); } } /// @notice Increases the total supply twab. Should be called anytime a balance moves from undelegated to delegated /// @param _amount The amount to increase the total by function _increaseTotalSupplyTwab(uint256 _amount) internal { if (_amount == 0) { return; } ( TwabLib.AccountDetails memory accountDetails, ObservationLib.Observation memory _totalSupply, bool tsIsNew ) = TwabLib.increaseBalance(totalSupplyTwab, _amount.toUint208(), uint32(block.timestamp)); totalSupplyTwab.details = accountDetails; if (tsIsNew) { emit NewTotalSupplyTwab(_totalSupply); } } // @inheritdoc ERC20 function _beforeTokenTransfer( address _from, address _to, uint256 _amount ) internal override { if (_from == _to) { return; } address _fromDelegate; if (_from != address(0)) { _fromDelegate = delegates[_from]; } address _toDelegate; if (_to != address(0)) { _toDelegate = delegates[_to]; } _transferTwab(_fromDelegate, _toDelegate, _amount); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (access/AccessControl.sol) pragma solidity ^0.8.0; import "./IAccessControl.sol"; import "../utils/Context.sol"; import "../utils/Strings.sol"; import "../utils/introspection/ERC165.sol"; /** * @dev Contract module that allows children to implement role-based access * control mechanisms. This is a lightweight version that doesn't allow enumerating role * members except through off-chain means by accessing the contract event logs. Some * applications may benefit from on-chain enumerability, for those cases see * {AccessControlEnumerable}. * * Roles are referred to by their `bytes32` identifier. These should be exposed * in the external API and be unique. The best way to achieve this is by * using `public constant` hash digests: * * ``` * bytes32 public constant MY_ROLE = keccak256("MY_ROLE"); * ``` * * Roles can be used to represent a set of permissions. To restrict access to a * function call, use {hasRole}: * * ``` * function foo() public { * require(hasRole(MY_ROLE, msg.sender)); * ... * } * ``` * * Roles can be granted and revoked dynamically via the {grantRole} and * {revokeRole} functions. Each role has an associated admin role, and only * accounts that have a role's admin role can call {grantRole} and {revokeRole}. * * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means * that only accounts with this role will be able to grant or revoke other * roles. More complex role relationships can be created by using * {_setRoleAdmin}. * * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to * grant and revoke this role. Extra precautions should be taken to secure * accounts that have been granted it. */ abstract contract AccessControl is Context, IAccessControl, ERC165 { struct RoleData { mapping(address => bool) members; bytes32 adminRole; } mapping(bytes32 => RoleData) private _roles; bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; /** * @dev Modifier that checks that an account has a specific role. Reverts * with a standardized message including the required role. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ * * _Available since v4.1._ */ modifier onlyRole(bytes32 role) { _checkRole(role); _; } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId); } /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) public view virtual override returns (bool) { return _roles[role].members[account]; } /** * @dev Revert with a standard message if `_msgSender()` is missing `role`. * Overriding this function changes the behavior of the {onlyRole} modifier. * * Format of the revert message is described in {_checkRole}. * * _Available since v4.6._ */ function _checkRole(bytes32 role) internal view virtual { _checkRole(role, _msgSender()); } /** * @dev Revert with a standard message if `account` is missing `role`. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ */ function _checkRole(bytes32 role, address account) internal view virtual { if (!hasRole(role, account)) { revert( string( abi.encodePacked( "AccessControl: account ", Strings.toHexString(uint160(account), 20), " is missing role ", Strings.toHexString(uint256(role), 32) ) ) ); } } /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) { return _roles[role].adminRole; } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. * * May emit a {RoleGranted} event. */ function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _grantRole(role, account); } /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. * * May emit a {RoleRevoked} event. */ function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _revokeRole(role, account); } /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been revoked `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. * * May emit a {RoleRevoked} event. */ function renounceRole(bytes32 role, address account) public virtual override { require(account == _msgSender(), "AccessControl: can only renounce roles for self"); _revokeRole(role, account); } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. Note that unlike {grantRole}, this function doesn't perform any * checks on the calling account. * * May emit a {RoleGranted} event. * * [WARNING] * ==== * This function should only be called from the constructor when setting * up the initial roles for the system. * * Using this function in any other way is effectively circumventing the admin * system imposed by {AccessControl}. * ==== * * NOTE: This function is deprecated in favor of {_grantRole}. */ function _setupRole(bytes32 role, address account) internal virtual { _grantRole(role, account); } /** * @dev Sets `adminRole` as ``role``'s admin role. * * Emits a {RoleAdminChanged} event. */ function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual { bytes32 previousAdminRole = getRoleAdmin(role); _roles[role].adminRole = adminRole; emit RoleAdminChanged(role, previousAdminRole, adminRole); } /** * @dev Grants `role` to `account`. * * Internal function without access restriction. * * May emit a {RoleGranted} event. */ function _grantRole(bytes32 role, address account) internal virtual { if (!hasRole(role, account)) { _roles[role].members[account] = true; emit RoleGranted(role, account, _msgSender()); } } /** * @dev Revokes `role` from `account`. * * Internal function without access restriction. * * May emit a {RoleRevoked} event. */ function _revokeRole(bytes32 role, address account) internal virtual { if (hasRole(role, account)) { _roles[role].members[account] = false; emit RoleRevoked(role, account, _msgSender()); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (access/AccessControlEnumerable.sol) pragma solidity ^0.8.0; import "./IAccessControlEnumerable.sol"; import "./AccessControl.sol"; import "../utils/structs/EnumerableSet.sol"; /** * @dev Extension of {AccessControl} that allows enumerating the members of each role. */ abstract contract AccessControlEnumerable is IAccessControlEnumerable, AccessControl { using EnumerableSet for EnumerableSet.AddressSet; mapping(bytes32 => EnumerableSet.AddressSet) private _roleMembers; /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IAccessControlEnumerable).interfaceId || super.supportsInterface(interfaceId); } /** * @dev Returns one of the accounts that have `role`. `index` must be a * value between 0 and {getRoleMemberCount}, non-inclusive. * * Role bearers are not sorted in any particular way, and their ordering may * change at any point. * * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure * you perform all queries on the same block. See the following * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] * for more information. */ function getRoleMember(bytes32 role, uint256 index) public view virtual override returns (address) { return _roleMembers[role].at(index); } /** * @dev Returns the number of accounts that have `role`. Can be used * together with {getRoleMember} to enumerate all bearers of a role. */ function getRoleMemberCount(bytes32 role) public view virtual override returns (uint256) { return _roleMembers[role].length(); } /** * @dev Overload {_grantRole} to track enumerable memberships */ function _grantRole(bytes32 role, address account) internal virtual override { super._grantRole(role, account); _roleMembers[role].add(account); } /** * @dev Overload {_revokeRole} to track enumerable memberships */ function _revokeRole(bytes32 role, address account) internal virtual override { super._revokeRole(role, account); _roleMembers[role].remove(account); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol) pragma solidity ^0.8.0; /** * @dev External interface of AccessControl declared to support ERC165 detection. */ interface IAccessControl { /** * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole` * * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite * {RoleAdminChanged} not being emitted signaling this. * * _Available since v3.1._ */ event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole); /** * @dev Emitted when `account` is granted `role`. * * `sender` is the account that originated the contract call, an admin role * bearer except when using {AccessControl-_setupRole}. */ event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Emitted when `account` is revoked `role`. * * `sender` is the account that originated the contract call: * - if using `revokeRole`, it is the admin role bearer * - if using `renounceRole`, it is the role bearer (i.e. `account`) */ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) external view returns (bool); /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {AccessControl-_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) external view returns (bytes32); /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function grantRole(bytes32 role, address account) external; /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function revokeRole(bytes32 role, address account) external; /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been granted `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. */ function renounceRole(bytes32 role, address account) external; }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (access/IAccessControlEnumerable.sol) pragma solidity ^0.8.0; import "./IAccessControl.sol"; /** * @dev External interface of AccessControlEnumerable declared to support ERC165 detection. */ interface IAccessControlEnumerable is IAccessControl { /** * @dev Returns one of the accounts that have `role`. `index` must be a * value between 0 and {getRoleMemberCount}, non-inclusive. * * Role bearers are not sorted in any particular way, and their ordering may * change at any point. * * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure * you perform all queries on the same block. See the following * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] * for more information. */ function getRoleMember(bytes32 role, uint256 index) external view returns (address); /** * @dev Returns the number of accounts that have `role`. Can be used * together with {getRoleMember} to enumerate all bearers of a role. */ function getRoleMemberCount(bytes32 role) external view returns (uint256); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) pragma solidity ^0.8.0; import "../utils/Context.sol"; /** * @dev Contract module which provides a basic access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * By default, the owner account will be the one that deploys the contract. This * can later be changed with {transferOwnership}. * * This module is used through inheritance. It will make available the modifier * `onlyOwner`, which can be applied to your functions to restrict their use to * the owner. */ abstract contract Ownable is Context { address private _owner; event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the deployer as the initial owner. */ constructor() { _transferOwnership(_msgSender()); } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { _checkOwner(); _; } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { return _owner; } /** * @dev Throws if the sender is not the owner. */ function _checkOwner() internal view virtual { require(owner() == _msgSender(), "Ownable: caller is not the owner"); } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions anymore. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby removing any functionality that is only available to the owner. */ function renounceOwnership() public virtual onlyOwner { _transferOwnership(address(0)); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Can only be called by the current owner. */ function transferOwnership(address newOwner) public virtual onlyOwner { require(newOwner != address(0), "Ownable: new owner is the zero address"); _transferOwnership(newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual { address oldOwner = _owner; _owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/ERC20.sol) pragma solidity ^0.8.0; import "./IERC20.sol"; import "./extensions/IERC20Metadata.sol"; import "../../utils/Context.sol"; /** * @dev Implementation of the {IERC20} interface. * * This implementation is agnostic to the way tokens are created. This means * that a supply mechanism has to be added in a derived contract using {_mint}. * For a generic mechanism see {ERC20PresetMinterPauser}. * * TIP: For a detailed writeup see our guide * https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How * to implement supply mechanisms]. * * We have followed general OpenZeppelin Contracts guidelines: functions revert * instead returning `false` on failure. This behavior is nonetheless * conventional and does not conflict with the expectations of ERC20 * applications. * * Additionally, an {Approval} event is emitted on calls to {transferFrom}. * This allows applications to reconstruct the allowance for all accounts just * by listening to said events. Other implementations of the EIP may not emit * these events, as it isn't required by the specification. * * Finally, the non-standard {decreaseAllowance} and {increaseAllowance} * functions have been added to mitigate the well-known issues around setting * allowances. See {IERC20-approve}. */ contract ERC20 is Context, IERC20, IERC20Metadata { mapping(address => uint256) private _balances; mapping(address => mapping(address => uint256)) private _allowances; uint256 private _totalSupply; string private _name; string private _symbol; /** * @dev Sets the values for {name} and {symbol}. * * The default value of {decimals} is 18. To select a different value for * {decimals} you should overload it. * * All two of these values are immutable: they can only be set once during * construction. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; } /** * @dev Returns the name of the token. */ function name() public view virtual override returns (string memory) { return _name; } /** * @dev Returns the symbol of the token, usually a shorter version of the * name. */ function symbol() public view virtual override returns (string memory) { return _symbol; } /** * @dev Returns the number of decimals used to get its user representation. * For example, if `decimals` equals `2`, a balance of `505` tokens should * be displayed to a user as `5.05` (`505 / 10 ** 2`). * * Tokens usually opt for a value of 18, imitating the relationship between * Ether and Wei. This is the value {ERC20} uses, unless this function is * overridden; * * NOTE: This information is only used for _display_ purposes: it in * no way affects any of the arithmetic of the contract, including * {IERC20-balanceOf} and {IERC20-transfer}. */ function decimals() public view virtual override returns (uint8) { return 18; } /** * @dev See {IERC20-totalSupply}. */ function totalSupply() public view virtual override returns (uint256) { return _totalSupply; } /** * @dev See {IERC20-balanceOf}. */ function balanceOf(address account) public view virtual override returns (uint256) { return _balances[account]; } /** * @dev See {IERC20-transfer}. * * Requirements: * * - `to` cannot be the zero address. * - the caller must have a balance of at least `amount`. */ function transfer(address to, uint256 amount) public virtual override returns (bool) { address owner = _msgSender(); _transfer(owner, to, amount); return true; } /** * @dev See {IERC20-allowance}. */ function allowance(address owner, address spender) public view virtual override returns (uint256) { return _allowances[owner][spender]; } /** * @dev See {IERC20-approve}. * * NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on * `transferFrom`. This is semantically equivalent to an infinite approval. * * Requirements: * * - `spender` cannot be the zero address. */ function approve(address spender, uint256 amount) public virtual override returns (bool) { address owner = _msgSender(); _approve(owner, spender, amount); return true; } /** * @dev See {IERC20-transferFrom}. * * Emits an {Approval} event indicating the updated allowance. This is not * required by the EIP. See the note at the beginning of {ERC20}. * * NOTE: Does not update the allowance if the current allowance * is the maximum `uint256`. * * Requirements: * * - `from` and `to` cannot be the zero address. * - `from` must have a balance of at least `amount`. * - the caller must have allowance for ``from``'s tokens of at least * `amount`. */ function transferFrom( address from, address to, uint256 amount ) public virtual override returns (bool) { address spender = _msgSender(); _spendAllowance(from, spender, amount); _transfer(from, to, amount); return true; } /** * @dev Atomically increases the allowance granted to `spender` by the caller. * * This is an alternative to {approve} that can be used as a mitigation for * problems described in {IERC20-approve}. * * Emits an {Approval} event indicating the updated allowance. * * Requirements: * * - `spender` cannot be the zero address. */ function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) { address owner = _msgSender(); _approve(owner, spender, allowance(owner, spender) + addedValue); return true; } /** * @dev Atomically decreases the allowance granted to `spender` by the caller. * * This is an alternative to {approve} that can be used as a mitigation for * problems described in {IERC20-approve}. * * Emits an {Approval} event indicating the updated allowance. * * Requirements: * * - `spender` cannot be the zero address. * - `spender` must have allowance for the caller of at least * `subtractedValue`. */ function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) { address owner = _msgSender(); uint256 currentAllowance = allowance(owner, spender); require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero"); unchecked { _approve(owner, spender, currentAllowance - subtractedValue); } return true; } /** * @dev Moves `amount` of tokens from `from` to `to`. * * This internal function is equivalent to {transfer}, and can be used to * e.g. implement automatic token fees, slashing mechanisms, etc. * * Emits a {Transfer} event. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `from` must have a balance of at least `amount`. */ function _transfer( address from, address to, uint256 amount ) internal virtual { require(from != address(0), "ERC20: transfer from the zero address"); require(to != address(0), "ERC20: transfer to the zero address"); _beforeTokenTransfer(from, to, amount); uint256 fromBalance = _balances[from]; require(fromBalance >= amount, "ERC20: transfer amount exceeds balance"); unchecked { _balances[from] = fromBalance - amount; } _balances[to] += amount; emit Transfer(from, to, amount); _afterTokenTransfer(from, to, amount); } /** @dev Creates `amount` tokens and assigns them to `account`, increasing * the total supply. * * Emits a {Transfer} event with `from` set to the zero address. * * Requirements: * * - `account` cannot be the zero address. */ function _mint(address account, uint256 amount) internal virtual { require(account != address(0), "ERC20: mint to the zero address"); _beforeTokenTransfer(address(0), account, amount); _totalSupply += amount; _balances[account] += amount; emit Transfer(address(0), account, amount); _afterTokenTransfer(address(0), account, amount); } /** * @dev Destroys `amount` tokens from `account`, reducing the * total supply. * * Emits a {Transfer} event with `to` set to the zero address. * * Requirements: * * - `account` cannot be the zero address. * - `account` must have at least `amount` tokens. */ function _burn(address account, uint256 amount) internal virtual { require(account != address(0), "ERC20: burn from the zero address"); _beforeTokenTransfer(account, address(0), amount); uint256 accountBalance = _balances[account]; require(accountBalance >= amount, "ERC20: burn amount exceeds balance"); unchecked { _balances[account] = accountBalance - amount; } _totalSupply -= amount; emit Transfer(account, address(0), amount); _afterTokenTransfer(account, address(0), amount); } /** * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens. * * This internal function is equivalent to `approve`, and can be used to * e.g. set automatic allowances for certain subsystems, etc. * * Emits an {Approval} event. * * Requirements: * * - `owner` cannot be the zero address. * - `spender` cannot be the zero address. */ function _approve( address owner, address spender, uint256 amount ) internal virtual { require(owner != address(0), "ERC20: approve from the zero address"); require(spender != address(0), "ERC20: approve to the zero address"); _allowances[owner][spender] = amount; emit Approval(owner, spender, amount); } /** * @dev Updates `owner` s allowance for `spender` based on spent `amount`. * * Does not update the allowance amount in case of infinite allowance. * Revert if not enough allowance is available. * * Might emit an {Approval} event. */ function _spendAllowance( address owner, address spender, uint256 amount ) internal virtual { uint256 currentAllowance = allowance(owner, spender); if (currentAllowance != type(uint256).max) { require(currentAllowance >= amount, "ERC20: insufficient allowance"); unchecked { _approve(owner, spender, currentAllowance - amount); } } } /** * @dev Hook that is called before any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens * will be transferred to `to`. * - when `from` is zero, `amount` tokens will be minted for `to`. * - when `to` is zero, `amount` of ``from``'s tokens will be burned. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _beforeTokenTransfer( address from, address to, uint256 amount ) internal virtual {} /** * @dev Hook that is called after any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens * has been transferred to `to`. * - when `from` is zero, `amount` tokens have been minted for `to`. * - when `to` is zero, `amount` of ``from``'s tokens have been burned. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _afterTokenTransfer( address from, address to, uint256 amount ) internal virtual {} }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 amount) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `from` to `to` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 amount ) external returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol) pragma solidity ^0.8.0; import "../IERC20.sol"; /** * @dev Interface for the optional metadata functions from the ERC20 standard. * * _Available since v4.1._ */ interface IERC20Metadata is IERC20 { /** * @dev Returns the name of the token. */ function name() external view returns (string memory); /** * @dev Returns the symbol of the token. */ function symbol() external view returns (string memory); /** * @dev Returns the decimals places of the token. */ function decimals() external view returns (uint8); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/extensions/draft-ERC20Permit.sol) pragma solidity ^0.8.0; import "./draft-IERC20Permit.sol"; import "../ERC20.sol"; import "../../../utils/cryptography/draft-EIP712.sol"; import "../../../utils/cryptography/ECDSA.sol"; import "../../../utils/Counters.sol"; /** * @dev Implementation of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on `{IERC20-approve}`, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. * * _Available since v3.4._ */ abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712 { using Counters for Counters.Counter; mapping(address => Counters.Counter) private _nonces; // solhint-disable-next-line var-name-mixedcase bytes32 private constant _PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); /** * @dev In previous versions `_PERMIT_TYPEHASH` was declared as `immutable`. * However, to ensure consistency with the upgradeable transpiler, we will continue * to reserve a slot. * @custom:oz-renamed-from _PERMIT_TYPEHASH */ // solhint-disable-next-line var-name-mixedcase bytes32 private _PERMIT_TYPEHASH_DEPRECATED_SLOT; /** * @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`. * * It's a good idea to use the same `name` that is defined as the ERC20 token name. */ constructor(string memory name) EIP712(name, "1") {} /** * @dev See {IERC20Permit-permit}. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual override { require(block.timestamp <= deadline, "ERC20Permit: expired deadline"); bytes32 structHash = keccak256(abi.encode(_PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline)); bytes32 hash = _hashTypedDataV4(structHash); address signer = ECDSA.recover(hash, v, r, s); require(signer == owner, "ERC20Permit: invalid signature"); _approve(owner, spender, value); } /** * @dev See {IERC20Permit-nonces}. */ function nonces(address owner) public view virtual override returns (uint256) { return _nonces[owner].current(); } /** * @dev See {IERC20Permit-DOMAIN_SEPARATOR}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view override returns (bytes32) { return _domainSeparatorV4(); } /** * @dev "Consume a nonce": return the current value and increment. * * _Available since v4.1._ */ function _useNonce(address owner) internal virtual returns (uint256 current) { Counters.Counter storage nonce = _nonces[owner]; current = nonce.current(); nonce.increment(); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IERC20Permit { /** * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens, * given ``owner``'s signed approval. * * IMPORTANT: The same issues {IERC20-approve} has related to transaction * ordering also apply here. * * Emits an {Approval} event. * * Requirements: * * - `spender` cannot be the zero address. * - `deadline` must be a timestamp in the future. * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner` * over the EIP712-formatted function arguments. * - the signature must use ``owner``'s current nonce (see {nonces}). * * For more information on the signature format, see the * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP * section]. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external; /** * @dev Returns the current nonce for `owner`. This value must be * included whenever a signature is generated for {permit}. * * Every successful call to {permit} increases ``owner``'s nonce by one. This * prevents a signature from being used multiple times. */ function nonces(address owner) external view returns (uint256); /** * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view returns (bytes32); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.0; import "../IERC20.sol"; import "../extensions/draft-IERC20Permit.sol"; import "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } function safePermit( IERC20Permit token, address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { uint256 nonceBefore = token.nonces(owner); token.permit(owner, spender, value, deadline, v, r, s); uint256 nonceAfter = token.nonces(owner); require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed"); } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/ERC721.sol) pragma solidity ^0.8.0; import "./IERC721.sol"; import "./IERC721Receiver.sol"; import "./extensions/IERC721Metadata.sol"; import "../../utils/Address.sol"; import "../../utils/Context.sol"; import "../../utils/Strings.sol"; import "../../utils/introspection/ERC165.sol"; /** * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including * the Metadata extension, but not including the Enumerable extension, which is available separately as * {ERC721Enumerable}. */ contract ERC721 is Context, ERC165, IERC721, IERC721Metadata { using Address for address; using Strings for uint256; // Token name string private _name; // Token symbol string private _symbol; // Mapping from token ID to owner address mapping(uint256 => address) private _owners; // Mapping owner address to token count mapping(address => uint256) private _balances; // Mapping from token ID to approved address mapping(uint256 => address) private _tokenApprovals; // Mapping from owner to operator approvals mapping(address => mapping(address => bool)) private _operatorApprovals; /** * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) { return interfaceId == type(IERC721).interfaceId || interfaceId == type(IERC721Metadata).interfaceId || super.supportsInterface(interfaceId); } /** * @dev See {IERC721-balanceOf}. */ function balanceOf(address owner) public view virtual override returns (uint256) { require(owner != address(0), "ERC721: address zero is not a valid owner"); return _balances[owner]; } /** * @dev See {IERC721-ownerOf}. */ function ownerOf(uint256 tokenId) public view virtual override returns (address) { address owner = _owners[tokenId]; require(owner != address(0), "ERC721: invalid token ID"); return owner; } /** * @dev See {IERC721Metadata-name}. */ function name() public view virtual override returns (string memory) { return _name; } /** * @dev See {IERC721Metadata-symbol}. */ function symbol() public view virtual override returns (string memory) { return _symbol; } /** * @dev See {IERC721Metadata-tokenURI}. */ function tokenURI(uint256 tokenId) public view virtual override returns (string memory) { _requireMinted(tokenId); string memory baseURI = _baseURI(); return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : ""; } /** * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each * token will be the concatenation of the `baseURI` and the `tokenId`. Empty * by default, can be overridden in child contracts. */ function _baseURI() internal view virtual returns (string memory) { return ""; } /** * @dev See {IERC721-approve}. */ function approve(address to, uint256 tokenId) public virtual override { address owner = ERC721.ownerOf(tokenId); require(to != owner, "ERC721: approval to current owner"); require( _msgSender() == owner || isApprovedForAll(owner, _msgSender()), "ERC721: approve caller is not token owner nor approved for all" ); _approve(to, tokenId); } /** * @dev See {IERC721-getApproved}. */ function getApproved(uint256 tokenId) public view virtual override returns (address) { _requireMinted(tokenId); return _tokenApprovals[tokenId]; } /** * @dev See {IERC721-setApprovalForAll}. */ function setApprovalForAll(address operator, bool approved) public virtual override { _setApprovalForAll(_msgSender(), operator, approved); } /** * @dev See {IERC721-isApprovedForAll}. */ function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) { return _operatorApprovals[owner][operator]; } /** * @dev See {IERC721-transferFrom}. */ function transferFrom( address from, address to, uint256 tokenId ) public virtual override { //solhint-disable-next-line max-line-length require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved"); _transfer(from, to, tokenId); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address from, address to, uint256 tokenId ) public virtual override { safeTransferFrom(from, to, tokenId, ""); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address from, address to, uint256 tokenId, bytes memory data ) public virtual override { require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved"); _safeTransfer(from, to, tokenId, data); } /** * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients * are aware of the ERC721 protocol to prevent tokens from being forever locked. * * `data` is additional data, it has no specified format and it is sent in call to `to`. * * This internal function is equivalent to {safeTransferFrom}, and can be used to e.g. * implement alternative mechanisms to perform token transfer, such as signature-based. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function _safeTransfer( address from, address to, uint256 tokenId, bytes memory data ) internal virtual { _transfer(from, to, tokenId); require(_checkOnERC721Received(from, to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer"); } /** * @dev Returns whether `tokenId` exists. * * Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}. * * Tokens start existing when they are minted (`_mint`), * and stop existing when they are burned (`_burn`). */ function _exists(uint256 tokenId) internal view virtual returns (bool) { return _owners[tokenId] != address(0); } /** * @dev Returns whether `spender` is allowed to manage `tokenId`. * * Requirements: * * - `tokenId` must exist. */ function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool) { address owner = ERC721.ownerOf(tokenId); return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender); } /** * @dev Safely mints `tokenId` and transfers it to `to`. * * Requirements: * * - `tokenId` must not exist. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function _safeMint(address to, uint256 tokenId) internal virtual { _safeMint(to, tokenId, ""); } /** * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is * forwarded in {IERC721Receiver-onERC721Received} to contract recipients. */ function _safeMint( address to, uint256 tokenId, bytes memory data ) internal virtual { _mint(to, tokenId); require( _checkOnERC721Received(address(0), to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer" ); } /** * @dev Mints `tokenId` and transfers it to `to`. * * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible * * Requirements: * * - `tokenId` must not exist. * - `to` cannot be the zero address. * * Emits a {Transfer} event. */ function _mint(address to, uint256 tokenId) internal virtual { require(to != address(0), "ERC721: mint to the zero address"); require(!_exists(tokenId), "ERC721: token already minted"); _beforeTokenTransfer(address(0), to, tokenId); _balances[to] += 1; _owners[tokenId] = to; emit Transfer(address(0), to, tokenId); _afterTokenTransfer(address(0), to, tokenId); } /** * @dev Destroys `tokenId`. * The approval is cleared when the token is burned. * * Requirements: * * - `tokenId` must exist. * * Emits a {Transfer} event. */ function _burn(uint256 tokenId) internal virtual { address owner = ERC721.ownerOf(tokenId); _beforeTokenTransfer(owner, address(0), tokenId); // Clear approvals _approve(address(0), tokenId); _balances[owner] -= 1; delete _owners[tokenId]; emit Transfer(owner, address(0), tokenId); _afterTokenTransfer(owner, address(0), tokenId); } /** * @dev Transfers `tokenId` from `from` to `to`. * As opposed to {transferFrom}, this imposes no restrictions on msg.sender. * * Requirements: * * - `to` cannot be the zero address. * - `tokenId` token must be owned by `from`. * * Emits a {Transfer} event. */ function _transfer( address from, address to, uint256 tokenId ) internal virtual { require(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner"); require(to != address(0), "ERC721: transfer to the zero address"); _beforeTokenTransfer(from, to, tokenId); // Clear approvals from the previous owner _approve(address(0), tokenId); _balances[from] -= 1; _balances[to] += 1; _owners[tokenId] = to; emit Transfer(from, to, tokenId); _afterTokenTransfer(from, to, tokenId); } /** * @dev Approve `to` to operate on `tokenId` * * Emits an {Approval} event. */ function _approve(address to, uint256 tokenId) internal virtual { _tokenApprovals[tokenId] = to; emit Approval(ERC721.ownerOf(tokenId), to, tokenId); } /** * @dev Approve `operator` to operate on all of `owner` tokens * * Emits an {ApprovalForAll} event. */ function _setApprovalForAll( address owner, address operator, bool approved ) internal virtual { require(owner != operator, "ERC721: approve to caller"); _operatorApprovals[owner][operator] = approved; emit ApprovalForAll(owner, operator, approved); } /** * @dev Reverts if the `tokenId` has not been minted yet. */ function _requireMinted(uint256 tokenId) internal view virtual { require(_exists(tokenId), "ERC721: invalid token ID"); } /** * @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address. * The call is not executed if the target address is not a contract. * * @param from address representing the previous owner of the given token ID * @param to target address that will receive the tokens * @param tokenId uint256 ID of the token to be transferred * @param data bytes optional data to send along with the call * @return bool whether the call correctly returned the expected magic value */ function _checkOnERC721Received( address from, address to, uint256 tokenId, bytes memory data ) private returns (bool) { if (to.isContract()) { try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) { return retval == IERC721Receiver.onERC721Received.selector; } catch (bytes memory reason) { if (reason.length == 0) { revert("ERC721: transfer to non ERC721Receiver implementer"); } else { /// @solidity memory-safe-assembly assembly { revert(add(32, reason), mload(reason)) } } } } else { return true; } } /** * @dev Hook that is called before any token transfer. This includes minting * and burning. * * Calling conditions: * * - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be * transferred to `to`. * - When `from` is zero, `tokenId` will be minted for `to`. * - When `to` is zero, ``from``'s `tokenId` will be burned. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _beforeTokenTransfer( address from, address to, uint256 tokenId ) internal virtual {} /** * @dev Hook that is called after any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _afterTokenTransfer( address from, address to, uint256 tokenId ) internal virtual {} }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/IERC721.sol) pragma solidity ^0.8.0; import "../../utils/introspection/IERC165.sol"; /** * @dev Required interface of an ERC721 compliant contract. */ interface IERC721 is IERC165 { /** * @dev Emitted when `tokenId` token is transferred from `from` to `to`. */ event Transfer(address indexed from, address indexed to, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token. */ event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets. */ event ApprovalForAll(address indexed owner, address indexed operator, bool approved); /** * @dev Returns the number of tokens in ``owner``'s account. */ function balanceOf(address owner) external view returns (uint256 balance); /** * @dev Returns the owner of the `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function ownerOf(uint256 tokenId) external view returns (address owner); /** * @dev Safely transfers `tokenId` token from `from` to `to`. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId, bytes calldata data ) external; /** * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients * are aware of the ERC721 protocol to prevent tokens from being forever locked. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Transfers `tokenId` token from `from` to `to`. * * WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Gives permission to `to` to transfer `tokenId` token to another account. * The approval is cleared when the token is transferred. * * Only a single account can be approved at a time, so approving the zero address clears previous approvals. * * Requirements: * * - The caller must own the token or be an approved operator. * - `tokenId` must exist. * * Emits an {Approval} event. */ function approve(address to, uint256 tokenId) external; /** * @dev Approve or remove `operator` as an operator for the caller. * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller. * * Requirements: * * - The `operator` cannot be the caller. * * Emits an {ApprovalForAll} event. */ function setApprovalForAll(address operator, bool _approved) external; /** * @dev Returns the account approved for `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function getApproved(uint256 tokenId) external view returns (address operator); /** * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`. * * See {setApprovalForAll} */ function isApprovedForAll(address owner, address operator) external view returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC721/IERC721Receiver.sol) pragma solidity ^0.8.0; /** * @title ERC721 token receiver interface * @dev Interface for any contract that wants to support safeTransfers * from ERC721 asset contracts. */ interface IERC721Receiver { /** * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom} * by `operator` from `from`, this function is called. * * It must return its Solidity selector to confirm the token transfer. * If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted. * * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`. */ function onERC721Received( address operator, address from, uint256 tokenId, bytes calldata data ) external returns (bytes4); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol) pragma solidity ^0.8.0; import "../IERC721.sol"; /** * @title ERC-721 Non-Fungible Token Standard, optional metadata extension * @dev See https://eips.ethereum.org/EIPS/eip-721 */ interface IERC721Metadata is IERC721 { /** * @dev Returns the token collection name. */ function name() external view returns (string memory); /** * @dev Returns the token collection symbol. */ function symbol() external view returns (string memory); /** * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token. */ function tokenURI(uint256 tokenId) external view returns (string memory); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol) pragma solidity ^0.8.1; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly /// @solidity memory-safe-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/Context.sol) pragma solidity ^0.8.0; /** * @dev Provides information about the current execution context, including the * sender of the transaction and its data. While these are generally available * via msg.sender and msg.data, they should not be accessed in such a direct * manner, since when dealing with meta-transactions the account sending and * paying for execution may not be the actual sender (as far as an application * is concerned). * * This contract is only required for intermediate, library-like contracts. */ abstract contract Context { function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/Counters.sol) pragma solidity ^0.8.0; /** * @title Counters * @author Matt Condon (@shrugs) * @dev Provides counters that can only be incremented, decremented or reset. This can be used e.g. to track the number * of elements in a mapping, issuing ERC721 ids, or counting request ids. * * Include with `using Counters for Counters.Counter;` */ library Counters { struct Counter { // This variable should never be directly accessed by users of the library: interactions must be restricted to // the library's function. As of Solidity v0.5.2, this cannot be enforced, though there is a proposal to add // this feature: see https://github.com/ethereum/solidity/issues/4637 uint256 _value; // default: 0 } function current(Counter storage counter) internal view returns (uint256) { return counter._value; } function increment(Counter storage counter) internal { unchecked { counter._value += 1; } } function decrement(Counter storage counter) internal { uint256 value = counter._value; require(value > 0, "Counter: decrement overflow"); unchecked { counter._value = value - 1; } } function reset(Counter storage counter) internal { counter._value = 0; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/Strings.sol) pragma solidity ^0.8.0; /** * @dev String operations. */ library Strings { bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef"; uint8 private constant _ADDRESS_LENGTH = 20; /** * @dev Converts a `uint256` to its ASCII `string` decimal representation. */ function toString(uint256 value) internal pure returns (string memory) { // Inspired by OraclizeAPI's implementation - MIT licence // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol if (value == 0) { return "0"; } uint256 temp = value; uint256 digits; while (temp != 0) { digits++; temp /= 10; } bytes memory buffer = new bytes(digits); while (value != 0) { digits -= 1; buffer[digits] = bytes1(uint8(48 + uint256(value % 10))); value /= 10; } return string(buffer); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation. */ function toHexString(uint256 value) internal pure returns (string memory) { if (value == 0) { return "0x00"; } uint256 temp = value; uint256 length = 0; while (temp != 0) { length++; temp >>= 8; } return toHexString(value, length); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length. */ function toHexString(uint256 value, uint256 length) internal pure returns (string memory) { bytes memory buffer = new bytes(2 * length + 2); buffer[0] = "0"; buffer[1] = "x"; for (uint256 i = 2 * length + 1; i > 1; --i) { buffer[i] = _HEX_SYMBOLS[value & 0xf]; value >>= 4; } require(value == 0, "Strings: hex length insufficient"); return string(buffer); } /** * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation. */ function toHexString(address addr) internal pure returns (string memory) { return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/cryptography/ECDSA.sol) pragma solidity ^0.8.0; import "../Strings.sol"; /** * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations. * * These functions can be used to verify that a message was signed by the holder * of the private keys of a given address. */ library ECDSA { enum RecoverError { NoError, InvalidSignature, InvalidSignatureLength, InvalidSignatureS, InvalidSignatureV } function _throwError(RecoverError error) private pure { if (error == RecoverError.NoError) { return; // no error: do nothing } else if (error == RecoverError.InvalidSignature) { revert("ECDSA: invalid signature"); } else if (error == RecoverError.InvalidSignatureLength) { revert("ECDSA: invalid signature length"); } else if (error == RecoverError.InvalidSignatureS) { revert("ECDSA: invalid signature 's' value"); } else if (error == RecoverError.InvalidSignatureV) { revert("ECDSA: invalid signature 'v' value"); } } /** * @dev Returns the address that signed a hashed message (`hash`) with * `signature` or error string. This address can then be used for verification purposes. * * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures: * this function rejects them by requiring the `s` value to be in the lower * half order, and the `v` value to be either 27 or 28. * * IMPORTANT: `hash` _must_ be the result of a hash operation for the * verification to be secure: it is possible to craft signatures that * recover to arbitrary addresses for non-hashed data. A safe way to ensure * this is by receiving a hash of the original message (which may otherwise * be too long), and then calling {toEthSignedMessageHash} on it. * * Documentation for signature generation: * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js] * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers] * * _Available since v4.3._ */ function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) { // Check the signature length // - case 65: r,s,v signature (standard) // - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098) _Available since v4.1._ if (signature.length == 65) { bytes32 r; bytes32 s; uint8 v; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. /// @solidity memory-safe-assembly assembly { r := mload(add(signature, 0x20)) s := mload(add(signature, 0x40)) v := byte(0, mload(add(signature, 0x60))) } return tryRecover(hash, v, r, s); } else if (signature.length == 64) { bytes32 r; bytes32 vs; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. /// @solidity memory-safe-assembly assembly { r := mload(add(signature, 0x20)) vs := mload(add(signature, 0x40)) } return tryRecover(hash, r, vs); } else { return (address(0), RecoverError.InvalidSignatureLength); } } /** * @dev Returns the address that signed a hashed message (`hash`) with * `signature`. This address can then be used for verification purposes. * * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures: * this function rejects them by requiring the `s` value to be in the lower * half order, and the `v` value to be either 27 or 28. * * IMPORTANT: `hash` _must_ be the result of a hash operation for the * verification to be secure: it is possible to craft signatures that * recover to arbitrary addresses for non-hashed data. A safe way to ensure * this is by receiving a hash of the original message (which may otherwise * be too long), and then calling {toEthSignedMessageHash} on it. */ function recover(bytes32 hash, bytes memory signature) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, signature); _throwError(error); return recovered; } /** * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately. * * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures] * * _Available since v4.3._ */ function tryRecover( bytes32 hash, bytes32 r, bytes32 vs ) internal pure returns (address, RecoverError) { bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff); uint8 v = uint8((uint256(vs) >> 255) + 27); return tryRecover(hash, v, r, s); } /** * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately. * * _Available since v4.2._ */ function recover( bytes32 hash, bytes32 r, bytes32 vs ) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, r, vs); _throwError(error); return recovered; } /** * @dev Overload of {ECDSA-tryRecover} that receives the `v`, * `r` and `s` signature fields separately. * * _Available since v4.3._ */ function tryRecover( bytes32 hash, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address, RecoverError) { // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most // signatures from current libraries generate a unique signature with an s-value in the lower half order. // // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept // these malleable signatures as well. if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) { return (address(0), RecoverError.InvalidSignatureS); } if (v != 27 && v != 28) { return (address(0), RecoverError.InvalidSignatureV); } // If the signature is valid (and not malleable), return the signer address address signer = ecrecover(hash, v, r, s); if (signer == address(0)) { return (address(0), RecoverError.InvalidSignature); } return (signer, RecoverError.NoError); } /** * @dev Overload of {ECDSA-recover} that receives the `v`, * `r` and `s` signature fields separately. */ function recover( bytes32 hash, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, v, r, s); _throwError(error); return recovered; } /** * @dev Returns an Ethereum Signed Message, created from a `hash`. This * produces hash corresponding to the one signed with the * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] * JSON-RPC method as part of EIP-191. * * See {recover}. */ function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32) { // 32 is the length in bytes of hash, // enforced by the type signature above return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n32", hash)); } /** * @dev Returns an Ethereum Signed Message, created from `s`. This * produces hash corresponding to the one signed with the * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] * JSON-RPC method as part of EIP-191. * * See {recover}. */ function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) { return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n", Strings.toString(s.length), s)); } /** * @dev Returns an Ethereum Signed Typed Data, created from a * `domainSeparator` and a `structHash`. This produces hash corresponding * to the one signed with the * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] * JSON-RPC method as part of EIP-712. * * See {recover}. */ function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32) { return keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/cryptography/draft-EIP712.sol) pragma solidity ^0.8.0; import "./ECDSA.sol"; /** * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data. * * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible, * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding * they need in their contracts using a combination of `abi.encode` and `keccak256`. * * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA * ({_hashTypedDataV4}). * * The implementation of the domain separator was designed to be as efficient as possible while still properly updating * the chain id to protect against replay attacks on an eventual fork of the chain. * * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask]. * * _Available since v3.4._ */ abstract contract EIP712 { /* solhint-disable var-name-mixedcase */ // Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to // invalidate the cached domain separator if the chain id changes. bytes32 private immutable _CACHED_DOMAIN_SEPARATOR; uint256 private immutable _CACHED_CHAIN_ID; address private immutable _CACHED_THIS; bytes32 private immutable _HASHED_NAME; bytes32 private immutable _HASHED_VERSION; bytes32 private immutable _TYPE_HASH; /* solhint-enable var-name-mixedcase */ /** * @dev Initializes the domain separator and parameter caches. * * The meaning of `name` and `version` is specified in * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]: * * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol. * - `version`: the current major version of the signing domain. * * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart * contract upgrade]. */ constructor(string memory name, string memory version) { bytes32 hashedName = keccak256(bytes(name)); bytes32 hashedVersion = keccak256(bytes(version)); bytes32 typeHash = keccak256( "EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)" ); _HASHED_NAME = hashedName; _HASHED_VERSION = hashedVersion; _CACHED_CHAIN_ID = block.chainid; _CACHED_DOMAIN_SEPARATOR = _buildDomainSeparator(typeHash, hashedName, hashedVersion); _CACHED_THIS = address(this); _TYPE_HASH = typeHash; } /** * @dev Returns the domain separator for the current chain. */ function _domainSeparatorV4() internal view returns (bytes32) { if (address(this) == _CACHED_THIS && block.chainid == _CACHED_CHAIN_ID) { return _CACHED_DOMAIN_SEPARATOR; } else { return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION); } } function _buildDomainSeparator( bytes32 typeHash, bytes32 nameHash, bytes32 versionHash ) private view returns (bytes32) { return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this))); } /** * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this * function returns the hash of the fully encoded EIP712 message for this domain. * * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example: * * ```solidity * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode( * keccak256("Mail(address to,string contents)"), * mailTo, * keccak256(bytes(mailContents)) * ))); * address signer = ECDSA.recover(digest, signature); * ``` */ function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) { return ECDSA.toTypedDataHash(_domainSeparatorV4(), structHash); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol) pragma solidity ^0.8.0; import "./IERC165.sol"; /** * @dev Implementation of the {IERC165} interface. * * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check * for the additional interface id that will be supported. For example: * * ```solidity * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { * return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId); * } * ``` * * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation. */ abstract contract ERC165 is IERC165 { /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IERC165).interfaceId; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ interface IERC165 { /** * @dev Returns true if this contract implements the interface defined by * `interfaceId`. See the corresponding * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] * to learn more about how these ids are created. * * This function call must use less than 30 000 gas. */ function supportsInterface(bytes4 interfaceId) external view returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/math/SafeCast.sol) pragma solidity ^0.8.0; /** * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow * checks. * * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can * easily result in undesired exploitation or bugs, since developers usually * assume that overflows raise errors. `SafeCast` restores this intuition by * reverting the transaction when such an operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. * * Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing * all math on `uint256` and `int256` and then downcasting. */ library SafeCast { /** * @dev Returns the downcasted uint248 from uint256, reverting on * overflow (when the input is greater than largest uint248). * * Counterpart to Solidity's `uint248` operator. * * Requirements: * * - input must fit into 248 bits * * _Available since v4.7._ */ function toUint248(uint256 value) internal pure returns (uint248) { require(value <= type(uint248).max, "SafeCast: value doesn't fit in 248 bits"); return uint248(value); } /** * @dev Returns the downcasted uint240 from uint256, reverting on * overflow (when the input is greater than largest uint240). * * Counterpart to Solidity's `uint240` operator. * * Requirements: * * - input must fit into 240 bits * * _Available since v4.7._ */ function toUint240(uint256 value) internal pure returns (uint240) { require(value <= type(uint240).max, "SafeCast: value doesn't fit in 240 bits"); return uint240(value); } /** * @dev Returns the downcasted uint232 from uint256, reverting on * overflow (when the input is greater than largest uint232). * * Counterpart to Solidity's `uint232` operator. * * Requirements: * * - input must fit into 232 bits * * _Available since v4.7._ */ function toUint232(uint256 value) internal pure returns (uint232) { require(value <= type(uint232).max, "SafeCast: value doesn't fit in 232 bits"); return uint232(value); } /** * @dev Returns the downcasted uint224 from uint256, reverting on * overflow (when the input is greater than largest uint224). * * Counterpart to Solidity's `uint224` operator. * * Requirements: * * - input must fit into 224 bits * * _Available since v4.2._ */ function toUint224(uint256 value) internal pure returns (uint224) { require(value <= type(uint224).max, "SafeCast: value doesn't fit in 224 bits"); return uint224(value); } /** * @dev Returns the downcasted uint216 from uint256, reverting on * overflow (when the input is greater than largest uint216). * * Counterpart to Solidity's `uint216` operator. * * Requirements: * * - input must fit into 216 bits * * _Available since v4.7._ */ function toUint216(uint256 value) internal pure returns (uint216) { require(value <= type(uint216).max, "SafeCast: value doesn't fit in 216 bits"); return uint216(value); } /** * @dev Returns the downcasted uint208 from uint256, reverting on * overflow (when the input is greater than largest uint208). * * Counterpart to Solidity's `uint208` operator. * * Requirements: * * - input must fit into 208 bits * * _Available since v4.7._ */ function toUint208(uint256 value) internal pure returns (uint208) { require(value <= type(uint208).max, "SafeCast: value doesn't fit in 208 bits"); return uint208(value); } /** * @dev Returns the downcasted uint200 from uint256, reverting on * overflow (when the input is greater than largest uint200). * * Counterpart to Solidity's `uint200` operator. * * Requirements: * * - input must fit into 200 bits * * _Available since v4.7._ */ function toUint200(uint256 value) internal pure returns (uint200) { require(value <= type(uint200).max, "SafeCast: value doesn't fit in 200 bits"); return uint200(value); } /** * @dev Returns the downcasted uint192 from uint256, reverting on * overflow (when the input is greater than largest uint192). * * Counterpart to Solidity's `uint192` operator. * * Requirements: * * - input must fit into 192 bits * * _Available since v4.7._ */ function toUint192(uint256 value) internal pure returns (uint192) { require(value <= type(uint192).max, "SafeCast: value doesn't fit in 192 bits"); return uint192(value); } /** * @dev Returns the downcasted uint184 from uint256, reverting on * overflow (when the input is greater than largest uint184). * * Counterpart to Solidity's `uint184` operator. * * Requirements: * * - input must fit into 184 bits * * _Available since v4.7._ */ function toUint184(uint256 value) internal pure returns (uint184) { require(value <= type(uint184).max, "SafeCast: value doesn't fit in 184 bits"); return uint184(value); } /** * @dev Returns the downcasted uint176 from uint256, reverting on * overflow (when the input is greater than largest uint176). * * Counterpart to Solidity's `uint176` operator. * * Requirements: * * - input must fit into 176 bits * * _Available since v4.7._ */ function toUint176(uint256 value) internal pure returns (uint176) { require(value <= type(uint176).max, "SafeCast: value doesn't fit in 176 bits"); return uint176(value); } /** * @dev Returns the downcasted uint168 from uint256, reverting on * overflow (when the input is greater than largest uint168). * * Counterpart to Solidity's `uint168` operator. * * Requirements: * * - input must fit into 168 bits * * _Available since v4.7._ */ function toUint168(uint256 value) internal pure returns (uint168) { require(value <= type(uint168).max, "SafeCast: value doesn't fit in 168 bits"); return uint168(value); } /** * @dev Returns the downcasted uint160 from uint256, reverting on * overflow (when the input is greater than largest uint160). * * Counterpart to Solidity's `uint160` operator. * * Requirements: * * - input must fit into 160 bits * * _Available since v4.7._ */ function toUint160(uint256 value) internal pure returns (uint160) { require(value <= type(uint160).max, "SafeCast: value doesn't fit in 160 bits"); return uint160(value); } /** * @dev Returns the downcasted uint152 from uint256, reverting on * overflow (when the input is greater than largest uint152). * * Counterpart to Solidity's `uint152` operator. * * Requirements: * * - input must fit into 152 bits * * _Available since v4.7._ */ function toUint152(uint256 value) internal pure returns (uint152) { require(value <= type(uint152).max, "SafeCast: value doesn't fit in 152 bits"); return uint152(value); } /** * @dev Returns the downcasted uint144 from uint256, reverting on * overflow (when the input is greater than largest uint144). * * Counterpart to Solidity's `uint144` operator. * * Requirements: * * - input must fit into 144 bits * * _Available since v4.7._ */ function toUint144(uint256 value) internal pure returns (uint144) { require(value <= type(uint144).max, "SafeCast: value doesn't fit in 144 bits"); return uint144(value); } /** * @dev Returns the downcasted uint136 from uint256, reverting on * overflow (when the input is greater than largest uint136). * * Counterpart to Solidity's `uint136` operator. * * Requirements: * * - input must fit into 136 bits * * _Available since v4.7._ */ function toUint136(uint256 value) internal pure returns (uint136) { require(value <= type(uint136).max, "SafeCast: value doesn't fit in 136 bits"); return uint136(value); } /** * @dev Returns the downcasted uint128 from uint256, reverting on * overflow (when the input is greater than largest uint128). * * Counterpart to Solidity's `uint128` operator. * * Requirements: * * - input must fit into 128 bits * * _Available since v2.5._ */ function toUint128(uint256 value) internal pure returns (uint128) { require(value <= type(uint128).max, "SafeCast: value doesn't fit in 128 bits"); return uint128(value); } /** * @dev Returns the downcasted uint120 from uint256, reverting on * overflow (when the input is greater than largest uint120). * * Counterpart to Solidity's `uint120` operator. * * Requirements: * * - input must fit into 120 bits * * _Available since v4.7._ */ function toUint120(uint256 value) internal pure returns (uint120) { require(value <= type(uint120).max, "SafeCast: value doesn't fit in 120 bits"); return uint120(value); } /** * @dev Returns the downcasted uint112 from uint256, reverting on * overflow (when the input is greater than largest uint112). * * Counterpart to Solidity's `uint112` operator. * * Requirements: * * - input must fit into 112 bits * * _Available since v4.7._ */ function toUint112(uint256 value) internal pure returns (uint112) { require(value <= type(uint112).max, "SafeCast: value doesn't fit in 112 bits"); return uint112(value); } /** * @dev Returns the downcasted uint104 from uint256, reverting on * overflow (when the input is greater than largest uint104). * * Counterpart to Solidity's `uint104` operator. * * Requirements: * * - input must fit into 104 bits * * _Available since v4.7._ */ function toUint104(uint256 value) internal pure returns (uint104) { require(value <= type(uint104).max, "SafeCast: value doesn't fit in 104 bits"); return uint104(value); } /** * @dev Returns the downcasted uint96 from uint256, reverting on * overflow (when the input is greater than largest uint96). * * Counterpart to Solidity's `uint96` operator. * * Requirements: * * - input must fit into 96 bits * * _Available since v4.2._ */ function toUint96(uint256 value) internal pure returns (uint96) { require(value <= type(uint96).max, "SafeCast: value doesn't fit in 96 bits"); return uint96(value); } /** * @dev Returns the downcasted uint88 from uint256, reverting on * overflow (when the input is greater than largest uint88). * * Counterpart to Solidity's `uint88` operator. * * Requirements: * * - input must fit into 88 bits * * _Available since v4.7._ */ function toUint88(uint256 value) internal pure returns (uint88) { require(value <= type(uint88).max, "SafeCast: value doesn't fit in 88 bits"); return uint88(value); } /** * @dev Returns the downcasted uint80 from uint256, reverting on * overflow (when the input is greater than largest uint80). * * Counterpart to Solidity's `uint80` operator. * * Requirements: * * - input must fit into 80 bits * * _Available since v4.7._ */ function toUint80(uint256 value) internal pure returns (uint80) { require(value <= type(uint80).max, "SafeCast: value doesn't fit in 80 bits"); return uint80(value); } /** * @dev Returns the downcasted uint72 from uint256, reverting on * overflow (when the input is greater than largest uint72). * * Counterpart to Solidity's `uint72` operator. * * Requirements: * * - input must fit into 72 bits * * _Available since v4.7._ */ function toUint72(uint256 value) internal pure returns (uint72) { require(value <= type(uint72).max, "SafeCast: value doesn't fit in 72 bits"); return uint72(value); } /** * @dev Returns the downcasted uint64 from uint256, reverting on * overflow (when the input is greater than largest uint64). * * Counterpart to Solidity's `uint64` operator. * * Requirements: * * - input must fit into 64 bits * * _Available since v2.5._ */ function toUint64(uint256 value) internal pure returns (uint64) { require(value <= type(uint64).max, "SafeCast: value doesn't fit in 64 bits"); return uint64(value); } /** * @dev Returns the downcasted uint56 from uint256, reverting on * overflow (when the input is greater than largest uint56). * * Counterpart to Solidity's `uint56` operator. * * Requirements: * * - input must fit into 56 bits * * _Available since v4.7._ */ function toUint56(uint256 value) internal pure returns (uint56) { require(value <= type(uint56).max, "SafeCast: value doesn't fit in 56 bits"); return uint56(value); } /** * @dev Returns the downcasted uint48 from uint256, reverting on * overflow (when the input is greater than largest uint48). * * Counterpart to Solidity's `uint48` operator. * * Requirements: * * - input must fit into 48 bits * * _Available since v4.7._ */ function toUint48(uint256 value) internal pure returns (uint48) { require(value <= type(uint48).max, "SafeCast: value doesn't fit in 48 bits"); return uint48(value); } /** * @dev Returns the downcasted uint40 from uint256, reverting on * overflow (when the input is greater than largest uint40). * * Counterpart to Solidity's `uint40` operator. * * Requirements: * * - input must fit into 40 bits * * _Available since v4.7._ */ function toUint40(uint256 value) internal pure returns (uint40) { require(value <= type(uint40).max, "SafeCast: value doesn't fit in 40 bits"); return uint40(value); } /** * @dev Returns the downcasted uint32 from uint256, reverting on * overflow (when the input is greater than largest uint32). * * Counterpart to Solidity's `uint32` operator. * * Requirements: * * - input must fit into 32 bits * * _Available since v2.5._ */ function toUint32(uint256 value) internal pure returns (uint32) { require(value <= type(uint32).max, "SafeCast: value doesn't fit in 32 bits"); return uint32(value); } /** * @dev Returns the downcasted uint24 from uint256, reverting on * overflow (when the input is greater than largest uint24). * * Counterpart to Solidity's `uint24` operator. * * Requirements: * * - input must fit into 24 bits * * _Available since v4.7._ */ function toUint24(uint256 value) internal pure returns (uint24) { require(value <= type(uint24).max, "SafeCast: value doesn't fit in 24 bits"); return uint24(value); } /** * @dev Returns the downcasted uint16 from uint256, reverting on * overflow (when the input is greater than largest uint16). * * Counterpart to Solidity's `uint16` operator. * * Requirements: * * - input must fit into 16 bits * * _Available since v2.5._ */ function toUint16(uint256 value) internal pure returns (uint16) { require(value <= type(uint16).max, "SafeCast: value doesn't fit in 16 bits"); return uint16(value); } /** * @dev Returns the downcasted uint8 from uint256, reverting on * overflow (when the input is greater than largest uint8). * * Counterpart to Solidity's `uint8` operator. * * Requirements: * * - input must fit into 8 bits * * _Available since v2.5._ */ function toUint8(uint256 value) internal pure returns (uint8) { require(value <= type(uint8).max, "SafeCast: value doesn't fit in 8 bits"); return uint8(value); } /** * @dev Converts a signed int256 into an unsigned uint256. * * Requirements: * * - input must be greater than or equal to 0. * * _Available since v3.0._ */ function toUint256(int256 value) internal pure returns (uint256) { require(value >= 0, "SafeCast: value must be positive"); return uint256(value); } /** * @dev Returns the downcasted int248 from int256, reverting on * overflow (when the input is less than smallest int248 or * greater than largest int248). * * Counterpart to Solidity's `int248` operator. * * Requirements: * * - input must fit into 248 bits * * _Available since v4.7._ */ function toInt248(int256 value) internal pure returns (int248) { require(value >= type(int248).min && value <= type(int248).max, "SafeCast: value doesn't fit in 248 bits"); return int248(value); } /** * @dev Returns the downcasted int240 from int256, reverting on * overflow (when the input is less than smallest int240 or * greater than largest int240). * * Counterpart to Solidity's `int240` operator. * * Requirements: * * - input must fit into 240 bits * * _Available since v4.7._ */ function toInt240(int256 value) internal pure returns (int240) { require(value >= type(int240).min && value <= type(int240).max, "SafeCast: value doesn't fit in 240 bits"); return int240(value); } /** * @dev Returns the downcasted int232 from int256, reverting on * overflow (when the input is less than smallest int232 or * greater than largest int232). * * Counterpart to Solidity's `int232` operator. * * Requirements: * * - input must fit into 232 bits * * _Available since v4.7._ */ function toInt232(int256 value) internal pure returns (int232) { require(value >= type(int232).min && value <= type(int232).max, "SafeCast: value doesn't fit in 232 bits"); return int232(value); } /** * @dev Returns the downcasted int224 from int256, reverting on * overflow (when the input is less than smallest int224 or * greater than largest int224). * * Counterpart to Solidity's `int224` operator. * * Requirements: * * - input must fit into 224 bits * * _Available since v4.7._ */ function toInt224(int256 value) internal pure returns (int224) { require(value >= type(int224).min && value <= type(int224).max, "SafeCast: value doesn't fit in 224 bits"); return int224(value); } /** * @dev Returns the downcasted int216 from int256, reverting on * overflow (when the input is less than smallest int216 or * greater than largest int216). * * Counterpart to Solidity's `int216` operator. * * Requirements: * * - input must fit into 216 bits * * _Available since v4.7._ */ function toInt216(int256 value) internal pure returns (int216) { require(value >= type(int216).min && value <= type(int216).max, "SafeCast: value doesn't fit in 216 bits"); return int216(value); } /** * @dev Returns the downcasted int208 from int256, reverting on * overflow (when the input is less than smallest int208 or * greater than largest int208). * * Counterpart to Solidity's `int208` operator. * * Requirements: * * - input must fit into 208 bits * * _Available since v4.7._ */ function toInt208(int256 value) internal pure returns (int208) { require(value >= type(int208).min && value <= type(int208).max, "SafeCast: value doesn't fit in 208 bits"); return int208(value); } /** * @dev Returns the downcasted int200 from int256, reverting on * overflow (when the input is less than smallest int200 or * greater than largest int200). * * Counterpart to Solidity's `int200` operator. * * Requirements: * * - input must fit into 200 bits * * _Available since v4.7._ */ function toInt200(int256 value) internal pure returns (int200) { require(value >= type(int200).min && value <= type(int200).max, "SafeCast: value doesn't fit in 200 bits"); return int200(value); } /** * @dev Returns the downcasted int192 from int256, reverting on * overflow (when the input is less than smallest int192 or * greater than largest int192). * * Counterpart to Solidity's `int192` operator. * * Requirements: * * - input must fit into 192 bits * * _Available since v4.7._ */ function toInt192(int256 value) internal pure returns (int192) { require(value >= type(int192).min && value <= type(int192).max, "SafeCast: value doesn't fit in 192 bits"); return int192(value); } /** * @dev Returns the downcasted int184 from int256, reverting on * overflow (when the input is less than smallest int184 or * greater than largest int184). * * Counterpart to Solidity's `int184` operator. * * Requirements: * * - input must fit into 184 bits * * _Available since v4.7._ */ function toInt184(int256 value) internal pure returns (int184) { require(value >= type(int184).min && value <= type(int184).max, "SafeCast: value doesn't fit in 184 bits"); return int184(value); } /** * @dev Returns the downcasted int176 from int256, reverting on * overflow (when the input is less than smallest int176 or * greater than largest int176). * * Counterpart to Solidity's `int176` operator. * * Requirements: * * - input must fit into 176 bits * * _Available since v4.7._ */ function toInt176(int256 value) internal pure returns (int176) { require(value >= type(int176).min && value <= type(int176).max, "SafeCast: value doesn't fit in 176 bits"); return int176(value); } /** * @dev Returns the downcasted int168 from int256, reverting on * overflow (when the input is less than smallest int168 or * greater than largest int168). * * Counterpart to Solidity's `int168` operator. * * Requirements: * * - input must fit into 168 bits * * _Available since v4.7._ */ function toInt168(int256 value) internal pure returns (int168) { require(value >= type(int168).min && value <= type(int168).max, "SafeCast: value doesn't fit in 168 bits"); return int168(value); } /** * @dev Returns the downcasted int160 from int256, reverting on * overflow (when the input is less than smallest int160 or * greater than largest int160). * * Counterpart to Solidity's `int160` operator. * * Requirements: * * - input must fit into 160 bits * * _Available since v4.7._ */ function toInt160(int256 value) internal pure returns (int160) { require(value >= type(int160).min && value <= type(int160).max, "SafeCast: value doesn't fit in 160 bits"); return int160(value); } /** * @dev Returns the downcasted int152 from int256, reverting on * overflow (when the input is less than smallest int152 or * greater than largest int152). * * Counterpart to Solidity's `int152` operator. * * Requirements: * * - input must fit into 152 bits * * _Available since v4.7._ */ function toInt152(int256 value) internal pure returns (int152) { require(value >= type(int152).min && value <= type(int152).max, "SafeCast: value doesn't fit in 152 bits"); return int152(value); } /** * @dev Returns the downcasted int144 from int256, reverting on * overflow (when the input is less than smallest int144 or * greater than largest int144). * * Counterpart to Solidity's `int144` operator. * * Requirements: * * - input must fit into 144 bits * * _Available since v4.7._ */ function toInt144(int256 value) internal pure returns (int144) { require(value >= type(int144).min && value <= type(int144).max, "SafeCast: value doesn't fit in 144 bits"); return int144(value); } /** * @dev Returns the downcasted int136 from int256, reverting on * overflow (when the input is less than smallest int136 or * greater than largest int136). * * Counterpart to Solidity's `int136` operator. * * Requirements: * * - input must fit into 136 bits * * _Available since v4.7._ */ function toInt136(int256 value) internal pure returns (int136) { require(value >= type(int136).min && value <= type(int136).max, "SafeCast: value doesn't fit in 136 bits"); return int136(value); } /** * @dev Returns the downcasted int128 from int256, reverting on * overflow (when the input is less than smallest int128 or * greater than largest int128). * * Counterpart to Solidity's `int128` operator. * * Requirements: * * - input must fit into 128 bits * * _Available since v3.1._ */ function toInt128(int256 value) internal pure returns (int128) { require(value >= type(int128).min && value <= type(int128).max, "SafeCast: value doesn't fit in 128 bits"); return int128(value); } /** * @dev Returns the downcasted int120 from int256, reverting on * overflow (when the input is less than smallest int120 or * greater than largest int120). * * Counterpart to Solidity's `int120` operator. * * Requirements: * * - input must fit into 120 bits * * _Available since v4.7._ */ function toInt120(int256 value) internal pure returns (int120) { require(value >= type(int120).min && value <= type(int120).max, "SafeCast: value doesn't fit in 120 bits"); return int120(value); } /** * @dev Returns the downcasted int112 from int256, reverting on * overflow (when the input is less than smallest int112 or * greater than largest int112). * * Counterpart to Solidity's `int112` operator. * * Requirements: * * - input must fit into 112 bits * * _Available since v4.7._ */ function toInt112(int256 value) internal pure returns (int112) { require(value >= type(int112).min && value <= type(int112).max, "SafeCast: value doesn't fit in 112 bits"); return int112(value); } /** * @dev Returns the downcasted int104 from int256, reverting on * overflow (when the input is less than smallest int104 or * greater than largest int104). * * Counterpart to Solidity's `int104` operator. * * Requirements: * * - input must fit into 104 bits * * _Available since v4.7._ */ function toInt104(int256 value) internal pure returns (int104) { require(value >= type(int104).min && value <= type(int104).max, "SafeCast: value doesn't fit in 104 bits"); return int104(value); } /** * @dev Returns the downcasted int96 from int256, reverting on * overflow (when the input is less than smallest int96 or * greater than largest int96). * * Counterpart to Solidity's `int96` operator. * * Requirements: * * - input must fit into 96 bits * * _Available since v4.7._ */ function toInt96(int256 value) internal pure returns (int96) { require(value >= type(int96).min && value <= type(int96).max, "SafeCast: value doesn't fit in 96 bits"); return int96(value); } /** * @dev Returns the downcasted int88 from int256, reverting on * overflow (when the input is less than smallest int88 or * greater than largest int88). * * Counterpart to Solidity's `int88` operator. * * Requirements: * * - input must fit into 88 bits * * _Available since v4.7._ */ function toInt88(int256 value) internal pure returns (int88) { require(value >= type(int88).min && value <= type(int88).max, "SafeCast: value doesn't fit in 88 bits"); return int88(value); } /** * @dev Returns the downcasted int80 from int256, reverting on * overflow (when the input is less than smallest int80 or * greater than largest int80). * * Counterpart to Solidity's `int80` operator. * * Requirements: * * - input must fit into 80 bits * * _Available since v4.7._ */ function toInt80(int256 value) internal pure returns (int80) { require(value >= type(int80).min && value <= type(int80).max, "SafeCast: value doesn't fit in 80 bits"); return int80(value); } /** * @dev Returns the downcasted int72 from int256, reverting on * overflow (when the input is less than smallest int72 or * greater than largest int72). * * Counterpart to Solidity's `int72` operator. * * Requirements: * * - input must fit into 72 bits * * _Available since v4.7._ */ function toInt72(int256 value) internal pure returns (int72) { require(value >= type(int72).min && value <= type(int72).max, "SafeCast: value doesn't fit in 72 bits"); return int72(value); } /** * @dev Returns the downcasted int64 from int256, reverting on * overflow (when the input is less than smallest int64 or * greater than largest int64). * * Counterpart to Solidity's `int64` operator. * * Requirements: * * - input must fit into 64 bits * * _Available since v3.1._ */ function toInt64(int256 value) internal pure returns (int64) { require(value >= type(int64).min && value <= type(int64).max, "SafeCast: value doesn't fit in 64 bits"); return int64(value); } /** * @dev Returns the downcasted int56 from int256, reverting on * overflow (when the input is less than smallest int56 or * greater than largest int56). * * Counterpart to Solidity's `int56` operator. * * Requirements: * * - input must fit into 56 bits * * _Available since v4.7._ */ function toInt56(int256 value) internal pure returns (int56) { require(value >= type(int56).min && value <= type(int56).max, "SafeCast: value doesn't fit in 56 bits"); return int56(value); } /** * @dev Returns the downcasted int48 from int256, reverting on * overflow (when the input is less than smallest int48 or * greater than largest int48). * * Counterpart to Solidity's `int48` operator. * * Requirements: * * - input must fit into 48 bits * * _Available since v4.7._ */ function toInt48(int256 value) internal pure returns (int48) { require(value >= type(int48).min && value <= type(int48).max, "SafeCast: value doesn't fit in 48 bits"); return int48(value); } /** * @dev Returns the downcasted int40 from int256, reverting on * overflow (when the input is less than smallest int40 or * greater than largest int40). * * Counterpart to Solidity's `int40` operator. * * Requirements: * * - input must fit into 40 bits * * _Available since v4.7._ */ function toInt40(int256 value) internal pure returns (int40) { require(value >= type(int40).min && value <= type(int40).max, "SafeCast: value doesn't fit in 40 bits"); return int40(value); } /** * @dev Returns the downcasted int32 from int256, reverting on * overflow (when the input is less than smallest int32 or * greater than largest int32). * * Counterpart to Solidity's `int32` operator. * * Requirements: * * - input must fit into 32 bits * * _Available since v3.1._ */ function toInt32(int256 value) internal pure returns (int32) { require(value >= type(int32).min && value <= type(int32).max, "SafeCast: value doesn't fit in 32 bits"); return int32(value); } /** * @dev Returns the downcasted int24 from int256, reverting on * overflow (when the input is less than smallest int24 or * greater than largest int24). * * Counterpart to Solidity's `int24` operator. * * Requirements: * * - input must fit into 24 bits * * _Available since v4.7._ */ function toInt24(int256 value) internal pure returns (int24) { require(value >= type(int24).min && value <= type(int24).max, "SafeCast: value doesn't fit in 24 bits"); return int24(value); } /** * @dev Returns the downcasted int16 from int256, reverting on * overflow (when the input is less than smallest int16 or * greater than largest int16). * * Counterpart to Solidity's `int16` operator. * * Requirements: * * - input must fit into 16 bits * * _Available since v3.1._ */ function toInt16(int256 value) internal pure returns (int16) { require(value >= type(int16).min && value <= type(int16).max, "SafeCast: value doesn't fit in 16 bits"); return int16(value); } /** * @dev Returns the downcasted int8 from int256, reverting on * overflow (when the input is less than smallest int8 or * greater than largest int8). * * Counterpart to Solidity's `int8` operator. * * Requirements: * * - input must fit into 8 bits * * _Available since v3.1._ */ function toInt8(int256 value) internal pure returns (int8) { require(value >= type(int8).min && value <= type(int8).max, "SafeCast: value doesn't fit in 8 bits"); return int8(value); } /** * @dev Converts an unsigned uint256 into a signed int256. * * Requirements: * * - input must be less than or equal to maxInt256. * * _Available since v3.0._ */ function toInt256(uint256 value) internal pure returns (int256) { // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive require(value <= uint256(type(int256).max), "SafeCast: value doesn't fit in an int256"); return int256(value); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol) pragma solidity ^0.8.0; /** * @dev Library for managing * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive * types. * * Sets have the following properties: * * - Elements are added, removed, and checked for existence in constant time * (O(1)). * - Elements are enumerated in O(n). No guarantees are made on the ordering. * * ``` * contract Example { * // Add the library methods * using EnumerableSet for EnumerableSet.AddressSet; * * // Declare a set state variable * EnumerableSet.AddressSet private mySet; * } * ``` * * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`) * and `uint256` (`UintSet`) are supported. * * [WARNING] * ==== * Trying to delete such a structure from storage will likely result in data corruption, rendering the structure unusable. * See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info. * * In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an array of EnumerableSet. * ==== */ library EnumerableSet { // To implement this library for multiple types with as little code // repetition as possible, we write it in terms of a generic Set type with // bytes32 values. // The Set implementation uses private functions, and user-facing // implementations (such as AddressSet) are just wrappers around the // underlying Set. // This means that we can only create new EnumerableSets for types that fit // in bytes32. struct Set { // Storage of set values bytes32[] _values; // Position of the value in the `values` array, plus 1 because index 0 // means a value is not in the set. mapping(bytes32 => uint256) _indexes; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function _add(Set storage set, bytes32 value) private returns (bool) { if (!_contains(set, value)) { set._values.push(value); // The value is stored at length-1, but we add 1 to all indexes // and use 0 as a sentinel value set._indexes[value] = set._values.length; return true; } else { return false; } } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function _remove(Set storage set, bytes32 value) private returns (bool) { // We read and store the value's index to prevent multiple reads from the same storage slot uint256 valueIndex = set._indexes[value]; if (valueIndex != 0) { // Equivalent to contains(set, value) // To delete an element from the _values array in O(1), we swap the element to delete with the last one in // the array, and then remove the last element (sometimes called as 'swap and pop'). // This modifies the order of the array, as noted in {at}. uint256 toDeleteIndex = valueIndex - 1; uint256 lastIndex = set._values.length - 1; if (lastIndex != toDeleteIndex) { bytes32 lastValue = set._values[lastIndex]; // Move the last value to the index where the value to delete is set._values[toDeleteIndex] = lastValue; // Update the index for the moved value set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex } // Delete the slot where the moved value was stored set._values.pop(); // Delete the index for the deleted slot delete set._indexes[value]; return true; } else { return false; } } /** * @dev Returns true if the value is in the set. O(1). */ function _contains(Set storage set, bytes32 value) private view returns (bool) { return set._indexes[value] != 0; } /** * @dev Returns the number of values on the set. O(1). */ function _length(Set storage set) private view returns (uint256) { return set._values.length; } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function _at(Set storage set, uint256 index) private view returns (bytes32) { return set._values[index]; } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function _values(Set storage set) private view returns (bytes32[] memory) { return set._values; } // Bytes32Set struct Bytes32Set { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _add(set._inner, value); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _remove(set._inner, value); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) { return _contains(set._inner, value); } /** * @dev Returns the number of values in the set. O(1). */ function length(Bytes32Set storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) { return _at(set._inner, index); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(Bytes32Set storage set) internal view returns (bytes32[] memory) { return _values(set._inner); } // AddressSet struct AddressSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(AddressSet storage set, address value) internal returns (bool) { return _add(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(AddressSet storage set, address value) internal returns (bool) { return _remove(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(AddressSet storage set, address value) internal view returns (bool) { return _contains(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns the number of values in the set. O(1). */ function length(AddressSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(AddressSet storage set, uint256 index) internal view returns (address) { return address(uint160(uint256(_at(set._inner, index)))); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(AddressSet storage set) internal view returns (address[] memory) { bytes32[] memory store = _values(set._inner); address[] memory result; /// @solidity memory-safe-assembly assembly { result := store } return result; } // UintSet struct UintSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(UintSet storage set, uint256 value) internal returns (bool) { return _add(set._inner, bytes32(value)); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(UintSet storage set, uint256 value) internal returns (bool) { return _remove(set._inner, bytes32(value)); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(UintSet storage set, uint256 value) internal view returns (bool) { return _contains(set._inner, bytes32(value)); } /** * @dev Returns the number of values on the set. O(1). */ function length(UintSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(UintSet storage set, uint256 index) internal view returns (uint256) { return uint256(_at(set._inner, index)); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(UintSet storage set) internal view returns (uint256[] memory) { bytes32[] memory store = _values(set._inner); uint256[] memory result; /// @solidity memory-safe-assembly assembly { result := store } return result; } }
// SPDX-License-Identifier: MIT pragma solidity >=0.6.0; /// @title Base64 /// @author Brecht Devos - <[email protected]> /// @notice Provides functions for encoding/decoding base64 library Base64 { string internal constant TABLE_ENCODE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'; bytes internal constant TABLE_DECODE = hex"0000000000000000000000000000000000000000000000000000000000000000" hex"00000000000000000000003e0000003f3435363738393a3b3c3d000000000000" hex"00000102030405060708090a0b0c0d0e0f101112131415161718190000000000" hex"001a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132330000000000"; function encode(bytes memory data) internal pure returns (string memory) { if (data.length == 0) return ''; // load the table into memory string memory table = TABLE_ENCODE; // multiply by 4/3 rounded up uint256 encodedLen = 4 * ((data.length + 2) / 3); // add some extra buffer at the end required for the writing string memory result = new string(encodedLen + 32); assembly { // set the actual output length mstore(result, encodedLen) // prepare the lookup table let tablePtr := add(table, 1) // input ptr let dataPtr := data let endPtr := add(dataPtr, mload(data)) // result ptr, jump over length let resultPtr := add(result, 32) // run over the input, 3 bytes at a time for {} lt(dataPtr, endPtr) {} { // read 3 bytes dataPtr := add(dataPtr, 3) let input := mload(dataPtr) // write 4 characters mstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F)))) resultPtr := add(resultPtr, 1) mstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F)))) resultPtr := add(resultPtr, 1) mstore8(resultPtr, mload(add(tablePtr, and(shr( 6, input), 0x3F)))) resultPtr := add(resultPtr, 1) mstore8(resultPtr, mload(add(tablePtr, and( input, 0x3F)))) resultPtr := add(resultPtr, 1) } // padding with '=' switch mod(mload(data), 3) case 1 { mstore(sub(resultPtr, 2), shl(240, 0x3d3d)) } case 2 { mstore(sub(resultPtr, 1), shl(248, 0x3d)) } } return result; } function decode(string memory _data) internal pure returns (bytes memory) { bytes memory data = bytes(_data); if (data.length == 0) return new bytes(0); require(data.length % 4 == 0, "invalid base64 decoder input"); // load the table into memory bytes memory table = TABLE_DECODE; // every 4 characters represent 3 bytes uint256 decodedLen = (data.length / 4) * 3; // add some extra buffer at the end required for the writing bytes memory result = new bytes(decodedLen + 32); assembly { // padding with '=' let lastBytes := mload(add(data, mload(data))) if eq(and(lastBytes, 0xFF), 0x3d) { decodedLen := sub(decodedLen, 1) if eq(and(lastBytes, 0xFFFF), 0x3d3d) { decodedLen := sub(decodedLen, 1) } } // set the actual output length mstore(result, decodedLen) // prepare the lookup table let tablePtr := add(table, 1) // input ptr let dataPtr := data let endPtr := add(dataPtr, mload(data)) // result ptr, jump over length let resultPtr := add(result, 32) // run over the input, 4 characters at a time for {} lt(dataPtr, endPtr) {} { // read 4 characters dataPtr := add(dataPtr, 4) let input := mload(dataPtr) // write 3 bytes let output := add( add( shl(18, and(mload(add(tablePtr, and(shr(24, input), 0xFF))), 0xFF)), shl(12, and(mload(add(tablePtr, and(shr(16, input), 0xFF))), 0xFF))), add( shl( 6, and(mload(add(tablePtr, and(shr( 8, input), 0xFF))), 0xFF)), and(mload(add(tablePtr, and( input , 0xFF))), 0xFF) ) ) mstore(resultPtr, shl(232, output)) resultPtr := add(resultPtr, 3) } } return result; } }
//SPDX-License-Identifier: MIT pragma solidity 0.8.15; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { ERC721 } from "@openzeppelin/contracts/token/ERC721/ERC721.sol"; import { Metadata } from "./Metadata.sol"; import { Nation } from "./Nation/Nation.sol"; import { Notary } from "./Notary/Notary.sol"; /** * @title CitizenAlpha * @author Kames Geraghty * @notice A Web3 of Trust experiment. */ contract CitizenAlpha is ERC721, Ownable { /// @notice Total citizenships issued uint256 private _idCounter; /// @notice Metadata instance; External tokenURI call address private _metadata; /// @notice Nation instance; Global AccessControl address private _nation; /// @notice Notary instance; Citizenship Management address private _notary; /// @notice TrustResolver instance; Unique tokenURI address private _resolver; /// @notice Enable tokenURI split logic operator bool private _tokenURISplit; /// @notice Reverse lookup of a tokenId using the owner address mapping(address => uint256) private _tokenIds; /// @notice Lookup address of Citizenship trust link mapping(address => address) private _links; /** * @notice Emit when Citizenship is issued. * @param id Citizen ID * @param citizen Address of new Citizen * @param link Address of Citizen issuing new Citizenship */ event Issued(uint256 id, address indexed citizen, address indexed link); /** * @notice Emit when Citizenship is revoked. * @param id Citizen ID * @param citizen Address of new Citizen * @param link Address of Founder revoking Citizenship */ event Revoked(uint256 id, address indexed citizen, address indexed link); /** * @notice Emit when Metadata instnace is updated. * @param metadata Address of new Metadata instance */ event NewMetadata(address metadata); /** * @notice Emit when Nation instnace is updated. * @param nation Address of new Nation instance */ event NewNation(address nation); /** * @notice Emit when Notary instnace is updated. * @param notary Address of new Notary instance */ event NewNotary(address notary); /** * @notice Emit when Resolver instnace is updated. * @param resolver Address of new Resolver instance */ event NewResolver(address resolver); /** * @notice CitizenAlpha Construction * @param metadata_ address - Metadata instance * @param name_ string - Name of ERC721 token * @param symbol_ string - Symbol of ERC721 token */ constructor( address metadata_, string memory name_, string memory symbol_ ) ERC721(name_, symbol_) { _metadata = metadata_; } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ /** * @notice Get Metadata instance * @return metadata Metadata */ function getMetadata() external view returns (address metadata) { return _metadata; } /** * @notice Get Nation instance * @return nation Nation */ function getNation() external view returns (address nation) { return _nation; } /** * @notice Get Notary instance * @return notary Notary */ function getNotary() external view returns (address notary) { return _notary; } /** * @notice Get Resolver instance * @return resolver Resolver */ function getResolver() external view returns (address resolver) { return _resolver; } /** * @notice Read totalIssued (_idCounter) * @return totalIssued uint256 */ function totalIssued() external view returns (uint256) { return _idCounter; } /** * @notice Check Citizenship ID * @param citizen address * @return id uint256 */ function getId(address citizen) external view returns (uint256) { require(_isCitizen(citizen), "CitizenAlpha:not-active-citizen"); return _tokenIds[citizen]; } /** * @notice Lookup Citizenship link * @param citizen address * @return link address */ function getLink(address citizen) external view returns (address link) { return _links[citizen]; } /** * @notice Check Role status of Citizen via Nation * @param citizen Address of Citizen * @return status bool */ function hasRole(bytes32 role, address citizen) external view returns (bool) { return Nation(_nation).hasRole(role, citizen); } /** * @notice Check Citizenship status * @param citizen Address of potential Citizen * @return status bool */ function isCitizen(address citizen) external view returns (bool status) { return balanceOf(citizen) == 1 ? true : false; } /** * @notice Generate token URI * @param tokenId uint256 * @return metadata string */ function tokenURI(uint256 tokenId) public view override returns (string memory) { Metadata metadata_ = Metadata(_metadata); if (!_tokenURISplit) { return metadata_.tokenURI(tokenId); } else { return _resolver == _msgSender() ? metadata_.tokenURIResolver(tokenId) : metadata_.tokenURI(tokenId); } } /** * @notice Issue a new Citizenship * @param to address */ function issue(address to) external { address _sender = _msgSender(); require(Notary(_notary).isNotary(_sender), "CitizenAlpha:not-notary"); require(!_isCitizen(to), "CitizenAlpha:is-citizen"); require(!_isPreviouslyIssued(to), "CitizenAlpha:revoked-citizenship"); _issue(to, _sender); } /** * @notice Revoke an existing Citizenship * @param from address */ function revoke(address from) external { address _sender = _msgSender(); require(Notary(_notary).isNotary(_sender), "CitizenAlpha:not-notary"); require(_isCitizen(from), "CitizenAlpha:not-citizen"); _revoke(from, _sender); } /** * @notice Reset Citizenship status * @param citizen address */ function reset(address citizen) external { require(Notary(_notary).isNotary(_msgSender()), "CitizenAlpha:not-notary"); require(!_isCitizen(citizen), "CitizenAlpha:is-citizen"); require(_isPreviouslyIssued(citizen), "CitizenAlpha:never-citizen"); _tokenIds[citizen] = 0; } /** * @notice Set URI Splitter status * @param status bool */ function setURISplitter(bool status) external onlyOwner { _tokenURISplit = status; } /** * @notice Set Metadata instance * @param metadata address */ function setMetadata(address metadata) external onlyOwner { _metadata = metadata; emit NewMetadata(metadata); } /** * @notice Set Nation instance * @param nation address */ function setNation(address nation) external onlyOwner { _nation = nation; emit NewNation(nation); } /** * @notice Set Notary instance * @param notary address */ function setNotary(address notary) external onlyOwner { _notary = notary; emit NewNotary(notary); } /** * @notice Set Resolver instance * @param resolver address */ function setResolver(address resolver) external onlyOwner { _resolver = resolver; emit NewResolver(resolver); } /** * @notice Override transferFrom to make non-transferable */ function transferFrom( address, address, uint256 ) public virtual override { revert("CitizenAlpha: Soulbound"); } function supportsInterface(bytes4 interfaceId) public view virtual override(ERC721) returns (bool) { return super.supportsInterface(interfaceId); } /* ===================================================================================== */ /* Internal Functions */ /* ===================================================================================== */ function _isCitizen(address citizen) internal view returns (bool) { return balanceOf(citizen) == 1 ? true : false; } /** * @dev First Founder can be issued<>revoked<>issued. * All other address can only be issued<>revoked. * Unless the account is reset. */ function _isPreviouslyIssued(address citizen) internal view returns (bool) { return _tokenIds[citizen] != 0 ? true : false; } function _issue(address to, address link) internal { uint256 __idCounter = _idCounter++; _links[to] = link; _tokenIds[to] = __idCounter; _mint(to, __idCounter); emit Issued(__idCounter, to, link); } function _revoke(address from, address link) internal { uint256 tokenId = _tokenIds[from]; _burn(tokenId); emit Revoked(tokenId, from, link); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import { Base64 } from "base64-sol/base64.sol"; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { Strings } from "@openzeppelin/contracts/utils/Strings.sol"; import { svg } from "./libraries/SVG.sol"; import { svgUtils } from "./libraries/SVGUtils.sol"; import { SVGColor } from "./libraries/SVGColor.sol"; import { ISource } from "./interfaces/ISource.sol"; import { ICitizenAlpha } from "./interfaces/ICitizenAlpha.sol"; import { SourceENS } from "./Sources/SourceENS.sol"; import { CitizenAlpha } from "./CitizenAlpha.sol"; import { SVGRender } from "./SVGRender.sol"; /** * @title Metadata * @author Kames Geraghty * @notice CitizenAlpha metadata resolver. */ contract Metadata is Ownable { using Strings for uint256; /// @notice Token instance address private _token; /// @notice SVGRender instance address private _svgRender; /// @notice ISources[] list address[] private _sources; struct Metadata { string name; string description; string avatar; string did; string ensAlias; string ensNode; string ensResolver; string traits; } struct ExternalMetadata { string avatar; string did; string ensNode; string ensAlias; string ensResolver; string traits; } constructor(address _svgRender_) { _svgRender = _svgRender_; } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ /** * @notice Get Token instance * @return token Token */ function getToken() external view returns (address token) { return _token; } /** * @notice Get Token instance * @return token Token */ function getSVGRender() external view returns (address token) { return _svgRender; } function getSourceData(uint256 idx, address user) external view returns (string[] memory, string[] memory) { return _getSourceData(idx, user); } function getSourcesData(address user) external view returns (string[] memory, string[] memory) { return _getSourcesData(user); } /** * @notice Construct tokenURI * @param tokenId address * @return uri string - Uniform Resource Identifier (URI) for `tokenId` token. */ function tokenURI(uint256 tokenId) external view returns (string memory) { return _constructTokenURI(tokenId); } /** * @notice Construct resolver tokenURI * @param tokenId address * @return uri string - Uniform Resource Identifier (URI) for `tokenId` token. */ function tokenURIResolver(uint256 tokenId) external view returns (string memory) { return _constructTokenURIResolver(tokenId); } /** * @notice Get User Metadata * @param user address * @return metadata Metadata */ function getMetadata(address user) external view returns (Metadata memory) { return _constructMetadata(user, CitizenAlpha(_token).getId(user)); } /** * @notice Get User Avatar * @param user address * @return avatar string */ function getAvatar(address user) external view returns (string memory) { uint256 _tokenId = ICitizenAlpha(_token).getId(user); SourceENS _resolverEns = SourceENS(_sources[0]); (, string memory alias_, ) = _resolverEns.getMetadata(user); string memory avatar_ = _resolverEns.getValue(user, "avatar"); return _generateAvatar(avatar_, _tokenId, alias_); } /** * @notice Get User Image * @param user address * @return avatar string */ function getImage(address user) external view returns (string memory) { uint256 _tokenId = ICitizenAlpha(_token).getId(user); SourceENS _resolverEns = SourceENS(_sources[0]); (, string memory alias_, ) = _resolverEns.getMetadata(user); return _generateImage(_tokenId, alias_); } /** * @notice Append Source instance * @param source address */ function appendSource(address source) external onlyOwner { _sources.push(source); } /** * @notice Set Source instance * @param idx uint256 * @param source address */ function updateSource(uint256 idx, address source) external onlyOwner { require(idx < _sources.length - 1, "Metadata:invalid-index"); _sources[idx] = source; } /** * @notice Set Token instance * @param token_ address */ function setToken(address token_) external onlyOwner { _token = token_; } /** * @notice Set SVGRender instance * @param svgRender_ address */ function setSVGRender(address svgRender_) external onlyOwner { _svgRender = svgRender_; } /* ===================================================================================== */ /* Internal Functions */ /* ===================================================================================== */ function _constructTokenURI(uint256 _tokenId) internal view returns (string memory) { ICitizenAlpha token_ = ICitizenAlpha(_token); Metadata memory _meta = _constructMetadata(token_.ownerOf(_tokenId), _tokenId); return string( abi.encodePacked( "data:application/json;base64,", Base64.encode( bytes( string.concat( '{"name":', '"', _meta.name, '",', '"description":', '"', _meta.description, '",', '"image":', '"', _meta.avatar, '",', '"attributes": [', _meta.traits, "]", "}" ) ) ) ) ); } function _constructTokenURIResolver(uint256 _tokenId) internal view returns (string memory) { ICitizenAlpha token_ = ICitizenAlpha(_token); address owner_ = token_.ownerOf(_tokenId); ExternalMetadata memory externalMetadata_ = _getExternalMetadata(owner_, _tokenId); string memory name_ = string(abi.encodePacked("Citizen #", _tokenId.toString())); string memory description_ = bytes(externalMetadata_.ensAlias).length > 0 ? externalMetadata_.ensAlias : Strings.toHexString(uint256(uint160(owner_)), 20); string memory avatar_ = _generateImage(_tokenId, externalMetadata_.ensAlias); address link_ = ICitizenAlpha(_token).getLink(owner_); return string( abi.encodePacked( "data:application/json;base64,", Base64.encode( bytes( string.concat( '{"name":', '"', name_, '",', '"description":', '"', description_, '",', '"image":', '"', avatar_, '",', '"attributes": [', _generateTrait("link", Strings.toHexString(uint256(uint160(link_)), 20)), "]", "}" ) ) ) ) ); } function _constructMetadata(address user, uint256 tokenId) internal view returns (Metadata memory) { ExternalMetadata memory externalMetadata_ = _getExternalMetadata(user, tokenId); string memory name_ = string(abi.encodePacked("Citizen #", tokenId.toString())); string memory description_ = bytes(externalMetadata_.ensAlias).length > 0 ? externalMetadata_.ensAlias : Strings.toHexString(uint256(uint160(user)), 20); address link_ = ICitizenAlpha(_token).getLink(user); Metadata memory _meta = Metadata({ name: name_, description: description_, avatar: externalMetadata_.avatar, did: externalMetadata_.did, ensNode: externalMetadata_.ensNode, ensAlias: externalMetadata_.ensAlias, ensResolver: externalMetadata_.ensResolver, traits: string.concat( externalMetadata_.traits, _generateTrait("link", Strings.toHexString(uint256(uint160(link_)), 20)) ) }); return _meta; } function _getExternalMetadata(address user, uint256 _tokenId) internal view returns (ExternalMetadata memory) { /// @dev ENS resolver must always be in the first slot. TODO: make better SourceENS _resolverEns = SourceENS(_sources[0]); string memory did_ = _resolverEns.getValue(user, "did"); string memory avatar_ = _resolverEns.getValue(user, "avatar"); (bytes32 node, string memory alias_, address resolver_) = _resolverEns.getMetadata(user); string memory traits_ = _getUnwrappedTraits(user); return ExternalMetadata({ avatar: _generateAvatar(avatar_, _tokenId, alias_), did: did_, ensNode: string(abi.encodePacked(node)), ensAlias: string(alias_), ensResolver: resolver_ != 0x0000000000000000000000000000000000000000 ? Strings.toHexString(uint256(uint160(resolver_)), 20) : "", traits: traits_ }); } function _getExternalAvatar(address user, uint256 _tokenId) internal view returns (string memory) { /// @dev ENS PublicResolver must be in first slot. TODO: make better in V2 SourceENS _resolverEns = SourceENS(_sources[0]); string memory avatar_ = _resolverEns.getValue(user, "avatar"); (, string memory alias_, ) = _resolverEns.getMetadata(user); return _generateAvatar(avatar_, _tokenId, alias_); } function _getUnwrappedTraits(address user) internal view returns (string memory) { (string[] memory keys_, string[] memory values_) = _getSourcesData(user); return _generateTraits(keys_, values_); } function _getSourceData(uint256 _sourceIndex, address _user) internal view returns (string[] memory, string[] memory) { ISource _source = ISource(_sources[_sourceIndex]); uint256 count = _source.count(_user); string[] memory keys_ = new string[](count); string[] memory values_ = new string[](count); (string[] memory keys__, string[] memory values__) = _source.getData(_user); for (uint256 k = 0; k < count; k++) { keys_[k] = (keys__[k]); values_[k] = values__[k]; } return (keys_, values_); } function _getSourcesData(address _user) internal view returns (string[] memory, string[] memory) { uint256 count = 0; address[] memory __sources = _sources; for (uint256 i = 0; i < __sources.length; i++) { ISource _source = ISource(__sources[i]); count = count + _source.count(_user); } string[] memory keys_ = new string[](count); string[] memory values_ = new string[](count); uint256 __start; for (uint256 i = 0; i < __sources.length; i++) { ISource _source = ISource(__sources[i]); (string[] memory keys__, string[] memory values__) = _source.getData(_user); for (uint256 k = __start; k < count; k++) { keys_[k] = (keys__[k]); values_[k] = values__[k]; } } return (keys_, values_); } /* ===================================================================================== */ /* Traits Functions */ /* ===================================================================================== */ function _appendTrait(string memory _traits, string memory _traitAppending) internal pure returns (string memory) { return string.concat(_traits, bytes(_traits).length > 0 ? "," : "", _traitAppending); } function _generateTrait(string memory _key, string memory _value) internal pure returns (string memory __traits) { return string.concat('{"trait_type":' '"', _key, '",', '"value":', '"', _value, '"}'); } function _generateTraits(string[] memory _keys, string[] memory _values) internal pure returns (string memory __traits) { string memory _traits = ""; for (uint256 i = 0; i < _keys.length; i++) { if (bytes(_values[i]).length > 0) { _traits = string.concat(_traits, _generateTrait(_keys[i], _values[i]), ","); } } return _traits; } function _generateAvatar( string memory _avatar, uint256 tokenId, string memory alias_ ) internal view returns (string memory) { if (bytes(_avatar).length == 0) { return string( abi.encodePacked( "data:image/svg+xml;base64,", Base64.encode(bytes(SVGRender(_svgRender).generate(tokenId, alias_))) ) ); } return _avatar; } function _generateImage(uint256 tokenId, string memory alias_) internal view returns (string memory) { return string( abi.encodePacked( "data:image/svg+xml;base64,", Base64.encode(bytes(SVGRender(_svgRender).generate(tokenId, alias_))) ) ); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import { AccessControlEnumerable, AccessControl, IAccessControl } from "@openzeppelin/contracts/access/AccessControlEnumerable.sol"; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { CitizenAlpha } from "../CitizenAlpha.sol"; import { Notary } from "../Notary/Notary.sol"; /** * @title Nation * @author Kames Geraghty * @notice Nation is an AccessControl layer for CitizenAlpha. * @dev Extends Citizen on-chain permissions using updatables nested Roles. */ contract Nation is AccessControlEnumerable { /// @notice CitizenAlpha instance address private _citizenAlpha; /// @notice Founder Role bytes32 private constant FOUNDER = keccak256("FOUNDER"); /// @notice Governance Role bytes32 private constant GOVERNANCE = keccak256("GOVERNANCE"); /// @notice Global Role AccessControl mapping(bytes32 => bool) private _roleActive; /** * @notice Nation Constructor * @param _founders addresses array of FOUNDERS */ constructor(address _citizenAlpha_, address[] memory _founders) { _citizenAlpha = _citizenAlpha_; _roleActive[FOUNDER] = true; _roleActive[GOVERNANCE] = true; _roleActive[DEFAULT_ADMIN_ROLE] = true; for (uint256 i = 0; i < _founders.length; i++) { _setupRole(FOUNDER, _founders[i]); _setupRole(DEFAULT_ADMIN_ROLE, _founders[i]); } _setRoleAdmin(FOUNDER, DEFAULT_ADMIN_ROLE); } /** * @notice Admin modifier * @param role bytes32 */ modifier _onlyAdmin(bytes32 role) { address sender_ = _msgSender(); require( hasRole(getRoleAdmin(role), sender_) || hasRole(GOVERNANCE, sender_) || hasRole(DEFAULT_ADMIN_ROLE, sender_), "Nation:unauthorized" ); _; } /** * @notice Governance modifier */ modifier _onlyGovernance() { address sender_ = _msgSender(); require( (hasRole(GOVERNANCE, sender_) || hasRole(DEFAULT_ADMIN_ROLE, sender_)), "Nation:unauthorized" ); _; } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ /** * @notice Get CitizenAlpha instance * @return citizenAlpha address of CitizenAlpha instance */ function getCitizenAlpha() external view returns (address) { return _citizenAlpha; } /** * @notice Check if Account has Role * @dev Include check for Role activication is Citizenship * @return active bool */ function hasRole(bytes32 role, address account) public view virtual override(AccessControl, IAccessControl) returns (bool) { if (!_roleActive[role] || !CitizenAlpha(_citizenAlpha).isCitizen(account)) { return false; } return super.hasRole(role, account); } /** * @notice Check Founder status * @param citizen address * @return status bool */ function isFounder(address citizen) external view returns (bool status) { return hasRole(FOUNDER, citizen); } /** * @notice Check Governance status * @param module address * @return status bool */ function isGovernance(address module) external view returns (bool status) { return hasRole(GOVERNANCE, module); } /** * @notice Get status of Role global settings * @return status bool */ function roleStatus(bytes32 role) external view returns (bool status) { return _roleActive[role]; } /** * @notice Grant Role to Citizen * @param role bytes32 * @param citizen address */ function grantRole(bytes32 role, address citizen) public virtual override(AccessControl, IAccessControl) _onlyAdmin(role) { require(_roleActive[role], "Nation:inactive-role"); _grantRole(role, citizen); } /** * @notice Revoke Role from Citizen * @param role bytes32 * @param citizen address */ function revokeRole(bytes32 role, address citizen) public virtual override(AccessControl, IAccessControl) _onlyAdmin(role) { require(role != DEFAULT_ADMIN_ROLE, "Nation:invalid-request"); require(_roleActive[role], "Nation:inactive-role"); _revokeRole(role, citizen); } /** * @notice Enable Role status * @param role bytes32 */ function enableRole(bytes32 role) external onlyRole(FOUNDER) { require(_roleActive[role] == false, "Nation:role-enabled"); _setRoleAdmin(role, FOUNDER); _roleActive[role] = true; } /** * @notice Enable Role status * @param role bytes32 * @param adminRole bytes32 */ function enableRoleWithAdmin(bytes32 role, bytes32 adminRole) external _onlyGovernance { require(_roleActive[role] == false, "Nation:role-enabled"); _setRoleAdmin(role, adminRole); _roleActive[role] = true; } /** * @notice Disable Role status * @param role bytes32 */ function disableRole(bytes32 role) external _onlyGovernance { require(_roleActive[role] == true, "Nation:role-disabled"); _setRoleAdmin(role, DEFAULT_ADMIN_ROLE); _roleActive[role] = false; } /** * @notice Set Role admin * @param role bytes32 * @param adminRole bytes32 */ function setRoleAdmin(bytes32 role, bytes32 adminRole) external _onlyGovernance { _setRoleAdmin(role, adminRole); } }
//SPDX-License-Identifier: MIT pragma solidity 0.8.15; import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol"; import { ICitizenAlpha } from "../interfaces/ICitizenAlpha.sol"; /** * @title Notary * @author Kames Geraghty * @notice Notary is a minimal AccessControl layer for Citizen issuance. */ contract Notary is AccessControl { /// @notice CitizenAlpha instance address private _citizenAlpha; /// @notice Notary Role bytes32 private constant NOTARY = keccak256("NOTARY"); /** * @notice Notary Constructor * @dev Set CitizenAlpha instance and set start Notaries. * @param _citizenAlpha_ CitizenAlpha instance * @param _notaries Array of Notaries */ constructor(address _citizenAlpha_, address[] memory _notaries) { _citizenAlpha = _citizenAlpha_; _setupRole(NOTARY, address(this)); for (uint256 i = 0; i < _notaries.length; i++) { _setupRole(DEFAULT_ADMIN_ROLE, _notaries[i]); _setupRole(NOTARY, _notaries[i]); } _setRoleAdmin(NOTARY, DEFAULT_ADMIN_ROLE); } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ function getCitizenAlpha() external view returns (address) { return _citizenAlpha; } /** * @notice Check Notary status * @param citizen address * @return status bool */ function isNotary(address citizen) external view returns (bool status) { return hasRole(NOTARY, citizen); } /** * @notice Issue Citizenship * @param to address */ function issue(address to) external { require(hasRole(NOTARY, _msgSender()), "Notary:unauthorized-access"); _issue(to); } /** * @notice Batch issue Citizenships * @param to address */ function issueBatch(address[] calldata to) external { require(hasRole(NOTARY, _msgSender()), "Notary:unauthorized-access"); for (uint256 i = 0; i < to.length; i++) { _issue(to[i]); } } /** * @notice Revoke Citizenship * @param from address */ function revoke(address from) external { require(hasRole(NOTARY, _msgSender()), "Notary:unauthorized-access"); _revoke(from); } /** * @notice Batch Revoke Citizenships * @param from address */ function revokeBatch(address[] calldata from) external { require(hasRole(NOTARY, _msgSender()), "Notary:unauthorized-access"); for (uint256 i = 0; i < from.length; i++) { _revoke(from[i]); } } /* ===================================================================================== */ /* Internal Functions */ /* ===================================================================================== */ function _issue(address _to) internal { ICitizenAlpha(_citizenAlpha).issue(_to); } function _revoke(address _from) internal { ICitizenAlpha(_citizenAlpha).revoke(_from); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import { Base64 } from "base64-sol/base64.sol"; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { Strings } from "@openzeppelin/contracts/utils/Strings.sol"; import { svg } from "./libraries/SVG.sol"; import { svgUtils } from "./libraries/SVGUtils.sol"; import { SVGColor } from "./libraries/SVGColor.sol"; contract SVGRender is Ownable { using Strings for uint256; address public svgColor; constructor(address _svgColor) { svgColor = _svgColor; } function generate(uint256 _tokenId, string memory _alias) public view returns (string memory) { string memory _bgDef = svgUtils.getDefURL("charcoal"); return string( abi.encodePacked( svg.start(), _getDefs(), svg.rect( string.concat( svg.prop("fill", _bgDef), svg.prop("x", "0"), svg.prop("y", "0"), svg.prop("width", "100%"), svg.prop("height", "100%") ), svgUtils.NULL ), svg.text( string.concat( svg.prop("x", "50%"), svg.prop("y", "50%"), svg.prop("dominant-baseline", "middle"), svg.prop("text-anchor", "middle"), svg.prop("font-size", "48px"), svg.prop("fill", "white") ), string.concat("CIV #", _tokenId.toString()) ), svg.text( string.concat( svg.prop("x", "50%"), svg.prop("y", "60%"), svg.prop("dominant-baseline", "middle"), svg.prop("text-anchor", "middle"), svg.prop("font-size", "22px"), svg.prop("fill", "white") ), _alias ), svg.end() ) ); } function _getDefs() internal view returns (string memory) { return svg.defs( string.concat( svg.linearGradient( string.concat(svg.prop("id", "charcoal"), svg.prop("gradientTransform", "rotate(140)")), string.concat( svg.stop( string.concat( svg.prop("offset", "0%"), svg.prop("stop-color", SVGColor(svgColor).getRgba("Dark1")) ) ), svg.stop( string.concat( svg.prop("offset", "70%"), svg.prop("stop-color", SVGColor(svgColor).getRgba("Dark2")) ) ) ) ) ) ); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { NameEncoder } from "../libraries/NameEncoder.sol"; import { ISource } from "../interfaces/ISource.sol"; import { IReverseRegistrar } from "../interfaces/ENS/IReverseRegistrar.sol"; import { ITextResolver } from "../interfaces/ENS/ITextResolver.sol"; import { IDefaultReverseResolver } from "../interfaces/ENS/IDefaultReverseResolver.sol"; contract SourceENS is ISource, Ownable { using NameEncoder for string; string[] private _keys; address private constant RESOLVER = 0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41; address private constant REVERSE_REGISTRAR = 0x084b1c3C81545d370f3634392De611CaaBFf8148; address private constant DEFAULT_REVERSE_RESOLVER = 0xA2C122BE93b0074270ebeE7f6b7292C7deB45047; constructor() { _keys.push("avatar"); _keys.push("url"); _keys.push("description"); _keys.push("com.github"); _keys.push("com.twitter"); _keys.push("org.telegram"); _keys.push("did"); } /* ===================================================================================== */ /* External Functions */ /* ===================================================================================== */ /** * @notice Get Keys * @return keys string[] */ function getKeys() external view returns (string[] memory keys) { return _keys; } /** * @notice Get data fields count for user * @return count uint256 */ function count(address user) external view returns (uint256 count) { (, bytes32 node_, ITextResolver res_) = _resolveOwner(user); (string[] memory keys_, ) = _fetchNodeTextFields(_keys, node_, res_); return keys_.length; } /** * @notice Get all available data for user * @param user address * @return keys string[] * @return values string[] */ function getData(address user) external view returns (string[] memory keys, string[] memory values) { (, bytes32 node_, ITextResolver res_) = _resolveOwner(user); (string[] memory keys_, string[] memory values_) = _fetchNodeTextFields(_keys, node_, res_); return (keys_, values_); } function getMetadata(address _address) external view returns ( bytes32 node, string memory name, address resolver ) { (string memory name, bytes32 node, ITextResolver resolver) = _resolveOwner(_address); return (node, name, address(resolver)); } /** * @notice Get data value for user * @param user address * @param key string * @return value string */ function getValue(address user, string memory key) external view returns (string memory) { (, bytes32 node_, ITextResolver res_) = _resolveOwner(user); return res_.text(node_, key); } /** * @notice Append Key * @param key string */ function appendKey(string calldata key) external onlyOwner { _keys.push(key); } /** * @notice Set Key * @param idx uint256 * @param key string */ function updateKey(uint256 idx, string calldata key) external onlyOwner { _keys[idx] = key; } /* ===================================================================================== */ /* Internal Functions */ /* ===================================================================================== */ function _resolveOwner(address owner_) internal view returns ( string memory, bytes32, ITextResolver ) { bytes32 node_ = IReverseRegistrar(REVERSE_REGISTRAR).node(owner_); string memory _name = IDefaultReverseResolver(DEFAULT_REVERSE_RESOLVER).name(node_); (, bytes32 _node) = _name.dnsEncodeName(); ITextResolver _resolver = ITextResolver(RESOLVER); return (_name, _node, _resolver); } function _fetchNodeTextFields( string[] memory _traits, bytes32 _node, ITextResolver _resolver ) internal view returns (string[] memory keys_, string[] memory values_) { string[] memory __keys = new string[](_traits.length); string[] memory __values = new string[](_traits.length); for (uint256 i = 0; i < _traits.length; i++) { __keys[i] = _traits[i]; __values[i] = _resolver.text(_node, _traits[i]); } return (__keys, __values); } }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; interface IDefaultReverseResolver { function name(bytes32 input) external view returns (string calldata); }
pragma solidity >=0.8.4; interface IReverseRegistrar { function setDefaultResolver(address resolver) external; function claim(address owner) external returns (bytes32); function claimForAddr( address addr, address owner, address resolver ) external returns (bytes32); function claimWithResolver(address owner, address resolver) external returns (bytes32); function setName(string memory name) external returns (bytes32); function setNameForAddr( address addr, address owner, address resolver, string memory name ) external returns (bytes32); function node(address addr) external pure returns (bytes32); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; interface ITextResolver { event TextChanged(bytes32 indexed node, string indexed indexedKey, string key); /** * Returns the text data associated with an ENS node and key. * @param node The ENS node to query. * @param key The text data key to query. * @return The associated text data. */ function text(bytes32 node, string calldata key) external view returns (string memory); }
//SPDX-License-Identifier: MIT pragma solidity 0.8.15; interface ICitizenAlpha { function ownerOf(uint256 _id) external view returns (address owner); function issue(address _citizen) external; function revoke(address _citizen) external; function getId(address citizen) external view returns (uint256); function getLink(address citizen) external view returns (address issuer); function hasRole(bytes32 role, address citizen) external view returns (bool); }
//SPDX-License-Identifier: MIT pragma solidity 0.8.15; interface ISource { function count(address _address) external view returns (uint256); function getData(address _address) external view returns (string[] memory keys, string[] memory values); function getValue(address _address, string memory _key) external view returns (string memory); }
//SPDX-License-Identifier: MIT pragma solidity >=0.8.4; library BytesUtils { /* * @dev Returns the keccak-256 hash of a byte range. * @param self The byte string to hash. * @param offset The position to start hashing at. * @param len The number of bytes to hash. * @return The hash of the byte range. */ function keccak( bytes memory self, uint256 offset, uint256 len ) internal pure returns (bytes32 ret) { require(offset + len <= self.length); assembly { ret := keccak256(add(add(self, 32), offset), len) } } /** * @dev Returns the ENS namehash of a DNS-encoded name. * @param self The DNS-encoded name to hash. * @param offset The offset at which to start hashing. * @return The namehash of the name. */ function namehash(bytes memory self, uint256 offset) internal pure returns (bytes32) { (bytes32 labelhash, uint256 newOffset) = readLabel(self, offset); if (labelhash == bytes32(0)) { require(offset == self.length - 1, "namehash: Junk at end of name"); return bytes32(0); } return keccak256(abi.encodePacked(namehash(self, newOffset), labelhash)); } /** * @dev Returns the keccak-256 hash of a DNS-encoded label, and the offset to the start of the next label. * @param self The byte string to read a label from. * @param idx The index to read a label at. * @return labelhash The hash of the label at the specified index, or 0 if it is the last label. * @return newIdx The index of the start of the next label. */ function readLabel(bytes memory self, uint256 idx) internal pure returns (bytes32 labelhash, uint256 newIdx) { require(idx < self.length, "readLabel: Index out of bounds"); uint256 len = uint256(uint8(self[idx])); if (len > 0) { labelhash = keccak(self, idx + 1, len); } else { labelhash = bytes32(0); } newIdx = idx + len + 1; } }
// SPDX-License-Identifier: MIT pragma solidity 0.8.15; import "./BytesUtils.sol"; library NameEncoder { using BytesUtils for bytes; function dnsEncodeName(string memory name) internal pure returns (bytes memory dnsName, bytes32 node) { uint8 labelLength = 0; bytes memory bytesName = bytes(name); uint256 length = bytesName.length; dnsName = new bytes(length + 2); node = 0; if (length == 0) { dnsName[0] = 0; return (dnsName, node); } // use unchecked to save gas since we check for an underflow // and we check for the length before the loop unchecked { for (uint256 i = length - 1; i >= 0; i--) { if (bytesName[i] == ".") { dnsName[i + 1] = bytes1(labelLength); node = keccak256(abi.encodePacked(node, bytesName.keccak(i + 1, labelLength))); labelLength = 0; } else { labelLength += 1; dnsName[i + 1] = bytesName[i]; } if (i == 0) { break; } } } node = keccak256(abi.encodePacked(node, bytesName.keccak(0, labelLength))); dnsName[0] = bytes1(labelLength); return (dnsName, node); } }
//SPDX-License-Identifier: MIT pragma solidity ^0.8.13; import "@openzeppelin/contracts/utils/Strings.sol"; import "./SVGUtils.sol"; /** * @title svg * @author Kames Geraghty * @notice SVG construction library using web-like API. * @dev Original code from w1nt3r-eth/hot-chain-svg (https://github.com/w1nt3r-eth/hot-chain-svg) */ library svg { using Strings for uint256; using Strings for uint8; function g(string memory _props, string memory _children) internal pure returns (string memory) { return el("g", _props, _children); } function path(string memory _props, string memory _children) internal pure returns (string memory) { return el("path", _props, _children); } function text(string memory _props, string memory _children) internal pure returns (string memory) { return el("text", _props, _children); } function line(string memory _props, string memory _children) internal pure returns (string memory) { return el("line", _props, _children); } function circle(string memory _props, string memory _children) internal pure returns (string memory) { return el("circle", _props, _children); } function circle(string memory _props) internal pure returns (string memory) { return el("circle", _props); } function rect(string memory _props, string memory _children) internal pure returns (string memory) { return el("rect", _props, _children); } function rect(string memory _props) internal pure returns (string memory) { return el("rect", _props); } function stop(string memory _props) internal pure returns (string memory) { return el("stop", _props); } function filter(string memory _props, string memory _children) internal pure returns (string memory) { return el("filter", _props, _children); } function defs(string memory _children) internal pure returns (string memory) { return el("defs", "", _children); } function cdata(string memory _content) internal pure returns (string memory) { return string.concat("<![CDATA[", _content, "]]>"); } /* GRADIENTS */ function radialGradient(string memory _props, string memory _children) internal pure returns (string memory) { return el("radialGradient", _props, _children); } function linearGradient(string memory _props, string memory _children) internal pure returns (string memory) { return el("linearGradient", _props, _children); } function gradientStop( uint256 offset, string memory stopColor, string memory _props ) internal pure returns (string memory) { return el( "stop", string.concat( prop("stop-color", stopColor), " ", prop("offset", string.concat(svgUtils.uint2str(offset), "%")), " ", _props ) ); } function animateTransform(string memory _props) internal pure returns (string memory) { return el("animateTransform", _props); } function image(string memory _href, string memory _props) internal pure returns (string memory) { return el("image", string.concat(prop("href", _href), " ", _props)); } function start() internal pure returns (string memory) { return string.concat( '<svg width="400" height="400" style="background:#541563" ', 'viewBox="0 0 400 400" ', 'xmlns="http://www.w3.org/2000/svg" ', ">" ); } function end() internal pure returns (bytes memory) { return ("</svg>"); } /* COMMON */ // A generic element, can be used to construct any SVG (or HTML) element function el( string memory _tag, string memory _props, string memory _children ) internal pure returns (string memory) { return string.concat("<", _tag, " ", _props, ">", _children, "</", _tag, ">"); } // A generic element, can be used to construct any SVG (or HTML) element without children function el(string memory _tag, string memory _props) internal pure returns (string memory) { return string.concat("<", _tag, " ", _props, "/>"); } // an SVG attribute function prop(string memory _key, string memory _val) internal pure returns (string memory) { return string.concat(_key, "=", '"', _val, '" '); } function stringifyIntSet( bytes memory _data, uint256 _offset, uint256 _len ) public pure returns (bytes memory) { bytes memory res; require(_data.length >= _offset + _len, "Out of range"); for (uint256 i = _offset; i < _offset + _len; i++) { res = abi.encodePacked(res, byte2uint8(_data, i).toString(), " "); } return res; } function byte2uint8(bytes memory _data, uint256 _offset) public pure returns (uint8) { require(_data.length > _offset, "Out of range"); return uint8(_data[_offset]); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.13; import "@openzeppelin/contracts/utils/Strings.sol"; contract SVGColor { using Strings for uint256; using Strings for uint8; mapping(string => bytes) public colors; constructor() { colors["Black"] = hex"000000"; colors["White"] = hex"FFFFFF"; colors["Dark1"] = hex"232323"; colors["Dark2"] = hex"464646"; } function getColor(string memory _colorName) public view returns (bytes memory) { require(colors[_colorName].length == 3, "Unknown color"); return abi.encodePacked(colors[_colorName], hex"64"); } function getColor(string memory _colorName, uint8 _alpha) public view returns (bytes memory) { require(colors[_colorName].length == 3, "Unknown color"); return abi.encodePacked(colors[_colorName], _alpha); } function getRgba(string memory _colorName) public view returns (string memory) { return string(toRgba(getColor(_colorName), 0)); } // Input: array of colors (without alpha) // Ouputs a linearGradient function autoLinearGradient( bytes memory _colors, bytes memory _id, bytes memory _customAttributes ) public view returns (bytes memory) { return this.autoLinearGradient("", _colors, _id, _customAttributes); } function autoLinearGradient( bytes memory _coordinates, bytes memory _colors, bytes memory _id, bytes memory _customAttributes ) external view returns (bytes memory) { bytes memory _b; if (_coordinates.length > 3) { _b = abi.encodePacked(uint8(128), _coordinates); } else { _b = hex"00"; } // Count the number of colors passed, each on 4 byte uint256 colorCount = _colors.length / 4; uint8 i = 0; while (i < colorCount) { _b = abi.encodePacked( _b, uint8(i * (100 / (colorCount - 1))), // grad. stop % uint8(_colors[i * 4]), uint8(_colors[i * 4 + 1]), uint8(_colors[i * 4 + 2]), uint8(_colors[i * 4 + 3]) ); i++; } return linearGradient(_b, _id, _customAttributes); } function linearGradient( bytes memory _lg, bytes memory _id, bytes memory _customAttributes ) public pure returns (bytes memory) { bytes memory grdata; uint8 offset = 1; if (uint8(_lg[0]) & 128 == 128) { grdata = abi.encodePacked( 'x1="', byte2uint8(_lg, 1).toString(), '%" x2="', byte2uint8(_lg, 2).toString(), '%" y1="', byte2uint8(_lg, 3).toString(), '%" y2="', byte2uint8(_lg, 4).toString(), '%"' ); offset = 5; } grdata = abi.encodePacked('<linearGradient id="', _id, '" ', _customAttributes, grdata, ">"); for (uint256 i = offset; i < _lg.length; i += 5) { grdata = abi.encodePacked( grdata, '<stop offset="', byte2uint8(_lg, i).toString(), '%" stop-color="', toRgba(_lg, i + 1), '" id="', _id, byte2uint8(_lg, i).toString(), '"/>' ); } return abi.encodePacked(grdata, "</linearGradient>"); } function toRgba(bytes memory _rgba, uint256 offset) public pure returns (bytes memory) { return abi.encodePacked( "rgba(", byte2uint8(_rgba, offset).toString(), ",", byte2uint8(_rgba, offset + 1).toString(), ",", byte2uint8(_rgba, offset + 2).toString(), ",", byte2uint8(_rgba, offset + 3).toString(), "%)" ); } function byte2uint8(bytes memory _data, uint256 _offset) public pure returns (uint8) { require(_data.length > _offset, "Out of range"); return uint8(_data[_offset]); } // formats rgba white with a specified opacity / alpha function white_a(uint256 _a) internal pure returns (string memory) { return rgba(255, 255, 255, _a); } // formats rgba black with a specified opacity / alpha function black_a(uint256 _a) internal pure returns (string memory) { return rgba(0, 0, 0, _a); } // formats generic rgba color in css function rgba( uint256 _r, uint256 _g, uint256 _b, uint256 _a ) internal pure returns (string memory) { string memory formattedA = _a < 100 ? string.concat("0.", uint2str(_a)) : "1"; return string.concat( "rgba(", uint2str(_r), ",", uint2str(_g), ",", uint2str(_b), ",", formattedA, ")" ); } function uint2str(uint256 _i) internal pure returns (string memory _uintAsString) { if (_i == 0) { return "0"; } uint256 j = _i; uint256 len; while (j != 0) { len++; j /= 10; } bytes memory bstr = new bytes(len); uint256 k = len; while (_i != 0) { k = k - 1; uint8 temp = (48 + uint8(_i - (_i / 10) * 10)); bytes1 b1 = bytes1(temp); bstr[k] = b1; _i /= 10; } return string(bstr); } }
//SPDX-License-Identifier: MIT pragma solidity ^0.8.13; import "@openzeppelin/contracts/utils/Strings.sol"; /** * @title SVG Utilities * @author Kames Geraghty * @notice The SVG Utilities Library provides functions for constructing SVG; format CSS and numbers. * @dev Original code from w1nt3r-eth/hot-chain-svg (https://github.com/w1nt3r-eth/hot-chain-svg) */ library svgUtils { using Strings for uint256; using Strings for uint8; /// @notice Empty SVG element string internal constant NULL = ""; /** * @notice Formats a CSS variable line. Includes a semicolon for formatting. * @param _key User for which to calculate prize amount. * @param _val User for which to calculate prize amount. * @return string Generated CSS variable. */ function setCssVar(string memory _key, string memory _val) internal pure returns (string memory) { return string.concat("--", _key, ":", _val, ";"); } /** * @notice Formats getting a css variable * @param _key User for which to calculate prize amount. * @return string Generated CSS variable. */ function getCssVar(string memory _key) internal pure returns (string memory) { return string.concat("var(--", _key, ")"); } // formats getting a def URL function getDefURL(string memory _id) internal pure returns (string memory) { return string.concat("url(#", _id, ")"); } // checks if two strings are equal function stringsEqual(string memory _a, string memory _b) internal pure returns (bool) { return keccak256(abi.encodePacked(_a)) == keccak256(abi.encodePacked(_b)); } // returns the length of a string in characters function utfStringLength(string memory _str) internal pure returns (uint256 length) { uint256 i = 0; bytes memory string_rep = bytes(_str); while (i < string_rep.length) { if (string_rep[i] >> 7 == 0) i += 1; else if (string_rep[i] >> 5 == bytes1(uint8(0x6))) i += 2; else if (string_rep[i] >> 4 == bytes1(uint8(0xE))) i += 3; else if (string_rep[i] >> 3 == bytes1(uint8(0x1E))) i += 4; //For safety else i += 1; length++; } } function round2Txt( uint256 _value, uint8 _decimals, uint8 _prec ) internal pure returns (bytes memory) { return abi.encodePacked( (_value / 10 ** _decimals).toString(), ".", ( _value / 10 ** (_decimals - _prec) - _value / 10 ** (_decimals ) * 10 ** _prec ).toString() ); } // converts an unsigned integer to a string function uint2str(uint256 _i) internal pure returns (string memory _uintAsString) { if (_i == 0) { return "0"; } uint256 j = _i; uint256 len; while (j != 0) { len++; j /= 10; } bytes memory bstr = new bytes(len); uint256 k = len; while (_i != 0) { k = k - 1; uint8 temp = (48 + uint8(_i - (_i / 10) * 10)); bytes1 b1 = bytes1(temp); bstr[k] = b1; _i /= 10; } return string(bstr); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; /** * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow * checks. * * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can * easily result in undesired exploitation or bugs, since developers usually * assume that overflows raise errors. `SafeCast` restores this intuition by * reverting the transaction when such an operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. * * Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing * all math on `uint256` and `int256` and then downcasting. */ library ExtendedSafeCastLib { /** * @dev Returns the downcasted uint104 from uint256, reverting on * overflow (when the input is greater than largest uint104). * * Counterpart to Solidity's `uint104` operator. * * Requirements: * * - input must fit into 104 bits */ function toUint104(uint256 _value) internal pure returns (uint104) { require(_value <= type(uint104).max, "SafeCast: value doesn't fit in 104 bits"); return uint104(_value); } /** * @dev Returns the downcasted uint208 from uint256, reverting on * overflow (when the input is greater than largest uint208). * * Counterpart to Solidity's `uint208` operator. * * Requirements: * * - input must fit into 208 bits */ function toUint208(uint256 _value) internal pure returns (uint208) { require(_value <= type(uint208).max, "SafeCast: value doesn't fit in 208 bits"); return uint208(_value); } /** * @dev Returns the downcasted uint224 from uint256, reverting on * overflow (when the input is greater than largest uint224). * * Counterpart to Solidity's `uint224` operator. * * Requirements: * * - input must fit into 224 bits */ function toUint224(uint256 _value) internal pure returns (uint224) { require(_value <= type(uint224).max, "SafeCast: value doesn't fit in 224 bits"); return uint224(_value); } /** * @dev Returns the downcasted uint192 from uint256, reverting on * overflow (when the input is greater than largest uint192). * * Counterpart to Solidity's `uint192` operator. * * Requirements: * * - input must fit into 224 bits */ function toUint192(uint256 value) internal pure returns (uint192) { require(value <= type(uint192).max, "SafeCast: value doesn't fit in 192 bits"); return uint192(value); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import "@openzeppelin/contracts/utils/math/SafeCast.sol"; import "./OverflowSafeComparatorLib.sol"; import "./RingBufferLib.sol"; /** * @title Observation Library * @notice This library allows one to store an array of timestamped values and efficiently binary search them. * @dev Largely pulled from Uniswap V3 Oracle.sol: https://github.com/Uniswap/v3-core/blob/c05a0e2c8c08c460fb4d05cfdda30b3ad8deeaac/contracts/libraries/Oracle.sol * @author PoolTogether Inc. */ library ObservationLib { using OverflowSafeComparatorLib for uint32; using SafeCast for uint256; /// @notice The maximum number of observations uint24 public constant MAX_CARDINALITY = 16777215; // 2**24 /** * @notice Observation, which includes an amount and timestamp. * @param amount `amount` at `timestamp`. * @param timestamp Recorded `timestamp`. */ struct Observation { uint224 amount; uint32 timestamp; } /** * @notice Fetches Observations `beforeOrAt` and `atOrAfter` a `_target`, eg: where [`beforeOrAt`, `atOrAfter`] is satisfied. * The result may be the same Observation, or adjacent Observations. * @dev The answer must be contained in the array used when the target is located within the stored Observation. * boundaries: older than the most recent Observation and younger, or the same age as, the oldest Observation. * @dev If `_newestObservationIndex` is less than `_oldestObservationIndex`, it means that we've wrapped around the circular buffer. * So the most recent observation will be at `_oldestObservationIndex + _cardinality - 1`, at the beginning of the circular buffer. * @param _observations List of Observations to search through. * @param _newestObservationIndex Index of the newest Observation. Right side of the circular buffer. * @param _oldestObservationIndex Index of the oldest Observation. Left side of the circular buffer. * @param _target Timestamp at which we are searching the Observation. * @param _cardinality Cardinality of the circular buffer we are searching through. * @param _time Timestamp at which we perform the binary search. * @return beforeOrAt Observation recorded before, or at, the target. * @return atOrAfter Observation recorded at, or after, the target. */ function binarySearch( Observation[MAX_CARDINALITY] storage _observations, uint24 _newestObservationIndex, uint24 _oldestObservationIndex, uint32 _target, uint24 _cardinality, uint32 _time ) internal view returns (Observation memory beforeOrAt, Observation memory atOrAfter) { uint256 leftSide = _oldestObservationIndex; uint256 rightSide = _newestObservationIndex < leftSide ? leftSide + _cardinality - 1 : _newestObservationIndex; uint256 currentIndex; while (true) { // We start our search in the middle of the `leftSide` and `rightSide`. // After each iteration, we narrow down the search to the left or the right side while still starting our search in the middle. currentIndex = (leftSide + rightSide) / 2; beforeOrAt = _observations[uint24(RingBufferLib.wrap(currentIndex, _cardinality))]; uint32 beforeOrAtTimestamp = beforeOrAt.timestamp; // We've landed on an uninitialized timestamp, keep searching higher (more recently). if (beforeOrAtTimestamp == 0) { leftSide = currentIndex + 1; continue; } atOrAfter = _observations[uint24(RingBufferLib.nextIndex(currentIndex, _cardinality))]; bool targetAtOrAfter = beforeOrAtTimestamp.lte(_target, _time); // Check if we've found the corresponding Observation. if (targetAtOrAfter && _target.lte(atOrAfter.timestamp, _time)) { break; } // If `beforeOrAtTimestamp` is greater than `_target`, then we keep searching lower. To the left of the current index. if (!targetAtOrAfter) { rightSide = currentIndex - 1; } else { // Otherwise, we keep searching higher. To the left of the current index. leftSide = currentIndex + 1; } } } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; /// @title OverflowSafeComparatorLib library to share comparator functions between contracts /// @dev Code taken from Uniswap V3 Oracle.sol: https://github.com/Uniswap/v3-core/blob/3e88af408132fc957e3e406f65a0ce2b1ca06c3d/contracts/libraries/Oracle.sol /// @author PoolTogether Inc. library OverflowSafeComparatorLib { /// @notice 32-bit timestamps comparator. /// @dev safe for 0 or 1 overflows, `_a` and `_b` must be chronologically before or equal to time. /// @param _a A comparison timestamp from which to determine the relative position of `_timestamp`. /// @param _b Timestamp to compare against `_a`. /// @param _timestamp A timestamp truncated to 32 bits. /// @return bool Whether `_a` is chronologically < `_b`. function lt( uint32 _a, uint32 _b, uint32 _timestamp ) internal pure returns (bool) { // No need to adjust if there hasn't been an overflow if (_a <= _timestamp && _b <= _timestamp) return _a < _b; uint256 aAdjusted = _a > _timestamp ? _a : _a + 2**32; uint256 bAdjusted = _b > _timestamp ? _b : _b + 2**32; return aAdjusted < bAdjusted; } /// @notice 32-bit timestamps comparator. /// @dev safe for 0 or 1 overflows, `_a` and `_b` must be chronologically before or equal to time. /// @param _a A comparison timestamp from which to determine the relative position of `_timestamp`. /// @param _b Timestamp to compare against `_a`. /// @param _timestamp A timestamp truncated to 32 bits. /// @return bool Whether `_a` is chronologically <= `_b`. function lte( uint32 _a, uint32 _b, uint32 _timestamp ) internal pure returns (bool) { // No need to adjust if there hasn't been an overflow if (_a <= _timestamp && _b <= _timestamp) return _a <= _b; uint256 aAdjusted = _a > _timestamp ? _a : _a + 2**32; uint256 bAdjusted = _b > _timestamp ? _b : _b + 2**32; return aAdjusted <= bAdjusted; } /// @notice 32-bit timestamp subtractor /// @dev safe for 0 or 1 overflows, where `_a` and `_b` must be chronologically before or equal to time /// @param _a The subtraction left operand /// @param _b The subtraction right operand /// @param _timestamp The current time. Expected to be chronologically after both. /// @return The difference between a and b, adjusted for overflow function checkedSub( uint32 _a, uint32 _b, uint32 _timestamp ) internal pure returns (uint32) { // No need to adjust if there hasn't been an overflow if (_a <= _timestamp && _b <= _timestamp) return _a - _b; uint256 aAdjusted = _a > _timestamp ? _a : _a + 2**32; uint256 bAdjusted = _b > _timestamp ? _b : _b + 2**32; return uint32(aAdjusted - bAdjusted); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; library RingBufferLib { /** * @notice Returns wrapped TWAB index. * @dev In order to navigate the TWAB circular buffer, we need to use the modulo operator. * @dev For example, if `_index` is equal to 32 and the TWAB circular buffer is of `_cardinality` 32, * it will return 0 and will point to the first element of the array. * @param _index Index used to navigate through the TWAB circular buffer. * @param _cardinality TWAB buffer cardinality. * @return TWAB index. */ function wrap(uint256 _index, uint256 _cardinality) internal pure returns (uint256) { return _index % _cardinality; } /** * @notice Computes the negative offset from the given index, wrapped by the cardinality. * @dev We add `_cardinality` to `_index` to be able to offset even if `_amount` is superior to `_cardinality`. * @param _index The index from which to offset * @param _amount The number of indices to offset. This is subtracted from the given index. * @param _cardinality The number of elements in the ring buffer * @return Offsetted index. */ function offset( uint256 _index, uint256 _amount, uint256 _cardinality ) internal pure returns (uint256) { return wrap(_index + _cardinality - _amount, _cardinality); } /// @notice Returns the index of the last recorded TWAB /// @param _nextIndex The next available twab index. This will be recorded to next. /// @param _cardinality The cardinality of the TWAB history. /// @return The index of the last recorded TWAB function newestIndex(uint256 _nextIndex, uint256 _cardinality) internal pure returns (uint256) { if (_cardinality == 0) { return 0; } return wrap(_nextIndex + _cardinality - 1, _cardinality); } /// @notice Computes the ring buffer index that follows the given one, wrapped by cardinality /// @param _index The index to increment /// @param _cardinality The number of elements in the Ring Buffer /// @return The next index relative to the given index. Will wrap around to 0 if the next index == cardinality function nextIndex(uint256 _index, uint256 _cardinality) internal pure returns (uint256) { return wrap(_index + 1, _cardinality); } }
// SPDX-License-Identifier: GPL-3.0 pragma solidity 0.8.15; import "./ExtendedSafeCastLib.sol"; import "./OverflowSafeComparatorLib.sol"; import "./RingBufferLib.sol"; import "./ObservationLib.sol"; /** * @title PoolTogether V4 TwabLib (Library) * @author PoolTogether Inc Team * @dev Time-Weighted Average Balance Library for ERC20 tokens. * @notice This TwabLib adds on-chain historical lookups to a user(s) time-weighted average balance. Each user is mapped to an Account struct containing the TWAB history (ring buffer) and ring buffer parameters. Every token.transfer() creates a new TWAB checkpoint. The new TWAB checkpoint is stored in the circular ring buffer, as either a new checkpoint or rewriting a previous checkpoint with new parameters. The TwabLib (using existing blocktimes of 1block/15sec) guarantees minimum 7.4 years of search history. */ library TwabLib { using OverflowSafeComparatorLib for uint32; using ExtendedSafeCastLib for uint256; /** * @notice Sets max ring buffer length in the Account.twabs Observation list. As users transfer/mint/burn tickets new Observation checkpoints are recorded. The current max cardinality guarantees a seven year minimum, of accurate historical lookups with current estimates of 1 new block every 15 seconds - assuming each block contains a transfer to trigger an observation write to storage. * @dev The user Account.AccountDetails.cardinality parameter can NOT exceed the max cardinality variable. Preventing "corrupted" ring buffer lookup pointers and new observation checkpoints. The MAX_CARDINALITY in fact guarantees at least 7.4 years of records: If 14 = block time in seconds (2**24) * 14 = 234881024 seconds of history 234881024 / (365 * 24 * 60 * 60) ~= 7.44 years */ uint24 public constant MAX_CARDINALITY = 16777215; // 2**24 /** @notice Struct ring buffer parameters for single user Account * @param balance Current balance for an Account * @param nextTwabIndex Next uninitialized or updatable ring buffer checkpoint storage slot * @param cardinality Current total "initialized" ring buffer checkpoints for single user AccountDetails. Used to set initial boundary conditions for an efficient binary search. */ struct AccountDetails { uint208 balance; uint24 nextTwabIndex; uint24 cardinality; } /// @notice Combines account details with their twab history /// @param details The account details /// @param twabs The history of twabs for this account struct Account { AccountDetails details; ObservationLib.Observation[MAX_CARDINALITY] twabs; } /// @notice Increases an account's balance and records a new twab. /// @param _account The account whose balance will be increased /// @param _amount The amount to increase the balance by /// @param _currentTime The current time /// @return accountDetails The new AccountDetails /// @return twab The user's latest TWAB /// @return isNew Whether the TWAB is new function increaseBalance( Account storage _account, uint208 _amount, uint32 _currentTime ) internal returns ( AccountDetails memory accountDetails, ObservationLib.Observation memory twab, bool isNew ) { AccountDetails memory _accountDetails = _account.details; (accountDetails, twab, isNew) = _nextTwab(_account.twabs, _accountDetails, _currentTime); accountDetails.balance = _accountDetails.balance + _amount; } /** @notice Calculates the next TWAB checkpoint for an account with a decreasing balance. * @dev With Account struct and amount decreasing calculates the next TWAB observable checkpoint. * @param _account Account whose balance will be decreased * @param _amount Amount to decrease the balance by * @param _revertMessage Revert message for insufficient balance * @return accountDetails Updated Account.details struct * @return twab TWAB observation (with decreasing average) * @return isNew Whether TWAB is new or calling twice in the same block */ function decreaseBalance( Account storage _account, uint208 _amount, string memory _revertMessage, uint32 _currentTime ) internal returns ( AccountDetails memory accountDetails, ObservationLib.Observation memory twab, bool isNew ) { AccountDetails memory _accountDetails = _account.details; require(_accountDetails.balance >= _amount, _revertMessage); (accountDetails, twab, isNew) = _nextTwab(_account.twabs, _accountDetails, _currentTime); unchecked { accountDetails.balance -= _amount; } } /** @notice Calculates the average balance held by a user for a given time frame. * @dev Finds the average balance between start and end timestamp epochs. Validates the supplied end time is within the range of elapsed time i.e. less then timestamp of now. * @param _twabs Individual user Observation recorded checkpoints passed as storage pointer * @param _accountDetails User AccountDetails struct loaded in memory * @param _startTime Start of timestamp range as an epoch * @param _endTime End of timestamp range as an epoch * @param _currentTime Block.timestamp * @return Average balance of user held between epoch timestamps start and end */ function getAverageBalanceBetween( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, uint32 _startTime, uint32 _endTime, uint32 _currentTime ) internal view returns (uint256) { uint32 endTime = _endTime > _currentTime ? _currentTime : _endTime; return _getAverageBalanceBetween(_twabs, _accountDetails, _startTime, endTime, _currentTime); } /// @notice Retrieves the oldest TWAB /// @param _twabs The storage array of twabs /// @param _accountDetails The TWAB account details /// @return index The index of the oldest TWAB in the twabs array /// @return twab The oldest TWAB function oldestTwab( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails ) internal view returns (uint24 index, ObservationLib.Observation memory twab) { index = _accountDetails.nextTwabIndex; twab = _twabs[index]; // If the TWAB is not initialized we go to the beginning of the TWAB circular buffer at index 0 if (twab.timestamp == 0) { index = 0; twab = _twabs[0]; } } /// @notice Retrieves the newest TWAB /// @param _twabs The storage array of twabs /// @param _accountDetails The TWAB account details /// @return index The index of the newest TWAB in the twabs array /// @return twab The newest TWAB function newestTwab( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails ) internal view returns (uint24 index, ObservationLib.Observation memory twab) { index = uint24(RingBufferLib.newestIndex(_accountDetails.nextTwabIndex, MAX_CARDINALITY)); twab = _twabs[index]; } /// @notice Retrieves amount at `_targetTime` timestamp /// @param _twabs List of TWABs to search through. /// @param _accountDetails Accounts details /// @param _targetTime Timestamp at which the reserved TWAB should be for. /// @return uint256 TWAB amount at `_targetTime`. function getBalanceAt( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, uint32 _targetTime, uint32 _currentTime ) internal view returns (uint256) { uint32 timeToTarget = _targetTime > _currentTime ? _currentTime : _targetTime; return _getBalanceAt(_twabs, _accountDetails, timeToTarget, _currentTime); } /// @notice Calculates the average balance held by a user for a given time frame. /// @param _startTime The start time of the time frame. /// @param _endTime The end time of the time frame. /// @return The average balance that the user held during the time frame. function _getAverageBalanceBetween( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, uint32 _startTime, uint32 _endTime, uint32 _currentTime ) private view returns (uint256) { (uint24 oldestTwabIndex, ObservationLib.Observation memory oldTwab) = oldestTwab( _twabs, _accountDetails ); (uint24 newestTwabIndex, ObservationLib.Observation memory newTwab) = newestTwab( _twabs, _accountDetails ); ObservationLib.Observation memory startTwab = _calculateTwab( _twabs, _accountDetails, newTwab, oldTwab, newestTwabIndex, oldestTwabIndex, _startTime, _currentTime ); ObservationLib.Observation memory endTwab = _calculateTwab( _twabs, _accountDetails, newTwab, oldTwab, newestTwabIndex, oldestTwabIndex, _endTime, _currentTime ); // Difference in amount / time return (endTwab.amount - startTwab.amount) / OverflowSafeComparatorLib.checkedSub(endTwab.timestamp, startTwab.timestamp, _currentTime); } /** @notice Searches TWAB history and calculate the difference between amount(s)/timestamp(s) to return average balance between the Observations closes to the supplied targetTime. * @param _twabs Individual user Observation recorded checkpoints passed as storage pointer * @param _accountDetails User AccountDetails struct loaded in memory * @param _targetTime Target timestamp to filter Observations in the ring buffer binary search * @param _currentTime Block.timestamp * @return uint256 Time-weighted average amount between two closest observations. */ function _getBalanceAt( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, uint32 _targetTime, uint32 _currentTime ) private view returns (uint256) { uint24 newestTwabIndex; ObservationLib.Observation memory afterOrAt; ObservationLib.Observation memory beforeOrAt; (newestTwabIndex, beforeOrAt) = newestTwab(_twabs, _accountDetails); // If `_targetTime` is chronologically after the newest TWAB, we can simply return the current balance if (beforeOrAt.timestamp.lte(_targetTime, _currentTime)) { return _accountDetails.balance; } uint24 oldestTwabIndex; // Now, set before to the oldest TWAB (oldestTwabIndex, beforeOrAt) = oldestTwab(_twabs, _accountDetails); // If `_targetTime` is chronologically before the oldest TWAB, we can early return if (_targetTime.lt(beforeOrAt.timestamp, _currentTime)) { return 0; } // Otherwise, we perform the `binarySearch` (beforeOrAt, afterOrAt) = ObservationLib.binarySearch( _twabs, newestTwabIndex, oldestTwabIndex, _targetTime, _accountDetails.cardinality, _currentTime ); // Sum the difference in amounts and divide by the difference in timestamps. // The time-weighted average balance uses time measured between two epoch timestamps as // a constaint on the measurement when calculating the time weighted average balance. return (afterOrAt.amount - beforeOrAt.amount) / OverflowSafeComparatorLib.checkedSub(afterOrAt.timestamp, beforeOrAt.timestamp, _currentTime); } /** @notice Calculates a user TWAB for a target timestamp using the historical TWAB records. The balance is linearly interpolated: amount differences / timestamp differences using the simple (after.amount - before.amount / end.timestamp - start.timestamp) formula. /** @dev Binary search in _calculateTwab fails when searching out of bounds. Thus, before searching we exclude target timestamps out of range of newest/oldest TWAB(s). IF a search is before or after the range we "extrapolate" a Observation from the expected state. * @param _twabs Individual user Observation recorded checkpoints passed as storage pointer * @param _accountDetails User AccountDetails struct loaded in memory * @param _newestTwab Newest TWAB in history (end of ring buffer) * @param _oldestTwab Olderst TWAB in history (end of ring buffer) * @param _newestTwabIndex Pointer in ring buffer to newest TWAB * @param _oldestTwabIndex Pointer in ring buffer to oldest TWAB * @param _targetTimestamp Epoch timestamp to calculate for time (T) in the TWAB * @param _time Block.timestamp * @return accountDetails Updated Account.details struct */ function _calculateTwab( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, ObservationLib.Observation memory _newestTwab, ObservationLib.Observation memory _oldestTwab, uint24 _newestTwabIndex, uint24 _oldestTwabIndex, uint32 _targetTimestamp, uint32 _time ) private view returns (ObservationLib.Observation memory) { // If `_targetTimestamp` is chronologically after the newest TWAB, we extrapolate a new one if (_newestTwab.timestamp.lt(_targetTimestamp, _time)) { return _computeNextTwab(_newestTwab, _accountDetails.balance, _targetTimestamp); } if (_newestTwab.timestamp == _targetTimestamp) { return _newestTwab; } if (_oldestTwab.timestamp == _targetTimestamp) { return _oldestTwab; } // If `_targetTimestamp` is chronologically before the oldest TWAB, we create a zero twab if (_targetTimestamp.lt(_oldestTwab.timestamp, _time)) { return ObservationLib.Observation({ amount: 0, timestamp: _targetTimestamp }); } // Otherwise, both timestamps must be surrounded by twabs. ( ObservationLib.Observation memory beforeOrAtStart, ObservationLib.Observation memory afterOrAtStart ) = ObservationLib.binarySearch( _twabs, _newestTwabIndex, _oldestTwabIndex, _targetTimestamp, _accountDetails.cardinality, _time ); uint224 heldBalance = (afterOrAtStart.amount - beforeOrAtStart.amount) / OverflowSafeComparatorLib.checkedSub( afterOrAtStart.timestamp, beforeOrAtStart.timestamp, _time ); return _computeNextTwab(beforeOrAtStart, heldBalance, _targetTimestamp); } /** * @notice Calculates the next TWAB using the newestTwab and updated balance. * @dev Storage of the TWAB obersation is managed by the calling function and not _computeNextTwab. * @param _currentTwab Newest Observation in the Account.twabs list * @param _currentBalance User balance at time of most recent (newest) checkpoint write * @param _time Current block.timestamp * @return TWAB Observation */ function _computeNextTwab( ObservationLib.Observation memory _currentTwab, uint224 _currentBalance, uint32 _time ) private pure returns (ObservationLib.Observation memory) { // New twab amount = last twab amount (or zero) + (current amount * elapsed seconds) return ObservationLib.Observation({ amount: _currentTwab.amount + _currentBalance * (_time.checkedSub(_currentTwab.timestamp, _time)), timestamp: _time }); } /// @notice Sets a new TWAB Observation at the next available index and returns the new account details. /// @dev Note that if _currentTime is before the last observation timestamp, it appears as an overflow /// @param _twabs The twabs array to insert into /// @param _accountDetails The current account details /// @param _currentTime The current time /// @return accountDetails The new account details /// @return twab The newest twab (may or may not be brand-new) /// @return isNew Whether the newest twab was created by this call function _nextTwab( ObservationLib.Observation[MAX_CARDINALITY] storage _twabs, AccountDetails memory _accountDetails, uint32 _currentTime ) private returns ( AccountDetails memory accountDetails, ObservationLib.Observation memory twab, bool isNew ) { (, ObservationLib.Observation memory _newestTwab) = newestTwab(_twabs, _accountDetails); // if we're in the same block, return if (_newestTwab.timestamp == _currentTime) { return (_accountDetails, _newestTwab, false); } ObservationLib.Observation memory newTwab = _computeNextTwab( _newestTwab, _accountDetails.balance, _currentTime ); _twabs[_accountDetails.nextTwabIndex] = newTwab; AccountDetails memory nextAccountDetails = push(_accountDetails); return (nextAccountDetails, newTwab, true); } /// @notice "Pushes" a new element on the AccountDetails ring buffer, and returns the new AccountDetails /// @param _accountDetails The account details from which to pull the cardinality and next index /// @return The new AccountDetails function push(AccountDetails memory _accountDetails) internal pure returns (AccountDetails memory) { _accountDetails.nextTwabIndex = uint24( RingBufferLib.nextIndex(_accountDetails.nextTwabIndex, MAX_CARDINALITY) ); // Prevent the Account specific cardinality from exceeding the MAX_CARDINALITY. // The ring buffer length is limited by MAX_CARDINALITY. IF the account.cardinality // exceeds the max cardinality, new observations would be incorrectly set or the // observation would be out of "bounds" of the ring buffer. Once reached the // AccountDetails.cardinality will continue to be equal to max cardinality. if (_accountDetails.cardinality < MAX_CARDINALITY) { _accountDetails.cardinality += 1; } return _accountDetails; } }
{ "evmVersion": "istanbul", "libraries": {}, "metadata": { "bytecodeHash": "ipfs", "useLiteralContent": true }, "optimizer": { "enabled": true, "runs": 200 }, "remappings": [], "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } } }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"internalType":"contract CitizenAlpha","name":"citizenAlpha_","type":"address"},{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"symbol","type":"string"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"delegator","type":"address"},{"indexed":true,"internalType":"address","name":"delegate","type":"address"}],"name":"Delegated","type":"event"},{"anonymous":false,"inputs":[{"components":[{"internalType":"uint224","name":"amount","type":"uint224"},{"internalType":"uint32","name":"timestamp","type":"uint32"}],"indexed":false,"internalType":"struct ObservationLib.Observation","name":"newTotalSupplyTwab","type":"tuple"}],"name":"NewTotalSupplyTwab","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"delegate","type":"address"},{"components":[{"internalType":"uint224","name":"amount","type":"uint224"},{"internalType":"uint32","name":"timestamp","type":"uint32"}],"indexed":false,"internalType":"struct ObservationLib.Observation","name":"newTwab","type":"tuple"}],"name":"NewUserTwab","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[],"name":"DOMAIN_SEPARATOR","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"claim","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"subtractedValue","type":"uint256"}],"name":"decreaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"}],"name":"delegate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"}],"name":"delegateOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"address","name":"_newDelegate","type":"address"},{"internalType":"uint256","name":"_deadline","type":"uint256"},{"internalType":"uint8","name":"_v","type":"uint8"},{"internalType":"bytes32","name":"_r","type":"bytes32"},{"internalType":"bytes32","name":"_s","type":"bytes32"}],"name":"delegateWithSignature","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"}],"name":"getAccountDetails","outputs":[{"components":[{"internalType":"uint208","name":"balance","type":"uint208"},{"internalType":"uint24","name":"nextTwabIndex","type":"uint24"},{"internalType":"uint24","name":"cardinality","type":"uint24"}],"internalType":"struct TwabLib.AccountDetails","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint64","name":"_startTime","type":"uint64"},{"internalType":"uint64","name":"_endTime","type":"uint64"}],"name":"getAverageBalanceBetween","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint64[]","name":"_startTimes","type":"uint64[]"},{"internalType":"uint64[]","name":"_endTimes","type":"uint64[]"}],"name":"getAverageBalancesBetween","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint64[]","name":"_startTimes","type":"uint64[]"},{"internalType":"uint64[]","name":"_endTimes","type":"uint64[]"}],"name":"getAverageTotalSuppliesBetween","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint64","name":"_target","type":"uint64"}],"name":"getBalanceAt","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint64[]","name":"_targets","type":"uint64[]"}],"name":"getBalancesAt","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint64[]","name":"_targets","type":"uint64[]"}],"name":"getTotalSuppliesAt","outputs":[{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint64","name":"_target","type":"uint64"}],"name":"getTotalSupplyAt","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_user","type":"address"},{"internalType":"uint16","name":"_index","type":"uint16"}],"name":"getTwab","outputs":[{"components":[{"internalType":"uint224","name":"amount","type":"uint224"},{"internalType":"uint32","name":"timestamp","type":"uint32"}],"internalType":"struct ObservationLib.Observation","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"addedValue","type":"uint256"}],"name":"increaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"nonces","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"},{"internalType":"uint256","name":"deadline","type":"uint256"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"}],"name":"permit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"}]
Contract Creation Code
61016060405269021e19e0c9bab24000006008557f94019368dc6b2ee4ac32010c9d0081ec29874325b541829d001d22c296b5246c610140523480156200004557600080fd5b50604051620035ec380380620035ec833981016040819052620000689162000267565b6040518060400160405280601681526020017f57656233436974697a656e205472757374546f6b656e0000000000000000000081525080604051806040016040528060018152602001603160f81b81525084848160039081620000cc919062000380565b506004620000db828262000380565b5050825160208085019190912083518483012060e08290526101008190524660a0818152604080517f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f81880181905281830187905260608201869052608082019490945230818401528151808203909301835260c0019052805194019390932091935091906080523060c052610120525050600780546001600160a01b0319166001600160a01b039790971696909617909555506200044c9350505050565b634e487b7160e01b600052604160045260246000fd5b600082601f830112620001c257600080fd5b81516001600160401b0380821115620001df57620001df6200019a565b604051601f8301601f19908116603f011681019082821181831017156200020a576200020a6200019a565b816040528381526020925086838588010111156200022757600080fd5b600091505b838210156200024b57858201830151818301840152908201906200022c565b838211156200025d5760008385830101525b9695505050505050565b6000806000606084860312156200027d57600080fd5b83516001600160a01b03811681146200029557600080fd5b60208501519093506001600160401b0380821115620002b357600080fd5b620002c187838801620001b0565b93506040860151915080821115620002d857600080fd5b50620002e786828701620001b0565b9150509250925092565b600181811c908216806200030657607f821691505b6020821081036200032757634e487b7160e01b600052602260045260246000fd5b50919050565b601f8211156200037b57600081815260208120601f850160051c81016020861015620003565750805b601f850160051c820191505b81811015620003775782815560010162000362565b5050505b505050565b81516001600160401b038111156200039c576200039c6200019a565b620003b481620003ad8454620002f1565b846200032d565b602080601f831160018114620003ec5760008415620003d35750858301515b600019600386901b1c1916600185901b17855562000377565b600085815260208120601f198616915b828110156200041d57888601518255948401946001909101908401620003fc565b50858210156200043c5787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b60805160a05160c05160e051610100516101205161014051613145620004a76000396000610a84015260006112cb0152600061131a015260006112f50152600061124e01526000611278015260006112a201526131456000f3fe608060405234801561001057600080fd5b50600436106101a95760003560e01c806368c7fd57116100f957806395d89b4111610097578063a457c2d711610071578063a457c2d71461045c578063a9059cbb1461046f578063d505accf14610482578063dd62ed3e1461049557600080fd5b806395d89b411461042e57806398b16f36146104365780639ecb03701461044957600080fd5b806385beb5f1116100d357806385beb5f1146103ae5780638d22ea2a146103c15780638e6d536a14610408578063919974dc1461041b57600080fd5b806368c7fd571461035f57806370a08231146103725780637ecebe001461039b57600080fd5b8063313ce567116101665780633950935111610140578063395093511461030f5780634e71d92d146103225780635c19a95c1461032c578063613ed6bd1461033f57600080fd5b8063313ce567146102d85780633644e515146102e757806336bb2a38146102ef57600080fd5b806306fdde03146101ae578063095ea7b3146101cc57806318160ddd146101ef57806323b872dd146102015780632aceb534146102145780632d0dd686146102c5575b600080fd5b6101b66104a8565b6040516101c3919061297c565b60405180910390f35b6101df6101da3660046129ed565b61053a565b60405190151581526020016101c3565b6002545b6040519081526020016101c3565b6101df61020f366004612a17565b610554565b61028d610222366004612a53565b6040805160608082018352600080835260208084018290529284018190526001600160a01b03949094168452600a82529282902082519384018352546001600160d01b038116845262ffffff600160d01b8204811692850192909252600160e81b9004169082015290565b6040805182516001600160d01b0316815260208084015162ffffff9081169183019190915292820151909216908201526060016101c3565b6101f36102d3366004612a86565b61057a565b604051601281526020016101c3565b6101f36105c6565b6103026102fd366004612aa1565b6105d5565b6040516101c39190612adf565b6101df61031d3660046129ed565b61064d565b61032a61066f565b005b61032a61033a366004612a53565b6107b9565b61035261034d366004612b4a565b6107c6565b6040516101c39190612b9d565b61035261036d366004612be1565b6108e2565b6101f3610380366004612a53565b6001600160a01b031660009081526020819052604090205490565b6101f36103a9366004612a53565b610914565b6103526103bc366004612c62565b610932565b6103f06103cf366004612a53565b6001600160a01b039081166000908152630100000b60205260409020541690565b6040516001600160a01b0390911681526020016101c3565b610352610416366004612ca4565b610a15565b61032a610429366004612d21565b610a30565b6101b6610b94565b6101f3610444366004612d80565b610ba3565b6101f3610457366004612dc3565b610c14565b6101df61046a3660046129ed565b610c7b565b6101df61047d3660046129ed565b610d01565b61032a610490366004612df6565b610d0f565b6101f36104a3366004612e60565b610e73565b6060600380546104b790612e8a565b80601f01602080910402602001604051908101604052809291908181526020018280546104e390612e8a565b80156105305780601f1061050557610100808354040283529160200191610530565b820191906000526020600020905b81548152906001019060200180831161051357829003601f168201915b5050505050905090565b600033610548818585610e9e565b60019150505b92915050565b600033610562858285610fc2565b61056d85858561103c565b60019150505b9392505050565b60408051606081018252600b546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260009061054e90600c908442611215565b60006105d0611241565b905090565b60408051808201909152600080825260208201526001600160a01b0383166000908152600a6020526040902060010161ffff831662ffffff811061061b5761061b612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201529392505050565b6000336105488185856106608383610e73565b61066a9190612eea565b610e9e565b60075460405163f3caad0360e01b81523360048201526001600160a01b039091169063f3caad0390602401602060405180830381865afa1580156106b7573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106db9190612f02565b6107255760405162461bcd60e51b8152602060048201526016602482015275151c9d5cdd151bdad95b8e9b9bdd0b5d1c9d5cdd195960521b60448201526064015b60405180910390fd5b3360009081526009602052604090205460ff16156107905760405162461bcd60e51b815260206004820152602260248201527f5472757374546f6b656e3a74727573742d70726576696f75736c792d69737375604482015261195960f21b606482015260840161071c565b336000818152600960205260409020805460ff191660011790556008546107b79190611368565b565b6107c33382611453565b50565b60608160008167ffffffffffffffff8111156107e4576107e4612f24565b60405190808252806020026020018201604052801561080d578160200160208202803683370190505b506001600160a01b0387166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b900490931691830191909152929350905b848110156108d5576108a683600101838a8a8581811061088b5761088b612ebe565b90506020020160208101906108a09190612a86565b42611215565b8482815181106108b8576108b8612ebe565b6020908102919091010152806108cd81612f3a565b915050610869565b5091979650505050505050565b6001600160a01b0385166000908152600a6020526040902060609061090a9086868686611510565b9695505050505050565b6001600160a01b03811660009081526005602052604081205461054e565b60608160008167ffffffffffffffff81111561095057610950612f24565b604051908082528060200260200182016040528015610979578160200160208202803683370190505b5060408051606081018252600b546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915290915060005b83811015610a0a576109db600c8389898581811061088b5761088b612ebe565b8382815181106109ed576109ed612ebe565b602090810291909101015280610a0281612f3a565b9150506109bb565b509095945050505050565b6060610a25600b86868686611510565b90505b949350505050565b83421115610a805760405162461bcd60e51b815260206004820181905260248201527f5469636b65742f64656c65676174652d657870697265642d646561646c696e65604482015260640161071c565b60007f00000000000000000000000000000000000000000000000000000000000000008787610aae8a611695565b6040805160208101959095526001600160a01b039384169085015291166060830152608082015260a0810186905260c0016040516020818303038152906040528051906020012090506000610b02826116bd565b90506000610b128287878761170b565b9050886001600160a01b0316816001600160a01b031614610b7f5760405162461bcd60e51b815260206004820152602160248201527f5469636b65742f64656c65676174652d696e76616c69642d7369676e617475726044820152606560f81b606482015260840161071c565b610b898989611453565b505050505050505050565b6060600480546104b790612e8a565b6001600160a01b0383166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b90049093169183019190915290610c0b906001830190868642611733565b95945050505050565b6001600160a01b0382166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b90049093169183019190915290610a289060018301908542611215565b60003381610c898286610e73565b905083811015610ce95760405162461bcd60e51b815260206004820152602560248201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604482015264207a65726f60d81b606482015260840161071c565b610cf68286868403610e9e565b506001949350505050565b60003361054881858561103c565b83421115610d5f5760405162461bcd60e51b815260206004820152601d60248201527f45524332305065726d69743a206578706972656420646561646c696e65000000604482015260640161071c565b60007f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9888888610d8e8c611695565b6040805160208101969096526001600160a01b0394851690860152929091166060840152608083015260a082015260c0810186905260e0016040516020818303038152906040528051906020012090506000610de9826116bd565b90506000610df98287878761170b565b9050896001600160a01b0316816001600160a01b031614610e5c5760405162461bcd60e51b815260206004820152601e60248201527f45524332305065726d69743a20696e76616c6964207369676e61747572650000604482015260640161071c565b610e678a8a8a610e9e565b50505050505050505050565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b6001600160a01b038316610f005760405162461bcd60e51b8152602060048201526024808201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646044820152637265737360e01b606482015260840161071c565b6001600160a01b038216610f615760405162461bcd60e51b815260206004820152602260248201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604482015261737360f01b606482015260840161071c565b6001600160a01b0383811660008181526001602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050565b6000610fce8484610e73565b9050600019811461103657818110156110295760405162461bcd60e51b815260206004820152601d60248201527f45524332303a20696e73756666696369656e7420616c6c6f77616e6365000000604482015260640161071c565b6110368484848403610e9e565b50505050565b6001600160a01b0383166110a05760405162461bcd60e51b815260206004820152602560248201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604482015264647265737360d81b606482015260840161071c565b6001600160a01b0382166111025760405162461bcd60e51b815260206004820152602360248201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260448201526265737360e81b606482015260840161071c565b61110d83838361176b565b6001600160a01b038316600090815260208190526040902054818110156111855760405162461bcd60e51b815260206004820152602660248201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604482015265616c616e636560d01b606482015260840161071c565b6001600160a01b038085166000908152602081905260408082208585039055918516815290812080548492906111bc908490612eea565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161120891815260200190565b60405180910390a3611036565b6000808263ffffffff168463ffffffff16116112315783611233565b825b905061090a86868386611802565b6000306001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614801561129a57507f000000000000000000000000000000000000000000000000000000000000000046145b156112c457507f000000000000000000000000000000000000000000000000000000000000000090565b50604080517f00000000000000000000000000000000000000000000000000000000000000006020808301919091527f0000000000000000000000000000000000000000000000000000000000000000828401527f000000000000000000000000000000000000000000000000000000000000000060608301524660808301523060a0808401919091528351808403909101815260c0909201909252805191012090565b6001600160a01b0382166113be5760405162461bcd60e51b815260206004820152601f60248201527f45524332303a206d696e7420746f20746865207a65726f206164647265737300604482015260640161071c565b6113ca6000838361176b565b80600260008282546113dc9190612eea565b90915550506001600160a01b03821660009081526020819052604081208054839290611409908490612eea565b90915550506040518181526001600160a01b038316906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a35050565b6001600160a01b0382811660009081526020818152604080832054630100000b909252909120549091908116908316810361148e5750505050565b6001600160a01b038481166000908152630100000b6020526040902080546001600160a01b0319169185169190911790556114ca81848461191f565b826001600160a01b0316846001600160a01b03167f4bc154dd35d6a5cb9206482ecb473cdbf2473006d6bce728b9cc0741bcc59ea260405160405180910390a350505050565b60608382811461156e5760405162461bcd60e51b815260206004820152602360248201527f5469636b65742f73746172742d656e642d74696d65732d6c656e6774682d6d616044820152620e8c6d60eb1b606482015260840161071c565b6040805160608101825288546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260008267ffffffffffffffff8111156115c3576115c3612f24565b6040519080825280602002602001820160405280156115ec578160200160208202803683370190505b5090504260005b84811015611686576116578b600101858c8c8581811061161557611615612ebe565b905060200201602081019061162a9190612a86565b8b8b8681811061163c5761163c612ebe565b90506020020160208101906116519190612a86565b86611733565b83828151811061166957611669612ebe565b60209081029190910101528061167e81612f3a565b9150506115f3565b50909998505050505050505050565b6001600160a01b03811660009081526005602052604090208054600181018255905b50919050565b600061054e6116ca611241565b8360405161190160f01b6020820152602281018390526042810182905260009060620160405160208183030381529060405280519060200120905092915050565b600080600061171c8787878761197f565b9150915061172981611a6c565b5095945050505050565b6000808263ffffffff168463ffffffff161161174f5783611751565b825b90506117608787878487611c22565b979650505050505050565b816001600160a01b0316836001600160a01b03160361178957505050565b60006001600160a01b038416156117ba57506001600160a01b038084166000908152630100000b6020526040902054165b60006001600160a01b038416156117eb57506001600160a01b038084166000908152630100000b6020526040902054165b6117f682828561191f565b5050505050565b505050565b60008061181f604080518082019091526000808252602082015290565b604080518082019091526000808252602082015261183d8888611cbe565b6020810151919450915061185e9063ffffffff9081169088908890611d4316565b1561187957505084516001600160d01b03169150610a289050565b60006118858989611e14565b60208101519093509091506118a69063ffffffff808a1691908990611e9916565b156118b8576000945050505050610a28565b6118ca8985838a8c604001518b611f68565b80945081935050506118e58360200151836020015188612139565b63ffffffff16826000015184600001516118ff9190612f53565b6119099190612f91565b6001600160e01b03169998505050505050505050565b6001600160a01b0383161561194f576119388382612203565b6001600160a01b03821661194f5761194f81612317565b6001600160a01b038216156117fd5761196882826123f0565b6001600160a01b0383166117fd576117fd8161242a565b6000807f7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a08311156119b65750600090506003611a63565b8460ff16601b141580156119ce57508460ff16601c14155b156119df5750600090506004611a63565b6040805160008082526020820180845289905260ff881692820192909252606081018690526080810185905260019060a0016020604051602081039080840390855afa158015611a33573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116611a5c57600060019250925050611a63565b9150600090505b94509492505050565b6000816004811115611a8057611a80612fb7565b03611a885750565b6001816004811115611a9c57611a9c612fb7565b03611ae95760405162461bcd60e51b815260206004820152601860248201527f45434453413a20696e76616c6964207369676e61747572650000000000000000604482015260640161071c565b6002816004811115611afd57611afd612fb7565b03611b4a5760405162461bcd60e51b815260206004820152601f60248201527f45434453413a20696e76616c6964207369676e6174757265206c656e67746800604482015260640161071c565b6003816004811115611b5e57611b5e612fb7565b03611bb65760405162461bcd60e51b815260206004820152602260248201527f45434453413a20696e76616c6964207369676e6174757265202773272076616c604482015261756560f01b606482015260840161071c565b6004816004811115611bca57611bca612fb7565b036107c35760405162461bcd60e51b815260206004820152602260248201527f45434453413a20696e76616c6964207369676e6174757265202776272076616c604482015261756560f01b606482015260840161071c565b6000806000611c318888611e14565b91509150600080611c428a8a611cbe565b915091506000611c588b8b8487878a8f8e612448565b90506000611c6c8c8c8588888b8f8f612448565b9050611c81816020015183602001518a612139565b63ffffffff1682600001518260000151611c9b9190612f53565b611ca59190612f91565b6001600160e01b03169c9b505050505050505050505050565b6000611cda604080518082019091526000808252602082015290565b611cf2836020015162ffffff1662ffffff8016612590565b9150838262ffffff1662ffffff8110611d0d57611d0d612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff166020820152919491935090915050565b60008163ffffffff168463ffffffff1611158015611d6d57508163ffffffff168363ffffffff1611155b15611d89578263ffffffff168463ffffffff1611159050610573565b60008263ffffffff168563ffffffff1611611db857611db363ffffffff8616640100000000612fcd565b611dc0565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff1611611df857611df363ffffffff8616640100000000612fcd565b611e00565b8463ffffffff165b64ffffffffff169091111595945050505050565b6000611e30604080518082019091526000808252602082015290565b82602001519150838262ffffff1662ffffff8110611e5057611e50612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201819052909150600003611e9257600091508382611d0d565b9250929050565b60008163ffffffff168463ffffffff1611158015611ec357508163ffffffff168363ffffffff1611155b15611ede578263ffffffff168463ffffffff16109050610573565b60008263ffffffff168563ffffffff1611611f0d57611f0863ffffffff8616640100000000612fcd565b611f15565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff1611611f4d57611f4863ffffffff8616640100000000612fcd565b611f55565b8463ffffffff165b64ffffffffff1690911095945050505050565b6040805180820190915260008082526020820152604080518082019091526000808252602082015260008662ffffff1690506000818962ffffff1610611fb3578862ffffff16611fce565b6001611fc462ffffff881684612eea565b611fce9190612ff6565b905060005b6002611fdf8385612eea565b611fe9919061300d565b90508a611ffb828962ffffff166125bd565b62ffffff1662ffffff811061201257612012612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201819052909550600081900361205e57612056826001612eea565b935050611fd3565b8b61206e838a62ffffff166125c9565b62ffffff1662ffffff811061208557612085612ebe565b604080518082019091529101546001600160e01b038116825263ffffffff600160e01b909104811660208301529095506000906120ca90838116908c908b90611d4316565b90508080156120f357506120f38660200151898c63ffffffff16611d439092919063ffffffff16565b156120ff57505061212b565b806121165761210f600184612ff6565b9350612124565b612121836001612eea565b94505b5050611fd3565b505050965096945050505050565b60008163ffffffff168463ffffffff161115801561216357508163ffffffff168363ffffffff1611155b15612179576121728385613021565b9050610573565b60008263ffffffff168563ffffffff16116121a8576121a363ffffffff8616640100000000612fcd565b6121b0565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff16116121e8576121e363ffffffff8616640100000000612fcd565b6121f0565b8463ffffffff165b64ffffffffff16905061090a8183612ff6565b8060000361220f575050565b6001600160a01b0382166000908152600a6020526040812090808061227384612237876125d9565b6040518060400160405280601b81526020017f5469636b65742f747761622d6275726e2d6c742d62616c616e6365000000000081525042612646565b82518754602085015160408601516001600160d01b039093166001600160e81b031990921691909117600160d01b62ffffff92831602176001600160e81b0316600160e81b919092160217875591945092509050801561230f57856001600160a01b03167fdd3e7cd3a260a292b0b3306b2ca62f30a7349619a9d09c58109318774c6b627d836040516123069190612adf565b60405180910390a25b505050505050565b806000036123225750565b6000806000612354600b612335866125d9565b6040518060600160405280602c81526020016130e4602c913942612646565b8251600b8054602086015160408701516001600160d01b039094166001600160e81b031990921691909117600160d01b62ffffff92831602176001600160e81b0316600160e81b9190931602919091179055919450925090508015611036577f3375b905d617084fa6b7531688cc8046feb1f1a0b8ba2273de03c59d8d84416c826040516123e29190612adf565b60405180910390a150505050565b806000036123fc575050565b6001600160a01b0382166000908152600a6020526040812090808061227384612424876125d9565b4261270a565b806000036124355750565b6000806000612354600b612424866125d9565b604080518082019091526000808252602082015261247b8383896020015163ffffffff16611e999092919063ffffffff16565b1561249f576124988789600001516001600160d01b0316856127b3565b9050612584565b8263ffffffff16876020015163ffffffff16036124bd575085612584565b8263ffffffff16866020015163ffffffff16036124db575084612584565b6124fa8660200151838563ffffffff16611e999092919063ffffffff16565b1561251f5750604080518082019091526000815263ffffffff83166020820152612584565b6000806125348b8888888e6040015189611f68565b91509150600061254d8260200151846020015187612139565b63ffffffff16836000015183600001516125679190612f53565b6125719190612f91565b905061257e8382886127b3565b93505050505b98975050505050505050565b6000816000036125a25750600061054e565b61057360016125b18486612eea565b6125bb9190612ff6565b835b6000610573828461303e565b60006105736125bb846001612eea565b60006001600160d01b038211156126425760405162461bcd60e51b815260206004820152602760248201527f53616665436173743a2076616c756520646f65736e27742066697420696e20326044820152663038206269747360c81b606482015260840161071c565b5090565b604080516060810182526000808252602082018190529181019190915260408051808201909152600080825260208201526040805160608101825287546001600160d01b0380821680845262ffffff600160d01b840481166020860152600160e81b90930490921693830193909352600092879190891611156126dc5760405162461bcd60e51b815260040161071c919061297c565b506126eb88600101828761282e565b8251999099036001600160d01b03168252909990985095505050505050565b604080516060810182526000808252602082018190529181019190915260408051808201909152600080825260208201526040805160608101825286546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260009061278660018801828761282e565b8351929650909450925061279b908790613052565b6001600160d01b031684525091959094509092509050565b604080518082019091526000808252602082015260405180604001604052806127f18660200151858663ffffffff166121399092919063ffffffff16565b6128019063ffffffff1686613074565b865161280d91906130a3565b6001600160e01b031681526020018363ffffffff1681525090509392505050565b6040805160608101825260008082526020820181905291810191909152604080518082019091526000808252602082015260008061286c8787611cbe565b9150508463ffffffff16816020015163ffffffff16036128945785935091506000905061290b565b60006128ae8288600001516001600160d01b0316886127b3565b90508088886020015162ffffff1662ffffff81106128ce576128ce612ebe565b825160209093015163ffffffff16600160e01b026001600160e01b039093169290921791015560006128ff88612914565b95509093506001925050505b93509350939050565b604080516060810182526000808252602080830182905292820152908201516129449062ffffff908116906125c9565b62ffffff90811660208401526040830151811610156126425760018260400181815161297091906130c5565b62ffffff169052505090565b600060208083528351808285015260005b818110156129a95785810183015185820160400152820161298d565b818111156129bb576000604083870101525b50601f01601f1916929092016040019392505050565b80356001600160a01b03811681146129e857600080fd5b919050565b60008060408385031215612a0057600080fd5b612a09836129d1565b946020939093013593505050565b600080600060608486031215612a2c57600080fd5b612a35846129d1565b9250612a43602085016129d1565b9150604084013590509250925092565b600060208284031215612a6557600080fd5b610573826129d1565b803567ffffffffffffffff811681146129e857600080fd5b600060208284031215612a9857600080fd5b61057382612a6e565b60008060408385031215612ab457600080fd5b612abd836129d1565b9150602083013561ffff81168114612ad457600080fd5b809150509250929050565b81516001600160e01b0316815260209182015163ffffffff169181019190915260400190565b60008083601f840112612b1757600080fd5b50813567ffffffffffffffff811115612b2f57600080fd5b6020830191508360208260051b8501011115611e9257600080fd5b600080600060408486031215612b5f57600080fd5b612b68846129d1565b9250602084013567ffffffffffffffff811115612b8457600080fd5b612b9086828701612b05565b9497909650939450505050565b6020808252825182820181905260009190848201906040850190845b81811015612bd557835183529284019291840191600101612bb9565b50909695505050505050565b600080600080600060608688031215612bf957600080fd5b612c02866129d1565b9450602086013567ffffffffffffffff80821115612c1f57600080fd5b612c2b89838a01612b05565b90965094506040880135915080821115612c4457600080fd5b50612c5188828901612b05565b969995985093965092949392505050565b60008060208385031215612c7557600080fd5b823567ffffffffffffffff811115612c8c57600080fd5b612c9885828601612b05565b90969095509350505050565b60008060008060408587031215612cba57600080fd5b843567ffffffffffffffff80821115612cd257600080fd5b612cde88838901612b05565b90965094506020870135915080821115612cf757600080fd5b50612d0487828801612b05565b95989497509550505050565b803560ff811681146129e857600080fd5b60008060008060008060c08789031215612d3a57600080fd5b612d43876129d1565b9550612d51602088016129d1565b945060408701359350612d6660608801612d10565b92506080870135915060a087013590509295509295509295565b600080600060608486031215612d9557600080fd5b612d9e846129d1565b9250612dac60208501612a6e565b9150612dba60408501612a6e565b90509250925092565b60008060408385031215612dd657600080fd5b612ddf836129d1565b9150612ded60208401612a6e565b90509250929050565b600080600080600080600060e0888a031215612e1157600080fd5b612e1a886129d1565b9650612e28602089016129d1565b95506040880135945060608801359350612e4460808901612d10565b925060a0880135915060c0880135905092959891949750929550565b60008060408385031215612e7357600080fd5b612e7c836129d1565b9150612ded602084016129d1565b600181811c90821680612e9e57607f821691505b6020821081036116b757634e487b7160e01b600052602260045260246000fd5b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b60008219821115612efd57612efd612ed4565b500190565b600060208284031215612f1457600080fd5b8151801515811461057357600080fd5b634e487b7160e01b600052604160045260246000fd5b600060018201612f4c57612f4c612ed4565b5060010190565b60006001600160e01b0383811690831681811015612f7357612f73612ed4565b039392505050565b634e487b7160e01b600052601260045260246000fd5b60006001600160e01b0383811680612fab57612fab612f7b565b92169190910492915050565b634e487b7160e01b600052602160045260246000fd5b600064ffffffffff808316818516808303821115612fed57612fed612ed4565b01949350505050565b60008282101561300857613008612ed4565b500390565b60008261301c5761301c612f7b565b500490565b600063ffffffff83811690831681811015612f7357612f73612ed4565b60008261304d5761304d612f7b565b500690565b60006001600160d01b03828116848216808303821115612fed57612fed612ed4565b60006001600160e01b038281168482168115158284048211161561309a5761309a612ed4565b02949350505050565b60006001600160e01b03828116848216808303821115612fed57612fed612ed4565b600062ffffff808316818516808303821115612fed57612fed612ed456fe5469636b65742f6275726e2d616d6f756e742d657863656564732d746f74616c2d737570706c792d74776162a264697066735822122045431772ea9aacf7d0267b5670fe37c485eac139074322f4aa6097c4dc75f73464736f6c634300080f0033000000000000000000000000825e0e24de8559831e2bdee296397ba38967ba07000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000155075626c696320476f6f64732050726f746f636f6c000000000000000000000000000000000000000000000000000000000000000000000000000000000000095047502e616c7068610000000000000000000000000000000000000000000000
Deployed Bytecode
0x608060405234801561001057600080fd5b50600436106101a95760003560e01c806368c7fd57116100f957806395d89b4111610097578063a457c2d711610071578063a457c2d71461045c578063a9059cbb1461046f578063d505accf14610482578063dd62ed3e1461049557600080fd5b806395d89b411461042e57806398b16f36146104365780639ecb03701461044957600080fd5b806385beb5f1116100d357806385beb5f1146103ae5780638d22ea2a146103c15780638e6d536a14610408578063919974dc1461041b57600080fd5b806368c7fd571461035f57806370a08231146103725780637ecebe001461039b57600080fd5b8063313ce567116101665780633950935111610140578063395093511461030f5780634e71d92d146103225780635c19a95c1461032c578063613ed6bd1461033f57600080fd5b8063313ce567146102d85780633644e515146102e757806336bb2a38146102ef57600080fd5b806306fdde03146101ae578063095ea7b3146101cc57806318160ddd146101ef57806323b872dd146102015780632aceb534146102145780632d0dd686146102c5575b600080fd5b6101b66104a8565b6040516101c3919061297c565b60405180910390f35b6101df6101da3660046129ed565b61053a565b60405190151581526020016101c3565b6002545b6040519081526020016101c3565b6101df61020f366004612a17565b610554565b61028d610222366004612a53565b6040805160608082018352600080835260208084018290529284018190526001600160a01b03949094168452600a82529282902082519384018352546001600160d01b038116845262ffffff600160d01b8204811692850192909252600160e81b9004169082015290565b6040805182516001600160d01b0316815260208084015162ffffff9081169183019190915292820151909216908201526060016101c3565b6101f36102d3366004612a86565b61057a565b604051601281526020016101c3565b6101f36105c6565b6103026102fd366004612aa1565b6105d5565b6040516101c39190612adf565b6101df61031d3660046129ed565b61064d565b61032a61066f565b005b61032a61033a366004612a53565b6107b9565b61035261034d366004612b4a565b6107c6565b6040516101c39190612b9d565b61035261036d366004612be1565b6108e2565b6101f3610380366004612a53565b6001600160a01b031660009081526020819052604090205490565b6101f36103a9366004612a53565b610914565b6103526103bc366004612c62565b610932565b6103f06103cf366004612a53565b6001600160a01b039081166000908152630100000b60205260409020541690565b6040516001600160a01b0390911681526020016101c3565b610352610416366004612ca4565b610a15565b61032a610429366004612d21565b610a30565b6101b6610b94565b6101f3610444366004612d80565b610ba3565b6101f3610457366004612dc3565b610c14565b6101df61046a3660046129ed565b610c7b565b6101df61047d3660046129ed565b610d01565b61032a610490366004612df6565b610d0f565b6101f36104a3366004612e60565b610e73565b6060600380546104b790612e8a565b80601f01602080910402602001604051908101604052809291908181526020018280546104e390612e8a565b80156105305780601f1061050557610100808354040283529160200191610530565b820191906000526020600020905b81548152906001019060200180831161051357829003601f168201915b5050505050905090565b600033610548818585610e9e565b60019150505b92915050565b600033610562858285610fc2565b61056d85858561103c565b60019150505b9392505050565b60408051606081018252600b546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260009061054e90600c908442611215565b60006105d0611241565b905090565b60408051808201909152600080825260208201526001600160a01b0383166000908152600a6020526040902060010161ffff831662ffffff811061061b5761061b612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201529392505050565b6000336105488185856106608383610e73565b61066a9190612eea565b610e9e565b60075460405163f3caad0360e01b81523360048201526001600160a01b039091169063f3caad0390602401602060405180830381865afa1580156106b7573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106db9190612f02565b6107255760405162461bcd60e51b8152602060048201526016602482015275151c9d5cdd151bdad95b8e9b9bdd0b5d1c9d5cdd195960521b60448201526064015b60405180910390fd5b3360009081526009602052604090205460ff16156107905760405162461bcd60e51b815260206004820152602260248201527f5472757374546f6b656e3a74727573742d70726576696f75736c792d69737375604482015261195960f21b606482015260840161071c565b336000818152600960205260409020805460ff191660011790556008546107b79190611368565b565b6107c33382611453565b50565b60608160008167ffffffffffffffff8111156107e4576107e4612f24565b60405190808252806020026020018201604052801561080d578160200160208202803683370190505b506001600160a01b0387166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b900490931691830191909152929350905b848110156108d5576108a683600101838a8a8581811061088b5761088b612ebe565b90506020020160208101906108a09190612a86565b42611215565b8482815181106108b8576108b8612ebe565b6020908102919091010152806108cd81612f3a565b915050610869565b5091979650505050505050565b6001600160a01b0385166000908152600a6020526040902060609061090a9086868686611510565b9695505050505050565b6001600160a01b03811660009081526005602052604081205461054e565b60608160008167ffffffffffffffff81111561095057610950612f24565b604051908082528060200260200182016040528015610979578160200160208202803683370190505b5060408051606081018252600b546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915290915060005b83811015610a0a576109db600c8389898581811061088b5761088b612ebe565b8382815181106109ed576109ed612ebe565b602090810291909101015280610a0281612f3a565b9150506109bb565b509095945050505050565b6060610a25600b86868686611510565b90505b949350505050565b83421115610a805760405162461bcd60e51b815260206004820181905260248201527f5469636b65742f64656c65676174652d657870697265642d646561646c696e65604482015260640161071c565b60007f94019368dc6b2ee4ac32010c9d0081ec29874325b541829d001d22c296b5246c8787610aae8a611695565b6040805160208101959095526001600160a01b039384169085015291166060830152608082015260a0810186905260c0016040516020818303038152906040528051906020012090506000610b02826116bd565b90506000610b128287878761170b565b9050886001600160a01b0316816001600160a01b031614610b7f5760405162461bcd60e51b815260206004820152602160248201527f5469636b65742f64656c65676174652d696e76616c69642d7369676e617475726044820152606560f81b606482015260840161071c565b610b898989611453565b505050505050505050565b6060600480546104b790612e8a565b6001600160a01b0383166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b90049093169183019190915290610c0b906001830190868642611733565b95945050505050565b6001600160a01b0382166000908152600a60209081526040808320815160608101835281546001600160d01b038116825262ffffff600160d01b8204811695830195909552600160e81b90049093169183019190915290610a289060018301908542611215565b60003381610c898286610e73565b905083811015610ce95760405162461bcd60e51b815260206004820152602560248201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604482015264207a65726f60d81b606482015260840161071c565b610cf68286868403610e9e565b506001949350505050565b60003361054881858561103c565b83421115610d5f5760405162461bcd60e51b815260206004820152601d60248201527f45524332305065726d69743a206578706972656420646561646c696e65000000604482015260640161071c565b60007f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9888888610d8e8c611695565b6040805160208101969096526001600160a01b0394851690860152929091166060840152608083015260a082015260c0810186905260e0016040516020818303038152906040528051906020012090506000610de9826116bd565b90506000610df98287878761170b565b9050896001600160a01b0316816001600160a01b031614610e5c5760405162461bcd60e51b815260206004820152601e60248201527f45524332305065726d69743a20696e76616c6964207369676e61747572650000604482015260640161071c565b610e678a8a8a610e9e565b50505050505050505050565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b6001600160a01b038316610f005760405162461bcd60e51b8152602060048201526024808201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646044820152637265737360e01b606482015260840161071c565b6001600160a01b038216610f615760405162461bcd60e51b815260206004820152602260248201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604482015261737360f01b606482015260840161071c565b6001600160a01b0383811660008181526001602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050565b6000610fce8484610e73565b9050600019811461103657818110156110295760405162461bcd60e51b815260206004820152601d60248201527f45524332303a20696e73756666696369656e7420616c6c6f77616e6365000000604482015260640161071c565b6110368484848403610e9e565b50505050565b6001600160a01b0383166110a05760405162461bcd60e51b815260206004820152602560248201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604482015264647265737360d81b606482015260840161071c565b6001600160a01b0382166111025760405162461bcd60e51b815260206004820152602360248201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260448201526265737360e81b606482015260840161071c565b61110d83838361176b565b6001600160a01b038316600090815260208190526040902054818110156111855760405162461bcd60e51b815260206004820152602660248201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604482015265616c616e636560d01b606482015260840161071c565b6001600160a01b038085166000908152602081905260408082208585039055918516815290812080548492906111bc908490612eea565b92505081905550826001600160a01b0316846001600160a01b03167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef8460405161120891815260200190565b60405180910390a3611036565b6000808263ffffffff168463ffffffff16116112315783611233565b825b905061090a86868386611802565b6000306001600160a01b037f0000000000000000000000004f9ce37b836812ca2e6772b2c42d2e1fbbaf6cf11614801561129a57507f000000000000000000000000000000000000000000000000000000000000000146145b156112c457507f0b4a635ed810e2e48d19e5bc6769cefd3d812bda4d5877d6303beed1dc9a2a9790565b50604080517f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f6020808301919091527ff18b6120926ff2d9ddfa72cddb303aec08994be72efa2b8a7ed45d44a591ddae828401527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc660608301524660808301523060a0808401919091528351808403909101815260c0909201909252805191012090565b6001600160a01b0382166113be5760405162461bcd60e51b815260206004820152601f60248201527f45524332303a206d696e7420746f20746865207a65726f206164647265737300604482015260640161071c565b6113ca6000838361176b565b80600260008282546113dc9190612eea565b90915550506001600160a01b03821660009081526020819052604081208054839290611409908490612eea565b90915550506040518181526001600160a01b038316906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a35050565b6001600160a01b0382811660009081526020818152604080832054630100000b909252909120549091908116908316810361148e5750505050565b6001600160a01b038481166000908152630100000b6020526040902080546001600160a01b0319169185169190911790556114ca81848461191f565b826001600160a01b0316846001600160a01b03167f4bc154dd35d6a5cb9206482ecb473cdbf2473006d6bce728b9cc0741bcc59ea260405160405180910390a350505050565b60608382811461156e5760405162461bcd60e51b815260206004820152602360248201527f5469636b65742f73746172742d656e642d74696d65732d6c656e6774682d6d616044820152620e8c6d60eb1b606482015260840161071c565b6040805160608101825288546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260008267ffffffffffffffff8111156115c3576115c3612f24565b6040519080825280602002602001820160405280156115ec578160200160208202803683370190505b5090504260005b84811015611686576116578b600101858c8c8581811061161557611615612ebe565b905060200201602081019061162a9190612a86565b8b8b8681811061163c5761163c612ebe565b90506020020160208101906116519190612a86565b86611733565b83828151811061166957611669612ebe565b60209081029190910101528061167e81612f3a565b9150506115f3565b50909998505050505050505050565b6001600160a01b03811660009081526005602052604090208054600181018255905b50919050565b600061054e6116ca611241565b8360405161190160f01b6020820152602281018390526042810182905260009060620160405160208183030381529060405280519060200120905092915050565b600080600061171c8787878761197f565b9150915061172981611a6c565b5095945050505050565b6000808263ffffffff168463ffffffff161161174f5783611751565b825b90506117608787878487611c22565b979650505050505050565b816001600160a01b0316836001600160a01b03160361178957505050565b60006001600160a01b038416156117ba57506001600160a01b038084166000908152630100000b6020526040902054165b60006001600160a01b038416156117eb57506001600160a01b038084166000908152630100000b6020526040902054165b6117f682828561191f565b5050505050565b505050565b60008061181f604080518082019091526000808252602082015290565b604080518082019091526000808252602082015261183d8888611cbe565b6020810151919450915061185e9063ffffffff9081169088908890611d4316565b1561187957505084516001600160d01b03169150610a289050565b60006118858989611e14565b60208101519093509091506118a69063ffffffff808a1691908990611e9916565b156118b8576000945050505050610a28565b6118ca8985838a8c604001518b611f68565b80945081935050506118e58360200151836020015188612139565b63ffffffff16826000015184600001516118ff9190612f53565b6119099190612f91565b6001600160e01b03169998505050505050505050565b6001600160a01b0383161561194f576119388382612203565b6001600160a01b03821661194f5761194f81612317565b6001600160a01b038216156117fd5761196882826123f0565b6001600160a01b0383166117fd576117fd8161242a565b6000807f7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46681b20a08311156119b65750600090506003611a63565b8460ff16601b141580156119ce57508460ff16601c14155b156119df5750600090506004611a63565b6040805160008082526020820180845289905260ff881692820192909252606081018690526080810185905260019060a0016020604051602081039080840390855afa158015611a33573d6000803e3d6000fd5b5050604051601f1901519150506001600160a01b038116611a5c57600060019250925050611a63565b9150600090505b94509492505050565b6000816004811115611a8057611a80612fb7565b03611a885750565b6001816004811115611a9c57611a9c612fb7565b03611ae95760405162461bcd60e51b815260206004820152601860248201527f45434453413a20696e76616c6964207369676e61747572650000000000000000604482015260640161071c565b6002816004811115611afd57611afd612fb7565b03611b4a5760405162461bcd60e51b815260206004820152601f60248201527f45434453413a20696e76616c6964207369676e6174757265206c656e67746800604482015260640161071c565b6003816004811115611b5e57611b5e612fb7565b03611bb65760405162461bcd60e51b815260206004820152602260248201527f45434453413a20696e76616c6964207369676e6174757265202773272076616c604482015261756560f01b606482015260840161071c565b6004816004811115611bca57611bca612fb7565b036107c35760405162461bcd60e51b815260206004820152602260248201527f45434453413a20696e76616c6964207369676e6174757265202776272076616c604482015261756560f01b606482015260840161071c565b6000806000611c318888611e14565b91509150600080611c428a8a611cbe565b915091506000611c588b8b8487878a8f8e612448565b90506000611c6c8c8c8588888b8f8f612448565b9050611c81816020015183602001518a612139565b63ffffffff1682600001518260000151611c9b9190612f53565b611ca59190612f91565b6001600160e01b03169c9b505050505050505050505050565b6000611cda604080518082019091526000808252602082015290565b611cf2836020015162ffffff1662ffffff8016612590565b9150838262ffffff1662ffffff8110611d0d57611d0d612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff166020820152919491935090915050565b60008163ffffffff168463ffffffff1611158015611d6d57508163ffffffff168363ffffffff1611155b15611d89578263ffffffff168463ffffffff1611159050610573565b60008263ffffffff168563ffffffff1611611db857611db363ffffffff8616640100000000612fcd565b611dc0565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff1611611df857611df363ffffffff8616640100000000612fcd565b611e00565b8463ffffffff165b64ffffffffff169091111595945050505050565b6000611e30604080518082019091526000808252602082015290565b82602001519150838262ffffff1662ffffff8110611e5057611e50612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201819052909150600003611e9257600091508382611d0d565b9250929050565b60008163ffffffff168463ffffffff1611158015611ec357508163ffffffff168363ffffffff1611155b15611ede578263ffffffff168463ffffffff16109050610573565b60008263ffffffff168563ffffffff1611611f0d57611f0863ffffffff8616640100000000612fcd565b611f15565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff1611611f4d57611f4863ffffffff8616640100000000612fcd565b611f55565b8463ffffffff165b64ffffffffff1690911095945050505050565b6040805180820190915260008082526020820152604080518082019091526000808252602082015260008662ffffff1690506000818962ffffff1610611fb3578862ffffff16611fce565b6001611fc462ffffff881684612eea565b611fce9190612ff6565b905060005b6002611fdf8385612eea565b611fe9919061300d565b90508a611ffb828962ffffff166125bd565b62ffffff1662ffffff811061201257612012612ebe565b604080518082019091529101546001600160e01b0381168252600160e01b900463ffffffff1660208201819052909550600081900361205e57612056826001612eea565b935050611fd3565b8b61206e838a62ffffff166125c9565b62ffffff1662ffffff811061208557612085612ebe565b604080518082019091529101546001600160e01b038116825263ffffffff600160e01b909104811660208301529095506000906120ca90838116908c908b90611d4316565b90508080156120f357506120f38660200151898c63ffffffff16611d439092919063ffffffff16565b156120ff57505061212b565b806121165761210f600184612ff6565b9350612124565b612121836001612eea565b94505b5050611fd3565b505050965096945050505050565b60008163ffffffff168463ffffffff161115801561216357508163ffffffff168363ffffffff1611155b15612179576121728385613021565b9050610573565b60008263ffffffff168563ffffffff16116121a8576121a363ffffffff8616640100000000612fcd565b6121b0565b8463ffffffff165b64ffffffffff16905060008363ffffffff168563ffffffff16116121e8576121e363ffffffff8616640100000000612fcd565b6121f0565b8463ffffffff165b64ffffffffff16905061090a8183612ff6565b8060000361220f575050565b6001600160a01b0382166000908152600a6020526040812090808061227384612237876125d9565b6040518060400160405280601b81526020017f5469636b65742f747761622d6275726e2d6c742d62616c616e6365000000000081525042612646565b82518754602085015160408601516001600160d01b039093166001600160e81b031990921691909117600160d01b62ffffff92831602176001600160e81b0316600160e81b919092160217875591945092509050801561230f57856001600160a01b03167fdd3e7cd3a260a292b0b3306b2ca62f30a7349619a9d09c58109318774c6b627d836040516123069190612adf565b60405180910390a25b505050505050565b806000036123225750565b6000806000612354600b612335866125d9565b6040518060600160405280602c81526020016130e4602c913942612646565b8251600b8054602086015160408701516001600160d01b039094166001600160e81b031990921691909117600160d01b62ffffff92831602176001600160e81b0316600160e81b9190931602919091179055919450925090508015611036577f3375b905d617084fa6b7531688cc8046feb1f1a0b8ba2273de03c59d8d84416c826040516123e29190612adf565b60405180910390a150505050565b806000036123fc575050565b6001600160a01b0382166000908152600a6020526040812090808061227384612424876125d9565b4261270a565b806000036124355750565b6000806000612354600b612424866125d9565b604080518082019091526000808252602082015261247b8383896020015163ffffffff16611e999092919063ffffffff16565b1561249f576124988789600001516001600160d01b0316856127b3565b9050612584565b8263ffffffff16876020015163ffffffff16036124bd575085612584565b8263ffffffff16866020015163ffffffff16036124db575084612584565b6124fa8660200151838563ffffffff16611e999092919063ffffffff16565b1561251f5750604080518082019091526000815263ffffffff83166020820152612584565b6000806125348b8888888e6040015189611f68565b91509150600061254d8260200151846020015187612139565b63ffffffff16836000015183600001516125679190612f53565b6125719190612f91565b905061257e8382886127b3565b93505050505b98975050505050505050565b6000816000036125a25750600061054e565b61057360016125b18486612eea565b6125bb9190612ff6565b835b6000610573828461303e565b60006105736125bb846001612eea565b60006001600160d01b038211156126425760405162461bcd60e51b815260206004820152602760248201527f53616665436173743a2076616c756520646f65736e27742066697420696e20326044820152663038206269747360c81b606482015260840161071c565b5090565b604080516060810182526000808252602082018190529181019190915260408051808201909152600080825260208201526040805160608101825287546001600160d01b0380821680845262ffffff600160d01b840481166020860152600160e81b90930490921693830193909352600092879190891611156126dc5760405162461bcd60e51b815260040161071c919061297c565b506126eb88600101828761282e565b8251999099036001600160d01b03168252909990985095505050505050565b604080516060810182526000808252602082018190529181019190915260408051808201909152600080825260208201526040805160608101825286546001600160d01b038116825262ffffff600160d01b820481166020840152600160e81b909104169181019190915260009061278660018801828761282e565b8351929650909450925061279b908790613052565b6001600160d01b031684525091959094509092509050565b604080518082019091526000808252602082015260405180604001604052806127f18660200151858663ffffffff166121399092919063ffffffff16565b6128019063ffffffff1686613074565b865161280d91906130a3565b6001600160e01b031681526020018363ffffffff1681525090509392505050565b6040805160608101825260008082526020820181905291810191909152604080518082019091526000808252602082015260008061286c8787611cbe565b9150508463ffffffff16816020015163ffffffff16036128945785935091506000905061290b565b60006128ae8288600001516001600160d01b0316886127b3565b90508088886020015162ffffff1662ffffff81106128ce576128ce612ebe565b825160209093015163ffffffff16600160e01b026001600160e01b039093169290921791015560006128ff88612914565b95509093506001925050505b93509350939050565b604080516060810182526000808252602080830182905292820152908201516129449062ffffff908116906125c9565b62ffffff90811660208401526040830151811610156126425760018260400181815161297091906130c5565b62ffffff169052505090565b600060208083528351808285015260005b818110156129a95785810183015185820160400152820161298d565b818111156129bb576000604083870101525b50601f01601f1916929092016040019392505050565b80356001600160a01b03811681146129e857600080fd5b919050565b60008060408385031215612a0057600080fd5b612a09836129d1565b946020939093013593505050565b600080600060608486031215612a2c57600080fd5b612a35846129d1565b9250612a43602085016129d1565b9150604084013590509250925092565b600060208284031215612a6557600080fd5b610573826129d1565b803567ffffffffffffffff811681146129e857600080fd5b600060208284031215612a9857600080fd5b61057382612a6e565b60008060408385031215612ab457600080fd5b612abd836129d1565b9150602083013561ffff81168114612ad457600080fd5b809150509250929050565b81516001600160e01b0316815260209182015163ffffffff169181019190915260400190565b60008083601f840112612b1757600080fd5b50813567ffffffffffffffff811115612b2f57600080fd5b6020830191508360208260051b8501011115611e9257600080fd5b600080600060408486031215612b5f57600080fd5b612b68846129d1565b9250602084013567ffffffffffffffff811115612b8457600080fd5b612b9086828701612b05565b9497909650939450505050565b6020808252825182820181905260009190848201906040850190845b81811015612bd557835183529284019291840191600101612bb9565b50909695505050505050565b600080600080600060608688031215612bf957600080fd5b612c02866129d1565b9450602086013567ffffffffffffffff80821115612c1f57600080fd5b612c2b89838a01612b05565b90965094506040880135915080821115612c4457600080fd5b50612c5188828901612b05565b969995985093965092949392505050565b60008060208385031215612c7557600080fd5b823567ffffffffffffffff811115612c8c57600080fd5b612c9885828601612b05565b90969095509350505050565b60008060008060408587031215612cba57600080fd5b843567ffffffffffffffff80821115612cd257600080fd5b612cde88838901612b05565b90965094506020870135915080821115612cf757600080fd5b50612d0487828801612b05565b95989497509550505050565b803560ff811681146129e857600080fd5b60008060008060008060c08789031215612d3a57600080fd5b612d43876129d1565b9550612d51602088016129d1565b945060408701359350612d6660608801612d10565b92506080870135915060a087013590509295509295509295565b600080600060608486031215612d9557600080fd5b612d9e846129d1565b9250612dac60208501612a6e565b9150612dba60408501612a6e565b90509250925092565b60008060408385031215612dd657600080fd5b612ddf836129d1565b9150612ded60208401612a6e565b90509250929050565b600080600080600080600060e0888a031215612e1157600080fd5b612e1a886129d1565b9650612e28602089016129d1565b95506040880135945060608801359350612e4460808901612d10565b925060a0880135915060c0880135905092959891949750929550565b60008060408385031215612e7357600080fd5b612e7c836129d1565b9150612ded602084016129d1565b600181811c90821680612e9e57607f821691505b6020821081036116b757634e487b7160e01b600052602260045260246000fd5b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b60008219821115612efd57612efd612ed4565b500190565b600060208284031215612f1457600080fd5b8151801515811461057357600080fd5b634e487b7160e01b600052604160045260246000fd5b600060018201612f4c57612f4c612ed4565b5060010190565b60006001600160e01b0383811690831681811015612f7357612f73612ed4565b039392505050565b634e487b7160e01b600052601260045260246000fd5b60006001600160e01b0383811680612fab57612fab612f7b565b92169190910492915050565b634e487b7160e01b600052602160045260246000fd5b600064ffffffffff808316818516808303821115612fed57612fed612ed4565b01949350505050565b60008282101561300857613008612ed4565b500390565b60008261301c5761301c612f7b565b500490565b600063ffffffff83811690831681811015612f7357612f73612ed4565b60008261304d5761304d612f7b565b500690565b60006001600160d01b03828116848216808303821115612fed57612fed612ed4565b60006001600160e01b038281168482168115158284048211161561309a5761309a612ed4565b02949350505050565b60006001600160e01b03828116848216808303821115612fed57612fed612ed4565b600062ffffff808316818516808303821115612fed57612fed612ed456fe5469636b65742f6275726e2d616d6f756e742d657863656564732d746f74616c2d737570706c792d74776162a264697066735822122045431772ea9aacf7d0267b5670fe37c485eac139074322f4aa6097c4dc75f73464736f6c634300080f0033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000825e0e24de8559831e2bdee296397ba38967ba07000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000155075626c696320476f6f64732050726f746f636f6c000000000000000000000000000000000000000000000000000000000000000000000000000000000000095047502e616c7068610000000000000000000000000000000000000000000000
-----Decoded View---------------
Arg [0] : citizenAlpha_ (address): 0x825E0e24de8559831E2BDEe296397bA38967bA07
Arg [1] : name (string): Public Goods Protocol
Arg [2] : symbol (string): PGP.alpha
-----Encoded View---------------
7 Constructor Arguments found :
Arg [0] : 000000000000000000000000825e0e24de8559831e2bdee296397ba38967ba07
Arg [1] : 0000000000000000000000000000000000000000000000000000000000000060
Arg [2] : 00000000000000000000000000000000000000000000000000000000000000a0
Arg [3] : 0000000000000000000000000000000000000000000000000000000000000015
Arg [4] : 5075626c696320476f6f64732050726f746f636f6c0000000000000000000000
Arg [5] : 0000000000000000000000000000000000000000000000000000000000000009
Arg [6] : 5047502e616c7068610000000000000000000000000000000000000000000000
Loading...
Loading
Loading...
Loading
[ Download: CSV Export ]
[ Download: CSV Export ]
A token is a representation of an on-chain or off-chain asset. The token page shows information such as price, total supply, holders, transfers and social links. Learn more about this page in our Knowledge Base.