// Sources flattened with buidler v1.4.3 https://buidler.dev
// File @openzeppelin/contracts/utils/SafeCast.sol@v3.1.0
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.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 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
*/
function toUint128(uint256 value) internal pure returns (uint128) {
require(value < 2**128, "SafeCast: value doesn\'t fit in 128 bits");
return uint128(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
*/
function toUint64(uint256 value) internal pure returns (uint64) {
require(value < 2**64, "SafeCast: value doesn\'t fit in 64 bits");
return uint64(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
*/
function toUint32(uint256 value) internal pure returns (uint32) {
require(value < 2**32, "SafeCast: value doesn\'t fit in 32 bits");
return uint32(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
*/
function toUint16(uint256 value) internal pure returns (uint16) {
require(value < 2**16, "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.
*/
function toUint8(uint256 value) internal pure returns (uint8) {
require(value < 2**8, "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.
*/
function toUint256(int256 value) internal pure returns (uint256) {
require(value >= 0, "SafeCast: value must be positive");
return uint256(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 >= -2**127 && value < 2**127, "SafeCast: value doesn\'t fit in 128 bits");
return int128(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 >= -2**63 && value < 2**63, "SafeCast: value doesn\'t fit in 64 bits");
return int64(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 >= -2**31 && value < 2**31, "SafeCast: value doesn\'t fit in 32 bits");
return int32(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 >= -2**15 && value < 2**15, "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 >= -2**7 && value < 2**7, "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.
*/
function toInt256(uint256 value) internal pure returns (int256) {
require(value < 2**255, "SafeCast: value doesn't fit in an int256");
return int256(value);
}
}
// File @openzeppelin/contracts/math/SafeMath.sol@v3.1.0
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/math/SignedSafeMath.sol@v3.1.0
pragma solidity ^0.6.0;
/**
* @title SignedSafeMath
* @dev Signed math operations with safety checks that revert on error.
*/
library SignedSafeMath {
int256 constant private _INT256_MIN = -2**255;
/**
* @dev Returns the multiplication of two signed integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(int256 a, int256 b) internal pure returns (int256) {
// 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;
}
require(!(a == -1 && b == _INT256_MIN), "SignedSafeMath: multiplication overflow");
int256 c = a * b;
require(c / a == b, "SignedSafeMath: multiplication overflow");
return c;
}
/**
* @dev Returns the integer division of two signed 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(int256 a, int256 b) internal pure returns (int256) {
require(b != 0, "SignedSafeMath: division by zero");
require(!(b == -1 && a == _INT256_MIN), "SignedSafeMath: division overflow");
int256 c = a / b;
return c;
}
/**
* @dev Returns the subtraction of two signed integers, reverting on
* overflow.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(int256 a, int256 b) internal pure returns (int256) {
int256 c = a - b;
require((b >= 0 && c <= a) || (b < 0 && c > a), "SignedSafeMath: subtraction overflow");
return c;
}
/**
* @dev Returns the addition of two signed integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(int256 a, int256 b) internal pure returns (int256) {
int256 c = a + b;
require((b >= 0 && c >= a) || (b < 0 && c < a), "SignedSafeMath: addition overflow");
return c;
}
}
// File @openzeppelin/contracts/GSN/Context.sol@v3.1.0
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/access/Ownable.sol@v3.1.0
pragma solidity ^0.6.0;
/**
* @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.
*/
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 () internal {
address msgSender = _msgSender();
_owner = msgSender;
emit OwnershipTransferred(address(0), msgSender);
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
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 {
emit OwnershipTransferred(_owner, address(0));
_owner = 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");
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
}
// File @animoca/ethereum-contracts-erc20_base/contracts/token/ERC20/IERC20.sol@v3.0.0
/*
https://github.com/OpenZeppelin/openzeppelin-contracts
The MIT License (MIT)
Copyright (c) 2016-2019 zOS Global Limited
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
pragma solidity 0.6.8;
/**
* @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 `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);
}
// File @openzeppelin/contracts/introspection/IERC165.sol@v3.1.0
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/introspection/ERC165.sol@v3.1.0
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 @animoca/ethereum-contracts-assets_inventory/contracts/token/ERC1155/IERC1155TokenReceiver.sol@v5.0.0
pragma solidity 0.6.8;
/**
* @title ERC-1155 Multi Token Standard, token receiver
* @dev See https://eips.ethereum.org/EIPS/eip-1155
* Interface for any contract that wants to support transfers from ERC1155 asset contracts.
* Note: The ERC-165 identifier for this interface is 0x4e2312e0.
*/
interface IERC1155TokenReceiver {
/**
* @notice Handle the receipt of a single ERC1155 token type.
* @dev An ERC1155-compliant smart contract MUST call this function on the token recipient contract, at the end of a `safeTransferFrom` after the balance has been updated.
* This function MUST return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` (i.e. 0xf23a6e61) if it accepts the transfer.
* This function MUST revert if it rejects the transfer.
* Return of any other value than the prescribed keccak256 generated value MUST result in the transaction being reverted by the caller.
* @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 `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @notice Handle the receipt of multiple ERC1155 token types.
* @dev An ERC1155-compliant smart contract MUST call this function on the token recipient contract, at the end of a `safeBatchTransferFrom` after the balances have been updated.
* This function MUST return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` (i.e. 0xbc197c81) if it accepts the transfer(s).
* This function MUST revert if it rejects the transfer(s).
* Return of any other value than the prescribed keccak256 generated value MUST result in the transaction being reverted by the caller.
* @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)"))`
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}
// File @animoca/ethereum-contracts-assets_inventory/contracts/token/ERC1155/ERC1155TokenReceiver.sol@v5.0.0
pragma solidity 0.6.8;
abstract contract ERC1155TokenReceiver is IERC1155TokenReceiver, ERC165 {
// bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))
bytes4 internal constant _ERC1155_RECEIVED = 0xf23a6e61;
// bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))
bytes4 internal constant _ERC1155_BATCH_RECEIVED = 0xbc197c81;
bytes4 internal constant _ERC1155_REJECTED = 0xffffffff;
constructor() internal {
_registerInterface(type(IERC1155TokenReceiver).interfaceId);
}
}
// File @animoca/ethereum-contracts-nft_staking/contracts/staking/NftStaking.sol@v3.0.4
pragma solidity 0.6.8;
/**
* @title NFT Staking
* Distribute ERC20 rewards over discrete-time schedules for the staking of NFTs.
* This contract is designed on a self-service model, where users will stake NFTs, unstake NFTs and claim rewards through their own transactions only.
*/
abstract contract NftStaking is ERC1155TokenReceiver, Ownable {
using SafeCast for uint256;
using SafeMath for uint256;
using SignedSafeMath for int256;
event RewardsAdded(uint256 startPeriod, uint256 endPeriod, uint256 rewardsPerCycle);
event Started();
event NftStaked(address staker, uint256 cycle, uint256 tokenId, uint256 weight);
event NftUnstaked(address staker, uint256 cycle, uint256 tokenId, uint256 weight);
event RewardsClaimed(address staker, uint256 cycle, uint256 startPeriod, uint256 periods, uint256 amount);
event HistoriesUpdated(address staker, uint256 startCycle, uint256 stakerStake, uint256 globalStake);
event Disabled();
/**
* Used to represent the current staking status of an NFT.
* Optimised for use in storage.
*/
struct TokenInfo {
address owner;
uint64 weight;
uint16 depositCycle;
uint16 withdrawCycle;
}
/**
* Used as a historical record of change of stake.
* Stake represents an aggregation of staked token weights.
* Optimised for use in storage.
*/
struct Snapshot {
uint128 stake;
uint128 startCycle;
}
/**
* Used to represent a staker's information about the next claim.
* Optimised for use in storage.
*/
struct NextClaim {
uint16 period;
uint64 globalSnapshotIndex;
uint64 stakerSnapshotIndex;
}
/**
* Used as a container to hold result values from computing rewards.
*/
struct ComputedClaim {
uint16 startPeriod;
uint16 periods;
uint256 amount;
}
bool public enabled = true;
uint256 public totalRewardsPool;
uint256 public startTimestamp;
IERC20 public immutable rewardsTokenContract;
IWhitelistedNftContract public immutable whitelistedNftContract;
uint32 public immutable cycleLengthInSeconds;
uint16 public immutable periodLengthInCycles;
Snapshot[] public globalHistory;
/* staker => snapshots*/
mapping(address => Snapshot[]) public stakerHistories;
/* staker => next claim */
mapping(address => NextClaim) public nextClaims;
/* tokenId => token info */
mapping(uint256 => TokenInfo) public tokenInfos;
/* period => rewardsPerCycle */
mapping(uint256 => uint256) public rewardsSchedule;
modifier hasStarted() {
require(startTimestamp != 0, "NftStaking: staking not started");
_;
}
modifier hasNotStarted() {
require(startTimestamp == 0, "NftStaking: staking has started");
_;
}
modifier isEnabled() {
require(enabled, "NftStaking: contract is not enabled");
_;
}
modifier isNotEnabled() {
require(!enabled, "NftStaking: contract is enabled");
_;
}
/**
* Constructor.
* @dev Reverts if the period length value is zero.
* @dev Reverts if the cycle length value is zero.
* @dev Warning: cycles and periods need to be calibrated carefully. Small values will increase computation load while estimating and claiming rewards. Big values will increase the time to wait before a new period becomes claimable.
* @param cycleLengthInSeconds_ The length of a cycle, in seconds.
* @param periodLengthInCycles_ The length of a period, in cycles.
* @param whitelistedNftContract_ The ERC1155-compliant (optional ERC721-compliance) contract from which staking is accepted.
* @param rewardsTokenContract_ The ERC20-based token used as staking rewards.
*/
constructor(
uint32 cycleLengthInSeconds_,
uint16 periodLengthInCycles_,
IWhitelistedNftContract whitelistedNftContract_,
IERC20 rewardsTokenContract_
) internal {
require(cycleLengthInSeconds_ >= 1 minutes, "NftStaking: invalid cycle length");
require(periodLengthInCycles_ >= 2, "NftStaking: invalid period length");
cycleLengthInSeconds = cycleLengthInSeconds_;
periodLengthInCycles = periodLengthInCycles_;
whitelistedNftContract = whitelistedNftContract_;
rewardsTokenContract = rewardsTokenContract_;
}
/* Admin Public Functions */
/**
* Adds `rewardsPerCycle` reward amount for the period range from `startPeriod` to `endPeriod`, inclusive, to the rewards schedule.
* The necessary amount of reward tokens is transferred to the contract. Cannot be used for past periods.
* Can only be used to add rewards and not to remove them.
* @dev Reverts if not called by the owner.
* @dev Reverts if the start period is zero.
* @dev Reverts if the end period precedes the start period.
* @dev Reverts if attempting to add rewards for a period earlier than the current, after staking has started.
* @dev Reverts if the reward tokens transfer fails.
* @dev The rewards token contract emits an ERC20 Transfer event for the reward tokens transfer.
* @dev Emits a RewardsAdded event.
* @param startPeriod The starting period (inclusive).
* @param endPeriod The ending period (inclusive).
* @param rewardsPerCycle The reward amount to add for each cycle within range.
*/
function addRewardsForPeriods(
uint16 startPeriod,
uint16 endPeriod,
uint256 rewardsPerCycle
) external onlyOwner {
require(startPeriod != 0 && startPeriod <= endPeriod, "NftStaking: wrong period range");
uint16 periodLengthInCycles_ = periodLengthInCycles;
if (startTimestamp != 0) {
require(
startPeriod >= _getCurrentPeriod(periodLengthInCycles_),
"NftStaking: already committed reward schedule"
);
}
for (uint256 period = startPeriod; period <= endPeriod; ++period) {
rewardsSchedule[period] = rewardsSchedule[period].add(rewardsPerCycle);
}
uint256 addedRewards = rewardsPerCycle.mul(periodLengthInCycles_).mul(endPeriod - startPeriod + 1);
totalRewardsPool = totalRewardsPool.add(addedRewards);
require(
rewardsTokenContract.transferFrom(msg.sender, address(this), addedRewards),
"NftStaking: failed to add funds to the reward pool"
);
emit RewardsAdded(startPeriod, endPeriod, rewardsPerCycle);
}
/**
* Starts the first cycle of staking, enabling users to stake NFTs.
* @dev Reverts if not called by the owner.
* @dev Reverts if the staking has already started.
* @dev Emits a Started event.
*/
function start() public onlyOwner hasNotStarted {
startTimestamp = now;
emit Started();
}
/**
* Permanently disables all staking and claiming.
* This is an emergency recovery feature which is NOT part of the normal contract operation.
* @dev Reverts if not called by the owner.
* @dev Emits a Disabled event.
*/
function disable() public onlyOwner {
enabled = false;
emit Disabled();
}
/**
* Withdraws a specified amount of reward tokens from the contract it has been disabled.
* @dev Reverts if not called by the owner.
* @dev Reverts if the contract has not been disabled.
* @dev Reverts if the reward tokens transfer fails.
* @dev The rewards token contract emits an ERC20 Transfer event for the reward tokens transfer.
* @param amount The amount to withdraw.
*/
function withdrawRewardsPool(uint256 amount) public onlyOwner isNotEnabled {
require(
rewardsTokenContract.transfer(msg.sender, amount),
"NftStaking: failed to withdraw from the rewards pool"
);
}
/* ERC1155TokenReceiver */
function onERC1155Received(
address, /*operator*/
address from,
uint256 id,
uint256, /*value*/
bytes calldata /*data*/
) external virtual override returns (bytes4) {
_stakeNft(id, from);
return _ERC1155_RECEIVED;
}
function onERC1155BatchReceived(
address, /*operator*/
address from,
uint256[] calldata ids,
uint256[] calldata, /*values*/
bytes calldata /*data*/
) external virtual override returns (bytes4) {
for (uint256 i = 0; i < ids.length; ++i) {
_stakeNft(ids[i], from);
}
return _ERC1155_BATCH_RECEIVED;
}
/* Staking Public Functions */
/**
* Unstakes a deposited NFT from the contract and updates the histories accordingly.
* The NFT's weight will not count for the current cycle.
* @dev Reverts if the caller is not the original owner of the NFT.
* @dev While the contract is enabled, reverts if the NFT is still frozen.
* @dev Reverts if the NFT transfer back to the original owner fails.
* @dev If ERC1155 safe transfers are supported by the receiver wallet, the whitelisted NFT contract emits an ERC1155 TransferSingle event for the NFT transfer back to the staker.
* @dev If ERC1155 safe transfers are not supported by the receiver wallet, the whitelisted NFT contract emits an ERC721 Transfer event for the NFT transfer back to the staker.
* @dev While the contract is enabled, emits a HistoriesUpdated event.
* @dev Emits a NftUnstaked event.
* @param tokenId The token identifier, referencing the NFT being unstaked.
*/
function unstakeNft(uint256 tokenId) external virtual {
TokenInfo memory tokenInfo = tokenInfos[tokenId];
require(tokenInfo.owner == msg.sender, "NftStaking: token not staked or incorrect token owner");
uint16 currentCycle = _getCycle(now);
if (enabled) {
// ensure that at least an entire cycle has elapsed before unstaking the token to avoid
// an exploit where a full cycle would be claimable if staking just before the end
// of a cycle and unstaking right after the start of the new cycle
require(currentCycle - tokenInfo.depositCycle >= 2, "NftStaking: token still frozen");
_updateHistories(msg.sender, -int128(tokenInfo.weight), currentCycle);
// clear the token owner to ensure it cannot be unstaked again without being re-staked
tokenInfo.owner = address(0);
// set the withdrawal cycle to ensure it cannot be re-staked during the same cycle
tokenInfo.withdrawCycle = currentCycle;
tokenInfos[tokenId] = tokenInfo;
}
try whitelistedNftContract.safeTransferFrom(address(this), msg.sender, tokenId, 1, "") {} catch {
// the above call to the ERC1155 safeTransferFrom() function may fail if the recipient
// is a contract wallet not implementing the ERC1155TokenReceiver interface
// if this happens, the transfer falls back to a call to the ERC721 (non-safe) transferFrom function.
whitelistedNftContract.transferFrom(address(this), msg.sender, tokenId);
}
emit NftUnstaked(msg.sender, currentCycle, tokenId, tokenInfo.weight);
}
/**
* Estimates the claimable rewards for the specified maximum number of past periods, starting at the next claimable period.
* Estimations can be done only for periods which have already ended.
* The maximum number of periods to claim can be calibrated to chunk down claims in several transactions to accomodate gas constraints.
* @param maxPeriods The maximum number of periods to calculate for.
* @return startPeriod The first period on which the computation starts.
* @return periods The number of periods computed for.
* @return amount The total claimable rewards.
*/
function estimateRewards(uint16 maxPeriods)
external
view
isEnabled
hasStarted
returns (
uint16 startPeriod,
uint16 periods,
uint256 amount
)
{
(ComputedClaim memory claim, ) = _computeRewards(msg.sender, maxPeriods);
startPeriod = claim.startPeriod;
periods = claim.periods;
amount = claim.amount;
}
/**
* Claims the claimable rewards for the specified maximum number of past periods, starting at the next claimable period.
* Claims can be done only for periods which have already ended.
* The maximum number of periods to claim can be calibrated to chunk down claims in several transactions to accomodate gas constraints.
* @dev Reverts if the reward tokens transfer fails.
* @dev The rewards token contract emits an ERC20 Transfer event for the reward tokens transfer.
* @dev Emits a RewardsClaimed event.
* @param maxPeriods The maximum number of periods to claim for.
*/
function claimRewards(uint16 maxPeriods) external isEnabled hasStarted {
NextClaim memory nextClaim = nextClaims[msg.sender];
(ComputedClaim memory claim, NextClaim memory newNextClaim) = _computeRewards(msg.sender, maxPeriods);
// free up memory on already processed staker snapshots
Snapshot[] storage stakerHistory = stakerHistories[msg.sender];
while (nextClaim.stakerSnapshotIndex < newNextClaim.stakerSnapshotIndex) {
delete stakerHistory[nextClaim.stakerSnapshotIndex++];
}
if (claim.periods == 0) {
return;
}
if (nextClaims[msg.sender].period == 0) {
return;
}
Snapshot memory lastStakerSnapshot = stakerHistory[stakerHistory.length - 1];
uint256 lastClaimedCycle = (claim.startPeriod + claim.periods - 1) * periodLengthInCycles;
if (
lastClaimedCycle >= lastStakerSnapshot.startCycle && // the claim reached the last staker snapshot
lastStakerSnapshot.stake == 0 // and nothing is staked in the last staker snapshot
) {
// re-init the next claim
delete nextClaims[msg.sender];
} else {
nextClaims[msg.sender] = newNextClaim;
}
if (claim.amount != 0) {
require(rewardsTokenContract.transfer(msg.sender, claim.amount), "NftStaking: failed to transfer rewards");
}
emit RewardsClaimed(msg.sender, _getCycle(now), claim.startPeriod, claim.periods, claim.amount);
}
/* Utility Public Functions */
/**
* Retrieves the current cycle (index-1 based).
* @return The current cycle (index-1 based).
*/
function getCurrentCycle() external view returns (uint16) {
return _getCycle(now);
}
/**
* Retrieves the current period (index-1 based).
* @return The current period (index-1 based).
*/
function getCurrentPeriod() external view returns (uint16) {
return _getCurrentPeriod(periodLengthInCycles);
}
/**
* Retrieves the last global snapshot index, if any.
* @dev Reverts if the global history is empty.
* @return The last global snapshot index.
*/
function lastGlobalSnapshotIndex() external view returns (uint256) {
uint256 length = globalHistory.length;
require(length != 0, "NftStaking: empty global history");
return length - 1;
}
/**
* Retrieves the last staker snapshot index, if any.
* @dev Reverts if the staker history is empty.
* @return The last staker snapshot index.
*/
function lastStakerSnapshotIndex(address staker) external view returns (uint256) {
uint256 length = stakerHistories[staker].length;
require(length != 0, "NftStaking: empty staker history");
return length - 1;
}
/* Staking Internal Functions */
/**
* Stakes the NFT received by the contract for its owner. The NFT's weight will count for the current cycle.
* @dev Reverts if the caller is not the whitelisted NFT contract.
* @dev Emits an HistoriesUpdated event.
* @dev Emits an NftStaked event.
* @param tokenId Identifier of the staked NFT.
* @param tokenOwner Owner of the staked NFT.
*/
function _stakeNft(uint256 tokenId, address tokenOwner) internal isEnabled hasStarted {
require(address(whitelistedNftContract) == msg.sender, "NftStaking: contract not whitelisted");
uint64 weight = _validateAndGetNftWeight(tokenId);
uint16 periodLengthInCycles_ = periodLengthInCycles;
uint16 currentCycle = _getCycle(now);
_updateHistories(tokenOwner, int128(weight), currentCycle);
// initialise the next claim if it was the first stake for this staker or if
// the next claim was re-initialised (ie. rewards were claimed until the last
// staker snapshot and the last staker snapshot has no stake)
if (nextClaims[tokenOwner].period == 0) {
uint16 currentPeriod = _getPeriod(currentCycle, periodLengthInCycles_);
nextClaims[tokenOwner] = NextClaim(currentPeriod, uint64(globalHistory.length - 1), 0);
}
uint16 withdrawCycle = tokenInfos[tokenId].withdrawCycle;
require(currentCycle != withdrawCycle, "NftStaking: unstaked token cooldown");
// set the staked token's info
tokenInfos[tokenId] = TokenInfo(tokenOwner, weight, currentCycle, 0);
emit NftStaked(tokenOwner, currentCycle, tokenId, weight);
}
/**
* Calculates the amount of rewards for a staker over a capped number of periods.
* @dev Processes until the specified maximum number of periods to claim is reached, or the last computable period is reached, whichever occurs first.
* @param staker The staker for whom the rewards will be computed.
* @param maxPeriods Maximum number of periods over which to compute the rewards.
* @return claim the result of computation
* @return nextClaim the next claim which can be used to update the staker's state
*/
function _computeRewards(address staker, uint16 maxPeriods)
internal
view
returns (ComputedClaim memory claim, NextClaim memory nextClaim)
{
// computing 0 periods
if (maxPeriods == 0) {
return (claim, nextClaim);
}
// the history is empty
if (globalHistory.length == 0) {
return (claim, nextClaim);
}
nextClaim = nextClaims[staker];
claim.startPeriod = nextClaim.period;
// nothing has been staked yet
if (claim.startPeriod == 0) {
return (claim, nextClaim);
}
uint16 periodLengthInCycles_ = periodLengthInCycles;
uint16 endClaimPeriod = _getCurrentPeriod(periodLengthInCycles_);
// current period is not claimable
if (nextClaim.period == endClaimPeriod) {
return (claim, nextClaim);
}
// retrieve the next snapshots if they exist
Snapshot[] memory stakerHistory = stakerHistories[staker];
Snapshot memory globalSnapshot = globalHistory[nextClaim.globalSnapshotIndex];
Snapshot memory stakerSnapshot = stakerHistory[nextClaim.stakerSnapshotIndex];
Snapshot memory nextGlobalSnapshot;
Snapshot memory nextStakerSnapshot;
if (nextClaim.globalSnapshotIndex != globalHistory.length - 1) {
nextGlobalSnapshot = globalHistory[nextClaim.globalSnapshotIndex + 1];
}
if (nextClaim.stakerSnapshotIndex != stakerHistory.length - 1) {
nextStakerSnapshot = stakerHistory[nextClaim.stakerSnapshotIndex + 1];
}
// excludes the current period
claim.periods = endClaimPeriod - nextClaim.period;
if (maxPeriods < claim.periods) {
claim.periods = maxPeriods;
}
// re-calibrate the end claim period based on the actual number of
// periods to claim. nextClaim.period will be updated to this value
// after exiting the loop
endClaimPeriod = nextClaim.period + claim.periods;
// iterate over periods
while (nextClaim.period != endClaimPeriod) {
uint16 nextPeriodStartCycle = nextClaim.period * periodLengthInCycles_ + 1;
uint256 rewardPerCycle = rewardsSchedule[nextClaim.period];
uint256 startCycle = nextPeriodStartCycle - periodLengthInCycles_;
uint256 endCycle = 0;
// iterate over global snapshots
while (endCycle != nextPeriodStartCycle) {
// find the range-to-claim starting cycle, where the current
// global snapshot, the current staker snapshot, and the current
// period overlap
if (globalSnapshot.startCycle > startCycle) {
startCycle = globalSnapshot.startCycle;
}
if (stakerSnapshot.startCycle > startCycle) {
startCycle = stakerSnapshot.startCycle;
}
// find the range-to-claim ending cycle, where the current
// global snapshot, the current staker snapshot, and the current
// period no longer overlap. The end cycle is exclusive of the
// range-to-claim and represents the beginning cycle of the next
// range-to-claim
endCycle = nextPeriodStartCycle;
if ((nextGlobalSnapshot.startCycle != 0) && (nextGlobalSnapshot.startCycle < endCycle)) {
endCycle = nextGlobalSnapshot.startCycle;
}
// only calculate and update the claimable rewards if there is
// something to calculate with
if ((globalSnapshot.stake != 0) && (stakerSnapshot.stake != 0) && (rewardPerCycle != 0)) {
uint256 snapshotReward = (endCycle - startCycle).mul(rewardPerCycle).mul(stakerSnapshot.stake);
snapshotReward /= globalSnapshot.stake;
claim.amount = claim.amount.add(snapshotReward);
}
// advance the current global snapshot to the next (if any)
// if its cycle range has been fully processed and if the next
// snapshot starts at most on next period first cycle
if (nextGlobalSnapshot.startCycle == endCycle) {
globalSnapshot = nextGlobalSnapshot;
++nextClaim.globalSnapshotIndex;
if (nextClaim.globalSnapshotIndex != globalHistory.length - 1) {
nextGlobalSnapshot = globalHistory[nextClaim.globalSnapshotIndex + 1];
} else {
nextGlobalSnapshot = Snapshot(0, 0);
}
}
// advance the current staker snapshot to the next (if any)
// if its cycle range has been fully processed and if the next
// snapshot starts at most on next period first cycle
if (nextStakerSnapshot.startCycle == endCycle) {
stakerSnapshot = nextStakerSnapshot;
++nextClaim.stakerSnapshotIndex;
if (nextClaim.stakerSnapshotIndex != stakerHistory.length - 1) {
nextStakerSnapshot = stakerHistory[nextClaim.stakerSnapshotIndex + 1];
} else {
nextStakerSnapshot = Snapshot(0, 0);
}
}
}
++nextClaim.period;
}
return (claim, nextClaim);
}
/**
* Updates the global and staker histories at the current cycle with a new difference in stake.
* @dev Emits a HistoriesUpdated event.
* @param staker The staker who is updating the history.
* @param stakeDelta The difference to apply to the current stake.
* @param currentCycle The current cycle.
*/
function _updateHistories(
address staker,
int128 stakeDelta,
uint16 currentCycle
) internal {
uint256 stakerSnapshotIndex = _updateHistory(stakerHistories[staker], stakeDelta, currentCycle);
uint256 globalSnapshotIndex = _updateHistory(globalHistory, stakeDelta, currentCycle);
emit HistoriesUpdated(
staker,
currentCycle,
stakerHistories[staker][stakerSnapshotIndex].stake,
globalHistory[globalSnapshotIndex].stake
);
}
/**
* Updates the history at the current cycle with a new difference in stake.
* @dev It will update the latest snapshot if it starts at the current cycle, otherwise will create a new snapshot with the updated stake.
* @param history The history to update.
* @param stakeDelta The difference to apply to the current stake.
* @param currentCycle The current cycle.
* @return snapshotIndex Index of the snapshot that was updated or created (i.e. the latest snapshot index).
*/
function _updateHistory(
Snapshot[] storage history,
int128 stakeDelta,
uint16 currentCycle
) internal returns (uint256 snapshotIndex) {
uint256 historyLength = history.length;
uint128 snapshotStake;
if (historyLength != 0) {
// there is an existing snapshot
snapshotIndex = historyLength - 1;
Snapshot storage snapshot = history[snapshotIndex];
snapshotStake = uint256(int256(snapshot.stake).add(stakeDelta)).toUint128();
if (snapshot.startCycle == currentCycle) {
// update the snapshot if it starts on the current cycle
snapshot.stake = snapshotStake;
return snapshotIndex;
}
// update the snapshot index (as a reflection that a new latest
// snapshot will be added to the history), if there was already an
// existing snapshot
snapshotIndex += 1;
} else {
// the snapshot index (as a reflection that a new latest snapshot
// will be added to the history) should already be initialized
// correctly to the default value 0
// the stake delta will not be negative, if we have no history, as
// that would indicate that we are unstaking without having staked
// anything first
snapshotStake = uint128(stakeDelta);
}
Snapshot memory snapshot;
snapshot.stake = snapshotStake;
snapshot.startCycle = currentCycle;
// add a new snapshot in the history
history.push(snapshot);
}
/* Utility Internal Functions */
/**
* Retrieves the cycle (index-1 based) at the specified timestamp.
* @dev Reverts if the specified timestamp is earlier than the beginning of the staking schedule
* @param timestamp The timestamp for which the cycle is derived from.
* @return The cycle (index-1 based) at the specified timestamp.
*/
function _getCycle(uint256 timestamp) internal view returns (uint16) {
require(timestamp >= startTimestamp, "NftStaking: timestamp preceeds contract start");
return (((timestamp - startTimestamp) / uint256(cycleLengthInSeconds)) + 1).toUint16();
}
/**
* Retrieves the period (index-1 based) for the specified cycle and period length.
* @dev reverts if the specified cycle is zero.
* @param cycle The cycle within the period to retrieve.
* @param periodLengthInCycles_ Length of a period, in cycles.
* @return The period (index-1 based) for the specified cycle and period length.
*/
function _getPeriod(uint16 cycle, uint16 periodLengthInCycles_) internal pure returns (uint16) {
require(cycle != 0, "NftStaking: cycle cannot be zero");
return (cycle - 1) / periodLengthInCycles_ + 1;
}
/**
* Retrieves the current period (index-1 based).
* @param periodLengthInCycles_ Length of a period, in cycles.
* @return The current period (index-1 based).
*/
function _getCurrentPeriod(uint16 periodLengthInCycles_) internal view returns (uint16) {
return _getPeriod(_getCycle(now), periodLengthInCycles_);
}
/* Internal Hooks */
/**
* Abstract function which validates whether or not an NFT is accepted for staking and retrieves its associated weight.
* @dev MUST throw if the token is invalid.
* @param tokenId uint256 token identifier of the NFT.
* @return uint64 the weight of the NFT.
*/
function _validateAndGetNftWeight(uint256 tokenId) internal virtual view returns (uint64);
}
/**
* @notice Interface for the NftStaking whitelisted NFT contract.
*/
interface IWhitelistedNftContract {
/**
* ERC1155: Transfers `value` amount of an `id` from `from` to `to` (with safety call).
* @dev Caller must be approved to manage the tokens being transferred out of the `from` account (see "Approval" section of the standard).
* @dev MUST revert if `to` is the zero address.
* @dev MUST revert if balance of holder for token `id` is lower than the `value` sent.
* @dev MUST revert on any other error.
* @dev MUST emit the `TransferSingle` event to reflect the balance change (see "Safe Transfer Rules" section of the standard).
* @dev After the above conditions are met, this function MUST check if `to` is a smart contract (e.g. code size > 0). If so, it MUST call `onERC1155Received` on `to` and act appropriately (see "Safe Transfer Rules" section of the standard).
* @param from Source address
* @param to Target address
* @param id ID of the token type
* @param value Transfer amount
* @param data Additional data with no specified format, MUST be sent unaltered in call to `onERC1155Received` on `to`
*/
function safeTransferFrom(
address from,
address to,
uint256 id,
uint256 value,
bytes calldata data
) external;
/**
* @notice ERC721: Transfers the ownership of a given token ID to another address.
* Usage of this method is discouraged, use `safeTransferFrom` whenever possible.
* Requires the msg sender to be the owner, approved, or operator.
* @param from current owner of the token.
* @param to address to receive the ownership of the given token ID.
* @param tokenId uint256 ID of the token to be transferred.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) external;
}
// File @animoca/f1dt-ethereum-contracts/contracts/staking/DeltaTimeStakingBeta.sol@v0.4.0
pragma solidity 0.6.8;
/**
* @title Delta Time Staking Beta
* This contract allows owners of Delta Time 2019 Car NFTs to stake them in exchange for REVV rewards.
*/
contract DeltaTimeStakingBeta is NftStaking {
mapping(uint256 => uint64) public weightsByRarity;
/**
* Constructor.
* @param cycleLengthInSeconds_ The length of a cycle, in seconds.
* @param periodLengthInCycles_ The length of a period, in cycles.
* @param inventoryContract IWhitelistedNftContract the DeltaTimeInventory contract.
* @param revvContract IERC20 the REVV contract.
* @param rarities uint256[] the supported DeltaTimeInventory NFT rarities.
* @param weights uint64[] the staking weights associated to the NFT rarities.
*/
constructor(
uint32 cycleLengthInSeconds_,
uint16 periodLengthInCycles_,
IWhitelistedNftContract inventoryContract,
IERC20 revvContract,
uint256[] memory rarities,
uint64[] memory weights
) public NftStaking(cycleLengthInSeconds_, periodLengthInCycles_, inventoryContract, revvContract) {
require(rarities.length == weights.length, "NftStaking: wrong arguments");
for (uint256 i = 0; i < rarities.length; ++i) {
weightsByRarity[rarities[i]] = weights[i];
}
}
/**
* Verifes that the token is eligible and returns its associated weight.
* Throws if the token is not a 2019 Car NFT.
* @param nftId uint256 token identifier of the NFT.
* @return uint64 the weight of the NFT.
*/
function _validateAndGetNftWeight(uint256 nftId) internal virtual override view returns (uint64) {
// Ids bits layout specification:
// https://github.com/animocabrands/f1dt-core_metadata/blob/v0.1.1/src/constants.js
uint256 nonFungible = (nftId >> 255) & 1;
uint256 tokenType = (nftId >> 240) & 0xFF;
uint256 tokenSeason = (nftId >> 224) & 0xFF;
uint256 tokenRarity = (nftId >> 176) & 0xFF;
// For interpretation of values, refer to: https://github.com/animocabrands/f1dt-core_metadata/tree/v0.1.1/src/mappings
// Types: https://github.com/animocabrands/f1dt-core_metadata/blob/v0.1.1/src/mappings/Common/Types/NameById.js
// Seasons: https://github.com/animocabrands/f1dt-core_metadata/blob/v0.1.1/src/mappings/Common/Seasons/NameById.js
// Rarities: https://github.com/animocabrands/f1dt-core_metadata/blob/v0.1.1/src/mappings/Common/Rarities/TierByRarity.js
require(nonFungible == 1 && tokenType == 1 && tokenSeason == 2, "NftStaking: wrong token");
return weightsByRarity[tokenRarity];
}
}
// File contracts/Contracts.sol
pragma solidity 0.6.8;
// import "@animoca/ethereum-contracts-erc20_base/contracts/mocks/token/ERC20/ERC20Mock.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/token/ERC20/REVV.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/token/ERC1155721/DeltaTimeInventoryV2.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/metadata/DeltaTimeCoreMetadata.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/token/ERC1155721/NFTRepairCentre.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/sale/REVVSale.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/sale/QualifyingGameSale.sol";
// import "@animoca/f1dt-ethereum-contracts/contracts/token/ERC721/TrackTickets.sol";
{
"compilationTarget": {
"DeltaTimeStakingBeta.sol": "DeltaTimeStakingBeta"
},
"evmVersion": "istanbul",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 2000
},
"remappings": []
}
[{"inputs":[{"internalType":"uint32","name":"cycleLengthInSeconds_","type":"uint32"},{"internalType":"uint16","name":"periodLengthInCycles_","type":"uint16"},{"internalType":"contract IWhitelistedNftContract","name":"inventoryContract","type":"address"},{"internalType":"contract IERC20","name":"revvContract","type":"address"},{"internalType":"uint256[]","name":"rarities","type":"uint256[]"},{"internalType":"uint64[]","name":"weights","type":"uint64[]"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[],"name":"Disabled","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"staker","type":"address"},{"indexed":false,"internalType":"uint256","name":"startCycle","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"stakerStake","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"globalStake","type":"uint256"}],"name":"HistoriesUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"staker","type":"address"},{"indexed":false,"internalType":"uint256","name":"cycle","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"weight","type":"uint256"}],"name":"NftStaked","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"staker","type":"address"},{"indexed":false,"internalType":"uint256","name":"cycle","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"weight","type":"uint256"}],"name":"NftUnstaked","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"startPeriod","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"endPeriod","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"rewardsPerCycle","type":"uint256"}],"name":"RewardsAdded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"staker","type":"address"},{"indexed":false,"internalType":"uint256","name":"cycle","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"startPeriod","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"periods","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RewardsClaimed","type":"event"},{"anonymous":false,"inputs":[],"name":"Started","type":"event"},{"inputs":[{"internalType":"uint16","name":"startPeriod","type":"uint16"},{"internalType":"uint16","name":"endPeriod","type":"uint16"},{"internalType":"uint256","name":"rewardsPerCycle","type":"uint256"}],"name":"addRewardsForPeriods","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint16","name":"maxPeriods","type":"uint16"}],"name":"claimRewards","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"cycleLengthInSeconds","outputs":[{"internalType":"uint32","name":"","type":"uint32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"disable","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"enabled","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint16","name":"maxPeriods","type":"uint16"}],"name":"estimateRewards","outputs":[{"internalType":"uint16","name":"startPeriod","type":"uint16"},{"internalType":"uint16","name":"periods","type":"uint16"},{"internalType":"uint256","name":"amount","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getCurrentCycle","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getCurrentPeriod","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"globalHistory","outputs":[{"internalType":"uint128","name":"stake","type":"uint128"},{"internalType":"uint128","name":"startCycle","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lastGlobalSnapshotIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"staker","type":"address"}],"name":"lastStakerSnapshotIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"nextClaims","outputs":[{"internalType":"uint16","name":"period","type":"uint16"},{"internalType":"uint64","name":"globalSnapshotIndex","type":"uint64"},{"internalType":"uint64","name":"stakerSnapshotIndex","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"from","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155BatchReceived","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"from","type":"address"},{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"periodLengthInCycles","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"rewardsSchedule","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"rewardsTokenContract","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"stakerHistories","outputs":[{"internalType":"uint128","name":"stake","type":"uint128"},{"internalType":"uint128","name":"startCycle","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"start","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"startTimestamp","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"tokenInfos","outputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint64","name":"weight","type":"uint64"},{"internalType":"uint16","name":"depositCycle","type":"uint16"},{"internalType":"uint16","name":"withdrawCycle","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalRewardsPool","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"unstakeNft","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"weightsByRarity","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"whitelistedNftContract","outputs":[{"internalType":"contract IWhitelistedNftContract","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"withdrawRewardsPool","outputs":[],"stateMutability":"nonpayable","type":"function"}]