Contract Name:
ERC20StakingModuleFactory
Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/draft-IERC20Permit.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "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");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
/*
ERC20StakingModule
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./interfaces/IStakingModule.sol";
import "./OwnerController.sol";
import "./TokenUtils.sol";
/**
* @title ERC20 staking module
*
* @notice this staking module allows users to deposit an amount of ERC20 token
* in exchange for shares credited to their address. When the user
* unstakes, these shares will be burned and a reward will be distributed.
*/
contract ERC20StakingModule is IStakingModule, OwnerController {
using SafeERC20 for IERC20;
using TokenUtils for IERC20;
// events
event Approval(address indexed user, address indexed operator, bool value);
// members
IERC20 private immutable _token;
address private immutable _factory;
mapping(address => uint256) public shares;
uint256 public totalShares;
mapping(address => mapping(address => bool)) public approvals;
/**
* @param token_ the token that will be staked
* @param factory_ address of module factory
*/
constructor(address token_, address factory_) {
require(token_ != address(0));
_token = IERC20(token_);
_factory = factory_;
}
/**
* @inheritdoc IStakingModule
*/
function tokens()
external
view
override
returns (address[] memory tokens_)
{
tokens_ = new address[](1);
tokens_[0] = address(_token);
}
/**
* @inheritdoc IStakingModule
*/
function balances(
address user
) external view override returns (uint256[] memory balances_) {
balances_ = new uint256[](1);
balances_[0] = _balance(user);
}
/**
* @inheritdoc IStakingModule
*/
function factory() external view override returns (address) {
return _factory;
}
/**
* @inheritdoc IStakingModule
*/
function totals()
external
view
override
returns (uint256[] memory totals_)
{
totals_ = new uint256[](1);
totals_[0] = _token.balanceOf(address(this));
}
/**
* @inheritdoc IStakingModule
*/
function stake(
address sender,
uint256 amount,
bytes calldata data
) external override onlyOwner returns (bytes32, uint256) {
// validate
require(amount > 0, "sm1");
address account = _account(sender, data);
// transfer
uint256 minted = _token.receiveAmount(totalShares, sender, amount);
// update user staking info
shares[account] += minted;
// add newly minted shares to global total
totalShares += minted;
bytes32 account_ = bytes32(uint256(uint160(account)));
emit Staked(account_, sender, address(_token), amount, minted);
return (account_, minted);
}
/**
* @inheritdoc IStakingModule
*/
function unstake(
address sender,
uint256 amount,
bytes calldata data
) external override onlyOwner returns (bytes32, address, uint256) {
// validate and get shares
address account = _account(sender, data);
uint256 burned = _shares(account, amount);
// burn shares
totalShares -= burned;
shares[account] -= burned;
// unstake
_token.safeTransfer(sender, amount);
bytes32 account_ = bytes32(uint256(uint160(account)));
emit Unstaked(account_, sender, address(_token), amount, burned);
return (account_, sender, burned);
}
/**
* @inheritdoc IStakingModule
*/
function claim(
address sender,
uint256 amount,
bytes calldata data
) external override onlyOwner returns (bytes32, address, uint256) {
address account = _account(sender, data);
uint256 s = _shares(account, amount);
bytes32 account_ = bytes32(uint256(uint160(account)));
emit Claimed(account_, sender, address(_token), amount, s);
return (account_, sender, s);
}
/**
* @inheritdoc IStakingModule
*/
function update(
address sender,
bytes calldata data
) external view override returns (bytes32) {
return (bytes32(uint256(uint160(_account(sender, data)))));
}
/**
* @inheritdoc IStakingModule
*/
function clean(bytes calldata) external override {}
/**
* @notice set approval for operators to act on user position
* @param operator address of operator
* @param value boolean to grant or revoke approval
*/
function approve(address operator, bool value) external {
approvals[msg.sender][operator] = value;
emit Approval(msg.sender, operator, value);
}
/**
* @dev internal helper to get user balance
* @param user address of interest
*/
function _balance(address user) private view returns (uint256) {
return _token.getAmount(totalShares, shares[user]);
}
/**
* @dev internal helper to validate and convert user stake amount to shares
* @param user address of user
* @param amount number of tokens to consider
* @return shares_ equivalent number of shares
*/
function _shares(
address user,
uint256 amount
) private view returns (uint256 shares_) {
// validate
require(amount > 0, "sm3");
require(totalShares > 0, "sm4");
// convert token amount to shares
shares_ = _token.getShares(totalShares, amount);
require(shares_ > 0, "sm5");
require(shares[user] >= shares_, "sm6");
}
/**
* @dev internal helper to get account and validate approval
* @param sender address of sender
* @param data either empty bytes or encoded account address
*/
function _account(
address sender,
bytes calldata data
) private view returns (address) {
require(data.length == 0 || data.length == 32, "sm7");
if (data.length > 0) {
address account;
assembly {
account := calldataload(132)
}
require(approvals[account][sender], "sm8");
return account;
} else {
return sender;
}
}
}
/*
ERC20StakingModuleFactory
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
import "./interfaces/IModuleFactory.sol";
import "./ERC20StakingModule.sol";
/**
* @title ERC20 staking module factory
*
* @notice this factory contract handles deployment for the
* ERC20StakingModule contract
*
* @dev it is called by the parent PoolFactory and is responsible
* for parsing constructor arguments before creating a new contract
*/
contract ERC20StakingModuleFactory is IModuleFactory {
/**
* @inheritdoc IModuleFactory
*/
function createModule(address, bytes calldata data)
external
override
returns (address)
{
// validate
require(data.length == 32, "smf1");
// parse staking token
address token;
assembly {
token := calldataload(100)
}
// create module
ERC20StakingModule module =
new ERC20StakingModule(token, address(this));
module.transferOwnership(msg.sender);
// output
emit ModuleCreated(msg.sender, address(module));
return address(module);
}
}
/*
IEvents
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
/**
* @title GYSR event system
*
* @notice common interface to define GYSR event system
*/
interface IEvents {
// staking
event Staked(
bytes32 indexed account,
address indexed user,
address indexed token,
uint256 amount,
uint256 shares
);
event Unstaked(
bytes32 indexed account,
address indexed user,
address indexed token,
uint256 amount,
uint256 shares
);
event Claimed(
bytes32 indexed account,
address indexed user,
address indexed token,
uint256 amount,
uint256 shares
);
event Updated(bytes32 indexed account, address indexed user);
// rewards
event RewardsDistributed(
address indexed user,
address indexed token,
uint256 amount,
uint256 shares
);
event RewardsFunded(
address indexed token,
uint256 amount,
uint256 shares,
uint256 timestamp
);
event RewardsExpired(
address indexed token,
uint256 amount,
uint256 shares,
uint256 timestamp
);
event RewardsWithdrawn(
address indexed token,
uint256 amount,
uint256 shares,
uint256 timestamp
);
event RewardsUpdated(bytes32 indexed account);
// gysr
event GysrSpent(address indexed user, uint256 amount);
event GysrVested(address indexed user, uint256 amount);
event GysrWithdrawn(uint256 amount);
event Fee(address indexed receiver, address indexed token, uint256 amount);
}
/*
IModuleFactory
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
/**
* @title Module factory interface
*
* @notice this defines the common module factory interface used by the
* main factory to create the staking and reward modules for a new Pool.
*/
interface IModuleFactory {
// events
event ModuleCreated(address indexed user, address module);
/**
* @notice create a new Pool module
* @param config address for configuration contract
* @param data binary encoded construction parameters
* @return address of newly created module
*/
function createModule(address config, bytes calldata data)
external
returns (address);
}
/*
IOwnerController
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
/**
* @title Owner controller interface
*
* @notice this defines the interface for any contracts that use the
* owner controller access pattern
*/
interface IOwnerController {
/**
* @dev Returns the address of the current owner.
*/
function owner() external view returns (address);
/**
* @dev Returns the address of the current controller.
*/
function controller() external view returns (address);
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`). This can
* include renouncing ownership by transferring to the zero address.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) external;
/**
* @dev Transfers control of the contract to a new account (`newController`).
* Can only be called by the owner.
*/
function transferControl(address newController) external;
}
/*
IStakingModule
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "./IEvents.sol";
import "./IOwnerController.sol";
/**
* @title Staking module interface
*
* @notice this contract defines the common interface that any staking module
* must implement to be compatible with the modular Pool architecture.
*/
interface IStakingModule is IOwnerController, IEvents {
/**
* @return array of staking tokens
*/
function tokens() external view returns (address[] memory);
/**
* @notice get balance of user
* @param user address of user
* @return balances of each staking token
*/
function balances(address user) external view returns (uint256[] memory);
/**
* @return address of module factory
*/
function factory() external view returns (address);
/**
* @notice get total staked amount
* @return totals for each staking token
*/
function totals() external view returns (uint256[] memory);
/**
* @notice stake an amount of tokens for user
* @param sender address of sender
* @param amount number of tokens to stake
* @param data additional data
* @return bytes32 id of staking account
* @return number of shares minted for stake
*/
function stake(
address sender,
uint256 amount,
bytes calldata data
) external returns (bytes32, uint256);
/**
* @notice unstake an amount of tokens for user
* @param sender address of sender
* @param amount number of tokens to unstake
* @param data additional data
* @return bytes32 id of staking account
* @return address of reward receiver
* @return number of shares burned for unstake
*/
function unstake(
address sender,
uint256 amount,
bytes calldata data
) external returns (bytes32, address, uint256);
/**
* @notice quote the share value for an amount of tokens without unstaking
* @param sender address of sender
* @param amount number of tokens to claim with
* @param data additional data
* @return bytes32 id of staking account
* @return address of reward receiver
* @return number of shares that the claim amount is worth
*/
function claim(
address sender,
uint256 amount,
bytes calldata data
) external returns (bytes32, address, uint256);
/**
* @notice method called by anyone to update accounting
* @dev will only be called ad hoc and should not contain essential logic
* @param sender address of user for update
* @param data additional data
* @return bytes32 id of staking account
*/
function update(
address sender,
bytes calldata data
) external returns (bytes32);
/**
* @notice method called by owner to clean up and perform additional accounting
* @dev will only be called ad hoc and should not contain any essential logic
* @param data additional data
*/
function clean(bytes calldata data) external;
}
/*
OwnerController
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
import "./interfaces/IOwnerController.sol";
/**
* @title Owner controller
*
* @notice this base contract implements an owner-controller access model.
*
* @dev the contract is an adapted version of the OpenZeppelin Ownable contract.
* It allows the owner to designate an additional account as the controller to
* perform restricted operations.
*
* Other changes include supporting role verification with a require method
* in addition to the modifier option, and removing some unneeded functionality.
*
* Original contract here:
* https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/access/Ownable.sol
*/
contract OwnerController is IOwnerController {
address private _owner;
address private _controller;
event OwnershipTransferred(
address indexed previousOwner,
address indexed newOwner
);
event ControlTransferred(
address indexed previousController,
address indexed newController
);
constructor() {
_owner = msg.sender;
_controller = msg.sender;
emit OwnershipTransferred(address(0), _owner);
emit ControlTransferred(address(0), _owner);
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view override returns (address) {
return _owner;
}
/**
* @dev Returns the address of the current controller.
*/
function controller() public view override returns (address) {
return _controller;
}
/**
* @dev Modifier that throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(_owner == msg.sender, "oc1");
_;
}
/**
* @dev Modifier that throws if called by any account other than the controller.
*/
modifier onlyController() {
require(_controller == msg.sender, "oc2");
_;
}
/**
* @dev Throws if called by any account other than the owner.
*/
function requireOwner() internal view {
require(_owner == msg.sender, "oc1");
}
/**
* @dev Throws if called by any account other than the controller.
*/
function requireController() internal view {
require(_controller == msg.sender, "oc2");
}
/**
* @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 override {
requireOwner();
require(newOwner != address(0), "oc3");
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
/**
* @dev Transfers control of the contract to a new account (`newController`).
* Can only be called by the owner.
*/
function transferControl(address newController) public virtual override {
requireOwner();
require(newController != address(0), "oc4");
emit ControlTransferred(_controller, newController);
_controller = newController;
}
}
/*
TokenUtils
https://github.com/gysr-io/core
SPDX-License-Identifier: MIT
*/
pragma solidity 0.8.18;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
/**
* @title Token utilities
*
* @notice this library implements utility methods for token handling,
* dynamic balance accounting, and fee processing
*/
library TokenUtils {
using SafeERC20 for IERC20;
event Fee(address indexed receiver, address indexed token, uint256 amount); // redefinition
uint256 constant INITIAL_SHARES_PER_TOKEN = 1e6;
uint256 constant FLOOR_SHARES_PER_TOKEN = 1e3;
/**
* @notice get token shares from amount
* @param token erc20 token interface
* @param total current total shares
* @param amount balance of tokens
*/
function getShares(
IERC20 token,
uint256 total,
uint256 amount
) internal view returns (uint256) {
if (total == 0) return 0;
uint256 balance = token.balanceOf(address(this));
if (total < balance * FLOOR_SHARES_PER_TOKEN)
return amount * FLOOR_SHARES_PER_TOKEN;
return (total * amount) / balance;
}
/**
* @notice get token amount from shares
* @param token erc20 token interface
* @param total current total shares
* @param shares balance of shares
*/
function getAmount(
IERC20 token,
uint256 total,
uint256 shares
) internal view returns (uint256) {
if (total == 0) return 0;
uint256 balance = token.balanceOf(address(this));
if (total < balance * FLOOR_SHARES_PER_TOKEN)
return shares / FLOOR_SHARES_PER_TOKEN;
return (balance * shares) / total;
}
/**
* @notice transfer tokens from sender into contract and convert to shares
* for internal accounting
* @param token erc20 token interface
* @param total current total shares
* @param sender token sender
* @param amount number of tokens to be sent
*/
function receiveAmount(
IERC20 token,
uint256 total,
address sender,
uint256 amount
) internal returns (uint256) {
// note: we assume amount > 0 has already been validated
// transfer
uint256 balance = token.balanceOf(address(this));
token.safeTransferFrom(sender, address(this), amount);
uint256 actual = token.balanceOf(address(this)) - balance;
require(amount >= actual);
// mint shares at current rate
uint256 minted;
if (total == 0) {
minted = actual * INITIAL_SHARES_PER_TOKEN;
} else if (total < balance * FLOOR_SHARES_PER_TOKEN) {
minted = actual * FLOOR_SHARES_PER_TOKEN;
} else {
minted = (total * actual) / balance;
}
require(minted > 0);
return minted;
}
/**
* @notice transfer tokens from sender into contract, process protocol fee,
* and convert to shares for internal accounting
* @param token erc20 token interface
* @param total current total shares
* @param sender token sender
* @param amount number of tokens to be sent
* @param feeReceiver address to receive fee
* @param feeRate portion of amount to take as fee in 18 decimals
*/
function receiveWithFee(
IERC20 token,
uint256 total,
address sender,
uint256 amount,
address feeReceiver,
uint256 feeRate
) internal returns (uint256) {
// note: we assume amount > 0 has already been validated
// check initial token balance
uint256 balance = token.balanceOf(address(this));
// process fee
uint256 fee;
if (feeReceiver != address(0) && feeRate > 0 && feeRate < 1e18) {
fee = (amount * feeRate) / 1e18;
token.safeTransferFrom(sender, feeReceiver, fee);
emit Fee(feeReceiver, address(token), fee);
}
// do transfer
token.safeTransferFrom(sender, address(this), amount - fee);
uint256 actual = token.balanceOf(address(this)) - balance;
require(amount >= actual);
// mint shares at current rate
uint256 minted;
if (total == 0) {
minted = actual * INITIAL_SHARES_PER_TOKEN;
} else if (total < balance * FLOOR_SHARES_PER_TOKEN) {
minted = actual * FLOOR_SHARES_PER_TOKEN;
} else {
minted = (total * actual) / balance;
}
require(minted > 0);
return minted;
}
}