Created
February 12, 2021 08:21
-
-
Save justinbarry/d0a97a90f2e00770c8ad4669ac23ea7b to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
*Submitted for verification at Etherscan.io on 2020-09-14 | |
*/ | |
// File: @openzeppelin/contracts/GSN/Context.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.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 GSN 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 payable) { | |
return msg.sender; | |
} | |
function _msgData() internal view virtual returns (bytes memory) { | |
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691 | |
return msg.data; | |
} | |
} | |
// File: @openzeppelin/contracts/token/ERC20/IERC20.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* @dev Interface of the ERC20 standard as defined in the EIP. | |
*/ | |
interface IERC20 { | |
/** | |
* @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 `recipient`. | |
* | |
* Returns a boolean value indicating whether the operation succeeded. | |
* | |
* Emits a {Transfer} event. | |
*/ | |
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool); | |
/** | |
* @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); | |
} | |
// File: @openzeppelin/contracts/math/SafeMath.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* @dev Wrappers over Solidity's arithmetic operations with added overflow | |
* checks. | |
* | |
* Arithmetic operations in Solidity wrap on overflow. This can easily result | |
* in bugs, because programmers usually assume that an overflow raises an | |
* error, which is the standard behavior in high level programming languages. | |
* `SafeMath` restores this intuition by reverting the transaction when 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. | |
*/ | |
library SafeMath { | |
/** | |
* @dev Returns the addition of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `+` operator. | |
* | |
* Requirements: | |
* | |
* - Addition cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b) internal pure returns (uint256) { | |
uint256 c = a + b; | |
require(c >= a, "SafeMath: addition overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b) internal pure returns (uint256) { | |
return sub(a, b, "SafeMath: subtraction overflow"); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b <= a, errorMessage); | |
uint256 c = a - b; | |
return c; | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `*` operator. | |
* | |
* Requirements: | |
* | |
* - Multiplication cannot overflow. | |
*/ | |
function mul(uint256 a, uint256 b) internal pure returns (uint256) { | |
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the | |
// benefit is lost if 'b' is also tested. | |
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 | |
if (a == 0) { | |
return 0; | |
} | |
uint256 c = a * b; | |
require(c / a == b, "SafeMath: multiplication overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b) internal pure returns (uint256) { | |
return div(a, b, "SafeMath: division by zero"); | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b > 0, errorMessage); | |
uint256 c = a / b; | |
// assert(a == b * c + a % b); // There is no case in which this doesn't hold | |
return c; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b) internal pure returns (uint256) { | |
return mod(a, b, "SafeMath: modulo by zero"); | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts with custom message when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b != 0, errorMessage); | |
return a % b; | |
} | |
} | |
// File: @openzeppelin/contracts/utils/Address.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.2; | |
/** | |
* @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 | |
* ==== | |
*/ | |
function isContract(address account) internal view returns (bool) { | |
// According to EIP-1052, 0x0 is the value returned for not-yet created accounts | |
// and 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470 is returned | |
// for accounts without code, i.e. `keccak256('')` | |
bytes32 codehash; | |
bytes32 accountHash = 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470; | |
// solhint-disable-next-line no-inline-assembly | |
assembly { codehash := extcodehash(account) } | |
return (codehash != accountHash && codehash != 0x0); | |
} | |
/** | |
* @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"); | |
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value | |
(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"); | |
return _functionCallWithValue(target, data, value, errorMessage); | |
} | |
function _functionCallWithValue(address target, bytes memory data, uint256 weiValue, string memory errorMessage) private returns (bytes memory) { | |
require(isContract(target), "Address: call to non-contract"); | |
// solhint-disable-next-line avoid-low-level-calls | |
(bool success, bytes memory returndata) = target.call{ value: weiValue }(data); | |
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 | |
// solhint-disable-next-line no-inline-assembly | |
assembly { | |
let returndata_size := mload(returndata) | |
revert(add(32, returndata), returndata_size) | |
} | |
} else { | |
revert(errorMessage); | |
} | |
} | |
} | |
} | |
// File: @openzeppelin/contracts/token/ERC20/ERC20.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* @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 guidelines: functions revert instead | |
* of 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 { | |
using SafeMath for uint256; | |
using Address for address; | |
mapping (address => uint256) private _balances; | |
mapping (address => mapping (address => uint256)) private _allowances; | |
uint256 private _totalSupply; | |
string private _name; | |
string private _symbol; | |
uint8 private _decimals; | |
/** | |
* @dev Sets the values for {name} and {symbol}, initializes {decimals} with | |
* a default value of 18. | |
* | |
* To select a different value for {decimals}, use {_setupDecimals}. | |
* | |
* All three of these values are immutable: they can only be set once during | |
* construction. | |
*/ | |
constructor (string memory name, string memory symbol) public { | |
_name = name; | |
_symbol = symbol; | |
_decimals = 18; | |
} | |
/** | |
* @dev Returns the name of the token. | |
*/ | |
function name() public view returns (string memory) { | |
return _name; | |
} | |
/** | |
* @dev Returns the symbol of the token, usually a shorter version of the | |
* name. | |
*/ | |
function symbol() public view 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 {_setupDecimals} is | |
* called. | |
* | |
* 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 returns (uint8) { | |
return _decimals; | |
} | |
/** | |
* @dev See {IERC20-totalSupply}. | |
*/ | |
function totalSupply() public view override returns (uint256) { | |
return _totalSupply; | |
} | |
/** | |
* @dev See {IERC20-balanceOf}. | |
*/ | |
function balanceOf(address account) public view override returns (uint256) { | |
return _balances[account]; | |
} | |
/** | |
* @dev See {IERC20-transfer}. | |
* | |
* Requirements: | |
* | |
* - `recipient` cannot be the zero address. | |
* - the caller must have a balance of at least `amount`. | |
*/ | |
function transfer(address recipient, uint256 amount) public virtual override returns (bool) { | |
_transfer(_msgSender(), recipient, 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}. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
*/ | |
function approve(address spender, uint256 amount) public virtual override returns (bool) { | |
_approve(_msgSender(), 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}; | |
* | |
* Requirements: | |
* - `sender` and `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
* - the caller must have allowance for ``sender``'s tokens of at least | |
* `amount`. | |
*/ | |
function transferFrom(address sender, address recipient, uint256 amount) public virtual override returns (bool) { | |
_transfer(sender, recipient, amount); | |
_approve(sender, _msgSender(), _allowances[sender][_msgSender()].sub(amount, "ERC20: transfer amount exceeds allowance")); | |
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) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(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) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue, "ERC20: decreased allowance below zero")); | |
return true; | |
} | |
/** | |
* @dev Moves tokens `amount` from `sender` to `recipient`. | |
* | |
* This is 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: | |
* | |
* - `sender` cannot be the zero address. | |
* - `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
*/ | |
function _transfer(address sender, address recipient, uint256 amount) internal virtual { | |
require(sender != address(0), "ERC20: transfer from the zero address"); | |
require(recipient != address(0), "ERC20: transfer to the zero address"); | |
_beforeTokenTransfer(sender, recipient, amount); | |
_balances[sender] = _balances[sender].sub(amount, "ERC20: transfer amount exceeds balance"); | |
_balances[recipient] = _balances[recipient].add(amount); | |
emit Transfer(sender, recipient, 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 | |
* | |
* - `to` 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 = _totalSupply.add(amount); | |
_balances[account] = _balances[account].add(amount); | |
emit Transfer(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); | |
_balances[account] = _balances[account].sub(amount, "ERC20: burn amount exceeds balance"); | |
_totalSupply = _totalSupply.sub(amount); | |
emit Transfer(account, address(0), amount); | |
} | |
/** | |
* @dev Sets `amount` as the allowance of `spender` over the `owner`s tokens. | |
* | |
* This is 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 Sets {decimals} to a value other than the default one of 18. | |
* | |
* WARNING: This function should only be called from the constructor. Most | |
* applications that interact with token contracts will not expect | |
* {decimals} to ever change, and may work incorrectly if it does. | |
*/ | |
function _setupDecimals(uint8 decimals_) internal { | |
_decimals = decimals_; | |
} | |
/** | |
* @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 to 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 { } | |
} | |
// File: @openzeppelin/contracts/introspection/IERC165.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.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); | |
} | |
// File: @openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* _Available since v3.1._ | |
*/ | |
interface IERC1155Receiver is IERC165 { | |
/** | |
@dev Handles the receipt of a single ERC1155 token type. This function is | |
called at the end of a `safeTransferFrom` after the balance has been updated. | |
To accept the transfer, this must return | |
`bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` | |
(i.e. 0xf23a6e61, or its own function selector). | |
@param operator The address which initiated the transfer (i.e. msg.sender) | |
@param from The address which previously owned the token | |
@param id The ID of the token being transferred | |
@param value The amount of tokens being transferred | |
@param data Additional data with no specified format | |
@return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed | |
*/ | |
function onERC1155Received( | |
address operator, | |
address from, | |
uint256 id, | |
uint256 value, | |
bytes calldata data | |
) | |
external | |
returns(bytes4); | |
/** | |
@dev Handles the receipt of a multiple ERC1155 token types. This function | |
is called at the end of a `safeBatchTransferFrom` after the balances have | |
been updated. To accept the transfer(s), this must return | |
`bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` | |
(i.e. 0xbc197c81, or its own function selector). | |
@param operator The address which initiated the batch transfer (i.e. msg.sender) | |
@param from The address which previously owned the token | |
@param ids An array containing ids of each token being transferred (order and length must match values array) | |
@param values An array containing amounts of each token being transferred (order and length must match ids array) | |
@param data Additional data with no specified format | |
@return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed | |
*/ | |
function onERC1155BatchReceived( | |
address operator, | |
address from, | |
uint256[] calldata ids, | |
uint256[] calldata values, | |
bytes calldata data | |
) | |
external | |
returns(bytes4); | |
} | |
// File: @openzeppelin/contracts/introspection/ERC165.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* @dev Implementation of the {IERC165} interface. | |
* | |
* Contracts may inherit from this and call {_registerInterface} to declare | |
* their support of an interface. | |
*/ | |
contract ERC165 is IERC165 { | |
/* | |
* bytes4(keccak256('supportsInterface(bytes4)')) == 0x01ffc9a7 | |
*/ | |
bytes4 private constant _INTERFACE_ID_ERC165 = 0x01ffc9a7; | |
/** | |
* @dev Mapping of interface ids to whether or not it's supported. | |
*/ | |
mapping(bytes4 => bool) private _supportedInterfaces; | |
constructor () internal { | |
// Derived contracts need only register support for their own interfaces, | |
// we register support for ERC165 itself here | |
_registerInterface(_INTERFACE_ID_ERC165); | |
} | |
/** | |
* @dev See {IERC165-supportsInterface}. | |
* | |
* Time complexity O(1), guaranteed to always use less than 30 000 gas. | |
*/ | |
function supportsInterface(bytes4 interfaceId) public view override returns (bool) { | |
return _supportedInterfaces[interfaceId]; | |
} | |
/** | |
* @dev Registers the contract as an implementer of the interface defined by | |
* `interfaceId`. Support of the actual ERC165 interface is automatic and | |
* registering its interface id is not required. | |
* | |
* See {IERC165-supportsInterface}. | |
* | |
* Requirements: | |
* | |
* - `interfaceId` cannot be the ERC165 invalid interface (`0xffffffff`). | |
*/ | |
function _registerInterface(bytes4 interfaceId) internal virtual { | |
require(interfaceId != 0xffffffff, "ERC165: invalid interface id"); | |
_supportedInterfaces[interfaceId] = true; | |
} | |
} | |
// File: @openzeppelin/contracts/token/ERC1155/ERC1155Receiver.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.0; | |
/** | |
* @dev _Available since v3.1._ | |
*/ | |
abstract contract ERC1155Receiver is ERC165, IERC1155Receiver { | |
constructor() public { | |
_registerInterface( | |
ERC1155Receiver(0).onERC1155Received.selector ^ | |
ERC1155Receiver(0).onERC1155BatchReceived.selector | |
); | |
} | |
} | |
// File: @openzeppelin/contracts/token/ERC1155/IERC1155.sol | |
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.6.2; | |
/** | |
* @dev Required interface of an ERC1155 compliant contract, as defined in the | |
* https://eips.ethereum.org/EIPS/eip-1155[EIP]. | |
* | |
* _Available since v3.1._ | |
*/ | |
interface IERC1155 is IERC165 { | |
/** | |
* @dev Emitted when `value` tokens of token type `id` are transfered from `from` to `to` by `operator`. | |
*/ | |
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value); | |
/** | |
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all | |
* transfers. | |
*/ | |
event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values); | |
/** | |
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to | |
* `approved`. | |
*/ | |
event ApprovalForAll(address indexed account, address indexed operator, bool approved); | |
/** | |
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI. | |
* | |
* If an {URI} event was emitted for `id`, the standard | |
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value | |
* returned by {IERC1155MetadataURI-uri}. | |
*/ | |
event URI(string value, uint256 indexed id); | |
/** | |
* @dev Returns the amount of tokens of token type `id` owned by `account`. | |
* | |
* Requirements: | |
* | |
* - `account` cannot be the zero address. | |
*/ | |
function balanceOf(address account, uint256 id) external view returns (uint256); | |
/** | |
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}. | |
* | |
* Requirements: | |
* | |
* - `accounts` and `ids` must have the same length. | |
*/ | |
function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids) external view returns (uint256[] memory); | |
/** | |
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`, | |
* | |
* Emits an {ApprovalForAll} event. | |
* | |
* Requirements: | |
* | |
* - `operator` cannot be the caller. | |
*/ | |
function setApprovalForAll(address operator, bool approved) external; | |
/** | |
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens. | |
* | |
* See {setApprovalForAll}. | |
*/ | |
function isApprovedForAll(address account, address operator) external view returns (bool); | |
/** | |
* @dev Transfers `amount` tokens of token type `id` from `from` to `to`. | |
* | |
* Emits a {TransferSingle} event. | |
* | |
* Requirements: | |
* | |
* - `to` cannot be the zero address. | |
* - If the caller is not `from`, it must be have been approved to spend ``from``'s tokens via {setApprovalForAll}. | |
* - `from` must have a balance of tokens of type `id` of at least `amount`. | |
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the | |
* acceptance magic value. | |
*/ | |
function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes calldata data) external; | |
/** | |
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}. | |
* | |
* Emits a {TransferBatch} event. | |
* | |
* Requirements: | |
* | |
* - `ids` and `amounts` must have the same length. | |
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the | |
* acceptance magic value. | |
*/ | |
function safeBatchTransferFrom(address from, address to, uint256[] calldata ids, uint256[] calldata amounts, bytes calldata data) external; | |
} | |
// File: contracts/IShareToken.sol | |
pragma solidity ^0.6.2; | |
interface IShareToken is IERC1155 { | |
function claimTradingProceeds( | |
address _market, | |
address _shareHolder, | |
bytes32 _fingerprint | |
) external returns (uint256[] memory _outcomeFees); | |
function getTokenId(address _market, uint256 _outcome) | |
external | |
pure | |
returns (uint256 _tokenId); | |
function getMarket(uint256 _tokenId) | |
external | |
view | |
returns (address _marketAddress); | |
} | |
// File: contracts/ERC20Wrapper.sol | |
pragma solidity ^0.6.2; | |
/** | |
* @dev This is an Wrapper around ERC1155 shareTokens generated by Augur | |
* @author yashnaman | |
* as shares on a outcome of a market. | |
* For every outcome there will be one wrapper. | |
* The approch here is simple. It gets ERC1155 token and mints ERC20. | |
* It burns ERC20s and gives back the ERC11555s. | |
* AugurFoundry passed in the constructor has special permission to mint and burn. | |
*/ | |
contract ERC20Wrapper is ERC20, ERC1155Receiver { | |
uint256 public tokenId; | |
IShareToken public shareToken; | |
IERC20 public cash; | |
address public augurFoundry; | |
/** | |
* @dev sets values for | |
* @param _augurFoundry A trusted factory contract so that users can wrap multiple tokens in one | |
* transaction without giving individual approvals | |
* @param _shareToken address of shareToken for which this wrapper is for | |
* @param _cash DAI | |
* @param _tokenId id of market outcome this wrapper is for | |
* @param _name a descriptive name mentioning market and outcome | |
* @param _symbol symbol | |
* @param _decimals decimals | |
*/ | |
constructor( | |
address _augurFoundry, | |
IShareToken _shareToken, | |
IERC20 _cash, | |
uint256 _tokenId, | |
string memory _name, | |
string memory _symbol, | |
uint8 _decimals | |
) public ERC20(_name, _symbol) { | |
_setupDecimals(_decimals); | |
augurFoundry = _augurFoundry; | |
tokenId = _tokenId; | |
shareToken = _shareToken; | |
cash = _cash; | |
} | |
/**@dev A function that gets ERC1155s and mints ERC20s | |
* Requirements: | |
* | |
* - if the msg.sender is not augurFoundry then it needs to have given setApprovalForAll | |
* to this contract (if the msg.sender is augur foundry then we trust it and know that | |
* it would have transferred the ERC1155s to this contract before calling it) | |
* @param _account account the newly minted ERC20s will go to | |
* @param _amount amount of tokens to be wrapped | |
*/ | |
function wrapTokens(address _account, uint256 _amount) public { | |
if (msg.sender != augurFoundry) { | |
shareToken.safeTransferFrom( | |
msg.sender, | |
address(this), | |
tokenId, | |
_amount, | |
"" | |
); | |
} | |
_mint(_account, _amount); | |
} | |
/**@dev A function that burns ERC20s and gives back ERC1155s | |
* Requirements: | |
* | |
* - if the msg.sender is not augurFoundry or _account then the caller must have allowance for ``_account``'s tokens of at least | |
* `amount`. | |
* - if the market has finalized then claim() function should be called. | |
* @param _account account the newly minted ERC20s will go to | |
* @param _amount amount of tokens to be unwrapped | |
*/ | |
function unWrapTokens(address _account, uint256 _amount) public { | |
if (msg.sender != _account && msg.sender != augurFoundry) { | |
uint256 decreasedAllowance = allowance(_account, msg.sender).sub( | |
_amount, | |
"ERC20: burn amount exceeds allowance" | |
); | |
_approve(_account, msg.sender, decreasedAllowance); | |
} | |
_burn(_account, _amount); | |
shareToken.safeTransferFrom( | |
address(this), | |
_account, | |
tokenId, | |
_amount, | |
"" | |
); | |
} | |
/**@dev A function that burns ERC20s and gives back DAI | |
* It will return _account DAI if the outcome for which this wrapper is for | |
* is a winning outcome. | |
* Requirements: | |
* - if msg.sender is not {_account} then {_account} should have given allowance to msg.sender | |
* of at least balanceOf(_account) | |
* This is to prevent cases where an unknowing contract has the balance and someone claims | |
* winning for them. | |
* - Not really a requirement but... | |
* it makes more sense to call it when the market has finalized. | |
* | |
* @param _account account for which DAI is being claimed | |
*/ | |
function claim(address _account) public { | |
/**@notice checks if the proceeds were claimed before. If not then claims the proceeds */ | |
if (shareToken.balanceOf(address(this), tokenId) != 0) { | |
shareToken.claimTradingProceeds( | |
shareToken.getMarket(tokenId), | |
address(this), | |
"" | |
); | |
} | |
uint256 cashBalance = cash.balanceOf(address(this)); | |
/**@notice If this is a winning outcome then give the user thier share of DAI */ | |
if (cashBalance != 0) { | |
uint256 userShare = (cashBalance.mul(balanceOf(_account))).div( | |
totalSupply() | |
); | |
if (msg.sender != _account) { | |
uint256 decreasedAllowance = allowance(_account, msg.sender) | |
.sub( | |
balanceOf(_account), | |
"ERC20: burn amount exceeds allowance" | |
); | |
_approve(_account, msg.sender, decreasedAllowance); | |
} | |
_burn(_account, balanceOf(_account)); | |
require(cash.transfer(_account, userShare)); | |
} | |
} | |
/** | |
@dev Handles the receipt of a single ERC1155 token type. This function is | |
called at the end of a `safeTransferFrom` after the balance has been updated. | |
To accept the transfer, this must return | |
`bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` | |
(i.e. 0xf23a6e61, or its own function selector). | |
@param operator The address which initiated the transfer (i.e. msg.sender) | |
@param from The address which previously owned the token | |
@param id The ID of the token being transferred | |
@param value The amount of tokens being transferred | |
@param data Additional data with no specified format | |
@return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed | |
*/ | |
function onERC1155Received( | |
address operator, | |
address from, | |
uint256 id, | |
uint256 value, | |
bytes calldata data | |
) external override returns (bytes4) { | |
/**@notice To make sure that no other tokenId other than what this ERC20 is a wrapper for is sent here*/ | |
require(id == tokenId, "Not acceptable"); | |
return ( | |
bytes4( | |
keccak256( | |
"onERC1155Received(address,address,uint256,uint256,bytes)" | |
) | |
) | |
); | |
} | |
/** | |
@dev Handles the receipt of a multiple ERC1155 token types. This function | |
is called at the end of a `safeBatchTransferFrom` after the balances have | |
been updated. To accept the transfer(s), this must return | |
`bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` | |
(i.e. 0xbc197c81, or its own function selector). | |
@param operator The address which initiated the batch transfer (i.e. msg.sender) | |
@param from The address which previously owned the token | |
@param ids An array containing ids of each token being transferred (order and length must match values array) | |
@param values An array containing amounts of each token being transferred (order and length must match ids array) | |
@param data Additional data with no specified format | |
@return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed | |
*/ | |
function onERC1155BatchReceived( | |
address operator, | |
address from, | |
uint256[] calldata ids, | |
uint256[] calldata values, | |
bytes calldata data | |
) external override returns (bytes4) { | |
/**@notice This is not allowed. Just transfer one predefined id here */ | |
return ""; | |
} | |
} | |
// File: contracts/AugurFoundry.sol | |
pragma solidity ^0.6.2; | |
pragma experimental ABIEncoderV2; | |
/** | |
* @dev This is a factory that creates Wrappers around ERC1155 shareTokens generated by Augur | |
* @author yashnaman | |
* as shares on outcomes of a markets. | |
* For every outcome there will be one wrapper. | |
*/ | |
contract AugurFoundry { | |
IShareToken public shareToken; | |
IERC20 public cash; | |
mapping(uint256 => address) public wrappers; | |
event WrapperCreated(uint256 indexed tokenId, address tokenAddress); | |
/**@dev sets value for {shareToken} and {cash} | |
* @param _shareToken address of shareToken associated with a augur universe | |
*@param _cash DAI | |
*/ | |
constructor(IShareToken _shareToken, IERC20 _cash) public { | |
cash = _cash; | |
shareToken = _shareToken; | |
} | |
/**@dev creates new ERC20 wrappers for a outcome of a market | |
*@param _tokenId token id associated with a outcome of a market | |
*@param _name a descriptive name mentioning market and outcome | |
*@param _symbol symbol for the ERC20 wrapper | |
*@param decimals decimals for the ERC20 wrapper | |
*/ | |
function newERC20Wrapper( | |
uint256 _tokenId, | |
string memory _name, | |
string memory _symbol, | |
uint8 _decimals | |
) public { | |
require(wrappers[_tokenId] == address(0), "Wrapper already created"); | |
ERC20Wrapper erc20Wrapper = new ERC20Wrapper( | |
address(this), | |
shareToken, | |
cash, | |
_tokenId, | |
_name, | |
_symbol, | |
_decimals | |
); | |
wrappers[_tokenId] = address(erc20Wrapper); | |
emit WrapperCreated(_tokenId, address(erc20Wrapper)); | |
} | |
/**@dev creates new ERC20 wrappers for multiple tokenIds*/ | |
function newERC20Wrappers( | |
uint256[] memory _tokenIds, | |
string[] memory _names, | |
string[] memory _symbols, | |
uint8[] memory _decimals | |
) public { | |
require( | |
_tokenIds.length == _names.length && | |
_tokenIds.length == _symbols.length | |
); | |
for (uint256 i = 0; i < _tokenIds.length; i++) { | |
newERC20Wrapper(_tokenIds[i], _names[i], _symbols[i], _decimals[i]); | |
} | |
} | |
/**@dev A function that wraps ERC1155s shareToken into ERC20s | |
* Requirements: | |
* | |
* - msg.sender has setApprovalForAll to this contract | |
* @param _tokenId token id associated with a outcome of a market | |
* @param _account account the newly minted ERC20s will go to | |
* @param _amount amount of tokens to be wrapped | |
*/ | |
function wrapTokens( | |
uint256 _tokenId, | |
address _account, | |
uint256 _amount | |
) public { | |
ERC20Wrapper erc20Wrapper = ERC20Wrapper(wrappers[_tokenId]); | |
shareToken.safeTransferFrom( | |
msg.sender, | |
address(erc20Wrapper), | |
_tokenId, | |
_amount, | |
"" | |
); | |
erc20Wrapper.wrapTokens(_account, _amount); | |
} | |
/**@dev A function that burns ERC20s and gives back ERC1155s | |
* Requirements: | |
* | |
* - msg.sender has more than _amount of ERC20 tokens associated with _tokenId. | |
* - if the market has finalized then it is advised that you call claim() on ERC20Wrapper | |
* contract associated with the winning outcome | |
* @param _tokenId token id associated with a outcome of a market | |
* @param _amount amount of tokens to be unwrapped | |
*/ | |
function unWrapTokens(uint256 _tokenId, uint256 _amount) public { | |
ERC20Wrapper erc20Wrapper = ERC20Wrapper(wrappers[_tokenId]); | |
erc20Wrapper.unWrapTokens(msg.sender, _amount); | |
} | |
/**@dev wraps multiple tokens */ | |
function wrapMultipleTokens( | |
uint256[] memory _tokenIds, | |
address _account, | |
uint256[] memory _amounts | |
) public { | |
for (uint256 i = 0; i < _tokenIds.length; i++) { | |
wrapTokens(_tokenIds[i], _account, _amounts[i]); | |
} | |
} | |
/**@dev unwraps multiple tokens */ | |
function unWrapMultipleTokens( | |
uint256[] memory _tokenIds, | |
uint256[] memory _amounts | |
) public { | |
for (uint256 i = 0; i < _tokenIds.length; i++) { | |
unWrapTokens(_tokenIds[i], _amounts[i]); | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment