// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)pragmasolidity ^0.8.20;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/errorAddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/errorAddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/errorFailedInnerCall();
/**
* @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].
*/functionsendValue(addresspayable 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.
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
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`.
*/functionfunctionCallWithValue(address target, bytesmemory data, uint256 value) internalreturns (bytesmemory) {
if (address(this).balance< value) {
revert AddressInsufficientBalance(address(this));
}
(bool success, bytesmemory 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.
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
(bool success, bytesmemory 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.
*/functionverifyCallResultFromTarget(address target,
bool success,
bytesmemory returndata
) internalviewreturns (bytesmemory) {
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 contractif (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.
*/functionverifyCallResult(bool success, bytesmemory returndata) internalpurereturns (bytesmemory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
*/function_revert(bytesmemory returndata) privatepure{
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly/// @solidity memory-safe-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}
Contract Source Code
File 2 of 22: Amount.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Represents the ERC20 token amount.type Amount isuint256;
using {addas+, subas-, isZero} forAmountglobal;
functionadd(Amount a, Amount b) purereturns (Amount sum) {
sum = Amount.wrap(Amount.unwrap(a) + Amount.unwrap(b));
}
functionsub(Amount a, Amount b) purereturns (Amount difference) {
difference = Amount.wrap(Amount.unwrap(a) - Amount.unwrap(b));
}
functionisZero(Amount a) purereturns (bool result) {
result = Amount.unwrap(a) ==0;
}
Contract Source Code
File 3 of 22: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Context.sol)pragmasolidity ^0.8.20;/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 4 of 22: Create2.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Create2.sol)pragmasolidity ^0.8.20;/**
* @dev Helper to make usage of the `CREATE2` EVM opcode easier and safer.
* `CREATE2` can be used to compute in advance the address where a smart
* contract will be deployed, which allows for interesting new mechanisms known
* as 'counterfactual interactions'.
*
* See the https://eips.ethereum.org/EIPS/eip-1014#motivation[EIP] for more
* information.
*/libraryCreate2{
/**
* @dev Not enough balance for performing a CREATE2 deploy.
*/errorCreate2InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev There's no code to deploy.
*/errorCreate2EmptyBytecode();
/**
* @dev The deployment failed.
*/errorCreate2FailedDeployment();
/**
* @dev Deploys a contract using `CREATE2`. The address where the contract
* will be deployed can be known in advance via {computeAddress}.
*
* The bytecode for a contract can be obtained from Solidity with
* `type(contractName).creationCode`.
*
* Requirements:
*
* - `bytecode` must not be empty.
* - `salt` must have not been used for `bytecode` already.
* - the factory must have a balance of at least `amount`.
* - if `amount` is non-zero, `bytecode` must have a `payable` constructor.
*/functiondeploy(uint256 amount, bytes32 salt, bytesmemory bytecode) internalreturns (address addr) {
if (address(this).balance< amount) {
revert Create2InsufficientBalance(address(this).balance, amount);
}
if (bytecode.length==0) {
revert Create2EmptyBytecode();
}
/// @solidity memory-safe-assemblyassembly {
addr :=create2(amount, add(bytecode, 0x20), mload(bytecode), salt)
}
if (addr ==address(0)) {
revert Create2FailedDeployment();
}
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy}. Any change in the
* `bytecodeHash` or `salt` will result in a new destination address.
*/functioncomputeAddress(bytes32 salt, bytes32 bytecodeHash) internalviewreturns (address) {
return computeAddress(salt, bytecodeHash, address(this));
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy} from a contract located at
* `deployer`. If `deployer` is this contract's address, returns the same value as {computeAddress}.
*/functioncomputeAddress(bytes32 salt, bytes32 bytecodeHash, address deployer) internalpurereturns (address addr) {
/// @solidity memory-safe-assemblyassembly {
let ptr :=mload(0x40) // Get free memory pointer// | | ↓ ptr ... ↓ ptr + 0x0B (start) ... ↓ ptr + 0x20 ... ↓ ptr + 0x40 ... |// |-------------------|---------------------------------------------------------------------------|// | bytecodeHash | CCCCCCCCCCCCC...CC |// | salt | BBBBBBBBBBBBB...BB |// | deployer | 000000...0000AAAAAAAAAAAAAAAAAAA...AA |// | 0xFF | FF |// |-------------------|---------------------------------------------------------------------------|// | memory | 000000...00FFAAAAAAAAAAAAAAAAAAA...AABBBBBBBBBBBBB...BBCCCCCCCCCCCCC...CC |// | keccak(start, 85) | ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ |mstore(add(ptr, 0x40), bytecodeHash)
mstore(add(ptr, 0x20), salt)
mstore(ptr, deployer) // Right-aligned with 12 preceding garbage byteslet start :=add(ptr, 0x0b) // The hashed data starts at the final garbage byte which we will set to 0xffmstore8(start, 0xff)
addr :=keccak256(start, 85)
}
}
}
Contract Source Code
File 5 of 22: IERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)pragmasolidity ^0.8.20;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed 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.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (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.
*/functiontransfer(address to, uint256 value) externalreturns (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.
*/functionallowance(address owner, address spender) externalviewreturns (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.
*/functionapprove(address spender, uint256 value) externalreturns (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.
*/functiontransferFrom(addressfrom, address to, uint256 value) externalreturns (bool);
}
Contract Source Code
File 6 of 22: IERC20Permit.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)pragmasolidity ^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.
*/interfaceIERC20Permit{
/**
* @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.
*/functionpermit(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.
*/functionnonces(address owner) externalviewreturns (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-mixedcasefunctionDOMAIN_SEPARATOR() externalviewreturns (bytes32);
}
Contract Source Code
File 7 of 22: IMerkleDistributor.sol
// SPDX-License-Identifier: GPL-3.0-or-laterpragmasolidity =0.8.20;// Allows anyone to claim a token if they exist in a merkle root.interfaceIMerkleDistributor{
// Returns the address of the token distributed by this contract.functiontoken() externalviewreturns (address);
// Returns the merkle root of the merkle tree containing account balances available to claim.functionmerkleRoot() externalviewreturns (bytes32);
// Returns true if the index has been marked claimed.functionisClaimed(uint256 index) externalviewreturns (bool);
// Claim the given amount of the token to the given address. Reverts if the inputs are invalid.functionclaim(uint256 index,
address account,
uint256 amount,
bytes32[] calldata merkleProof
) external;
// This event is triggered whenever a call to #claim succeeds.eventClaimed(uint256 index, address account, uint256 amount);
}
Contract Source Code
File 8 of 22: IMerkleDistributorPeriphery.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;import {IERC20} from"@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IMerkleDistributorWithDeadline} from"src/uniswap/interfaces/IMerkleDistributorWithDeadline.sol";
import {IOwnable2Step} from"src/interfaces/IOwnable2Step.sol";
import {Amount} from"src/types/Amount.sol";
import {Id} from"src/types/Id.sol";
import {Index} from"src/types/Index.sol";
import {MerkleProof} from"src/types/MerkleProof.sol";
import {MerkleRoot} from"src/types/MerkleRoot.sol";
import {Number} from"src/types/Number.sol";
import {Timestamp} from"src/types/Timestamp.sol";
/// @title A periphery contract to deploy and manage Merkle Distributor contracts./// @author Timelord/// @dev The owner can deploy new Merkle Distributor contracts and token transfer./// @dev Users can claim rewards from multiple Distributor contracts.interfaceIMerkleDistributorPeripheryisIOwnable2Step{
eventQueue(addressindexed deployer,
IERC20 indexed token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
);
eventUnqueue();
eventCreateFromQueue(
Id indexed id,
IMerkleDistributorWithDeadline indexed distributor,
IERC20 indexed token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
);
/// @dev Event emitted when the contract deploys a new distributor contract./// @notice Only emitted once for a unique id and distributor address./// @param id The id of the newly deployed distributor contract. Id increments per new deployment./// The id parameter is indexed, to query for one specific event for the given id./// @param distributor The address of the newly deployed distributor contract./// The distributor parameter is indexed, to query for one specific event for the given address./// @param token The address of the ERC20 token reward./// The token parameter is indexed, to query for all events where the reward is the ERC20 token./// @param totalAmount The total amount of ERC20 token reward./// @param merkleRoot The 32 bytes merkle root./// @param endTime The deadline for claiming the rewards in unix timestamp.eventCreate(
Id indexed id,
IMerkleDistributorWithDeadline indexed distributor,
IERC20 indexed token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
);
/// @dev Event emitted when the owner withdraws the remaining rewards after deadline from a distributor contract./// @notice Only emitted once for a unique id and distributor address./// @param distributor The address of the distributor contract where the rewards were withdrawn./// The distributor parameter is indexed, to query for one specific withdraw event for the given address./// @param amount The amount of remaining ERC20 token reward withdrawn.eventWithdraw(
IMerkleDistributorWithDeadline indexed distributor,
Amount amount
);
errorCannotQueueWithDeployerAsZeroAddress();
errorCannotQueueWithTokenAsZeroAddress();
errorCannotQueueWithTotalAmountAsZero();
errorCannotQueueWithEndTimeInThePast();
/// @dev Reverts with this error when calling the create function with token address as zero.errorCannotCreateWithTokenAsZeroAddress();
/// @dev Reverts with this error when calling the create function with total amount as zero.errorCannotCreateWithTotalAmountAsZero();
/// @dev Reverts with this error when calling the create function with end time in the past.errorCannotCreateWithEndTimeInThePast();
errorOnlyAuthorizedOwner(address account);
errorInconsistentQueuedToken();
errorInconsistentQueuedTotalAmount();
errorInconsistentQueuedMerkleRoot();
errorInconsistentQueuedEndTime();
/// @dev View the address given the id of the distributor contract./// @notice Returns the zero address if the distributor contract is not deployed given the id./// @param id The id of the distributor address.functionmerkleDistributor(
Id id
) externalviewreturns (IMerkleDistributorWithDeadline);
/// @dev View the total number of distributor contracts deployed.functiontotalMerkleDistributors() externalviewreturns (Number);
functionownerGivenId(Id id) externalviewreturns (address);
/// @dev A record of a single query for areClaimed function call./// @param distributor The address of the distributor contract being queried./// @param index The index of the mapping of user address and reward amount where the merkle root is generated from.structQuery {
IMerkleDistributorWithDeadline distributor;
Index index;
}
/// @dev Checks that the reward from multiple distributors are claimed given the index of the mapping./// @param queries The list of queries./// @return results The list of boolean results./// @notice The length of queries and results will always be equal./// @notice When the query distributor address does not exist or the index does not exist for the mapping, it will return false.functionareClaimed(
Query[] calldata queries
) externalviewreturns (bool[] memory results);
functionqueued()
externalviewreturns (address deployer,
IERC20 token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
);
functionqueue(address deployer,
IERC20 token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
) external;
functionunqueue() external;
functioncreateFromQueue(
IERC20 token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
) externalreturns (Id id, IMerkleDistributorWithDeadline distributor);
/// @dev The owner deploys a new distributor contract and transfer the necessary ERC20 tokens to the distributor./// @dev Emits the Create event./// @notice Can only be called by the owner./// @notice The owner must first approve this contract for token transfer./// @param token The address of the ERC20 token reward./// Reverts when the address does not follow ERC20 standard or is zero address./// Reverts with CannotCreateWithTokenAsZeroAddress when the address is the zero address./// @param totalAmount The total amount of ERC20 token reward being distributed./// Reverts when there is not enough ERC20 token from the owner./// Reverts with CannotCreateWithTotalAmountAsZero when the totalAmount is zero./// @param merkleRoot The merkle root of the distributor contract for claiming verification./// @param endTime The deadline of distribution and claim in unix timestamp./// Reverts when with CannotCreateWithEndTimeInThePast the block timestamp is greater than the endTime on function call./// @return id The id of the newly deployed distributor contract./// @return distributor The address of the newly deployed distributor contract.functioncreate(
IERC20 token,
Amount totalAmount,
MerkleRoot merkleRoot,
Timestamp endTime
) externalreturns (Id id, IMerkleDistributorWithDeadline distributor);
/// @dev A record of a single order for claim function call./// @param distributor The address of the distributor contract being claimed./// @param index The index of the mapping of user address and reward amount where the merkle root is generated from./// @param amount The exact amount of ERC20 token address being claimed./// @notice The amount must be exactly equal to the mapping of user address and reward amount./// @param merkleProof A list of 32 bytes for verification of claiming.structOrder {
IMerkleDistributorWithDeadline distributor;
Index index;
Amount amount;
MerkleProof[] merkleProof;
}
/// @dev Msg sender claims the rewards given the list of orders./// @dev Transfer the ERC20 token rewards to the correct user./// @notice Reverts when any of the orders fail./// @notice User can alternatively claim the rewards directly from the individual distributor contracts, but one at a time./// @notice The contract does not emit any events. Instead the individual distributor contracts will emit the Claimed events./// Ingest these events by getting the address of the deployed distributor contracts from the Create event./// @param orders The list of orders for claiming.functionclaim(Order[] calldata orders) external;
/// @dev The owner withdraws the remaining rewards of the distributor contracts./// @dev Can only be called when the distributor contracts have reached the endTime deadline./// @dev Emits Withdraw event for each withdrawal of distributor contracts./// @notice Reverts when any withdrawals fail./// @param distributors The list of distributor addresses to withdraw from./// @return amounts The list of amount of token withdrawn./// Distributors and amounts will always have the same length./// The token denomination of amount is the token reward of the distributor of the same index.functionwithdraw(
IMerkleDistributorWithDeadline[] calldata distributors
) externalreturns (Amount[] memory amounts);
}
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @title Interface for Two Step Ownable contract/// @author TimelordinterfaceIOwnable2Step{
/// @dev Returns the address of the owner./// @notice Returns zero when there is no owner.functionowner() externalviewreturns (address);
/// @dev Returns the address of the pending owner./// @notice Returns zero when there is no pending owner.functionpendingOwner() externalviewreturns (address);
/// @dev Renounce ownership of the contract./// @dev Can only be called by the owner./// @dev The address of the owner will change to zero address./// @notice This transaction cannot be reversed./// @notice Owner must make sure any remaining rewards in the distributors are all withdrawn.functionrenounceOwnership() external;
/// @dev Transfer the ownership to another address./// @dev Can only be called by the owner./// @dev Does not transfer the ownership immediately, instead set the pending owner first./// @notice The pending owner must accept ownership to finalize the ownership transfer./// @param newOwner The address of the new pending owner.functiontransferOwnership(address newOwner) external;
/// @dev The new pending owner accepts the ownership transfer./// @notice Can only be called by the pending owner.functionacceptOwnership() external;
}
Contract Source Code
File 11 of 22: Id.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Unique id for identification.type Id isuint256;
Contract Source Code
File 12 of 22: Index.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev The index for mapping of user addresses and reward amount.type Index isuint256;
Contract Source Code
File 13 of 22: MerkleDistributor.sol
// SPDX-License-Identifier: GPL-3.0-or-laterpragmasolidity =0.8.20;import {IERC20, SafeERC20} from"openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import {MerkleProof} from"openzeppelin-contracts/contracts/utils/cryptography/MerkleProof.sol";
import {IMerkleDistributor} from"./interfaces/IMerkleDistributor.sol";
errorAlreadyClaimed();
errorInvalidProof();
contractMerkleDistributorisIMerkleDistributor{
usingSafeERC20forIERC20;
addresspublicimmutableoverride token;
bytes32publicimmutableoverride merkleRoot;
// This is a packed array of booleans.mapping(uint256=>uint256) private claimedBitMap;
constructor(address token_, bytes32 merkleRoot_) {
token = token_;
merkleRoot = merkleRoot_;
}
functionisClaimed(uint256 index) publicviewoverridereturns (bool) {
uint256 claimedWordIndex = index /256;
uint256 claimedBitIndex = index %256;
uint256 claimedWord = claimedBitMap[claimedWordIndex];
uint256 mask = (1<< claimedBitIndex);
return claimedWord & mask == mask;
}
function_setClaimed(uint256 index) private{
uint256 claimedWordIndex = index /256;
uint256 claimedBitIndex = index %256;
claimedBitMap[claimedWordIndex] =
claimedBitMap[claimedWordIndex] |
(1<< claimedBitIndex);
}
functionclaim(uint256 index,
address account,
uint256 amount,
bytes32[] calldata merkleProof
) publicvirtualoverride{
if (isClaimed(index)) revert AlreadyClaimed();
// Verify the merkle proof.bytes32 node =keccak256(abi.encodePacked(index, account, amount));
if (!MerkleProof.verify(merkleProof, merkleRoot, node))
revert InvalidProof();
// Mark it claimed and send the token.
_setClaimed(index);
IERC20(token).safeTransfer(account, amount);
emit Claimed(index, account, amount);
}
}
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Represents the individual 32 bytes from a merkle proof of the distributor contract.type MerkleProof isbytes32;
Contract Source Code
File 17 of 22: MerkleRoot.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Represents the 32 bytes merkle root of the distributor contract.type MerkleRoot isbytes32;
Contract Source Code
File 18 of 22: Number.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Represents the number of contracts.type Number isuint256;
Contract Source Code
File 19 of 22: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)pragmasolidity ^0.8.20;import {Context} from"../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/errorOwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/errorOwnableInvalidOwner(address owner);
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/constructor(address initialOwner) {
if (initialOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
if (newOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 20 of 22: Ownable2Step.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable2Step.sol)pragmasolidity ^0.8.20;import {Ownable} from"./Ownable.sol";
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is specified at deployment time in the constructor for `Ownable`. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/abstractcontractOwnable2StepisOwnable{
addressprivate _pendingOwner;
eventOwnershipTransferStarted(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/functionpendingOwner() publicviewvirtualreturns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualoverrideonlyOwner{
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtualoverride{
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/functionacceptOwnership() publicvirtual{
address sender = _msgSender();
if (pendingOwner() != sender) {
revert OwnableUnauthorizedAccount(sender);
}
_transferOwnership(sender);
}
}
Contract Source Code
File 21 of 22: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^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.
*/librarySafeERC20{
usingAddressforaddress;
/**
* @dev An operation with an ERC20 token failed.
*/errorSafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/errorSafeERC20FailedDecreaseAllowance(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.
*/functionsafeTransfer(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.
*/functionsafeTransferFrom(IERC20 token, addressfrom, 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.
*/functionsafeIncreaseAllowance(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.
*/functionsafeDecreaseAllowance(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.
*/functionforceApprove(IERC20 token, address spender, uint256 value) internal{
bytesmemory 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, bytesmemory 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.bytesmemory 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, bytesmemory data) privatereturns (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, bytesmemory returndata) =address(token).call(data);
return success && (returndata.length==0||abi.decode(returndata, (bool))) &&address(token).code.length>0;
}
}
Contract Source Code
File 22 of 22: Timestamp.sol
// SPDX-License-Identifier: UNLICENSEDpragmasolidity =0.8.20;/// @dev Represents the number of seconds in unix timestamp.type Timestamp isuint256;
using {addas+, subas-, equalas==, notEqualas!=, lessThanas<, lessThanOrEqualas<=, greaterThanas>, greaterThanOrEqualas>=} forTimestampglobal;
functionadd(Timestamp a, Timestamp b) purereturns (Timestamp sum) {
sum = Timestamp.wrap(Timestamp.unwrap(a) + Timestamp.unwrap(b));
}
functionsub(Timestamp a, Timestamp b) purereturns (Timestamp difference) {
difference = Timestamp.wrap(Timestamp.unwrap(a) - Timestamp.unwrap(b));
}
functionequal(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) == Timestamp.unwrap(b);
}
functionnotEqual(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) != Timestamp.unwrap(b);
}
functionlessThan(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) < Timestamp.unwrap(b);
}
functionlessThanOrEqual(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) <= Timestamp.unwrap(b);
}
functiongreaterThan(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) > Timestamp.unwrap(b);
}
functiongreaterThanOrEqual(Timestamp a, Timestamp b) purereturns (bool result) {
result = Timestamp.unwrap(a) >= Timestamp.unwrap(b);
}