// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error AddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedInnerCall();
/**
* @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://consensys.net/diligence/blog/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.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert AddressInsufficientBalance(address(this));
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert FailedInnerCall();
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {FailedInnerCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert AddressInsufficientBalance(address(this));
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an
* unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {FailedInnerCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) 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 a `value` amount of tokens 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 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC6372.sol)
pragma solidity ^0.8.20;
interface IERC6372 {
/**
* @dev Clock used for flagging checkpoints. Can be overridden to implement timestamp based checkpoints (and voting).
*/
function clock() external view returns (uint48);
/**
* @dev Description of the clock
*/
// solhint-disable-next-line func-name-mixedcase
function CLOCK_MODE() external view returns (string memory);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
interface IHistoricalBalance {
/**
* @notice This function retrieves the historical balance of an account at
* a specific point in time.
* @param account The address of the account for which to retrieve the
* historical balance.
* @param timepoint The timepoint (block number or timestamp depending on
* implementation) at which to query the balance (uint256).
* @return balance The balance of the account at the specified timepoint.
*/
function getPastBalanceOf(address account, uint256 timepoint) external view returns (uint256 balance);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
interface ILegacyVeMav is IERC20 {
/// @notice Preview the number of points that would be returned for the
/// given amount and duration.
///
/// @param amount mav to be staked
/// @param duration number of seconds to stake for
function previewPoints(
uint256 amount,
uint256 duration
) external view returns (uint256 newVotes, uint256 stakingPeriodEnd);
function lockups(
address account,
uint256 lockupId
) external returns (uint128 amount, uint128 end, uint256 points);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
import {IVotes} from "@openzeppelin/contracts/governance/utils/IVotes.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {IERC6372} from "@openzeppelin/contracts/interfaces/IERC6372.sol";
import {IHistoricalBalance} from "../votingescrowbase/IHistoricalBalance.sol";
interface IMaverickV2VotingEscrowBase is IVotes, IHistoricalBalance {
error VotingEscrowTransferNotSupported();
error VotingEscrowInvalidAddress(address);
error VotingEscrowInvalidAmount(uint256);
error VotingEscrowInvalidDuration(uint256 duration, uint256 minDuration, uint256 maxDuration);
error VotingEscrowInvalidEndTime(uint256 newEnd, uint256 oldEnd);
error VotingEscrowStakeStillLocked(uint256 currentTime, uint256 endTime);
error VotingEscrowStakeAlreadyRedeemed();
error VotingEscrowNotApprovedExtender(address account, address extender, uint256 lockupId);
error VotingEscrowIncentiveAlreadyClaimed(address account, uint256 batchIndex);
error VotingEscrowNoIncentivesToClaim(address account, uint256 batchIndex);
error VotingEscrowInvalidExtendIncentiveToken(IERC20 incentiveToken);
error VotingEscrowNoSupplyAtTimepoint();
error VotingEscrowIncentiveTimepointInFuture(uint256 timestamp, uint256 claimTimepoint);
event Stake(address indexed user, uint256 lockupId, Lockup);
event Unstake(address indexed user, uint256 lockupId, Lockup);
event ExtenderApproval(address staker, address extender, uint256 lockupId, bool newState);
event ClaimIncentiveBatch(uint256 batchIndex, address account, uint256 claimAmount);
event CreateNewIncentiveBatch(
address user,
uint256 amount,
uint256 timepoint,
uint256 stakeDuration,
IERC20 incentiveToken
);
struct Lockup {
uint128 amount;
uint128 end;
uint256 votes;
}
struct ClaimInformation {
bool timepointInPast;
bool hasClaimed;
uint128 claimAmount;
}
struct BatchInformation {
uint128 totalIncentives;
uint128 stakeDuration;
uint48 claimTimepoint;
IERC20 incentiveToken;
}
struct TokenIncentiveTotals {
uint128 totalIncentives;
uint128 claimedIncentives;
}
// solhint-disable-next-line func-name-mixedcase
function MIN_STAKE_DURATION() external returns (uint256 duration);
// solhint-disable-next-line func-name-mixedcase
function MAX_STAKE_DURATION() external returns (uint256 duration);
// solhint-disable-next-line func-name-mixedcase
function YEAR_BASE() external returns (uint256);
/**
* @notice This function retrieves the address of the ERC20 token used as the base token for staking and rewards.
* @return baseToken The address of the IERC20 base token contract.
*/
function baseToken() external returns (IERC20);
/**
* @notice This function retrieves the starting timestamp. This may be used
* for reward calculations or other time-based logic.
*/
function startTimestamp() external returns (uint256 timestamp);
/**
* @notice This function retrieves the details of a specific lockup for a given staker and lockup index.
* @param staker The address of the staker for which to retrieve the lockup details.
* @param index The index of the lockup within the staker's lockup history.
* @return lockup A Lockup struct containing details about the lockup (see struct definition for details).
*/
function getLockup(address staker, uint256 index) external view returns (Lockup memory lockup);
/**
* @notice This function retrieves the total number of lockups associated with a specific staker.
* @param staker The address of the staker for which to retrieve the lockup count.
* @return count The total number of lockups for the staker.
*/
function lockupCount(address staker) external view returns (uint256 count);
/**
* @notice This function simulates a lockup scenario, providing details about the resulting lockup structure for a specified amount and duration.
* @param amount The amount of tokens to be locked.
* @param duration The duration of the lockup period.
* @return lockup A Lockup struct containing details about the simulated lockup (see struct definition for details).
*/
function previewVotes(uint128 amount, uint256 duration) external view returns (Lockup memory lockup);
/**
* @notice This function grants approval for a designated extender contract to manage a specific lockup on behalf of the staker.
* @param extender The address of the extender contract to be approved.
* @param lockupId The ID of the lockup for which to grant approval.
*/
function approveExtender(address extender, uint256 lockupId) external;
/**
* @notice This function revokes approval previously granted to an extender contract for managing a specific lockup.
* @param extender The address of the extender contract whose approval is being revoked.
* @param lockupId The ID of the lockup for which to revoke approval.
*/
function revokeExtender(address extender, uint256 lockupId) external;
/**
* @notice This function checks whether a specific account has been approved by a staker to manage a particular lockup through an extender contract.
* @param account The address of the account to check for approval (may be the extender or another account).
* @param extender The address of the extender contract for which to check approval.
* @param lockupId The ID of the lockup to verify approval for.
* @return isApproved True if the account is approved for the lockup, False otherwise (bool).
*/
function isApprovedExtender(address account, address extender, uint256 lockupId) external view returns (bool);
/**
* @notice This function extends the lockup period for the caller (msg.sender) for a specified lockup ID, adding a new duration and amount.
* @param lockupId The ID of the lockup to be extended.
* @param duration The additional duration to extend the lockup by.
* @param amount The additional amount of tokens to be locked.
* @return newLockup A Lockup struct containing details about the newly extended lockup (see struct definition for details).
*/
function extendForSender(
uint256 lockupId,
uint256 duration,
uint128 amount
) external returns (Lockup memory newLockup);
/**
* @notice This function extends the lockup period for a specified account, adding a new duration and amount. The caller (msg.sender) must be authorized to manage the lockup through an extender contract.
* @param account The address of the account whose lockup is being extended.
* @param lockupId The ID of the lockup to be extended.
* @param duration The additional duration to extend the lockup by.
* @param amount The additional amount of tokens to be locked.
* @return newLockup A Lockup struct containing details about the newly extended lockup (see struct definition for details).
*/
function extendForAccount(
address account,
uint256 lockupId,
uint256 duration,
uint128 amount
) external returns (Lockup memory newLockup);
/**
* @notice This function merges multiple lockups associated with the caller
* (msg.sender) into a single new lockup.
* @param lockupIds An array containing the IDs of the lockups to be merged.
* @return newLockup A Lockup struct containing details about the newly merged lockup (see struct definition for details).
*/
function merge(uint256[] memory lockupIds) external returns (Lockup memory newLockup);
/**
* @notice This function unstakes the specified lockup ID for the caller (msg.sender), returning the details of the unstaked lockup.
* @param lockupId The ID of the lockup to be unstaked.
* @param to The address to which the unstaked tokens should be sent (optional, defaults to msg.sender).
* @return lockup A Lockup struct containing details about the unstaked lockup (see struct definition for details).
*/
function unstake(uint256 lockupId, address to) external returns (Lockup memory lockup);
/**
* @notice This function is a simplified version of `unstake` that automatically sends the unstaked tokens to the caller (msg.sender).
* @param lockupId The ID of the lockup to be unstaked.
* @return lockup A Lockup struct containing details about the unstaked lockup (see struct definition for details).
*/
function unstakeToSender(uint256 lockupId) external returns (Lockup memory lockup);
/**
* @notice This function stakes a specified amount of tokens for the caller
* (msg.sender) for a defined duration.
* @param amount The amount of tokens to be staked.
* @param duration The duration of the lockup period.
* @return lockup A Lockup struct containing details about the newly
* created lockup (see struct definition for details).
*/
function stakeToSender(uint128 amount, uint256 duration) external returns (Lockup memory lockup);
/**
* @notice This function stakes a specified amount of tokens for a defined
* duration, allowing the caller (msg.sender) to specify an optional
* recipient for the staked tokens.
* @param amount The amount of tokens to be staked.
* @param duration The duration of the lockup period.
* @param to The address to which the staked tokens will be credited (optional, defaults to msg.sender).
* @return lockup A Lockup struct containing details about the newly
* created lockup (see struct definition for details).
*/
function stake(uint128 amount, uint256 duration, address to) external returns (Lockup memory);
/**
* @notice This function retrieves the total incentive information for a specific ERC-20 token.
* @param token The address of the ERC20 token for which to retrieve incentive totals.
* @return totals A TokenIncentiveTotals struct containing details about
* the token's incentives (see struct definition for details).
*/
function incentiveTotals(IERC20 token) external view returns (TokenIncentiveTotals memory);
/**
* @notice This function retrieves the total number of created incentive batches.
* @return count The total number of incentive batches.
*/
function incentiveBatchCount() external view returns (uint256);
/**
* @notice This function retrieves claim information for a specific account and incentive batch index.
* @param account The address of the account for which to retrieve claim information.
* @param batchIndex The index of the incentive batch for which to retrieve
* claim information.
* @return claimInformation A ClaimInformation struct containing details about the
* account's claims for the specified batch (see struct definition for
* details).
* @return batchInformation A BatchInformation struct containing details about the
* specified batch (see struct definition for details).
*/
function claimAndBatchInformation(
address account,
uint256 batchIndex
) external view returns (ClaimInformation memory claimInformation, BatchInformation memory batchInformation);
/**
* @notice This function retrieves batch information for a incentive batch index.
* @param batchIndex The index of the incentive batch for which to retrieve
* claim information.
* @return info A BatchInformation struct containing details about the
* specified batch (see struct definition for details).
*/
function incentiveBatchInformation(uint256 batchIndex) external view returns (BatchInformation memory info);
/**
* @notice This function allows claiming rewards from a specific incentive
* batch while simultaneously extending a lockup with the claimed tokens.
* @param batchIndex The index of the incentive batch from which to claim rewards.
* @param lockupId The ID of the lockup to be extended with the claimed tokens.
* @return lockup A Lockup struct containing details about the updated
* lockup after extension (see struct definition for details).
* @return claimAmount The amount of tokens claimed from the incentive batch.
*/
function claimFromIncentiveBatchAndExtend(
uint256 batchIndex,
uint256 lockupId
) external returns (Lockup memory lockup, uint128 claimAmount);
/**
* @notice This function allows claiming rewards from a specific incentive
* batch, without extending any lockups.
* @param batchIndex The index of the incentive batch from which to claim rewards.
* @return lockup A Lockup struct containing details about the user's
* lockup that might have been affected by the claim (see struct definition
* for details).
* @return claimAmount The amount of tokens claimed from the incentive batch.
*/
function claimFromIncentiveBatch(uint256 batchIndex) external returns (Lockup memory lockup, uint128 claimAmount);
/**
* @notice This function creates a new incentive batch for a specified amount
* of incentive tokens, timepoint, stake duration, and associated ERC-20
* token. An incentive batch is a reward of incentives put up by the
* caller at a certain timepoint. The incentive batch is claimable by ve
* holders after the timepoint has passed. The ve holders will receive
* their incentive pro rata of their vote balance (`pastbalanceOf`) at that
* timepoint. The incentivizer can specify that users have to stake the
* resulting incentive for a given `stakeDuration` number of seconds.
* `stakeDuration` can either be zero, meaning that no staking is required
* on redemption, or can be a number between `MIN_STAKE_DURATION()` and
* `MAX_STAKE_DURATION()`.
* @param amount The total amount of incentive tokens to be distributed in the batch.
* @param timepoint The timepoint at which the incentive batch starts accruing rewards.
* @param stakeDuration The duration of the lockup period required to be
* eligible for the incentive batch rewards.
* @param incentiveToken The address of the ERC20 token used for the incentive rewards.
* @return index The index of the newly created incentive batch.
*/
function createIncentiveBatch(
uint128 amount,
uint48 timepoint,
uint128 stakeDuration,
IERC20 incentiveToken
) external returns (uint256 index);
}
interface IMaverickV2VotingEscrow is IMaverickV2VotingEscrowBase, IERC20Metadata, IERC6372 {}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
interface IMaverickV2VotingEscrowWSync {
error VotingEscrowLockupEndTooShortToSync(uint256 legacyLockupEnd, uint256 minimumLockupEnd);
event Sync(address staker, uint256 legacyLockupIndex, uint256 newBalance);
/**
* @notice This function retrieves the minimum lockup duration required for
* a legacy lockup to be eligible for synchronization.
* @return minSyncDuration The minimum allowed lockup end time.
*/
// solhint-disable-next-line func-name-mixedcase
function MIN_SYNC_DURATION() external pure returns (uint256 minSyncDuration);
/**
* @notice This function retrieves the address of the legacy Maverick V1
* Voting Escrow (veMav) token.
* @return legacyVeMav The address of the IERC20 legacy veMav token.
*/
function legacyVeMav() external view returns (IERC20);
/**
* @notice This function retrieves the synced balance for a specific legacy lockup index of a user.
* @param staker The address of the user for whom to retrieve the synced balance.
* @param legacyLockupIndex The index of the legacy lockup for which to
* retrieve the synced balance.
* @return balance The synced balance associated with the legacy lockup.
*/
function syncBalances(address staker, uint256 legacyLockupIndex) external view returns (uint256 balance);
/**
* @notice This function synchronizes a specific legacy lockup index for a
* user within the contract. If the legacy lockup.end is not at least
* `block.timestamp + MIN_SYNC_DURATION()`, this function will revert.
* @param staker The address of the user for whom to perform synchronization.
* @param legacyLockupIndex The index of the legacy lockup to be
* synchronized.
* @return newBalance The new balance resulting from the synchronization
* process.
*/
function sync(address staker, uint256 legacyLockupIndex) external returns (uint256 newBalance);
}
// SPDX-License-Identifier: GPL-2.0-or-later
// As the copyright holder of this work, Ubiquity Labs retains
// the right to distribute, use, and modify this code under any license of
// their choosing, in addition to the terms of the GPL-v2 or later.
pragma solidity ^0.8.25;
interface IMulticall {
function multicall(bytes[] calldata data) external returns (bytes[] memory results);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
interface ISpiral {
struct Info {
address locker;
IERC20 sprMav;
IERC20 mav;
uint256 unlockTime;
}
/**
* @notice Pulls locker information.
*/
function lockerInfo() external view returns (Info memory);
/**
* @notice Puils mav tokens into the deposit contract via transferFrom.
* sprMav is send to msg.sender.
*/
function lock(uint256 amount) external;
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
interface IStake {
/// @notice Deposit tokens, and receive sdToken or sdTokenGauge in return.
/// @param _amount Amount of tokens to deposit.
/// @param _lock Whether to lock the tokens in the locker contract.
/// @param _stake Whether to stake the sdToken in the gauge.
/// @param _user Address of the user to receive the sdToken.
/// @dev If the lock is true, the tokens are directly sent to the locker and increase the lock amount as veToken.
/// If the lock is false, the tokens are sent to this contract until someone locks them. A small percent of the deposit
/// is used to incentivize users to lock the tokens.
/// If the stake is true, the sdToken is staked in the gauge that distributes rewards. If the stake is false, the sdToken
/// is sent to the user.
function deposit(
uint256 _amount,
bool _lock,
bool _stake,
address _user
) external;
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.25;
interface IUnlock {
/**
* @notice Puils mav tokens into the deposit contract via transferFrom
* @param to Address of the receiver of the deposit
* @param _amount MAV amount to deposit
* @param _lock Lock now? or pay ~0.1% to the locker
* @param _stake Stake the wrapper tokens into staking contract
*/
function depositFor(
address to,
uint256 _amount,
bool _lock,
bool _stake
) external;
/**
* @notice Address of unlock staker.
*/
function staker() external returns (address);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (governance/utils/IVotes.sol)
pragma solidity ^0.8.20;
/**
* @dev Common interface for {ERC20Votes}, {ERC721Votes}, and other {Votes}-enabled contracts.
*/
interface IVotes {
/**
* @dev The signature used has expired.
*/
error VotesExpiredSignature(uint256 expiry);
/**
* @dev Emitted when an account changes their delegate.
*/
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate);
/**
* @dev Emitted when a token transfer or delegate change results in changes to a delegate's number of voting units.
*/
event DelegateVotesChanged(address indexed delegate, uint256 previousVotes, uint256 newVotes);
/**
* @dev Returns the current amount of votes that `account` has.
*/
function getVotes(address account) external view returns (uint256);
/**
* @dev Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*/
function getPastVotes(address account, uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
* configured to use block numbers, this will return the value at the end of the corresponding block.
*
* NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
* Votes that have not been delegated are still part of total supply, even though they would not participate in a
* vote.
*/
function getPastTotalSupply(uint256 timepoint) external view returns (uint256);
/**
* @dev Returns the delegate that `account` has chosen.
*/
function delegates(address account) external view returns (address);
/**
* @dev Delegates votes from the sender to `delegatee`.
*/
function delegate(address delegatee) external;
/**
* @dev Delegates votes from signer to `delegatee`.
*/
function delegateBySig(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.25;
import {IMaverickV2VotingEscrowWSync} from "@maverick/v2-rewards/contracts/interfaces/IMaverickV2VotingEscrowWSync.sol";
import {IMaverickV2VotingEscrow} from "@maverick/v2-rewards/contracts/interfaces/IMaverickV2VotingEscrow.sol";
import {Multicall} from "@maverick/v2-common/contracts/base/Multicall.sol";
import {MerkleProof} from "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IStake} from "./interfaces/IStake.sol";
import {IUnlock} from "./interfaces/IUnlock.sol";
import {ISpiral} from "./interfaces/ISpiral.sol";
import {ILegacyVeMav} from "./interfaces/ILegacyVeMav.sol";
contract MaverickV2LockupDistributor is Multicall, ReentrancyGuard {
using SafeERC20 for IERC20;
struct ClaimValue {
address account;
uint128 amount;
uint256 index;
uint256 minClaimTimestamp;
uint256 minStakeDuration;
bytes32[] proof;
}
uint256 internal constant FOUR_YEARS = 4 * 365 days;
IERC20 public immutable mav;
bytes32 public immutable merkleRoot;
IMaverickV2VotingEscrow public immutable veMavV2;
ILegacyVeMav public immutable veMavLegacy;
IStake public immutable stakeDaoContract;
IUnlock public immutable unlockContract;
ISpiral public immutable spiralDaoContract;
// This is a packed array of booleans.
mapping(uint256 => uint256) private claimedBitMap;
//@notice This event is triggered whenever a call to #claim succeeds.
event Claimed(
address account,
uint256 amount,
uint256 index,
uint256 stakeDuration
);
error DistributorAlreadyClaimed();
error DistributorClaimPeriodNotYetOpen();
error DistributorInvalidProof();
error DistributorLockerDidNotLockEnough(
uint256 initialTotalSupply,
uint256 expectedTotalSupply,
uint256 postStakeTotalSupply
);
error DistributorInvalidStakeDuration();
error DistributorAccountIsNotSender();
modifier claimStake(ClaimValue memory claimValue, uint256 stakeDuration) {
_claimCheck(claimValue, stakeDuration);
_setClaimed(claimValue.index);
_;
emit Claimed(
claimValue.account,
claimValue.amount,
claimValue.index,
stakeDuration
);
}
modifier checkLegacyBalance(uint256 _amount, uint256 stakeDuration) {
uint256 initialTotalSupply = veMavLegacy.totalSupply();
(uint256 newVotes, ) = veMavLegacy.previewPoints(
_amount,
stakeDuration
);
uint256 expectedTotalSupply = initialTotalSupply + newVotes;
_;
uint256 postStakeTotalSupply = veMavLegacy.totalSupply();
if (postStakeTotalSupply < expectedTotalSupply)
revert DistributorLockerDidNotLockEnough(
initialTotalSupply,
expectedTotalSupply,
postStakeTotalSupply
);
}
constructor(
bytes32 _merkleRoot,
IMaverickV2VotingEscrow _veMavV2,
IStake _stakeDaoContract,
IUnlock _unlockContract,
ISpiral _spiralDaoContract
) {
merkleRoot = _merkleRoot;
veMavV2 = _veMavV2;
mav = _veMavV2.baseToken();
veMavLegacy = ILegacyVeMav(
address(
IMaverickV2VotingEscrowWSync(address(_veMavV2)).legacyVeMav()
)
);
stakeDaoContract = _stakeDaoContract;
unlockContract = _unlockContract;
spiralDaoContract = _spiralDaoContract;
}
function _claimCheck(
ClaimValue memory claimValue,
uint256 stakeDuration
) internal view {
if (isClaimed(claimValue.index)) revert DistributorAlreadyClaimed();
if (block.timestamp < claimValue.minClaimTimestamp)
revert DistributorClaimPeriodNotYetOpen();
if (stakeDuration < claimValue.minStakeDuration)
revert DistributorInvalidStakeDuration();
if (msg.sender != claimValue.account)
revert DistributorAccountIsNotSender();
if (!isProofValid(claimValue)) revert DistributorInvalidProof();
}
/**
* @notice Execute a claim using a merkle proof. Stake output to veMav
* contract.
*/
function claimToVeMav(
ClaimValue memory claimValue,
uint256 stakeDuration
) public claimStake(claimValue, stakeDuration) {
mav.approve(address(veMavV2), claimValue.amount);
veMavV2.stake(claimValue.amount, stakeDuration, msg.sender);
}
/**
* @notice Execute a claim using a merkle proof. Send output mav to user.
* Only valid for claims where claimValue.minStakeDuration = 0.
*/
function claimToMav(
ClaimValue memory claimValue
) public claimStake(claimValue, 0) {
mav.safeTransfer(claimValue.account, claimValue.amount);
}
/**
* @notice Delegate veMav vote by signature.
*/
function delegateVeMavVoteBySignature(
address delegatee,
uint256 nonce,
uint256 expiry,
uint8 v,
bytes32 r,
bytes32 s
) public {
veMavV2.delegateBySig(delegatee, nonce, expiry, v, r, s);
}
/**
* @notice Execute a claim using a merkle proof. Stake output to unkMav liquid
* locker.
*/
function claimToUnlock(
ClaimValue memory claimValue
)
public
nonReentrant
claimStake(claimValue, FOUR_YEARS)
checkLegacyBalance(claimValue.amount, FOUR_YEARS)
{
mav.approve(address(unlockContract), claimValue.amount);
unlockContract.depositFor(msg.sender, claimValue.amount, true, false);
}
/**
* @notice Execute a claim using a merkle proof. Stake output to sprMav liquid
* locker.
*/
function claimToSpiralDao(
ClaimValue memory claimValue
)
public
nonReentrant
claimStake(claimValue, FOUR_YEARS)
checkLegacyBalance(claimValue.amount, FOUR_YEARS)
{
mav.approve(address(spiralDaoContract), claimValue.amount);
ISpiral.Info memory info = spiralDaoContract.lockerInfo();
spiralDaoContract.lock(claimValue.amount);
info.sprMav.transfer(msg.sender, info.sprMav.balanceOf(address(this)));
}
/**
* @notice Execute a claim using a merkle proof. Stake output to sdMav liquid
* locker.
*/
function claimToStakeDao(
ClaimValue memory claimValue
)
public
nonReentrant
claimStake(claimValue, FOUR_YEARS)
checkLegacyBalance(claimValue.amount, FOUR_YEARS)
{
mav.approve(address(stakeDaoContract), claimValue.amount);
stakeDaoContract.deposit(claimValue.amount, true, false, msg.sender);
}
/**
* @notice
* @param _index Index in the tree
*/
function isClaimed(uint256 _index) public view returns (bool) {
uint256 claimedWordIndex = _index / 256;
uint256 claimedBitIndex = _index % 256;
uint256 claimedWord = claimedBitMap[claimedWordIndex];
uint256 mask = (1 << claimedBitIndex);
return claimedWord & mask == mask;
}
function isProofValid(
ClaimValue memory claimValue
) public view returns (bool) {
// Verify the Merkle proof.
bytes32 node = keccak256(
bytes.concat(
keccak256(
abi.encode(
claimValue.index,
claimValue.account,
claimValue.amount,
claimValue.minClaimTimestamp,
claimValue.minStakeDuration
)
)
)
);
return MerkleProof.verify(claimValue.proof, merkleRoot, node);
}
/**
* @notice
* @param _index Index in the tree
*/
function _setClaimed(uint256 _index) internal {
uint256 claimedWordIndex = _index / 256;
uint256 claimedBitIndex = _index % 256;
claimedBitMap[claimedWordIndex] =
claimedBitMap[claimedWordIndex] |
(1 << claimedBitIndex);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/cryptography/MerkleProof.sol)
pragma solidity ^0.8.20;
/**
* @dev These functions deal with verification of Merkle Tree proofs.
*
* The tree and the proofs can be generated using our
* https://github.com/OpenZeppelin/merkle-tree[JavaScript library].
* You will find a quickstart guide in the readme.
*
* WARNING: You should avoid using leaf values that are 64 bytes long prior to
* hashing, or use a hash function other than keccak256 for hashing leaves.
* This is because the concatenation of a sorted pair of internal nodes in
* the Merkle tree could be reinterpreted as a leaf value.
* OpenZeppelin's JavaScript library generates Merkle trees that are safe
* against this attack out of the box.
*/
library MerkleProof {
/**
*@dev The multiproof provided is not valid.
*/
error MerkleProofInvalidMultiproof();
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*/
function verify(bytes32[] memory proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Calldata version of {verify}
*/
function verifyCalldata(bytes32[] calldata proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProofCalldata(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leafs & pre-images are assumed to be sorted.
*/
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Calldata version of {processProof}
*/
function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = _hashPair(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function multiProofVerify(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProof(proof, proofFlags, leaves) == root;
}
/**
* @dev Calldata version of {multiProofVerify}
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function multiProofVerifyCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProofCalldata(proof, proofFlags, leaves) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*/
function processMultiProof(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofLen = proof.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
if (leavesLen + proofLen != totalHashes + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
if (proofPos != proofLen) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[totalHashes - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Calldata version of {processMultiProof}.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*/
function processMultiProofCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofLen = proof.length;
uint256 totalHashes = proofFlags.length;
// Check proof validity.
if (leavesLen + proofLen != totalHashes + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](totalHashes);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < totalHashes; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = _hashPair(a, b);
}
if (totalHashes > 0) {
if (proofPos != proofLen) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[totalHashes - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Sorts the pair (a, b) and hashes the result.
*/
function _hashPair(bytes32 a, bytes32 b) private pure returns (bytes32) {
return a < b ? _efficientHash(a, b) : _efficientHash(b, a);
}
/**
* @dev Implementation of keccak256(abi.encode(a, b)) that doesn't allocate or expand memory.
*/
function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}
// SPDX-License-Identifier: GPL-2.0-or-later
// As the copyright holder of this work, Ubiquity Labs retains
// the right to distribute, use, and modify this code under any license of
// their choosing, in addition to the terms of the GPL-v2 or later.
pragma solidity ^0.8.25;
import {IMulticall} from "./IMulticall.sol";
import {Address} from "@openzeppelin/contracts/utils/Address.sol";
// Modified from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/6ba452dea4258afe77726293435f10baf2bed265/contracts/utils/Multicall.sol
/*
* @notice Multicall
*/
abstract contract Multicall is IMulticall {
/**
* @notice This function allows multiple calls to different contract functions
* in a single transaction.
* @param data An array of encoded function call data.
* @return results An array of the results of the function calls.
*/
function multicall(bytes[] calldata data) external returns (bytes[] memory results) {
results = new bytes[](data.length);
for (uint256 i = 0; i < data.length; i++) {
results[i] = Address.functionDelegateCall(address(this), data[i]);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
uint256 private _status;
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
constructor() {
_status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be NOT_ENTERED
if (_status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
_status = ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == ENTERED;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
/**
* @dev An operation with an ERC20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data);
if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @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).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
}
}
{
"compilationTarget": {
"contracts/MaverickV2LockupDistributor.sol": "MaverickV2LockupDistributor"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 2500
},
"remappings": [
":@maverick/=node_modules/@maverick/",
":@openzeppelin/=node_modules/@openzeppelin/",
":@prb/=node_modules/@prb/",
":forge-std/=node_modules/forge-std/src/"
]
}
[{"inputs":[{"internalType":"bytes32","name":"_merkleRoot","type":"bytes32"},{"internalType":"contract IMaverickV2VotingEscrow","name":"_veMavV2","type":"address"},{"internalType":"contract IStake","name":"_stakeDaoContract","type":"address"},{"internalType":"contract IUnlock","name":"_unlockContract","type":"address"},{"internalType":"contract ISpiral","name":"_spiralDaoContract","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"AddressInsufficientBalance","type":"error"},{"inputs":[],"name":"DistributorAccountIsNotSender","type":"error"},{"inputs":[],"name":"DistributorAlreadyClaimed","type":"error"},{"inputs":[],"name":"DistributorClaimPeriodNotYetOpen","type":"error"},{"inputs":[],"name":"DistributorInvalidProof","type":"error"},{"inputs":[],"name":"DistributorInvalidStakeDuration","type":"error"},{"inputs":[{"internalType":"uint256","name":"initialTotalSupply","type":"uint256"},{"internalType":"uint256","name":"expectedTotalSupply","type":"uint256"},{"internalType":"uint256","name":"postStakeTotalSupply","type":"uint256"}],"name":"DistributorLockerDidNotLockEnough","type":"error"},{"inputs":[],"name":"FailedInnerCall","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"account","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"index","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"stakeDuration","type":"uint256"}],"name":"Claimed","type":"event"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"}],"name":"claimToMav","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"}],"name":"claimToSpiralDao","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"}],"name":"claimToStakeDao","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"}],"name":"claimToUnlock","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"},{"internalType":"uint256","name":"stakeDuration","type":"uint256"}],"name":"claimToVeMav","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"delegatee","type":"address"},{"internalType":"uint256","name":"nonce","type":"uint256"},{"internalType":"uint256","name":"expiry","type":"uint256"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"}],"name":"delegateVeMavVoteBySignature","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_index","type":"uint256"}],"name":"isClaimed","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint128","name":"amount","type":"uint128"},{"internalType":"uint256","name":"index","type":"uint256"},{"internalType":"uint256","name":"minClaimTimestamp","type":"uint256"},{"internalType":"uint256","name":"minStakeDuration","type":"uint256"},{"internalType":"bytes32[]","name":"proof","type":"bytes32[]"}],"internalType":"struct MaverickV2LockupDistributor.ClaimValue","name":"claimValue","type":"tuple"}],"name":"isProofValid","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"mav","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"merkleRoot","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes[]","name":"data","type":"bytes[]"}],"name":"multicall","outputs":[{"internalType":"bytes[]","name":"results","type":"bytes[]"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"spiralDaoContract","outputs":[{"internalType":"contract ISpiral","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"stakeDaoContract","outputs":[{"internalType":"contract IStake","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"unlockContract","outputs":[{"internalType":"contract IUnlock","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"veMavLegacy","outputs":[{"internalType":"contract ILegacyVeMav","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"veMavV2","outputs":[{"internalType":"contract IMaverickV2VotingEscrow","name":"","type":"address"}],"stateMutability":"view","type":"function"}]