Transaction Hash:
Block:
16662695 at Feb-19-2023 12:40:11 PM +UTC
Transaction Fee:
0.002196423516483099 ETH
$4.84
Gas Used:
79,791 Gas / 27.527208789 Gwei
Emitted Events:
| 69 |
FLOKI.Transfer( from=[Sender] 0x59d9086d461e7ab719c768ca166360fc50d54c0b, to=0x7a0c595355eCa8d74307B5EEC1b4a0C19A2C66e2, value=79658031339659001 )
|
Account State Difference:
| Address | Before | After | State Difference | ||
|---|---|---|---|---|---|
| 0x59d9086d...C50d54c0b |
2.065635515445069031 Eth
Nonce: 43
|
2.063439091928585932 Eth
Nonce: 44
| 0.002196423516483099 | ||
|
0x95222290...5CC4BAfe5
Miner
| (beaverbuild) | 73.456706466837900345 Eth | 73.456866048837900345 Eth | 0.000159582 | |
| 0xcf0C122c...Be62b6a2E |
Execution Trace
FLOKI.transfer( recipient=0x7a0c595355eCa8d74307B5EEC1b4a0C19A2C66e2, amount=79658031339659001 ) => ( True )
-
TreasuryHandlerAlpha.beforeTransferHandler( benefactor=0x59d9086d461e7AB719C768Ca166360FC50d54c0b, beneficiary=0x7a0c595355eCa8d74307B5EEC1b4a0C19A2C66e2, amount=79658031339659001 ) -
DynamicTaxHandler.getTax( benefactor=0x59d9086d461e7AB719C768Ca166360FC50d54c0b, beneficiary=0x7a0c595355eCa8d74307B5EEC1b4a0C19A2C66e2, amount=79658031339659001 ) => ( 0 ) -
TreasuryHandlerAlpha.afterTransferHandler( benefactor=0x59d9086d461e7AB719C768Ca166360FC50d54c0b, beneficiary=0x7a0c595355eCa8d74307B5EEC1b4a0C19A2C66e2, amount=79658031339659001 )
transfer[FLOKI (ln:105)]
_transfer[FLOKI (ln:106)]beforeTransferHandler[FLOKI (ln:378)]getTax[FLOKI (ln:379)]_moveDelegates[FLOKI (ln:383)]_writeCheckpoint[FLOKI (ln:316)]Checkpoint[FLOKI (ln:342)]DelegateVotesChanged[FLOKI (ln:345)]
_writeCheckpoint[FLOKI (ln:322)]Checkpoint[FLOKI (ln:342)]DelegateVotesChanged[FLOKI (ln:345)]
_moveDelegates[FLOKI (ln:386)]_writeCheckpoint[FLOKI (ln:316)]Checkpoint[FLOKI (ln:342)]DelegateVotesChanged[FLOKI (ln:345)]
_writeCheckpoint[FLOKI (ln:322)]Checkpoint[FLOKI (ln:342)]DelegateVotesChanged[FLOKI (ln:345)]
Transfer[FLOKI (ln:387)]afterTransferHandler[FLOKI (ln:389)]Transfer[FLOKI (ln:390)]
_msgSender[FLOKI (ln:106)]
File 1 of 3: FLOKI
File 2 of 3: TreasuryHandlerAlpha
File 3 of 3: DynamicTaxHandler
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "./governance/IGovernanceToken.sol";
import "./tax/ITaxHandler.sol";
import "./treasury/ITreasuryHandler.sol";
/**
* @title Floki token contract
* @dev The Floki token has modular systems for tax and treasury handler as well as governance capabilities.
*/
contract FLOKI is IERC20, IGovernanceToken, Ownable {
/// @dev Registry of user token balances.
mapping(address => uint256) private _balances;
/// @dev Registry of addresses users have given allowances to.
mapping(address => mapping(address => uint256)) private _allowances;
/// @notice Registry of user delegates for governance.
mapping(address => address) public delegates;
/// @notice Registry of nonces for vote delegation.
mapping(address => uint256) public nonces;
/// @notice Registry of the number of balance checkpoints an account has.
mapping(address => uint32) public numCheckpoints;
/// @notice Registry of balance checkpoints per account.
mapping(address => mapping(uint32 => Checkpoint)) public checkpoints;
/// @notice The EIP-712 typehash for the contract's domain.
bytes32 public constant DOMAIN_TYPEHASH =
keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)");
/// @notice The EIP-712 typehash for the delegation struct used by the contract.
bytes32 public constant DELEGATION_TYPEHASH =
keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)");
/// @notice The contract implementing tax calculations.
ITaxHandler public taxHandler;
/// @notice The contract that performs treasury-related operations.
ITreasuryHandler public treasuryHandler;
/// @notice Emitted when the tax handler contract is changed.
event TaxHandlerChanged(address oldAddress, address newAddress);
/// @notice Emitted when the treasury handler contract is changed.
event TreasuryHandlerChanged(address oldAddress, address newAddress);
/// @dev Name of the token.
string private _name;
/// @dev Symbol of the token.
string private _symbol;
/**
* @param name_ Name of the token.
* @param symbol_ Symbol of the token.
* @param taxHandlerAddress Initial tax handler contract.
* @param treasuryHandlerAddress Initial treasury handler contract.
*/
constructor(
string memory name_,
string memory symbol_,
address taxHandlerAddress,
address treasuryHandlerAddress
) {
_name = name_;
_symbol = symbol_;
taxHandler = ITaxHandler(taxHandlerAddress);
treasuryHandler = ITreasuryHandler(treasuryHandlerAddress);
_balances[_msgSender()] = totalSupply();
emit Transfer(address(0), _msgSender(), totalSupply());
}
/**
* @notice Get token name.
* @return Name of the token.
*/
function name() public view returns (string memory) {
return _name;
}
/**
* @notice Get token symbol.
* @return Symbol of the token.
*/
function symbol() external view returns (string memory) {
return _symbol;
}
/**
* @notice Get number of decimals used by the token.
* @return Number of decimals used by the token.
*/
function decimals() external pure returns (uint8) {
return 9;
}
/**
* @notice Get the maximum number of tokens.
* @return The maximum number of tokens that will ever be in existence.
*/
function totalSupply() public pure override returns (uint256) {
// Ten trillion, i.e., 10,000,000,000,000 tokens.
return 1e13 * 1e9;
}
/**
* @notice Get token balance of given given account.
* @param account Address to retrieve balance for.
* @return The number of tokens owned by `account`.
*/
function balanceOf(address account) external view override returns (uint256) {
return _balances[account];
}
/**
* @notice Transfer tokens from caller's address to another.
* @param recipient Address to send the caller's tokens to.
* @param amount The number of tokens to transfer to recipient.
* @return True if transfer succeeds, else an error is raised.
*/
function transfer(address recipient, uint256 amount) external override returns (bool) {
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @notice Get the allowance `owner` has given `spender`.
* @param owner The address on behalf of whom tokens can be spent by `spender`.
* @param spender The address authorized to spend tokens on behalf of `owner`.
* @return The allowance `owner` has given `spender`.
*/
function allowance(address owner, address spender) external view override returns (uint256) {
return _allowances[owner][spender];
}
/**
* @notice Approve address to spend caller's tokens.
* @dev This method can be exploited by malicious spenders if their allowance is already non-zero. See the following
* document for details: https://docs.google.com/document/d/1YLPtQxZu1UAvO9cZ1O2RPXBbT0mooh4DYKjA_jp-RLM/edit.
* Ensure the spender can be trusted before calling this method if they've already been approved before. Otherwise
* use either the `increaseAllowance`/`decreaseAllowance` functions, or first set their allowance to zero, before
* setting a new allowance.
* @param spender Address to authorize for token expenditure.
* @param amount The number of tokens `spender` is allowed to spend.
* @return True if the approval succeeds, else an error is raised.
*/
function approve(address spender, uint256 amount) external override returns (bool) {
_approve(_msgSender(), spender, amount);
return true;
}
/**
* @notice Transfer tokens from one address to another.
* @param sender Address to move tokens from.
* @param recipient Address to send the caller's tokens to.
* @param amount The number of tokens to transfer to recipient.
* @return True if the transfer succeeds, else an error is raised.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external override returns (bool) {
_transfer(sender, recipient, amount);
uint256 currentAllowance = _allowances[sender][_msgSender()];
require(
currentAllowance >= amount,
"FLOKI:transferFrom:ALLOWANCE_EXCEEDED: Transfer amount exceeds allowance."
);
unchecked {
_approve(sender, _msgSender(), currentAllowance - amount);
}
return true;
}
/**
* @notice Increase spender's allowance.
* @param spender Address of user authorized to spend caller's tokens.
* @param addedValue The number of tokens to add to `spender`'s allowance.
* @return True if the allowance is successfully increased, else an error is raised.
*/
function increaseAllowance(address spender, uint256 addedValue) external returns (bool) {
_approve(_msgSender(), spender, _allowances[_msgSender()][spender] + addedValue);
return true;
}
/**
* @notice Decrease spender's allowance.
* @param spender Address of user authorized to spend caller's tokens.
* @param subtractedValue The number of tokens to remove from `spender`'s allowance.
* @return True if the allowance is successfully decreased, else an error is raised.
*/
function decreaseAllowance(address spender, uint256 subtractedValue) external returns (bool) {
uint256 currentAllowance = _allowances[_msgSender()][spender];
require(
currentAllowance >= subtractedValue,
"FLOKI:decreaseAllowance:ALLOWANCE_UNDERFLOW: Subtraction results in sub-zero allowance."
);
unchecked {
_approve(_msgSender(), spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @notice Delegate votes to given address.
* @dev It should be noted that users that want to vote themselves, also need to call this method, albeit with their
* own address.
* @param delegatee Address to delegate votes to.
*/
function delegate(address delegatee) external {
return _delegate(msg.sender, delegatee);
}
/**
* @notice Delegate votes from signatory to `delegatee`.
* @param delegatee The address to delegate votes to.
* @param nonce The contract state required to match the signature.
* @param expiry The time at which to expire the signature.
* @param v The recovery byte of the signature.
* @param r Half of the ECDSA signature pair.
* @param s Half of the ECDSA signature pair.
*/
function delegateBySig(
address delegatee,
uint256 nonce,
uint256 expiry,
uint8 v,
bytes32 r,
bytes32 s
) external {
bytes32 domainSeparator = keccak256(
abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name())), block.chainid, address(this))
);
bytes32 structHash = keccak256(abi.encode(DELEGATION_TYPEHASH, delegatee, nonce, expiry));
bytes32 digest = keccak256(abi.encodePacked("\\x19\\x01", domainSeparator, structHash));
address signatory = ecrecover(digest, v, r, s);
require(signatory != address(0), "FLOKI:delegateBySig:INVALID_SIGNATURE: Received signature was invalid.");
require(block.timestamp <= expiry, "FLOKI:delegateBySig:EXPIRED_SIGNATURE: Received signature has expired.");
require(nonce == nonces[signatory]++, "FLOKI:delegateBySig:INVALID_NONCE: Received nonce was invalid.");
return _delegate(signatory, delegatee);
}
/**
* @notice Determine the number of votes for an account as of a block number.
* @dev Block number must be a finalized block or else this function will revert to prevent misinformation.
* @param account The address of the account to check.
* @param blockNumber The block number to get the vote balance at.
* @return The number of votes the account had as of the given block.
*/
function getVotesAtBlock(address account, uint32 blockNumber) public view returns (uint224) {
require(
blockNumber < block.number,
"FLOKI:getVotesAtBlock:FUTURE_BLOCK: Cannot get votes at a block in the future."
);
uint32 nCheckpoints = numCheckpoints[account];
if (nCheckpoints == 0) {
return 0;
}
// First check most recent balance.
if (checkpoints[account][nCheckpoints - 1].blockNumber <= blockNumber) {
return checkpoints[account][nCheckpoints - 1].votes;
}
// Next check implicit zero balance.
if (checkpoints[account][0].blockNumber > blockNumber) {
return 0;
}
// Perform binary search.
uint32 lowerBound = 0;
uint32 upperBound = nCheckpoints - 1;
while (upperBound > lowerBound) {
uint32 center = upperBound - (upperBound - lowerBound) / 2;
Checkpoint memory checkpoint = checkpoints[account][center];
if (checkpoint.blockNumber == blockNumber) {
return checkpoint.votes;
} else if (checkpoint.blockNumber < blockNumber) {
lowerBound = center;
} else {
upperBound = center - 1;
}
}
// No exact block found. Use last known balance before that block number.
return checkpoints[account][lowerBound].votes;
}
/**
* @notice Set new tax handler contract.
* @param taxHandlerAddress Address of new tax handler contract.
*/
function setTaxHandler(address taxHandlerAddress) external onlyOwner {
address oldTaxHandlerAddress = address(taxHandler);
taxHandler = ITaxHandler(taxHandlerAddress);
emit TaxHandlerChanged(oldTaxHandlerAddress, taxHandlerAddress);
}
/**
* @notice Set new treasury handler contract.
* @param treasuryHandlerAddress Address of new treasury handler contract.
*/
function setTreasuryHandler(address treasuryHandlerAddress) external onlyOwner {
address oldTreasuryHandlerAddress = address(treasuryHandler);
treasuryHandler = ITreasuryHandler(treasuryHandlerAddress);
emit TreasuryHandlerChanged(oldTreasuryHandlerAddress, treasuryHandlerAddress);
}
/**
* @notice Delegate votes from one address to another.
* @param delegator Address from which to delegate votes for.
* @param delegatee Address to delegate votes to.
*/
function _delegate(address delegator, address delegatee) private {
address currentDelegate = delegates[delegator];
uint256 delegatorBalance = _balances[delegator];
delegates[delegator] = delegatee;
emit DelegateChanged(delegator, currentDelegate, delegatee);
_moveDelegates(currentDelegate, delegatee, uint224(delegatorBalance));
}
/**
* @notice Move delegates from one address to another.
* @param from Representative to move delegates from.
* @param to Representative to move delegates to.
* @param amount Number of delegates to move.
*/
function _moveDelegates(
address from,
address to,
uint224 amount
) private {
// No need to update checkpoints if the votes don't actually move between different delegates. This can be the
// case where tokens are transferred between two parties that have delegated their votes to the same address.
if (from == to) {
return;
}
// Some users preemptively delegate their votes (i.e. before they have any tokens). No need to perform an update
// to the checkpoints in that case.
if (amount == 0) {
return;
}
if (from != address(0)) {
uint32 fromRepNum = numCheckpoints[from];
uint224 fromRepOld = fromRepNum > 0 ? checkpoints[from][fromRepNum - 1].votes : 0;
uint224 fromRepNew = fromRepOld - amount;
_writeCheckpoint(from, fromRepNum, fromRepOld, fromRepNew);
}
if (to != address(0)) {
uint32 toRepNum = numCheckpoints[to];
uint224 toRepOld = toRepNum > 0 ? checkpoints[to][toRepNum - 1].votes : 0;
uint224 toRepNew = toRepOld + amount;
_writeCheckpoint(to, toRepNum, toRepOld, toRepNew);
}
}
/**
* @notice Write balance checkpoint to chain.
* @param delegatee The address to write the checkpoint for.
* @param nCheckpoints The number of checkpoints `delegatee` already has.
* @param oldVotes Number of votes prior to this checkpoint.
* @param newVotes Number of votes `delegatee` now has.
*/
function _writeCheckpoint(
address delegatee,
uint32 nCheckpoints,
uint224 oldVotes,
uint224 newVotes
) private {
uint32 blockNumber = uint32(block.number);
if (nCheckpoints > 0 && checkpoints[delegatee][nCheckpoints - 1].blockNumber == blockNumber) {
checkpoints[delegatee][nCheckpoints - 1].votes = newVotes;
} else {
checkpoints[delegatee][nCheckpoints] = Checkpoint(blockNumber, newVotes);
numCheckpoints[delegatee] = nCheckpoints + 1;
}
emit DelegateVotesChanged(delegatee, oldVotes, newVotes);
}
/**
* @notice Approve spender on behalf of owner.
* @param owner Address on behalf of whom tokens can be spent by `spender`.
* @param spender Address to authorize for token expenditure.
* @param amount The number of tokens `spender` is allowed to spend.
*/
function _approve(
address owner,
address spender,
uint256 amount
) private {
require(owner != address(0), "FLOKI:_approve:OWNER_ZERO: Cannot approve for the zero address.");
require(spender != address(0), "FLOKI:_approve:SPENDER_ZERO: Cannot approve to the zero address.");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @notice Transfer `amount` tokens from account `from` to account `to`.
* @param from Address the tokens are moved out of.
* @param to Address the tokens are moved to.
* @param amount The number of tokens to transfer.
*/
function _transfer(
address from,
address to,
uint256 amount
) private {
require(from != address(0), "FLOKI:_transfer:FROM_ZERO: Cannot transfer from the zero address.");
require(to != address(0), "FLOKI:_transfer:TO_ZERO: Cannot transfer to the zero address.");
require(amount > 0, "FLOKI:_transfer:ZERO_AMOUNT: Transfer amount must be greater than zero.");
require(amount <= _balances[from], "FLOKI:_transfer:INSUFFICIENT_BALANCE: Transfer amount exceeds balance.");
treasuryHandler.beforeTransferHandler(from, to, amount);
uint256 tax = taxHandler.getTax(from, to, amount);
uint256 taxedAmount = amount - tax;
_balances[from] -= amount;
_balances[to] += taxedAmount;
_moveDelegates(delegates[from], delegates[to], uint224(taxedAmount));
if (tax > 0) {
_balances[address(treasuryHandler)] += tax;
_moveDelegates(delegates[from], delegates[address(treasuryHandler)], uint224(tax));
emit Transfer(from, address(treasuryHandler), tax);
}
treasuryHandler.afterTransferHandler(from, to, amount);
emit Transfer(from, to, taxedAmount);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external returns (bool);
/**
* @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);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @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() {
_setOwner(_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 {
_setOwner(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");
_setOwner(newOwner);
}
function _setOwner(address newOwner) private {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
/**
* @title Governance token interface.
*/
interface IGovernanceToken {
/// @notice A checkpoint for marking number of votes as of a given block.
struct Checkpoint {
// The 32-bit unsigned integer is valid until these estimated dates for these given chains:
// - BSC: Sat Dec 23 2428 18:23:11 UTC
// - ETH: Tue Apr 18 3826 09:27:12 UTC
// This assumes that block mining rates don't speed up.
uint32 blockNumber;
// This type is set to `uint224` for optimizations purposes (i.e., specifically to fit in a 32-byte block). It
// assumes that the number of votes for the implementing governance token never exceeds the maximum value for a
// 224-bit number.
uint224 votes;
}
/**
* @notice Determine the number of votes for an account as of a block number.
* @dev Block number must be a finalized block or else this function will revert to prevent misinformation.
* @param account The address of the account to check.
* @param blockNumber The block number to get the vote balance at.
* @return The number of votes the account had as of the given block.
*/
function getVotesAtBlock(address account, uint32 blockNumber) external view returns (uint224);
/// @notice Emitted whenever a new delegate is set for an account.
event DelegateChanged(address delegator, address currentDelegate, address newDelegate);
/// @notice Emitted when a delegate's vote count changes.
event DelegateVotesChanged(address delegatee, uint224 oldVotes, uint224 newVotes);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
/**
* @title Tax handler interface
* @dev Any class that implements this interface can be used for protocol-specific tax calculations.
*/
interface ITaxHandler {
/**
* @notice Get number of tokens to pay as tax.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
* @return Number of tokens to pay as tax.
*/
function getTax(
address benefactor,
address beneficiary,
uint256 amount
) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
/**
* @title Treasury handler interface
* @dev Any class that implements this interface can be used for protocol-specific operations pertaining to the treasury.
*/
interface ITreasuryHandler {
/**
* @notice Perform operations before a transfer is executed.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function beforeTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external;
/**
* @notice Perform operations after a transfer is executed.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function afterTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external;
}
// SPDX-License-Identifier: MIT
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 2 of 3: TreasuryHandlerAlpha
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@uniswap/v2-periphery/contracts/interfaces/IUniswapV2Router02.sol";
import "../utils/ExchangePoolProcessor.sol";
import "../utils/LenientReentrancyGuard.sol";
import "./ITreasuryHandler.sol";
/**
* @title Treasury handler alpha contract
* @dev Sells tokens that have accumulated through taxes and sends the resulting ETH to the treasury. If
* `liquidityBasisPoints` has been set to a non-zero value, then that percentage will instead be added to the designated
* liquidity pool.
*/
contract TreasuryHandlerAlpha is ITreasuryHandler, LenientReentrancyGuard, ExchangePoolProcessor {
using Address for address payable;
using EnumerableSet for EnumerableSet.AddressSet;
/// @notice The treasury address.
address payable public treasury;
/// @notice The token that accumulates through taxes. This will be sold for ETH.
IERC20 public token;
/// @notice The basis points of tokens to sell and add as liquidity to the pool.
uint256 public liquidityBasisPoints;
/// @notice The maximum price impact the sell (initiated from this contract) may have.
uint256 public priceImpactBasisPoints;
/// @notice The Uniswap router that handles the sell and liquidity operations.
IUniswapV2Router02 public router;
/// @notice Emitted when the basis points value of tokens to add as liquidity is updated.
event LiquidityBasisPointsUpdated(uint256 oldBasisPoints, uint256 newBasisPoints);
/// @notice Emitted when the maximum price impact basis points value is updated.
event PriceImpactBasisPointsUpdated(uint256 oldBasisPoints, uint256 newBasisPoints);
/// @notice Emitted when the treasury address is updated.
event TreasuryAddressUpdated(address oldTreasuryAddress, address newTreasuryAddress);
/**
* @param treasuryAddress Address of treasury to use.
* @param tokenAddress Address of token to accumulate and sell.
* @param routerAddress Address of Uniswap router for sell and liquidity operations.
* @param initialLiquidityBasisPoints Initial basis points value of swap to add to liquidity.
* @param initialPriceImpactBasisPoints Initial basis points value of price impact to account for during swaps.
*/
constructor(
address treasuryAddress,
address tokenAddress,
address routerAddress,
uint256 initialLiquidityBasisPoints,
uint256 initialPriceImpactBasisPoints
) {
treasury = payable(treasuryAddress);
token = IERC20(tokenAddress);
router = IUniswapV2Router02(routerAddress);
liquidityBasisPoints = initialLiquidityBasisPoints;
priceImpactBasisPoints = initialPriceImpactBasisPoints;
}
/**
* @notice Perform operations before a sell action (or a liquidity addition) is executed. The accumulated tokens are
* then sold for ETH. In case the number of accumulated tokens exceeds the price impact percentage threshold, then
* the number will be adjusted to stay within the threshold. If a non-zero percentage is set for liquidity, then
* that percentage will be added to the primary liquidity pool instead of being sold for ETH and sent to the
* treasury.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function beforeTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external nonReentrant {
// Silence a few warnings. This will be optimized out by the compiler.
benefactor;
amount;
// No actions are done on transfers other than sells.
if (!_exchangePools.contains(beneficiary)) {
return;
}
uint256 contractTokenBalance = token.balanceOf(address(this));
if (contractTokenBalance > 0) {
uint256 primaryPoolBalance = token.balanceOf(primaryPool);
uint256 maxPriceImpactSale = (primaryPoolBalance * priceImpactBasisPoints) / 10000;
// Ensure the price impact is within reasonable bounds.
if (contractTokenBalance > maxPriceImpactSale) {
contractTokenBalance = maxPriceImpactSale;
}
// The number of tokens to sell for liquidity purposes. This is calculated as follows:
//
// B P
// L = - * -----
// 2 10000
//
// Where:
// L = tokens to sell for liquidity
// B = available token balance
// P = basis points of tokens to use for liquidity
//
// The number is divided by two to preserve the token side of the token/WETH pool.
uint256 tokensForLiquidity = (contractTokenBalance * liquidityBasisPoints) / 20000;
uint256 tokensForSwap = contractTokenBalance - tokensForLiquidity;
uint256 currentWeiBalance = address(this).balance;
_swapTokensForEth(tokensForSwap);
uint256 weiEarned = address(this).balance - currentWeiBalance;
// No need to divide this number, because that was only to have enough tokens remaining to pair with this
// ETH value.
uint256 weiForLiquidity = (weiEarned * liquidityBasisPoints) / 10000;
if (tokensForLiquidity > 0) {
_addLiquidity(tokensForLiquidity, weiForLiquidity);
}
// It's cheaper to get the active balance rather than calculating based off of the `currentWeiBalance` and
// `weiForLiquidity` numbers.
uint256 remainingWeiBalance = address(this).balance;
if (remainingWeiBalance > 0) {
treasury.sendValue(remainingWeiBalance);
}
}
}
/**
* @notice Perform post-transfer operations. This contract ignores those operations, hence nothing happens.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function afterTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external nonReentrant {
// Silence a few warnings. This will be optimized out by the compiler.
benefactor;
beneficiary;
amount;
return;
}
/**
* @notice Set new liquidity basis points value.
* @param newBasisPoints New liquidity basis points value. Cannot exceed 10,000 (i.e., 100%) as that would break the
* calculation.
*/
function setLiquidityBasisPoints(uint256 newBasisPoints) external onlyOwner {
require(
newBasisPoints <= 10000,
"TreasuryHandlerAlpha:setLiquidityPercentage:INVALID_PERCENTAGE: Cannot set more than 10,000 basis points."
);
uint256 oldBasisPoints = liquidityBasisPoints;
liquidityBasisPoints = newBasisPoints;
emit LiquidityBasisPointsUpdated(oldBasisPoints, newBasisPoints);
}
/**
* @notice Set new price impact basis points value.
* @param newBasisPoints New price impact basis points value.
*/
function setPriceImpactBasisPoints(uint256 newBasisPoints) external onlyOwner {
require(
newBasisPoints < 1500,
"TreasuryHandlerAlpha:setPriceImpactBasisPoints:OUT_OF_BOUNDS: Cannot set price impact too high."
);
uint256 oldBasisPoints = priceImpactBasisPoints;
priceImpactBasisPoints = newBasisPoints;
emit PriceImpactBasisPointsUpdated(oldBasisPoints, newBasisPoints);
}
/**
* @notice Set new treasury address.
* @param newTreasuryAddress New treasury address.
*/
function setTreasury(address newTreasuryAddress) external onlyOwner {
require(
newTreasuryAddress != address(0),
"TreasuryHandlerAlpha:setTreasury:ZERO_TREASURY: Cannot set zero address as treasury."
);
address oldTreasuryAddress = address(treasury);
treasury = payable(newTreasuryAddress);
emit TreasuryAddressUpdated(oldTreasuryAddress, newTreasuryAddress);
}
/**
* @notice Withdraw any tokens or ETH stuck in the treasury handler.
* @param tokenAddress Address of the token to withdraw. If set to the zero address, ETH will be withdrawn.
* @param amount The number of tokens to withdraw.
*/
function withdraw(address tokenAddress, uint256 amount) external onlyOwner {
require(
tokenAddress != address(token),
"TreasuryHandlerAlpha:withdraw:INVALID_TOKEN: Not allowed to withdraw token required for swaps."
);
if (tokenAddress == address(0)) {
treasury.sendValue(amount);
} else {
IERC20(tokenAddress).transferFrom(address(this), address(treasury), amount);
}
}
/**
* @dev Swap accumulated tokens for ETH.
* @param tokenAmount Number of tokens to swap for ETH.
*/
function _swapTokensForEth(uint256 tokenAmount) private {
// The ETH/token pool is the primary pool. It always exists.
address[] memory path = new address[](2);
path[0] = address(token);
path[1] = router.WETH();
// Ensure the router can perform the swap for the designated number of tokens.
token.approve(address(router), tokenAmount);
router.swapExactTokensForETHSupportingFeeOnTransferTokens(tokenAmount, 0, path, address(this), block.timestamp);
}
/**
* @dev Add liquidity to primary pool.
* @param tokenAmount Number of tokens to add as liquidity.
* @param weiAmount ETH value to pair with the tokens.
*/
function _addLiquidity(uint256 tokenAmount, uint256 weiAmount) private {
// Ensure the router can perform the transfer for the designated number of tokens.
token.approve(address(router), tokenAmount);
// Both minimum values are set to zero to allow for any form of slippage.
router.addLiquidityETH{ value: weiAmount }(
address(token),
tokenAmount,
0,
0,
address(treasury),
block.timestamp
);
}
/**
* @notice Allow contract to accept ETH.
*/
receive() external payable {}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external returns (bool);
/**
* @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);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @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
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
assembly {
size := extcodesize(account)
}
return size > 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
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
pragma solidity >=0.6.2;
import './IUniswapV2Router01.sol';
interface IUniswapV2Router02 is IUniswapV2Router01 {
function removeLiquidityETHSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountETH);
function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountETH);
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
function swapExactETHForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
function swapExactTokensForETHSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
/**
* @title Exchange pool processor abstract contract.
* @dev Keeps an enumerable set of designated exchange addresses as well as a single primary pool address.
*/
abstract contract ExchangePoolProcessor is Ownable {
using EnumerableSet for EnumerableSet.AddressSet;
/// @dev Set of exchange pool addresses.
EnumerableSet.AddressSet internal _exchangePools;
/// @notice Primary exchange pool address.
address public primaryPool;
/// @notice Emitted when an exchange pool address is added to the set of tracked pool addresses.
event ExchangePoolAdded(address exchangePool);
/// @notice Emitted when an exchange pool address is removed from the set of tracked pool addresses.
event ExchangePoolRemoved(address exchangePool);
/// @notice Emitted when the primary pool address is updated.
event PrimaryPoolUpdated(address oldPrimaryPool, address newPrimaryPool);
/**
* @notice Get list of addresses designated as exchange pools.
* @return An array of exchange pool addresses.
*/
function getExchangePoolAddresses() external view returns (address[] memory) {
return _exchangePools.values();
}
/**
* @notice Add an address to the set of exchange pool addresses.
* @dev Nothing happens if the pool already exists in the set.
* @param exchangePool Address of exchange pool to add.
*/
function addExchangePool(address exchangePool) external onlyOwner {
if (_exchangePools.add(exchangePool)) {
emit ExchangePoolAdded(exchangePool);
}
}
/**
* @notice Remove an address from the set of exchange pool addresses.
* @dev Nothing happens if the pool doesn't exist in the set..
* @param exchangePool Address of exchange pool to remove.
*/
function removeExchangePool(address exchangePool) external onlyOwner {
if (_exchangePools.remove(exchangePool)) {
emit ExchangePoolRemoved(exchangePool);
}
}
/**
* @notice Set exchange pool address as primary pool.
* @dev To prevent issues, only addresses inside the set of exchange pool addresses can be selected as primary pool.
* @param exchangePool Address of exchange pool to set as primary pool.
*/
function setPrimaryPool(address exchangePool) external onlyOwner {
require(
_exchangePools.contains(exchangePool),
"ExchangePoolProcessor:setPrimaryPool:INVALID_POOL: Given address is not registered as exchange pool."
);
require(
primaryPool != exchangePool,
"ExchangePoolProcessor:setPrimaryPool:ALREADY_SET: This address is already the primary pool address."
);
address oldPrimaryPool = primaryPool;
primaryPool = exchangePool;
emit PrimaryPoolUpdated(oldPrimaryPool, exchangePool);
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
/**
* @title Lenient Reentrancy Guard
* @dev A near carbon copy of OpenZeppelin's ReentrancyGuard contract. The difference between the two being that this
* contract will silently return instead of failing.
*/
abstract contract LenientReentrancyGuard {
// 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() {
if (_status == _ENTERED) {
return;
}
_status = _ENTERED;
_;
// 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
pragma solidity 0.8.11;
/**
* @title Treasury handler interface
* @dev Any class that implements this interface can be used for protocol-specific operations pertaining to the treasury.
*/
interface ITreasuryHandler {
/**
* @notice Perform operations before a transfer is executed.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function beforeTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external;
/**
* @notice Perform operations after a transfer is executed.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
*/
function afterTransferHandler(
address benefactor,
address beneficiary,
uint256 amount
) external;
}
pragma solidity >=0.6.2;
interface IUniswapV2Router01 {
function factory() external pure returns (address);
function WETH() external pure returns (address);
function addLiquidity(
address tokenA,
address tokenB,
uint amountADesired,
uint amountBDesired,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB, uint liquidity);
function addLiquidityETH(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountETH, uint liquidity);
function removeLiquidity(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB);
function removeLiquidityETH(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountETH);
function removeLiquidityWithPermit(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountA, uint amountB);
function removeLiquidityETHWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountETH);
function swapExactTokensForTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapTokensForExactTokens(
uint amountOut,
uint amountInMax,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapExactETHForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function swapTokensForExactETH(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapExactTokensForETH(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapETHForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function quote(uint amountA, uint reserveA, uint reserveB) external pure returns (uint amountB);
function getAmountOut(uint amountIn, uint reserveIn, uint reserveOut) external pure returns (uint amountOut);
function getAmountIn(uint amountOut, uint reserveIn, uint reserveOut) external pure returns (uint amountIn);
function getAmountsOut(uint amountIn, address[] calldata path) external view returns (uint[] memory amounts);
function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @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() {
_setOwner(_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 {
_setOwner(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");
_setOwner(newOwner);
}
function _setOwner(address newOwner) private {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
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.
*/
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;
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;
assembly {
result := store
}
return result;
}
}
// SPDX-License-Identifier: MIT
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 3 of 3: DynamicTaxHandler
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import "./ITaxHandler.sol";
import "../utils/ExchangePoolProcessor.sol";
/**
* @title Dynamic tax handler
* @notice Processes tax for a given token transfer. Checks for the following:
* - Is the address on the static blacklist? If so, it can only transfer to the
* `receiver` address. In all other cases, the transfer will fail.
* - Is the address exempt from taxes, if so, the number of taxed tokens is
* always zero.
* - Is it a transfer between "regular" users? This means they are not on the
* list of either blacklisted or exempt addresses, nor are they an address
* designated as an exchange pool.
* - Is it a transfer towards or from an exchange pool? If so, the transaction
* is taxed according to its relative size to the exchange pool.
*/
contract DynamicTaxHandler is ITaxHandler, ExchangePoolProcessor {
using EnumerableSet for EnumerableSet.AddressSet;
struct TaxCheckpoint {
uint256 threshold;
uint256 basisPoints;
}
/// @notice The default buy tax in basis points.
uint256 public baseBuyTaxBasisPoints;
/// @notice The default sell tax in basis points.
uint256 public baseSellTaxBasisPoints;
/// @dev The registry of buy tax checkpoints. Used to keep track of the
/// correct number of tokens to deduct as tax when buying.
mapping(uint256 => TaxCheckpoint) private _buyTaxBasisPoints;
/// @dev The number of buy tax checkpoints in the registry.
uint256 private _buyTaxPoints;
/// @dev The registry of sell tax checkpoints. Used to keep track of the
/// correct number of tokens to deduct as tax when selling.
mapping(uint256 => TaxCheckpoint) private _sellTaxBasisPoints;
/// @dev The number of sell tax checkpoints in the registry.
uint256 private _sellTaxPoints;
/// @notice Registry of blacklisted addresses.
mapping (address => bool) public isBlacklisted;
/// @notice The only address the blacklisted addresses can still transfer tokens to.
address public immutable receiver;
/// @dev The set of addresses exempt from tax.
EnumerableSet.AddressSet private _exempted;
/// @notice The token to account for.
IERC20 public token;
/// @notice Emitted whenever the base buy tax basis points value is changed.
event BaseBuyTaxBasisPointsChanged(uint256 previousValue, uint256 newValue);
/// @notice Emitted whenever the base sell tax basis points value is changed.
event BaseSellTaxBasisPointsChanged(uint256 previousValue, uint256 newValue);
/// @notice Emitted whenever a buy tax checkpoint is added.
event BuyTaxCheckpointAdded(uint256 threshold, uint256 basisPoints);
/// @notice Emitted whenever a buy tax checkpoint is removed.
event BuyTaxCheckpointRemoved(uint256 threshold, uint256 basisPoints);
/// @notice Emitted whenever a sell tax checkpoint is added.
event SellTaxCheckpointAdded(uint256 threshold, uint256 basisPoints);
/// @notice Emitted whenever a sell tax checkpoint is removed.
event SellTaxCheckpointRemoved(uint256 threshold, uint256 basisPoints);
/// @notice Emitted when an address is added to or removed from the exempted addresses set.
event TaxExemptionUpdated(address indexed wallet, bool exempted);
/**
* @param tokenAddress Address of the token to account for when interacting
* with exchange pools.
* @param receiverAddress The only address the blacklisted addresses can
* send tokens to.
* @param blacklistedAddresses The list of addresses that are banned from
* performing transfers. They can still receive tokens however.
*/
constructor(
address tokenAddress,
address receiverAddress,
address[] memory blacklistedAddresses
) {
token = IERC20(tokenAddress);
receiver = receiverAddress;
for (uint256 i = 0; i < blacklistedAddresses.length; i++) {
isBlacklisted[blacklistedAddresses[i]] = true;
}
}
/**
* @notice Get number of tokens to pay as tax.
* @dev There is no easy way to differentiate between a user swapping
* tokens and a user adding or removing liquidity to the pool. In both
* cases tokens are transferred to or from the pool. This is an unfortunate
* case where users have to accept being taxed on liquidity additions and
* removal. To get around this issue a separate liquidity addition contract
* can be deployed. This contract could be exempt from taxes if its
* functionality is verified to only add and remove liquidity.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
* @return Number of tokens to pay as tax.
*/
function getTax(
address benefactor,
address beneficiary,
uint256 amount
) external view returns (uint256) {
// Blacklisted addresses are only allowed to transfer to the receiver.
if (isBlacklisted[benefactor]) {
if (beneficiary == receiver) {
return 0;
} else {
revert("DynamicTaxHandler:getTax:BLACKLISTED: Benefactor has been blacklisted");
}
}
// Exempted addresses don't pay tax.
if (_exempted.contains(benefactor) || _exempted.contains(beneficiary)) {
return 0;
}
// Transactions between regular users (this includes contracts) aren't taxed.
if (!_exchangePools.contains(benefactor) && !_exchangePools.contains(beneficiary)) {
return 0;
}
// Transactions between pools aren't taxed.
if (_exchangePools.contains(benefactor) && _exchangePools.contains(beneficiary)) {
return 0;
}
uint256 poolBalance = token.balanceOf(primaryPool);
uint256 basisPoints;
// If the benefactor is found in the set of exchange pools, then it's a buy transactions, otherwise a sell
// transactions, because the other use cases have already been checked above.
if (_exchangePools.contains(benefactor)) {
basisPoints = _getBuyTaxBasisPoints(amount, poolBalance);
} else {
basisPoints = _getSellTaxBasisPoints(amount, poolBalance);
}
return (amount * basisPoints) / 10000;
}
/**
* @notice Set buy tax basis points value.
* @param basisPoints The new buy tax basis points base value.
*/
function setBaseBuyTaxBasisPoints(uint256 basisPoints) external onlyOwner {
uint256 previousBuyTaxBasisPoints = baseBuyTaxBasisPoints;
baseBuyTaxBasisPoints = basisPoints;
emit BaseBuyTaxBasisPointsChanged(previousBuyTaxBasisPoints, basisPoints);
}
/**
* @notice Set base sell tax basis points value.
* @param basisPoints The new sell tax basis points base value.
*/
function setBaseSellTaxBasisPoints(uint256 basisPoints) external onlyOwner {
uint256 previousSellTaxBasisPoints = baseSellTaxBasisPoints;
baseSellTaxBasisPoints = basisPoints;
emit BaseSellTaxBasisPointsChanged(previousSellTaxBasisPoints, basisPoints);
}
/**
* @notice Set buy tax checkpoints
* @param thresholds Array containing the threshold values of the buy tax checkpoints.
* @param basisPoints Array containing the basis points values of the buy tax checkpoints.
*/
function setBuyTaxCheckpoints(uint256[] memory thresholds, uint256[] memory basisPoints) external onlyOwner {
require(
thresholds.length == basisPoints.length,
"DynamicTaxHandler:setBuyTaxBasisPoints:UNEQUAL_LENGTHS: Array lengths should be equal."
);
// Reset previous points
for (uint256 i = 0; i < _buyTaxPoints; i++) {
emit BuyTaxCheckpointRemoved(_buyTaxBasisPoints[i].threshold, _buyTaxBasisPoints[i].basisPoints);
_buyTaxBasisPoints[i].basisPoints = 0;
_buyTaxBasisPoints[i].threshold = 0;
}
_buyTaxPoints = thresholds.length;
for (uint256 i = 0; i < thresholds.length; i++) {
_buyTaxBasisPoints[i] = TaxCheckpoint({ basisPoints: basisPoints[i], threshold: thresholds[i] });
emit BuyTaxCheckpointAdded(_buyTaxBasisPoints[i].threshold, _buyTaxBasisPoints[i].basisPoints);
}
}
/**
* @notice Set sell tax checkpoints
* @param thresholds Array containing the threshold values of the sell tax checkpoints.
* @param basisPoints Array containing the basis points values of the sell tax checkpoints.
*/
function setSellTaxCheckpoints(uint256[] memory thresholds, uint256[] memory basisPoints) external onlyOwner {
require(
thresholds.length == basisPoints.length,
"DynamicTaxHandler:setSellTaxBasisPoints:UNEQUAL_LENGTHS: Array lengths should be equal."
);
// Reset previous points
for (uint256 i = 0; i < _sellTaxPoints; i++) {
emit SellTaxCheckpointRemoved(_sellTaxBasisPoints[i].threshold, _sellTaxBasisPoints[i].basisPoints);
_sellTaxBasisPoints[i].basisPoints = 0;
_sellTaxBasisPoints[i].threshold = 0;
}
_sellTaxPoints = thresholds.length;
for (uint256 i = 0; i < thresholds.length; i++) {
_sellTaxBasisPoints[i] = TaxCheckpoint({ basisPoints: basisPoints[i], threshold: thresholds[i] });
emit SellTaxCheckpointAdded(_sellTaxBasisPoints[i].threshold, _sellTaxBasisPoints[i].basisPoints);
}
}
/**
* @notice Add address to set of tax-exempted addresses.
* @param exemption Address to add to set of tax-exempted addresses.
*/
function addExemption(address exemption) external onlyOwner {
if (_exempted.add(exemption)) {
emit TaxExemptionUpdated(exemption, true);
}
}
/**
* @notice Remove address from set of tax-exempted addresses.
* @param exemption Address to remove from set of tax-exempted addresses.
*/
function removeExemption(address exemption) external onlyOwner {
if (_exempted.remove(exemption)) {
emit TaxExemptionUpdated(exemption, false);
}
}
function _getBuyTaxBasisPoints(uint256 amount, uint256 poolBalance) private view returns (uint256 taxBasisPoints) {
taxBasisPoints = baseBuyTaxBasisPoints;
uint256 basisPoints = (amount * 10000) / poolBalance;
for (uint256 i = 0; i < _buyTaxPoints; i++) {
if (_buyTaxBasisPoints[i].threshold <= basisPoints) {
taxBasisPoints = _buyTaxBasisPoints[i].basisPoints;
}
}
}
function _getSellTaxBasisPoints(uint256 amount, uint256 poolBalance) private view returns (uint256 taxBasisPoints) {
taxBasisPoints = baseSellTaxBasisPoints;
uint256 basisPoints = (amount * 10000) / poolBalance;
for (uint256 i = 0; i < _sellTaxPoints; i++) {
if (_sellTaxBasisPoints[i].threshold <= basisPoints) {
taxBasisPoints = _sellTaxBasisPoints[i].basisPoints;
}
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external returns (bool);
/**
* @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);
}
// SPDX-License-Identifier: MIT
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.
*/
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;
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;
assembly {
result := store
}
return result;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
/**
* @title Tax handler interface
* @dev Any class that implements this interface can be used for protocol-specific tax calculations.
*/
interface ITaxHandler {
/**
* @notice Get number of tokens to pay as tax.
* @param benefactor Address of the benefactor.
* @param beneficiary Address of the beneficiary.
* @param amount Number of tokens in the transfer.
* @return Number of tokens to pay as tax.
*/
function getTax(
address benefactor,
address beneficiary,
uint256 amount
) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.11;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
/**
* @title Exchange pool processor abstract contract.
* @dev Keeps an enumerable set of designated exchange addresses as well as a single primary pool address.
*/
abstract contract ExchangePoolProcessor is Ownable {
using EnumerableSet for EnumerableSet.AddressSet;
/// @dev Set of exchange pool addresses.
EnumerableSet.AddressSet internal _exchangePools;
/// @notice Primary exchange pool address.
address public primaryPool;
/// @notice Emitted when an exchange pool address is added to the set of tracked pool addresses.
event ExchangePoolAdded(address exchangePool);
/// @notice Emitted when an exchange pool address is removed from the set of tracked pool addresses.
event ExchangePoolRemoved(address exchangePool);
/// @notice Emitted when the primary pool address is updated.
event PrimaryPoolUpdated(address oldPrimaryPool, address newPrimaryPool);
/**
* @notice Get list of addresses designated as exchange pools.
* @return An array of exchange pool addresses.
*/
function getExchangePoolAddresses() external view returns (address[] memory) {
return _exchangePools.values();
}
/**
* @notice Add an address to the set of exchange pool addresses.
* @dev Nothing happens if the pool already exists in the set.
* @param exchangePool Address of exchange pool to add.
*/
function addExchangePool(address exchangePool) external onlyOwner {
if (_exchangePools.add(exchangePool)) {
emit ExchangePoolAdded(exchangePool);
}
}
/**
* @notice Remove an address from the set of exchange pool addresses.
* @dev Nothing happens if the pool doesn't exist in the set..
* @param exchangePool Address of exchange pool to remove.
*/
function removeExchangePool(address exchangePool) external onlyOwner {
if (_exchangePools.remove(exchangePool)) {
emit ExchangePoolRemoved(exchangePool);
}
}
/**
* @notice Set exchange pool address as primary pool.
* @dev To prevent issues, only addresses inside the set of exchange pool addresses can be selected as primary pool.
* @param exchangePool Address of exchange pool to set as primary pool.
*/
function setPrimaryPool(address exchangePool) external onlyOwner {
require(
_exchangePools.contains(exchangePool),
"ExchangePoolProcessor:setPrimaryPool:INVALID_POOL: Given address is not registered as exchange pool."
);
require(
primaryPool != exchangePool,
"ExchangePoolProcessor:setPrimaryPool:ALREADY_SET: This address is already the primary pool address."
);
address oldPrimaryPool = primaryPool;
primaryPool = exchangePool;
emit PrimaryPoolUpdated(oldPrimaryPool, exchangePool);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @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() {
_setOwner(_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 {
_setOwner(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");
_setOwner(newOwner);
}
function _setOwner(address newOwner) private {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
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;
}
}