Contract Source Code:
File 1 of 1 : Borroe
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;
/**
* @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;
}
}
/**
* @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 Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_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);
}
}
/**
* @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);
}
/// @title Interface of the BORROE ERC20 token
interface IBorroe is IERC20 {
event AddedToWhitelist(address indexed user);
event RemovedFromWhitelist(address indexed user);
/// @notice Adds a user to the whitelist
/// @param user The user to add to the whitelist
function addToWhitelist(address user) external;
/// @notice Removes a user from the whitelist
/// @param user The used to remove from the whitelist
function removeFromWhitelist(address user) external;
/// @notice Checks that address is whitelisted
/// @param user The address of the user to check
function checkWhitelisted(address user) external view returns (bool);
/// @notice Returns the maximum total supply of tokens
/// @return The maximum total supply of tokens
function maxTotalSupply() external view returns (uint256);
}
/**
* @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);
}
/**
* @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 `sender` to `recipient`.
*
* 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 {}
}
/// @title The native ERC20 token for Borroe system.
contract Borroe is IBorroe, ERC20, Ownable {
uint256 private constant _MAX_TOTAL_SUPPLY = 1e9;
/// @dev Converts from % to basis points and vice versa
uint256 private constant _BP_CONVERTER = 1e4;
// Addresses of initial token distribution destinations
address private immutable _vesting;
address private immutable _liquidityPool;
address private immutable _exchangeListing;
address private immutable _marketing;
address private immutable _treasury;
address private immutable _rewards;
// 50%
uint256 public constant TO_VESTING = 5000;
// 5% + 2.5%
uint256 public constant TO_LOCK_TEAM = 500;
uint256 public constant TO_LOCK_PARTNERS = 250;
// 10%
uint256 public constant TO_LIQUIDITY_POOL = 1000;
uint256 public constant TO_EXCHANGE_LISTING = 1000;
uint256 public constant TO_MARKETING = 1000;
uint256 public constant TO_TREASURY = 1000;
// 2.5%
uint256 public constant TO_REWARDS = 250;
// 1%
uint256 public constant BURNT_ON_TRANSFER = 100;
uint256 public constant TO_MARKETING_ON_TRANSFER = 100;
uint256 public constant TO_REWARDS_ON_TRANSFER = 100;
/// @dev If tokens are transfered to the whitelisted address,
/// 3% of fees are charged
/// @dev DEXes trading BORROE tokens should be whitelisted
/// so that users pay transaction fees (3%) when creating orders
mapping(address => bool) private _whitelist;
/// @param vesting The address of vesting contract
/// @param liquidityPool The address of liquidity pool
/// @param exchangeListing The address of exchange listing wallet
/// @param marketing The address of marketing wallet
/// @param treasury The address of treasury
/// @param rewards The address of rewards wallet
constructor(
address vesting,
address liquidityPool,
address exchangeListing,
address marketing,
address treasury,
address rewards
) ERC20("BORROE", "$ROE") {
require(vesting != address(0), "BORROE: Invalid vesting address");
require(
liquidityPool != address(0),
"BORROE: Invalid liquidity pool address"
);
require(
exchangeListing != address(0),
"BORROE: Invalid exchange listing address"
);
require(marketing != address(0), "BORROE: Invalid marketing address");
require(treasury != address(0), "BORROE: Invalid treasury address");
require(rewards != address(0), "BORROE: Invalid rewards address");
_vesting = vesting;
_liquidityPool = liquidityPool;
_exchangeListing = exchangeListing;
_marketing = marketing;
_treasury = treasury;
_rewards = rewards;
// Mint tokens to vesting contract
// Both vested and locked tokens are minted
_mint(
_vesting,
(_MAX_TOTAL_SUPPLY *
10 ** decimals() *
(TO_VESTING + TO_LOCK_TEAM + TO_LOCK_PARTNERS)) / _BP_CONVERTER
);
// Mint tokens to liquidity pool
_mint(
_liquidityPool,
(_MAX_TOTAL_SUPPLY * 10 ** decimals() * TO_LIQUIDITY_POOL) /
_BP_CONVERTER
);
// Mint tokens to exchange listing
_mint(
_exchangeListing,
(_MAX_TOTAL_SUPPLY * 10 ** decimals() * TO_EXCHANGE_LISTING) /
_BP_CONVERTER
);
// Mint tokens to marketing
_mint(
_marketing,
(_MAX_TOTAL_SUPPLY * 10 ** decimals() * TO_MARKETING) /
_BP_CONVERTER
);
// Mint tokens to treasury
_mint(
_treasury,
(_MAX_TOTAL_SUPPLY * 10 ** decimals() * TO_TREASURY) / _BP_CONVERTER
);
// Mint tokens to rewards
_mint(
_rewards,
(_MAX_TOTAL_SUPPLY * 10 ** decimals() * TO_REWARDS) / _BP_CONVERTER
);
}
/// @notice See {IBorroe-maxTotalSupply}
function maxTotalSupply() external pure returns (uint256) {
return _MAX_TOTAL_SUPPLY * 10 ** decimals();
}
/// @notice See {IBorroe-checkWhitelisted}
function checkWhitelisted(address user) external view returns (bool) {
require(user != address(0), "BORROE: Invalid address");
return _whitelist[user];
}
/// @notice See {IBorroe-addToWhitelist}
function addToWhitelist(address user) external onlyOwner {
require(user != address(0), "BORROE: Invalid address");
require(!_whitelist[user], "BORROE: Address is already whitelisted");
_whitelist[user] = true;
emit AddedToWhitelist(user);
}
/// @notice See {IBorroe-removeFromWhitelist}
function removeFromWhitelist(address user) external onlyOwner {
require(user != address(0), "BORROE: Invalid address");
require(_whitelist[user], "BORROE: Address is not whitelisted");
_whitelist[user] = false;
emit RemovedFromWhitelist(user);
}
/// @notice See {IBorroe-decimals}
function decimals() public pure override returns (uint8) {
return 18;
}
/// @notice Custom transfer function that charges 3% of transfered amount
/// as fees and distributes them
function transfer(
address to,
uint256 amount
) public override(ERC20, IERC20) returns (bool) {
address owner = msg.sender;
// Charge and distribute fees if destination address is whitelisted
if (_whitelist[to]) {
amount = _distributeFees(owner, amount);
}
_transfer(owner, to, amount);
return true;
}
/// @notice Custom transfer function that charges 3% of transfered amount
/// as fees and distributes them
function transferFrom(
address from,
address to,
uint256 amount
) public override(ERC20, IERC20) returns (bool) {
address spender = msg.sender;
_spendAllowance(from, spender, amount);
// Charge and distribute fees if destination address is whitelisted
if (_whitelist[to]) {
amount = _distributeFees(from, amount);
}
_transfer(from, to, amount);
return true;
}
/// @dev Custom mint function limiting total supply
/// @param account The receiver of tokens
/// @param amount The amount of tokens to mint
function _mint(address account, uint256 amount) internal override {
require(
totalSupply() + amount <= _MAX_TOTAL_SUPPLY * 10 ** decimals(),
"BORROE: Mint exceeds max total supply"
);
super._mint(account, amount);
}
/// @dev Calculates parts of fee amount to be distributed among known destinations
/// and distributes them:
/// 1% gets burnt
/// 1% gets transfered to markeing wallet
/// 1% gets transfered to rewards wallet
function _distributeFees(
address from,
uint256 amount
) private returns (uint256) {
require(
from != address(0),
"BORROE: Fees distributor cannot have zero address"
);
require(amount != 0, "BORROE: Invalid fee amount");
uint256 burnt = (amount * BURNT_ON_TRANSFER) / _BP_CONVERTER;
uint256 toMarketing = (amount * TO_MARKETING_ON_TRANSFER) /
_BP_CONVERTER;
uint256 toRewards = (amount * TO_REWARDS_ON_TRANSFER) / _BP_CONVERTER;
_burn(from, burnt);
_transfer(from, _marketing, toMarketing);
_transfer(from, _rewards, toRewards);
uint256 decreasedAmount = amount - burnt - toMarketing - toRewards;
return decreasedAmount;
}
}