Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (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() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20.sol";
import "./extensions/IERC20Metadata.sol";
import "../../utils/Context.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/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;
// Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by
// decrementing then incrementing.
_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;
unchecked {
// Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.
_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;
// Overflow not possible: amount <= accountBalance <= totalSupply.
_totalSupply -= amount;
}
emit Transfer(account, address(0), amount);
_afterTokenTransfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(
address owner,
address spender,
uint256 amount
) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - amount);
}
}
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* has been transferred to `to`.
* - when `from` is zero, `amount` tokens have been minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens have been burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "../interfaces/IAssetTokenData.sol";
/// @author Swarm Markets
/// @title AssetToken
/// @notice Main Asset Token Contract
contract AssetToken is ERC20, ReentrancyGuard {
/// @dev Used to check access to functions as a kindof modifiers
uint256 private constant ACTIVE_CONTRACT = 1 << 0;
uint256 private constant UNFROZEN_CONTRACT = 1 << 1;
uint256 private constant ONLY_ISSUER = 1 << 2;
uint256 private constant ONLY_ISSUER_OR_GUARDIAN = 1 << 3;
uint256 private constant ONLY_ISSUER_OR_AGENT = 1 << 4;
uint8 private immutable _decimals;
/// @dev This is a WAD on DSMATH representing 1
uint256 public constant DECIMALS = 10 ** 18;
/// @dev This is a proportion of 1 representing 100%, equal to a WAD
uint256 public constant HUNDRED_PERCENT = 10 ** 18;
/// @notice AssetTokenData Address
address public assetTokenDataAddress;
/// @notice Structure to hold the Mint Requests
struct MintRequest {
address destination;
uint256 amount;
string referenceTo;
bool completed;
}
/// @notice Mint Requests mapping and last ID
mapping(uint256 => MintRequest) public mintRequests;
uint256 public mintRequestID;
/// @notice Structure to hold the Redemption Requests
struct RedemptionRequest {
address sender;
string receipt;
uint256 assetTokenAmount;
uint256 underlyingAssetAmount;
bool completed;
bool fromStake;
string approveTxID;
address canceledBy;
}
/// @notice Redemption Requests mapping and last ID
mapping(uint256 => RedemptionRequest) public redemptionRequests;
uint256 public redemptionRequestID;
/// @notice stakedRedemptionRequests is map from requester to request ID
/// @notice exists to detect that sender already has request from stake function
mapping(address => uint256) public stakedRedemptionRequests;
/// @notice mapping to hold each user safeguardStake amoun
mapping(address => uint256) public safeguardStakes;
/// @notice sum of the total stakes amounts
uint256 public totalStakes;
/// @notice the percetage (on 18 digits)
/// @notice if this gets overgrown the contract change state
uint256 public statePercent;
/// @notice know your asset string
string public kya;
/// @notice minimum Redemption Amount (in Asset token value)
uint256 public minimumRedemptionAmount;
/// @notice Emitted when the address of the asset token data is set
event AssetTokenDataChanged(address indexed _oldAddress, address indexed _newAddress, address indexed _caller);
/// @notice Emitted when kya string is set
event KyaChanged(string _kya, address indexed _caller);
/// @notice Emitted when minimumRedemptionAmount is set
event MinimumRedemptionAmountChanged(uint256 _newAmount, address indexed _caller);
/// @notice Emitted when a mint request is requested
event MintRequested(
uint256 indexed _mintRequestID,
address indexed _destination,
uint256 _amount,
address indexed _caller
);
/// @notice Emitted when a mint request gets approved
event MintApproved(
uint256 indexed _mintRequestID,
address indexed _destination,
uint256 _amountMinted,
address indexed _caller
);
/// @notice Emitted when a redemption request is requested
event RedemptionRequested(
uint256 indexed _redemptionRequestID,
uint256 _assetTokenAmount,
uint256 _underlyingAssetAmount,
bool _fromStake,
address indexed _caller
);
/// @notice Emitted when a redemption request is cancelled
event RedemptionCanceled(
uint256 indexed _redemptionRequestID,
address indexed _requestReceiver,
string _motive,
address indexed _caller
);
/// @notice Emitted when a redemption request is approved
event RedemptionApproved(
uint256 indexed _redemptionRequestID,
uint256 _assetTokenAmount,
uint256 _underlyingAssetAmount,
address indexed _requestReceiver,
address indexed _caller
);
/// @notice Emitted when the token gets bruned
event TokenBurned(uint256 _amount, address indexed _caller);
/// @notice Emitted when the contract change to safeguard
event SafeguardUnstaked(uint256 _amount, address indexed _caller);
/// @notice Constructor: sets the state variables and provide proper checks to deploy
/// @param _assetTokenData the asset token data contract address
/// @param _statePercent the state percent to check the safeguard convertion
/// @param _kya verification link
/// @param _minimumRedemptionAmount less than this value is not allowed
/// @param _name of the token
/// @param _symbol of the token
constructor(
address _assetTokenData,
uint256 _statePercent,
string memory _kya,
uint256 _minimumRedemptionAmount,
string memory _name,
string memory _symbol
) ERC20(_name, _symbol) {
require(_assetTokenData != address(0), "AssetToken: assetTokenData is address 0");
require(_statePercent > 0, "AssetToken: statePercent must be > 0");
require(_statePercent <= HUNDRED_PERCENT, "AssetToken: statePercent <= HUNDRED_PERCENT");
require(bytes(_kya).length > 3, "AssetToken: incorrect kya passed");
// IT IS THE WAD EQUIVALENT USED IN DSMATH
_decimals = 18;
assetTokenDataAddress = _assetTokenData;
statePercent = _statePercent;
kya = _kya;
minimumRedemptionAmount = _minimumRedemptionAmount;
}
/// @notice kindof modifier to frist-check data on functions
/// @param modifiers an array containing the modifiers to check (the enums)
function checkAccessToFunction(uint256 modifiers) internal view {
bool found;
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
if (modifiers & ACTIVE_CONTRACT != 0) {
assetTknDtaContract.onlyActiveContract(address(this));
found = true;
}
if (modifiers & UNFROZEN_CONTRACT != 0) {
assetTknDtaContract.onlyUnfrozenContract(address(this));
found = true;
}
if (modifiers & ONLY_ISSUER != 0) {
assetTknDtaContract.onlyIssuer(address(this), _msgSender());
found = true;
}
if (modifiers & ONLY_ISSUER_OR_GUARDIAN != 0) {
assetTknDtaContract.onlyIssuerOrGuardian(address(this), _msgSender());
found = true;
}
if (modifiers & ONLY_ISSUER_OR_AGENT != 0) {
assetTknDtaContract.onlyIssuerOrAgent(address(this), _msgSender());
found = true;
}
require(found, "AssetToken: access not found");
}
/// @notice Hook to be executed before every transfer and mint
/// @notice This overrides the ERC20 defined function
/// @param _from the sender
/// @param _to the receipent
/// @param _amount the amount (it is not used but needed to be defined to override)
function _beforeTokenTransfer(address _from, address _to, uint256 _amount) internal virtual override {
// on safeguard the only available transfers are from allowed addresses and guardian
// or from an authorized user to this contract
// address(this) is added as the _from for approving redemption (burn)
// address(this) is added as the _to for requesting redemption (transfer to this contract)
// address(0) is added to the condition to allow burn on safeguard
checkAccessToFunction(UNFROZEN_CONTRACT);
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
if (assetTknDtaContract.isOnSafeguard(address(this))) {
/// @dev State is SAFEGUARD
if (
// receiver is NOT this contract AND sender is NOT this contract AND sender is NOT guardian
_to != address(this) &&
_from != address(this) &&
_from != assetTknDtaContract.getGuardian(address(this))
) {
require(
assetTknDtaContract.isAllowedTransferOnSafeguard(address(this), _from),
"AssetToken: beforeTokenTransfer: not allowed (onSafeguard)"
);
} else {
require(
assetTknDtaContract.mustBeAuthorizedHolders(address(this), _from, _to, _amount),
"AssetToken: beforeTokenTransfer: not authorized (onActive)"
);
}
} else {
/// @dev State is ACTIVE
// this is mint or transfer
// mint signature: ==> _beforeTokenTransfer(address(0), account, amount);
// burn signature: ==> _beforeTokenTransfer(account, address(0), amount);
require(
assetTknDtaContract.mustBeAuthorizedHolders(address(this), _from, _to, _amount),
"AssetToken: beforeTokenTransfer: not authorized (onActive)"
);
}
super._beforeTokenTransfer(_from, _to, _amount);
}
/// @notice Sets Asset Token Data Address
/// @param _newAddress value to be set
function setAssetTokenData(address _newAddress) external {
checkAccessToFunction(UNFROZEN_CONTRACT | ONLY_ISSUER_OR_GUARDIAN);
require(_newAddress != address(0), "AssetToken: newAddress is address 0");
emit AssetTokenDataChanged(assetTokenDataAddress, _newAddress, _msgSender());
assetTokenDataAddress = _newAddress;
}
/// @notice Sets the verification link
/// @param _kya value to be set
function setKya(string calldata _kya) external {
checkAccessToFunction(ONLY_ISSUER_OR_GUARDIAN | UNFROZEN_CONTRACT);
require(bytes(_kya).length > 3, "AssetToken: incorrect kya passed");
emit KyaChanged(_kya, _msgSender());
kya = _kya;
}
/// @notice Sets the _minimumRedemptionAmount
/// @param _minimumRedemptionAmount value to be set
function setMinimumRedemptionAmount(uint256 _minimumRedemptionAmount) external {
checkAccessToFunction(ONLY_ISSUER_OR_GUARDIAN | UNFROZEN_CONTRACT);
emit MinimumRedemptionAmountChanged(_minimumRedemptionAmount, _msgSender());
minimumRedemptionAmount = _minimumRedemptionAmount;
}
/// @notice Freeze the contract
function freezeContract() external {
checkAccessToFunction(ONLY_ISSUER_OR_GUARDIAN);
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
require(!assetTknDtaContract.isContractFrozen(address(this)), "AssetToken: contract is frozen");
require(assetTknDtaContract.freezeContract(address(this)), "AssetToken: freezing failed");
}
/// @notice unfreeze the contract
function unfreezeContract() external {
checkAccessToFunction(ONLY_ISSUER_OR_GUARDIAN);
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
require(assetTknDtaContract.isContractFrozen(address(this)), "AssetToken: contract is not frozen");
require(assetTknDtaContract.unfreezeContract(address(this)), "AssetToken: unfreezing failed");
}
/// @notice Requests a mint to the caller
/// @param _amount the amount to mint in asset token format
/// @return uint256 request ID to be referenced in the mapping
function requestMint(uint256 _amount) external returns (uint256) {
return _requestMint(_amount, _msgSender());
}
/// @notice Requests a mint to the _destination address
/// @param _amount the amount to mint in asset token format
/// @param _destination the receiver of the tokens
/// @return uint256 request ID to be referenced in the mapping
function requestMint(uint256 _amount, address _destination) external returns (uint256) {
return _requestMint(_amount, _destination);
}
/// @notice Performs the Mint Request to the destination address
/// @param _amount entered in the external functions
/// @param _destination the receiver of the tokens
/// @return uint256 request ID to be referenced in the mapping
function _requestMint(uint256 _amount, address _destination) private returns (uint256) {
checkAccessToFunction(ACTIVE_CONTRACT | UNFROZEN_CONTRACT | ONLY_ISSUER_OR_AGENT);
require(_amount > 0, "AssetToken: amount must be > 0");
mintRequestID++;
emit MintRequested(mintRequestID, _destination, _amount, _msgSender());
mintRequests[mintRequestID] = MintRequest(_destination, _amount, "", false);
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
if (_msgSender() == assetTknDtaContract.getIssuer(address(this))) {
approveMint(mintRequestID, "IssuerMint");
}
return mintRequestID;
}
/// @notice Approves the Mint Request
/// @param _mintRequestID the ID to be referenced in the mapping
/// @param _referenceTo reference comment for the issuer
function approveMint(uint256 _mintRequestID, string memory _referenceTo) public nonReentrant {
checkAccessToFunction(ACTIVE_CONTRACT | ONLY_ISSUER);
require(mintRequests[_mintRequestID].destination != address(0), "AssetToken: requestID does not exist");
require(!mintRequests[_mintRequestID].completed, "AssetToken: request is completed");
mintRequests[_mintRequestID].completed = true;
mintRequests[_mintRequestID].referenceTo = _referenceTo;
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
assetTknDtaContract.update(address(this));
uint256 currentRate = assetTknDtaContract.getCurrentRate(address(this));
uint256 amountToMint = (mintRequests[_mintRequestID].amount * (DECIMALS)) / (currentRate);
emit MintApproved(_mintRequestID, mintRequests[_mintRequestID].destination, amountToMint, _msgSender());
_mint(mintRequests[_mintRequestID].destination, amountToMint);
}
/// @notice Requests an amount of assetToken Redemption
/// @param _assetTokenAmount the amount of Asset Token to be redeemed
/// @param _destination the off chain hash of the redemption transaction
/// @return uint256 redemptionRequest ID to be referenced in the mapping
function requestRedemption(
uint256 _assetTokenAmount,
string memory _destination
) external nonReentrant returns (uint256) {
require(_assetTokenAmount > 0, "AssetToken: assetTokenAmount must be > 0");
require(balanceOf(_msgSender()) >= _assetTokenAmount, "AssetToken: caller has insufficient funds");
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
address issuer = assetTknDtaContract.getIssuer(address(this));
address guardian = assetTknDtaContract.getGuardian(address(this));
bool isOnSafeguard = assetTknDtaContract.isOnSafeguard(address(this));
if ((!isOnSafeguard && _msgSender() != issuer) || (isOnSafeguard && _msgSender() != guardian)) {
require(
_assetTokenAmount >= minimumRedemptionAmount,
"AssetToken: minimumRedemptionAmount not reached yet"
);
}
assetTknDtaContract.update(address(this));
uint256 currentRate = assetTknDtaContract.getCurrentRate(address(this));
uint256 underlyingAssetAmount = (_assetTokenAmount * (currentRate)) / (DECIMALS);
redemptionRequestID++;
emit RedemptionRequested(redemptionRequestID, _assetTokenAmount, underlyingAssetAmount, false, _msgSender());
redemptionRequests[redemptionRequestID] = RedemptionRequest(
_msgSender(),
_destination,
_assetTokenAmount,
underlyingAssetAmount,
false,
false,
"",
address(0)
);
/// @dev make the transfer to the contract for the amount requested (18 digits)
_transfer(_msgSender(), address(this), _assetTokenAmount);
/// @dev approve instantly when called by issuer or guardian
if ((!isOnSafeguard && _msgSender() == issuer) || (isOnSafeguard && _msgSender() == guardian)) {
approveRedemption(redemptionRequestID, "AutomaticRedemptionApproval");
}
return redemptionRequestID;
}
/// @notice Approves the Redemption Requests
/// @param _redemptionRequestID redemption request ID to be referenced in the mapping
/// @param _motive motive of the cancelation
function cancelRedemptionRequest(uint256 _redemptionRequestID, string memory _motive) external {
require(
redemptionRequests[_redemptionRequestID].sender != address(0),
"AssetToken: redemptionRequestID does not exist"
);
require(
redemptionRequests[_redemptionRequestID].canceledBy == address(0),
"AssetToken: redemption has been cancelled"
);
require(!redemptionRequests[_redemptionRequestID].completed, "AssetToken: redemption already completed");
require(!redemptionRequests[_redemptionRequestID].fromStake, "AssetToken: staked request - unstake to redeem");
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
if (_msgSender() != redemptionRequests[_redemptionRequestID].sender) {
// not owner of the redemption so guardian or issuer should be the caller
assetTknDtaContract.onlyIssuerOrGuardian(address(this), _msgSender());
}
uint256 refundAmount = redemptionRequests[_redemptionRequestID].assetTokenAmount;
emit RedemptionCanceled(
_redemptionRequestID,
redemptionRequests[_redemptionRequestID].sender,
_motive,
_msgSender()
);
redemptionRequests[_redemptionRequestID].assetTokenAmount = 0;
redemptionRequests[_redemptionRequestID].underlyingAssetAmount = 0;
redemptionRequests[_redemptionRequestID].canceledBy = _msgSender();
_transfer(address(this), redemptionRequests[_redemptionRequestID].sender, refundAmount);
}
/// @notice Approves the Redemption Requests
/// @param _redemptionRequestID redemption request ID to be referenced in the mapping
/// @param _approveTxID the transaction ID
function approveRedemption(uint256 _redemptionRequestID, string memory _approveTxID) public {
checkAccessToFunction(ONLY_ISSUER_OR_GUARDIAN);
require(
redemptionRequests[_redemptionRequestID].canceledBy == address(0),
"AssetToken: redemptionRequestID has been cancelled"
);
require(
redemptionRequests[_redemptionRequestID].sender != address(0),
"AssetToken: redemptionRequestID is incorrect"
);
require(!redemptionRequests[_redemptionRequestID].completed, "AssetToken: redemptionRequestID completed");
if (redemptionRequests[_redemptionRequestID].fromStake) {
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
require(
assetTknDtaContract.isOnSafeguard(address(this)),
"AssetToken: contract is active (not onSafeguard)"
);
}
emit RedemptionApproved(
_redemptionRequestID,
redemptionRequests[_redemptionRequestID].assetTokenAmount,
redemptionRequests[_redemptionRequestID].underlyingAssetAmount,
redemptionRequests[_redemptionRequestID].sender,
_msgSender()
);
redemptionRequests[_redemptionRequestID].completed = true;
redemptionRequests[_redemptionRequestID].approveTxID = _approveTxID;
// burn tokens from the contract
_burn(address(this), redemptionRequests[_redemptionRequestID].assetTokenAmount);
}
/// @notice Burns a certain amount of tokens
/// @param _amount qty of assetTokens to be burned
function burn(uint256 _amount) external {
emit TokenBurned(_amount, _msgSender());
_burn(_msgSender(), _amount);
}
/// @notice Performs the Safeguard Stake
/// @param _amount the assetToken amount to be staked
/// @param _receipt the off chain hash of the redemption transaction
function safeguardStake(uint256 _amount, string calldata _receipt) external nonReentrant {
checkAccessToFunction(ACTIVE_CONTRACT);
require(balanceOf(_msgSender()) >= _amount, "AssetToken: caller has insufficient funds");
safeguardStakes[_msgSender()] = safeguardStakes[_msgSender()] + _amount;
totalStakes = totalStakes + (_amount);
uint256 stakedPercent = (totalStakes * (HUNDRED_PERCENT)) / (totalSupply());
IAssetTokenData assetTknDtaContract = IAssetTokenData(assetTokenDataAddress);
if (stakedPercent >= statePercent) {
require(assetTknDtaContract.setContractToSafeguard(address(this)), "AssetToken: error on safeguard change");
/// @dev now the contract is on safeguard
}
uint256 _requestID = stakedRedemptionRequests[_msgSender()];
if (_requestID == 0) {
/// @dev zero means that it's new request
redemptionRequestID++;
redemptionRequests[redemptionRequestID] = RedemptionRequest(
_msgSender(),
_receipt,
_amount,
0,
false,
true,
"",
address(0)
);
stakedRedemptionRequests[_msgSender()] = redemptionRequestID;
_requestID = redemptionRequestID;
} else {
/// @dev non zero means the request already exist and need only add amount
redemptionRequests[_requestID].assetTokenAmount =
redemptionRequests[_requestID].assetTokenAmount +
(_amount);
}
emit RedemptionRequested(
_requestID,
redemptionRequests[_requestID].assetTokenAmount,
redemptionRequests[_requestID].underlyingAssetAmount,
true,
_msgSender()
);
_transfer(_msgSender(), address(this), _amount);
}
/// @notice Calls to UnStake all the funds
function safeguardUnstake() external {
_safeguardUnstake(safeguardStakes[_msgSender()]);
}
/// @notice Calls to UnStake with a certain amount
/// @param _amount to be unStaked in asset token
function safeguardUnstake(uint256 _amount) external {
_safeguardUnstake(_amount);
}
/// @notice Performs the UnStake with a certain amount
/// @param _amount to be unStaked in asset token
function _safeguardUnstake(uint256 _amount) private {
checkAccessToFunction(ACTIVE_CONTRACT | UNFROZEN_CONTRACT);
require(_amount > 0, "AssetToken: amount must be > 0");
require(safeguardStakes[_msgSender()] >= _amount, "AssetToken: amount exceeds staked");
emit SafeguardUnstaked(_amount, _msgSender());
safeguardStakes[_msgSender()] = safeguardStakes[_msgSender()] - (_amount);
totalStakes = totalStakes - (_amount);
uint256 _requestID = stakedRedemptionRequests[_msgSender()];
redemptionRequests[_requestID].assetTokenAmount = redemptionRequests[_requestID].assetTokenAmount - _amount;
_transfer(address(this), _msgSender(), _amount);
}
function decimals() public view virtual override returns (uint8) {
return _decimals;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
/// @author Swarm Markets
/// @title
/// @notice
/// @notice
interface IAssetTokenData {
function getIssuer(address _tokenAddress) external view returns (address);
function getGuardian(address _tokenAddress) external view returns (address);
function setContractToSafeguard(address _tokenAddress) external returns (bool);
function freezeContract(address _tokenAddress) external returns (bool);
function unfreezeContract(address _tokenAddress) external returns (bool);
function isOnSafeguard(address _tokenAddress) external view returns (bool);
function isContractFrozen(address _tokenAddress) external view returns (bool);
function beforeTokenTransfer(address, address) external;
function onlyStoredToken(address _tokenAddress) external view;
function onlyActiveContract(address _tokenAddress) external view;
function onlyUnfrozenContract(address _tokenAddress) external view;
function onlyIssuer(address _tokenAddress, address _functionCaller) external view;
function onlyIssuerOrGuardian(address _tokenAddress, address _functionCaller) external view;
function onlyIssuerOrAgent(address _tokenAddress, address _functionCaller) external view;
function checkIfTransactionIsAllowed(
address _caller,
address _from,
address _to,
address _tokenAddress,
bytes4 _operation,
bytes calldata _data
) external view returns (bool);
function mustBeAuthorizedHolders(
address _tokenAddress,
address _from,
address _to,
uint256 _amount
) external returns (bool);
function update(address _tokenAddress) external;
function getCurrentRate(address _tokenAddress) external view returns (uint256);
function getInterestRate(address _tokenAddress) external view returns (uint256, bool);
function hasRole(bytes32 role, address account) external view returns (bool);
function isAllowedTransferOnSafeguard(address _tokenAddress, address _account) external view returns (bool);
function registerAssetToken(address _tokenAddress, address _issuer, address _guardian) external returns (bool);
function transferIssuer(address _tokenAddress, address _newIssuer) external;
function setInterestRate(address _tokenAddress, uint256 _interestRate, bool _positiveInterest) external;
function addAgent(address _tokenAddress, address _newAgent) external;
function removeAgent(address _tokenAddress, address _agent) external;
function addMemberToBlacklist(address _tokenAddress, address _account) external;
function removeMemberFromBlacklist(address _tokenAddress, address _account) external;
function allowTransferOnSafeguard(address _tokenAddress, address _account) external;
function preventTransferOnSafeguard(address _tokenAddress, address _account) external;
}