// 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.1) (token/ERC1155/IERC1155.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[EIP].
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the value of tokens of token type `id` owned by `account`.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(
address[] calldata accounts,
uint256[] calldata ids
) external view returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the caller.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {onERC1155Received} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `value` amount.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes calldata data) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {onERC1155BatchReceived} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
*
* Requirements:
*
* - `ids` and `values` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// 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: BSD-3-Clause
pragma solidity =0.8.20;
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import {MerkleProof} from "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
/**
* @title MerkleDistributor
* @dev A contract for distributing tokens to multiple addresses using a Merkle tree.
*/
contract MerkleDistributor {
using SafeERC20 for IERC20;
error MerkleDistributor__PermissionDenied();
error MerkleDistributor__NotStarted();
error MerkleDistributor__Finished();
error MerkleDistributor__Refunded();
error MerkleDistributor__AlreadyRefunded();
error MerkleDistributor__NoClaimableTokensLeft();
error MerkleDistributor__AlreadyClaimed();
error MerkleDistributor__InvalidCaller();
error MerkleDistributor__InvalidProof();
error MerkleDistributor__InvalidParams(string param);
error MerkleDistributor__NothingToRefund();
error MerkleDistributor__InvalidPaginationParameters();
// Events
event Created(uint256 indexed distributionId, address indexed token, bool isERC20, uint40 startTime);
event Refunded(uint256 indexed distributionId, uint256 amount);
event Claimed(uint256 indexed distributionId, address account);
// Struct to store distribution details
struct Distribution {
address token;
bool isERC20;
uint40 walletCount; // max: ~1B wallets
uint40 claimedCount; // 160 + 8 + 40 + 40 = 248 bits
uint176 amountPerClaim;
uint40 startTime; // supports up to year 36,825
uint40 endTime; // 176 + 40 + 40 = 256 bits
address owner;
uint40 refundedAt; // 160 + 40 = 200 bits
bytes32 merkleRoot; // 256 bits
string title;
string ipfsCID; // To store all WL addresses to create the Merkle Proof
mapping(address => bool) isClaimed;
}
Distribution[] public distributions;
/**
* @dev Modifier to check if the caller is the owner of the distribution.
* @param distributionId The ID of the distribution.
*/
modifier onlyOwner(uint256 distributionId) {
if (msg.sender != distributions[distributionId].owner) revert MerkleDistributor__PermissionDenied();
_;
}
/**
* @dev Creates a new token distribution.
* @param token The address of the token to be distributed.
* @param isERC20 Flag indicating if the token is an ERC20 token.
* @param amountPerClaim The amount of tokens to be distributed per claim.
* @param walletCount The number of wallets to distribute tokens to.
* @param startTime The start time of the distribution.
* @param endTime The end time of the distribution.
* @param merkleRoot The Merkle root of the distribution (optional).
* @param title The title of the distribution (optional).
* @param ipfsCID The IPFS CID of the distribution (optional).
*
* @notice If the Merkle root is not provided, there will be no verification on claims,
* anyone can claim all tokens with multiple accounts.
*/
function createDistribution(
address token,
bool isERC20,
uint176 amountPerClaim,
uint40 walletCount,
uint40 startTime,
uint40 endTime,
bytes32 merkleRoot,
string calldata title,
string calldata ipfsCID
) external {
if (token == address(0)) revert MerkleDistributor__InvalidParams('token');
if (amountPerClaim == 0) revert MerkleDistributor__InvalidParams('amountPerClaim');
if (walletCount == 0) revert MerkleDistributor__InvalidParams('walletCount');
if (endTime <= block.timestamp) revert MerkleDistributor__InvalidParams('endTime');
if (startTime >= endTime) revert MerkleDistributor__InvalidParams('startTime');
// Create a new distribution
distributions.push();
Distribution storage distribution = distributions[distributions.length - 1];
distribution.token = token;
distribution.isERC20 = isERC20;
distribution.walletCount = walletCount;
// distribution.claimedCount = 0;
distribution.amountPerClaim = amountPerClaim;
distribution.startTime = startTime;
distribution.endTime = endTime;
distribution.owner = msg.sender;
// distribution.refundedAt = 0;
distribution.merkleRoot = merkleRoot; // optional
distribution.title = title; // optional
distribution.ipfsCID = ipfsCID; // optional
// Deposit total amount of tokens to this contract
if (isERC20) {
IERC20(token).safeTransferFrom(msg.sender, address(this), amountPerClaim * walletCount);
} else {
// Only support an ERC1155 token at id = 0
IERC1155(token).safeTransferFrom(msg.sender, address(this), 0, amountPerClaim * walletCount, "");
}
emit Created(distributions.length - 1, token, isERC20, startTime);
}
/**
* @dev Allows a user to claim tokens from a specific distribution using a merkle proof.
* @param distributionId The ID of the distribution.
* @param merkleProof The merkle proof for the user's claim.
*/
function claim(uint256 distributionId, bytes32[] calldata merkleProof) external {
Distribution storage distribution = distributions[distributionId];
if (distribution.startTime > block.timestamp) revert MerkleDistributor__NotStarted();
if (distribution.endTime < block.timestamp) revert MerkleDistributor__Finished();
if (distribution.refundedAt > 0) revert MerkleDistributor__Refunded();
if (distribution.isClaimed[msg.sender]) revert MerkleDistributor__AlreadyClaimed();
if (distribution.claimedCount >= distribution.walletCount) revert MerkleDistributor__NoClaimableTokensLeft();
if (distribution.merkleRoot == bytes32(0)) { // Public airdrop
// NOTE: Block contracts from claiming tokens to prevent abuse during a public airdrop.
// This won't completely eliminate bot claiming but will make it more challenging.
// Caveat: ERC4337-based wallets will also be unable to claim; however, they can use an EOA to do so.
if(tx.origin != msg.sender) revert MerkleDistributor__InvalidCaller();
} else { // Whitelist only
if (!MerkleProof.verify(
merkleProof,
distribution.merkleRoot,
keccak256(abi.encodePacked(msg.sender))
)) revert MerkleDistributor__InvalidProof();
}
// Mark it claimed and send the token
distribution.isClaimed[msg.sender] = true;
distribution.claimedCount += 1;
if (distribution.isERC20) {
IERC20(distribution.token).safeTransfer(msg.sender, distribution.amountPerClaim);
} else {
// Only support an ERC1155 token at id = 0
IERC1155(distribution.token).safeTransferFrom(address(this), msg.sender, 0, distribution.amountPerClaim, "");
}
emit Claimed(distributionId, msg.sender);
}
/**
* @dev Allows the owner to refund the remaining tokens from a specific distribution.
* @param distributionId The ID of the distribution to refund.
* @notice The owner can refund the remaining tokens whenever they want, even during the distribution.
*/
function refund(uint256 distributionId) external onlyOwner(distributionId) {
Distribution storage distribution = distributions[distributionId];
if (distribution.refundedAt > 0) revert MerkleDistributor__AlreadyRefunded();
uint256 amountLeft = getAmountLeft(distributionId);
if (amountLeft == 0) revert MerkleDistributor__NothingToRefund();
distribution.refundedAt = uint40(block.timestamp);
// Transfer the remaining tokens back to the owner
if (distribution.isERC20) {
IERC20(distribution.token).safeTransfer(distribution.owner, amountLeft);
} else {
// Only support an ERC1155 token at id = 0
IERC1155(distribution.token).safeTransferFrom(address(this), distribution.owner, 0, amountLeft, "");
}
emit Refunded(distributionId, amountLeft);
}
// MARK: - Utility functions
/**
* @dev Checks if a distribution is whitelist-only.
* @param distributionId The ID of the distribution.
* @return A boolean indicating whether the distribution is whitelist-only.
*/
function isWhitelistOnly(uint256 distributionId) external view returns (bool) {
return distributions[distributionId].merkleRoot != bytes32(0);
}
/**
* @dev Checks if an address is whitelisted for a specific distribution.
* @param distributionId The ID of the distribution.
* @param wallet The address to check.
* @param merkleProof The Merkle proof for the address.
* @return A boolean indicating whether the address is whitelisted.
*/
function isWhitelisted(uint256 distributionId, address wallet, bytes32[] calldata merkleProof) external view returns (bool) {
return MerkleProof.verify(
merkleProof,
distributions[distributionId].merkleRoot,
keccak256(abi.encodePacked(wallet))
);
}
/**
* @dev Checks if a specific wallet address has claimed the tokens for a given distribution ID.
* @param distributionId The ID of the distribution.
* @param wallet The wallet address to check.
* @return A boolean indicating whether the wallet address has claimed the tokens or not.
*/
function isClaimed(uint256 distributionId, address wallet) external view returns (bool) {
return distributions[distributionId].isClaimed[wallet];
}
/**
* @dev Returns the amount of tokens left to be claimed for a specific distribution.
* @param distributionId The ID of the distribution.
* @return The amount of tokens left to be claimed.
*/
function getAmountLeft(uint256 distributionId) public view returns (uint256) {
Distribution storage distribution = distributions[distributionId];
return distribution.amountPerClaim * (distribution.walletCount - distribution.claimedCount);
}
/**
* @dev Returns the total amount claimed for a specific distribution.
* @param distributionId The ID of the distribution.
* @return The total amount claimed for the distribution.
*/
function getAmountClaimed(uint256 distributionId) external view returns (uint256) {
Distribution storage distribution = distributions[distributionId];
return distribution.amountPerClaim * distribution.claimedCount;
}
/**
* @dev Returns the number of distributions in the MerkleDistributor contract.
* @return The number of distributions.
*/
function distributionCount() external view returns (uint256) {
return distributions.length;
}
/**
* @dev Retrieves the distribution IDs for a given token address within a specified range.
* @param token The address of the token.
* @param start The starting index of the range (inclusive).
* @param stop The ending index of the range (exclusive).
* @return ids An array of distribution IDs within the specified range.
*/
function getDistributionIdsByToken(address token, uint256 start, uint256 stop) external view returns (uint256[] memory ids) {
if (start >= stop || stop - start > 10000) revert MerkleDistributor__InvalidPaginationParameters();
unchecked {
uint256 distributionsLength = distributions.length;
if (stop > distributionsLength) {
stop = distributionsLength;
}
uint256 count;
for (uint256 i = start; i < stop; ++i) {
if (distributions[i].token == token) ++count;
}
ids = new uint256[](count);
uint256 j;
for (uint256 i = start; i < stop; ++i) {
if (distributions[i].token == token) {
ids[j++] = i;
if (j == count) break;
}
}
}
}
/**
* @dev Retrieves the distribution IDs owned by a specific address within a given range.
* @param owner The address of the owner.
* @param start The starting index of the range (inclusive).
* @param stop The ending index of the range (exclusive).
* @return ids An array of distribution IDs owned by the specified address within the given range.
*/
function getDistributionIdsByOwner(address owner, uint256 start, uint256 stop) external view returns (uint256[] memory ids) {
if (start >= stop || stop - start > 10000) revert MerkleDistributor__InvalidPaginationParameters();
unchecked {
uint256 distributionsLength = distributions.length;
if (stop > distributionsLength) {
stop = distributionsLength;
}
uint256 count;
for (uint256 i = start; i < stop; ++i) {
if (distributions[i].owner == owner) ++count;
}
ids = new uint256[](count);
uint256 j;
for (uint256 i = start; i < stop; ++i) {
if (distributions[i].owner == owner) {
ids[j++] = i;
if (j == count) break;
}
}
}
}
// MARK: - ERC1155 Receiver
function onERC1155Received(address, address, uint256, uint256, bytes memory) external pure returns (bytes4) {
return this.onERC1155Received.selector;
}
}
// 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/MerkleDistributor.sol": "MerkleDistributor"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 50000
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"AddressInsufficientBalance","type":"error"},{"inputs":[],"name":"FailedInnerCall","type":"error"},{"inputs":[],"name":"MerkleDistributor__AlreadyClaimed","type":"error"},{"inputs":[],"name":"MerkleDistributor__AlreadyRefunded","type":"error"},{"inputs":[],"name":"MerkleDistributor__Finished","type":"error"},{"inputs":[],"name":"MerkleDistributor__InvalidCaller","type":"error"},{"inputs":[],"name":"MerkleDistributor__InvalidPaginationParameters","type":"error"},{"inputs":[{"internalType":"string","name":"param","type":"string"}],"name":"MerkleDistributor__InvalidParams","type":"error"},{"inputs":[],"name":"MerkleDistributor__InvalidProof","type":"error"},{"inputs":[],"name":"MerkleDistributor__NoClaimableTokensLeft","type":"error"},{"inputs":[],"name":"MerkleDistributor__NotStarted","type":"error"},{"inputs":[],"name":"MerkleDistributor__NothingToRefund","type":"error"},{"inputs":[],"name":"MerkleDistributor__PermissionDenied","type":"error"},{"inputs":[],"name":"MerkleDistributor__Refunded","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"distributionId","type":"uint256"},{"indexed":false,"internalType":"address","name":"account","type":"address"}],"name":"Claimed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"distributionId","type":"uint256"},{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":false,"internalType":"bool","name":"isERC20","type":"bool"},{"indexed":false,"internalType":"uint40","name":"startTime","type":"uint40"}],"name":"Created","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"distributionId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Refunded","type":"event"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"},{"internalType":"bytes32[]","name":"merkleProof","type":"bytes32[]"}],"name":"claim","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"bool","name":"isERC20","type":"bool"},{"internalType":"uint176","name":"amountPerClaim","type":"uint176"},{"internalType":"uint40","name":"walletCount","type":"uint40"},{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"uint40","name":"endTime","type":"uint40"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"title","type":"string"},{"internalType":"string","name":"ipfsCID","type":"string"}],"name":"createDistribution","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"distributionCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"distributions","outputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"bool","name":"isERC20","type":"bool"},{"internalType":"uint40","name":"walletCount","type":"uint40"},{"internalType":"uint40","name":"claimedCount","type":"uint40"},{"internalType":"uint176","name":"amountPerClaim","type":"uint176"},{"internalType":"uint40","name":"startTime","type":"uint40"},{"internalType":"uint40","name":"endTime","type":"uint40"},{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint40","name":"refundedAt","type":"uint40"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"string","name":"title","type":"string"},{"internalType":"string","name":"ipfsCID","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"}],"name":"getAmountClaimed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"}],"name":"getAmountLeft","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"start","type":"uint256"},{"internalType":"uint256","name":"stop","type":"uint256"}],"name":"getDistributionIdsByOwner","outputs":[{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"start","type":"uint256"},{"internalType":"uint256","name":"stop","type":"uint256"}],"name":"getDistributionIdsByToken","outputs":[{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"},{"internalType":"address","name":"wallet","type":"address"}],"name":"isClaimed","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"}],"name":"isWhitelistOnly","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"},{"internalType":"address","name":"wallet","type":"address"},{"internalType":"bytes32[]","name":"merkleProof","type":"bytes32[]"}],"name":"isWhitelisted","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"uint256","name":"distributionId","type":"uint256"}],"name":"refund","outputs":[],"stateMutability":"nonpayable","type":"function"}]