// Sources flattened with hardhat v2.16.1 https://hardhat.org
// File @openzeppelin/contracts/utils/Context.sol@v4.7.0
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// File @openzeppelin/contracts/access/Ownable.sol@v4.7.0
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^0.8.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.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// File @openzeppelin/contracts/token/ERC20/IERC20.sol@v4.7.0
// 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);
}
// File @openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol@v4.7.0
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// File @openzeppelin/contracts/token/ERC20/ERC20.sol@v4.7.0
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20 is Context, IERC20, IERC20Metadata {
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* The default value of {decimals} is 18. To select a different value for
* {decimals} you should overload it.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the value {ERC20} uses, unless this function is
* overridden;
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual override returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address to, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_transfer(owner, to, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual override returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
* - the caller must have allowance for ``from``'s tokens of at least
* `amount`.
*/
function transferFrom(
address from,
address to,
uint256 amount
) public virtual override returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, amount);
_transfer(from, to, amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, spender) + addedValue);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @dev Moves `amount` of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
*/
function _transfer(
address from,
address to,
uint256 amount
) internal virtual {
require(from != address(0), "ERC20: transfer from the zero address");
require(to != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(from, to, amount);
uint256 fromBalance = _balances[from];
require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
unchecked {
_balances[from] = fromBalance - amount;
}
_balances[to] += amount;
emit Transfer(from, to, amount);
_afterTokenTransfer(from, to, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
_balances[account] += amount;
emit Transfer(address(0), account, amount);
_afterTokenTransfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
unchecked {
_balances[account] = accountBalance - amount;
}
_totalSupply -= amount;
emit Transfer(account, address(0), amount);
_afterTokenTransfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(
address owner,
address spender,
uint256 amount
) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - amount);
}
}
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* has been transferred to `to`.
* - when `from` is zero, `amount` tokens have been minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens have been burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
}
// File @openzeppelin/contracts/token/ERC20/extensions/draft-IERC20Permit.sol@v4.7.0
// 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);
}
// File @openzeppelin/contracts/utils/Address.sol@v4.7.0
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// File @openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol@v4.7.0
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
/**
* @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");
}
}
}
// File @openzeppelin/contracts/security/ReentrancyGuard.sol@v4.7.0
// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
// On the first call to nonReentrant, _notEntered will be true
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
// File @openzeppelin/contracts/utils/structs/EnumerableSet.sol@v4.7.0
// OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol)
pragma solidity ^0.8.0;
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*
* [WARNING]
* ====
* Trying to delete such a structure from storage will likely result in data corruption, rendering the structure unusable.
* See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
*
* In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an array of EnumerableSet.
* ====
*/
library EnumerableSet {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position of the value in the `values` array, plus 1 because index 0
// means a value is not in the set.
mapping(bytes32 => uint256) _indexes;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._indexes[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We read and store the value's index to prevent multiple reads from the same storage slot
uint256 valueIndex = set._indexes[value];
if (valueIndex != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 toDeleteIndex = valueIndex - 1;
uint256 lastIndex = set._values.length - 1;
if (lastIndex != toDeleteIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the last value to the index where the value to delete is
set._values[toDeleteIndex] = lastValue;
// Update the index for the moved value
set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the index for the deleted slot
delete set._indexes[value];
return true;
} else {
return false;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._indexes[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
return _values(set._inner);
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
/// @solidity memory-safe-assembly
assembly {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
/// @solidity memory-safe-assembly
assembly {
result := store
}
return result;
}
}
// File contracts/interfaces/IIFBridgableStakeWeight.sol
pragma solidity ^0.8.9;
interface IIFBridgableStakeWeight {
enum BridgeType {
UserWeight,
TotalWeight
}
struct MessageRequest {
// user address
address[] users;
// timestamp value
uint80 timestamp;
// bridge type
BridgeType bridgeType;
// track number
uint24 trackId;
// amount of weight at timestamp
uint192[] weights;
}
}
// File contracts/interfaces/IIFRetrievableStakeWeight.sol
pragma solidity ^0.8.9;
interface IIFRetrievableStakeWeight {
function getTotalStakeWeight(uint24 trackId, uint80 timestamp)
external
view
returns (uint192);
function getUserStakeWeight(
uint24 trackId,
address user,
uint80 timestamp
) external view returns (uint192);
}
// File sgn-v2-contracts/contracts/interfaces/IBridge.sol@v0.2.0
pragma solidity >=0.8.0;
interface IBridge {
function send(
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
uint32 _maxSlippage
) external;
function relay(
bytes calldata _relayRequest,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external;
function transfers(bytes32 transferId) external view returns (bool);
function withdraws(bytes32 withdrawId) external view returns (bool);
function withdraw(
bytes calldata _wdmsg,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external;
/**
* @notice Verifies that a message is signed by a quorum among the signers.
* @param _msg signed message
* @param _sigs list of signatures sorted by signer addresses in ascending order
* @param _signers sorted list of current signers
* @param _powers powers of current signers
*/
function verifySigs(
bytes memory _msg,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external view;
}
// File sgn-v2-contracts/contracts/interfaces/IOriginalTokenVault.sol@v0.2.0
pragma solidity >=0.8.0;
interface IOriginalTokenVault {
/**
* @notice Lock original tokens to trigger mint at a remote chain's PeggedTokenBridge
* @param _token local token address
* @param _amount locked token amount
* @param _mintChainId destination chainId to mint tokens
* @param _mintAccount destination account to receive minted tokens
* @param _nonce user input to guarantee unique depositId
*/
function deposit(
address _token,
uint256 _amount,
uint64 _mintChainId,
address _mintAccount,
uint64 _nonce
) external;
/**
* @notice Withdraw locked original tokens triggered by a burn at a remote chain's PeggedTokenBridge.
* @param _request The serialized Withdraw protobuf.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the bridge's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function withdraw(
bytes calldata _request,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external;
function records(bytes32 recordId) external view returns (bool);
}
// File sgn-v2-contracts/contracts/interfaces/IOriginalTokenVaultV2.sol@v0.2.0
pragma solidity >=0.8.0;
interface IOriginalTokenVaultV2 {
/**
* @notice Lock original tokens to trigger mint at a remote chain's PeggedTokenBridge
* @param _token local token address
* @param _amount locked token amount
* @param _mintChainId destination chainId to mint tokens
* @param _mintAccount destination account to receive minted tokens
* @param _nonce user input to guarantee unique depositId
*/
function deposit(
address _token,
uint256 _amount,
uint64 _mintChainId,
address _mintAccount,
uint64 _nonce
) external returns (bytes32);
/**
* @notice Withdraw locked original tokens triggered by a burn at a remote chain's PeggedTokenBridge.
* @param _request The serialized Withdraw protobuf.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the bridge's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function withdraw(
bytes calldata _request,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external returns (bytes32);
function records(bytes32 recordId) external view returns (bool);
}
// File sgn-v2-contracts/contracts/interfaces/IPeggedTokenBridge.sol@v0.2.0
pragma solidity >=0.8.0;
interface IPeggedTokenBridge {
/**
* @notice Burn tokens to trigger withdrawal at a remote chain's OriginalTokenVault
* @param _token local token address
* @param _amount locked token amount
* @param _withdrawAccount account who withdraw original tokens on the remote chain
* @param _nonce user input to guarantee unique depositId
*/
function burn(
address _token,
uint256 _amount,
address _withdrawAccount,
uint64 _nonce
) external;
/**
* @notice Mint tokens triggered by deposit at a remote chain's OriginalTokenVault.
* @param _request The serialized Mint protobuf.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function mint(
bytes calldata _request,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external;
function records(bytes32 recordId) external view returns (bool);
}
// File sgn-v2-contracts/contracts/interfaces/IPeggedTokenBridgeV2.sol@v0.2.0
pragma solidity >=0.8.0;
interface IPeggedTokenBridgeV2 {
/**
* @notice Burn pegged tokens to trigger a cross-chain withdrawal of the original tokens at a remote chain's
* OriginalTokenVault, or mint at another remote chain
* @param _token The pegged token address.
* @param _amount The amount to burn.
* @param _toChainId If zero, withdraw from original vault; otherwise, the remote chain to mint tokens.
* @param _toAccount The account to receive tokens on the remote chain
* @param _nonce A number to guarantee unique depositId. Can be timestamp in practice.
*/
function burn(
address _token,
uint256 _amount,
uint64 _toChainId,
address _toAccount,
uint64 _nonce
) external returns (bytes32);
// same with `burn` above, use openzeppelin ERC20Burnable interface
function burnFrom(
address _token,
uint256 _amount,
uint64 _toChainId,
address _toAccount,
uint64 _nonce
) external returns (bytes32);
/**
* @notice Mint tokens triggered by deposit at a remote chain's OriginalTokenVault.
* @param _request The serialized Mint protobuf.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function mint(
bytes calldata _request,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external returns (bytes32);
function records(bytes32 recordId) external view returns (bool);
}
// File sgn-v2-contracts/contracts/message/libraries/MsgDataTypes.sol@v0.2.0
pragma solidity 0.8.9;
library MsgDataTypes {
// bridge operation type at the sender side (src chain)
enum BridgeSendType {
Null,
Liquidity,
PegDeposit,
PegBurn,
PegV2Deposit,
PegV2Burn,
PegV2BurnFrom
}
// bridge operation type at the receiver side (dst chain)
enum TransferType {
Null,
LqRelay, // relay through liquidity bridge
LqWithdraw, // withdraw from liquidity bridge
PegMint, // mint through pegged token bridge
PegWithdraw, // withdraw from original token vault
PegV2Mint, // mint through pegged token bridge v2
PegV2Withdraw // withdraw from original token vault v2
}
enum MsgType {
MessageWithTransfer,
MessageOnly
}
enum TxStatus {
Null,
Success,
Fail,
Fallback,
Pending // transient state within a transaction
}
struct TransferInfo {
TransferType t;
address sender;
address receiver;
address token;
uint256 amount;
uint64 wdseq; // only needed for LqWithdraw (refund)
uint64 srcChainId;
bytes32 refId;
bytes32 srcTxHash; // src chain msg tx hash
}
struct RouteInfo {
address sender;
address receiver;
uint64 srcChainId;
bytes32 srcTxHash; // src chain msg tx hash
}
struct MsgWithTransferExecutionParams {
bytes message;
TransferInfo transfer;
bytes[] sigs;
address[] signers;
uint256[] powers;
}
struct BridgeTransferParams {
bytes request;
bytes[] sigs;
address[] signers;
uint256[] powers;
}
}
// File sgn-v2-contracts/contracts/message/interfaces/IMessageBus.sol@v0.2.0
pragma solidity >=0.8.0;
interface IMessageBus {
function liquidityBridge() external view returns (address);
function pegBridge() external view returns (address);
function pegBridgeV2() external view returns (address);
function pegVault() external view returns (address);
function pegVaultV2() external view returns (address);
/**
* @notice Calculates the required fee for the message.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
@ @return The required fee.
*/
function calcFee(bytes calldata _message) external view returns (uint256);
/**
* @notice Sends a message to an app on another chain via MessageBus without an associated transfer.
* A fee is charged in the native gas token.
* @param _receiver The address of the destination app contract.
* @param _dstChainId The destination chain ID.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
*/
function sendMessage(
address _receiver,
uint256 _dstChainId,
bytes calldata _message
) external payable;
/**
* @notice Sends a message associated with a transfer to an app on another chain via MessageBus without an associated transfer.
* A fee is charged in the native token.
* @param _receiver The address of the destination app contract.
* @param _dstChainId The destination chain ID.
* @param _srcBridge The bridge contract to send the transfer with.
* @param _srcTransferId The transfer ID.
* @param _dstChainId The destination chain ID.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
*/
function sendMessageWithTransfer(
address _receiver,
uint256 _dstChainId,
address _srcBridge,
bytes32 _srcTransferId,
bytes calldata _message
) external payable;
/**
* @notice Withdraws message fee in the form of native gas token.
* @param _account The address receiving the fee.
* @param _cumulativeFee The cumulative fee credited to the account. Tracked by SGN.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A withdrawal must be
* signed-off by +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function withdrawFee(
address _account,
uint256 _cumulativeFee,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external;
/**
* @notice Execute a message with a successful transfer.
* @param _message Arbitrary message bytes originated from and encoded by the source app contract
* @param _transfer The transfer info.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function executeMessageWithTransfer(
bytes calldata _message,
MsgDataTypes.TransferInfo calldata _transfer,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external payable;
/**
* @notice Execute a message with a refunded transfer.
* @param _message Arbitrary message bytes originated from and encoded by the source app contract
* @param _transfer The transfer info.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function executeMessageWithTransferRefund(
bytes calldata _message, // the same message associated with the original transfer
MsgDataTypes.TransferInfo calldata _transfer,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external payable;
/**
* @notice Execute a message not associated with a transfer.
* @param _message Arbitrary message bytes originated from and encoded by the source app contract
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A relay must be signed-off by
* +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function executeMessage(
bytes calldata _message,
MsgDataTypes.RouteInfo calldata _route,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external payable;
}
// File sgn-v2-contracts/contracts/message/libraries/MessageSenderLib.sol@v0.2.0
pragma solidity >=0.8.0;
library MessageSenderLib {
using SafeERC20 for IERC20;
// ============== Internal library functions called by apps ==============
/**
* @notice Sends a message to an app on another chain via MessageBus without an associated transfer.
* @param _receiver The address of the destination app contract.
* @param _dstChainId The destination chain ID.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
* @param _messageBus The address of the MessageBus on this chain.
* @param _fee The fee amount to pay to MessageBus.
*/
function sendMessage(
address _receiver,
uint64 _dstChainId,
bytes memory _message,
address _messageBus,
uint256 _fee
) internal {
IMessageBus(_messageBus).sendMessage{value: _fee}(_receiver, _dstChainId, _message);
}
/**
* @notice Sends a message to an app on another chain via MessageBus with an associated transfer.
* @param _receiver The address of the destination app contract.
* @param _token The address of the token to be sent.
* @param _amount The amount of tokens to be sent.
* @param _dstChainId The destination chain ID.
* @param _nonce A number input to guarantee uniqueness of transferId. Can be timestamp in practice.
* @param _maxSlippage The max slippage accepted, given as percentage in point (pip). Eg. 5000 means 0.5%.
* Must be greater than minimalMaxSlippage. Receiver is guaranteed to receive at least (100% - max slippage percentage) * amount or the
* transfer can be refunded. Only applicable to the {MsgDataTypes.BridgeSendType.Liquidity}.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
* @param _bridgeSendType One of the {MsgDataTypes.BridgeSendType} enum.
* @param _messageBus The address of the MessageBus on this chain.
* @param _fee The fee amount to pay to MessageBus.
* @return The transfer ID.
*/
function sendMessageWithTransfer(
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
uint32 _maxSlippage,
bytes memory _message,
MsgDataTypes.BridgeSendType _bridgeSendType,
address _messageBus,
uint256 _fee
) internal returns (bytes32) {
if (_bridgeSendType == MsgDataTypes.BridgeSendType.Liquidity) {
return
sendMessageWithLiquidityBridgeTransfer(
_receiver,
_token,
_amount,
_dstChainId,
_nonce,
_maxSlippage,
_message,
_messageBus,
_fee
);
} else if (
_bridgeSendType == MsgDataTypes.BridgeSendType.PegDeposit ||
_bridgeSendType == MsgDataTypes.BridgeSendType.PegV2Deposit
) {
return
sendMessageWithPegVaultDeposit(
_bridgeSendType,
_receiver,
_token,
_amount,
_dstChainId,
_nonce,
_message,
_messageBus,
_fee
);
} else if (
_bridgeSendType == MsgDataTypes.BridgeSendType.PegBurn ||
_bridgeSendType == MsgDataTypes.BridgeSendType.PegV2Burn
) {
return
sendMessageWithPegBridgeBurn(
_bridgeSendType,
_receiver,
_token,
_amount,
_dstChainId,
_nonce,
_message,
_messageBus,
_fee
);
} else {
revert("bridge type not supported");
}
}
/**
* @notice Sends a message to an app on another chain via MessageBus with an associated liquidity bridge transfer.
* @param _receiver The address of the destination app contract.
* @param _token The address of the token to be sent.
* @param _amount The amount of tokens to be sent.
* @param _dstChainId The destination chain ID.
* @param _nonce A number input to guarantee uniqueness of transferId. Can be timestamp in practice.
* @param _maxSlippage The max slippage accepted, given as percentage in point (pip). Eg. 5000 means 0.5%.
* Must be greater than minimalMaxSlippage. Receiver is guaranteed to receive at least (100% - max slippage percentage) * amount or the
* transfer can be refunded.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
* @param _messageBus The address of the MessageBus on this chain.
* @param _fee The fee amount to pay to MessageBus.
* @return The transfer ID.
*/
function sendMessageWithLiquidityBridgeTransfer(
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
uint32 _maxSlippage,
bytes memory _message,
address _messageBus,
uint256 _fee
) internal returns (bytes32) {
address bridge = IMessageBus(_messageBus).liquidityBridge();
IERC20(_token).safeIncreaseAllowance(bridge, _amount);
IBridge(bridge).send(_receiver, _token, _amount, _dstChainId, _nonce, _maxSlippage);
bytes32 transferId = keccak256(
abi.encodePacked(address(this), _receiver, _token, _amount, _dstChainId, _nonce, uint64(block.chainid))
);
IMessageBus(_messageBus).sendMessageWithTransfer{value: _fee}(
_receiver,
_dstChainId,
bridge,
transferId,
_message
);
return transferId;
}
/**
* @notice Sends a message to an app on another chain via MessageBus with an associated OriginalTokenVault deposit.
* @param _receiver The address of the destination app contract.
* @param _token The address of the token to be sent.
* @param _amount The amount of tokens to be sent.
* @param _dstChainId The destination chain ID.
* @param _nonce A number input to guarantee uniqueness of transferId. Can be timestamp in practice.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
* @param _messageBus The address of the MessageBus on this chain.
* @param _fee The fee amount to pay to MessageBus.
* @return The transfer ID.
*/
function sendMessageWithPegVaultDeposit(
MsgDataTypes.BridgeSendType _bridgeSendType,
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
bytes memory _message,
address _messageBus,
uint256 _fee
) internal returns (bytes32) {
address pegVault;
if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegDeposit) {
pegVault = IMessageBus(_messageBus).pegVault();
} else {
pegVault = IMessageBus(_messageBus).pegVaultV2();
}
IERC20(_token).safeIncreaseAllowance(pegVault, _amount);
bytes32 transferId;
if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegDeposit) {
IOriginalTokenVault(pegVault).deposit(_token, _amount, _dstChainId, _receiver, _nonce);
transferId = keccak256(
abi.encodePacked(address(this), _token, _amount, _dstChainId, _receiver, _nonce, uint64(block.chainid))
);
} else {
transferId = IOriginalTokenVaultV2(pegVault).deposit(_token, _amount, _dstChainId, _receiver, _nonce);
}
IMessageBus(_messageBus).sendMessageWithTransfer{value: _fee}(
_receiver,
_dstChainId,
pegVault,
transferId,
_message
);
return transferId;
}
/**
* @notice Sends a message to an app on another chain via MessageBus with an associated PeggedTokenBridge burn.
* @param _receiver The address of the destination app contract.
* @param _token The address of the token to be sent.
* @param _amount The amount of tokens to be sent.
* @param _dstChainId The destination chain ID.
* @param _nonce A number input to guarantee uniqueness of transferId. Can be timestamp in practice.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
* @param _messageBus The address of the MessageBus on this chain.
* @param _fee The fee amount to pay to MessageBus.
* @return The transfer ID.
*/
function sendMessageWithPegBridgeBurn(
MsgDataTypes.BridgeSendType _bridgeSendType,
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
bytes memory _message,
address _messageBus,
uint256 _fee
) internal returns (bytes32) {
address pegBridge;
if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegBurn) {
pegBridge = IMessageBus(_messageBus).pegBridge();
} else {
pegBridge = IMessageBus(_messageBus).pegBridgeV2();
}
IERC20(_token).safeIncreaseAllowance(pegBridge, _amount);
bytes32 transferId;
if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegBurn) {
IPeggedTokenBridge(pegBridge).burn(_token, _amount, _receiver, _nonce);
transferId = keccak256(
abi.encodePacked(address(this), _token, _amount, _receiver, _nonce, uint64(block.chainid))
);
} else {
transferId = IPeggedTokenBridgeV2(pegBridge).burn(_token, _amount, _dstChainId, _receiver, _nonce);
}
// handle cases where certain tokens do not spend allowance for role-based burn
IERC20(_token).safeApprove(pegBridge, 0);
IMessageBus(_messageBus).sendMessageWithTransfer{value: _fee}(
_receiver,
_dstChainId,
pegBridge,
transferId,
_message
);
return transferId;
}
/**
* @notice Sends a token transfer via a bridge.
* @param _receiver The address of the destination app contract.
* @param _token The address of the token to be sent.
* @param _amount The amount of tokens to be sent.
* @param _dstChainId The destination chain ID.
* @param _nonce A number input to guarantee uniqueness of transferId. Can be timestamp in practice.
* @param _maxSlippage The max slippage accepted, given as percentage in point (pip). Eg. 5000 means 0.5%.
* Must be greater than minimalMaxSlippage. Receiver is guaranteed to receive at least (100% - max slippage percentage) * amount or the
* transfer can be refunded.
* @param _bridgeSendType One of the {MsgDataTypes.BridgeSendType} enum.
*/
function sendTokenTransfer(
address _receiver,
address _token,
uint256 _amount,
uint64 _dstChainId,
uint64 _nonce,
uint32 _maxSlippage,
MsgDataTypes.BridgeSendType _bridgeSendType,
address _bridge
) internal {
IERC20(_token).safeIncreaseAllowance(_bridge, _amount);
if (_bridgeSendType == MsgDataTypes.BridgeSendType.Liquidity) {
IBridge(_bridge).send(_receiver, _token, _amount, _dstChainId, _nonce, _maxSlippage);
} else if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegDeposit) {
IOriginalTokenVault(_bridge).deposit(_token, _amount, _dstChainId, _receiver, _nonce);
} else if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegBurn) {
IPeggedTokenBridge(_bridge).burn(_token, _amount, _receiver, _nonce);
// handle cases where certain tokens do not spend allowance for role-based burn
IERC20(_token).safeApprove(_bridge, 0);
} else if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegV2Deposit) {
IOriginalTokenVaultV2(_bridge).deposit(_token, _amount, _dstChainId, _receiver, _nonce);
} else if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegV2Burn) {
IPeggedTokenBridgeV2(_bridge).burn(_token, _amount, _dstChainId, _receiver, _nonce);
// handle cases where certain tokens do not spend allowance for role-based burn
IERC20(_token).safeApprove(_bridge, 0);
} else if (_bridgeSendType == MsgDataTypes.BridgeSendType.PegV2BurnFrom) {
IPeggedTokenBridgeV2(_bridge).burnFrom(_token, _amount, _dstChainId, _receiver, _nonce);
// handle cases where certain tokens do not spend allowance for role-based burn
IERC20(_token).safeApprove(_bridge, 0);
} else {
revert("bridge type not supported");
}
}
}
// File sgn-v2-contracts/contracts/interfaces/ISigsVerifier.sol@v0.2.0
pragma solidity >=0.8.0;
interface ISigsVerifier {
/**
* @notice Verifies that a message is signed by a quorum among the signers.
* @param _msg signed message
* @param _sigs list of signatures sorted by signer addresses in ascending order
* @param _signers sorted list of current signers
* @param _powers powers of current signers
*/
function verifySigs(
bytes memory _msg,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external view;
}
// File sgn-v2-contracts/contracts/safeguard/Ownable.sol@v0.2.0
// File sgn-v2-contracts/contracts/message/messagebus/MessageBusSender.sol@v0.2.0
pragma solidity 0.8.9;
contract MessageBusSender is Ownable {
ISigsVerifier public immutable sigsVerifier;
uint256 public feeBase;
uint256 public feePerByte;
mapping(address => uint256) public withdrawnFees;
event Message(address indexed sender, address receiver, uint256 dstChainId, bytes message, uint256 fee);
event MessageWithTransfer(
address indexed sender,
address receiver,
uint256 dstChainId,
address bridge,
bytes32 srcTransferId,
bytes message,
uint256 fee
);
event FeeBaseUpdated(uint256 feeBase);
event FeePerByteUpdated(uint256 feePerByte);
constructor(ISigsVerifier _sigsVerifier) {
sigsVerifier = _sigsVerifier;
}
/**
* @notice Sends a message to an app on another chain via MessageBus without an associated transfer.
* A fee is charged in the native gas token.
* @param _receiver The address of the destination app contract.
* @param _dstChainId The destination chain ID.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
*/
function sendMessage(
address _receiver,
uint256 _dstChainId,
bytes calldata _message
) external payable {
require(_dstChainId != block.chainid, "Invalid chainId");
uint256 minFee = calcFee(_message);
require(msg.value >= minFee, "Insufficient fee");
emit Message(msg.sender, _receiver, _dstChainId, _message, msg.value);
}
/**
* @notice Sends a message associated with a transfer to an app on another chain via MessageBus without an associated transfer.
* A fee is charged in the native token.
* @param _receiver The address of the destination app contract.
* @param _dstChainId The destination chain ID.
* @param _srcBridge The bridge contract to send the transfer with.
* @param _srcTransferId The transfer ID.
* @param _dstChainId The destination chain ID.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
*/
function sendMessageWithTransfer(
address _receiver,
uint256 _dstChainId,
address _srcBridge,
bytes32 _srcTransferId,
bytes calldata _message
) external payable {
require(_dstChainId != block.chainid, "Invalid chainId");
uint256 minFee = calcFee(_message);
require(msg.value >= minFee, "Insufficient fee");
// SGN needs to verify
// 1. msg.sender matches sender of the src transfer
// 2. dstChainId matches dstChainId of the src transfer
// 3. bridge is either liquidity bridge, peg src vault, or peg dst bridge
emit MessageWithTransfer(msg.sender, _receiver, _dstChainId, _srcBridge, _srcTransferId, _message, msg.value);
}
/**
* @notice Withdraws message fee in the form of native gas token.
* @param _account The address receiving the fee.
* @param _cumulativeFee The cumulative fee credited to the account. Tracked by SGN.
* @param _sigs The list of signatures sorted by signing addresses in ascending order. A withdrawal must be
* signed-off by +2/3 of the sigsVerifier's current signing power to be delivered.
* @param _signers The sorted list of signers.
* @param _powers The signing powers of the signers.
*/
function withdrawFee(
address _account,
uint256 _cumulativeFee,
bytes[] calldata _sigs,
address[] calldata _signers,
uint256[] calldata _powers
) external {
bytes32 domain = keccak256(abi.encodePacked(block.chainid, address(this), "withdrawFee"));
sigsVerifier.verifySigs(abi.encodePacked(domain, _account, _cumulativeFee), _sigs, _signers, _powers);
uint256 amount = _cumulativeFee - withdrawnFees[_account];
require(amount > 0, "No new amount to withdraw");
withdrawnFees[_account] = _cumulativeFee;
(bool sent, ) = _account.call{value: amount, gas: 50000}("");
require(sent, "failed to withdraw fee");
}
/**
* @notice Calculates the required fee for the message.
* @param _message Arbitrary message bytes to be decoded by the destination app contract.
@ @return The required fee.
*/
function calcFee(bytes calldata _message) public view returns (uint256) {
return feeBase + _message.length * feePerByte;
}
// -------------------- Admin --------------------
function setFeePerByte(uint256 _fee) external onlyOwner {
feePerByte = _fee;
emit FeePerByteUpdated(feePerByte);
}
function setFeeBase(uint256 _fee) external onlyOwner {
feeBase = _fee;
emit FeeBaseUpdated(feeBase);
}
}
// File contracts/IFAllocationMaster.sol
pragma solidity ^0.8.9;
// import 'hardhat/console.sol';
// IFAllocationMaster is responsible for persisting all launchpad state between project token sales
// in order for the sales to have clean, self-enclosed, one-time-use states.
// IFAllocationMaster is the master of allocations. He can remember everything and he is a smart guy.
contract IFAllocationMaster is
Ownable,
ReentrancyGuard,
IIFRetrievableStakeWeight,
IIFBridgableStakeWeight
{
using SafeERC20 for ERC20;
using EnumerableSet for EnumerableSet.AddressSet;
// CONSTANTS
// number of decimals of rollover factors
uint64 constant ROLLOVER_FACTOR_DECIMALS = 10**18;
// STRUCTS
// Celer Multichain Integration
address public immutable messageBus;
// A checkpoint for marking stake info at a given block
struct UserCheckpoint {
// timestamp number of checkpoint
uint80 timestamp;
// amount staked at checkpoint
uint104 staked;
// amount of stake weight at checkpoint
uint192 stakeWeight;
// number of finished sales at time of checkpoint
uint24 numFinishedSales;
}
// A checkpoint for marking stake info at a given block
struct TrackCheckpoint {
// timestamp number of checkpoint
uint80 timestamp;
// amount staked at checkpoint
uint104 totalStaked;
// amount of stake weight at checkpoint
uint192 totalStakeWeight;
// number of finished sales at time of checkpoint
uint24 numFinishedSales;
}
// Info of each track. These parameters cannot be changed.
struct TrackInfo {
// name of track
string name;
// token to stake (e.g., IDIA)
ERC20 stakeToken;
// weight accrual rate for this track (stake weight increase per timestamp per stake token)
uint24 weightAccrualRate;
// amount rolled over when finished sale counter increases (with decimals == ROLLOVER_FACTOR_DECIMALS)
// e.g., if rolling over 20% when sale finishes, then this is 0.2 * ROLLOVER_FACTOR_DECIMALS, or
// 200_000_000_000_000_000
uint64 passiveRolloverRate;
// amount rolled over when finished sale counter increases, and user actively elected to roll over
uint64 activeRolloverRate;
// maximum total stake for a user in this track
uint104 maxTotalStake;
}
// Info of each user stake weight.
struct AddressStakeWeight {
address user;
uint192 stakeWeight;
}
// INFO FOR FACTORING IN ROLLOVERS
// the number of checkpoints of a track -- (track, finished sale count) => timestamp number
mapping(uint24 => mapping(uint24 => uint80))
public trackFinishedSaleTimestamps;
// stake weight each user actively rolls over for a given track and a finished sale count
// (track, user, finished sale count) => amount of stake weight
mapping(uint24 => mapping(address => mapping(uint24 => uint192)))
public trackActiveRollOvers;
// total stake weight actively rolled over for a given track and a finished sale count
// (track, finished sale count) => total amount of stake weight
mapping(uint24 => mapping(uint24 => uint192))
public trackTotalActiveRollOvers;
// TRACK INFO
// array of track information
TrackInfo[] public tracks;
// whether track is disabled -- (track) => disabled status
mapping(uint24 => bool) public trackDisabled;
// whether user has emergency withdrawn from track -- (track, user) => status
mapping(uint24 => mapping(address => bool)) public hasEmergencyWithdrawn;
// number of unique stakers on track -- (track) => staker count
mapping(uint24 => uint256) public numTrackStakers;
// array of unique stakers on track -- (track) => address array
// users are only added on first checkpoint to maintain unique
mapping(uint24 => address[]) public trackStakers;
// the number of checkpoints of a track -- (track) => checkpoint count
mapping(uint24 => uint32) public trackCheckpointCounts;
// track checkpoint mapping -- (track, checkpoint number) => TrackCheckpoint
mapping(uint24 => mapping(uint32 => TrackCheckpoint))
public trackCheckpoints;
// max stakes seen for each track -- (track) => max stake seen on track
mapping(uint24 => uint104) public trackMaxStakes;
// USER INFO
// the number of checkpoints of a user for a track -- (track, user address) => checkpoint count
mapping(uint24 => mapping(address => uint32)) public userCheckpointCounts;
// user checkpoint mapping -- (track, user address, checkpoint number) => UserCheckpoint
mapping(uint24 => mapping(address => mapping(uint32 => UserCheckpoint)))
public userCheckpoints;
// EVENTS
event AddTrack(string indexed name, address indexed token);
event DisableTrack(uint24 indexed trackId);
event ActiveRollOver(uint24 indexed trackId, address indexed user);
event BumpSaleCounter(uint24 indexed trackId, uint32 newCount);
event AddUserCheckpoint(uint24 indexed trackId, uint80 timestamp);
event AddTrackCheckpoint(uint24 indexed trackId, uint80 timestamp);
event Stake(uint24 indexed trackId, address indexed user, uint104 amount);
event Unstake(uint24 indexed trackId, address indexed user, uint104 amount);
event EmergencyWithdraw(
uint24 indexed trackId,
address indexed sender,
uint256 amount
);
event SyncUserWeight(
address receiver,
uint24 srcTrackId,
uint80 timestamp,
uint64 dstChainId,
uint24 dstTrackId
);
event SyncTotalWeight(
address receiver,
uint24 srcTrackId,
uint80 timestamp,
uint64 dstChainId,
uint24 dstTrackId
);
// CONSTRUCTOR
constructor(address _messageBus) {
messageBus = _messageBus;
}
// FUNCTIONS
// number of tracks
function trackCount() external view returns (uint24) {
return uint24(tracks.length);
}
// adds a new track
function addTrack(
string calldata name,
ERC20 stakeToken,
uint24 _weightAccrualRate,
uint64 _passiveRolloverRate,
uint64 _activeRolloverRate,
uint104 _maxTotalStake
) external onlyOwner {
require(_weightAccrualRate != 0, 'accrual rate is 0');
// add track
tracks.push(
TrackInfo({
name: name, // name of track
stakeToken: stakeToken, // token to stake (e.g., IDIA)
weightAccrualRate: _weightAccrualRate, // rate of stake weight accrual
passiveRolloverRate: _passiveRolloverRate, // passive rollover
activeRolloverRate: _activeRolloverRate, // active rollover
maxTotalStake: _maxTotalStake // max total stake
})
);
// add first track checkpoint
addTrackCheckpoint(
uint24(tracks.length - 1), // latest track
0, // initialize with 0 stake
false, // add or sub does not matter
false // do not bump finished sale counter
);
// emit
emit AddTrack(name, address(stakeToken));
}
// bumps a track's finished sale counter
function bumpSaleCounter(uint24 trackId) external onlyOwner {
// get number of finished sales of this track
uint24 nFinishedSales = trackCheckpoints[trackId][
trackCheckpointCounts[trackId] - 1
].numFinishedSales;
// update map that tracks timestamp numbers of finished sales
trackFinishedSaleTimestamps[trackId][nFinishedSales] = uint80(
block.timestamp
);
// add a new checkpoint with counter incremented by 1
addTrackCheckpoint(trackId, 0, false, true);
// `BumpSaleCounter` event emitted in function call above
}
// disables a track
function disableTrack(uint24 trackId) external onlyOwner {
// set disabled
trackDisabled[trackId] = true;
// emit
emit DisableTrack(trackId);
}
// perform active rollover
function activeRollOver(uint24 trackId) external {
// add new user checkpoint
addUserCheckpoint(trackId, 0, false);
// get new user checkpoint
UserCheckpoint memory userCp = userCheckpoints[trackId][_msgSender()][
userCheckpointCounts[trackId][_msgSender()] - 1
];
// current sale count
uint24 saleCount = userCp.numFinishedSales;
// subtract old user rollover amount from total
trackTotalActiveRollOvers[trackId][saleCount] -= trackActiveRollOvers[
trackId
][_msgSender()][saleCount];
// update user rollover amount
trackActiveRollOvers[trackId][_msgSender()][saleCount] = userCp
.stakeWeight;
// add new user rollover amount to total
trackTotalActiveRollOvers[trackId][saleCount] += userCp.stakeWeight;
// emit
emit ActiveRollOver(trackId, _msgSender());
}
// get closest PRECEDING user checkpoint
function getClosestUserCheckpoint(
uint24 trackId,
address user,
uint80 timestamp
) private view returns (UserCheckpoint memory cp) {
// get total checkpoint count for user
uint32 nCheckpoints = userCheckpointCounts[trackId][user];
if (
userCheckpoints[trackId][user][nCheckpoints - 1].timestamp <=
timestamp
) {
// First check most recent checkpoint
// return closest checkpoint
return userCheckpoints[trackId][user][nCheckpoints - 1];
} else if (userCheckpoints[trackId][user][0].timestamp > timestamp) {
// Next check earliest checkpoint
// If specified timestamp number is earlier than user's first checkpoint,
// return null checkpoint
return
UserCheckpoint({
timestamp: 0,
staked: 0,
stakeWeight: 0,
numFinishedSales: 0
});
} else {
// binary search on checkpoints
uint32 lower = 0;
uint32 upper = nCheckpoints - 1;
while (upper > lower) {
uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow
UserCheckpoint memory tempCp = userCheckpoints[trackId][user][
center
];
if (tempCp.timestamp == timestamp) {
return tempCp;
} else if (tempCp.timestamp < timestamp) {
lower = center;
} else {
upper = center - 1;
}
}
// return closest checkpoint
return userCheckpoints[trackId][user][lower];
}
}
// gets a user's stake weight within a track at a particular timestamp number
// logic extended from Compound COMP token `getPriorVotes` function
function getUserStakeWeight(
uint24 trackId,
address user,
uint80 timestamp
) public view returns (uint192) {
require(timestamp <= block.timestamp, 'timestamp # too high');
// if track is disabled, stake weight is 0
if (trackDisabled[trackId]) return 0;
// check number of user checkpoints
uint32 nUserCheckpoints = userCheckpointCounts[trackId][user];
if (nUserCheckpoints == 0) {
return 0;
}
// get closest preceding user checkpoint
UserCheckpoint memory closestUserCheckpoint = getClosestUserCheckpoint(
trackId,
user,
timestamp
);
// check if closest preceding checkpoint was null checkpoint
if (closestUserCheckpoint.timestamp == 0) {
return 0;
}
// get closest preceding track checkpoint
TrackCheckpoint memory closestTrackCp = getClosestTrackCheckpoint(
trackId,
timestamp
);
// get number of finished sales between user's last checkpoint timestamp and provided timestamp
uint24 numFinishedSalesDelta = closestTrackCp.numFinishedSales -
closestUserCheckpoint.numFinishedSales;
// get track info
TrackInfo memory track = tracks[trackId];
// calculate stake weight given above delta
uint192 stakeWeight;
if (numFinishedSalesDelta == 0) {
// calculate normally without rollover decay
uint80 elapsedTimestamps = timestamp -
closestUserCheckpoint.timestamp;
stakeWeight =
closestUserCheckpoint.stakeWeight +
(uint192(elapsedTimestamps) *
track.weightAccrualRate *
closestUserCheckpoint.staked) /
10**18;
return stakeWeight;
} else {
// calculate with rollover decay
// starting stakeweight
stakeWeight = closestUserCheckpoint.stakeWeight;
// current timestamp for iteration
uint80 currTimestamp = closestUserCheckpoint.timestamp;
// for each finished sale in between, get stake weight of that period
// and perform weighted sum
for (uint24 i = 0; i < numFinishedSalesDelta; i++) {
// get number of blocks passed at the current sale number
uint80 elapsedTimestamps = trackFinishedSaleTimestamps[trackId][
closestUserCheckpoint.numFinishedSales + i
] - currTimestamp;
// update stake weight
stakeWeight =
stakeWeight +
(uint192(elapsedTimestamps) *
track.weightAccrualRate *
closestUserCheckpoint.staked) /
10**18;
// get amount of stake weight actively rolled over for this sale number
uint192 activeRolloverWeight = trackActiveRollOvers[trackId][
user
][closestUserCheckpoint.numFinishedSales + i];
// factor in passive and active rollover decay
stakeWeight =
// decay active weight
(activeRolloverWeight * track.activeRolloverRate) /
ROLLOVER_FACTOR_DECIMALS +
// decay passive weight
((stakeWeight - activeRolloverWeight) *
track.passiveRolloverRate) /
ROLLOVER_FACTOR_DECIMALS;
// update currTimestamp for next round
currTimestamp = trackFinishedSaleTimestamps[trackId][
closestUserCheckpoint.numFinishedSales + i
];
}
// add any remaining accrued stake weight at current finished sale count
uint80 remainingElapsed = timestamp -
trackFinishedSaleTimestamps[trackId][
closestTrackCp.numFinishedSales - 1
];
stakeWeight +=
(uint192(remainingElapsed) *
track.weightAccrualRate *
closestUserCheckpoint.staked) /
10**18;
}
// return
return stakeWeight;
}
// get batch stake weight users by trackId
function getBatchStakeWeightByTrackId(uint24 trackId, uint80 timestamp, uint start, uint count)
public
view
returns (AddressStakeWeight[] memory)
{
require(timestamp <= block.timestamp, 'timestamp # too high');
require(start >= 0, 'start parameter cannot be negative number');
require(count > 0, 'count parameter must be greater than zero');
// total current user for a track
uint256 totalUser = numTrackStakers[trackId];
uint end = start + count;
uint stakersCount = totalUser < end ? totalUser : end;
AddressStakeWeight[] memory result = new AddressStakeWeight[](stakersCount - start);
for (uint i = start; i < stakersCount; i++) {
// get staker address
address staker = trackStakers[trackId][i];
// get stake weight for user
uint192 stakeWeight = getUserStakeWeight(trackId, staker, timestamp);
result[i - start] = AddressStakeWeight(staker, stakeWeight);
}
return result;
}
// get closest PRECEDING track checkpoint
function getClosestTrackCheckpoint(uint24 trackId, uint80 timestamp)
private
view
returns (TrackCheckpoint memory cp)
{
// get total checkpoint count for track
uint32 nCheckpoints = trackCheckpointCounts[trackId];
if (
trackCheckpoints[trackId][nCheckpoints - 1].timestamp <= timestamp
) {
// First check most recent checkpoint
// return closest checkpoint
return trackCheckpoints[trackId][nCheckpoints - 1];
} else if (trackCheckpoints[trackId][0].timestamp > timestamp) {
// Next check earliest checkpoint
// If specified timestamp number is earlier than track's first checkpoint,
// return null checkpoint
return
TrackCheckpoint({
timestamp: 0,
totalStaked: 0,
totalStakeWeight: 0,
numFinishedSales: 0
});
} else {
// binary search on checkpoints
uint32 lower = 0;
uint32 upper = nCheckpoints - 1;
while (upper > lower) {
uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow
TrackCheckpoint memory tempCp = trackCheckpoints[trackId][
center
];
if (tempCp.timestamp == timestamp) {
return tempCp;
} else if (tempCp.timestamp < timestamp) {
lower = center;
} else {
upper = center - 1;
}
}
// return closest checkpoint
return trackCheckpoints[trackId][lower];
}
}
// gets total stake weight within a track at a particular timestamp number
// logic extended from Compound COMP token `getPriorVotes` function
function getTotalStakeWeight(uint24 trackId, uint80 timestamp)
public
view
returns (uint192)
{
require(timestamp <= block.timestamp, 'timestamp # too high');
// if track is disabled, stake weight is 0
if (trackDisabled[trackId]) return 0;
// get closest track checkpoint
TrackCheckpoint memory closestCheckpoint = getClosestTrackCheckpoint(
trackId,
timestamp
);
// check if closest preceding checkpoint was null checkpoint
if (closestCheckpoint.timestamp == 0) {
return 0;
}
// calculate blocks elapsed since checkpoint
uint80 additionalTimestamps = (timestamp - closestCheckpoint.timestamp);
// get track info
TrackInfo storage trackInfo = tracks[trackId];
// calculate marginal accrued stake weight
uint192 marginalAccruedStakeWeight = (uint192(additionalTimestamps) *
trackInfo.weightAccrualRate *
closestCheckpoint.totalStaked) / 10**18;
// return
return closestCheckpoint.totalStakeWeight + marginalAccruedStakeWeight;
}
function addUserCheckpoint(
uint24 trackId,
uint104 amount,
bool addElseSub
) internal {
// get track info
TrackInfo storage track = tracks[trackId];
// get user checkpoint count
uint32 nCheckpointsUser = userCheckpointCounts[trackId][_msgSender()];
// get track checkpoint count
uint32 nCheckpointsTrack = trackCheckpointCounts[trackId];
// get latest track checkpoint
TrackCheckpoint memory trackCp = trackCheckpoints[trackId][
nCheckpointsTrack - 1
];
// if this is first checkpoint
if (nCheckpointsUser == 0) {
// check if amount exceeds maximum
require(amount <= track.maxTotalStake, 'exceeds staking cap');
// add user to stakers list of track
trackStakers[trackId].push(_msgSender());
// increment stakers count on track
numTrackStakers[trackId]++;
// add a first checkpoint for this user on this track
userCheckpoints[trackId][_msgSender()][0] = UserCheckpoint({
timestamp: uint80(block.timestamp),
staked: amount,
stakeWeight: 0,
numFinishedSales: trackCp.numFinishedSales
});
// increment user's checkpoint count
userCheckpointCounts[trackId][_msgSender()] = nCheckpointsUser + 1;
} else {
// get previous checkpoint
UserCheckpoint storage prev = userCheckpoints[trackId][
_msgSender()
][nCheckpointsUser - 1];
// check if amount exceeds maximum
require(
(addElseSub ? prev.staked + amount : prev.staked - amount) <=
track.maxTotalStake,
'exceeds staking cap'
);
// ensure timestamp number downcast to uint80 is monotonically increasing (prevent overflow)
// this should never happen within the lifetime of the universe, but if it does, this prevents a catastrophe
require(
prev.timestamp <= uint80(block.timestamp),
'timestamp # overflow'
);
// add a new checkpoint for user within this track
// if no blocks elapsed, just update prev checkpoint (so checkpoints can be uniquely identified by timestamp number)
if (prev.timestamp == uint80(block.timestamp)) {
prev.staked = addElseSub
? prev.staked + amount
: prev.staked - amount;
prev.numFinishedSales = trackCp.numFinishedSales;
} else {
userCheckpoints[trackId][_msgSender()][
nCheckpointsUser
] = UserCheckpoint({
timestamp: uint80(block.timestamp),
staked: addElseSub
? prev.staked + amount
: prev.staked - amount,
stakeWeight: getUserStakeWeight(
trackId,
_msgSender(),
uint80(block.timestamp)
),
numFinishedSales: trackCp.numFinishedSales
});
// increment user's checkpoint count
userCheckpointCounts[trackId][_msgSender()] =
nCheckpointsUser +
1;
}
}
// emit
emit AddUserCheckpoint(trackId, uint80(block.timestamp));
}
function addTrackCheckpoint(
uint24 trackId, // track number
uint104 amount, // delta on staked amount
bool addElseSub, // true = adding; false = subtracting
bool _bumpSaleCounter // whether to increase sale counter by 1
) internal {
// get track info
TrackInfo storage track = tracks[trackId];
// get track checkpoint count
uint32 nCheckpoints = trackCheckpointCounts[trackId];
// if this is first checkpoint
if (nCheckpoints == 0) {
// add a first checkpoint for this track
trackCheckpoints[trackId][0] = TrackCheckpoint({
timestamp: uint80(block.timestamp),
totalStaked: amount,
totalStakeWeight: 0,
numFinishedSales: _bumpSaleCounter ? 1 : 0
});
// increase new track's checkpoint count by 1
trackCheckpointCounts[trackId]++;
} else {
// get previous checkpoint
TrackCheckpoint storage prev = trackCheckpoints[trackId][
nCheckpoints - 1
];
// get whether track is disabled
bool isDisabled = trackDisabled[trackId];
if (isDisabled) {
// if previous checkpoint was disabled, then cannot increase stake going forward
require(!addElseSub, 'disabled: cannot add stake');
}
// ensure timestamp number downcast to uint80 is monotonically increasing (prevent overflow)
// this should never happen within the lifetime of the universe, but if it does, this prevents a catastrophe
require(
prev.timestamp <= uint80(block.timestamp),
'timestamp # overflow'
);
// calculate blocks elapsed since checkpoint
uint80 additionalTimestamp = (uint80(block.timestamp) -
prev.timestamp);
// calculate marginal accrued stake weight
uint192 marginalAccruedStakeWeight = (uint192(additionalTimestamp) *
track.weightAccrualRate *
prev.totalStaked) / 10**18;
// calculate new stake weight
uint192 newStakeWeight = prev.totalStakeWeight +
marginalAccruedStakeWeight;
// factor in passive and active rollover decay
if (_bumpSaleCounter) {
// get total active rollover amount
uint192 activeRolloverWeight = trackTotalActiveRollOvers[
trackId
][prev.numFinishedSales];
newStakeWeight =
// decay active weight
(activeRolloverWeight * track.activeRolloverRate) /
ROLLOVER_FACTOR_DECIMALS +
// decay passive weight
((newStakeWeight - activeRolloverWeight) *
track.passiveRolloverRate) /
ROLLOVER_FACTOR_DECIMALS;
// emit
emit BumpSaleCounter(trackId, prev.numFinishedSales + 1);
}
// add a new checkpoint for this track
// if no timestamp elapsed, just update prev checkpoint (so checkpoints can be uniquely identified by timestamp number)
if (additionalTimestamp == 0) {
prev.totalStaked = addElseSub
? prev.totalStaked + amount
: prev.totalStaked - amount;
prev.totalStakeWeight = isDisabled
? (
prev.totalStakeWeight < newStakeWeight
? prev.totalStakeWeight
: newStakeWeight
)
: newStakeWeight;
prev.numFinishedSales = _bumpSaleCounter
? prev.numFinishedSales + 1
: prev.numFinishedSales;
} else {
trackCheckpoints[trackId][nCheckpoints] = TrackCheckpoint({
timestamp: uint80(block.timestamp),
totalStaked: addElseSub
? prev.totalStaked + amount
: prev.totalStaked - amount,
totalStakeWeight: isDisabled
? (
prev.totalStakeWeight < newStakeWeight
? prev.totalStakeWeight
: newStakeWeight
)
: newStakeWeight,
numFinishedSales: _bumpSaleCounter
? prev.numFinishedSales + 1
: prev.numFinishedSales
});
// increase new track's checkpoint count by 1
trackCheckpointCounts[trackId]++;
}
}
// emit
emit AddTrackCheckpoint(trackId, uint80(block.timestamp));
}
// stake
function stake(uint24 trackId, uint104 amount) external nonReentrant {
// stake amount must be greater than 0
require(amount > 0, 'amount is 0');
// get track info
TrackInfo storage track = tracks[trackId];
// get whether track is disabled
bool isDisabled = trackDisabled[trackId];
// cannot stake into disabled track
require(!isDisabled, 'track is disabled');
// transfer the specified amount of stake token from user to this contract
track.stakeToken.safeTransferFrom(_msgSender(), address(this), amount);
// add user checkpoint
addUserCheckpoint(trackId, amount, true);
// add track checkpoint
addTrackCheckpoint(trackId, amount, true, false);
// get latest track cp
TrackCheckpoint memory trackCp = trackCheckpoints[trackId][
trackCheckpointCounts[trackId] - 1
];
// update track max staked
if (trackMaxStakes[trackId] < trackCp.totalStaked) {
trackMaxStakes[trackId] = trackCp.totalStaked;
}
// emit
emit Stake(trackId, _msgSender(), amount);
}
// unstake
function unstake(uint24 trackId, uint104 amount) external nonReentrant {
// amount must be greater than 0
require(amount > 0, 'amount is 0');
// get track info
TrackInfo storage track = tracks[trackId];
// get number of user's checkpoints within this track
uint32 userCheckpointCount = userCheckpointCounts[trackId][
_msgSender()
];
// get user's latest checkpoint
UserCheckpoint storage checkpoint = userCheckpoints[trackId][
_msgSender()
][userCheckpointCount - 1];
// ensure amount <= user's current stake
require(amount <= checkpoint.staked, 'amount > staked');
// add user checkpoint
addUserCheckpoint(trackId, amount, false);
// add track checkpoint
addTrackCheckpoint(trackId, amount, false, false);
// transfer the specified amount of stake token from this contract to user
track.stakeToken.safeTransfer(_msgSender(), amount);
// emit
emit Unstake(trackId, _msgSender(), amount);
}
// emergency withdraw
function emergencyWithdraw(uint24 trackId) external nonReentrant {
// require track is disabled
require(trackDisabled[trackId], 'track !disabled');
// require can only emergency withdraw once
require(
!hasEmergencyWithdrawn[trackId][_msgSender()],
'already called'
);
// set emergency withdrawn status to true
hasEmergencyWithdrawn[trackId][_msgSender()] = true;
// get track info
TrackInfo storage track = tracks[trackId];
// get number of user's checkpoints within this track
uint32 userCheckpointCount = userCheckpointCounts[trackId][
_msgSender()
];
// get user's latest checkpoint
UserCheckpoint storage checkpoint = userCheckpoints[trackId][
_msgSender()
][userCheckpointCount - 1];
// update checkpoint before emergency withdrawal
// add user checkpoint
addUserCheckpoint(trackId, checkpoint.staked, false);
// add track checkpoint
addTrackCheckpoint(trackId, checkpoint.staked, false, false);
// transfer the specified amount of stake token from this contract to user
track.stakeToken.safeTransfer(_msgSender(), checkpoint.staked);
// emit
emit EmergencyWithdraw(trackId, _msgSender(), checkpoint.staked);
}
// Methods for bridging track weight information
// Push
function syncUserWeight(
address receiver,
address[] calldata users,
uint24 trackId,
uint80 timestamp,
uint64 dstChainId
) external payable nonReentrant {
// should be active track
require(!trackDisabled[trackId], 'track !disabled');
// get user stake weight on this contract
uint192[] memory userStakeWeights = new uint192[](users.length);
for (uint256 i = 0; i < users.length; i++) {
userStakeWeights[i] = getUserStakeWeight(
trackId,
users[i],
timestamp
);
}
// construct message data to be sent to dest contract
bytes memory message = abi.encode(
MessageRequest({
bridgeType: BridgeType.UserWeight,
users: users,
timestamp: timestamp,
weights: userStakeWeights,
trackId: trackId
})
);
// calculate messageBus fee
MessageBusSender messageBusSender = MessageBusSender(messageBus);
uint256 fee = messageBusSender.calcFee(message);
require(msg.value >= fee, "Not enough fee");
// trigger the message bridge
MessageSenderLib.sendMessage(
receiver,
dstChainId,
message,
messageBus,
fee
);
// Refund mesasgeBus fee
if ((msg.value - fee) != 0) {
payable(_msgSender()).transfer(msg.value - fee);
}
emit SyncUserWeight(
receiver,
trackId,
timestamp,
dstChainId,
trackId
);
}
function syncTotalWeight(
address receiver,
uint24 trackId,
uint80 timestamp,
uint64 dstChainId
) external payable nonReentrant {
// should be active track
require(!trackDisabled[trackId], 'track disabled');
address[] memory users = new address[](1);
users[0] = _msgSender();
// get total stake weight on this contract
uint192[] memory weights = new uint192[](1);
weights[0] = getTotalStakeWeight(trackId, timestamp);
// construct message data to be sent to dest contract
bytes memory message = abi.encode(
MessageRequest({
bridgeType: BridgeType.TotalWeight,
users: users,
timestamp: timestamp,
weights: weights,
trackId: trackId
})
);
// calculate messageBus fee
MessageBusSender messageBusSender = MessageBusSender(messageBus);
uint256 fee = messageBusSender.calcFee(message);
require(msg.value >= fee, "Not enough fee");
// trigger the message bridge
MessageSenderLib.sendMessage(
receiver,
dstChainId,
message,
messageBus,
fee
);
// Refund mesasgeBus fee
if ((msg.value - fee) != 0) {
payable(_msgSender()).transfer(msg.value - fee);
}
emit SyncTotalWeight(receiver, trackId, timestamp, dstChainId, trackId);
}
}
{
"compilationTarget": {
"IFAllocationMaster.sol": "IFAllocationMaster"
},
"evmVersion": "london",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"_messageBus","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":true,"internalType":"address","name":"user","type":"address"}],"name":"ActiveRollOver","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"string","name":"name","type":"string"},{"indexed":true,"internalType":"address","name":"token","type":"address"}],"name":"AddTrack","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":false,"internalType":"uint80","name":"timestamp","type":"uint80"}],"name":"AddTrackCheckpoint","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":false,"internalType":"uint80","name":"timestamp","type":"uint80"}],"name":"AddUserCheckpoint","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":false,"internalType":"uint32","name":"newCount","type":"uint32"}],"name":"BumpSaleCounter","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"}],"name":"DisableTrack","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"EmergencyWithdraw","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":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint104","name":"amount","type":"uint104"}],"name":"Stake","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"receiver","type":"address"},{"indexed":false,"internalType":"uint24","name":"srcTrackId","type":"uint24"},{"indexed":false,"internalType":"uint80","name":"timestamp","type":"uint80"},{"indexed":false,"internalType":"uint64","name":"dstChainId","type":"uint64"},{"indexed":false,"internalType":"uint24","name":"dstTrackId","type":"uint24"}],"name":"SyncTotalWeight","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"receiver","type":"address"},{"indexed":false,"internalType":"uint24","name":"srcTrackId","type":"uint24"},{"indexed":false,"internalType":"uint80","name":"timestamp","type":"uint80"},{"indexed":false,"internalType":"uint64","name":"dstChainId","type":"uint64"},{"indexed":false,"internalType":"uint24","name":"dstTrackId","type":"uint24"}],"name":"SyncUserWeight","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint24","name":"trackId","type":"uint24"},{"indexed":true,"internalType":"address","name":"user","type":"address"},{"indexed":false,"internalType":"uint104","name":"amount","type":"uint104"}],"name":"Unstake","type":"event"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"}],"name":"activeRollOver","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"string","name":"name","type":"string"},{"internalType":"contract ERC20","name":"stakeToken","type":"address"},{"internalType":"uint24","name":"_weightAccrualRate","type":"uint24"},{"internalType":"uint64","name":"_passiveRolloverRate","type":"uint64"},{"internalType":"uint64","name":"_activeRolloverRate","type":"uint64"},{"internalType":"uint104","name":"_maxTotalStake","type":"uint104"}],"name":"addTrack","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"}],"name":"bumpSaleCounter","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"}],"name":"disableTrack","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"}],"name":"emergencyWithdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint80","name":"timestamp","type":"uint80"},{"internalType":"uint256","name":"start","type":"uint256"},{"internalType":"uint256","name":"count","type":"uint256"}],"name":"getBatchStakeWeightByTrackId","outputs":[{"components":[{"internalType":"address","name":"user","type":"address"},{"internalType":"uint192","name":"stakeWeight","type":"uint192"}],"internalType":"struct IFAllocationMaster.AddressStakeWeight[]","name":"","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint80","name":"timestamp","type":"uint80"}],"name":"getTotalStakeWeight","outputs":[{"internalType":"uint192","name":"","type":"uint192"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"address","name":"user","type":"address"},{"internalType":"uint80","name":"timestamp","type":"uint80"}],"name":"getUserStakeWeight","outputs":[{"internalType":"uint192","name":"","type":"uint192"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"address","name":"","type":"address"}],"name":"hasEmergencyWithdrawn","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"messageBus","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"}],"name":"numTrackStakers","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint104","name":"amount","type":"uint104"}],"name":"stake","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint80","name":"timestamp","type":"uint80"},{"internalType":"uint64","name":"dstChainId","type":"uint64"}],"name":"syncTotalWeight","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"address[]","name":"users","type":"address[]"},{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint80","name":"timestamp","type":"uint80"},{"internalType":"uint64","name":"dstChainId","type":"uint64"}],"name":"syncUserWeight","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackActiveRollOvers","outputs":[{"internalType":"uint192","name":"","type":"uint192"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackCheckpointCounts","outputs":[{"internalType":"uint32","name":"","type":"uint32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"uint32","name":"","type":"uint32"}],"name":"trackCheckpoints","outputs":[{"internalType":"uint80","name":"timestamp","type":"uint80"},{"internalType":"uint104","name":"totalStaked","type":"uint104"},{"internalType":"uint192","name":"totalStakeWeight","type":"uint192"},{"internalType":"uint24","name":"numFinishedSales","type":"uint24"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"trackCount","outputs":[{"internalType":"uint24","name":"","type":"uint24"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackDisabled","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackFinishedSaleTimestamps","outputs":[{"internalType":"uint80","name":"","type":"uint80"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackMaxStakes","outputs":[{"internalType":"uint104","name":"","type":"uint104"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"trackStakers","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"uint24","name":"","type":"uint24"}],"name":"trackTotalActiveRollOvers","outputs":[{"internalType":"uint192","name":"","type":"uint192"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"tracks","outputs":[{"internalType":"string","name":"name","type":"string"},{"internalType":"contract ERC20","name":"stakeToken","type":"address"},{"internalType":"uint24","name":"weightAccrualRate","type":"uint24"},{"internalType":"uint64","name":"passiveRolloverRate","type":"uint64"},{"internalType":"uint64","name":"activeRolloverRate","type":"uint64"},{"internalType":"uint104","name":"maxTotalStake","type":"uint104"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"trackId","type":"uint24"},{"internalType":"uint104","name":"amount","type":"uint104"}],"name":"unstake","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"address","name":"","type":"address"}],"name":"userCheckpointCounts","outputs":[{"internalType":"uint32","name":"","type":"uint32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint24","name":"","type":"uint24"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint32","name":"","type":"uint32"}],"name":"userCheckpoints","outputs":[{"internalType":"uint80","name":"timestamp","type":"uint80"},{"internalType":"uint104","name":"staked","type":"uint104"},{"internalType":"uint192","name":"stakeWeight","type":"uint192"},{"internalType":"uint24","name":"numFinishedSales","type":"uint24"}],"stateMutability":"view","type":"function"}]