Contract Name:
Zapper_Matic_Bridge_V1_1
Contract Source Code:
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../oz/0.8.0/access/Ownable.sol";
import "../oz/0.8.0/token/ERC20/utils/SafeERC20.sol";
abstract contract ZapBaseV2 is Ownable {
using SafeERC20 for IERC20;
bool public stopped = false;
// if true, goodwill is not deducted
mapping(address => bool) public feeWhitelist;
uint256 public goodwill;
// % share of goodwill (0-100 %)
uint256 affiliateSplit;
// restrict affiliates
mapping(address => bool) public affiliates;
// affiliate => token => amount
mapping(address => mapping(address => uint256)) public affiliateBalance;
// token => amount
mapping(address => uint256) public totalAffiliateBalance;
// swapTarget => approval status
mapping(address => bool) public approvedTargets;
address internal constant ETHAddress =
0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
constructor(uint256 _goodwill, uint256 _affiliateSplit) {
goodwill = _goodwill;
affiliateSplit = _affiliateSplit;
}
// circuit breaker modifiers
modifier stopInEmergency {
if (stopped) {
revert("Temporarily Paused");
} else {
_;
}
}
function _getBalance(address token)
internal
view
returns (uint256 balance)
{
if (token == address(0)) {
balance = address(this).balance;
} else {
balance = IERC20(token).balanceOf(address(this));
}
}
function _approveToken(address token, address spender) internal {
IERC20 _token = IERC20(token);
if (_token.allowance(address(this), spender) > 0) return;
else {
_token.safeApprove(spender, type(uint256).max);
}
}
function _approveToken(
address token,
address spender,
uint256 amount
) internal {
IERC20(token).safeApprove(spender, 0);
IERC20(token).safeApprove(spender, amount);
}
// - to Pause the contract
function toggleContractActive() public onlyOwner {
stopped = !stopped;
}
function set_feeWhitelist(address zapAddress, bool status)
external
onlyOwner
{
feeWhitelist[zapAddress] = status;
}
function set_new_goodwill(uint256 _new_goodwill) public onlyOwner {
require(
_new_goodwill >= 0 && _new_goodwill <= 100,
"GoodWill Value not allowed"
);
goodwill = _new_goodwill;
}
function set_new_affiliateSplit(uint256 _new_affiliateSplit)
external
onlyOwner
{
require(
_new_affiliateSplit <= 100,
"Affiliate Split Value not allowed"
);
affiliateSplit = _new_affiliateSplit;
}
function set_affiliate(address _affiliate, bool _status)
external
onlyOwner
{
affiliates[_affiliate] = _status;
}
///@notice Withdraw goodwill share, retaining affilliate share
function withdrawTokens(address[] calldata tokens) external onlyOwner {
for (uint256 i = 0; i < tokens.length; i++) {
uint256 qty;
if (tokens[i] == ETHAddress) {
qty = address(this).balance - totalAffiliateBalance[tokens[i]];
Address.sendValue(payable(owner()), qty);
} else {
qty =
IERC20(tokens[i]).balanceOf(address(this)) -
totalAffiliateBalance[tokens[i]];
IERC20(tokens[i]).safeTransfer(owner(), qty);
}
}
}
///@notice Withdraw affilliate share, retaining goodwill share
function affilliateWithdraw(address[] calldata tokens) external {
uint256 tokenBal;
for (uint256 i = 0; i < tokens.length; i++) {
tokenBal = affiliateBalance[msg.sender][tokens[i]];
affiliateBalance[msg.sender][tokens[i]] = 0;
totalAffiliateBalance[tokens[i]] =
totalAffiliateBalance[tokens[i]] -
tokenBal;
if (tokens[i] == ETHAddress) {
Address.sendValue(payable(msg.sender), tokenBal);
} else {
IERC20(tokens[i]).safeTransfer(msg.sender, tokenBal);
}
}
}
function setApprovedTargets(
address[] calldata targets,
bool[] calldata isApproved
) external onlyOwner {
require(targets.length == isApproved.length, "Invalid Input length");
for (uint256 i = 0; i < targets.length; i++) {
approvedTargets[targets[i]] = isApproved[i];
}
}
receive() external payable {
require(msg.sender != tx.origin, "Do not send ETH directly");
}
}
// 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() {
address msgSender = _msgSender();
_owner = msgSender;
emit OwnershipTransferred(address(0), 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 {
emit OwnershipTransferred(_owner, address(0));
_owner = 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"
);
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(
token,
abi.encodeWithSelector(token.transfer.selector, to, value)
);
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(
token,
abi.encodeWithSelector(token.transferFrom.selector, from, to, value)
);
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
// solhint-disable-next-line max-line-length
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(
token,
abi.encodeWithSelector(token.approve.selector, spender, value)
);
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(
token,
abi.encodeWithSelector(
token.approve.selector,
spender,
newAllowance
)
);
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(
oldAllowance >= value,
"SafeERC20: decreased allowance below zero"
);
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(
token,
abi.encodeWithSelector(
token.approve.selector,
spender,
newAllowance
)
);
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata =
address(token).functionCall(
data,
"SafeERC20: low-level call failed"
);
if (returndata.length > 0) {
// Return data is optional
// solhint-disable-next-line max-line-length
require(
abi.decode(returndata, (bool)),
"SafeERC20: ERC20 operation did not succeed"
);
}
}
}
// 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) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
return msg.data;
}
}
// 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;
// solhint-disable-next-line no-inline-assembly
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"
);
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(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");
// solhint-disable-next-line avoid-low-level-calls
(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");
// solhint-disable-next-line avoid-low-level-calls
(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");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.delegatecall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
function _verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) private 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
// solhint-disable-next-line no-inline-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
///@author Zapper
///@notice This contract swaps and bridges ETH/Tokens to Matic/Polygon
// SPDX-License-Identifier: GPLv2
pragma solidity ^0.8.0;
import "../../_base/ZapBaseV2.sol";
// PoS Bridge
interface IRootChainManager {
function depositEtherFor(address user) external payable;
function depositFor(
address user,
address rootToken,
bytes calldata depositData
) external;
function tokenToType(address) external returns (bytes32);
function typeToPredicate(bytes32) external returns (address);
}
// Plasma Bridge
interface IDepositManager {
function depositERC20ForUser(
address _token,
address _user,
uint256 _amount
) external;
}
interface IWETH {
function deposit() external payable;
}
contract Zapper_Matic_Bridge_V1_1 is ZapBaseV2 {
using SafeERC20 for IERC20;
address private constant wethTokenAddress =
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
IRootChainManager public rootChainManager =
IRootChainManager(0xA0c68C638235ee32657e8f720a23ceC1bFc77C77);
IDepositManager public depositManager =
IDepositManager(0x401F6c983eA34274ec46f84D70b31C151321188b);
address private constant maticAddress =
0x7D1AfA7B718fb893dB30A3aBc0Cfc608AaCfeBB0;
constructor(uint256 _goodwill, uint256 _affiliateSplit)
ZapBaseV2(_goodwill, _affiliateSplit)
{
_approveToken(maticAddress, address(depositManager));
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
/**
@notice Bridge from Ethereum to Matic
@notice Use index 0 for primary swap and index 1 for matic swap
@param fromToken Address of the token to swap from
@param toToken Address of the token to bridge
@param swapAmounts Quantites of fromToken to swap to toToken and matic
@param minTokensRec Minimum acceptable quantity of swapped tokens and/or matic
@param swapTargets Execution targets for swaps
@param swapData DEX swap data
@param affiliate Affiliate address
*/
function ZapBridge(
address fromToken,
address toToken,
uint256[2] calldata swapAmounts,
uint256[2] calldata minTokensRec,
address[2] calldata swapTargets,
bytes[2] calldata swapData,
address affiliate
) external payable stopInEmergency {
uint256[2] memory toInvest =
_pullTokens(fromToken, swapAmounts, affiliate);
if (swapAmounts[0] > 0) {
// Token swap
uint256 toTokenAmt =
_fillQuote(
fromToken,
toInvest[0],
toToken,
swapTargets[0],
swapData[0]
);
require(toTokenAmt >= minTokensRec[0], "ERR: High Slippage 1");
_bridgeToken(toToken, toTokenAmt);
}
// Matic swap
if (swapAmounts[1] > 0) {
uint256 maticAmount =
_fillQuote(
fromToken,
toInvest[1],
maticAddress,
swapTargets[1],
swapData[1]
);
require(maticAmount >= minTokensRec[1], "ERR: High Slippage 2");
_bridgeMatic(maticAmount);
}
}
function _bridgeToken(address toToken, uint256 toTokenAmt) internal {
if (toToken == address(0)) {
rootChainManager.depositEtherFor{ value: toTokenAmt }(msg.sender);
} else {
bytes32 tokenType = rootChainManager.tokenToType(toToken);
address predicate = rootChainManager.typeToPredicate(tokenType);
_approveToken(toToken, predicate);
rootChainManager.depositFor(
msg.sender,
toToken,
abi.encode(toTokenAmt)
);
}
}
function _bridgeMatic(uint256 maticAmount) internal {
depositManager.depositERC20ForUser(
maticAddress,
msg.sender,
maticAmount
);
}
// 0x Swap
function _fillQuote(
address fromToken,
uint256 amount,
address toToken,
address swapTarget,
bytes memory swapCallData
) internal returns (uint256 amtBought) {
if (fromToken == wethTokenAddress && toToken == address(0)) {
IWETH(wethTokenAddress).deposit{ value: amount }();
return amount;
}
uint256 valueToSend;
if (fromToken == toToken) {
return amount;
}
if (fromToken == address(0)) {
valueToSend = amount;
} else {
_approveToken(fromToken, swapTarget);
}
uint256 iniBal = _getBalance(toToken);
require(approvedTargets[swapTarget], "Target not Authorized");
(bool success, ) = swapTarget.call{ value: valueToSend }(swapCallData);
require(success, "Error Swapping Tokens");
uint256 finalBal = _getBalance(toToken);
amtBought = finalBal - iniBal;
}
function _pullTokens(
address fromToken,
uint256[2] memory swapAmounts,
address affiliate
) internal returns (uint256[2] memory toInvest) {
if (fromToken == address(0)) {
require(msg.value > 0, "No eth sent");
require(
swapAmounts[0] + (swapAmounts[1]) == msg.value,
"msg.value != fromTokenAmounts"
);
} else {
require(msg.value == 0, "Eth sent with token");
// transfer token
IERC20(fromToken).safeTransferFrom(
msg.sender,
address(this),
swapAmounts[0] + (swapAmounts[1])
);
}
if (swapAmounts[0] > 0) {
toInvest[0] =
swapAmounts[0] -
(_subtractGoodwill(fromToken, swapAmounts[0], affiliate));
}
if (swapAmounts[1] > 0) {
toInvest[1] =
swapAmounts[1] -
(_subtractGoodwill(fromToken, swapAmounts[1], affiliate));
}
}
function _subtractGoodwill(
address token,
uint256 amount,
address affiliate
) internal returns (uint256 totalGoodwillPortion) {
bool whitelisted = feeWhitelist[msg.sender];
if (!whitelisted && goodwill > 0) {
totalGoodwillPortion = (amount * goodwill) / 10000;
if (affiliates[affiliate]) {
if (token == address(0)) {
token = ETHAddress;
}
uint256 affiliatePortion =
(totalGoodwillPortion * affiliateSplit) / 100;
affiliateBalance[affiliate][token] += affiliatePortion;
totalAffiliateBalance[token] += affiliatePortion;
}
}
}
}
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "./ZapBaseV2.sol";
abstract contract ZapOutBaseV3 is ZapBaseV2 {
using SafeERC20 for IERC20;
/**
@dev Transfer tokens from msg.sender to this contract
@param token The ERC20 token to transfer to this contract
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
@return Quantity of tokens transferred to this contract
*/
function _pullTokens(
address token,
uint256 amount,
bool shouldSellEntireBalance
) internal returns (uint256) {
if (shouldSellEntireBalance) {
require(
Address.isContract(msg.sender),
"ERR: shouldSellEntireBalance is true for EOA"
);
uint256 allowance =
IERC20(token).allowance(msg.sender, address(this));
IERC20(token).safeTransferFrom(
msg.sender,
address(this),
allowance
);
return allowance;
} else {
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
return amount;
}
}
function _subtractGoodwill(
address token,
uint256 amount,
address affiliate,
bool enableGoodwill
) internal returns (uint256 totalGoodwillPortion) {
bool whitelisted = feeWhitelist[msg.sender];
if (enableGoodwill && !whitelisted && goodwill > 0) {
totalGoodwillPortion = (amount * goodwill) / 10000;
if (affiliates[affiliate]) {
if (token == address(0)) {
token = ETHAddress;
}
uint256 affiliatePortion =
(totalGoodwillPortion * affiliateSplit) / 100;
affiliateBalance[affiliate][token] += affiliatePortion;
totalAffiliateBalance[token] += affiliatePortion;
}
}
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// Visit <https://www.gnu.org/licenses/>for a copy of the GNU Affero General Public License
///@author Zapper
///@notice this contract implements one click removal of liquidity from UniswapV2 pools, receiving ETH, ERC20 or both.
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../_base/ZapOutBaseV3.sol";
interface IUniswapV2Factory {
function getPair(address tokenA, address tokenB)
external
view
returns (address pair);
}
interface IUniswapV2Router02 {
function WETH() external pure returns (address);
function removeLiquidity(
address tokenA,
address tokenB,
uint256 liquidity,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline
) external returns (uint256 amountA, uint256 amountB);
function removeLiquidityETH(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);
}
interface IUniswapV2Pair {
function token0() external pure returns (address);
function token1() external pure returns (address);
function balanceOf(address user) external view returns (uint256);
function totalSupply() external view returns (uint256);
function getReserves()
external
view
returns (
uint112 _reserve0,
uint112 _reserve1,
uint32 _blockTimestampLast
);
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
}
interface IWETH {
function withdraw(uint256 wad) external;
}
contract UniswapV2_ZapOut_General_V4_0_1 is ZapOutBaseV3 {
using SafeERC20 for IERC20;
uint256 private constant deadline =
0xf000000000000000000000000000000000000000000000000000000000000000;
IUniswapV2Router02 private constant uniswapV2Router =
IUniswapV2Router02(0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D);
IUniswapV2Factory private constant uniswapFactory =
IUniswapV2Factory(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
address private constant wethTokenAddress =
address(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
constructor(uint256 _goodwill, uint256 _affiliateSplit)
ZapBaseV2(_goodwill, _affiliateSplit)
{
// 0x exchange
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
event zapOut(
address sender,
address pool,
address token,
uint256 tokensRec
);
/**
@notice Zap out in both tokens
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param affiliate Affiliate address
@return amountA Quantity of tokenA received after zapout
@return amountB Quantity of tokenB received after zapout
*/
function ZapOut2PairToken(
address fromPoolAddress,
uint256 incomingLP,
address affiliate
) public stopInEmergency returns (uint256 amountA, uint256 amountB) {
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
require(address(pair) != address(0), "Pool Cannot be Zero Address");
// get reserves
address token0 = pair.token0();
address token1 = pair.token1();
IERC20(fromPoolAddress).safeTransferFrom(
msg.sender,
address(this),
incomingLP
);
_approveToken(fromPoolAddress, address(uniswapV2Router), incomingLP);
if (token0 == wethTokenAddress || token1 == wethTokenAddress) {
address _token = token0 == wethTokenAddress ? token1 : token0;
(amountA, amountB) = uniswapV2Router.removeLiquidityETH(
_token,
incomingLP,
1,
1,
address(this),
deadline
);
// subtract goodwill
uint256 tokenGoodwill =
_subtractGoodwill(_token, amountA, affiliate, true);
uint256 ethGoodwill =
_subtractGoodwill(ETHAddress, amountB, affiliate, true);
// send tokens
IERC20(_token).safeTransfer(msg.sender, amountA - tokenGoodwill);
Address.sendValue(payable(msg.sender), amountB - ethGoodwill);
} else {
(amountA, amountB) = uniswapV2Router.removeLiquidity(
token0,
token1,
incomingLP,
1,
1,
address(this),
deadline
);
// subtract goodwill
uint256 tokenAGoodwill =
_subtractGoodwill(token0, amountA, affiliate, true);
uint256 tokenBGoodwill =
_subtractGoodwill(token1, amountB, affiliate, true);
// send tokens
IERC20(token0).safeTransfer(msg.sender, amountA - tokenAGoodwill);
IERC20(token1).safeTransfer(msg.sender, amountB - tokenBGoodwill);
}
emit zapOut(msg.sender, fromPoolAddress, token0, amountA);
emit zapOut(msg.sender, fromPoolAddress, token1, amountB);
}
/**
@notice Zap out in a single token
@param toTokenAddress Address of desired token
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param minTokensRec Minimum quantity of tokens to receive
@param swapTargets Execution targets for swaps
@param swapData DEX swap data
@param affiliate Affiliate address
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
*/
function ZapOut(
address toTokenAddress,
address fromPoolAddress,
uint256 incomingLP,
uint256 minTokensRec,
address[] memory swapTargets,
bytes[] memory swapData,
address affiliate,
bool shouldSellEntireBalance
) public stopInEmergency returns (uint256 tokensRec) {
(uint256 amount0, uint256 amount1) =
_removeLiquidity(
fromPoolAddress,
incomingLP,
shouldSellEntireBalance
);
//swaps tokens to token
tokensRec = _swapTokens(
fromPoolAddress,
amount0,
amount1,
toTokenAddress,
swapTargets,
swapData
);
require(tokensRec >= minTokensRec, "High Slippage");
uint256 totalGoodwillPortion;
// transfer toTokens to sender
if (toTokenAddress == address(0)) {
totalGoodwillPortion = _subtractGoodwill(
ETHAddress,
tokensRec,
affiliate,
true
);
payable(msg.sender).transfer(tokensRec - totalGoodwillPortion);
} else {
totalGoodwillPortion = _subtractGoodwill(
toTokenAddress,
tokensRec,
affiliate,
true
);
IERC20(toTokenAddress).safeTransfer(
msg.sender,
tokensRec - totalGoodwillPortion
);
}
tokensRec = tokensRec - totalGoodwillPortion;
emit zapOut(msg.sender, fromPoolAddress, toTokenAddress, tokensRec);
return tokensRec;
}
/**
@notice Zap out in both tokens with permit
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param affiliate Affiliate address to share fees
@param permitData Encoded permit data, which contains owner, spender, value, deadline, r,s,v values
@return amountA Quantity of tokenA received
@return amountB Quantity of tokenB received
*/
function ZapOut2PairTokenWithPermit(
address fromPoolAddress,
uint256 incomingLP,
address affiliate,
bytes calldata permitData
) external stopInEmergency returns (uint256 amountA, uint256 amountB) {
// permit
_validatePool(fromPoolAddress);
(bool success, ) = fromPoolAddress.call(permitData);
require(success, "Could Not Permit");
(amountA, amountB) = ZapOut2PairToken(
fromPoolAddress,
incomingLP,
affiliate
);
}
/**
@notice Zap out in a single token with permit
@param toTokenAddress Address of desired token
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param minTokensRec Minimum quantity of tokens to receive
@param swapTargets Execution targets for swaps
@param swapData DEX swap data
@param affiliate Affiliate address
*/
function ZapOutWithPermit(
address toTokenAddress,
address fromPoolAddress,
uint256 incomingLP,
uint256 minTokensRec,
bytes memory permitData,
address[] memory swapTargets,
bytes[] memory swapData,
address affiliate
) public stopInEmergency returns (uint256) {
// permit
_validatePool(fromPoolAddress);
(bool success, ) = fromPoolAddress.call(permitData);
require(success, "Could Not Permit");
return (
ZapOut(
toTokenAddress,
fromPoolAddress,
incomingLP,
minTokensRec,
swapTargets,
swapData,
affiliate,
false
)
);
}
function _validatePool(address poolAddress) internal view {
IUniswapV2Pair pair = IUniswapV2Pair(poolAddress);
address token0 = pair.token0();
address token1 = pair.token1();
address retrievedAddress = uniswapFactory.getPair(token0, token1);
require(retrievedAddress == poolAddress, "Invalid Pool Address");
}
function _removeLiquidity(
address fromPoolAddress,
uint256 incomingLP,
bool shouldSellEntireBalance
) internal returns (uint256 amount0, uint256 amount1) {
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
require(address(pair) != address(0), "Pool Cannot be Zero Address");
address token0 = pair.token0();
address token1 = pair.token1();
_pullTokens(fromPoolAddress, incomingLP, shouldSellEntireBalance);
_approveToken(fromPoolAddress, address(uniswapV2Router), incomingLP);
(amount0, amount1) = uniswapV2Router.removeLiquidity(
token0,
token1,
incomingLP,
1,
1,
address(this),
deadline
);
require(amount0 > 0 && amount1 > 0, "Removed Insufficient Liquidity");
}
function _swapTokens(
address fromPoolAddress,
uint256 amount0,
uint256 amount1,
address toToken,
address[] memory swapTargets,
bytes[] memory swapData
) internal returns (uint256 tokensBought) {
address token0 = IUniswapV2Pair(fromPoolAddress).token0();
address token1 = IUniswapV2Pair(fromPoolAddress).token1();
//swap token0 to toToken
if (token0 == toToken) {
tokensBought = tokensBought + amount0;
} else {
//swap token using 0x swap
tokensBought =
tokensBought +
_fillQuote(
token0,
toToken,
amount0,
swapTargets[0],
swapData[0]
);
}
//swap token1 to toToken
if (token1 == toToken) {
tokensBought = tokensBought + amount1;
} else {
//swap token using 0x swap
tokensBought =
tokensBought +
_fillQuote(
token1,
toToken,
amount1,
swapTargets[1],
swapData[1]
);
}
}
function _fillQuote(
address fromTokenAddress,
address toToken,
uint256 amount,
address swapTarget,
bytes memory swapData
) internal returns (uint256) {
if (fromTokenAddress == wethTokenAddress && toToken == address(0)) {
IWETH(wethTokenAddress).withdraw(amount);
return amount;
}
uint256 valueToSend;
if (fromTokenAddress == address(0)) {
valueToSend = amount;
} else {
_approveToken(fromTokenAddress, swapTarget, amount);
}
uint256 initialBalance = _getBalance(toToken);
require(approvedTargets[swapTarget], "Target not Authorized");
(bool success, ) = swapTarget.call{ value: valueToSend }(swapData);
require(success, "Error Swapping Tokens");
uint256 finalBalance = _getBalance(toToken) - initialBalance;
require(finalBalance > 0, "Swapped to Invalid Intermediate");
return finalBalance;
}
/**
@notice Utility function to determine quantity and addresses of tokens being removed
@param fromPoolAddress Pool from which to remove liquidity
@param liquidity Quantity of LP tokens to remove.
@return amountA Quantity of tokenA removed
@return amountB Quantity of tokenB removed
@return token0 Address of the underlying token to be removed
@return token1 Address of the underlying token to be removed
*/
function removeLiquidityReturn(address fromPoolAddress, uint256 liquidity)
external
view
returns (
uint256 amountA,
uint256 amountB,
address token0,
address token1
)
{
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
token0 = pair.token0();
token1 = pair.token1();
uint256 balance0 = IERC20(token0).balanceOf(fromPoolAddress);
uint256 balance1 = IERC20(token1).balanceOf(fromPoolAddress);
uint256 _totalSupply = pair.totalSupply();
amountA = (liquidity * balance0) / _totalSupply;
amountB = (liquidity * balance1) / _totalSupply;
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// Visit <https://www.gnu.org/licenses/>for a copy of the GNU Affero General Public License
///@author Zapper
///@notice this contract implements one click removal of liquidity from Sushiswap pools, receiving ETH, ERC20 or both.
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../_base/ZapOutBaseV3.sol";
interface IUniswapV2Factory {
function getPair(address tokenA, address tokenB)
external
view
returns (address pair);
}
interface IUniswapV2Router02 {
function WETH() external pure returns (address);
function removeLiquidity(
address tokenA,
address tokenB,
uint256 liquidity,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline
) external returns (uint256 amountA, uint256 amountB);
function removeLiquidityETH(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);
}
interface IUniswapV2Pair {
function token0() external pure returns (address);
function token1() external pure returns (address);
function balanceOf(address user) external view returns (uint256);
function totalSupply() external view returns (uint256);
function getReserves()
external
view
returns (
uint112 _reserve0,
uint112 _reserve1,
uint32 _blockTimestampLast
);
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
}
interface IWETH {
function withdraw(uint256 wad) external;
}
contract Sushiswap_ZapOut_General_V3 is ZapOutBaseV3 {
using SafeERC20 for IERC20;
uint256 private constant deadline =
0xf000000000000000000000000000000000000000000000000000000000000000;
IUniswapV2Router02 private constant sushiswapRouter =
IUniswapV2Router02(0xd9e1cE17f2641f24aE83637ab66a2cca9C378B9F);
IUniswapV2Factory private constant sushiswapFactory =
IUniswapV2Factory(0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac);
address private constant wethTokenAddress =
address(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
constructor(uint256 _goodwill, uint256 _affiliateSplit)
ZapBaseV2(_goodwill, _affiliateSplit)
{
// 0x exchange
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
event zapOut(
address sender,
address pool,
address token,
uint256 tokensRec
);
/**
@notice Zap out in both tokens
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param affiliate Affiliate address
@return amountA Quantity of tokenA received after zapout
@return amountB Quantity of tokenB received after zapout
*/
function ZapOut2PairToken(
address fromPoolAddress,
uint256 incomingLP,
address affiliate
) public stopInEmergency returns (uint256 amountA, uint256 amountB) {
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
require(address(pair) != address(0), "Pool Cannot be Zero Address");
// get reserves
address token0 = pair.token0();
address token1 = pair.token1();
IERC20(fromPoolAddress).safeTransferFrom(
msg.sender,
address(this),
incomingLP
);
_approveToken(fromPoolAddress, address(sushiswapRouter), incomingLP);
if (token0 == wethTokenAddress || token1 == wethTokenAddress) {
address _token = token0 == wethTokenAddress ? token1 : token0;
(amountA, amountB) = sushiswapRouter.removeLiquidityETH(
_token,
incomingLP,
1,
1,
address(this),
deadline
);
// subtract goodwill
uint256 tokenGoodwill =
_subtractGoodwill(_token, amountA, affiliate, true);
uint256 ethGoodwill =
_subtractGoodwill(ETHAddress, amountB, affiliate, true);
// send tokens
IERC20(_token).safeTransfer(msg.sender, amountA - tokenGoodwill);
Address.sendValue(payable(msg.sender), amountB - ethGoodwill);
} else {
(amountA, amountB) = sushiswapRouter.removeLiquidity(
token0,
token1,
incomingLP,
1,
1,
address(this),
deadline
);
// subtract goodwill
uint256 tokenAGoodwill =
_subtractGoodwill(token0, amountA, affiliate, true);
uint256 tokenBGoodwill =
_subtractGoodwill(token1, amountB, affiliate, true);
// send tokens
IERC20(token0).safeTransfer(msg.sender, amountA - tokenAGoodwill);
IERC20(token1).safeTransfer(msg.sender, amountB - tokenBGoodwill);
}
emit zapOut(msg.sender, fromPoolAddress, token0, amountA);
emit zapOut(msg.sender, fromPoolAddress, token1, amountB);
}
/**
@notice Zap out in a single token
@param toTokenAddress Address of desired token
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param minTokensRec Minimum quantity of tokens to receive
@param swapTargets Execution targets for swaps
@param swapData DEX swap data
@param affiliate Affiliate address
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
*/
function ZapOut(
address toTokenAddress,
address fromPoolAddress,
uint256 incomingLP,
uint256 minTokensRec,
address[] memory swapTargets,
bytes[] memory swapData,
address affiliate,
bool shouldSellEntireBalance
) public stopInEmergency returns (uint256 tokensRec) {
(uint256 amount0, uint256 amount1) =
_removeLiquidity(
fromPoolAddress,
incomingLP,
shouldSellEntireBalance
);
//swaps tokens to token
tokensRec = _swapTokens(
fromPoolAddress,
amount0,
amount1,
toTokenAddress,
swapTargets,
swapData
);
require(tokensRec >= minTokensRec, "High Slippage");
uint256 totalGoodwillPortion;
// transfer toTokens to sender
if (toTokenAddress == address(0)) {
totalGoodwillPortion = _subtractGoodwill(
ETHAddress,
tokensRec,
affiliate,
true
);
payable(msg.sender).transfer(tokensRec - totalGoodwillPortion);
} else {
totalGoodwillPortion = _subtractGoodwill(
toTokenAddress,
tokensRec,
affiliate,
true
);
IERC20(toTokenAddress).safeTransfer(
msg.sender,
tokensRec - totalGoodwillPortion
);
}
tokensRec = tokensRec - totalGoodwillPortion;
emit zapOut(msg.sender, fromPoolAddress, toTokenAddress, tokensRec);
return tokensRec;
}
/**
@notice Zap out in both tokens with permit
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param affiliate Affiliate address to share fees
@param permitData Encoded permit data, which contains owner, spender, value, deadline, r,s,v values
@return amountA Quantity of tokenA received
@return amountB Quantity of tokenB received
*/
function ZapOut2PairTokenWithPermit(
address fromPoolAddress,
uint256 incomingLP,
address affiliate,
bytes calldata permitData
) external stopInEmergency returns (uint256 amountA, uint256 amountB) {
// permit
_validatePool(fromPoolAddress);
(bool success, ) = fromPoolAddress.call(permitData);
require(success, "Could Not Permit");
(amountA, amountB) = ZapOut2PairToken(
fromPoolAddress,
incomingLP,
affiliate
);
}
/**
@notice Zap out in a single token with permit
@param toTokenAddress Address of desired token
@param fromPoolAddress Pool from which to remove liquidity
@param incomingLP Quantity of LP to remove from pool
@param minTokensRec Minimum quantity of tokens to receive
@param swapTargets Execution targets for swaps
@param swapData DEX swap data
@param affiliate Affiliate address
*/
function ZapOutWithPermit(
address toTokenAddress,
address fromPoolAddress,
uint256 incomingLP,
uint256 minTokensRec,
bytes memory permitData,
address[] memory swapTargets,
bytes[] memory swapData,
address affiliate
) public stopInEmergency returns (uint256) {
// permit
_validatePool(fromPoolAddress);
(bool success, ) = fromPoolAddress.call(permitData);
require(success, "Could Not Permit");
return (
ZapOut(
toTokenAddress,
fromPoolAddress,
incomingLP,
minTokensRec,
swapTargets,
swapData,
affiliate,
false
)
);
}
function _validatePool(address poolAddress) internal view {
IUniswapV2Pair pair = IUniswapV2Pair(poolAddress);
address token0 = pair.token0();
address token1 = pair.token1();
address retrievedAddress = sushiswapFactory.getPair(token0, token1);
require(retrievedAddress == poolAddress, "Invalid Pool Address");
}
function _removeLiquidity(
address fromPoolAddress,
uint256 incomingLP,
bool shouldSellEntireBalance
) internal returns (uint256 amount0, uint256 amount1) {
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
require(address(pair) != address(0), "Pool Cannot be Zero Address");
address token0 = pair.token0();
address token1 = pair.token1();
_pullTokens(fromPoolAddress, incomingLP, shouldSellEntireBalance);
_approveToken(fromPoolAddress, address(sushiswapRouter), incomingLP);
(amount0, amount1) = sushiswapRouter.removeLiquidity(
token0,
token1,
incomingLP,
1,
1,
address(this),
deadline
);
require(amount0 > 0 && amount1 > 0, "Removed Insufficient Liquidity");
}
function _swapTokens(
address fromPoolAddress,
uint256 amount0,
uint256 amount1,
address toToken,
address[] memory swapTargets,
bytes[] memory swapData
) internal returns (uint256 tokensBought) {
address token0 = IUniswapV2Pair(fromPoolAddress).token0();
address token1 = IUniswapV2Pair(fromPoolAddress).token1();
//swap token0 to toToken
if (token0 == toToken) {
tokensBought = tokensBought + amount0;
} else {
//swap token using 0x swap
tokensBought =
tokensBought +
_fillQuote(
token0,
toToken,
amount0,
swapTargets[0],
swapData[0]
);
}
//swap token1 to toToken
if (token1 == toToken) {
tokensBought = tokensBought + amount1;
} else {
//swap token using 0x swap
tokensBought =
tokensBought +
_fillQuote(
token1,
toToken,
amount1,
swapTargets[1],
swapData[1]
);
}
}
function _fillQuote(
address fromTokenAddress,
address toToken,
uint256 amount,
address swapTarget,
bytes memory swapData
) internal returns (uint256) {
if (fromTokenAddress == wethTokenAddress && toToken == address(0)) {
IWETH(wethTokenAddress).withdraw(amount);
return amount;
}
uint256 valueToSend;
if (fromTokenAddress == address(0)) {
valueToSend = amount;
} else {
_approveToken(fromTokenAddress, swapTarget, amount);
}
uint256 initialBalance = _getBalance(toToken);
require(approvedTargets[swapTarget], "Target not Authorized");
(bool success, ) = swapTarget.call{ value: valueToSend }(swapData);
require(success, "Error Swapping Tokens");
uint256 finalBalance = _getBalance(toToken) - initialBalance;
require(finalBalance > 0, "Swapped to Invalid Intermediate");
return finalBalance;
}
/**
@notice Utility function to determine quantity and addresses of tokens being removed
@param fromPoolAddress Pool from which to remove liquidity
@param liquidity Quantity of LP tokens to remove.
@return amountA Quantity of tokenA removed
@return amountB Quantity of tokenB removed
@return token0 Address of the underlying token to be removed
@return token1 Address of the underlying token to be removed
*/
function removeLiquidityReturn(address fromPoolAddress, uint256 liquidity)
external
view
returns (
uint256 amountA,
uint256 amountB,
address token0,
address token1
)
{
IUniswapV2Pair pair = IUniswapV2Pair(fromPoolAddress);
token0 = pair.token0();
token1 = pair.token1();
uint256 balance0 = IERC20(token0).balanceOf(fromPoolAddress);
uint256 balance1 = IERC20(token1).balanceOf(fromPoolAddress);
uint256 _totalSupply = pair.totalSupply();
amountA = (liquidity * balance0) / _totalSupply;
amountB = (liquidity * balance1) / _totalSupply;
}
}
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "./ZapBaseV2.sol";
abstract contract ZapInBaseV3 is ZapBaseV2 {
using SafeERC20 for IERC20;
function _pullTokens(
address token,
uint256 amount,
address affiliate,
bool enableGoodwill,
bool shouldSellEntireBalance
) internal returns (uint256 value) {
uint256 totalGoodwillPortion;
if (token == address(0)) {
require(msg.value > 0, "No eth sent");
// subtract goodwill
totalGoodwillPortion = _subtractGoodwill(
ETHAddress,
msg.value,
affiliate,
enableGoodwill
);
return msg.value - totalGoodwillPortion;
}
require(amount > 0, "Invalid token amount");
require(msg.value == 0, "Eth sent with token");
//transfer token
if (shouldSellEntireBalance) {
require(
Address.isContract(msg.sender),
"ERR: shouldSellEntireBalance is true for EOA"
);
amount = IERC20(token).allowance(msg.sender, address(this));
}
IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
// subtract goodwill
totalGoodwillPortion = _subtractGoodwill(
token,
amount,
affiliate,
enableGoodwill
);
return amount - totalGoodwillPortion;
}
function _subtractGoodwill(
address token,
uint256 amount,
address affiliate,
bool enableGoodwill
) internal returns (uint256 totalGoodwillPortion) {
bool whitelisted = feeWhitelist[msg.sender];
if (enableGoodwill && !whitelisted && goodwill > 0) {
totalGoodwillPortion = (amount * goodwill) / 10000;
if (affiliates[affiliate]) {
if (token == address(0)) {
token = ETHAddress;
}
uint256 affiliatePortion =
(totalGoodwillPortion * affiliateSplit) / 100;
affiliateBalance[affiliate][token] += affiliatePortion;
totalAffiliateBalance[token] += affiliatePortion;
}
}
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
///@author Zapper
///@notice This contract adds liquidity to Uniswap V2 pools using ETH or any ERC20 Token.
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../_base/ZapInBaseV3.sol";
// import "@uniswap/lib/contracts/libraries/Babylonian.sol";
library Babylonian {
function sqrt(uint256 y) internal pure returns (uint256 z) {
if (y > 3) {
z = y;
uint256 x = y / 2 + 1;
while (x < z) {
z = x;
x = (y / x + x) / 2;
}
} else if (y != 0) {
z = 1;
}
// else z = 0
}
}
interface IWETH {
function deposit() external payable;
function transfer(address to, uint256 value) external returns (bool);
function withdraw(uint256) external;
}
interface IUniswapV2Factory {
function getPair(address tokenA, address tokenB)
external
view
returns (address);
}
interface IUniswapV2Router02 {
function factory() external pure returns (address);
function WETH() external pure returns (address);
function addLiquidity(
address tokenA,
address tokenB,
uint256 amountADesired,
uint256 amountBDesired,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline
)
external
returns (
uint256 amountA,
uint256 amountB,
uint256 liquidity
);
function addLiquidityETH(
address token,
uint256 amountTokenDesired,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline
)
external
payable
returns (
uint256 amountToken,
uint256 amountETH,
uint256 liquidity
);
function removeLiquidity(
address tokenA,
address tokenB,
uint256 liquidity,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline
) external returns (uint256 amountA, uint256 amountB);
function removeLiquidityETH(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);
function removeLiquidityWithPermit(
address tokenA,
address tokenB,
uint256 liquidity,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline,
bool approveMax,
uint8 v,
bytes32 r,
bytes32 s
) external returns (uint256 amountA, uint256 amountB);
function removeLiquidityETHWithPermit(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline,
bool approveMax,
uint8 v,
bytes32 r,
bytes32 s
) external returns (uint256 amountToken, uint256 amountETH);
function swapExactTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapTokensForExactTokens(
uint256 amountOut,
uint256 amountInMax,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapExactETHForTokens(
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external payable returns (uint256[] memory amounts);
function swapTokensForExactETH(
uint256 amountOut,
uint256 amountInMax,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapExactTokensForETH(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
function swapETHForExactTokens(
uint256 amountOut,
address[] calldata path,
address to,
uint256 deadline
) external payable returns (uint256[] memory amounts);
function removeLiquidityETHSupportingFeeOnTransferTokens(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline
) external returns (uint256 amountETH);
function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
address token,
uint256 liquidity,
uint256 amountTokenMin,
uint256 amountETHMin,
address to,
uint256 deadline,
bool approveMax,
uint8 v,
bytes32 r,
bytes32 s
) external returns (uint256 amountETH);
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external;
function swapExactETHForTokensSupportingFeeOnTransferTokens(
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external payable;
function swapExactTokensForETHSupportingFeeOnTransferTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external;
function quote(
uint256 amountA,
uint256 reserveA,
uint256 reserveB
) external pure returns (uint256 amountB);
function getAmountOut(
uint256 amountIn,
uint256 reserveIn,
uint256 reserveOut
) external pure returns (uint256 amountOut);
function getAmountIn(
uint256 amountOut,
uint256 reserveIn,
uint256 reserveOut
) external pure returns (uint256 amountIn);
function getAmountsOut(uint256 amountIn, address[] calldata path)
external
view
returns (uint256[] memory amounts);
function getAmountsIn(uint256 amountOut, address[] calldata path)
external
view
returns (uint256[] memory amounts);
}
interface IUniswapV2Pair {
function token0() external pure returns (address);
function token1() external pure returns (address);
function getReserves()
external
view
returns (
uint112 _reserve0,
uint112 _reserve1,
uint32 _blockTimestampLast
);
}
contract UniswapV2_ZapIn_General_V5 is ZapInBaseV3 {
using SafeERC20 for IERC20;
IUniswapV2Factory private constant UniSwapV2FactoryAddress =
IUniswapV2Factory(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
IUniswapV2Router02 private constant uniswapRouter =
IUniswapV2Router02(0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D);
address private constant wethTokenAddress =
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
uint256 private constant deadline =
0xf000000000000000000000000000000000000000000000000000000000000000;
constructor(uint256 _goodwill, uint256 _affiliateSplit)
ZapBaseV2(_goodwill, _affiliateSplit)
{
// 0x exchange
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
event zapIn(address sender, address pool, uint256 tokensRec);
/**
@notice This function is used to invest in given Uniswap V2 pair through ETH/ERC20 Tokens
@param _FromTokenContractAddress The ERC20 token used for investment (address(0x00) if ether)
@param _pairAddress The Uniswap pair address
@param _amount The amount of fromToken to invest
@param _minPoolTokens Reverts if less tokens received than this
@param _swapTarget Excecution target for the first swap
@param swapData DEX quote data
@param affiliate Affiliate address
@param transferResidual Set false to save gas by donating the residual remaining after a Zap
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
@return Amount of LP bought
*/
function ZapIn(
address _FromTokenContractAddress,
address _pairAddress,
uint256 _amount,
uint256 _minPoolTokens,
address _swapTarget,
bytes calldata swapData,
address affiliate,
bool transferResidual,
bool shouldSellEntireBalance
) external payable stopInEmergency returns (uint256) {
uint256 toInvest =
_pullTokens(
_FromTokenContractAddress,
_amount,
affiliate,
true,
shouldSellEntireBalance
);
uint256 LPBought =
_performZapIn(
_FromTokenContractAddress,
_pairAddress,
toInvest,
_swapTarget,
swapData,
transferResidual
);
require(LPBought >= _minPoolTokens, "High Slippage");
emit zapIn(msg.sender, _pairAddress, LPBought);
IERC20(_pairAddress).safeTransfer(msg.sender, LPBought);
return LPBought;
}
function _getPairTokens(address _pairAddress)
internal
pure
returns (address token0, address token1)
{
IUniswapV2Pair uniPair = IUniswapV2Pair(_pairAddress);
token0 = uniPair.token0();
token1 = uniPair.token1();
}
function _performZapIn(
address _FromTokenContractAddress,
address _pairAddress,
uint256 _amount,
address _swapTarget,
bytes memory swapData,
bool transferResidual
) internal returns (uint256) {
uint256 intermediateAmt;
address intermediateToken;
(address _ToUniswapToken0, address _ToUniswapToken1) =
_getPairTokens(_pairAddress);
if (
_FromTokenContractAddress != _ToUniswapToken0 &&
_FromTokenContractAddress != _ToUniswapToken1
) {
// swap to intermediate
(intermediateAmt, intermediateToken) = _fillQuote(
_FromTokenContractAddress,
_pairAddress,
_amount,
_swapTarget,
swapData
);
} else {
intermediateToken = _FromTokenContractAddress;
intermediateAmt = _amount;
}
// divide intermediate into appropriate amount to add liquidity
(uint256 token0Bought, uint256 token1Bought) =
_swapIntermediate(
intermediateToken,
_ToUniswapToken0,
_ToUniswapToken1,
intermediateAmt
);
return
_uniDeposit(
_ToUniswapToken0,
_ToUniswapToken1,
token0Bought,
token1Bought,
transferResidual
);
}
function _uniDeposit(
address _ToUnipoolToken0,
address _ToUnipoolToken1,
uint256 token0Bought,
uint256 token1Bought,
bool transferResidual
) internal returns (uint256) {
_approveToken(_ToUnipoolToken0, address(uniswapRouter), token0Bought);
_approveToken(_ToUnipoolToken1, address(uniswapRouter), token1Bought);
(uint256 amountA, uint256 amountB, uint256 LP) =
uniswapRouter.addLiquidity(
_ToUnipoolToken0,
_ToUnipoolToken1,
token0Bought,
token1Bought,
1,
1,
address(this),
deadline
);
if (transferResidual) {
//Returning Residue in token0, if any.
if (token0Bought - amountA > 0) {
IERC20(_ToUnipoolToken0).safeTransfer(
msg.sender,
token0Bought - amountA
);
}
//Returning Residue in token1, if any
if (token1Bought - amountB > 0) {
IERC20(_ToUnipoolToken1).safeTransfer(
msg.sender,
token1Bought - amountB
);
}
}
return LP;
}
function _fillQuote(
address _fromTokenAddress,
address _pairAddress,
uint256 _amount,
address _swapTarget,
bytes memory swapData
) internal returns (uint256 amountBought, address intermediateToken) {
if (_swapTarget == wethTokenAddress) {
IWETH(wethTokenAddress).deposit{ value: _amount }();
return (_amount, wethTokenAddress);
}
uint256 valueToSend;
if (_fromTokenAddress == address(0)) {
valueToSend = _amount;
} else {
_approveToken(_fromTokenAddress, _swapTarget, _amount);
}
(address _token0, address _token1) = _getPairTokens(_pairAddress);
IERC20 token0 = IERC20(_token0);
IERC20 token1 = IERC20(_token1);
uint256 initialBalance0 = token0.balanceOf(address(this));
uint256 initialBalance1 = token1.balanceOf(address(this));
require(approvedTargets[_swapTarget], "Target not Authorized");
(bool success, ) = _swapTarget.call{ value: valueToSend }(swapData);
require(success, "Error Swapping Tokens 1");
uint256 finalBalance0 =
token0.balanceOf(address(this)) - initialBalance0;
uint256 finalBalance1 =
token1.balanceOf(address(this)) - initialBalance1;
if (finalBalance0 > finalBalance1) {
amountBought = finalBalance0;
intermediateToken = _token0;
} else {
amountBought = finalBalance1;
intermediateToken = _token1;
}
require(amountBought > 0, "Swapped to Invalid Intermediate");
}
function _swapIntermediate(
address _toContractAddress,
address _ToUnipoolToken0,
address _ToUnipoolToken1,
uint256 _amount
) internal returns (uint256 token0Bought, uint256 token1Bought) {
IUniswapV2Pair pair =
IUniswapV2Pair(
UniSwapV2FactoryAddress.getPair(
_ToUnipoolToken0,
_ToUnipoolToken1
)
);
(uint256 res0, uint256 res1, ) = pair.getReserves();
if (_toContractAddress == _ToUnipoolToken0) {
uint256 amountToSwap = calculateSwapInAmount(res0, _amount);
//if no reserve or a new pair is created
if (amountToSwap <= 0) amountToSwap = _amount / 2;
token1Bought = _token2Token(
_toContractAddress,
_ToUnipoolToken1,
amountToSwap
);
token0Bought = _amount - amountToSwap;
} else {
uint256 amountToSwap = calculateSwapInAmount(res1, _amount);
//if no reserve or a new pair is created
if (amountToSwap <= 0) amountToSwap = _amount / 2;
token0Bought = _token2Token(
_toContractAddress,
_ToUnipoolToken0,
amountToSwap
);
token1Bought = _amount - amountToSwap;
}
}
function calculateSwapInAmount(uint256 reserveIn, uint256 userIn)
internal
pure
returns (uint256)
{
return
(Babylonian.sqrt(
reserveIn * ((userIn * 3988000) + (reserveIn * 3988009))
) - (reserveIn * 1997)) / 1994;
}
/**
@notice This function is used to swap ERC20 <> ERC20
@param _FromTokenContractAddress The token address to swap from.
@param _ToTokenContractAddress The token address to swap to.
@param tokens2Trade The amount of tokens to swap
@return tokenBought The quantity of tokens bought
*/
function _token2Token(
address _FromTokenContractAddress,
address _ToTokenContractAddress,
uint256 tokens2Trade
) internal returns (uint256 tokenBought) {
if (_FromTokenContractAddress == _ToTokenContractAddress) {
return tokens2Trade;
}
_approveToken(
_FromTokenContractAddress,
address(uniswapRouter),
tokens2Trade
);
address pair =
UniSwapV2FactoryAddress.getPair(
_FromTokenContractAddress,
_ToTokenContractAddress
);
require(pair != address(0), "No Swap Available");
address[] memory path = new address[](2);
path[0] = _FromTokenContractAddress;
path[1] = _ToTokenContractAddress;
tokenBought = uniswapRouter.swapExactTokensForTokens(
tokens2Trade,
1,
path,
address(this),
deadline
)[path.length - 1];
require(tokenBought > 0, "Error Swapping Tokens 2");
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
///@author Zapper
///@notice This contract adds liquidity to Sushiswap pools using ETH or any ERC20 Token.
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../_base/ZapInBaseV3.sol";
// import "@uniswap/lib/contracts/libraries/Babylonian.sol";
library Babylonian {
function sqrt(uint256 y) internal pure returns (uint256 z) {
if (y > 3) {
z = y;
uint256 x = y / 2 + 1;
while (x < z) {
z = x;
x = (y / x + x) / 2;
}
} else if (y != 0) {
z = 1;
}
// else z = 0
}
}
interface IWETH {
function deposit() external payable;
}
interface IUniswapV2Factory {
function getPair(address tokenA, address tokenB)
external
view
returns (address);
}
interface IUniswapV2Router02 {
function addLiquidity(
address tokenA,
address tokenB,
uint256 amountADesired,
uint256 amountBDesired,
uint256 amountAMin,
uint256 amountBMin,
address to,
uint256 deadline
)
external
returns (
uint256 amountA,
uint256 amountB,
uint256 liquidity
);
function swapExactTokensForTokens(
uint256 amountIn,
uint256 amountOutMin,
address[] calldata path,
address to,
uint256 deadline
) external returns (uint256[] memory amounts);
}
interface IUniswapV2Pair {
function token0() external pure returns (address);
function token1() external pure returns (address);
function getReserves()
external
view
returns (
uint112 _reserve0,
uint112 _reserve1,
uint32 _blockTimestampLast
);
}
contract Sushiswap_ZapIn_V4 is ZapInBaseV3 {
using SafeERC20 for IERC20;
IUniswapV2Factory private constant sushiSwapFactoryAddress =
IUniswapV2Factory(0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac);
IUniswapV2Router02 private constant sushiSwapRouter =
IUniswapV2Router02(0xd9e1cE17f2641f24aE83637ab66a2cca9C378B9F);
address private constant wethTokenAddress =
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
uint256 private constant deadline =
0xf000000000000000000000000000000000000000000000000000000000000000;
constructor(uint256 _goodwill, uint256 _affiliateSplit)
ZapBaseV2(_goodwill, _affiliateSplit)
{
// 0x exchange
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
event zapIn(address sender, address pool, uint256 tokensRec);
/**
@notice Add liquidity to Sushiswap pools with ETH/ERC20 Tokens
@param _FromTokenContractAddress The ERC20 token used (address(0x00) if ether)
@param _pairAddress The Sushiswap pair address
@param _amount The amount of fromToken to invest
@param _minPoolTokens Minimum quantity of pool tokens to receive. Reverts otherwise
@param _swapTarget Excecution target for the first swap
@param swapData DEX quote data
@param affiliate Affiliate address
@param transferResidual Set false to save gas by donating the residual remaining after a Zap
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
@return Amount of LP bought
*/
function ZapIn(
address _FromTokenContractAddress,
address _pairAddress,
uint256 _amount,
uint256 _minPoolTokens,
address _swapTarget,
bytes calldata swapData,
address affiliate,
bool transferResidual,
bool shouldSellEntireBalance
) external payable stopInEmergency returns (uint256) {
uint256 toInvest =
_pullTokens(
_FromTokenContractAddress,
_amount,
affiliate,
true,
shouldSellEntireBalance
);
uint256 LPBought =
_performZapIn(
_FromTokenContractAddress,
_pairAddress,
toInvest,
_swapTarget,
swapData,
transferResidual
);
require(LPBought >= _minPoolTokens, "High Slippage");
emit zapIn(msg.sender, _pairAddress, LPBought);
IERC20(_pairAddress).safeTransfer(msg.sender, LPBought);
return LPBought;
}
function _getPairTokens(address _pairAddress)
internal
pure
returns (address token0, address token1)
{
IUniswapV2Pair uniPair = IUniswapV2Pair(_pairAddress);
token0 = uniPair.token0();
token1 = uniPair.token1();
}
function _performZapIn(
address _FromTokenContractAddress,
address _pairAddress,
uint256 _amount,
address _swapTarget,
bytes memory swapData,
bool transferResidual
) internal returns (uint256) {
uint256 intermediateAmt;
address intermediateToken;
(address _ToUniswapToken0, address _ToUniswapToken1) =
_getPairTokens(_pairAddress);
if (
_FromTokenContractAddress != _ToUniswapToken0 &&
_FromTokenContractAddress != _ToUniswapToken1
) {
// swap to intermediate
(intermediateAmt, intermediateToken) = _fillQuote(
_FromTokenContractAddress,
_pairAddress,
_amount,
_swapTarget,
swapData
);
} else {
intermediateToken = _FromTokenContractAddress;
intermediateAmt = _amount;
}
// divide intermediate into appropriate amount to add liquidity
(uint256 token0Bought, uint256 token1Bought) =
_swapIntermediate(
intermediateToken,
_ToUniswapToken0,
_ToUniswapToken1,
intermediateAmt
);
return
_uniDeposit(
_ToUniswapToken0,
_ToUniswapToken1,
token0Bought,
token1Bought,
transferResidual
);
}
function _uniDeposit(
address _ToUnipoolToken0,
address _ToUnipoolToken1,
uint256 token0Bought,
uint256 token1Bought,
bool transferResidual
) internal returns (uint256) {
_approveToken(_ToUnipoolToken0, address(sushiSwapRouter), token0Bought);
_approveToken(_ToUnipoolToken1, address(sushiSwapRouter), token1Bought);
(uint256 amountA, uint256 amountB, uint256 LP) =
sushiSwapRouter.addLiquidity(
_ToUnipoolToken0,
_ToUnipoolToken1,
token0Bought,
token1Bought,
1,
1,
address(this),
deadline
);
if (transferResidual) {
//Returning Residue in token0, if any.
if (token0Bought - amountA > 0) {
IERC20(_ToUnipoolToken0).safeTransfer(
msg.sender,
token0Bought - amountA
);
}
//Returning Residue in token1, if any
if (token1Bought - amountB > 0) {
IERC20(_ToUnipoolToken1).safeTransfer(
msg.sender,
token1Bought - amountB
);
}
}
return LP;
}
function _fillQuote(
address _fromTokenAddress,
address _pairAddress,
uint256 _amount,
address _swapTarget,
bytes memory swapData
) internal returns (uint256 amountBought, address intermediateToken) {
if (_swapTarget == wethTokenAddress) {
IWETH(wethTokenAddress).deposit{ value: _amount }();
return (_amount, wethTokenAddress);
}
uint256 valueToSend;
if (_fromTokenAddress == address(0)) {
valueToSend = _amount;
} else {
_approveToken(_fromTokenAddress, _swapTarget, _amount);
}
(address _token0, address _token1) = _getPairTokens(_pairAddress);
IERC20 token0 = IERC20(_token0);
IERC20 token1 = IERC20(_token1);
uint256 initialBalance0 = token0.balanceOf(address(this));
uint256 initialBalance1 = token1.balanceOf(address(this));
require(approvedTargets[_swapTarget], "Target not Authorized");
(bool success, ) = _swapTarget.call{ value: valueToSend }(swapData);
require(success, "Error Swapping Tokens 1");
uint256 finalBalance0 =
token0.balanceOf(address(this)) - initialBalance0;
uint256 finalBalance1 =
token1.balanceOf(address(this)) - initialBalance1;
if (finalBalance0 > finalBalance1) {
amountBought = finalBalance0;
intermediateToken = _token0;
} else {
amountBought = finalBalance1;
intermediateToken = _token1;
}
require(amountBought > 0, "Swapped to Invalid Intermediate");
}
function _swapIntermediate(
address _toContractAddress,
address _ToUnipoolToken0,
address _ToUnipoolToken1,
uint256 _amount
) internal returns (uint256 token0Bought, uint256 token1Bought) {
IUniswapV2Pair pair =
IUniswapV2Pair(
sushiSwapFactoryAddress.getPair(
_ToUnipoolToken0,
_ToUnipoolToken1
)
);
(uint256 res0, uint256 res1, ) = pair.getReserves();
if (_toContractAddress == _ToUnipoolToken0) {
uint256 amountToSwap = calculateSwapInAmount(res0, _amount);
//if no reserve or a new pair is created
if (amountToSwap <= 0) amountToSwap = _amount / 2;
token1Bought = _token2Token(
_toContractAddress,
_ToUnipoolToken1,
amountToSwap
);
token0Bought = _amount - amountToSwap;
} else {
uint256 amountToSwap = calculateSwapInAmount(res1, _amount);
//if no reserve or a new pair is created
if (amountToSwap <= 0) amountToSwap = _amount / 2;
token0Bought = _token2Token(
_toContractAddress,
_ToUnipoolToken0,
amountToSwap
);
token1Bought = _amount - amountToSwap;
}
}
function calculateSwapInAmount(uint256 reserveIn, uint256 userIn)
internal
pure
returns (uint256)
{
return
(Babylonian.sqrt(
reserveIn * ((userIn * 3988000) + (reserveIn * 3988009))
) - (reserveIn * 1997)) / 1994;
}
/**
@notice This function is used to swap ERC20 <> ERC20
@param _FromTokenContractAddress The token address to swap from.
@param _ToTokenContractAddress The token address to swap to.
@param tokens2Trade The amount of tokens to swap
@return tokenBought The quantity of tokens bought
*/
function _token2Token(
address _FromTokenContractAddress,
address _ToTokenContractAddress,
uint256 tokens2Trade
) internal returns (uint256 tokenBought) {
if (_FromTokenContractAddress == _ToTokenContractAddress) {
return tokens2Trade;
}
_approveToken(
_FromTokenContractAddress,
address(sushiSwapRouter),
tokens2Trade
);
address pair =
sushiSwapFactoryAddress.getPair(
_FromTokenContractAddress,
_ToTokenContractAddress
);
require(pair != address(0), "No Swap Available");
address[] memory path = new address[](2);
path[0] = _FromTokenContractAddress;
path[1] = _ToTokenContractAddress;
tokenBought = sushiSwapRouter.swapExactTokensForTokens(
tokens2Trade,
1,
path,
address(this),
deadline
)[path.length - 1];
require(tokenBought > 0, "Error Swapping Tokens 2");
}
}
// ███████╗░█████╗░██████╗░██████╗░███████╗██████╗░░░░███████╗██╗
// ╚════██║██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔══██╗░░░██╔════╝██║
// ░░███╔═╝███████║██████╔╝██████╔╝█████╗░░██████╔╝░░░█████╗░░██║
// ██╔══╝░░██╔══██║██╔═══╝░██╔═══╝░██╔══╝░░██╔══██╗░░░██╔══╝░░██║
// ███████╗██║░░██║██║░░░░░██║░░░░░███████╗██║░░██║██╗██║░░░░░██║
// ╚══════╝╚═╝░░╚═╝╚═╝░░░░░╚═╝░░░░░╚══════╝╚═╝░░╚═╝╚═╝╚═╝░░░░░╚═╝
// Copyright (C) 2021 zapper
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
///@author Zapper
///@notice This contract adds liquidity to Curve pools with ETH or ERC tokens.
// SPDX-License-Identifier: GPL-2.0
pragma solidity ^0.8.0;
import "../_base/ZapInBaseV3.sol";
interface IWETH {
function deposit() external payable;
}
interface ICurveSwap {
function coins(int128 arg0) external view returns (address);
function underlying_coins(int128 arg0) external view returns (address);
function add_liquidity(uint256[4] calldata amounts, uint256 min_mint_amount)
external;
function add_liquidity(
uint256[4] calldata amounts,
uint256 min_mint_amount,
bool addUnderlying
) external;
function add_liquidity(uint256[3] calldata amounts, uint256 min_mint_amount)
external;
function add_liquidity(
uint256[3] calldata amounts,
uint256 min_mint_amount,
bool addUnderlying
) external;
function add_liquidity(uint256[2] calldata amounts, uint256 min_mint_amount)
external;
function add_liquidity(
uint256[2] calldata amounts,
uint256 min_mint_amount,
bool addUnderlying
) external;
}
interface ICurveEthSwap {
function add_liquidity(uint256[2] calldata amounts, uint256 min_mint_amount)
external
payable
returns (uint256);
}
interface ICurveRegistry {
function getSwapAddress(address tokenAddress)
external
view
returns (address swapAddress);
function getTokenAddress(address swapAddress)
external
view
returns (address tokenAddress);
function getDepositAddress(address swapAddress)
external
view
returns (address depositAddress);
function getPoolTokens(address swapAddress)
external
view
returns (address[4] memory poolTokens);
function shouldAddUnderlying(address swapAddress)
external
view
returns (bool);
function getNumTokens(address swapAddress)
external
view
returns (uint8 numTokens);
function isBtcPool(address swapAddress) external view returns (bool);
function isEthPool(address swapAddress) external view returns (bool);
function isUnderlyingToken(
address swapAddress,
address tokenContractAddress
) external view returns (bool, uint8);
}
contract Curve_ZapIn_General_V4 is ZapInBaseV3 {
using SafeERC20 for IERC20;
ICurveRegistry public curveReg;
address private constant wethTokenAddress =
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;
constructor(
ICurveRegistry _curveRegistry,
uint256 _goodwill,
uint256 _affiliateSplit
) ZapBaseV2(_goodwill, _affiliateSplit) {
curveReg = _curveRegistry;
// 0x exchange
approvedTargets[0xDef1C0ded9bec7F1a1670819833240f027b25EfF] = true;
}
event zapIn(address sender, address pool, uint256 tokensRec);
/**
@notice This function adds liquidity to a Curve pool with ETH or ERC20 tokens
@param fromTokenAddress The token used for entry (address(0) if ether)
@param toTokenAddress The intermediate ERC20 token to swap to
@param swapAddress Curve swap address for the pool
@param incomingTokenQty The amount of fromTokenAddress to invest
@param minPoolTokens The minimum acceptable quantity of Curve LP to receive. Reverts otherwise
@param swapTarget Excecution target for the first swap
@param swapData DEX quote data
@param affiliate Affiliate address
@param shouldSellEntireBalance If True transfers entrire allowable amount from another contract
@return crvTokensBought Quantity of Curve LP tokens received
*/
function ZapIn(
address fromTokenAddress,
address toTokenAddress,
address swapAddress,
uint256 incomingTokenQty,
uint256 minPoolTokens,
address swapTarget,
bytes calldata swapData,
address affiliate,
bool shouldSellEntireBalance
) external payable stopInEmergency returns (uint256 crvTokensBought) {
uint256 toInvest =
_pullTokens(
fromTokenAddress,
incomingTokenQty,
affiliate,
true,
shouldSellEntireBalance
);
if (fromTokenAddress == address(0)) {
fromTokenAddress = ETHAddress;
}
// perform zapIn
crvTokensBought = _performZapIn(
fromTokenAddress,
toTokenAddress,
swapAddress,
toInvest,
swapTarget,
swapData
);
require(
crvTokensBought > minPoolTokens,
"Received less than minPoolTokens"
);
address poolTokenAddress = curveReg.getTokenAddress(swapAddress);
emit zapIn(msg.sender, poolTokenAddress, crvTokensBought);
IERC20(poolTokenAddress).transfer(msg.sender, crvTokensBought);
}
function _performZapIn(
address fromTokenAddress,
address toTokenAddress,
address swapAddress,
uint256 toInvest,
address swapTarget,
bytes memory swapData
) internal returns (uint256 crvTokensBought) {
(bool isUnderlying, uint8 underlyingIndex) =
curveReg.isUnderlyingToken(swapAddress, fromTokenAddress);
if (isUnderlying) {
crvTokensBought = _enterCurve(
swapAddress,
toInvest,
underlyingIndex
);
} else {
//swap tokens using 0x swap
uint256 tokensBought =
_fillQuote(
fromTokenAddress,
toTokenAddress,
toInvest,
swapTarget,
swapData
);
if (toTokenAddress == address(0)) toTokenAddress = ETHAddress;
//get underlying token index
(isUnderlying, underlyingIndex) = curveReg.isUnderlyingToken(
swapAddress,
toTokenAddress
);
if (isUnderlying) {
crvTokensBought = _enterCurve(
swapAddress,
tokensBought,
underlyingIndex
);
} else {
(uint256 tokens, uint8 metaIndex) =
_enterMetaPool(swapAddress, toTokenAddress, tokensBought);
crvTokensBought = _enterCurve(swapAddress, tokens, metaIndex);
}
}
}
/**
@notice This function gets adds the liquidity for meta pools and returns the token index and swap tokens
@param swapAddress Curve swap address for the pool
@param toTokenAddress The ERC20 token to which from token to be convert
@param swapTokens quantity of toToken to invest
@return tokensBought quantity of curve LP acquired
@return index index of LP token in swapAddress whose pool tokens were acquired
*/
function _enterMetaPool(
address swapAddress,
address toTokenAddress,
uint256 swapTokens
) internal returns (uint256 tokensBought, uint8 index) {
address[4] memory poolTokens = curveReg.getPoolTokens(swapAddress);
for (uint8 i = 0; i < 4; i++) {
address intermediateSwapAddress =
curveReg.getSwapAddress(poolTokens[i]);
if (intermediateSwapAddress != address(0)) {
(, index) = curveReg.isUnderlyingToken(
intermediateSwapAddress,
toTokenAddress
);
tokensBought = _enterCurve(
intermediateSwapAddress,
swapTokens,
index
);
return (tokensBought, i);
}
}
}
function _fillQuote(
address fromTokenAddress,
address toTokenAddress,
uint256 amount,
address swapTarget,
bytes memory swapData
) internal returns (uint256 amountBought) {
if (fromTokenAddress == toTokenAddress) {
return amount;
}
if (swapTarget == wethTokenAddress) {
IWETH(wethTokenAddress).deposit{ value: amount }();
return amount;
}
uint256 valueToSend;
if (fromTokenAddress == ETHAddress) {
valueToSend = amount;
} else {
_approveToken(fromTokenAddress, swapTarget, amount);
}
uint256 initialBalance = _getBalance(toTokenAddress);
require(approvedTargets[swapTarget], "Target not Authorized");
(bool success, ) = swapTarget.call{ value: valueToSend }(swapData);
require(success, "Error Swapping Tokens");
amountBought = _getBalance(toTokenAddress) - initialBalance;
require(amountBought > 0, "Swapped To Invalid Intermediate");
}
/**
@notice This function adds liquidity to a curve pool
@param swapAddress Curve swap address for the pool
@param amount The quantity of tokens being added as liquidity
@param index The token index for the add_liquidity call
@return crvTokensBought the quantity of curve LP tokens received
*/
function _enterCurve(
address swapAddress,
uint256 amount,
uint8 index
) internal returns (uint256 crvTokensBought) {
address tokenAddress = curveReg.getTokenAddress(swapAddress);
address depositAddress = curveReg.getDepositAddress(swapAddress);
uint256 initialBalance = _getBalance(tokenAddress);
address entryToken = curveReg.getPoolTokens(swapAddress)[index];
if (entryToken != ETHAddress) {
IERC20(entryToken).safeIncreaseAllowance(
address(depositAddress),
amount
);
}
uint256 numTokens = curveReg.getNumTokens(swapAddress);
bool addUnderlying = curveReg.shouldAddUnderlying(swapAddress);
if (numTokens == 4) {
uint256[4] memory amounts;
amounts[index] = amount;
if (addUnderlying) {
ICurveSwap(depositAddress).add_liquidity(amounts, 0, true);
} else {
ICurveSwap(depositAddress).add_liquidity(amounts, 0);
}
} else if (numTokens == 3) {
uint256[3] memory amounts;
amounts[index] = amount;
if (addUnderlying) {
ICurveSwap(depositAddress).add_liquidity(amounts, 0, true);
} else {
ICurveSwap(depositAddress).add_liquidity(amounts, 0);
}
} else {
uint256[2] memory amounts;
amounts[index] = amount;
if (curveReg.isEthPool(depositAddress)) {
ICurveEthSwap(depositAddress).add_liquidity{ value: amount }(
amounts,
0
);
} else if (addUnderlying) {
ICurveSwap(depositAddress).add_liquidity(amounts, 0, true);
} else {
ICurveSwap(depositAddress).add_liquidity(amounts, 0);
}
}
crvTokensBought = _getBalance(tokenAddress) - initialBalance;
}
function updateCurveRegistry(ICurveRegistry newCurveRegistry)
external
onlyOwner
{
require(newCurveRegistry != curveReg, "Already using this Registry");
curveReg = newCurveRegistry;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./SafeERC20.sol";
/**
* @dev A token holder contract that will allow a beneficiary to extract the
* tokens after a given release time.
*
* Useful for simple vesting schedules like "advisors get all of their tokens
* after 1 year".
*/
contract TokenTimelock {
using SafeERC20 for IERC20;
// ERC20 basic token contract being held
IERC20 private immutable _token;
// beneficiary of tokens after they are released
address private immutable _beneficiary;
// timestamp when token release is enabled
uint256 private immutable _releaseTime;
constructor(
IERC20 token_,
address beneficiary_,
uint256 releaseTime_
) {
// solhint-disable-next-line not-rely-on-time
require(
releaseTime_ > block.timestamp,
"TokenTimelock: release time is before current time"
);
_token = token_;
_beneficiary = beneficiary_;
_releaseTime = releaseTime_;
}
/**
* @return the token being held.
*/
function token() public view virtual returns (IERC20) {
return _token;
}
/**
* @return the beneficiary of the tokens.
*/
function beneficiary() public view virtual returns (address) {
return _beneficiary;
}
/**
* @return the time when the tokens are released.
*/
function releaseTime() public view virtual returns (uint256) {
return _releaseTime;
}
/**
* @notice Transfers tokens held by timelock to beneficiary.
*/
function release() public virtual {
// solhint-disable-next-line not-rely-on-time
require(
block.timestamp >= releaseTime(),
"TokenTimelock: current time is before release time"
);
uint256 amount = token().balanceOf(address(this));
require(amount > 0, "TokenTimelock: no tokens to release");
token().safeTransfer(beneficiary(), amount);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./IERC20.sol";
import "./extensions/IERC20Metadata.sol";
import "../../utils/Context.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* We have followed general OpenZeppelin guidelines: functions revert instead
* of returning `false` on failure. This behavior is nonetheless conventional
* and does not conflict with the expectations of ERC20 applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20 is Context, IERC20, IERC20Metadata {
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* The defaut value of {decimals} is 18. To select a different value for
* {decimals} you should overload it.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5,05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the value {ERC20} uses, unless this function is
* overridden;
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `recipient` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address recipient, uint256 amount)
public
virtual
override
returns (bool)
{
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender)
public
view
virtual
override
returns (uint256)
{
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount)
public
virtual
override
returns (bool)
{
_approve(_msgSender(), spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* Requirements:
*
* - `sender` and `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
* - the caller must have allowance for ``sender``'s tokens of at least
* `amount`.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) public virtual override returns (bool) {
_transfer(sender, recipient, amount);
uint256 currentAllowance = _allowances[sender][_msgSender()];
require(
currentAllowance >= amount,
"ERC20: transfer amount exceeds allowance"
);
_approve(sender, _msgSender(), currentAllowance - amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue)
public
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
_allowances[_msgSender()][spender] + addedValue
);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue)
public
virtual
returns (bool)
{
uint256 currentAllowance = _allowances[_msgSender()][spender];
require(
currentAllowance >= subtractedValue,
"ERC20: decreased allowance below zero"
);
_approve(_msgSender(), spender, currentAllowance - subtractedValue);
return true;
}
/**
* @dev Moves tokens `amount` from `sender` to `recipient`.
*
* This is internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `sender` cannot be the zero address.
* - `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
*/
function _transfer(
address sender,
address recipient,
uint256 amount
) internal virtual {
require(sender != address(0), "ERC20: transfer from the zero address");
require(recipient != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(sender, recipient, amount);
uint256 senderBalance = _balances[sender];
require(
senderBalance >= amount,
"ERC20: transfer amount exceeds balance"
);
_balances[sender] = senderBalance - amount;
_balances[recipient] += amount;
emit Transfer(sender, recipient, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `to` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
_balances[account] += amount;
emit Transfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
_balances[account] = accountBalance - amount;
_totalSupply -= amount;
emit Transfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be to transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../utils/Context.sol";
import "../utils/Strings.sol";
import "../utils/introspection/ERC165.sol";
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControl {
function hasRole(bytes32 role, address account)
external
view
returns (bool);
function getRoleAdmin(bytes32 role) external view returns (bytes32);
function grantRole(bytes32 role, address account) external;
function revokeRole(bytes32 role, address account) external;
function renounceRole(bytes32 role, address account) external;
}
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it.
*/
abstract contract AccessControl is Context, IAccessControl, ERC165 {
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
mapping(bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(
bytes32 indexed role,
bytes32 indexed previousAdminRole,
bytes32 indexed newAdminRole
);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {_setupRole}.
*/
event RoleGranted(
bytes32 indexed role,
address indexed account,
address indexed sender
);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(
bytes32 indexed role,
address indexed account,
address indexed sender
);
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with a standardized message including the required role.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{20}) is missing role (0x[0-9a-f]{32})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
_checkRole(role, _msgSender());
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override
returns (bool)
{
return
interfaceId == type(IAccessControl).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account)
public
view
override
returns (bool)
{
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `account` is missing `role`.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{20}) is missing role (0x[0-9a-f]{32})$/
*/
function _checkRole(bytes32 role, address account) internal view {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
Strings.toHexString(uint160(account), 20),
" is missing role ",
Strings.toHexString(uint256(role), 32)
)
)
);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view override returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account)
public
virtual
override
onlyRole(getRoleAdmin(role))
{
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account)
public
virtual
override
onlyRole(getRoleAdmin(role))
{
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account)
public
virtual
override
{
require(
account == _msgSender(),
"AccessControl: can only renounce roles for self"
);
_revokeRole(role, account);
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
emit RoleAdminChanged(role, getRoleAdmin(role), adminRole);
_roles[role].adminRole = adminRole;
}
function _grantRole(bytes32 role, address account) private {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
function _revokeRole(bytes32 role, address account) private {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant alphabet = "0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length)
internal
pure
returns (string memory)
{
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = alphabet[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override
returns (bool)
{
return interfaceId == type(IERC165).interfaceId;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}