// File: @openzeppelin/contracts-ethereum-package/contracts/math/SafeMath.sol
pragma solidity ^0.5.0;
/**
* @dev Wrappers over Solidity's arithmetic operations with added overflow
* checks.
*
* Arithmetic operations in Solidity wrap on overflow. This can easily result
* in bugs, because programmers usually assume that an overflow raises an
* error, which is the standard behavior in high level programming languages.
* `SafeMath` restores this intuition by reverting the transaction when an
* operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*/
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
require(c >= a, "SafeMath: addition overflow");
return c;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
return sub(a, b, "SafeMath: subtraction overflow");
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
* - Subtraction cannot overflow.
*
* _Available since v2.4.0._
*/
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b <= a, errorMessage);
uint256 c = a - b;
return c;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) {
return 0;
}
uint256 c = a * b;
require(c / a == b, "SafeMath: multiplication overflow");
return c;
}
/**
* @dev Returns the integer division of two unsigned integers. Reverts on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return div(a, b, "SafeMath: division by zero");
}
/**
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
* - The divisor cannot be zero.
*
* _Available since v2.4.0._
*/
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
// Solidity only automatically asserts when dividing by 0
require(b > 0, errorMessage);
uint256 c = a / b;
// assert(a == b * c + a % b); // There is no case in which this doesn't hold
return c;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* Reverts when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
return mod(a, b, "SafeMath: modulo by zero");
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* Reverts with custom message when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
* - The divisor cannot be zero.
*
* _Available since v2.4.0._
*/
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b != 0, errorMessage);
return a % b;
}
}
// File: @openzeppelin/contracts-ethereum-package/contracts/drafts/SignedSafeMath.sol
pragma solidity ^0.5.0;
/**
* @title SignedSafeMath
* @dev Signed math operations with safety checks that revert on error.
*/
library SignedSafeMath {
int256 constant private INT256_MIN = -2**255;
/**
* @dev Multiplies two signed integers, reverts on overflow.
*/
function mul(int256 a, int256 b) internal pure returns (int256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) {
return 0;
}
require(!(a == -1 && b == INT256_MIN), "SignedSafeMath: multiplication overflow");
int256 c = a * b;
require(c / a == b, "SignedSafeMath: multiplication overflow");
return c;
}
/**
* @dev Integer division of two signed integers truncating the quotient, reverts on division by zero.
*/
function div(int256 a, int256 b) internal pure returns (int256) {
require(b != 0, "SignedSafeMath: division by zero");
require(!(b == -1 && a == INT256_MIN), "SignedSafeMath: division overflow");
int256 c = a / b;
return c;
}
/**
* @dev Subtracts two signed integers, reverts on overflow.
*/
function sub(int256 a, int256 b) internal pure returns (int256) {
int256 c = a - b;
require((b >= 0 && c <= a) || (b < 0 && c > a), "SignedSafeMath: subtraction overflow");
return c;
}
/**
* @dev Adds two signed integers, reverts on overflow.
*/
function add(int256 a, int256 b) internal pure returns (int256) {
int256 c = a + b;
require((b >= 0 && c >= a) || (b < 0 && c < a), "SignedSafeMath: addition overflow");
return c;
}
}
// File: @openzeppelin/upgrades/contracts/Initializable.sol
pragma solidity >=0.4.24 <0.7.0;
/**
* @title Initializable
*
* @dev Helper contract to support initializer functions. To use it, replace
* the constructor with a function that has the `initializer` modifier.
* WARNING: Unlike constructors, initializer functions must be manually
* invoked. This applies both to deploying an Initializable contract, as well
* as extending an Initializable contract via inheritance.
* WARNING: When used with inheritance, manual care must be taken to not invoke
* a parent initializer twice, or ensure that all initializers are idempotent,
* because this is not dealt with automatically as with constructors.
*/
contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
*/
bool private initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private initializing;
/**
* @dev Modifier to use in the initializer function of a contract.
*/
modifier initializer() {
require(initializing || isConstructor() || !initialized, "Contract instance has already been initialized");
bool isTopLevelCall = !initializing;
if (isTopLevelCall) {
initializing = true;
initialized = true;
}
_;
if (isTopLevelCall) {
initializing = false;
}
}
/// @dev Returns true if and only if the function is running in the constructor
function isConstructor() private view returns (bool) {
// extcodesize checks the size of the code stored in an address, and
// address returns the current address. Since the code is still not
// deployed when running a constructor, any checks on its code size will
// yield zero, making it an effective way to detect if a contract is
// under construction or not.
address self = address(this);
uint256 cs;
assembly { cs := extcodesize(self) }
return cs == 0;
}
// Reserved storage space to allow for layout changes in the future.
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/GSN/Context.sol
pragma solidity ^0.5.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 GSN 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.
*/
contract Context is Initializable {
// Empty internal constructor, to prevent people from mistakenly deploying
// an instance of this contract, which should be used via inheritance.
constructor () internal { }
// solhint-disable-previous-line no-empty-blocks
function _msgSender() internal view returns (address payable) {
return msg.sender;
}
function _msgData() internal view returns (bytes memory) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
return msg.data;
}
}
// File: @openzeppelin/contracts-ethereum-package/contracts/ownership/Ownable.sol
pragma solidity ^0.5.0;
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be aplied to your functions to restrict their use to
* the owner.
*/
contract Ownable is Initializable, Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
function initialize(address sender) public initializer {
_owner = sender;
emit OwnershipTransferred(address(0), _owner);
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(isOwner(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Returns true if the caller is the current owner.
*/
function isOwner() public view returns (bool) {
return _msgSender() == _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 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 onlyOwner {
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
*/
function _transferOwnership(address newOwner) internal {
require(newOwner != address(0), "Ownable: new owner is the zero address");
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/IERC20.sol
pragma solidity ^0.5.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP. Does not include
* the optional functions; to access them see {ERC20Detailed}.
*/
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);
}
// File: @openzeppelin/contracts-ethereum-package/contracts/utils/Address.sol
pragma solidity ^0.5.5;
/**
* @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) {
// According to EIP-1052, 0x0 is the value returned for not-yet created accounts
// and 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470 is returned
// for accounts without code, i.e. `keccak256('')`
bytes32 codehash;
bytes32 accountHash = 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470;
// solhint-disable-next-line no-inline-assembly
assembly { codehash := extcodehash(account) }
return (codehash != accountHash && codehash != 0x0);
}
/**
* @dev Converts an `address` into `address payable`. Note that this is
* simply a type cast: the actual underlying value is not changed.
*
* _Available since v2.4.0._
*/
function toPayable(address account) internal pure returns (address payable) {
return address(uint160(account));
}
/**
* @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].
*
* _Available since v2.4.0._
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
// solhint-disable-next-line avoid-call-value
(bool success, ) = recipient.call.value(amount)("");
require(success, "Address: unable to send value, recipient may have reverted");
}
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/SafeERC20.sol
pragma solidity ^0.5.0;
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for ERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using SafeMath for uint256;
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));
}
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).add(value);
callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero");
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.
// A Solidity high level call has three parts:
// 1. The target address is checked to verify it contains contract code
// 2. The call itself is made, and success asserted
// 3. The return value is decoded, which in turn checks the size of the returned data.
// solhint-disable-next-line max-line-length
require(address(token).isContract(), "SafeERC20: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = address(token).call(data);
require(success, "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");
}
}
}
// File: @0x/contracts-utils/contracts/src/LibEIP712.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibEIP712 {
// Hash of the EIP712 Domain Separator Schema
// keccak256(abi.encodePacked(
// "EIP712Domain(",
// "string name,",
// "string version,",
// "uint256 chainId,",
// "address verifyingContract",
// ")"
// ))
bytes32 constant internal _EIP712_DOMAIN_SEPARATOR_SCHEMA_HASH = 0x8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f;
/// @dev Calculates a EIP712 domain separator.
/// @param name The EIP712 domain name.
/// @param version The EIP712 domain version.
/// @param verifyingContract The EIP712 verifying contract.
/// @return EIP712 domain separator.
function hashEIP712Domain(
string memory name,
string memory version,
uint256 chainId,
address verifyingContract
)
internal
pure
returns (bytes32 result)
{
bytes32 schemaHash = _EIP712_DOMAIN_SEPARATOR_SCHEMA_HASH;
// Assembly for more efficient computing:
// keccak256(abi.encodePacked(
// _EIP712_DOMAIN_SEPARATOR_SCHEMA_HASH,
// keccak256(bytes(name)),
// keccak256(bytes(version)),
// chainId,
// uint256(verifyingContract)
// ))
assembly {
// Calculate hashes of dynamic data
let nameHash := keccak256(add(name, 32), mload(name))
let versionHash := keccak256(add(version, 32), mload(version))
// Load free memory pointer
let memPtr := mload(64)
// Store params in memory
mstore(memPtr, schemaHash)
mstore(add(memPtr, 32), nameHash)
mstore(add(memPtr, 64), versionHash)
mstore(add(memPtr, 96), chainId)
mstore(add(memPtr, 128), verifyingContract)
// Compute hash
result := keccak256(memPtr, 160)
}
return result;
}
/// @dev Calculates EIP712 encoding for a hash struct with a given domain hash.
/// @param eip712DomainHash Hash of the domain domain separator data, computed
/// with getDomainHash().
/// @param hashStruct The EIP712 hash struct.
/// @return EIP712 hash applied to the given EIP712 Domain.
function hashEIP712Message(bytes32 eip712DomainHash, bytes32 hashStruct)
internal
pure
returns (bytes32 result)
{
// Assembly for more efficient computing:
// keccak256(abi.encodePacked(
// EIP191_HEADER,
// EIP712_DOMAIN_HASH,
// hashStruct
// ));
assembly {
// Load free memory pointer
let memPtr := mload(64)
mstore(memPtr, 0x1901000000000000000000000000000000000000000000000000000000000000) // EIP191 header
mstore(add(memPtr, 2), eip712DomainHash) // EIP712 domain hash
mstore(add(memPtr, 34), hashStruct) // Hash of struct
// Compute hash
result := keccak256(memPtr, 66)
}
return result;
}
}
// File: @0x/contracts-exchange-libs/contracts/src/LibOrder.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibOrder {
using LibOrder for Order;
// Hash for the EIP712 Order Schema:
// keccak256(abi.encodePacked(
// "Order(",
// "address makerAddress,",
// "address takerAddress,",
// "address feeRecipientAddress,",
// "address senderAddress,",
// "uint256 makerAssetAmount,",
// "uint256 takerAssetAmount,",
// "uint256 makerFee,",
// "uint256 takerFee,",
// "uint256 expirationTimeSeconds,",
// "uint256 salt,",
// "bytes makerAssetData,",
// "bytes takerAssetData,",
// "bytes makerFeeAssetData,",
// "bytes takerFeeAssetData",
// ")"
// ))
bytes32 constant internal _EIP712_ORDER_SCHEMA_HASH =
0xf80322eb8376aafb64eadf8f0d7623f22130fd9491a221e902b713cb984a7534;
// A valid order remains fillable until it is expired, fully filled, or cancelled.
// An order's status is unaffected by external factors, like account balances.
enum OrderStatus {
INVALID, // Default value
INVALID_MAKER_ASSET_AMOUNT, // Order does not have a valid maker asset amount
INVALID_TAKER_ASSET_AMOUNT, // Order does not have a valid taker asset amount
FILLABLE, // Order is fillable
EXPIRED, // Order has already expired
FULLY_FILLED, // Order is fully filled
CANCELLED // Order has been cancelled
}
// solhint-disable max-line-length
/// @dev Canonical order structure.
struct Order {
address makerAddress; // Address that created the order.
address takerAddress; // Address that is allowed to fill the order. If set to 0, any address is allowed to fill the order.
address feeRecipientAddress; // Address that will recieve fees when order is filled.
address senderAddress; // Address that is allowed to call Exchange contract methods that affect this order. If set to 0, any address is allowed to call these methods.
uint256 makerAssetAmount; // Amount of makerAsset being offered by maker. Must be greater than 0.
uint256 takerAssetAmount; // Amount of takerAsset being bid on by maker. Must be greater than 0.
uint256 makerFee; // Fee paid to feeRecipient by maker when order is filled.
uint256 takerFee; // Fee paid to feeRecipient by taker when order is filled.
uint256 expirationTimeSeconds; // Timestamp in seconds at which order expires.
uint256 salt; // Arbitrary number to facilitate uniqueness of the order's hash.
bytes makerAssetData; // Encoded data that can be decoded by a specified proxy contract when transferring makerAsset. The leading bytes4 references the id of the asset proxy.
bytes takerAssetData; // Encoded data that can be decoded by a specified proxy contract when transferring takerAsset. The leading bytes4 references the id of the asset proxy.
bytes makerFeeAssetData; // Encoded data that can be decoded by a specified proxy contract when transferring makerFeeAsset. The leading bytes4 references the id of the asset proxy.
bytes takerFeeAssetData; // Encoded data that can be decoded by a specified proxy contract when transferring takerFeeAsset. The leading bytes4 references the id of the asset proxy.
}
// solhint-enable max-line-length
/// @dev Order information returned by `getOrderInfo()`.
struct OrderInfo {
OrderStatus orderStatus; // Status that describes order's validity and fillability.
bytes32 orderHash; // EIP712 typed data hash of the order (see LibOrder.getTypedDataHash).
uint256 orderTakerAssetFilledAmount; // Amount of order that has already been filled.
}
/// @dev Calculates the EIP712 typed data hash of an order with a given domain separator.
/// @param order The order structure.
/// @return EIP712 typed data hash of the order.
function getTypedDataHash(Order memory order, bytes32 eip712ExchangeDomainHash)
internal
pure
returns (bytes32 orderHash)
{
orderHash = LibEIP712.hashEIP712Message(
eip712ExchangeDomainHash,
order.getStructHash()
);
return orderHash;
}
/// @dev Calculates EIP712 hash of the order struct.
/// @param order The order structure.
/// @return EIP712 hash of the order struct.
function getStructHash(Order memory order)
internal
pure
returns (bytes32 result)
{
bytes32 schemaHash = _EIP712_ORDER_SCHEMA_HASH;
bytes memory makerAssetData = order.makerAssetData;
bytes memory takerAssetData = order.takerAssetData;
bytes memory makerFeeAssetData = order.makerFeeAssetData;
bytes memory takerFeeAssetData = order.takerFeeAssetData;
// Assembly for more efficiently computing:
// keccak256(abi.encodePacked(
// EIP712_ORDER_SCHEMA_HASH,
// uint256(order.makerAddress),
// uint256(order.takerAddress),
// uint256(order.feeRecipientAddress),
// uint256(order.senderAddress),
// order.makerAssetAmount,
// order.takerAssetAmount,
// order.makerFee,
// order.takerFee,
// order.expirationTimeSeconds,
// order.salt,
// keccak256(order.makerAssetData),
// keccak256(order.takerAssetData),
// keccak256(order.makerFeeAssetData),
// keccak256(order.takerFeeAssetData)
// ));
assembly {
// Assert order offset (this is an internal error that should never be triggered)
if lt(order, 32) {
invalid()
}
// Calculate memory addresses that will be swapped out before hashing
let pos1 := sub(order, 32)
let pos2 := add(order, 320)
let pos3 := add(order, 352)
let pos4 := add(order, 384)
let pos5 := add(order, 416)
// Backup
let temp1 := mload(pos1)
let temp2 := mload(pos2)
let temp3 := mload(pos3)
let temp4 := mload(pos4)
let temp5 := mload(pos5)
// Hash in place
mstore(pos1, schemaHash)
mstore(pos2, keccak256(add(makerAssetData, 32), mload(makerAssetData))) // store hash of makerAssetData
mstore(pos3, keccak256(add(takerAssetData, 32), mload(takerAssetData))) // store hash of takerAssetData
mstore(pos4, keccak256(add(makerFeeAssetData, 32), mload(makerFeeAssetData))) // store hash of makerFeeAssetData
mstore(pos5, keccak256(add(takerFeeAssetData, 32), mload(takerFeeAssetData))) // store hash of takerFeeAssetData
result := keccak256(pos1, 480)
// Restore
mstore(pos1, temp1)
mstore(pos2, temp2)
mstore(pos3, temp3)
mstore(pos4, temp4)
mstore(pos5, temp5)
}
return result;
}
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/ERC20.sol
pragma solidity ^0.5.0;
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20Mintable}.
*
* 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 Initializable, Context, IERC20 {
using SafeMath for uint256;
mapping (address => uint256) private _balances;
mapping (address => mapping (address => uint256)) private _allowances;
uint256 private _totalSupply;
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view 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 returns (bool) {
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public 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 returns (bool) {
_transfer(sender, recipient, amount);
_approve(sender, _msgSender(), _allowances[sender][_msgSender()].sub(amount, "ERC20: transfer amount exceeds allowance"));
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 returns (bool) {
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(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 returns (bool) {
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue, "ERC20: decreased allowance below zero"));
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 {
require(sender != address(0), "ERC20: transfer from the zero address");
require(recipient != address(0), "ERC20: transfer to the zero address");
_balances[sender] = _balances[sender].sub(amount, "ERC20: transfer amount exceeds balance");
_balances[recipient] = _balances[recipient].add(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 {
require(account != address(0), "ERC20: mint to the zero address");
_totalSupply = _totalSupply.add(amount);
_balances[account] = _balances[account].add(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 {
require(account != address(0), "ERC20: burn from the zero address");
_balances[account] = _balances[account].sub(amount, "ERC20: burn amount exceeds balance");
_totalSupply = _totalSupply.sub(amount);
emit Transfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner`s tokens.
*
* This is 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 {
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 Destroys `amount` tokens from `account`.`amount` is then deducted
* from the caller's allowance.
*
* See {_burn} and {_approve}.
*/
function _burnFrom(address account, uint256 amount) internal {
_burn(account, amount);
_approve(account, _msgSender(), _allowances[account][_msgSender()].sub(amount, "ERC20: burn amount exceeds allowance"));
}
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/ERC20Detailed.sol
pragma solidity ^0.5.0;
/**
* @dev Optional functions from the ERC20 standard.
*/
contract ERC20Detailed is Initializable, IERC20 {
string private _name;
string private _symbol;
uint8 private _decimals;
/**
* @dev Sets the values for `name`, `symbol`, and `decimals`. All three of
* these values are immutable: they can only be set once during
* construction.
*/
function initialize(string memory name, string memory symbol, uint8 decimals) public initializer {
_name = name;
_symbol = symbol;
_decimals = decimals;
}
/**
* @dev Returns the name of the token.
*/
function name() public view returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view 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.
*
* 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 returns (uint8) {
return _decimals;
}
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/access/Roles.sol
pragma solidity ^0.5.0;
/**
* @title Roles
* @dev Library for managing addresses assigned to a Role.
*/
library Roles {
struct Role {
mapping (address => bool) bearer;
}
/**
* @dev Give an account access to this role.
*/
function add(Role storage role, address account) internal {
require(!has(role, account), "Roles: account already has role");
role.bearer[account] = true;
}
/**
* @dev Remove an account's access to this role.
*/
function remove(Role storage role, address account) internal {
require(has(role, account), "Roles: account does not have role");
role.bearer[account] = false;
}
/**
* @dev Check if an account has this role.
* @return bool
*/
function has(Role storage role, address account) internal view returns (bool) {
require(account != address(0), "Roles: account is the zero address");
return role.bearer[account];
}
}
// File: @openzeppelin/contracts-ethereum-package/contracts/access/roles/MinterRole.sol
pragma solidity ^0.5.0;
contract MinterRole is Initializable, Context {
using Roles for Roles.Role;
event MinterAdded(address indexed account);
event MinterRemoved(address indexed account);
Roles.Role private _minters;
function initialize(address sender) public initializer {
if (!isMinter(sender)) {
_addMinter(sender);
}
}
modifier onlyMinter() {
require(isMinter(_msgSender()), "MinterRole: caller does not have the Minter role");
_;
}
function isMinter(address account) public view returns (bool) {
return _minters.has(account);
}
function addMinter(address account) public onlyMinter {
_addMinter(account);
}
function renounceMinter() public {
_removeMinter(_msgSender());
}
function _addMinter(address account) internal {
_minters.add(account);
emit MinterAdded(account);
}
function _removeMinter(address account) internal {
_minters.remove(account);
emit MinterRemoved(account);
}
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/ERC20Mintable.sol
pragma solidity ^0.5.0;
/**
* @dev Extension of {ERC20} that adds a set of accounts with the {MinterRole},
* which have permission to mint (create) new tokens as they see fit.
*
* At construction, the deployer of the contract is the only minter.
*/
contract ERC20Mintable is Initializable, ERC20, MinterRole {
function initialize(address sender) public initializer {
MinterRole.initialize(sender);
}
/**
* @dev See {ERC20-_mint}.
*
* Requirements:
*
* - the caller must have the {MinterRole}.
*/
function mint(address account, uint256 amount) public onlyMinter returns (bool) {
_mint(account, amount);
return true;
}
uint256[50] private ______gap;
}
// File: @openzeppelin/contracts-ethereum-package/contracts/token/ERC20/ERC20Burnable.sol
pragma solidity ^0.5.0;
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
contract ERC20Burnable is Initializable, Context, ERC20 {
/**
* @dev Destroys `amount` tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 amount) public {
_burn(_msgSender(), amount);
}
/**
* @dev See {ERC20-_burnFrom}.
*/
function burnFrom(address account, uint256 amount) public {
_burnFrom(account, amount);
}
uint256[50] private ______gap;
}
// File: contracts/interfaces/IRariGovernanceTokenDistributor.sol
pragma solidity 0.5.17;
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
/**
* @title IRariGovernanceTokenDistributor
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @notice IRariGovernanceTokenDistributor is a simple interface for RariGovernanceTokenDistributor used by RariFundManager and RariFundToken.
*/
interface IRariGovernanceTokenDistributor {
/**
* @notice Enum for the Rari pools to which distributions are rewarded.
*/
enum RariPool {
Stable,
Yield,
Ethereum
}
/**
* @notice Boolean indicating if this contract is disabled.
*/
function disabled() external returns (bool);
/**
* @notice Starting block number of the distribution.
*/
function distributionStartBlock() external returns (uint256);
/**
* @notice Ending block number of the distribution.
*/
function distributionEndBlock() external returns (uint256);
/**
* @dev Updates RGT distribution speeds for each pool given one `pool` and its `newBalance` (only accessible by the RariFundManager corresponding to `pool`).
* @param pool The pool whose balance should be refreshed.
* @param newBalance The new balance of the pool to be refreshed.
*/
function refreshDistributionSpeeds(RariPool pool, uint256 newBalance) external;
/**
* @notice Updates RGT distribution speeds for each pool given one `pool` whose balance should be refreshed.
* @param pool The pool whose balance should be refreshed.
*/
function refreshDistributionSpeeds(RariPool pool) external;
/**
* @dev Distributes all undistributed RGT earned by `holder` in `pool` (without reverting if no RGT is available to distribute).
* @param holder The holder of RSPT, RYPT, or REPT whose RGT is to be distributed.
* @param pool The Rari pool for which to distribute RGT.
* @return The quantity of RGT distributed.
*/
function distributeRgt(address holder, RariPool pool) external returns (uint256);
/**
* @dev Stores the RGT distributed per RSPT/RYPT/REPT right before `holder`'s first incoming RSPT/RYPT/REPT transfer since having a zero balance.
* @param holder The holder of RSPT, RYPT, and/or REPT.
* @param pool The Rari pool of the pool token.
*/
function beforeFirstPoolTokenTransferIn(address holder, RariPool pool) external;
}
// File: contracts/RariFundToken.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title RariFundToken
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @notice RariFundToken is the ERC20 token contract accounting for the ownership of RariFundController's funds.
*/
contract RariFundToken is Initializable, ERC20, ERC20Detailed, ERC20Mintable, ERC20Burnable {
using SafeMath for uint256;
/**
* @dev Initializer for RariFundToken.
*/
function initialize() public initializer {
ERC20Detailed.initialize("Rari Stable Pool Token", "RSPT", 18);
ERC20Mintable.initialize(msg.sender);
}
/**
* @dev Contract of the RariGovernanceTokenDistributor.
*/
IRariGovernanceTokenDistributor public rariGovernanceTokenDistributor;
/**
* @dev Emitted when the GovernanceTokenDistributorSet of the RariFundManager is set or upgraded.
*/
event GovernanceTokenDistributorSet(address newContract);
/**
* @dev Sets or upgrades the RariGovernanceTokenDistributor of the RariFundToken. Caller must have the {MinterRole}.
* @param newContract The address of the new RariGovernanceTokenDistributor contract.
* @param force Boolean indicating if we should not revert on validation error.
*/
function setGovernanceTokenDistributor(address payable newContract, bool force) external onlyMinter {
if (!force && address(rariGovernanceTokenDistributor) != address(0)) {
require(rariGovernanceTokenDistributor.disabled(), "The old governance token distributor contract has not been disabled. (Set `force` to true to avoid this error.)");
require(newContract != address(0), "By default, the governance token distributor cannot be set to the zero address. (Set `force` to true to avoid this error.)");
}
rariGovernanceTokenDistributor = IRariGovernanceTokenDistributor(newContract);
if (newContract != address(0)) {
if (!force) require(block.number <= rariGovernanceTokenDistributor.distributionStartBlock(), "The distribution period has already started. (Set `force` to true to avoid this error.)");
if (block.number < rariGovernanceTokenDistributor.distributionEndBlock()) rariGovernanceTokenDistributor.refreshDistributionSpeeds(IRariGovernanceTokenDistributor.RariPool.Stable);
}
emit GovernanceTokenDistributorSet(newContract);
}
/*
* @notice Moves `amount` tokens from the caller's account to `recipient`.
* @dev Claims RGT earned by the sender and `recipient` beforehand (so RariGovernanceTokenDistributor can continue distributing RGT considering the new RSPT balances).
* @return A boolean value indicating whether the operation succeeded.
*/
function transfer(address recipient, uint256 amount) public returns (bool) {
// Claim RGT/set timestamp for initial transfer of RSPT to `recipient`
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) {
rariGovernanceTokenDistributor.distributeRgt(_msgSender(), IRariGovernanceTokenDistributor.RariPool.Stable);
if (balanceOf(recipient) > 0) rariGovernanceTokenDistributor.distributeRgt(recipient, IRariGovernanceTokenDistributor.RariPool.Stable);
else rariGovernanceTokenDistributor.beforeFirstPoolTokenTransferIn(recipient, IRariGovernanceTokenDistributor.RariPool.Stable);
}
// Transfer RSPT and returns true
_transfer(_msgSender(), recipient, amount);
return true;
}
/*
* @notice Moves `amount` tokens from `sender` to `recipient` using the allowance mechanism. `amount` is then deducted from the caller's allowance.
* @dev Claims RGT earned by `sender` and `recipient` beforehand (so RariGovernanceTokenDistributor can continue distributing RGT considering the new RSPT balances).
* @return A boolean value indicating whether the operation succeeded.
*/
function transferFrom(address sender, address recipient, uint256 amount) public returns (bool) {
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) {
// Claim RGT/set timestamp for initial transfer of RSPT to `recipient`
rariGovernanceTokenDistributor.distributeRgt(sender, IRariGovernanceTokenDistributor.RariPool.Stable);
if (balanceOf(recipient) > 0) rariGovernanceTokenDistributor.distributeRgt(recipient, IRariGovernanceTokenDistributor.RariPool.Stable);
else rariGovernanceTokenDistributor.beforeFirstPoolTokenTransferIn(recipient, IRariGovernanceTokenDistributor.RariPool.Stable);
}
// Transfer RSPT, deduct from allowance, and return true
_transfer(sender, recipient, amount);
_approve(sender, _msgSender(), allowance(sender, _msgSender()).sub(amount, "ERC20: transfer amount exceeds allowance"));
return true;
}
/**
* @dev Creates `amount` tokens and assigns them to `account`, increasing the total supply. Caller must have the {MinterRole}.
* @dev Claims RGT earned by `account` beforehand (so RariGovernanceTokenDistributor can continue distributing RGT considering the new RSPT balance of the caller).
*/
function mint(address account, uint256 amount) public onlyMinter returns (bool) {
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) {
// Claim RGT/set timestamp for initial transfer of RSPT to `account`
if (balanceOf(account) > 0) rariGovernanceTokenDistributor.distributeRgt(account, IRariGovernanceTokenDistributor.RariPool.Stable);
else rariGovernanceTokenDistributor.beforeFirstPoolTokenTransferIn(account, IRariGovernanceTokenDistributor.RariPool.Stable);
}
// Mint RSPT and return true
_mint(account, amount);
return true;
}
/*
* @notice Destroys `amount` tokens from the caller, reducing the total supply.
* @dev Claims RGT earned by `account` beforehand (so RariGovernanceTokenDistributor can continue distributing RGT considering the new RSPT balance of the caller).
*/
function burn(uint256 amount) public {
// Claim RGT, then burn RSPT
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) rariGovernanceTokenDistributor.distributeRgt(_msgSender(), IRariGovernanceTokenDistributor.RariPool.Stable);
_burn(_msgSender(), amount);
}
/*
* @notice Destroys `amount` tokens from `account`. `amount` is then deducted from the caller's allowance.
* @dev Claims RGT earned by `account` beforehand (so RariGovernanceTokenDistributor can continue distributing RGT considering the new RSPT balance of `account`).
*/
function burnFrom(address account, uint256 amount) public {
// Claim RGT, then burn RSPT
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) rariGovernanceTokenDistributor.distributeRgt(account, IRariGovernanceTokenDistributor.RariPool.Stable);
_burnFrom(account, amount);
}
/*
* @dev Destroys `amount` tokens from `account`. Caller must have the {MinterRole}.
*/
function fundManagerBurnFrom(address account, uint256 amount) public onlyMinter {
// Claim RGT, then burn RSPT
if (address(rariGovernanceTokenDistributor) != address(0) && block.number > rariGovernanceTokenDistributor.distributionStartBlock()) rariGovernanceTokenDistributor.distributeRgt(account, IRariGovernanceTokenDistributor.RariPool.Stable);
_burn(account, amount);
}
}
// File: @chainlink/contracts/src/v0.5/interfaces/AggregatorV3Interface.sol
pragma solidity >=0.5.0;
interface AggregatorV3Interface {
function decimals() external view returns (uint8);
function description() external view returns (string memory);
function version() external view returns (uint256);
// getRoundData and latestRoundData should both raise "No data present"
// if they do not have data to report, instead of returning unset values
// which could be misinterpreted as actual reported values.
function getRoundData(uint80 _roundId)
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
function latestRoundData()
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
}
// File: contracts/external/mstable/MassetStructs.sol
pragma solidity ^0.5.7;
/**
* @title MassetStructs
* @author Stability Labs Pty. Ltd.
* @notice Structs used in the Masset contract and associated Libs
*/
interface MassetStructs {
/** @dev Stores bAsset info. The struct takes 5 storage slots per Basset */
struct Basset {
/** @dev Address of the bAsset */
address addr;
/** @dev Status of the basset, */
BassetStatus status; // takes uint8 datatype (1 byte) in storage
/** @dev An ERC20 can charge transfer fee, for example USDT, DGX tokens. */
bool isTransferFeeCharged; // takes a byte in storage
/**
* @dev 1 Basset * ratio / ratioScale == x Masset (relative value)
* If ratio == 10e8 then 1 bAsset = 10 mAssets
* A ratio is divised as 10^(18-tokenDecimals) * measurementMultiple(relative value of 1 base unit)
*/
uint256 ratio;
/** @dev Target weights of the Basset (100% == 1e18) */
uint256 maxWeight;
/** @dev Amount of the Basset that is held in Collateral */
uint256 vaultBalance;
}
/** @dev Status of the Basset - has it broken its peg? */
enum BassetStatus {
Default,
Normal,
BrokenBelowPeg,
BrokenAbovePeg,
Blacklisted,
Liquidating,
Liquidated,
Failed
}
}
// File: contracts/external/mstable/IBasketManager.sol
pragma solidity ^0.5.7;
pragma experimental ABIEncoderV2;
/**
* @title IBasketManager
* @dev (Internal) Interface for interacting with BasketManager
* VERSION: 1.0
* DATE: 2020-05-05
*/
contract IBasketManager is MassetStructs {
function getBassets() external view returns (Basset[] memory bAssets, uint256 len);
}
// File: contracts/RariFundPriceConsumer.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title RariFundPriceConsumer
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @notice RariFundPriceConsumer retrieves stablecoin prices from Chainlink's public price feeds (used by RariFundManager and RariFundController).
*/
contract RariFundPriceConsumer is Initializable, Ownable {
using SafeMath for uint256;
/**
* @dev Initializer for RariFundPriceConsumer.
*/
function initialize(bool _allCurrenciesPeggedTo1Usd) public initializer {
Ownable.initialize(msg.sender);
allCurrenciesPeggedTo1Usd = _allCurrenciesPeggedTo1Usd;
}
/**
* @dev Chainlink price feed for DAI/USD.
*/
AggregatorV3Interface private _daiUsdPriceFeed;
/**
* @dev Chainlink price feed for ETH/USD.
*/
AggregatorV3Interface private _ethUsdPriceFeed;
/**
* @dev Chainlink price feeds for ETH-based pairs.
*/
mapping(string => AggregatorV3Interface) private _ethBasedPriceFeeds;
/**
* @dev mStable mUSD basket manager contract.
*/
IBasketManager constant private _basketManager = IBasketManager(0x66126B4aA2a1C07536Ef8E5e8bD4EfDA1FdEA96D);
/**
* @dev mStable mUSD token contract.
*/
IERC20 constant private _mUsd = IERC20(0xe2f2a5C287993345a840Db3B0845fbC70f5935a5);
/**
* @dev Initializer that sets supported ERC20 contract addresses and price feeds for each supported token.
*/
function initialize() public initializer {
_daiUsdPriceFeed = AggregatorV3Interface(0xAed0c38402a5d19df6E4c03F4E2DceD6e29c1ee9);
_ethUsdPriceFeed = AggregatorV3Interface(0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419);
_ethBasedPriceFeeds["USDC"] = AggregatorV3Interface(0x986b5E1e1755e3C2440e960477f25201B0a8bbD4);
_ethBasedPriceFeeds["USDT"] = AggregatorV3Interface(0xEe9F2375b4bdF6387aa8265dD4FB8F16512A1d46);
_ethBasedPriceFeeds["TUSD"] = AggregatorV3Interface(0x3886BA987236181D98F2401c507Fb8BeA7871dF2);
_ethBasedPriceFeeds["BUSD"] = AggregatorV3Interface(0x614715d2Af89E6EC99A233818275142cE88d1Cfd);
_ethBasedPriceFeeds["sUSD"] = AggregatorV3Interface(0x8e0b7e6062272B5eF4524250bFFF8e5Bd3497757);
}
/**
* @dev Retrives the latest DAI/USD price.
*/
function getDaiUsdPrice() internal view returns (uint256) {
(, int256 price, , , ) = _daiUsdPriceFeed.latestRoundData();
return price >= 0 ? uint256(price).mul(1e10) : 0;
}
/**
* @dev Retrives the latest ETH/USD price.
*/
function getEthUsdPrice() internal view returns (uint256) {
(, int256 price, , , ) = _ethUsdPriceFeed.latestRoundData();
return price >= 0 ? uint256(price).mul(1e10) : 0;
}
/**
* @dev Retrives the latest price of an ETH-based pair.
*/
function getPriceInEth(string memory currencyCode) internal view returns (uint256) {
(, int256 price, , , ) = _ethBasedPriceFeeds[currencyCode].latestRoundData();
return price >= 0 ? uint256(price) : 0;
}
/**
* @dev Retrives the latest mUSD/USD price given the prices of the underlying bAssets.
*/
function getMUsdUsdPrice(uint256[] memory bAssetUsdPrices) internal view returns (uint256) {
(MassetStructs.Basset[] memory bAssets, ) = _basketManager.getBassets();
uint256 usdSupplyScaled = 0;
for (uint256 i = 0; i < bAssets.length; i++) usdSupplyScaled = usdSupplyScaled.add(bAssets[i].vaultBalance.mul(bAssets[i].ratio).div(1e8).mul(bAssetUsdPrices[i]));
return usdSupplyScaled.div(_mUsd.totalSupply());
}
/**
* @notice Returns the price of each supported currency in USD (scaled by 1e18).
*/
function getCurrencyPricesInUsd() external view returns (uint256[] memory) {
uint256[] memory prices = new uint256[](7);
// If all pegged to $1
if (allCurrenciesPeggedTo1Usd) {
for (uint256 i = 0; i < 7; i++) prices[i] = 1e18;
return prices;
}
// Get bAsset prices and mUSD price
uint256 ethUsdPrice = getEthUsdPrice();
prices[0] = getDaiUsdPrice();
prices[1] = getPriceInEth("USDC").mul(ethUsdPrice).div(1e18);
prices[2] = getPriceInEth("TUSD").mul(ethUsdPrice).div(1e18);
prices[3] = getPriceInEth("USDT").mul(ethUsdPrice).div(1e18);
prices[6] = getMUsdUsdPrice(prices);
// Reorder bAsset prices to match _supportedCurrencies
uint256 tusdPrice = prices[2];
prices[2] = prices[3];
prices[3] = tusdPrice;
// Get other prices
prices[4] = getPriceInEth("BUSD").mul(ethUsdPrice).div(1e18);
prices[5] = getPriceInEth("sUSD").mul(ethUsdPrice).div(1e18);
// Return prices array
return prices;
}
/**
* @notice Boolean indicating if all currencies are stablecoins pegged to the value of $1.
*/
bool public allCurrenciesPeggedTo1Usd;
/**
* @dev Admin function to peg all stablecoin prices to $1.
*/
function set1UsdPegOnAllCurrencies(bool enabled) external onlyOwner {
require(allCurrenciesPeggedTo1Usd != enabled, "$1 USD peg status already set to the requested value.");
allCurrenciesPeggedTo1Usd = enabled;
}
}
// File: contracts/RariFundManager.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title RariFundManager
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @notice This contract is the primary contract powering the Rari Stable Pool.
* Anyone can deposit to the fund with deposit(string currencyCode, uint256 amount).
* Anyone can withdraw their funds (with interest) from the fund with withdraw(string currencyCode, uint256 amount).
*/
contract RariFundManager is Initializable, Ownable {
using SafeMath for uint256;
using SignedSafeMath for int256;
using SafeERC20 for IERC20;
/**
* @dev Boolean that, if true, disables the primary functionality of this RariFundManager.
*/
bool public fundDisabled;
/**
* @dev Address of the RariFundController.
*/
address payable private _rariFundControllerContract;
/**
* @dev Contract of the RariFundController.
*/
RariFundController public rariFundController;
/**
* @dev Address of the RariFundToken.
*/
address private _rariFundTokenContract;
/**
* @dev Contract of the RariFundToken.
*/
RariFundToken public rariFundToken;
/**
* @dev Contract of the RariFundPriceConsumer.
*/
RariFundPriceConsumer public rariFundPriceConsumer;
/**
* @dev Address of the RariFundProxy.
*/
address private _rariFundProxyContract;
/**
* @dev Address of the rebalancer.
*/
address private _rariFundRebalancerAddress;
/**
* @dev Array of currencies supported by the fund.
*/
string[] private _supportedCurrencies;
/**
* @dev Maps `_supportedCurrencies` items to their indexes.
*/
mapping(string => uint8) private _currencyIndexes;
/**
* @dev Maps supported currency codes to their decimal precisions (number of digits after the decimal point).
*/
mapping(string => uint256) private _currencyDecimals;
/**
* @dev Maps supported currency codes to ERC20 token contract addresses.
*/
mapping(string => address) private _erc20Contracts;
/**
* @dev Maps currency codes to arrays of supported pools.
*/
mapping(string => RariFundController.LiquidityPool[]) private _poolsByCurrency;
/**
* @dev Initializer that sets supported ERC20 contract addresses and supported pools for each supported token.
*/
function initialize() public initializer {
// Initialize base contracts
Ownable.initialize(msg.sender);
// Add supported currencies
addSupportedCurrency("DAI", 0x6B175474E89094C44Da98b954EedeAC495271d0F, 18);
addPoolToCurrency("DAI", RariFundController.LiquidityPool.dYdX);
addPoolToCurrency("DAI", RariFundController.LiquidityPool.Compound);
addPoolToCurrency("DAI", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("USDC", 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48, 6);
addPoolToCurrency("USDC", RariFundController.LiquidityPool.dYdX);
addPoolToCurrency("USDC", RariFundController.LiquidityPool.Compound);
addPoolToCurrency("USDC", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("USDT", 0xdAC17F958D2ee523a2206206994597C13D831ec7, 6);
addPoolToCurrency("USDT", RariFundController.LiquidityPool.Compound);
addPoolToCurrency("USDT", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("TUSD", 0x0000000000085d4780B73119b644AE5ecd22b376, 18);
addPoolToCurrency("TUSD", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("BUSD", 0x4Fabb145d64652a948d72533023f6E7A623C7C53, 18);
addPoolToCurrency("BUSD", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("sUSD", 0x57Ab1ec28D129707052df4dF418D58a2D46d5f51, 18);
addPoolToCurrency("sUSD", RariFundController.LiquidityPool.Aave);
addSupportedCurrency("mUSD", 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5, 18);
addPoolToCurrency("mUSD", RariFundController.LiquidityPool.mStable);
// Initialize raw fund balance cache (can't set initial values in field declarations with proxy storage)
_rawFundBalanceCache = -1;
}
/**
* @dev Marks a token as supported by the fund and stores its decimal precision and ERC20 contract address.
* @param currencyCode The currency code of the token.
* @param erc20Contract The ERC20 contract address of the token.
* @param decimals The decimal precision (number of digits after the decimal point) of the token.
*/
function addSupportedCurrency(string memory currencyCode, address erc20Contract, uint256 decimals) internal {
_currencyIndexes[currencyCode] = uint8(_supportedCurrencies.length);
_supportedCurrencies.push(currencyCode);
_erc20Contracts[currencyCode] = erc20Contract;
_currencyDecimals[currencyCode] = decimals;
}
/**
* @dev Adds a supported pool for a token.
* @param currencyCode The currency code of the token.
* @param pool Pool ID to be supported.
*/
function addPoolToCurrency(string memory currencyCode, RariFundController.LiquidityPool pool) internal {
_poolsByCurrency[currencyCode].push(pool);
}
/**
* @dev Emitted when RariFundManager is upgraded.
*/
event FundManagerUpgraded(address newContract);
/**
* @dev Upgrades RariFundManager.
* Sends data to the new contract and sets the new RariFundToken minter.
* @param newContract The address of the new RariFundManager contract.
*/
function upgradeFundManager(address newContract) external onlyOwner {
require(fundDisabled, "This fund manager contract must be disabled before it can be upgraded.");
// Pass data to the new contract
FundManagerData memory data;
data = FundManagerData(
_netDeposits,
_rawInterestAccruedAtLastFeeRateChange,
_interestFeesGeneratedAtLastFeeRateChange,
_interestFeesClaimed
);
RariFundManager(newContract).setFundManagerData(data);
// Update RariFundToken minter
if (_rariFundTokenContract != address(0)) {
rariFundToken.addMinter(newContract);
rariFundToken.renounceMinter();
}
emit FundManagerUpgraded(newContract);
}
/**
* @dev Old RariFundManager contract authorized to migrate its data to the new one.
*/
address private _authorizedFundManagerDataSource;
/**
* @dev Upgrades RariFundManager.
* Authorizes the source for fund manager data (i.e., the old fund manager).
* @param authorizedFundManagerDataSource Authorized source for data (i.e., the old fund manager).
*/
function authorizeFundManagerDataSource(address authorizedFundManagerDataSource) external onlyOwner {
_authorizedFundManagerDataSource = authorizedFundManagerDataSource;
}
/**
* @dev Struct for data to transfer from the old RariFundManager to the new one.
*/
struct FundManagerData {
int256 netDeposits;
int256 rawInterestAccruedAtLastFeeRateChange;
int256 interestFeesGeneratedAtLastFeeRateChange;
uint256 interestFeesClaimed;
}
/**
* @dev Upgrades RariFundManager.
* Sets data receieved from the old contract.
* @param data The data from the old contract necessary to initialize the new contract.
*/
function setFundManagerData(FundManagerData calldata data) external {
require(_authorizedFundManagerDataSource != address(0) && msg.sender == _authorizedFundManagerDataSource, "Caller is not an authorized source.");
_netDeposits = data.netDeposits;
_rawInterestAccruedAtLastFeeRateChange = data.rawInterestAccruedAtLastFeeRateChange;
_interestFeesGeneratedAtLastFeeRateChange = data.interestFeesGeneratedAtLastFeeRateChange;
_interestFeesClaimed = data.interestFeesClaimed;
_interestFeeRate = RariFundManager(_authorizedFundManagerDataSource).getInterestFeeRate();
_withdrawalFeeRate = RariFundManager(_authorizedFundManagerDataSource).getWithdrawalFeeRate();
}
/**
* @dev Emitted when the RariFundController of the RariFundManager is set or upgraded.
*/
event FundControllerSet(address newContract);
/**
* @dev Sets or upgrades the RariFundController of the RariFundManager.
* @param newContract The address of the new RariFundController contract.
*/
function setFundController(address payable newContract) external onlyOwner {
_rariFundControllerContract = newContract;
rariFundController = RariFundController(_rariFundControllerContract);
emit FundControllerSet(newContract);
}
/**
* @dev Forwards tokens lost in the fund manager (in case of accidental transfer of funds to this contract).
* @param erc20Contract The ERC20 contract address of the token to forward.
* @param to The destination address to which the funds will be forwarded.
* @return Boolean indicating success.
*/
function forwardLostFunds(address erc20Contract, address to) external onlyOwner returns (bool) {
IERC20 token = IERC20(erc20Contract);
uint256 balance = token.balanceOf(address(this));
if (balance <= 0) return false;
token.safeTransfer(to, balance);
return true;
}
/**
* @dev Emitted when the RariFundToken of the RariFundManager is set.
*/
event FundTokenSet(address newContract);
/**
* @dev Sets or upgrades the RariFundToken of the RariFundManager.
* @param newContract The address of the new RariFundToken contract.
*/
function setFundToken(address newContract) external onlyOwner {
_rariFundTokenContract = newContract;
rariFundToken = RariFundToken(_rariFundTokenContract);
emit FundTokenSet(newContract);
}
/**
* @dev Emitted when the RariFundProxy of the RariFundManager is set.
*/
event FundProxySet(address newContract);
/**
* @dev Sets or upgrades the RariFundProxy of the RariFundManager.
* @param newContract The address of the new RariFundProxy contract.
*/
function setFundProxy(address newContract) external onlyOwner {
_rariFundProxyContract = newContract;
emit FundProxySet(newContract);
}
/**
* @dev Throws if called by any account other than the RariFundProxy.
*/
modifier onlyProxy() {
require(_rariFundProxyContract == msg.sender, "Caller is not the RariFundProxy.");
_;
}
/**
* @dev Emitted when the rebalancer of the RariFundManager is set.
*/
event FundRebalancerSet(address newAddress);
/**
* @dev Sets or upgrades the rebalancer of the RariFundManager.
* @param newAddress The Ethereum address of the new rebalancer server.
*/
function setFundRebalancer(address newAddress) external onlyOwner {
_rariFundRebalancerAddress = newAddress;
emit FundRebalancerSet(newAddress);
}
/**
* @dev Throws if called by any account other than the rebalancer.
*/
modifier onlyRebalancer() {
require(_rariFundRebalancerAddress == msg.sender, "Caller is not the rebalancer.");
_;
}
/**
* @dev Emitted when the RariFundPriceConsumer of the RariFundManager is set.
*/
event FundPriceConsumerSet(address newContract);
/**
* @dev Sets or upgrades the RariFundPriceConsumer of the RariFundManager.
* @param newContract The address of the new RariFundPriceConsumer contract.
*/
function setFundPriceConsumer(address newContract) external onlyOwner {
rariFundPriceConsumer = RariFundPriceConsumer(newContract);
emit FundPriceConsumerSet(newContract);
}
/**
* @dev Emitted when the primary functionality of this RariFundManager contract has been disabled.
*/
event FundDisabled();
/**
* @dev Emitted when the primary functionality of this RariFundManager contract has been enabled.
*/
event FundEnabled();
/**
* @dev Disables/enables primary functionality of this RariFundManager so contract(s) can be upgraded.
*/
function setFundDisabled(bool disabled) external onlyOwner {
require(disabled != fundDisabled, "No change to fund enabled/disabled status.");
fundDisabled = disabled;
if (disabled) emit FundDisabled(); else emit FundEnabled();
}
/**
* @dev Throws if fund is disabled.
*/
modifier fundEnabled() {
require(!fundDisabled, "This fund manager contract is disabled. This may be due to an upgrade.");
_;
}
/**
* @dev Boolean indicating if return values of `getPoolBalance` are to be cached.
*/
bool _cachePoolBalances;
/**
* @dev Boolean indicating if dYdX balances returned by `getPoolBalance` are to be cached.
*/
bool _cacheDydxBalances;
/**
* @dev Maps to currency codes to cached pool balances to pool indexes.
*/
mapping(string => mapping(uint8 => uint256)) _poolBalanceCache;
/**
* @dev Cached array of dYdX token addresses.
*/
address[] private _dydxTokenAddressesCache;
/**
* @dev Cached array of dYdX balances.
*/
uint256[] private _dydxBalancesCache;
/**
* @dev Returns the fund controller's balance of the specified currency in the specified pool.
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `CompoundPoolController.getBalance`) potentially modifies the state.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token.
*/
function getPoolBalance(RariFundController.LiquidityPool pool, string memory currencyCode) internal returns (uint256) {
if (!rariFundController.hasCurrencyInPool(pool, currencyCode)) return 0;
if (_cachePoolBalances || _cacheDydxBalances) {
if (pool == RariFundController.LiquidityPool.dYdX) {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (_dydxBalancesCache.length == 0) (_dydxTokenAddressesCache, _dydxBalancesCache) = rariFundController.getDydxBalances();
for (uint256 i = 0; i < _dydxBalancesCache.length; i++) if (_dydxTokenAddressesCache[i] == erc20Contract) return _dydxBalancesCache[i];
revert("Failed to get dYdX balance of this currency code.");
} else if (_cachePoolBalances) {
uint8 poolAsUint8 = uint8(pool);
if (_poolBalanceCache[currencyCode][poolAsUint8] == 0) _poolBalanceCache[currencyCode][poolAsUint8] = rariFundController._getPoolBalance(pool, currencyCode);
return _poolBalanceCache[currencyCode][poolAsUint8];
}
}
return rariFundController._getPoolBalance(pool, currencyCode);
}
/**
* @dev Caches dYdX pool balances returned by `getPoolBalance` for the duration of the function.
*/
modifier cacheDydxBalances() {
bool cacheSetPreviously = _cacheDydxBalances;
_cacheDydxBalances = true;
_;
if (!cacheSetPreviously) {
_cacheDydxBalances = false;
if (!_cachePoolBalances) _dydxBalancesCache.length = 0;
}
}
/**
* @dev Caches return values of `getPoolBalance` for the duration of the function.
*/
modifier cachePoolBalances() {
bool cacheSetPreviously = _cachePoolBalances;
_cachePoolBalances = true;
_;
if (!cacheSetPreviously) {
_cachePoolBalances = false;
if (!_cacheDydxBalances) _dydxBalancesCache.length = 0;
for (uint256 i = 0; i < _supportedCurrencies.length; i++) {
string memory currencyCode = _supportedCurrencies[i];
for (uint256 j = 0; j < _poolsByCurrency[currencyCode].length; j++) _poolBalanceCache[currencyCode][uint8(_poolsByCurrency[currencyCode][j])] = 0;
}
}
}
/**
* @notice Returns the fund's raw total balance (all RFT holders' funds + all unclaimed fees) of the specified currency.
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `RariFundController.getPoolBalance`) potentially modifies the state.
* @param currencyCode The currency code of the balance to be calculated.
*/
function getRawFundBalance(string memory currencyCode) public returns (uint256) {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
IERC20 token = IERC20(erc20Contract);
uint256 totalBalance = token.balanceOf(_rariFundControllerContract);
for (uint256 i = 0; i < _poolsByCurrency[currencyCode].length; i++)
totalBalance = totalBalance.add(getPoolBalance(_poolsByCurrency[currencyCode][i], currencyCode));
return totalBalance;
}
/**
* @dev Caches the fund's raw total balance (all RFT holders' funds + all unclaimed fees) of all currencies in USD (scaled by 1e18).
*/
int256 private _rawFundBalanceCache;
/**
* @notice Returns the fund's raw total balance (all RFT holders' funds + all unclaimed fees) of all currencies in USD (scaled by 1e18).
* Returns `_rawFundBalanceCache` if set to save gas.
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getRawFundBalance() public returns (uint256) {
if (_rawFundBalanceCache >= 0) return uint256(_rawFundBalanceCache);
uint256[] memory pricesInUsd = rariFundPriceConsumer.getCurrencyPricesInUsd();
return getRawFundBalance(pricesInUsd);
}
/**
* @dev Returns the fund's raw total balance (all RFT holders' funds + all unclaimed fees) of all currencies in USD (scaled by 1e18).
* Accepts prices in USD as a parameter to avoid calculating them every time.
* Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getRawFundBalance(uint256[] memory pricesInUsd) public cacheDydxBalances returns (uint256) {
uint256 totalBalance = 0;
for (uint256 i = 0; i < _supportedCurrencies.length; i++) {
string memory currencyCode = _supportedCurrencies[i];
uint256 balance = getRawFundBalance(currencyCode);
uint256 balanceUsd = balance.mul(pricesInUsd[i]).div(10 ** _currencyDecimals[currencyCode]);
totalBalance = totalBalance.add(balanceUsd);
}
return totalBalance;
}
/**
* @dev Caches the value of `getRawFundBalance()` for the duration of the function.
*/
modifier cacheRawFundBalance() {
bool cacheSetPreviously = _rawFundBalanceCache >= 0;
if (!cacheSetPreviously) _rawFundBalanceCache = toInt256(getRawFundBalance());
_;
if (!cacheSetPreviously) _rawFundBalanceCache = -1;
}
/**
* @notice Returns the fund's total investor balance (all RFT holders' funds but not unclaimed fees) of all currencies in USD (scaled by 1e18).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getFundBalance() public cacheRawFundBalance returns (uint256) {
return getRawFundBalance().sub(getInterestFeesUnclaimed());
}
/**
* @notice Returns the total balance in USD (scaled by 1e18) of `account`.
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
* @param account The account whose balance we are calculating.
*/
function balanceOf(address account) external returns (uint256) {
uint256 rftTotalSupply = rariFundToken.totalSupply();
if (rftTotalSupply == 0) return 0;
uint256 rftBalance = rariFundToken.balanceOf(account);
uint256 fundBalanceUsd = getFundBalance();
uint256 accountBalanceUsd = rftBalance.mul(fundBalanceUsd).div(rftTotalSupply);
return accountBalanceUsd;
}
/**
* @dev UNUSED AFTER UPGRADE: Fund balance limit in USD per Ethereum address.
*/
uint256 private _accountBalanceLimitDefault;
/**
* @dev UNUSED AFTER UPGRADE: Maps user accounts to individual account balance limits (where 0 indicates the default while any negative value indicates 0).
*/
mapping(address => int256) private _accountBalanceLimits;
/**
* @dev Maps currency codes to booleans indicating if they are accepted for deposits.
*/
mapping(string => bool) private _acceptedCurrencies;
/**
* @notice Returns a boolean indicating if deposits in `currencyCode` are currently accepted.
* @param currencyCode The currency code to check.
*/
function isCurrencyAccepted(string memory currencyCode) public view returns (bool) {
return _acceptedCurrencies[currencyCode];
}
/**
* @dev UNUSED AFTER UPGRADE: Array of accepted currencies (only used by `getAcceptedCurrencies`).
*/
string[] private _acceptedCurrenciesArray;
/**
* @notice Returns an array of currency codes currently accepted for deposits.
*/
function getAcceptedCurrencies() external view returns (string[] memory) {
uint256 arrayLength = 0;
for (uint256 i = 0; i < _supportedCurrencies.length; i++) if (_acceptedCurrencies[_supportedCurrencies[i]]) arrayLength++;
string[] memory acceptedCurrencies = new string[](arrayLength);
uint256 index = 0;
for (uint256 i = 0; i < _supportedCurrencies.length; i++) if (_acceptedCurrencies[_supportedCurrencies[i]]) {
acceptedCurrencies[index] = _supportedCurrencies[i];
index++;
}
return acceptedCurrencies;
}
/**
* @dev Marks `currencyCodes` as accepted or not accepted.
* @param currencyCodes The currency codes to mark as accepted or not accepted.
* @param accepted An array of booleans indicating if each of `currencyCodes` is to be accepted.
*/
function setAcceptedCurrencies(string[] calldata currencyCodes, bool[] calldata accepted) external onlyRebalancer {
require (currencyCodes.length > 0 && currencyCodes.length == accepted.length, "Lengths of arrays must be equal and both greater than 0.");
for (uint256 i = 0; i < currencyCodes.length; i++) _acceptedCurrencies[currencyCodes[i]] = accepted[i];
}
/**
* @dev Emitted when funds have been deposited to RariFund.
*/
event Deposit(string indexed currencyCode, address indexed sender, address indexed payee, uint256 amount, uint256 amountUsd, uint256 rftMinted);
/**
* @dev Emitted when funds have been withdrawn from RariFund.
*/
event Withdrawal(string indexed currencyCode, address indexed sender, address indexed payee, uint256 amount, uint256 amountUsd, uint256 rftBurned, uint256 withdrawalFeeRate);
/**
* @notice Deposits funds from `msg.sender` to the Rari Stable Pool in exchange for RFT minted to `to`.
* You may only deposit currencies accepted by the fund (see `isCurrencyAccepted(string currencyCode)`).
* Please note that you must approve RariFundManager to transfer at least `amount`.
* @param to The address that will receieve the minted RFT.
* @param currencyCode The currency code of the token to be deposited.
* @param amount The amount of tokens to be deposited.
*/
function depositTo(address to, string memory currencyCode, uint256 amount) public fundEnabled {
// Input validation
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
require(isCurrencyAccepted(currencyCode), "This currency is not currently accepted; please convert your funds to an accepted currency before depositing.");
require(amount > 0, "Deposit amount must be greater than 0.");
// Get currency prices
uint256[] memory pricesInUsd = rariFundPriceConsumer.getCurrencyPricesInUsd();
// Manually cache raw fund balance
bool cacheSetPreviously = _rawFundBalanceCache >= 0;
if (!cacheSetPreviously) _rawFundBalanceCache = toInt256(getRawFundBalance(pricesInUsd));
// Get deposit amount in USD
uint256 amountUsd = amount.mul(pricesInUsd[_currencyIndexes[currencyCode]]).div(10 ** _currencyDecimals[currencyCode]);
// Calculate RFT to mint
uint256 rftTotalSupply = rariFundToken.totalSupply();
uint256 fundBalanceUsd = rftTotalSupply > 0 ? getFundBalance() : 0; // Only set if used
uint256 rftAmount = 0;
if (rftTotalSupply > 0 && fundBalanceUsd > 0) rftAmount = amountUsd.mul(rftTotalSupply).div(fundBalanceUsd);
else rftAmount = amountUsd;
require(rftAmount > 0, "Deposit amount is so small that no RFT would be minted.");
// Update net deposits, transfer funds from msg.sender, mint RFT, and emit event
_netDeposits = _netDeposits.add(int256(amountUsd));
IERC20(erc20Contract).safeTransferFrom(msg.sender, _rariFundControllerContract, amount); // The user must approve the transfer of tokens beforehand
require(rariFundToken.mint(to, rftAmount), "Failed to mint output tokens.");
emit Deposit(currencyCode, msg.sender, to, amount, amountUsd, rftAmount);
// Update _rawFundBalanceCache
_rawFundBalanceCache = _rawFundBalanceCache.add(int256(amountUsd));
// Update RGT distribution speeds
IRariGovernanceTokenDistributor rariGovernanceTokenDistributor = rariFundToken.rariGovernanceTokenDistributor();
if (address(rariGovernanceTokenDistributor) != address(0) && block.number < rariGovernanceTokenDistributor.distributionEndBlock()) rariGovernanceTokenDistributor.refreshDistributionSpeeds(IRariGovernanceTokenDistributor.RariPool.Stable, getFundBalance());
// Clear _rawFundBalanceCache
if (!cacheSetPreviously) _rawFundBalanceCache = -1;
}
/**
* @notice Deposits funds to the Rari Stable Pool in exchange for RFT.
* You may only deposit currencies accepted by the fund (see `isCurrencyAccepted(string currencyCode)`).
* Please note that you must approve RariFundManager to transfer at least `amount`.
* @param currencyCode The currency code of the token to be deposited.
* @param amount The amount of tokens to be deposited.
*/
function deposit(string calldata currencyCode, uint256 amount) external {
depositTo(msg.sender, currencyCode, amount);
}
/**
* @dev Returns the amount of RFT to burn for a withdrawal (used by `_withdrawFrom`).
* @param from The address from which RFT will be burned.
* @param amountUsd The amount of the withdrawal in USD
*/
function getRftBurnAmount(address from, uint256 amountUsd) internal returns (uint256) {
uint256 rftTotalSupply = rariFundToken.totalSupply();
uint256 fundBalanceUsd = getFundBalance();
require(fundBalanceUsd > 0, "Fund balance is zero.");
uint256 rftAmount = amountUsd.mul(rftTotalSupply).div(fundBalanceUsd);
require(rftAmount <= rariFundToken.balanceOf(from), "Your RFT balance is too low for a withdrawal of this amount.");
require(rftAmount > 0, "Withdrawal amount is so small that no RFT would be burned.");
return rftAmount;
}
/**
* @dev Internal function to withdraw funds from pools if necessary for `RariFundController` to hold at least `amount` of actual tokens.
* This function was separated from `_withdrawFrom` to avoid the stack going too deep.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The minimum amount of tokens that must be held by `RariFundController` after withdrawing.
*/
function withdrawFromPoolsIfNecessary(string memory currencyCode, uint256 amount) internal {
// Check contract balance of token and withdraw from pools if necessary
address erc20Contract = _erc20Contracts[currencyCode];
uint256 contractBalance = IERC20(erc20Contract).balanceOf(_rariFundControllerContract);
for (uint256 i = 0; i < _poolsByCurrency[currencyCode].length; i++) {
if (contractBalance >= amount) break;
RariFundController.LiquidityPool pool = _poolsByCurrency[currencyCode][i];
uint256 poolBalance = getPoolBalance(pool, currencyCode);
if (poolBalance <= 0) continue;
uint256 amountLeft = amount.sub(contractBalance);
bool withdrawAll = amountLeft >= poolBalance;
uint256 poolAmount = withdrawAll ? poolBalance : amountLeft;
rariFundController.withdrawFromPoolOptimized(pool, currencyCode, poolAmount, withdrawAll);
if (pool == RariFundController.LiquidityPool.dYdX) {
for (uint256 j = 0; j < _dydxBalancesCache.length; j++) if (_dydxTokenAddressesCache[j] == erc20Contract) _dydxBalancesCache[j] = poolBalance.sub(poolAmount);
} else _poolBalanceCache[currencyCode][uint8(pool)] = poolBalance.sub(poolAmount);
contractBalance = contractBalance.add(poolAmount);
}
require(amount <= contractBalance, "Available balance not enough to cover amount even after withdrawing from pools.");
}
/**
* @dev Internal function to withdraw funds from the Rari Stable Pool to `msg.sender` in exchange for RFT burned from `from`.
* You may only withdraw currencies held by the fund (see `getRawFundBalance(string currencyCode)`).
* Please note that you must approve RariFundManager to burn of the necessary amount of RFT.
* @param from The address from which RFT will be burned.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
* @return The amount withdrawn after the fee.
*/
function _withdrawFrom(address from, string memory currencyCode, uint256 amount, uint256[] memory pricesInUsd) internal fundEnabled cachePoolBalances returns (uint256) {
// Input validation
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
require(amount > 0, "Withdrawal amount must be greater than 0.");
// Withdraw from pools if necessary
withdrawFromPoolsIfNecessary(currencyCode, amount);
// Manually cache raw fund balance
bool cacheSetPreviously = _rawFundBalanceCache >= 0;
if (!cacheSetPreviously) _rawFundBalanceCache = toInt256(getRawFundBalance(pricesInUsd));
// Calculate withdrawal fee and amount after fee
uint256 feeAmount = amount.mul(_withdrawalFeeRate).div(1e18);
uint256 amountAfterFee = amount.sub(feeAmount);
// Get withdrawal amount in USD
uint256 amountUsd = amount.mul(pricesInUsd[_currencyIndexes[currencyCode]]).div(10 ** _currencyDecimals[currencyCode]);
// Calculate RFT to burn
uint256 rftAmount = getRftBurnAmount(from, amountUsd);
// Update net deposits, burn RFT, transfer funds to msg.sender, transfer fee to _withdrawalFeeMasterBeneficiary, and emit event
_netDeposits = _netDeposits.sub(int256(amountUsd));
rariFundToken.fundManagerBurnFrom(from, rftAmount); // The user must approve the burning of tokens beforehand
IERC20 token = IERC20(erc20Contract);
token.safeTransferFrom(_rariFundControllerContract, msg.sender, amountAfterFee);
token.safeTransferFrom(_rariFundControllerContract, _withdrawalFeeMasterBeneficiary, feeAmount);
emit Withdrawal(currencyCode, from, msg.sender, amount, amountUsd, rftAmount, _withdrawalFeeRate);
// Update _rawFundBalanceCache
_rawFundBalanceCache = _rawFundBalanceCache.sub(int256(amountUsd));
// Update RGT distribution speeds
IRariGovernanceTokenDistributor rariGovernanceTokenDistributor = rariFundToken.rariGovernanceTokenDistributor();
if (address(rariGovernanceTokenDistributor) != address(0) && block.number < rariGovernanceTokenDistributor.distributionEndBlock()) rariGovernanceTokenDistributor.refreshDistributionSpeeds(IRariGovernanceTokenDistributor.RariPool.Stable, getFundBalance());
// Clear _rawFundBalanceCache
if (!cacheSetPreviously) _rawFundBalanceCache = -1;
// Return amount after fee
return amountAfterFee;
}
/**
* @notice Withdraws funds from the Rari Stable Pool in exchange for RFT.
* You may only withdraw currencies held by the fund (see `getRawFundBalance(string currencyCode)`).
* Please note that you must approve RariFundManager to burn of the necessary amount of RFT.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
* @return The amount withdrawn after the fee.
*/
function withdraw(string calldata currencyCode, uint256 amount) external returns (uint256) {
return _withdrawFrom(msg.sender, currencyCode, amount, rariFundPriceConsumer.getCurrencyPricesInUsd());
}
/**
* @dev Withdraws multiple currencies from the Rari Stable Pool to `msg.sender` (RariFundProxy) in exchange for RFT burned from `from`.
* You may only withdraw currencies held by the fund (see `getRawFundBalance(string currencyCode)`).
* Please note that you must approve RariFundManager to burn of the necessary amount of RFT.
* @param from The address from which RFT will be burned.
* @param currencyCodes The currency codes of the tokens to be withdrawn.
* @param amounts The amounts of the tokens to be withdrawn.
* @return Array of amounts withdrawn after fees.
*/
function withdrawFrom(address from, string[] calldata currencyCodes, uint256[] calldata amounts) external onlyProxy cachePoolBalances returns (uint256[] memory) {
// Input validation
require(currencyCodes.length > 0 && currencyCodes.length == amounts.length, "Lengths of currency code and amount arrays must be greater than 0 and equal.");
uint256[] memory pricesInUsd = rariFundPriceConsumer.getCurrencyPricesInUsd();
// Manually cache raw fund balance (no need to check if set previously because the function is external)
_rawFundBalanceCache = toInt256(getRawFundBalance(pricesInUsd));
// Make withdrawals
uint256[] memory amountsAfterFees = new uint256[](currencyCodes.length);
for (uint256 i = 0; i < currencyCodes.length; i++) amountsAfterFees[i] = _withdrawFrom(from, currencyCodes[i], amounts[i], pricesInUsd);
// Reset _rawFundBalanceCache
_rawFundBalanceCache = -1;
// Return amounts withdrawn after fees
return amountsAfterFees;
}
/**
* @dev Net quantity of deposits to the fund (i.e., deposits - withdrawals).
* On deposit, amount deposited is added to `_netDeposits`; on withdrawal, amount withdrawn is subtracted from `_netDeposits`.
*/
int256 private _netDeposits;
/**
* @notice Returns the raw total amount of interest accrued by the fund as a whole (including the fees paid on interest) in USD (scaled by 1e18).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getRawInterestAccrued() public returns (int256) {
return toInt256(getRawFundBalance()).sub(_netDeposits).add(toInt256(_interestFeesClaimed));
}
/**
* @notice Returns the total amount of interest accrued by past and current RFT holders (excluding the fees paid on interest) in USD (scaled by 1e18).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getInterestAccrued() public returns (int256) {
return toInt256(getFundBalance()).sub(_netDeposits);
}
/**
* @dev The proportion of interest accrued that is taken as a service fee (scaled by 1e18).
*/
uint256 private _interestFeeRate;
/**
* @dev Returns the fee rate on interest (proportion of raw interest accrued scaled by 1e18).
*/
function getInterestFeeRate() public view returns (uint256) {
return _interestFeeRate;
}
/**
* @dev Sets the fee rate on interest.
* @param rate The proportion of interest accrued to be taken as a service fee (scaled by 1e18).
*/
function setInterestFeeRate(uint256 rate) external fundEnabled onlyOwner cacheRawFundBalance {
require(rate != _interestFeeRate, "This is already the current interest fee rate.");
require(rate <= 1e18, "The interest fee rate cannot be greater than 100%.");
_depositFees();
_interestFeesGeneratedAtLastFeeRateChange = getInterestFeesGenerated(); // MUST update this first before updating _rawInterestAccruedAtLastFeeRateChange since it depends on it
_rawInterestAccruedAtLastFeeRateChange = getRawInterestAccrued();
_interestFeeRate = rate;
}
/**
* @dev The amount of interest accrued at the time of the most recent change to the fee rate.
*/
int256 private _rawInterestAccruedAtLastFeeRateChange;
/**
* @dev The amount of fees generated on interest at the time of the most recent change to the fee rate.
*/
int256 private _interestFeesGeneratedAtLastFeeRateChange;
/**
* @notice Returns the amount of interest fees accrued by beneficiaries in USD (scaled by 1e18).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getInterestFeesGenerated() public returns (int256) {
int256 rawInterestAccruedSinceLastFeeRateChange = getRawInterestAccrued().sub(_rawInterestAccruedAtLastFeeRateChange);
int256 interestFeesGeneratedSinceLastFeeRateChange = rawInterestAccruedSinceLastFeeRateChange.mul(int256(_interestFeeRate)).div(1e18);
int256 interestFeesGenerated = _interestFeesGeneratedAtLastFeeRateChange.add(interestFeesGeneratedSinceLastFeeRateChange);
return interestFeesGenerated;
}
/**
* @dev The total claimed amount of interest fees.
*/
uint256 private _interestFeesClaimed;
/**
* @dev Returns the total unclaimed amount of interest fees.
* Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `getRawFundBalance`) potentially modifies the state.
*/
function getInterestFeesUnclaimed() public returns (uint256) {
int256 interestFeesUnclaimed = getInterestFeesGenerated().sub(toInt256(_interestFeesClaimed));
return interestFeesUnclaimed > 0 ? uint256(interestFeesUnclaimed) : 0;
}
/**
* @dev The master beneficiary of fees on interest; i.e., the recipient of all fees on interest.
*/
address private _interestFeeMasterBeneficiary;
/**
* @dev Sets the master beneficiary of interest fees.
* @param beneficiary The master beneficiary of fees on interest; i.e., the recipient of all fees on interest.
*/
function setInterestFeeMasterBeneficiary(address beneficiary) external fundEnabled onlyOwner {
require(beneficiary != address(0), "Master beneficiary cannot be the zero address.");
_interestFeeMasterBeneficiary = beneficiary;
}
/**
* @dev Emitted when fees on interest are deposited back into the fund.
*/
event InterestFeeDeposit(address beneficiary, uint256 amountUsd);
/**
* @dev Internal function to deposit all accrued fees on interest back into the fund on behalf of the master beneficiary.
* @return Integer indicating success (0), no fees to claim (1), or no RFT to mint (2).
*/
function _depositFees() internal fundEnabled cacheRawFundBalance returns (uint8) {
// Input validation
require(_interestFeeMasterBeneficiary != address(0), "Master beneficiary cannot be the zero address.");
// Get and validate unclaimed interest fees
uint256 amountUsd = getInterestFeesUnclaimed();
if (amountUsd <= 0) return 1;
// Calculate RFT amount to mint and validate
uint256 rftTotalSupply = rariFundToken.totalSupply();
uint256 rftAmount = 0;
if (rftTotalSupply > 0) {
uint256 fundBalanceUsd = getFundBalance();
if (fundBalanceUsd > 0) rftAmount = amountUsd.mul(rftTotalSupply).div(fundBalanceUsd);
else rftAmount = amountUsd;
} else rftAmount = amountUsd;
if (rftAmount <= 0) return 2;
// Update claimed interest fees and net deposits, mint RFT, emit events, and return no error
_interestFeesClaimed = _interestFeesClaimed.add(amountUsd);
_netDeposits = _netDeposits.add(int256(amountUsd));
require(rariFundToken.mint(_interestFeeMasterBeneficiary, rftAmount), "Failed to mint output tokens.");
emit Deposit("USD", _interestFeeMasterBeneficiary, _interestFeeMasterBeneficiary, amountUsd, amountUsd, rftAmount);
emit InterestFeeDeposit(_interestFeeMasterBeneficiary, amountUsd);
// Update RGT distribution speeds
IRariGovernanceTokenDistributor rariGovernanceTokenDistributor = rariFundToken.rariGovernanceTokenDistributor();
if (address(rariGovernanceTokenDistributor) != address(0) && block.number < rariGovernanceTokenDistributor.distributionEndBlock()) rariGovernanceTokenDistributor.refreshDistributionSpeeds(IRariGovernanceTokenDistributor.RariPool.Stable, getFundBalance());
// Return no error
return 0;
}
/**
* @notice Deposits all accrued fees on interest back into the fund on behalf of the master beneficiary.
* @return Boolean indicating success.
*/
function depositFees() external onlyRebalancer {
uint8 result = _depositFees();
require(result == 0, result == 2 ? "Deposit amount is so small that no RFT would be minted." : "No new fees are available to claim.");
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
* @param value The uint256 to convert.
*/
function toInt256(uint256 value) internal pure returns (int256) {
require(value < 2 ** 255, "SafeCast: value doesn't fit in an int256");
return int256(value);
}
/**
* @dev The current withdrawal fee rate (scaled by 1e18).
*/
uint256 private _withdrawalFeeRate;
/**
* @dev The master beneficiary of withdrawal fees; i.e., the recipient of all withdrawal fees.
*/
address private _withdrawalFeeMasterBeneficiary;
/**
* @dev Returns the withdrawal fee rate (proportion of every withdrawal taken as a service fee scaled by 1e18).
*/
function getWithdrawalFeeRate() public view returns (uint256) {
return _withdrawalFeeRate;
}
/**
* @dev Sets the withdrawal fee rate.
* @param rate The proportion of every withdrawal taken as a service fee (scaled by 1e18).
*/
function setWithdrawalFeeRate(uint256 rate) external fundEnabled onlyOwner {
require(rate != _withdrawalFeeRate, "This is already the current withdrawal fee rate.");
require(rate <= 1e18, "The withdrawal fee rate cannot be greater than 100%.");
_withdrawalFeeRate = rate;
}
/**
* @dev Sets the master beneficiary of withdrawal fees.
* @param beneficiary The master beneficiary of withdrawal fees; i.e., the recipient of all withdrawal fees.
*/
function setWithdrawalFeeMasterBeneficiary(address beneficiary) external fundEnabled onlyOwner {
require(beneficiary != address(0), "Master beneficiary cannot be the zero address.");
_withdrawalFeeMasterBeneficiary = beneficiary;
}
}
// File: contracts/external/dydx/lib/Account.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title Account
* @author dYdX
*
* Library of structs and functions that represent an account
*/
library Account {
// Represents the unique key that specifies an account
struct Info {
address owner; // The address that owns the account
uint256 number; // A nonce that allows a single address to control many accounts
}
}
// File: contracts/external/dydx/lib/Types.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title Types
* @author dYdX
*
* Library for interacting with the basic structs used in Solo
*/
library Types {
// ============ AssetAmount ============
enum AssetDenomination {
Wei, // the amount is denominated in wei
Par // the amount is denominated in par
}
enum AssetReference {
Delta, // the amount is given as a delta from the current value
Target // the amount is given as an exact number to end up at
}
struct AssetAmount {
bool sign; // true if positive
AssetDenomination denomination;
AssetReference ref;
uint256 value;
}
// ============ Par (Principal Amount) ============
// Individual principal amount for an account
struct Par {
bool sign; // true if positive
uint128 value;
}
// ============ Wei (Token Amount) ============
// Individual token amount for an account
struct Wei {
bool sign; // true if positive
uint256 value;
}
}
// File: contracts/external/dydx/Getters.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title Getters
* @author dYdX
*
* Public read-only functions that allow transparency into the state of Solo
*/
contract Getters {
using Types for Types.Par;
/**
* Get an account's summary for each market.
*
* @param account The account to query
* @return The following values:
* - The ERC20 token address for each market
* - The account's principal value for each market
* - The account's (supplied or borrowed) number of tokens for each market
*/
function getAccountBalances(
Account.Info memory account
)
public
view
returns (
address[] memory,
Types.Par[] memory,
Types.Wei[] memory
);
}
// File: contracts/external/dydx/lib/Actions.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title Actions
* @author dYdX
*
* Library that defines and parses valid Actions
*/
library Actions {
// ============ Enums ============
enum ActionType {
Deposit, // supply tokens
Withdraw, // borrow tokens
Transfer, // transfer balance between accounts
Buy, // buy an amount of some token (externally)
Sell, // sell an amount of some token (externally)
Trade, // trade tokens against another account
Liquidate, // liquidate an undercollateralized or expiring account
Vaporize, // use excess tokens to zero-out a completely negative account
Call // send arbitrary data to an address
}
// ============ Structs ============
/*
* Arguments that are passed to Solo in an ordered list as part of a single operation.
* Each ActionArgs has an actionType which specifies which action struct that this data will be
* parsed into before being processed.
*/
struct ActionArgs {
ActionType actionType;
uint256 accountId;
Types.AssetAmount amount;
uint256 primaryMarketId;
uint256 secondaryMarketId;
address otherAddress;
uint256 otherAccountId;
bytes data;
}
}
// File: contracts/external/dydx/Operation.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title Operation
* @author dYdX
*
* Primary public function for allowing users and contracts to manage accounts within Solo
*/
contract Operation {
/**
* The main entry-point to Solo that allows users and contracts to manage accounts.
* Take one or more actions on one or more accounts. The msg.sender must be the owner or
* operator of all accounts except for those being liquidated, vaporized, or traded with.
* One call to operate() is considered a singular "operation". Account collateralization is
* ensured only after the completion of the entire operation.
*
* @param accounts A list of all accounts that will be used in this operation. Cannot contain
* duplicates. In each action, the relevant account will be referred-to by its
* index in the list.
* @param actions An ordered list of all actions that will be taken in this operation. The
* actions will be processed in order.
*/
function operate(
Account.Info[] memory accounts,
Actions.ActionArgs[] memory actions
)
public;
}
// File: contracts/external/dydx/SoloMargin.sol
/*
Copyright 2019 dYdX Trading Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity 0.5.17;
/**
* @title SoloMargin
* @author dYdX
*
* Main contract that inherits from other contracts
*/
contract SoloMargin is
Getters,
Operation
{ }
// File: contracts/lib/pools/DydxPoolController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title DydxPoolController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles deposits to and withdrawals from dYdX liquidity pools.
*/
library DydxPoolController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
/**
* @dev dYdX SoloMargin contract address.
*/
address constant private SOLO_MARGIN_CONTRACT = 0x1E0447b19BB6EcFdAe1e4AE1694b0C3659614e4e;
/**
* @dev dYdX SoloMargin contract object.
*/
SoloMargin constant private _soloMargin = SoloMargin(SOLO_MARGIN_CONTRACT);
/**
* @dev Returns a token's dYdX market ID given its ERC20 contract address.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getMarketId(address erc20Contract) private pure returns (uint256) {
if (erc20Contract == 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48) return 2; // USDC
if (erc20Contract == 0x6B175474E89094C44Da98b954EedeAC495271d0F) return 3; // DAI
else revert("Supported dYdX market not found for this token address.");
}
/**
* @dev Returns the fund's balances of all currencies supported by dYdX.
* @return An array of ERC20 token contract addresses and a corresponding array of balances.
*/
function getBalances() external view returns (address[] memory, uint256[] memory) {
Account.Info memory account = Account.Info(address(this), 0);
(address[] memory tokens, , Types.Wei[] memory weis) = _soloMargin.getAccountBalances(account);
uint256[] memory balances = new uint256[](weis.length);
for (uint256 i = 0; i < weis.length; i++) balances[i] = weis[i].sign ? weis[i].value : 0;
return (tokens, balances);
}
/**
* @dev Returns the fund's balance of the specified currency in the dYdX pool.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getBalance(address erc20Contract) external view returns (uint256) {
uint256 marketId = getMarketId(erc20Contract);
Account.Info memory account = Account.Info(address(this), 0);
(, , Types.Wei[] memory weis) = _soloMargin.getAccountBalances(account);
return weis[marketId].sign ? weis[marketId].value : 0;
}
/**
* @dev Approves tokens to dYdX without spending gas on every deposit.
* @param erc20Contract The ERC20 contract address of the token.
* @param amount Amount of the specified token to approve to dYdX.
*/
function approve(address erc20Contract, uint256 amount) external {
IERC20 token = IERC20(erc20Contract);
uint256 allowance = token.allowance(address(this), SOLO_MARGIN_CONTRACT);
if (allowance == amount) return;
if (amount > 0 && allowance > 0) token.safeApprove(SOLO_MARGIN_CONTRACT, 0);
token.safeApprove(SOLO_MARGIN_CONTRACT, amount);
return;
}
/**
* @dev Deposits funds to the dYdX pool. Assumes that you have already approved >= the amount to dYdX.
* @param erc20Contract The ERC20 contract address of the token to be deposited.
* @param amount The amount of tokens to be deposited.
*/
function deposit(address erc20Contract, uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
uint256 marketId = getMarketId(erc20Contract);
Account.Info memory account = Account.Info(address(this), 0);
Account.Info[] memory accounts = new Account.Info[](1);
accounts[0] = account;
Types.AssetAmount memory assetAmount = Types.AssetAmount(true, Types.AssetDenomination.Wei, Types.AssetReference.Delta, amount);
bytes memory emptyData;
Actions.ActionArgs memory action = Actions.ActionArgs(
Actions.ActionType.Deposit,
0,
assetAmount,
marketId,
0,
address(this),
0,
emptyData
);
Actions.ActionArgs[] memory actions = new Actions.ActionArgs[](1);
actions[0] = action;
_soloMargin.operate(accounts, actions);
}
/**
* @dev Withdraws funds from the dYdX pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
*/
function withdraw(address erc20Contract, uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
uint256 marketId = getMarketId(erc20Contract);
Account.Info memory account = Account.Info(address(this), 0);
Account.Info[] memory accounts = new Account.Info[](1);
accounts[0] = account;
Types.AssetAmount memory assetAmount = Types.AssetAmount(false, Types.AssetDenomination.Wei, Types.AssetReference.Delta, amount);
bytes memory emptyData;
Actions.ActionArgs memory action = Actions.ActionArgs(
Actions.ActionType.Withdraw,
0,
assetAmount,
marketId,
0,
address(this),
0,
emptyData
);
Actions.ActionArgs[] memory actions = new Actions.ActionArgs[](1);
actions[0] = action;
_soloMargin.operate(accounts, actions);
}
/**
* @dev Withdraws all funds from the dYdX pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
*/
function withdrawAll(address erc20Contract) external {
uint256 marketId = getMarketId(erc20Contract);
Account.Info memory account = Account.Info(address(this), 0);
Account.Info[] memory accounts = new Account.Info[](1);
accounts[0] = account;
Types.AssetAmount memory assetAmount = Types.AssetAmount(true, Types.AssetDenomination.Par, Types.AssetReference.Target, 0);
bytes memory emptyData;
Actions.ActionArgs memory action = Actions.ActionArgs(
Actions.ActionType.Withdraw,
0,
assetAmount,
marketId,
0,
address(this),
0,
emptyData
);
Actions.ActionArgs[] memory actions = new Actions.ActionArgs[](1);
actions[0] = action;
_soloMargin.operate(accounts, actions);
}
}
// File: contracts/external/compound/CErc20.sol
/**
* Copyright 2020 Compound Labs, Inc.
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
pragma solidity 0.5.17;
/**
* @title Compound's CErc20 Contract
* @notice CTokens which wrap an EIP-20 underlying
* @author Compound
*/
interface CErc20 {
function mint(uint mintAmount) external returns (uint);
function redeem(uint redeemTokens) external returns (uint);
function redeemUnderlying(uint redeemAmount) external returns (uint);
function balanceOf(address owner) external view returns (uint);
function balanceOfUnderlying(address owner) external returns (uint);
function accrueInterest() external returns (uint);
function exchangeRateStored() external view returns (uint);
}
// File: contracts/lib/pools/CompoundPoolController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title CompoundPoolController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles deposits to and withdrawals from dYdX liquidity pools.
*/
library CompoundPoolController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
/**
* @dev Returns a token's cToken contract address given its ERC20 contract address.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getCErc20Contract(address erc20Contract) private pure returns (address) {
if (erc20Contract == 0x6B175474E89094C44Da98b954EedeAC495271d0F) return 0x5d3a536E4D6DbD6114cc1Ead35777bAB948E3643; // DAI => cDAI
if (erc20Contract == 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48) return 0x39AA39c021dfbaE8faC545936693aC917d5E7563; // USDC => cUSDC
if (erc20Contract == 0xdAC17F958D2ee523a2206206994597C13D831ec7) return 0xf650C3d88D12dB855b8bf7D11Be6C55A4e07dCC9; // USDT => cUSDT
else revert("Supported Compound cToken address not found for this token address.");
}
/**
* @dev Returns the fund's balance of the specified currency in the Compound pool.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getBalance(address erc20Contract) external returns (uint256) {
return CErc20(getCErc20Contract(erc20Contract)).balanceOfUnderlying(address(this));
}
/**
* @dev Approves tokens to Compound without spending gas on every deposit.
* @param erc20Contract The ERC20 contract address of the token.
* @param amount Amount of the specified token to approve to Compound.
*/
function approve(address erc20Contract, uint256 amount) external {
address cErc20Contract = getCErc20Contract(erc20Contract);
IERC20 token = IERC20(erc20Contract);
uint256 allowance = token.allowance(address(this), cErc20Contract);
if (allowance == amount) return;
if (amount > 0 && allowance > 0) token.safeApprove(cErc20Contract, 0);
token.safeApprove(cErc20Contract, amount);
return;
}
/**
* @dev Deposits funds to the Compound pool. Assumes that you have already approved >= the amount to Compound.
* @param erc20Contract The ERC20 contract address of the token to be deposited.
* @param amount The amount of tokens to be deposited.
*/
function deposit(address erc20Contract, uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
CErc20 cErc20 = CErc20(getCErc20Contract(erc20Contract));
uint256 mintResult = cErc20.mint(amount);
require(mintResult == 0, "Error calling mint on Compound cToken: error code not equal to 0.");
}
/**
* @dev Withdraws funds from the Compound pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
*/
function withdraw(address erc20Contract, uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
CErc20 cErc20 = CErc20(getCErc20Contract(erc20Contract));
uint256 redeemResult = cErc20.redeemUnderlying(amount);
require(redeemResult == 0, "Error calling redeemUnderlying on Compound cToken: error code not equal to 0.");
}
/**
* @dev Withdraws all funds from the Compound pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @return Boolean indicating success.
*/
function withdrawAll(address erc20Contract) external returns (bool) {
CErc20 cErc20 = CErc20(getCErc20Contract(erc20Contract));
uint256 balance = cErc20.balanceOf(address(this));
if (balance <= 0) return false;
uint256 redeemResult = cErc20.redeem(balance);
require(redeemResult == 0, "Error calling redeem on Compound cToken: error code not equal to 0.");
return true;
}
}
// File: contracts/external/aave/LendingPool.sol
/**
* Aave Protocol
* Copyright (C) 2019 Aave
* 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 3 of the License, or 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
*/
pragma solidity 0.5.17;
/**
* @title LendingPool contract
* @notice Implements the actions of the LendingPool, and exposes accessory methods to fetch the users and reserve data
* @author Aave
*/
contract LendingPool {
/**
* @dev deposits The underlying asset into the reserve. A corresponding amount of the overlying asset (aTokens)
* is minted.
* @param _reserve the address of the reserve
* @param _amount the amount to be deposited
* @param _referralCode integrators are assigned a referral code and can potentially receive rewards.
*/
function deposit(address _reserve, uint256 _amount, uint16 _referralCode) external payable;
}
// File: contracts/external/aave/AToken.sol
/**
* Aave Protocol
* Copyright (C) 2019 Aave
* 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 3 of the License, or 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
*/
pragma solidity 0.5.17;
/**
* @title Aave ERC20 AToken
* @dev Implementation of the interest bearing token for the DLP protocol.
* @author Aave
*/
contract AToken {
/**
* @dev redeems aToken for the underlying asset
* @param _amount the amount being redeemed
*/
function redeem(uint256 _amount) external;
/**
* @dev calculates the balance of the user, which is the
* principal balance + interest generated by the principal balance + interest generated by the redirected balance
* @param _user the user for which the balance is being calculated
* @return the total balance of the user
*/
function balanceOf(address _user) public view returns (uint256);
}
// File: contracts/lib/pools/AavePoolController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title AavePoolController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles deposits to and withdrawals from Aave liquidity pools.
*/
library AavePoolController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
/**
* @dev Aave LendingPool contract address.
*/
address constant private LENDING_POOL_CONTRACT = 0x398eC7346DcD622eDc5ae82352F02bE94C62d119;
/**
* @dev Aave LendingPool contract object.
*/
LendingPool constant private _lendingPool = LendingPool(LENDING_POOL_CONTRACT);
/**
* @dev Aave LendingPoolCore contract address.
*/
address constant private LENDING_POOL_CORE_CONTRACT = 0x3dfd23A6c5E8BbcFc9581d2E864a68feb6a076d3;
/**
* @dev Returns a token's aToken contract address given its ERC20 contract address.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getATokenContract(address erc20Contract) private pure returns (address) {
if (erc20Contract == 0x6B175474E89094C44Da98b954EedeAC495271d0F) return 0xfC1E690f61EFd961294b3e1Ce3313fBD8aa4f85d; // DAI => aDAI
if (erc20Contract == 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48) return 0x9bA00D6856a4eDF4665BcA2C2309936572473B7E; // USDC => aUSDC
if (erc20Contract == 0xdAC17F958D2ee523a2206206994597C13D831ec7) return 0x71fc860F7D3A592A4a98740e39dB31d25db65ae8; // USDT => aUSDT
if (erc20Contract == 0x0000000000085d4780B73119b644AE5ecd22b376) return 0x4DA9b813057D04BAef4e5800E36083717b4a0341; // TUSD => aTUSD
if (erc20Contract == 0x4Fabb145d64652a948d72533023f6E7A623C7C53) return 0x6Ee0f7BB50a54AB5253dA0667B0Dc2ee526C30a8; // BUSD => aBUSD
if (erc20Contract == 0x57Ab1ec28D129707052df4dF418D58a2D46d5f51) return 0x625aE63000f46200499120B906716420bd059240; // sUSD => aSUSD
else revert("Supported Aave aToken address not found for this token address.");
}
/**
* @dev Returns the fund's balance of the specified currency in the Aave pool.
* @param erc20Contract The ERC20 contract address of the token.
*/
function getBalance(address erc20Contract) external view returns (uint256) {
AToken aToken = AToken(getATokenContract(erc20Contract));
return aToken.balanceOf(address(this));
}
/**
* @dev Approves tokens to Aave without spending gas on every deposit.
* @param erc20Contract The ERC20 contract address of the token.
* @param amount Amount of the specified token to approve to Aave.
*/
function approve(address erc20Contract, uint256 amount) external {
IERC20 token = IERC20(erc20Contract);
uint256 allowance = token.allowance(address(this), LENDING_POOL_CORE_CONTRACT);
if (allowance == amount) return;
if (amount > 0 && allowance > 0) token.safeApprove(LENDING_POOL_CORE_CONTRACT, 0);
token.safeApprove(LENDING_POOL_CORE_CONTRACT, amount);
return;
}
/**
* @dev Deposits funds to the Aave pool. Assumes that you have already approved >= the amount to Aave.
* @param erc20Contract The ERC20 contract address of the token to be deposited.
* @param amount The amount of tokens to be deposited.
* @param referralCode Referral code.
*/
function deposit(address erc20Contract, uint256 amount, uint16 referralCode) external {
require(amount > 0, "Amount must be greater than 0.");
_lendingPool.deposit(erc20Contract, amount, referralCode);
}
/**
* @dev Withdraws funds from the Aave pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
*/
function withdraw(address erc20Contract, uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
AToken aToken = AToken(getATokenContract(erc20Contract));
aToken.redeem(amount);
}
/**
* @dev Withdraws all funds from the Aave pool.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @return Boolean indicating success.
*/
function withdrawAll(address erc20Contract) external returns (bool) {
AToken aToken = AToken(getATokenContract(erc20Contract));
uint256 balance = aToken.balanceOf(address(this));
if (balance <= 0) return false;
aToken.redeem(balance);
return true;
}
}
// File: contracts/external/mstable/ISavingsContract.sol
pragma solidity 0.5.17;
/**
* @title ISavingsContract
*/
contract ISavingsContract {
uint256 public exchangeRate;
mapping(address => uint256) public creditBalances;
function depositSavings(uint256 _amount) external returns (uint256 creditsIssued);
function redeem(uint256 _amount) external returns (uint256 massetReturned);
}
// File: contracts/lib/pools/MStablePoolController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title MStablePoolController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles deposits to and withdrawals from mStable liquidity pools.
*/
library MStablePoolController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
/**
* @dev mStable mUSD ERC20 token contract address.
*/
address constant private MUSD_TOKEN_CONTRACT = 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5;
/**
* @dev mStable SavingsContract contract address.
*/
address constant private SAVINGS_CONTRACT = 0xcf3F73290803Fc04425BEE135a4Caeb2BaB2C2A1;
/**
* @dev mStable SavingsContract contract object.
*/
ISavingsContract constant private _savingsContract = ISavingsContract(SAVINGS_CONTRACT);
/**
* @dev Returns the fund's mUSD token balance supplied to the mStable savings contract.
*/
function getBalance() external view returns (uint256) {
return _savingsContract.creditBalances(address(this)).mul(_savingsContract.exchangeRate()).div(1e18);
}
/**
* @dev Approves mUSD tokens to the mStable savings contract without spending gas on every deposit.
* @param amount Amount of mUSD tokens to approve to the mStable savings contract.
*/
function approve(uint256 amount) external {
IERC20 token = IERC20(MUSD_TOKEN_CONTRACT);
uint256 allowance = token.allowance(address(this), SAVINGS_CONTRACT);
if (allowance == amount) return;
if (amount > 0 && allowance > 0) token.safeApprove(SAVINGS_CONTRACT, 0);
token.safeApprove(SAVINGS_CONTRACT, amount);
return;
}
/**
* @dev Deposits mUSD tokens to the mStable savings contract.
* @param amount The amount of mUSD tokens to be deposited.
*/
function deposit(uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
uint256 creditsIssued = _savingsContract.depositSavings(amount);
require(creditsIssued > 0, "Error calling depositSavings on mStable savings contract: no credits issued.");
}
/**
* @dev Withdraws mUSD tokens from the mStable savings contract.
* May withdraw slightly more than `amount` due to imperfect precision.
* @param amount The amount of mUSD tokens to be withdrawn.
*/
function withdraw(uint256 amount) external {
require(amount > 0, "Amount must be greater than 0.");
uint256 exchangeRate = _savingsContract.exchangeRate();
uint256 credits = amount.mul(1e18).div(exchangeRate);
if (credits.mul(exchangeRate).div(1e18) < amount) credits++; // Round up if necessary (i.e., if the division above left a remainder)
uint256 mAssetReturned = _savingsContract.redeem(credits);
require(mAssetReturned > 0, "Error calling redeem on mStable savings contract: no mUSD returned.");
}
/**
* @dev Withdraws all funds from the mStable savings contract.
*/
function withdrawAll() external returns (bool) {
uint256 creditBalance = _savingsContract.creditBalances(address(this));
if (creditBalance <= 0) return false;
uint256 mAssetReturned = _savingsContract.redeem(creditBalance);
require(mAssetReturned > 0, "Error calling redeem on mStable savings contract: no mUSD returned.");
return true;
}
}
// File: @0x/contracts-utils/contracts/src/LibRichErrors.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibRichErrors {
// bytes4(keccak256("Error(string)"))
bytes4 internal constant STANDARD_ERROR_SELECTOR =
0x08c379a0;
// solhint-disable func-name-mixedcase
/// @dev ABI encode a standard, string revert error payload.
/// This is the same payload that would be included by a `revert(string)`
/// solidity statement. It has the function signature `Error(string)`.
/// @param message The error string.
/// @return The ABI encoded error.
function StandardError(
string memory message
)
internal
pure
returns (bytes memory)
{
return abi.encodeWithSelector(
STANDARD_ERROR_SELECTOR,
bytes(message)
);
}
// solhint-enable func-name-mixedcase
/// @dev Reverts an encoded rich revert reason `errorData`.
/// @param errorData ABI encoded error data.
function rrevert(bytes memory errorData)
internal
pure
{
assembly {
revert(add(errorData, 0x20), mload(errorData))
}
}
}
// File: @0x/contracts-utils/contracts/src/LibSafeMathRichErrors.sol
pragma solidity ^0.5.9;
library LibSafeMathRichErrors {
// bytes4(keccak256("Uint256BinOpError(uint8,uint256,uint256)"))
bytes4 internal constant UINT256_BINOP_ERROR_SELECTOR =
0xe946c1bb;
// bytes4(keccak256("Uint256DowncastError(uint8,uint256)"))
bytes4 internal constant UINT256_DOWNCAST_ERROR_SELECTOR =
0xc996af7b;
enum BinOpErrorCodes {
ADDITION_OVERFLOW,
MULTIPLICATION_OVERFLOW,
SUBTRACTION_UNDERFLOW,
DIVISION_BY_ZERO
}
enum DowncastErrorCodes {
VALUE_TOO_LARGE_TO_DOWNCAST_TO_UINT32,
VALUE_TOO_LARGE_TO_DOWNCAST_TO_UINT64,
VALUE_TOO_LARGE_TO_DOWNCAST_TO_UINT96
}
// solhint-disable func-name-mixedcase
function Uint256BinOpError(
BinOpErrorCodes errorCode,
uint256 a,
uint256 b
)
internal
pure
returns (bytes memory)
{
return abi.encodeWithSelector(
UINT256_BINOP_ERROR_SELECTOR,
errorCode,
a,
b
);
}
function Uint256DowncastError(
DowncastErrorCodes errorCode,
uint256 a
)
internal
pure
returns (bytes memory)
{
return abi.encodeWithSelector(
UINT256_DOWNCAST_ERROR_SELECTOR,
errorCode,
a
);
}
}
// File: @0x/contracts-utils/contracts/src/LibSafeMath.sol
pragma solidity ^0.5.9;
library LibSafeMath {
function safeMul(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
if (a == 0) {
return 0;
}
uint256 c = a * b;
if (c / a != b) {
LibRichErrors.rrevert(LibSafeMathRichErrors.Uint256BinOpError(
LibSafeMathRichErrors.BinOpErrorCodes.MULTIPLICATION_OVERFLOW,
a,
b
));
}
return c;
}
function safeDiv(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
if (b == 0) {
LibRichErrors.rrevert(LibSafeMathRichErrors.Uint256BinOpError(
LibSafeMathRichErrors.BinOpErrorCodes.DIVISION_BY_ZERO,
a,
b
));
}
uint256 c = a / b;
return c;
}
function safeSub(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
if (b > a) {
LibRichErrors.rrevert(LibSafeMathRichErrors.Uint256BinOpError(
LibSafeMathRichErrors.BinOpErrorCodes.SUBTRACTION_UNDERFLOW,
a,
b
));
}
return a - b;
}
function safeAdd(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
uint256 c = a + b;
if (c < a) {
LibRichErrors.rrevert(LibSafeMathRichErrors.Uint256BinOpError(
LibSafeMathRichErrors.BinOpErrorCodes.ADDITION_OVERFLOW,
a,
b
));
}
return c;
}
function max256(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
return a >= b ? a : b;
}
function min256(uint256 a, uint256 b)
internal
pure
returns (uint256)
{
return a < b ? a : b;
}
}
// File: @0x/contracts-exchange-libs/contracts/src/LibMathRichErrors.sol
pragma solidity ^0.5.9;
library LibMathRichErrors {
// bytes4(keccak256("DivisionByZeroError()"))
bytes internal constant DIVISION_BY_ZERO_ERROR =
hex"a791837c";
// bytes4(keccak256("RoundingError(uint256,uint256,uint256)"))
bytes4 internal constant ROUNDING_ERROR_SELECTOR =
0x339f3de2;
// solhint-disable func-name-mixedcase
function DivisionByZeroError()
internal
pure
returns (bytes memory)
{
return DIVISION_BY_ZERO_ERROR;
}
function RoundingError(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (bytes memory)
{
return abi.encodeWithSelector(
ROUNDING_ERROR_SELECTOR,
numerator,
denominator,
target
);
}
}
// File: @0x/contracts-exchange-libs/contracts/src/LibMath.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibMath {
using LibSafeMath for uint256;
/// @dev Calculates partial value given a numerator and denominator rounded down.
/// Reverts if rounding error is >= 0.1%
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to calculate partial of.
/// @return Partial value of target rounded down.
function safeGetPartialAmountFloor(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (uint256 partialAmount)
{
if (isRoundingErrorFloor(
numerator,
denominator,
target
)) {
LibRichErrors.rrevert(LibMathRichErrors.RoundingError(
numerator,
denominator,
target
));
}
partialAmount = numerator.safeMul(target).safeDiv(denominator);
return partialAmount;
}
/// @dev Calculates partial value given a numerator and denominator rounded down.
/// Reverts if rounding error is >= 0.1%
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to calculate partial of.
/// @return Partial value of target rounded up.
function safeGetPartialAmountCeil(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (uint256 partialAmount)
{
if (isRoundingErrorCeil(
numerator,
denominator,
target
)) {
LibRichErrors.rrevert(LibMathRichErrors.RoundingError(
numerator,
denominator,
target
));
}
// safeDiv computes `floor(a / b)`. We use the identity (a, b integer):
// ceil(a / b) = floor((a + b - 1) / b)
// To implement `ceil(a / b)` using safeDiv.
partialAmount = numerator.safeMul(target)
.safeAdd(denominator.safeSub(1))
.safeDiv(denominator);
return partialAmount;
}
/// @dev Calculates partial value given a numerator and denominator rounded down.
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to calculate partial of.
/// @return Partial value of target rounded down.
function getPartialAmountFloor(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (uint256 partialAmount)
{
partialAmount = numerator.safeMul(target).safeDiv(denominator);
return partialAmount;
}
/// @dev Calculates partial value given a numerator and denominator rounded down.
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to calculate partial of.
/// @return Partial value of target rounded up.
function getPartialAmountCeil(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (uint256 partialAmount)
{
// safeDiv computes `floor(a / b)`. We use the identity (a, b integer):
// ceil(a / b) = floor((a + b - 1) / b)
// To implement `ceil(a / b)` using safeDiv.
partialAmount = numerator.safeMul(target)
.safeAdd(denominator.safeSub(1))
.safeDiv(denominator);
return partialAmount;
}
/// @dev Checks if rounding error >= 0.1% when rounding down.
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to multiply with numerator/denominator.
/// @return Rounding error is present.
function isRoundingErrorFloor(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (bool isError)
{
if (denominator == 0) {
LibRichErrors.rrevert(LibMathRichErrors.DivisionByZeroError());
}
// The absolute rounding error is the difference between the rounded
// value and the ideal value. The relative rounding error is the
// absolute rounding error divided by the absolute value of the
// ideal value. This is undefined when the ideal value is zero.
//
// The ideal value is `numerator * target / denominator`.
// Let's call `numerator * target % denominator` the remainder.
// The absolute error is `remainder / denominator`.
//
// When the ideal value is zero, we require the absolute error to
// be zero. Fortunately, this is always the case. The ideal value is
// zero iff `numerator == 0` and/or `target == 0`. In this case the
// remainder and absolute error are also zero.
if (target == 0 || numerator == 0) {
return false;
}
// Otherwise, we want the relative rounding error to be strictly
// less than 0.1%.
// The relative error is `remainder / (numerator * target)`.
// We want the relative error less than 1 / 1000:
// remainder / (numerator * denominator) < 1 / 1000
// or equivalently:
// 1000 * remainder < numerator * target
// so we have a rounding error iff:
// 1000 * remainder >= numerator * target
uint256 remainder = mulmod(
target,
numerator,
denominator
);
isError = remainder.safeMul(1000) >= numerator.safeMul(target);
return isError;
}
/// @dev Checks if rounding error >= 0.1% when rounding up.
/// @param numerator Numerator.
/// @param denominator Denominator.
/// @param target Value to multiply with numerator/denominator.
/// @return Rounding error is present.
function isRoundingErrorCeil(
uint256 numerator,
uint256 denominator,
uint256 target
)
internal
pure
returns (bool isError)
{
if (denominator == 0) {
LibRichErrors.rrevert(LibMathRichErrors.DivisionByZeroError());
}
// See the comments in `isRoundingError`.
if (target == 0 || numerator == 0) {
// When either is zero, the ideal value and rounded value are zero
// and there is no rounding error. (Although the relative error
// is undefined.)
return false;
}
// Compute remainder as before
uint256 remainder = mulmod(
target,
numerator,
denominator
);
remainder = denominator.safeSub(remainder) % denominator;
isError = remainder.safeMul(1000) >= numerator.safeMul(target);
return isError;
}
}
// File: @0x/contracts-exchange-libs/contracts/src/LibFillResults.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibFillResults {
using LibSafeMath for uint256;
struct BatchMatchedFillResults {
FillResults[] left; // Fill results for left orders
FillResults[] right; // Fill results for right orders
uint256 profitInLeftMakerAsset; // Profit taken from left makers
uint256 profitInRightMakerAsset; // Profit taken from right makers
}
struct FillResults {
uint256 makerAssetFilledAmount; // Total amount of makerAsset(s) filled.
uint256 takerAssetFilledAmount; // Total amount of takerAsset(s) filled.
uint256 makerFeePaid; // Total amount of fees paid by maker(s) to feeRecipient(s).
uint256 takerFeePaid; // Total amount of fees paid by taker to feeRecipients(s).
uint256 protocolFeePaid; // Total amount of fees paid by taker to the staking contract.
}
struct MatchedFillResults {
FillResults left; // Amounts filled and fees paid of left order.
FillResults right; // Amounts filled and fees paid of right order.
uint256 profitInLeftMakerAsset; // Profit taken from the left maker
uint256 profitInRightMakerAsset; // Profit taken from the right maker
}
/// @dev Calculates amounts filled and fees paid by maker and taker.
/// @param order to be filled.
/// @param takerAssetFilledAmount Amount of takerAsset that will be filled.
/// @param protocolFeeMultiplier The current protocol fee of the exchange contract.
/// @param gasPrice The gasprice of the transaction. This is provided so that the function call can continue
/// to be pure rather than view.
/// @return fillResults Amounts filled and fees paid by maker and taker.
function calculateFillResults(
LibOrder.Order memory order,
uint256 takerAssetFilledAmount,
uint256 protocolFeeMultiplier,
uint256 gasPrice
)
internal
pure
returns (FillResults memory fillResults)
{
// Compute proportional transfer amounts
fillResults.takerAssetFilledAmount = takerAssetFilledAmount;
fillResults.makerAssetFilledAmount = LibMath.safeGetPartialAmountFloor(
takerAssetFilledAmount,
order.takerAssetAmount,
order.makerAssetAmount
);
fillResults.makerFeePaid = LibMath.safeGetPartialAmountFloor(
takerAssetFilledAmount,
order.takerAssetAmount,
order.makerFee
);
fillResults.takerFeePaid = LibMath.safeGetPartialAmountFloor(
takerAssetFilledAmount,
order.takerAssetAmount,
order.takerFee
);
// Compute the protocol fee that should be paid for a single fill.
fillResults.protocolFeePaid = gasPrice.safeMul(protocolFeeMultiplier);
return fillResults;
}
/// @dev Calculates fill amounts for the matched orders.
/// Each order is filled at their respective price point. However, the calculations are
/// carried out as though the orders are both being filled at the right order's price point.
/// The profit made by the leftOrder order goes to the taker (who matched the two orders).
/// @param leftOrder First order to match.
/// @param rightOrder Second order to match.
/// @param leftOrderTakerAssetFilledAmount Amount of left order already filled.
/// @param rightOrderTakerAssetFilledAmount Amount of right order already filled.
/// @param protocolFeeMultiplier The current protocol fee of the exchange contract.
/// @param gasPrice The gasprice of the transaction. This is provided so that the function call can continue
/// to be pure rather than view.
/// @param shouldMaximallyFillOrders A value that indicates whether or not this calculation should use
/// the maximal fill order matching strategy.
/// @param matchedFillResults Amounts to fill and fees to pay by maker and taker of matched orders.
function calculateMatchedFillResults(
LibOrder.Order memory leftOrder,
LibOrder.Order memory rightOrder,
uint256 leftOrderTakerAssetFilledAmount,
uint256 rightOrderTakerAssetFilledAmount,
uint256 protocolFeeMultiplier,
uint256 gasPrice,
bool shouldMaximallyFillOrders
)
internal
pure
returns (MatchedFillResults memory matchedFillResults)
{
// Derive maker asset amounts for left & right orders, given store taker assert amounts
uint256 leftTakerAssetAmountRemaining = leftOrder.takerAssetAmount.safeSub(leftOrderTakerAssetFilledAmount);
uint256 leftMakerAssetAmountRemaining = LibMath.safeGetPartialAmountFloor(
leftOrder.makerAssetAmount,
leftOrder.takerAssetAmount,
leftTakerAssetAmountRemaining
);
uint256 rightTakerAssetAmountRemaining = rightOrder.takerAssetAmount.safeSub(rightOrderTakerAssetFilledAmount);
uint256 rightMakerAssetAmountRemaining = LibMath.safeGetPartialAmountFloor(
rightOrder.makerAssetAmount,
rightOrder.takerAssetAmount,
rightTakerAssetAmountRemaining
);
// Maximally fill the orders and pay out profits to the matcher in one or both of the maker assets.
if (shouldMaximallyFillOrders) {
matchedFillResults = _calculateMatchedFillResultsWithMaximalFill(
leftOrder,
rightOrder,
leftMakerAssetAmountRemaining,
leftTakerAssetAmountRemaining,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
} else {
matchedFillResults = _calculateMatchedFillResults(
leftOrder,
rightOrder,
leftMakerAssetAmountRemaining,
leftTakerAssetAmountRemaining,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
}
// Compute fees for left order
matchedFillResults.left.makerFeePaid = LibMath.safeGetPartialAmountFloor(
matchedFillResults.left.makerAssetFilledAmount,
leftOrder.makerAssetAmount,
leftOrder.makerFee
);
matchedFillResults.left.takerFeePaid = LibMath.safeGetPartialAmountFloor(
matchedFillResults.left.takerAssetFilledAmount,
leftOrder.takerAssetAmount,
leftOrder.takerFee
);
// Compute fees for right order
matchedFillResults.right.makerFeePaid = LibMath.safeGetPartialAmountFloor(
matchedFillResults.right.makerAssetFilledAmount,
rightOrder.makerAssetAmount,
rightOrder.makerFee
);
matchedFillResults.right.takerFeePaid = LibMath.safeGetPartialAmountFloor(
matchedFillResults.right.takerAssetFilledAmount,
rightOrder.takerAssetAmount,
rightOrder.takerFee
);
// Compute the protocol fee that should be paid for a single fill. In this
// case this should be made the protocol fee for both the left and right orders.
uint256 protocolFee = gasPrice.safeMul(protocolFeeMultiplier);
matchedFillResults.left.protocolFeePaid = protocolFee;
matchedFillResults.right.protocolFeePaid = protocolFee;
// Return fill results
return matchedFillResults;
}
/// @dev Adds properties of both FillResults instances.
/// @param fillResults1 The first FillResults.
/// @param fillResults2 The second FillResults.
/// @return The sum of both fill results.
function addFillResults(
FillResults memory fillResults1,
FillResults memory fillResults2
)
internal
pure
returns (FillResults memory totalFillResults)
{
totalFillResults.makerAssetFilledAmount = fillResults1.makerAssetFilledAmount.safeAdd(fillResults2.makerAssetFilledAmount);
totalFillResults.takerAssetFilledAmount = fillResults1.takerAssetFilledAmount.safeAdd(fillResults2.takerAssetFilledAmount);
totalFillResults.makerFeePaid = fillResults1.makerFeePaid.safeAdd(fillResults2.makerFeePaid);
totalFillResults.takerFeePaid = fillResults1.takerFeePaid.safeAdd(fillResults2.takerFeePaid);
totalFillResults.protocolFeePaid = fillResults1.protocolFeePaid.safeAdd(fillResults2.protocolFeePaid);
return totalFillResults;
}
/// @dev Calculates part of the matched fill results for a given situation using the fill strategy that only
/// awards profit denominated in the left maker asset.
/// @param leftOrder The left order in the order matching situation.
/// @param rightOrder The right order in the order matching situation.
/// @param leftMakerAssetAmountRemaining The amount of the left order maker asset that can still be filled.
/// @param leftTakerAssetAmountRemaining The amount of the left order taker asset that can still be filled.
/// @param rightMakerAssetAmountRemaining The amount of the right order maker asset that can still be filled.
/// @param rightTakerAssetAmountRemaining The amount of the right order taker asset that can still be filled.
/// @return MatchFillResults struct that does not include fees paid.
function _calculateMatchedFillResults(
LibOrder.Order memory leftOrder,
LibOrder.Order memory rightOrder,
uint256 leftMakerAssetAmountRemaining,
uint256 leftTakerAssetAmountRemaining,
uint256 rightMakerAssetAmountRemaining,
uint256 rightTakerAssetAmountRemaining
)
private
pure
returns (MatchedFillResults memory matchedFillResults)
{
// Calculate fill results for maker and taker assets: at least one order will be fully filled.
// The maximum amount the left maker can buy is `leftTakerAssetAmountRemaining`
// The maximum amount the right maker can sell is `rightMakerAssetAmountRemaining`
// We have two distinct cases for calculating the fill results:
// Case 1.
// If the left maker can buy more than the right maker can sell, then only the right order is fully filled.
// If the left maker can buy exactly what the right maker can sell, then both orders are fully filled.
// Case 2.
// If the left maker cannot buy more than the right maker can sell, then only the left order is fully filled.
// Case 3.
// If the left maker can buy exactly as much as the right maker can sell, then both orders are fully filled.
if (leftTakerAssetAmountRemaining > rightMakerAssetAmountRemaining) {
// Case 1: Right order is fully filled
matchedFillResults = _calculateCompleteRightFill(
leftOrder,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
} else if (leftTakerAssetAmountRemaining < rightMakerAssetAmountRemaining) {
// Case 2: Left order is fully filled
matchedFillResults.left.makerAssetFilledAmount = leftMakerAssetAmountRemaining;
matchedFillResults.left.takerAssetFilledAmount = leftTakerAssetAmountRemaining;
matchedFillResults.right.makerAssetFilledAmount = leftTakerAssetAmountRemaining;
// Round up to ensure the maker's exchange rate does not exceed the price specified by the order.
// We favor the maker when the exchange rate must be rounded.
matchedFillResults.right.takerAssetFilledAmount = LibMath.safeGetPartialAmountCeil(
rightOrder.takerAssetAmount,
rightOrder.makerAssetAmount,
leftTakerAssetAmountRemaining // matchedFillResults.right.makerAssetFilledAmount
);
} else {
// leftTakerAssetAmountRemaining == rightMakerAssetAmountRemaining
// Case 3: Both orders are fully filled. Technically, this could be captured by the above cases, but
// this calculation will be more precise since it does not include rounding.
matchedFillResults = _calculateCompleteFillBoth(
leftMakerAssetAmountRemaining,
leftTakerAssetAmountRemaining,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
}
// Calculate amount given to taker
matchedFillResults.profitInLeftMakerAsset = matchedFillResults.left.makerAssetFilledAmount.safeSub(
matchedFillResults.right.takerAssetFilledAmount
);
return matchedFillResults;
}
/// @dev Calculates part of the matched fill results for a given situation using the maximal fill order matching
/// strategy.
/// @param leftOrder The left order in the order matching situation.
/// @param rightOrder The right order in the order matching situation.
/// @param leftMakerAssetAmountRemaining The amount of the left order maker asset that can still be filled.
/// @param leftTakerAssetAmountRemaining The amount of the left order taker asset that can still be filled.
/// @param rightMakerAssetAmountRemaining The amount of the right order maker asset that can still be filled.
/// @param rightTakerAssetAmountRemaining The amount of the right order taker asset that can still be filled.
/// @return MatchFillResults struct that does not include fees paid.
function _calculateMatchedFillResultsWithMaximalFill(
LibOrder.Order memory leftOrder,
LibOrder.Order memory rightOrder,
uint256 leftMakerAssetAmountRemaining,
uint256 leftTakerAssetAmountRemaining,
uint256 rightMakerAssetAmountRemaining,
uint256 rightTakerAssetAmountRemaining
)
private
pure
returns (MatchedFillResults memory matchedFillResults)
{
// If a maker asset is greater than the opposite taker asset, than there will be a spread denominated in that maker asset.
bool doesLeftMakerAssetProfitExist = leftMakerAssetAmountRemaining > rightTakerAssetAmountRemaining;
bool doesRightMakerAssetProfitExist = rightMakerAssetAmountRemaining > leftTakerAssetAmountRemaining;
// Calculate the maximum fill results for the maker and taker assets. At least one of the orders will be fully filled.
//
// The maximum that the left maker can possibly buy is the amount that the right order can sell.
// The maximum that the right maker can possibly buy is the amount that the left order can sell.
//
// If the left order is fully filled, profit will be paid out in the left maker asset. If the right order is fully filled,
// the profit will be out in the right maker asset.
//
// There are three cases to consider:
// Case 1.
// If the left maker can buy more than the right maker can sell, then only the right order is fully filled.
// Case 2.
// If the right maker can buy more than the left maker can sell, then only the right order is fully filled.
// Case 3.
// If the right maker can sell the max of what the left maker can buy and the left maker can sell the max of
// what the right maker can buy, then both orders are fully filled.
if (leftTakerAssetAmountRemaining > rightMakerAssetAmountRemaining) {
// Case 1: Right order is fully filled with the profit paid in the left makerAsset
matchedFillResults = _calculateCompleteRightFill(
leftOrder,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
} else if (rightTakerAssetAmountRemaining > leftMakerAssetAmountRemaining) {
// Case 2: Left order is fully filled with the profit paid in the right makerAsset.
matchedFillResults.left.makerAssetFilledAmount = leftMakerAssetAmountRemaining;
matchedFillResults.left.takerAssetFilledAmount = leftTakerAssetAmountRemaining;
// Round down to ensure the right maker's exchange rate does not exceed the price specified by the order.
// We favor the right maker when the exchange rate must be rounded and the profit is being paid in the
// right maker asset.
matchedFillResults.right.makerAssetFilledAmount = LibMath.safeGetPartialAmountFloor(
rightOrder.makerAssetAmount,
rightOrder.takerAssetAmount,
leftMakerAssetAmountRemaining
);
matchedFillResults.right.takerAssetFilledAmount = leftMakerAssetAmountRemaining;
} else {
// Case 3: The right and left orders are fully filled
matchedFillResults = _calculateCompleteFillBoth(
leftMakerAssetAmountRemaining,
leftTakerAssetAmountRemaining,
rightMakerAssetAmountRemaining,
rightTakerAssetAmountRemaining
);
}
// Calculate amount given to taker in the left order's maker asset if the left spread will be part of the profit.
if (doesLeftMakerAssetProfitExist) {
matchedFillResults.profitInLeftMakerAsset = matchedFillResults.left.makerAssetFilledAmount.safeSub(
matchedFillResults.right.takerAssetFilledAmount
);
}
// Calculate amount given to taker in the right order's maker asset if the right spread will be part of the profit.
if (doesRightMakerAssetProfitExist) {
matchedFillResults.profitInRightMakerAsset = matchedFillResults.right.makerAssetFilledAmount.safeSub(
matchedFillResults.left.takerAssetFilledAmount
);
}
return matchedFillResults;
}
/// @dev Calculates the fill results for the maker and taker in the order matching and writes the results
/// to the fillResults that are being collected on the order. Both orders will be fully filled in this
/// case.
/// @param leftMakerAssetAmountRemaining The amount of the left maker asset that is remaining to be filled.
/// @param leftTakerAssetAmountRemaining The amount of the left taker asset that is remaining to be filled.
/// @param rightMakerAssetAmountRemaining The amount of the right maker asset that is remaining to be filled.
/// @param rightTakerAssetAmountRemaining The amount of the right taker asset that is remaining to be filled.
/// @return MatchFillResults struct that does not include fees paid or spreads taken.
function _calculateCompleteFillBoth(
uint256 leftMakerAssetAmountRemaining,
uint256 leftTakerAssetAmountRemaining,
uint256 rightMakerAssetAmountRemaining,
uint256 rightTakerAssetAmountRemaining
)
private
pure
returns (MatchedFillResults memory matchedFillResults)
{
// Calculate the fully filled results for both orders.
matchedFillResults.left.makerAssetFilledAmount = leftMakerAssetAmountRemaining;
matchedFillResults.left.takerAssetFilledAmount = leftTakerAssetAmountRemaining;
matchedFillResults.right.makerAssetFilledAmount = rightMakerAssetAmountRemaining;
matchedFillResults.right.takerAssetFilledAmount = rightTakerAssetAmountRemaining;
return matchedFillResults;
}
/// @dev Calculates the fill results for the maker and taker in the order matching and writes the results
/// to the fillResults that are being collected on the order.
/// @param leftOrder The left order that is being maximally filled. All of the information about fill amounts
/// can be derived from this order and the right asset remaining fields.
/// @param rightMakerAssetAmountRemaining The amount of the right maker asset that is remaining to be filled.
/// @param rightTakerAssetAmountRemaining The amount of the right taker asset that is remaining to be filled.
/// @return MatchFillResults struct that does not include fees paid or spreads taken.
function _calculateCompleteRightFill(
LibOrder.Order memory leftOrder,
uint256 rightMakerAssetAmountRemaining,
uint256 rightTakerAssetAmountRemaining
)
private
pure
returns (MatchedFillResults memory matchedFillResults)
{
matchedFillResults.right.makerAssetFilledAmount = rightMakerAssetAmountRemaining;
matchedFillResults.right.takerAssetFilledAmount = rightTakerAssetAmountRemaining;
matchedFillResults.left.takerAssetFilledAmount = rightMakerAssetAmountRemaining;
// Round down to ensure the left maker's exchange rate does not exceed the price specified by the order.
// We favor the left maker when the exchange rate must be rounded and the profit is being paid in the
// left maker asset.
matchedFillResults.left.makerAssetFilledAmount = LibMath.safeGetPartialAmountFloor(
leftOrder.makerAssetAmount,
leftOrder.takerAssetAmount,
rightMakerAssetAmountRemaining
);
return matchedFillResults;
}
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IExchangeCore.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract IExchangeCore {
// Fill event is emitted whenever an order is filled.
event Fill(
address indexed makerAddress, // Address that created the order.
address indexed feeRecipientAddress, // Address that received fees.
bytes makerAssetData, // Encoded data specific to makerAsset.
bytes takerAssetData, // Encoded data specific to takerAsset.
bytes makerFeeAssetData, // Encoded data specific to makerFeeAsset.
bytes takerFeeAssetData, // Encoded data specific to takerFeeAsset.
bytes32 indexed orderHash, // EIP712 hash of order (see LibOrder.getTypedDataHash).
address takerAddress, // Address that filled the order.
address senderAddress, // Address that called the Exchange contract (msg.sender).
uint256 makerAssetFilledAmount, // Amount of makerAsset sold by maker and bought by taker.
uint256 takerAssetFilledAmount, // Amount of takerAsset sold by taker and bought by maker.
uint256 makerFeePaid, // Amount of makerFeeAssetData paid to feeRecipient by maker.
uint256 takerFeePaid, // Amount of takerFeeAssetData paid to feeRecipient by taker.
uint256 protocolFeePaid // Amount of eth or weth paid to the staking contract.
);
// Cancel event is emitted whenever an individual order is cancelled.
event Cancel(
address indexed makerAddress, // Address that created the order.
address indexed feeRecipientAddress, // Address that would have recieved fees if order was filled.
bytes makerAssetData, // Encoded data specific to makerAsset.
bytes takerAssetData, // Encoded data specific to takerAsset.
address senderAddress, // Address that called the Exchange contract (msg.sender).
bytes32 indexed orderHash // EIP712 hash of order (see LibOrder.getTypedDataHash).
);
// CancelUpTo event is emitted whenever `cancelOrdersUpTo` is executed succesfully.
event CancelUpTo(
address indexed makerAddress, // Orders cancelled must have been created by this address.
address indexed orderSenderAddress, // Orders cancelled must have a `senderAddress` equal to this address.
uint256 orderEpoch // Orders with specified makerAddress and senderAddress with a salt less than this value are considered cancelled.
);
/// @dev Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch
/// and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress).
/// @param targetOrderEpoch Orders created with a salt less or equal to this value will be cancelled.
function cancelOrdersUpTo(uint256 targetOrderEpoch)
external
payable;
/// @dev Fills the input order.
/// @param order Order struct containing order specifications.
/// @param takerAssetFillAmount Desired amount of takerAsset to sell.
/// @param signature Proof that order has been created by maker.
/// @return Amounts filled and fees paid by maker and taker.
function fillOrder(
LibOrder.Order memory order,
uint256 takerAssetFillAmount,
bytes memory signature
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev After calling, the order can not be filled anymore.
/// @param order Order struct containing order specifications.
function cancelOrder(LibOrder.Order memory order)
public
payable;
/// @dev Gets information about an order: status, hash, and amount filled.
/// @param order Order to gather information on.
/// @return OrderInfo Information about the order and its state.
/// See LibOrder.OrderInfo for a complete description.
function getOrderInfo(LibOrder.Order memory order)
public
view
returns (LibOrder.OrderInfo memory orderInfo);
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IProtocolFees.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract IProtocolFees {
// Logs updates to the protocol fee multiplier.
event ProtocolFeeMultiplier(uint256 oldProtocolFeeMultiplier, uint256 updatedProtocolFeeMultiplier);
// Logs updates to the protocolFeeCollector address.
event ProtocolFeeCollectorAddress(address oldProtocolFeeCollector, address updatedProtocolFeeCollector);
/// @dev Allows the owner to update the protocol fee multiplier.
/// @param updatedProtocolFeeMultiplier The updated protocol fee multiplier.
function setProtocolFeeMultiplier(uint256 updatedProtocolFeeMultiplier)
external;
/// @dev Allows the owner to update the protocolFeeCollector address.
/// @param updatedProtocolFeeCollector The updated protocolFeeCollector contract address.
function setProtocolFeeCollectorAddress(address updatedProtocolFeeCollector)
external;
/// @dev Returns the protocolFeeMultiplier
function protocolFeeMultiplier()
external
view
returns (uint256);
/// @dev Returns the protocolFeeCollector address
function protocolFeeCollector()
external
view
returns (address);
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IMatchOrders.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract IMatchOrders {
/// @dev Match complementary orders that have a profitable spread.
/// Each order is filled at their respective price point, and
/// the matcher receives a profit denominated in the left maker asset.
/// @param leftOrders Set of orders with the same maker / taker asset.
/// @param rightOrders Set of orders to match against `leftOrders`
/// @param leftSignatures Proof that left orders were created by the left makers.
/// @param rightSignatures Proof that right orders were created by the right makers.
/// @return batchMatchedFillResults Amounts filled and profit generated.
function batchMatchOrders(
LibOrder.Order[] memory leftOrders,
LibOrder.Order[] memory rightOrders,
bytes[] memory leftSignatures,
bytes[] memory rightSignatures
)
public
payable
returns (LibFillResults.BatchMatchedFillResults memory batchMatchedFillResults);
/// @dev Match complementary orders that have a profitable spread.
/// Each order is maximally filled at their respective price point, and
/// the matcher receives a profit denominated in either the left maker asset,
/// right maker asset, or a combination of both.
/// @param leftOrders Set of orders with the same maker / taker asset.
/// @param rightOrders Set of orders to match against `leftOrders`
/// @param leftSignatures Proof that left orders were created by the left makers.
/// @param rightSignatures Proof that right orders were created by the right makers.
/// @return batchMatchedFillResults Amounts filled and profit generated.
function batchMatchOrdersWithMaximalFill(
LibOrder.Order[] memory leftOrders,
LibOrder.Order[] memory rightOrders,
bytes[] memory leftSignatures,
bytes[] memory rightSignatures
)
public
payable
returns (LibFillResults.BatchMatchedFillResults memory batchMatchedFillResults);
/// @dev Match two complementary orders that have a profitable spread.
/// Each order is filled at their respective price point. However, the calculations are
/// carried out as though the orders are both being filled at the right order's price point.
/// The profit made by the left order goes to the taker (who matched the two orders).
/// @param leftOrder First order to match.
/// @param rightOrder Second order to match.
/// @param leftSignature Proof that order was created by the left maker.
/// @param rightSignature Proof that order was created by the right maker.
/// @return matchedFillResults Amounts filled and fees paid by maker and taker of matched orders.
function matchOrders(
LibOrder.Order memory leftOrder,
LibOrder.Order memory rightOrder,
bytes memory leftSignature,
bytes memory rightSignature
)
public
payable
returns (LibFillResults.MatchedFillResults memory matchedFillResults);
/// @dev Match two complementary orders that have a profitable spread.
/// Each order is maximally filled at their respective price point, and
/// the matcher receives a profit denominated in either the left maker asset,
/// right maker asset, or a combination of both.
/// @param leftOrder First order to match.
/// @param rightOrder Second order to match.
/// @param leftSignature Proof that order was created by the left maker.
/// @param rightSignature Proof that order was created by the right maker.
/// @return matchedFillResults Amounts filled by maker and taker of matched orders.
function matchOrdersWithMaximalFill(
LibOrder.Order memory leftOrder,
LibOrder.Order memory rightOrder,
bytes memory leftSignature,
bytes memory rightSignature
)
public
payable
returns (LibFillResults.MatchedFillResults memory matchedFillResults);
}
// File: @0x/contracts-exchange-libs/contracts/src/LibZeroExTransaction.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibZeroExTransaction {
using LibZeroExTransaction for ZeroExTransaction;
// Hash for the EIP712 0x transaction schema
// keccak256(abi.encodePacked(
// "ZeroExTransaction(",
// "uint256 salt,",
// "uint256 expirationTimeSeconds,",
// "uint256 gasPrice,",
// "address signerAddress,",
// "bytes data",
// ")"
// ));
bytes32 constant internal _EIP712_ZEROEX_TRANSACTION_SCHEMA_HASH = 0xec69816980a3a3ca4554410e60253953e9ff375ba4536a98adfa15cc71541508;
struct ZeroExTransaction {
uint256 salt; // Arbitrary number to ensure uniqueness of transaction hash.
uint256 expirationTimeSeconds; // Timestamp in seconds at which transaction expires.
uint256 gasPrice; // gasPrice that transaction is required to be executed with.
address signerAddress; // Address of transaction signer.
bytes data; // AbiV2 encoded calldata.
}
/// @dev Calculates the EIP712 typed data hash of a transaction with a given domain separator.
/// @param transaction 0x transaction structure.
/// @return EIP712 typed data hash of the transaction.
function getTypedDataHash(ZeroExTransaction memory transaction, bytes32 eip712ExchangeDomainHash)
internal
pure
returns (bytes32 transactionHash)
{
// Hash the transaction with the domain separator of the Exchange contract.
transactionHash = LibEIP712.hashEIP712Message(
eip712ExchangeDomainHash,
transaction.getStructHash()
);
return transactionHash;
}
/// @dev Calculates EIP712 hash of the 0x transaction struct.
/// @param transaction 0x transaction structure.
/// @return EIP712 hash of the transaction struct.
function getStructHash(ZeroExTransaction memory transaction)
internal
pure
returns (bytes32 result)
{
bytes32 schemaHash = _EIP712_ZEROEX_TRANSACTION_SCHEMA_HASH;
bytes memory data = transaction.data;
uint256 salt = transaction.salt;
uint256 expirationTimeSeconds = transaction.expirationTimeSeconds;
uint256 gasPrice = transaction.gasPrice;
address signerAddress = transaction.signerAddress;
// Assembly for more efficiently computing:
// result = keccak256(abi.encodePacked(
// schemaHash,
// salt,
// expirationTimeSeconds,
// gasPrice,
// uint256(signerAddress),
// keccak256(data)
// ));
assembly {
// Compute hash of data
let dataHash := keccak256(add(data, 32), mload(data))
// Load free memory pointer
let memPtr := mload(64)
mstore(memPtr, schemaHash) // hash of schema
mstore(add(memPtr, 32), salt) // salt
mstore(add(memPtr, 64), expirationTimeSeconds) // expirationTimeSeconds
mstore(add(memPtr, 96), gasPrice) // gasPrice
mstore(add(memPtr, 128), and(signerAddress, 0xffffffffffffffffffffffffffffffffffffffff)) // signerAddress
mstore(add(memPtr, 160), dataHash) // hash of data
// Compute hash
result := keccak256(memPtr, 192)
}
return result;
}
}
// File: @0x/contracts-exchange/contracts/src/interfaces/ISignatureValidator.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract ISignatureValidator {
// Allowed signature types.
enum SignatureType {
Illegal, // 0x00, default value
Invalid, // 0x01
EIP712, // 0x02
EthSign, // 0x03
Wallet, // 0x04
Validator, // 0x05
PreSigned, // 0x06
EIP1271Wallet, // 0x07
NSignatureTypes // 0x08, number of signature types. Always leave at end.
}
event SignatureValidatorApproval(
address indexed signerAddress, // Address that approves or disapproves a contract to verify signatures.
address indexed validatorAddress, // Address of signature validator contract.
bool isApproved // Approval or disapproval of validator contract.
);
/// @dev Approves a hash on-chain.
/// After presigning a hash, the preSign signature type will become valid for that hash and signer.
/// @param hash Any 32-byte hash.
function preSign(bytes32 hash)
external
payable;
/// @dev Approves/unnapproves a Validator contract to verify signatures on signer's behalf.
/// @param validatorAddress Address of Validator contract.
/// @param approval Approval or disapproval of Validator contract.
function setSignatureValidatorApproval(
address validatorAddress,
bool approval
)
external
payable;
/// @dev Verifies that a hash has been signed by the given signer.
/// @param hash Any 32-byte hash.
/// @param signature Proof that the hash has been signed by signer.
/// @return isValid `true` if the signature is valid for the given hash and signer.
function isValidHashSignature(
bytes32 hash,
address signerAddress,
bytes memory signature
)
public
view
returns (bool isValid);
/// @dev Verifies that a signature for an order is valid.
/// @param order The order.
/// @param signature Proof that the order has been signed by signer.
/// @return isValid true if the signature is valid for the given order and signer.
function isValidOrderSignature(
LibOrder.Order memory order,
bytes memory signature
)
public
view
returns (bool isValid);
/// @dev Verifies that a signature for a transaction is valid.
/// @param transaction The transaction.
/// @param signature Proof that the order has been signed by signer.
/// @return isValid true if the signature is valid for the given transaction and signer.
function isValidTransactionSignature(
LibZeroExTransaction.ZeroExTransaction memory transaction,
bytes memory signature
)
public
view
returns (bool isValid);
/// @dev Verifies that an order, with provided order hash, has been signed
/// by the given signer.
/// @param order The order.
/// @param orderHash The hash of the order.
/// @param signature Proof that the hash has been signed by signer.
/// @return isValid True if the signature is valid for the given order and signer.
function _isValidOrderWithHashSignature(
LibOrder.Order memory order,
bytes32 orderHash,
bytes memory signature
)
internal
view
returns (bool isValid);
/// @dev Verifies that a transaction, with provided order hash, has been signed
/// by the given signer.
/// @param transaction The transaction.
/// @param transactionHash The hash of the transaction.
/// @param signature Proof that the hash has been signed by signer.
/// @return isValid True if the signature is valid for the given transaction and signer.
function _isValidTransactionWithHashSignature(
LibZeroExTransaction.ZeroExTransaction memory transaction,
bytes32 transactionHash,
bytes memory signature
)
internal
view
returns (bool isValid);
}
// File: @0x/contracts-exchange/contracts/src/interfaces/ITransactions.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract ITransactions {
// TransactionExecution event is emitted when a ZeroExTransaction is executed.
event TransactionExecution(bytes32 indexed transactionHash);
/// @dev Executes an Exchange method call in the context of signer.
/// @param transaction 0x transaction containing salt, signerAddress, and data.
/// @param signature Proof that transaction has been signed by signer.
/// @return ABI encoded return data of the underlying Exchange function call.
function executeTransaction(
LibZeroExTransaction.ZeroExTransaction memory transaction,
bytes memory signature
)
public
payable
returns (bytes memory);
/// @dev Executes a batch of Exchange method calls in the context of signer(s).
/// @param transactions Array of 0x transactions containing salt, signerAddress, and data.
/// @param signatures Array of proofs that transactions have been signed by signer(s).
/// @return Array containing ABI encoded return data for each of the underlying Exchange function calls.
function batchExecuteTransactions(
LibZeroExTransaction.ZeroExTransaction[] memory transactions,
bytes[] memory signatures
)
public
payable
returns (bytes[] memory);
/// @dev The current function will be called in the context of this address (either 0x transaction signer or `msg.sender`).
/// If calling a fill function, this address will represent the taker.
/// If calling a cancel function, this address will represent the maker.
/// @return Signer of 0x transaction if entry point is `executeTransaction`.
/// `msg.sender` if entry point is any other function.
function _getCurrentContextAddress()
internal
view
returns (address);
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IAssetProxyDispatcher.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract IAssetProxyDispatcher {
// Logs registration of new asset proxy
event AssetProxyRegistered(
bytes4 id, // Id of new registered AssetProxy.
address assetProxy // Address of new registered AssetProxy.
);
/// @dev Registers an asset proxy to its asset proxy id.
/// Once an asset proxy is registered, it cannot be unregistered.
/// @param assetProxy Address of new asset proxy to register.
function registerAssetProxy(address assetProxy)
external;
/// @dev Gets an asset proxy.
/// @param assetProxyId Id of the asset proxy.
/// @return The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered.
function getAssetProxy(bytes4 assetProxyId)
external
view
returns (address);
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IWrapperFunctions.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract IWrapperFunctions {
/// @dev Fills the input order. Reverts if exact takerAssetFillAmount not filled.
/// @param order Order struct containing order specifications.
/// @param takerAssetFillAmount Desired amount of takerAsset to sell.
/// @param signature Proof that order has been created by maker.
function fillOrKillOrder(
LibOrder.Order memory order,
uint256 takerAssetFillAmount,
bytes memory signature
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev Executes multiple calls of fillOrder.
/// @param orders Array of order specifications.
/// @param takerAssetFillAmounts Array of desired amounts of takerAsset to sell in orders.
/// @param signatures Proofs that orders have been created by makers.
/// @return Array of amounts filled and fees paid by makers and taker.
function batchFillOrders(
LibOrder.Order[] memory orders,
uint256[] memory takerAssetFillAmounts,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults[] memory fillResults);
/// @dev Executes multiple calls of fillOrKillOrder.
/// @param orders Array of order specifications.
/// @param takerAssetFillAmounts Array of desired amounts of takerAsset to sell in orders.
/// @param signatures Proofs that orders have been created by makers.
/// @return Array of amounts filled and fees paid by makers and taker.
function batchFillOrKillOrders(
LibOrder.Order[] memory orders,
uint256[] memory takerAssetFillAmounts,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults[] memory fillResults);
/// @dev Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored.
/// @param orders Array of order specifications.
/// @param takerAssetFillAmounts Array of desired amounts of takerAsset to sell in orders.
/// @param signatures Proofs that orders have been created by makers.
/// @return Array of amounts filled and fees paid by makers and taker.
function batchFillOrdersNoThrow(
LibOrder.Order[] memory orders,
uint256[] memory takerAssetFillAmounts,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults[] memory fillResults);
/// @dev Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker.
/// If any fill reverts, the error is caught and ignored.
/// NOTE: This function does not enforce that the takerAsset is the same for each order.
/// @param orders Array of order specifications.
/// @param takerAssetFillAmount Desired amount of takerAsset to sell.
/// @param signatures Proofs that orders have been signed by makers.
/// @return Amounts filled and fees paid by makers and taker.
function marketSellOrdersNoThrow(
LibOrder.Order[] memory orders,
uint256 takerAssetFillAmount,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker.
/// If any fill reverts, the error is caught and ignored.
/// NOTE: This function does not enforce that the makerAsset is the same for each order.
/// @param orders Array of order specifications.
/// @param makerAssetFillAmount Desired amount of makerAsset to buy.
/// @param signatures Proofs that orders have been signed by makers.
/// @return Amounts filled and fees paid by makers and taker.
function marketBuyOrdersNoThrow(
LibOrder.Order[] memory orders,
uint256 makerAssetFillAmount,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold.
/// NOTE: This function does not enforce that the takerAsset is the same for each order.
/// @param orders Array of order specifications.
/// @param takerAssetFillAmount Minimum amount of takerAsset to sell.
/// @param signatures Proofs that orders have been signed by makers.
/// @return Amounts filled and fees paid by makers and taker.
function marketSellOrdersFillOrKill(
LibOrder.Order[] memory orders,
uint256 takerAssetFillAmount,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought.
/// NOTE: This function does not enforce that the makerAsset is the same for each order.
/// @param orders Array of order specifications.
/// @param makerAssetFillAmount Minimum amount of makerAsset to buy.
/// @param signatures Proofs that orders have been signed by makers.
/// @return Amounts filled and fees paid by makers and taker.
function marketBuyOrdersFillOrKill(
LibOrder.Order[] memory orders,
uint256 makerAssetFillAmount,
bytes[] memory signatures
)
public
payable
returns (LibFillResults.FillResults memory fillResults);
/// @dev Executes multiple calls of cancelOrder.
/// @param orders Array of order specifications.
function batchCancelOrders(LibOrder.Order[] memory orders)
public
payable;
}
// File: @0x/contracts-exchange/contracts/src/interfaces/ITransferSimulator.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
contract ITransferSimulator {
/// @dev This function may be used to simulate any amount of transfers
/// As they would occur through the Exchange contract. Note that this function
/// will always revert, even if all transfers are successful. However, it may
/// be used with eth_call or with a try/catch pattern in order to simulate
/// the results of the transfers.
/// @param assetData Array of asset details, each encoded per the AssetProxy contract specification.
/// @param fromAddresses Array containing the `from` addresses that correspond with each transfer.
/// @param toAddresses Array containing the `to` addresses that correspond with each transfer.
/// @param amounts Array containing the amounts that correspond to each transfer.
/// @return This function does not return a value. However, it will always revert with
/// `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful.
function simulateDispatchTransferFromCalls(
bytes[] memory assetData,
address[] memory fromAddresses,
address[] memory toAddresses,
uint256[] memory amounts
)
public;
}
// File: @0x/contracts-exchange/contracts/src/interfaces/IExchange.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
// solhint-disable no-empty-blocks
contract IExchange is
IProtocolFees,
IExchangeCore,
IMatchOrders,
ISignatureValidator,
ITransactions,
IAssetProxyDispatcher,
ITransferSimulator,
IWrapperFunctions
{}
// File: @0x/contracts-utils/contracts/src/LibBytesRichErrors.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibBytesRichErrors {
enum InvalidByteOperationErrorCodes {
FromLessThanOrEqualsToRequired,
ToLessThanOrEqualsLengthRequired,
LengthGreaterThanZeroRequired,
LengthGreaterThanOrEqualsFourRequired,
LengthGreaterThanOrEqualsTwentyRequired,
LengthGreaterThanOrEqualsThirtyTwoRequired,
LengthGreaterThanOrEqualsNestedBytesLengthRequired,
DestinationLengthGreaterThanOrEqualSourceLengthRequired
}
// bytes4(keccak256("InvalidByteOperationError(uint8,uint256,uint256)"))
bytes4 internal constant INVALID_BYTE_OPERATION_ERROR_SELECTOR =
0x28006595;
// solhint-disable func-name-mixedcase
function InvalidByteOperationError(
InvalidByteOperationErrorCodes errorCode,
uint256 offset,
uint256 required
)
internal
pure
returns (bytes memory)
{
return abi.encodeWithSelector(
INVALID_BYTE_OPERATION_ERROR_SELECTOR,
errorCode,
offset,
required
);
}
}
// File: @0x/contracts-utils/contracts/src/LibBytes.sol
/*
Copyright 2019 ZeroEx Intl.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
pragma solidity ^0.5.9;
library LibBytes {
using LibBytes for bytes;
/// @dev Gets the memory address for a byte array.
/// @param input Byte array to lookup.
/// @return memoryAddress Memory address of byte array. This
/// points to the header of the byte array which contains
/// the length.
function rawAddress(bytes memory input)
internal
pure
returns (uint256 memoryAddress)
{
assembly {
memoryAddress := input
}
return memoryAddress;
}
/// @dev Gets the memory address for the contents of a byte array.
/// @param input Byte array to lookup.
/// @return memoryAddress Memory address of the contents of the byte array.
function contentAddress(bytes memory input)
internal
pure
returns (uint256 memoryAddress)
{
assembly {
memoryAddress := add(input, 32)
}
return memoryAddress;
}
/// @dev Copies `length` bytes from memory location `source` to `dest`.
/// @param dest memory address to copy bytes to.
/// @param source memory address to copy bytes from.
/// @param length number of bytes to copy.
function memCopy(
uint256 dest,
uint256 source,
uint256 length
)
internal
pure
{
if (length < 32) {
// Handle a partial word by reading destination and masking
// off the bits we are interested in.
// This correctly handles overlap, zero lengths and source == dest
assembly {
let mask := sub(exp(256, sub(32, length)), 1)
let s := and(mload(source), not(mask))
let d := and(mload(dest), mask)
mstore(dest, or(s, d))
}
} else {
// Skip the O(length) loop when source == dest.
if (source == dest) {
return;
}
// For large copies we copy whole words at a time. The final
// word is aligned to the end of the range (instead of after the
// previous) to handle partial words. So a copy will look like this:
//
// ####
// ####
// ####
// ####
//
// We handle overlap in the source and destination range by
// changing the copying direction. This prevents us from
// overwriting parts of source that we still need to copy.
//
// This correctly handles source == dest
//
if (source > dest) {
assembly {
// We subtract 32 from `sEnd` and `dEnd` because it
// is easier to compare with in the loop, and these
// are also the addresses we need for copying the
// last bytes.
length := sub(length, 32)
let sEnd := add(source, length)
let dEnd := add(dest, length)
// Remember the last 32 bytes of source
// This needs to be done here and not after the loop
// because we may have overwritten the last bytes in
// source already due to overlap.
let last := mload(sEnd)
// Copy whole words front to back
// Note: the first check is always true,
// this could have been a do-while loop.
// solhint-disable-next-line no-empty-blocks
for {} lt(source, sEnd) {} {
mstore(dest, mload(source))
source := add(source, 32)
dest := add(dest, 32)
}
// Write the last 32 bytes
mstore(dEnd, last)
}
} else {
assembly {
// We subtract 32 from `sEnd` and `dEnd` because those
// are the starting points when copying a word at the end.
length := sub(length, 32)
let sEnd := add(source, length)
let dEnd := add(dest, length)
// Remember the first 32 bytes of source
// This needs to be done here and not after the loop
// because we may have overwritten the first bytes in
// source already due to overlap.
let first := mload(source)
// Copy whole words back to front
// We use a signed comparisson here to allow dEnd to become
// negative (happens when source and dest < 32). Valid
// addresses in local memory will never be larger than
// 2**255, so they can be safely re-interpreted as signed.
// Note: the first check is always true,
// this could have been a do-while loop.
// solhint-disable-next-line no-empty-blocks
for {} slt(dest, dEnd) {} {
mstore(dEnd, mload(sEnd))
sEnd := sub(sEnd, 32)
dEnd := sub(dEnd, 32)
}
// Write the first 32 bytes
mstore(dest, first)
}
}
}
}
/// @dev Returns a slices from a byte array.
/// @param b The byte array to take a slice from.
/// @param from The starting index for the slice (inclusive).
/// @param to The final index for the slice (exclusive).
/// @return result The slice containing bytes at indices [from, to)
function slice(
bytes memory b,
uint256 from,
uint256 to
)
internal
pure
returns (bytes memory result)
{
// Ensure that the from and to positions are valid positions for a slice within
// the byte array that is being used.
if (from > to) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.FromLessThanOrEqualsToRequired,
from,
to
));
}
if (to > b.length) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.ToLessThanOrEqualsLengthRequired,
to,
b.length
));
}
// Create a new bytes structure and copy contents
result = new bytes(to - from);
memCopy(
result.contentAddress(),
b.contentAddress() + from,
result.length
);
return result;
}
/// @dev Returns a slice from a byte array without preserving the input.
/// @param b The byte array to take a slice from. Will be destroyed in the process.
/// @param from The starting index for the slice (inclusive).
/// @param to The final index for the slice (exclusive).
/// @return result The slice containing bytes at indices [from, to)
/// @dev When `from == 0`, the original array will match the slice. In other cases its state will be corrupted.
function sliceDestructive(
bytes memory b,
uint256 from,
uint256 to
)
internal
pure
returns (bytes memory result)
{
// Ensure that the from and to positions are valid positions for a slice within
// the byte array that is being used.
if (from > to) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.FromLessThanOrEqualsToRequired,
from,
to
));
}
if (to > b.length) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.ToLessThanOrEqualsLengthRequired,
to,
b.length
));
}
// Create a new bytes structure around [from, to) in-place.
assembly {
result := add(b, from)
mstore(result, sub(to, from))
}
return result;
}
/// @dev Pops the last byte off of a byte array by modifying its length.
/// @param b Byte array that will be modified.
/// @return The byte that was popped off.
function popLastByte(bytes memory b)
internal
pure
returns (bytes1 result)
{
if (b.length == 0) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanZeroRequired,
b.length,
0
));
}
// Store last byte.
result = b[b.length - 1];
assembly {
// Decrement length of byte array.
let newLen := sub(mload(b), 1)
mstore(b, newLen)
}
return result;
}
/// @dev Tests equality of two byte arrays.
/// @param lhs First byte array to compare.
/// @param rhs Second byte array to compare.
/// @return True if arrays are the same. False otherwise.
function equals(
bytes memory lhs,
bytes memory rhs
)
internal
pure
returns (bool equal)
{
// Keccak gas cost is 30 + numWords * 6. This is a cheap way to compare.
// We early exit on unequal lengths, but keccak would also correctly
// handle this.
return lhs.length == rhs.length && keccak256(lhs) == keccak256(rhs);
}
/// @dev Reads an address from a position in a byte array.
/// @param b Byte array containing an address.
/// @param index Index in byte array of address.
/// @return address from byte array.
function readAddress(
bytes memory b,
uint256 index
)
internal
pure
returns (address result)
{
if (b.length < index + 20) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanOrEqualsTwentyRequired,
b.length,
index + 20 // 20 is length of address
));
}
// Add offset to index:
// 1. Arrays are prefixed by 32-byte length parameter (add 32 to index)
// 2. Account for size difference between address length and 32-byte storage word (subtract 12 from index)
index += 20;
// Read address from array memory
assembly {
// 1. Add index to address of bytes array
// 2. Load 32-byte word from memory
// 3. Apply 20-byte mask to obtain address
result := and(mload(add(b, index)), 0xffffffffffffffffffffffffffffffffffffffff)
}
return result;
}
/// @dev Writes an address into a specific position in a byte array.
/// @param b Byte array to insert address into.
/// @param index Index in byte array of address.
/// @param input Address to put into byte array.
function writeAddress(
bytes memory b,
uint256 index,
address input
)
internal
pure
{
if (b.length < index + 20) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanOrEqualsTwentyRequired,
b.length,
index + 20 // 20 is length of address
));
}
// Add offset to index:
// 1. Arrays are prefixed by 32-byte length parameter (add 32 to index)
// 2. Account for size difference between address length and 32-byte storage word (subtract 12 from index)
index += 20;
// Store address into array memory
assembly {
// The address occupies 20 bytes and mstore stores 32 bytes.
// First fetch the 32-byte word where we'll be storing the address, then
// apply a mask so we have only the bytes in the word that the address will not occupy.
// Then combine these bytes with the address and store the 32 bytes back to memory with mstore.
// 1. Add index to address of bytes array
// 2. Load 32-byte word from memory
// 3. Apply 12-byte mask to obtain extra bytes occupying word of memory where we'll store the address
let neighbors := and(
mload(add(b, index)),
0xffffffffffffffffffffffff0000000000000000000000000000000000000000
)
// Make sure input address is clean.
// (Solidity does not guarantee this)
input := and(input, 0xffffffffffffffffffffffffffffffffffffffff)
// Store the neighbors and address into memory
mstore(add(b, index), xor(input, neighbors))
}
}
/// @dev Reads a bytes32 value from a position in a byte array.
/// @param b Byte array containing a bytes32 value.
/// @param index Index in byte array of bytes32 value.
/// @return bytes32 value from byte array.
function readBytes32(
bytes memory b,
uint256 index
)
internal
pure
returns (bytes32 result)
{
if (b.length < index + 32) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanOrEqualsThirtyTwoRequired,
b.length,
index + 32
));
}
// Arrays are prefixed by a 256 bit length parameter
index += 32;
// Read the bytes32 from array memory
assembly {
result := mload(add(b, index))
}
return result;
}
/// @dev Writes a bytes32 into a specific position in a byte array.
/// @param b Byte array to insert <input> into.
/// @param index Index in byte array of <input>.
/// @param input bytes32 to put into byte array.
function writeBytes32(
bytes memory b,
uint256 index,
bytes32 input
)
internal
pure
{
if (b.length < index + 32) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanOrEqualsThirtyTwoRequired,
b.length,
index + 32
));
}
// Arrays are prefixed by a 256 bit length parameter
index += 32;
// Read the bytes32 from array memory
assembly {
mstore(add(b, index), input)
}
}
/// @dev Reads a uint256 value from a position in a byte array.
/// @param b Byte array containing a uint256 value.
/// @param index Index in byte array of uint256 value.
/// @return uint256 value from byte array.
function readUint256(
bytes memory b,
uint256 index
)
internal
pure
returns (uint256 result)
{
result = uint256(readBytes32(b, index));
return result;
}
/// @dev Writes a uint256 into a specific position in a byte array.
/// @param b Byte array to insert <input> into.
/// @param index Index in byte array of <input>.
/// @param input uint256 to put into byte array.
function writeUint256(
bytes memory b,
uint256 index,
uint256 input
)
internal
pure
{
writeBytes32(b, index, bytes32(input));
}
/// @dev Reads an unpadded bytes4 value from a position in a byte array.
/// @param b Byte array containing a bytes4 value.
/// @param index Index in byte array of bytes4 value.
/// @return bytes4 value from byte array.
function readBytes4(
bytes memory b,
uint256 index
)
internal
pure
returns (bytes4 result)
{
if (b.length < index + 4) {
LibRichErrors.rrevert(LibBytesRichErrors.InvalidByteOperationError(
LibBytesRichErrors.InvalidByteOperationErrorCodes.LengthGreaterThanOrEqualsFourRequired,
b.length,
index + 4
));
}
// Arrays are prefixed by a 32 byte length field
index += 32;
// Read the bytes4 from array memory
assembly {
result := mload(add(b, index))
// Solidity does not require us to clean the trailing bytes.
// We do it anyway
result := and(result, 0xFFFFFFFF00000000000000000000000000000000000000000000000000000000)
}
return result;
}
/// @dev Writes a new length to a byte array.
/// Decreasing length will lead to removing the corresponding lower order bytes from the byte array.
/// Increasing length may lead to appending adjacent in-memory bytes to the end of the byte array.
/// @param b Bytes array to write new length to.
/// @param length New length of byte array.
function writeLength(bytes memory b, uint256 length)
internal
pure
{
assembly {
mstore(b, length)
}
}
}
// File: contracts/lib/exchanges/ZeroExExchangeController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title ZeroExExchangeController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles exchanges via 0x.
*/
library ZeroExExchangeController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
using LibBytes for bytes;
/**
* @dev 0x v3 Exchange contract address.
*/
address constant private EXCHANGE_CONTRACT = 0x61935CbDd02287B511119DDb11Aeb42F1593b7Ef;
/**
* @dev 0x v3 Exchange contract object.
*/
IExchange constant private _exchange = IExchange(EXCHANGE_CONTRACT);
/**
* @dev 0x v3 ERC20Proxy contract address.
*/
address constant private ERC20_PROXY_CONTRACT = 0x95E6F48254609A6ee006F7D493c8e5fB97094ceF;
/**
* @dev Decodes ERC20 or ERC20Bridge asset data.
* @param assetData The ERC20 or ERC20Bridge asset data.
* @return The asset token address.
*/
function decodeTokenAddress(bytes calldata assetData) external pure returns (address) {
bytes4 assetProxyId = assetData.readBytes4(0);
if (assetProxyId == 0xf47261b0 || assetProxyId == 0xdc1600f3) return assetData.readAddress(16);
revert("Invalid asset proxy ID.");
}
/**
* @dev Gets allowance of the specified token to 0x.
* @param erc20Contract The ERC20 contract address of the token.
*/
function allowance(address erc20Contract) external view returns (uint256) {
return IERC20(erc20Contract).allowance(address(this), ERC20_PROXY_CONTRACT);
}
/**
* @dev Approves tokens to 0x without spending gas on every deposit.
* @param erc20Contract The ERC20 contract address of the token.
* @param amount Amount of the specified token to approve to dYdX.
*/
function approve(address erc20Contract, uint256 amount) external {
IERC20 token = IERC20(erc20Contract);
uint256 _allowance = token.allowance(address(this), ERC20_PROXY_CONTRACT);
if (_allowance == amount) return;
if (amount > 0 && _allowance > 0) token.safeApprove(ERC20_PROXY_CONTRACT, 0);
token.safeApprove(ERC20_PROXY_CONTRACT, amount);
return;
}
/**
* @dev Market sells to 0x exchange orders up to a certain amount of input.
* @param orders The limit orders to be filled in ascending order of price.
* @param signatures The signatures for the orders.
* @param takerAssetFillAmount The amount of the taker asset to sell (excluding taker fees).
* @param protocolFee The protocol fee in ETH to pay to 0x.
* @return Array containing the taker asset filled amount (sold) and maker asset filled amount (bought).
*/
function marketSellOrdersFillOrKill(LibOrder.Order[] memory orders, bytes[] memory signatures, uint256 takerAssetFillAmount, uint256 protocolFee) public returns (uint256[2] memory) {
require(orders.length > 0, "At least one order and matching signature is required.");
require(orders.length == signatures.length, "Mismatch between number of orders and signatures.");
require(takerAssetFillAmount > 0, "Taker asset fill amount must be greater than 0.");
LibFillResults.FillResults memory fillResults = _exchange.marketSellOrdersFillOrKill.value(protocolFee)(orders, takerAssetFillAmount, signatures);
return [fillResults.takerAssetFilledAmount, fillResults.makerAssetFilledAmount];
}
/**
* @dev Market buys from 0x exchange orders up to a certain amount of output.
* @param orders The limit orders to be filled in ascending order of price.
* @param signatures The signatures for the orders.
* @param makerAssetFillAmount The amount of the maker asset to buy.
* @param protocolFee The protocol fee in ETH to pay to 0x.
* @return Array containing the taker asset filled amount (sold) and maker asset filled amount (bought).
*/
function marketBuyOrdersFillOrKill(LibOrder.Order[] memory orders, bytes[] memory signatures, uint256 makerAssetFillAmount, uint256 protocolFee) public returns (uint256[2] memory) {
require(orders.length > 0, "At least one order and matching signature is required.");
require(orders.length == signatures.length, "Mismatch between number of orders and signatures.");
require(makerAssetFillAmount > 0, "Maker asset fill amount must be greater than 0.");
LibFillResults.FillResults memory fillResults = _exchange.marketBuyOrdersFillOrKill.value(protocolFee)(orders, makerAssetFillAmount, signatures);
return [fillResults.takerAssetFilledAmount, fillResults.makerAssetFilledAmount];
}
}
// File: contracts/external/mstable/IMasset.sol
pragma solidity 0.5.17;
/**
* @title IMasset
* @dev (Internal) Interface for interacting with Masset
* VERSION: 1.0
* DATE: 2020-05-05
*/
interface IMasset {
function mint(address _basset, uint256 _bassetQuantity) external returns (uint256 massetMinted);
function redeem(address _basset, uint256 _bassetQuantity) external returns (uint256 massetRedeemed);
function swap(address _input, address _output, uint256 _quantity, address _recipient) external returns (uint256 output);
function swapFee() external view returns (uint256);
}
// File: contracts/lib/exchanges/MStableExchangeController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title MStableExchangeController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @dev This library handles minting and redeeming of mStable's mUSD token.
*/
library MStableExchangeController {
using SafeMath for uint256;
using SafeERC20 for IERC20;
address constant private MUSD_TOKEN_CONTRACT = 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5;
IMasset constant private _mUsdToken = IMasset(MUSD_TOKEN_CONTRACT);
/**
* @dev Returns the mUSD swap fee (scaled by 1e18).
*/
function getSwapFee() external view returns (uint256) {
return _mUsdToken.swapFee();
}
/**
* @dev Approves tokens to the mUSD token contract without spending gas on every deposit.
* @param erc20Contract The ERC20 contract address of the token.
* @param amount Amount of the specified token to approve to the mUSD token contract.
*/
function approve(address erc20Contract, uint256 amount) external {
IERC20 token = IERC20(erc20Contract);
uint256 allowance = token.allowance(address(this), MUSD_TOKEN_CONTRACT);
if (allowance == amount) return;
if (amount > 0 && allowance > 0) token.safeApprove(MUSD_TOKEN_CONTRACT, 0);
token.safeApprove(MUSD_TOKEN_CONTRACT, amount);
return;
}
/**
* @dev Mints mUSD tokens in exchange for the specified amount of the specified token.
* @param erc20Contract The ERC20 contract address of the token to be exchanged.
* @param inputAmount The amount of input tokens to be exchanged for mUSD.
* @return The amount of mUSD tokens minted.
*/
function mint(address erc20Contract, uint256 inputAmount) external returns (uint256) {
require(inputAmount > 0, "Input amount must be greater than 0.");
uint256 mAssetMinted = _mUsdToken.mint(erc20Contract, inputAmount);
require(mAssetMinted > 0, "Error calling mint on mStable mUSD token: no mUSD minted.");
return mAssetMinted;
}
/**
* @dev Redeems mUSD tokens in exchange for the specified amount of the specified token.
* @param erc20Contract The ERC20 contract address of the token to be withdrawn.
* @param outputAmount The amount of output tokens to be exchanged from mUSD.
* @return The amount of mUSD tokens redeemed.
*/
function redeem(address erc20Contract, uint256 outputAmount) external returns (uint256) {
require(outputAmount > 0, "Output amount must be greater than 0.");
uint256 mAssetRedeemed = _mUsdToken.redeem(erc20Contract, outputAmount);
require(mAssetRedeemed > 0, "Error calling redeem on mStable mUSD token: no mUSD redeemed.");
return mAssetRedeemed;
}
/**
* @dev Redeems mUSD tokens in exchange for the specified amount of the specified token.
* @param inputErc20Contract The ERC20 contract address of the token to be exchanged for mUSD.
* @param outputErc20Contract The ERC20 contract address of the token to be exchanged from mUSD.
* @param inputAmount The amount of input tokens to be exchanged for mUSD.
* @return The amount of output tokens.
*/
function swap(address inputErc20Contract, address outputErc20Contract, uint256 inputAmount) external returns (uint256) {
require(inputAmount > 0, "Input amount must be greater than 0.");
uint256 outputAmount = _mUsdToken.swap(inputErc20Contract, outputErc20Contract, inputAmount, address(this));
require(outputAmount > 0, "Error calling redeem on mStable mUSD token: output amount not greater than 0.");
return outputAmount;
}
}
// File: contracts/RariFundController.sol
/**
* COPYRIGHT © 2020 RARI CAPITAL, INC. ALL RIGHTS RESERVED.
* Anyone is free to integrate the public (i.e., non-administrative) application programming interfaces (APIs) of the official Ethereum smart contract instances deployed by Rari Capital, Inc. in any application (commercial or noncommercial and under any license), provided that the application does not abuse the APIs or act against the interests of Rari Capital, Inc.
* Anyone is free to study, review, and analyze the source code contained in this package.
* Reuse (including deployment of smart contracts other than private testing on a private network), modification, redistribution, or sublicensing of any source code contained in this package is not permitted without the explicit permission of David Lucid of Rari Capital, Inc.
* No one is permitted to use the software for any purpose other than those allowed by this license.
* This license is liable to change at any time at the sole discretion of David Lucid of Rari Capital, Inc.
*/
pragma solidity 0.5.17;
/**
* @title RariFundController
* @author David Lucid <david@rari.capital> (https://github.com/davidlucid)
* @notice This contract handles deposits to and withdrawals from the liquidity pools that power the Rari Stable Pool as well as currency exchanges via 0x.
*/
contract RariFundController is Ownable {
using SafeMath for uint256;
using SignedSafeMath for int256;
using SafeERC20 for IERC20;
/**
* @dev Boolean to be checked on `upgradeFundController`.
*/
bool public constant IS_RARI_FUND_CONTROLLER = true;
/**
* @dev Boolean that, if true, disables the primary functionality of this RariFundController.
*/
bool private _fundDisabled;
/**
* @dev Address of the RariFundManager.
*/
address private _rariFundManagerContract;
/**
* @dev Contract of the RariFundManager.
*/
RariFundManager public rariFundManager;
/**
* @dev Address of the rebalancer.
*/
address private _rariFundRebalancerAddress;
/**
* @dev Array of currencies supported by the fund.
*/
string[] private _supportedCurrencies;
/**
* @dev Maps `_supportedCurrencies` items to their indexes.
*/
mapping(string => uint8) private _currencyIndexes;
/**
* @dev Maps supported currency codes to their decimal precisions (number of digits after the decimal point).
*/
mapping(string => uint256) private _currencyDecimals;
/**
* @dev Maps supported currency codes to ERC20 token contract addresses.
*/
mapping(string => address) private _erc20Contracts;
/**
* @dev Enum for liqudity pools supported by Rari.
*/
enum LiquidityPool { dYdX, Compound, Aave, mStable }
/**
* @dev Maps currency codes to arrays of supported pools.
*/
mapping(string => LiquidityPool[]) private _poolsByCurrency;
/**
* @dev Constructor that sets supported ERC20 contract addresses and supported pools for each supported token.
*/
constructor () public {
// Initialize base contracts
Ownable.initialize(msg.sender);
// Add supported currencies
addSupportedCurrency("DAI", 0x6B175474E89094C44Da98b954EedeAC495271d0F, 18);
addPoolToCurrency("DAI", LiquidityPool.dYdX);
addPoolToCurrency("DAI", LiquidityPool.Compound);
addPoolToCurrency("DAI", LiquidityPool.Aave);
addSupportedCurrency("USDC", 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48, 6);
addPoolToCurrency("USDC", LiquidityPool.dYdX);
addPoolToCurrency("USDC", LiquidityPool.Compound);
addPoolToCurrency("USDC", LiquidityPool.Aave);
addSupportedCurrency("USDT", 0xdAC17F958D2ee523a2206206994597C13D831ec7, 6);
addPoolToCurrency("USDT", LiquidityPool.Compound);
addPoolToCurrency("USDT", LiquidityPool.Aave);
addSupportedCurrency("TUSD", 0x0000000000085d4780B73119b644AE5ecd22b376, 18);
addPoolToCurrency("TUSD", LiquidityPool.Aave);
addSupportedCurrency("BUSD", 0x4Fabb145d64652a948d72533023f6E7A623C7C53, 18);
addPoolToCurrency("BUSD", LiquidityPool.Aave);
addSupportedCurrency("sUSD", 0x57Ab1ec28D129707052df4dF418D58a2D46d5f51, 18);
addPoolToCurrency("sUSD", LiquidityPool.Aave);
addSupportedCurrency("mUSD", 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5, 18);
addPoolToCurrency("mUSD", LiquidityPool.mStable);
}
/**
* @dev Marks a token as supported by the fund and stores its decimal precision and ERC20 contract address.
* @param currencyCode The currency code of the token.
* @param erc20Contract The ERC20 contract address of the token.
* @param decimals The decimal precision (number of digits after the decimal point) of the token.
*/
function addSupportedCurrency(string memory currencyCode, address erc20Contract, uint256 decimals) internal {
_currencyIndexes[currencyCode] = uint8(_supportedCurrencies.length);
_supportedCurrencies.push(currencyCode);
_erc20Contracts[currencyCode] = erc20Contract;
_currencyDecimals[currencyCode] = decimals;
}
/**
* @dev Adds a supported pool for a token.
* @param currencyCode The currency code of the token.
* @param pool Pool ID to be supported.
*/
function addPoolToCurrency(string memory currencyCode, LiquidityPool pool) internal {
_poolsByCurrency[currencyCode].push(pool);
}
/**
* @dev Payable fallback function called by 0x Exchange v3 to refund unspent protocol fee.
*/
function () external payable {
require(msg.sender == 0x61935CbDd02287B511119DDb11Aeb42F1593b7Ef, "msg.sender is not 0x Exchange v3.");
}
/**
* @dev Sets or upgrades RariFundController by withdrawing all tokens from all pools and forwarding them from the old to the new.
* @param newContract The address of the new RariFundController contract.
*/
function upgradeFundController(address payable newContract) external onlyOwner {
require(RariFundController(newContract).IS_RARI_FUND_CONTROLLER(), "New contract does not have IS_RARI_FUND_CONTROLLER set to true.");
for (uint256 i = 0; i < _supportedCurrencies.length; i++) {
string memory currencyCode = _supportedCurrencies[i];
for (uint256 j = 0; j < _poolsByCurrency[currencyCode].length; j++)
if (hasCurrencyInPool(_poolsByCurrency[currencyCode][j], currencyCode))
_withdrawAllFromPool(_poolsByCurrency[currencyCode][j], currencyCode);
IERC20 token = IERC20(_erc20Contracts[currencyCode]);
uint256 balance = token.balanceOf(address(this));
if (balance > 0) token.safeTransfer(newContract, balance);
}
}
/**
* @dev Sets or upgrades RariFundController by forwarding tokens from the old to the new.
* @param newContract The address of the new RariFundController contract.
* @param erc20Contract The ERC20 contract address of the token to forward.
* @return Boolean indicating if the balance transferred was greater than 0.
*/
function upgradeFundController(address payable newContract, address erc20Contract) external onlyOwner returns (bool) {
require(RariFundController(newContract).IS_RARI_FUND_CONTROLLER(), "New contract does not have IS_RARI_FUND_CONTROLLER set to true.");
IERC20 token = IERC20(erc20Contract);
uint256 balance = token.balanceOf(address(this));
if (balance <= 0) return false;
token.safeTransfer(newContract, balance);
return true;
}
/**
* @dev Emitted when the RariFundManager of the RariFundController is set.
*/
event FundManagerSet(address newAddress);
/**
* @dev Sets or upgrades the RariFundManager of the RariFundController.
* @param newContract The address of the new RariFundManager contract.
*/
function setFundManager(address newContract) external onlyOwner {
// Approve maximum output tokens to RariFundManager
for (uint256 i = 0; i < _supportedCurrencies.length; i++) {
IERC20 token = IERC20(_erc20Contracts[_supportedCurrencies[i]]);
if (_rariFundManagerContract != address(0)) token.safeApprove(_rariFundManagerContract, 0);
if (newContract != address(0)) token.safeApprove(newContract, uint256(-1));
}
_rariFundManagerContract = newContract;
rariFundManager = RariFundManager(_rariFundManagerContract);
emit FundManagerSet(newContract);
}
/**
* @dev Throws if called by any account other than the RariFundManager.
*/
modifier onlyManager() {
require(_rariFundManagerContract == msg.sender, "Caller is not the fund manager.");
_;
}
/**
* @dev Emitted when the rebalancer of the RariFundController is set.
*/
event FundRebalancerSet(address newAddress);
/**
* @dev Sets or upgrades the rebalancer of the RariFundController.
* @param newAddress The Ethereum address of the new rebalancer server.
*/
function setFundRebalancer(address newAddress) external onlyOwner {
_rariFundRebalancerAddress = newAddress;
emit FundRebalancerSet(newAddress);
}
/**
* @dev Throws if called by any account other than the rebalancer.
*/
modifier onlyRebalancer() {
require(_rariFundRebalancerAddress == msg.sender, "Caller is not the rebalancer.");
_;
}
/**
* @dev Emitted when the primary functionality of this RariFundController contract has been disabled.
*/
event FundDisabled();
/**
* @dev Emitted when the primary functionality of this RariFundController contract has been enabled.
*/
event FundEnabled();
/**
* @dev Disables primary functionality of this RariFundController so contract(s) can be upgraded.
*/
function disableFund() external onlyOwner {
require(!_fundDisabled, "Fund already disabled.");
_fundDisabled = true;
emit FundDisabled();
}
/**
* @dev Enables primary functionality of this RariFundController once contract(s) are upgraded.
*/
function enableFund() external onlyOwner {
require(_fundDisabled, "Fund already enabled.");
_fundDisabled = false;
emit FundEnabled();
}
/**
* @dev Throws if fund is disabled.
*/
modifier fundEnabled() {
require(!_fundDisabled, "This fund controller contract is disabled. This may be due to an upgrade.");
_;
}
/**
* @dev Returns `_poolsByCurrency[currencyCode]`. Used by `RariFundProxy.getRawFundBalancesAndPrices`.
*/
function getPoolsByCurrency(string calldata currencyCode) external view returns (LiquidityPool[] memory) {
return _poolsByCurrency[currencyCode];
}
/**
* @dev Returns the balances of all currencies supported by dYdX.
* @return An array of ERC20 token contract addresses and a corresponding array of balances.
*/
function getDydxBalances() external view returns (address[] memory, uint256[] memory) {
return DydxPoolController.getBalances();
}
/**
* @dev Returns the fund controller's balance of the specified currency in the specified pool (without checking `_poolsWithFunds` first).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `CompoundPoolController.getBalance`) potentially modifies the state.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token.
*/
function _getPoolBalance(LiquidityPool pool, string memory currencyCode) public returns (uint256) {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (pool == LiquidityPool.dYdX) return DydxPoolController.getBalance(erc20Contract);
else if (pool == LiquidityPool.Compound) return CompoundPoolController.getBalance(erc20Contract);
else if (pool == LiquidityPool.Aave) return AavePoolController.getBalance(erc20Contract);
else if (pool == LiquidityPool.mStable && erc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) return MStablePoolController.getBalance();
else revert("Invalid pool index.");
}
/**
* @dev Returns the fund controller's balance of the specified currency in the specified pool (checking `_poolsWithFunds` first to save gas).
* @dev Ideally, we can add the `view` modifier, but Compound's `getUnderlyingBalance` function (called by `CompoundPoolController.getBalance`) potentially modifies the state.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token.
*/
function getPoolBalance(LiquidityPool pool, string memory currencyCode) public returns (uint256) {
if (!_poolsWithFunds[currencyCode][uint8(pool)]) return 0;
return _getPoolBalance(pool, currencyCode);
}
/**
* @dev Approves tokens to the specified pool without spending gas on every deposit.
* Note that this function is vulnerable to the allowance double-spend exploit, as with the `approve` functions of the ERC20 contracts themselves. If you are concerned and setting exact allowances, make sure to set allowance to 0 on the client side before setting an allowance greater than 0.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token to be approved.
* @param amount The amount of tokens to be approved.
*/
function approveToPool(LiquidityPool pool, string calldata currencyCode, uint256 amount) external fundEnabled onlyRebalancer {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (pool == LiquidityPool.dYdX) DydxPoolController.approve(erc20Contract, amount);
else if (pool == LiquidityPool.Compound) CompoundPoolController.approve(erc20Contract, amount);
else if (pool == LiquidityPool.Aave) AavePoolController.approve(erc20Contract, amount);
else if (pool == LiquidityPool.mStable && erc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) return MStablePoolController.approve(amount);
else revert("Invalid pool index.");
}
/**
* @dev Mapping of bools indicating the presence of funds to pool indexes to currency codes.
*/
mapping(string => mapping(uint8 => bool)) _poolsWithFunds;
/**
* @dev Return a boolean indicating if the fund controller has funds in `currencyCode` in `pool`.
* @param pool The index of the pool to check.
* @param currencyCode The currency code of the token to check.
*/
function hasCurrencyInPool(LiquidityPool pool, string memory currencyCode) public view returns (bool) {
return _poolsWithFunds[currencyCode][uint8(pool)];
}
/**
* @dev Referral code for Aave deposits.
*/
uint16 _aaveReferralCode;
/**
* @dev Sets the referral code for Aave deposits.
* @param referralCode The referral code.
*/
function setAaveReferralCode(uint16 referralCode) external onlyOwner {
_aaveReferralCode = referralCode;
}
/**
* @dev Enum for pool allocation action types supported by Rari.
*/
enum PoolAllocationAction { Deposit, Withdraw, WithdrawAll }
/**
* @dev Emitted when a deposit or withdrawal is made.
* Note that `amount` is not set for `WithdrawAll` actions.
*/
event PoolAllocation(PoolAllocationAction indexed action, LiquidityPool indexed pool, string indexed currencyCode, uint256 amount);
/**
* @dev Deposits funds to the specified pool.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token to be deposited.
* @param amount The amount of tokens to be deposited.
*/
function depositToPool(LiquidityPool pool, string calldata currencyCode, uint256 amount) external fundEnabled onlyRebalancer {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (pool == LiquidityPool.dYdX) DydxPoolController.deposit(erc20Contract, amount);
else if (pool == LiquidityPool.Compound) CompoundPoolController.deposit(erc20Contract, amount);
else if (pool == LiquidityPool.Aave) AavePoolController.deposit(erc20Contract, amount, _aaveReferralCode);
else if (pool == LiquidityPool.mStable && erc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) MStablePoolController.deposit(amount);
else revert("Invalid pool index.");
_poolsWithFunds[currencyCode][uint8(pool)] = true;
emit PoolAllocation(PoolAllocationAction.Deposit, pool, currencyCode, amount);
}
/**
* @dev Internal function to withdraw funds from the specified pool.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
*/
function _withdrawFromPool(LiquidityPool pool, string memory currencyCode, uint256 amount) internal {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (pool == LiquidityPool.dYdX) DydxPoolController.withdraw(erc20Contract, amount);
else if (pool == LiquidityPool.Compound) CompoundPoolController.withdraw(erc20Contract, amount);
else if (pool == LiquidityPool.Aave) AavePoolController.withdraw(erc20Contract, amount);
else if (pool == LiquidityPool.mStable && erc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) MStablePoolController.withdraw(amount);
else revert("Invalid pool index.");
emit PoolAllocation(PoolAllocationAction.Withdraw, pool, currencyCode, amount);
}
/**
* @dev Withdraws funds from the specified pool.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
*/
function withdrawFromPool(LiquidityPool pool, string calldata currencyCode, uint256 amount) external fundEnabled onlyRebalancer {
_withdrawFromPool(pool, currencyCode, amount);
_poolsWithFunds[currencyCode][uint8(pool)] = _getPoolBalance(pool, currencyCode) > 0;
}
/**
* @dev Withdraws funds from the specified pool (with optimizations based on the `all` parameter).
* If we already know all funds are being withdrawn, we won't have to check again here in this function.
* If withdrawing all funds, we choose _withdrawFromPool or _withdrawAllFromPool based on estimated gas usage.
* The value of `all` is trusted because `msg.sender` is always RariFundManager.
* @param pool The index of the pool.
* @param currencyCode The currency code of the token to be withdrawn.
* @param amount The amount of tokens to be withdrawn.
* @param all Boolean indicating if all funds are being withdrawn.
*/
function withdrawFromPoolOptimized(LiquidityPool pool, string calldata currencyCode, uint256 amount, bool all) external fundEnabled onlyManager {
all && (pool == LiquidityPool.dYdX || pool == LiquidityPool.mStable) ? _withdrawAllFromPool(pool, currencyCode) : _withdrawFromPool(pool, currencyCode, amount);
if (all) _poolsWithFunds[currencyCode][uint8(pool)] = false;
}
/**
* @dev Internal function to withdraw all funds from the specified pool.
* @param pool The index of the pool.
* @param currencyCode The ERC20 contract of the token to be withdrawn.
*/
function _withdrawAllFromPool(LiquidityPool pool, string memory currencyCode) internal {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
if (pool == LiquidityPool.dYdX) DydxPoolController.withdrawAll(erc20Contract);
else if (pool == LiquidityPool.Compound) require(CompoundPoolController.withdrawAll(erc20Contract), "No Compound balance to withdraw from.");
else if (pool == LiquidityPool.Aave) require(AavePoolController.withdrawAll(erc20Contract), "No Aave balance to withdraw from.");
else if (pool == LiquidityPool.mStable && erc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) require(MStablePoolController.withdrawAll(), "No mStable balance to withdraw from.");
else revert("Invalid pool index.");
_poolsWithFunds[currencyCode][uint8(pool)] = false;
emit PoolAllocation(PoolAllocationAction.WithdrawAll, pool, currencyCode, 0);
}
/**
* @dev Withdraws all funds from the specified pool.
* @param pool The index of the pool.
* @param currencyCode The ERC20 contract of the token to be withdrawn.
*/
function withdrawAllFromPool(LiquidityPool pool, string calldata currencyCode) external fundEnabled onlyRebalancer {
_withdrawAllFromPool(pool, currencyCode);
}
/**
* @dev Withdraws all funds from the specified pool (without requiring the fund to be enabled).
* @param pool The index of the pool.
* @param currencyCode The ERC20 contract of the token to be withdrawn.
*/
function withdrawAllFromPoolOnUpgrade(LiquidityPool pool, string calldata currencyCode) external onlyOwner {
_withdrawAllFromPool(pool, currencyCode);
}
/**
* @dev Approves tokens to 0x without spending gas on every deposit.
* Note that this function is vulnerable to the allowance double-spend exploit, as with the `approve` functions of the ERC20 contracts themselves. If you are concerned and setting exact allowances, make sure to set allowance to 0 on the client side before setting an allowance greater than 0.
* @param erc20Contract The ERC20 contract address of the token to be approved.
* @param amount The amount of tokens to be approved.
*/
function approveTo0x(address erc20Contract, uint256 amount) external fundEnabled onlyRebalancer {
ZeroExExchangeController.approve(erc20Contract, amount);
}
/**
* @dev Enum for currency exchanges supported by Rari.
*/
enum CurrencyExchange { ZeroEx, mStable }
/**
* @dev Emitted when currencies are exchanged via 0x or mStable.
* Note that `inputAmountUsd` and `outputAmountUsd` are not present when the input currency is not a supported stablecoin (i.e., when exchanging COMP via 0x).
*/
event CurrencyTrade(string indexed inputCurrencyCode, string indexed outputCurrencyCode, uint256 inputAmount, uint256 inputAmountUsd, uint256 outputAmount, uint256 outputAmountUsd, CurrencyExchange indexed exchange);
/**
* @dev Daily limit on 0x exchange order slippage (scaled by 1e18).
*/
uint256 private _dailyLossRateLimit;
/**
* @dev Sets or upgrades the daily limit on 0x exchange order loss over raw total fund balance.
* @param limit The daily limit on 0x exchange order loss over raw total fund balance (scaled by 1e18).
*/
function setDailyLossRateLimit(uint256 limit) external onlyOwner {
_dailyLossRateLimit = limit;
}
/**
* @dev Struct for a loss of funds due to a currency exchange (loss could be negative).
*/
struct CurrencyExchangeLoss {
uint256 timestamp;
int256 lossRate;
}
/**
* @dev Array of arrays containing 0x exchange order time and slippage (scaled by 1e18).
*/
CurrencyExchangeLoss[] private _lossRateHistory;
/**
* @dev Market sell to 0x exchange orders (reverting if `takerAssetFillAmount` is not filled or the 24-hour slippage limit is surpassed).
* We should be able to make this function external and use calldata for all parameters, but Solidity does not support calldata structs (https://github.com/ethereum/solidity/issues/5479).
* @param inputCurrencyCode The currency code of the token to be sold.
* @param outputCurrencyCode The currency code of the token to be bought.
* @param orders The limit orders to be filled in ascending order of price.
* @param signatures The signatures for the orders.
* @param takerAssetFillAmount The amount of the taker asset to sell (excluding taker fees).
*/
function marketSell0xOrdersFillOrKill(string memory inputCurrencyCode, string memory outputCurrencyCode, LibOrder.Order[] memory orders, bytes[] memory signatures, uint256 takerAssetFillAmount) public payable fundEnabled onlyRebalancer {
// Check if input is a supported stablecoin and make sure output is a supported stablecoin
address inputErc20Contract = _erc20Contracts[inputCurrencyCode];
address outputErc20Contract = _erc20Contracts[outputCurrencyCode];
require(outputErc20Contract != address(0), "Invalid output currency code.");
// Check orders (if inputting a supported stablecoin)
if (inputErc20Contract != address(0)) for (uint256 i = 0; i < orders.length; i++) {
address takerAssetAddress = ZeroExExchangeController.decodeTokenAddress(orders[i].takerAssetData);
require(inputErc20Contract == takerAssetAddress, "Not all input assets correspond to input currency code.");
address makerAssetAddress = ZeroExExchangeController.decodeTokenAddress(orders[i].makerAssetData);
require(outputErc20Contract == makerAssetAddress, "Not all output assets correspond to output currency code.");
if (orders[i].takerFee > 0) require(orders[i].takerFeeAssetData.length == 0, "Taker fees are not supported."); // TODO: Support orders with taker fees (need to include taker fees in loss calculation)
}
// Get prices and raw fund balance before exchange
uint256[] memory pricesInUsd;
uint256 rawFundBalanceBeforeExchange;
if (inputErc20Contract != address(0)) {
pricesInUsd = rariFundManager.rariFundPriceConsumer().getCurrencyPricesInUsd();
rawFundBalanceBeforeExchange = rariFundManager.getRawFundBalance(pricesInUsd);
}
// Market sell
uint256[2] memory filledAmounts = ZeroExExchangeController.marketSellOrdersFillOrKill(orders, signatures, takerAssetFillAmount, msg.value);
// Check 24-hour loss rate limit (if inputting a supported stablecoin)
uint256 inputFilledAmountUsd = 0;
uint256 outputFilledAmountUsd = 0;
if (inputErc20Contract != address(0)) {
inputFilledAmountUsd = toUsd(inputCurrencyCode, filledAmounts[0], pricesInUsd);
outputFilledAmountUsd = toUsd(inputCurrencyCode, filledAmounts[1], pricesInUsd);
handleExchangeLoss(inputFilledAmountUsd, outputFilledAmountUsd, rawFundBalanceBeforeExchange);
}
// Emit event
emit CurrencyTrade(inputCurrencyCode, outputCurrencyCode, filledAmounts[0], inputFilledAmountUsd, filledAmounts[1], outputFilledAmountUsd, CurrencyExchange.ZeroEx);
// Refund unused ETH
uint256 ethBalance = address(this).balance;
if (ethBalance > 0) {
(bool success, ) = msg.sender.call.value(ethBalance)("");
require(success, "Failed to transfer ETH to msg.sender after exchange.");
}
}
/**
* @dev Converts an amount to USD (scaled by 1e18).
* @param currencyCode The currency code to convert.
* @param amount The amount to convert.
* @param pricesInUsd An array of prices in USD for all supported currencies (in order).
* @return The equivalent USD amount (scaled by 1e18).
*/
function toUsd(string memory currencyCode, uint256 amount, uint256[] memory pricesInUsd) internal view returns (uint256) {
return amount.mul(pricesInUsd[_currencyIndexes[currencyCode]]).div(10 ** _currencyDecimals[currencyCode]);
}
/**
* @dev Checks the validity of a trade given the 24-hour exchange loss rate limit; if breached, reverts; otherwise, logs the loss rate of the trade.
* Note that while miners may be able to manipulate `block.timestamp` by up to 900 seconds, this small margin of error is acceptable.
* @param inputAmountUsd The amount sold in USD (scaled by 1e18).
* @param outputAmountUsd The amount bought in USD (scaled by 1e18).
*/
function handleExchangeLoss(uint256 inputAmountUsd, uint256 outputAmountUsd, uint256 rawFundBalanceBeforeExchange) internal {
// Calculate loss rate
int256 lossUsd = int256(inputAmountUsd).sub(int256(outputAmountUsd));
int256 lossRate = lossUsd.mul(1e18).div(int256(rawFundBalanceBeforeExchange));
// Check if sum of loss rates over the last 24 hours + this trade's loss rate > the limit
int256 lossRateLastDay = 0;
for (uint256 i = _lossRateHistory.length; i > 0; i--) {
if (_lossRateHistory[i - 1].timestamp < block.timestamp.sub(86400)) break;
lossRateLastDay = lossRateLastDay.add(_lossRateHistory[i - 1].lossRate);
}
require(lossRateLastDay.add(lossRate) <= int256(_dailyLossRateLimit), "This exchange would violate the 24-hour loss rate limit.");
// Log loss rate in history
_lossRateHistory.push(CurrencyExchangeLoss(block.timestamp, lossRate));
}
/**
* @dev Approves tokens to the mUSD token contract without spending gas on every deposit.
* Note that this function is vulnerable to the allowance double-spend exploit, as with the `approve` functions of the ERC20 contracts themselves. If you are concerned and setting exact allowances, make sure to set allowance to 0 on the client side before setting an allowance greater than 0.
* @param currencyCode The currency code of the token to be approved.
* @param amount Amount of the specified token to approve to the mUSD token contract.
*/
function approveToMUsd(string calldata currencyCode, uint256 amount) external fundEnabled onlyRebalancer {
address erc20Contract = _erc20Contracts[currencyCode];
require(erc20Contract != address(0), "Invalid currency code.");
MStableExchangeController.approve(erc20Contract, amount);
}
/**
* @dev Swaps tokens via mStable mUSD.
* @param inputCurrencyCode The currency code of the input token to be sold.
* @param outputCurrencyCode The currency code of the output token to be bought.
* @param inputAmount The amount of input tokens to be sold.
*/
function swapMStable(string calldata inputCurrencyCode, string calldata outputCurrencyCode, uint256 inputAmount) external fundEnabled onlyRebalancer {
// Input validation
address inputErc20Contract = _erc20Contracts[inputCurrencyCode];
address outputErc20Contract = _erc20Contracts[outputCurrencyCode];
require(outputErc20Contract != address(0), "Invalid input currency code.");
require(inputErc20Contract != address(0), "Invalid output currency code.");
// Get prices and raw fund balance before exchange
uint256[] memory pricesInUsd;
uint256 rawFundBalanceBeforeExchange;
pricesInUsd = rariFundManager.rariFundPriceConsumer().getCurrencyPricesInUsd();
rawFundBalanceBeforeExchange = rariFundManager.getRawFundBalance(pricesInUsd);
// Swap stablecoins via mUSD
uint256 outputAmount;
if (inputErc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) {
uint256 outputDecimals = _currencyDecimals[outputCurrencyCode];
uint256 outputAmountBeforeFees = outputDecimals >= 18 ? inputAmount.mul(10 ** outputDecimals.sub(18)) : inputAmount.div(10 ** uint256(18).sub(outputDecimals));
uint256 mUsdRedeemed = MStableExchangeController.redeem(outputErc20Contract, outputAmountBeforeFees);
require(mUsdRedeemed == inputAmount, "Amount of mUSD redeemed not equal to input mUSD amount.");
outputAmount = outputAmountBeforeFees.sub(outputAmountBeforeFees.mul(MStableExchangeController.getSwapFee()).div(1e18));
} else if (outputErc20Contract == 0xe2f2a5C287993345a840Db3B0845fbC70f5935a5) outputAmount = MStableExchangeController.mint(inputErc20Contract, inputAmount);
else outputAmount = MStableExchangeController.swap(inputErc20Contract, outputErc20Contract, inputAmount);
// Check 24-hour loss rate limit
uint256 inputFilledAmountUsd = toUsd(inputCurrencyCode, inputAmount, pricesInUsd);
uint256 outputFilledAmountUsd = toUsd(outputCurrencyCode, outputAmount, pricesInUsd);
handleExchangeLoss(inputFilledAmountUsd, outputFilledAmountUsd, rawFundBalanceBeforeExchange);
// Emit event
emit CurrencyTrade(inputCurrencyCode, outputCurrencyCode, inputAmount, inputFilledAmountUsd, outputAmount, outputFilledAmountUsd, CurrencyExchange.mStable);
}
}
{
"compilationTarget": {
"RariFundController.sol": "RariFundController"
},
"evmVersion": "istanbul",
"libraries": {
"AavePoolController": "0x3ac888a387392673d5661dced8894d8da4e13e26",
"CompoundPoolController": "0xa311ab659454a501c441ed39cdaacf2391a007d3",
"DydxPoolController": "0x82dd72f529a2e02c0ffcff7fe2da337bbededd29",
"MStableExchangeController": "0xcee3cbdcf1b57d336d7c2c1f03dd26603c16ea77",
"MStablePoolController": "0x1a2b86d96a2c12808eb6c3bdbecfdb5879eaa09b",
"ZeroExExchangeController": "0x7f2258c41e8916b5414c4546dc4e680e3f9c6c9c"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": []
}
[{"inputs":[],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"string","name":"inputCurrencyCode","type":"string"},{"indexed":true,"internalType":"string","name":"outputCurrencyCode","type":"string"},{"indexed":false,"internalType":"uint256","name":"inputAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"inputAmountUsd","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"outputAmount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"outputAmountUsd","type":"uint256"},{"indexed":true,"internalType":"enum RariFundController.CurrencyExchange","name":"exchange","type":"uint8"}],"name":"CurrencyTrade","type":"event"},{"anonymous":false,"inputs":[],"name":"FundDisabled","type":"event"},{"anonymous":false,"inputs":[],"name":"FundEnabled","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"newAddress","type":"address"}],"name":"FundManagerSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"newAddress","type":"address"}],"name":"FundRebalancerSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"enum RariFundController.PoolAllocationAction","name":"action","type":"uint8"},{"indexed":true,"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"indexed":true,"internalType":"string","name":"currencyCode","type":"string"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"PoolAllocation","type":"event"},{"payable":true,"stateMutability":"payable","type":"fallback"},{"constant":true,"inputs":[],"name":"IS_RARI_FUND_CONTROLLER","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"}],"name":"_getPoolBalance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"erc20Contract","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approveTo0x","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"string","name":"currencyCode","type":"string"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approveToMUsd","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approveToPool","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"depositToPool","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[],"name":"disableFund","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[],"name":"enableFund","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"getDydxBalances","outputs":[{"internalType":"address[]","name":"","type":"address[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"}],"name":"getPoolBalance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"internalType":"string","name":"currencyCode","type":"string"}],"name":"getPoolsByCurrency","outputs":[{"internalType":"enum RariFundController.LiquidityPool[]","name":"","type":"uint8[]"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"}],"name":"hasCurrencyInPool","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"initialize","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"isOwner","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"string","name":"inputCurrencyCode","type":"string"},{"internalType":"string","name":"outputCurrencyCode","type":"string"},{"components":[{"internalType":"address","name":"makerAddress","type":"address"},{"internalType":"address","name":"takerAddress","type":"address"},{"internalType":"address","name":"feeRecipientAddress","type":"address"},{"internalType":"address","name":"senderAddress","type":"address"},{"internalType":"uint256","name":"makerAssetAmount","type":"uint256"},{"internalType":"uint256","name":"takerAssetAmount","type":"uint256"},{"internalType":"uint256","name":"makerFee","type":"uint256"},{"internalType":"uint256","name":"takerFee","type":"uint256"},{"internalType":"uint256","name":"expirationTimeSeconds","type":"uint256"},{"internalType":"uint256","name":"salt","type":"uint256"},{"internalType":"bytes","name":"makerAssetData","type":"bytes"},{"internalType":"bytes","name":"takerAssetData","type":"bytes"},{"internalType":"bytes","name":"makerFeeAssetData","type":"bytes"},{"internalType":"bytes","name":"takerFeeAssetData","type":"bytes"}],"internalType":"struct LibOrder.Order[]","name":"orders","type":"tuple[]"},{"internalType":"bytes[]","name":"signatures","type":"bytes[]"},{"internalType":"uint256","name":"takerAssetFillAmount","type":"uint256"}],"name":"marketSell0xOrdersFillOrKill","outputs":[],"payable":true,"stateMutability":"payable","type":"function"},{"constant":true,"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[],"name":"rariFundManager","outputs":[{"internalType":"contract RariFundManager","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[],"name":"renounceOwnership","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"uint16","name":"referralCode","type":"uint16"}],"name":"setAaveReferralCode","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"uint256","name":"limit","type":"uint256"}],"name":"setDailyLossRateLimit","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"newContract","type":"address"}],"name":"setFundManager","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"newAddress","type":"address"}],"name":"setFundRebalancer","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"string","name":"inputCurrencyCode","type":"string"},{"internalType":"string","name":"outputCurrencyCode","type":"string"},{"internalType":"uint256","name":"inputAmount","type":"uint256"}],"name":"swapMStable","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address payable","name":"newContract","type":"address"}],"name":"upgradeFundController","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"address payable","name":"newContract","type":"address"},{"internalType":"address","name":"erc20Contract","type":"address"}],"name":"upgradeFundController","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"}],"name":"withdrawAllFromPool","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"}],"name":"withdrawAllFromPoolOnUpgrade","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"withdrawFromPool","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"enum RariFundController.LiquidityPool","name":"pool","type":"uint8"},{"internalType":"string","name":"currencyCode","type":"string"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bool","name":"all","type":"bool"}],"name":"withdrawFromPoolOptimized","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"}]