// SPDX-License-Identifier: Apache-2.0
// Contracts by dYdX Foundation. Individual files are released under different licenses.
//
// https://dydx.community
// https://github.com/dydxfoundation/governance-contracts
pragma solidity 0.7.5;
pragma experimental ABIEncoderV2;
import { SafeMath } from '../dependencies/open-zeppelin/SafeMath.sol';
interface ISafetyModuleV1 {
function claimRewardsFor(
address staker,
address recipient
)
external
returns (uint256);
}
interface ILiquidityStakingV1 {
function claimRewardsFor(
address staker,
address recipient
)
external
returns (uint256);
}
interface IMerkleDistributorV1 {
function claimRewardsFor(
address user,
uint256 cumulativeAmount,
bytes32[] calldata merkleProof
)
external
returns (uint256);
}
interface ITreasuryVester {
function claim() external;
}
/**
* @title ClaimsProxy
* @author dYdX
*
* @notice Contract which claims DYDX rewards from multiple contracts on behalf of a user.
*
* Requires the following permissions:
* - Set as the CLAIMS_PROXY on the SafetyModuleV1 contract.
* - Has role CLAIM_OPERATOR_ROLE on the LiquidityStakingV1 contract.
* - Has role CLAIM_OPERATOR_ROLE on the MerkleDistributorV1 contract.
*/
contract ClaimsProxy {
using SafeMath for uint256;
// ============ Constants ============
ISafetyModuleV1 public immutable SAFETY_MODULE;
ILiquidityStakingV1 public immutable LIQUIDITY_STAKING;
IMerkleDistributorV1 public immutable MERKLE_DISTRIBUTOR;
ITreasuryVester public immutable REWARDS_TREASURY_VESTER;
// ============ Constructor ============
constructor(
ISafetyModuleV1 safetyModule,
ILiquidityStakingV1 liquidityStaking,
IMerkleDistributorV1 merkleDistributor,
ITreasuryVester rewardsTreasuryVester
) {
SAFETY_MODULE = safetyModule;
LIQUIDITY_STAKING = liquidityStaking;
MERKLE_DISTRIBUTOR = merkleDistributor;
REWARDS_TREASURY_VESTER = rewardsTreasuryVester;
}
// ============ External Functions ============
/**
* @notice Claim rewards from zero or more rewards contracts. All rewards are sent directly to
* the sender's address.
*
* @param claimSafetyRewards Whether or not to claim rewards from SafetyModuleV1.
* @param claimLiquidityRewards Whether or not to claim rewards from LiquidityStakingV1.
* @param merkleCumulativeAmount The cumulative rewards amount for the user in the
* MerkleDistributorV1 rewards Merkle tree, or zero to skip
* claiming from this contract.
* @param merkleProof The Merkle proof for the user's cumulative rewards.
* @param vestFromTreasuryVester Whether or not to vest rewards from the rewards treasury
* vester to the rewards treasury (e.g. set to true if rewards
* treasury has insufficient funds for users, and false otherwise).
*
* @return The total number of rewards claimed.
*/
function claimRewards(
bool claimSafetyRewards,
bool claimLiquidityRewards,
uint256 merkleCumulativeAmount,
bytes32[] calldata merkleProof,
bool vestFromTreasuryVester
)
external
returns (uint256)
{
if (vestFromTreasuryVester) {
// call rewards treasury vester so that rewards treasury has sufficient rewards
REWARDS_TREASURY_VESTER.claim();
}
address user = msg.sender;
uint256 amount1 = 0;
uint256 amount2 = 0;
uint256 amount3 = 0;
if (claimSafetyRewards) {
amount1 = SAFETY_MODULE.claimRewardsFor(user, user);
}
if (claimLiquidityRewards) {
amount2 = LIQUIDITY_STAKING.claimRewardsFor(user, user);
}
if (merkleCumulativeAmount != 0) {
amount3 = MERKLE_DISTRIBUTOR.claimRewardsFor(user, merkleCumulativeAmount, merkleProof);
}
return amount1.add(amount2).add(amount3);
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.7.5;
/**
* @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.
*/
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.
*/
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.
*/
function mod(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
require(b != 0, errorMessage);
return a % b;
}
}
{
"compilationTarget": {
"contracts/misc/ClaimsProxy.sol": "ClaimsProxy"
},
"evmVersion": "istanbul",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": []
}
[{"inputs":[{"internalType":"contract ISafetyModuleV1","name":"safetyModule","type":"address"},{"internalType":"contract ILiquidityStakingV1","name":"liquidityStaking","type":"address"},{"internalType":"contract IMerkleDistributorV1","name":"merkleDistributor","type":"address"},{"internalType":"contract ITreasuryVester","name":"rewardsTreasuryVester","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"LIQUIDITY_STAKING","outputs":[{"internalType":"contract ILiquidityStakingV1","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MERKLE_DISTRIBUTOR","outputs":[{"internalType":"contract IMerkleDistributorV1","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"REWARDS_TREASURY_VESTER","outputs":[{"internalType":"contract ITreasuryVester","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SAFETY_MODULE","outputs":[{"internalType":"contract ISafetyModuleV1","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bool","name":"claimSafetyRewards","type":"bool"},{"internalType":"bool","name":"claimLiquidityRewards","type":"bool"},{"internalType":"uint256","name":"merkleCumulativeAmount","type":"uint256"},{"internalType":"bytes32[]","name":"merkleProof","type":"bytes32[]"},{"internalType":"bool","name":"vestFromTreasuryVester","type":"bool"}],"name":"claimRewards","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]