// 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) (utils/Context.sol)
pragma solidity ^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.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}
// 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/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) (utils/math/Math.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
/**
* @dev Muldiv operation overflow.
*/
error MathOverflowedMulDiv();
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an overflow flag.
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
return a / b;
}
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
if (denominator <= prod1) {
revert MathOverflowedMulDiv();
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (unsignedRoundsUp(rounding) && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (unsignedRoundsUp(rounding) && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (unsignedRoundsUp(rounding) && 1 << (result << 3) < value ? 1 : 0);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/*
* Merkle Proof library as seen on:
* https://github.com/gnosis/safe-token-distribution/blob/master/tooling/contracts/MerkleProof.sol
*/
library MerkleProof {
function verify(
bytes32[] calldata proof,
bytes32 root,
bytes32 leaf
) internal pure returns (bool) {
bytes32 computed = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computed = hashPair(computed, proof[i]);
}
return computed == root;
}
function hashPair(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
(a, b) = (a < b) ? (a, b) : (b, a);
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^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.
*/
abstract contract Ownable is Context {
address private _owner;
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed 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.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
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.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
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) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/access/Ownable.sol";
import "./PassportRegistry.sol";
contract PassportBuilderScore is Ownable {
PassportRegistry public passportRegistry;
// Mapping to store scores for each passport ID
mapping(uint256 => uint256) private passportScores;
// Mapping to store timestamps of last updates for each passport ID
mapping(uint256 => uint256) private passportLastUpdate;
// Mapping to store trusted signers
mapping(address => bool) public trustedSigners;
event ScoreUpdated(uint256 indexed passportId, uint256 score, uint256 timestamp);
event PassportRegistryChanged(address indexed oldAddress, address indexed newAddress);
uint256 public EXPIRATION_TIME = 1 days * 90; // 90 days
constructor(address passportRegistryAddress, address initialOwner) Ownable(initialOwner) {
passportRegistry = PassportRegistry(passportRegistryAddress);
trustedSigners[initialOwner] = true;
}
/**
* @notice Sets the expiration time for the scores.
* @dev Can only be called by the owner.
* @param newExpirationTime The new expiration time in days.
*/
function setExpirationTime(uint256 newExpirationTime) external onlyOwner {
EXPIRATION_TIME = 1 days * newExpirationTime;
}
/**
* @notice Adds the given address to the list of trusted signers.
* @dev Can only be called by the owner.
* @param signer The address to add to the list of trusted signers.
*/
function addTrustedSigner(address signer) external onlyOwner {
trustedSigners[signer] = true;
}
/**
* @notice Removes the given address from the list of trusted signers.
* @dev Can only be called by the owner.
* @param signer The address to remove from the list of trusted signers.
*/
function removeTrustedSigner(address signer) external onlyOwner {
trustedSigners[signer] = false;
}
/**
* @notice Sets the score for a given passport ID.
* @dev Can only be called by the owner.
* @param passportId The ID of the passport to set the score for.
* @param score The score to set for the passport ID.
*/
function setScore(uint256 passportId, uint256 score) external returns (bool) {
require(trustedSigners[msg.sender], "Caller is not a trusted signer");
require(passportRegistry.idPassport(passportId) != address(0), "Passport ID does not exist");
passportScores[passportId] = score;
passportLastUpdate[passportId] = block.timestamp;
emit ScoreUpdated(passportId, score, block.timestamp);
return true;
}
/**
* @notice Gets the score of a given passport ID.
* @param passportId The ID of the passport to get the score for.
* @return The score of the given passport ID.
*/
function getScore(uint256 passportId) public view returns (uint256) {
uint256 lastUpdate = passportLastUpdate[passportId] == 0 ? block.timestamp : passportLastUpdate[passportId];
require(lastUpdate + EXPIRATION_TIME >= block.timestamp, "Score is expired");
return passportScores[passportId];
}
/**
* @notice Gets the timestamp of the last update for a given passport ID.
* @param passportId The ID of the passport to get the last update timestamp for.
* @return The timestamp of the last update for the given passport ID.
*/
function getLastUpdate(uint256 passportId) external view returns (uint256) {
return passportLastUpdate[passportId];
}
function getLastUpdateByAddress(address wallet) external view returns (uint256) {
return passportLastUpdate[passportRegistry.passportId(wallet)];
}
/**
* @notice Gets the score of a given address.
* @param wallet The address to get the score for.
* @return The score of the given address.
*/
function getScoreByAddress(address wallet) external view returns (uint256) {
uint256 passportId = passportRegistry.passportId(wallet);
require(passportRegistry.idPassport(passportId) != address(0), "Passport ID does not exist");
uint256 score = getScore(passportId);
return score;
}
/**
* @notice Changes the address of the PassportRegistry contract.
* @dev Can only be called by the owner.
* @param newPassportRegistryAddress The address of the new PassportRegistry contract.
*/
function setPassportRegistry(address newPassportRegistryAddress) external onlyOwner {
require(newPassportRegistryAddress != address(0), "Invalid address");
address oldAddress = address(passportRegistry);
passportRegistry = PassportRegistry(newPassportRegistryAddress);
emit PassportRegistryChanged(oldAddress, newPassportRegistryAddress);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/utils/math/Math.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
contract PassportRegistry is Ownable, Pausable {
// wallet => passport id
mapping(address => uint256) public passportId;
// passport id => wallet
mapping(uint256 => address) public idPassport;
// wallet => bool
mapping(address => bool) public walletActive;
// id => bool
mapping(uint256 => bool) public idActive;
// id => source
mapping(uint256 => string) public idSource;
// source => # passports
mapping(string => uint256) public sourcePassports;
// Total number of passports created
uint256 public totalCreates;
// Total number of passports sequencially created
uint256 public totalSequencialCreates;
// Total number of passports created by admins
uint256 public totalAdminsCreates;
// Total number of passport transfers
uint256 public totalPassportTransfers;
// The next id to be issued
uint256 private _nextSequentialPassportId;
// Smart contract id in sequencial mode
bool private _sequencial;
// A new passport has been created
event Create(address indexed wallet, uint256 passportId, string source);
// A passport has been tranfered
event Transfer(uint256 oldPassportId, uint256 newPassportId, address indexed oldWallet, address indexed newWallet);
// A passport has been deactivated
event Deactivate(address indexed wallet, uint256 passportId);
// A passport has been activated
event Activate(address indexed wallet, uint256 passportId);
// Passport generation mode changed
event PassportGenerationChanged(bool sequencial, uint256 nextSequencialPassportId);
// Transfer request initiated
event TransferRequested(address indexed fromWallet, address indexed toWallet, uint256 passportId);
// Transfer request accepted
event TransferAccepted(address indexed fromWallet, address indexed toWallet, uint256 passportId);
// Transfer request revoked
event TransferRevoked(address indexed wallet, uint256 passportId);
mapping(uint256 => address) public transferRequests;
/**
* @dev Modifier to make a function callable only when the contract is in sequencial mode.
*
* Requirements:
*
* - The contract must be in sequencial mode.
*/
modifier whenSequencialGeneration() {
require(sequencial(), "Admin generation mode");
_;
}
/**
* @dev Modifier to make a function callable only when the contract is in admin generation mode.
*
* Requirements:
*
* - The contract must be in admin generation mode.
*/
modifier whenAdminGeneration() {
require(!sequencial(), "Sequencial generation mode");
_;
}
constructor(address initialOwner) Ownable(initialOwner) {
_sequencial = false;
}
/**
* @notice Creates a new passport with the next sequential ID.
* @dev Can only be called when the contract is in sequential generation mode and not paused.
* @param source The source of the passport creation.
*/
function create(string memory source) public whenNotPaused whenSequencialGeneration {
require(passportId[msg.sender] == 0, "Passport already exists");
totalSequencialCreates++;
_create(msg.sender, _nextSequentialPassportId, source);
_nextSequentialPassportId += 1;
}
/**
* @notice Creates a new passport with a specified ID for a specific wallet.
* @dev Can only be called by the owner when the contract is in admin generation mode and not paused.
* @param source The source of the passport creation.
* @param wallet The address of the wallet to associate with the new passport.
* @param id The ID to assign to the new passport.
*/
function adminCreate(
string memory source,
address wallet,
uint256 id
) public onlyOwner whenNotPaused whenAdminGeneration {
require(passportId[wallet] == 0, "Passport already exists");
totalAdminsCreates++;
_create(wallet, id, source);
}
/**
* @notice Transfers the passport ID of the msg.sender to the new wallet.
* @dev Can only be called by the passport owner and when the contract is not paused.
* @param newWallet The address of the new wallet to transfer the passport to.
*/
function transfer(address newWallet) public whenNotPaused {
uint256 id = passportId[msg.sender];
require(newWallet != msg.sender, "You can not transfer to yourself");
require(newWallet != address(0), "You can not transfer to zero address");
require(id != 0, "Passport does not exist");
require(passportId[newWallet] == 0, "Wallet passed already has a passport");
require(transferRequests[id] == address(0), "Pending transfer already exists for this passport ID");
transferRequests[id] = newWallet;
emit TransferRequested(msg.sender, newWallet, id);
}
/**
* @notice Accepts a pending passport transfer to the msg.sender's wallet.
* @dev Can be called by the new wallet to accept the transfer.
*/
function acceptTransfer(uint256 _passportId) public whenNotPaused {
address newWallet = transferRequests[_passportId];
require(newWallet == msg.sender, "You are not authorized to accept this transfer");
address oldWallet = idPassport[_passportId];
require(oldWallet != address(0), "Passport does not exist");
passportId[oldWallet] = 0;
passportId[newWallet] = _passportId;
idPassport[_passportId] = newWallet;
walletActive[oldWallet] = false;
walletActive[newWallet] = true;
totalPassportTransfers++;
delete transferRequests[_passportId];
emit TransferAccepted(oldWallet, newWallet, _passportId);
emit Transfer(_passportId, _passportId, oldWallet, newWallet);
}
/**
* @notice Revokes a pending passport transfer.
* @dev Can only be called by the passport owner and when the contract is not paused.
* @param _passportId The ID of the passport for which to revoke the transfer.
*/
function revokeTransfer(uint256 _passportId) public whenNotPaused {
address owner = idPassport[_passportId];
require(owner == msg.sender, "You are not the owner of this passport");
require(transferRequests[_passportId] != address(0), "No pending transfer to revoke");
delete transferRequests[_passportId];
emit TransferRevoked(msg.sender, _passportId);
}
// Admin
/**
* @notice Transfers the passport ID from one wallet to another.
* @dev Can only be called by the owner (aka admin).
* @param wallet The address of the wallet to transfer the passport from.
* @param id The new passport ID to assign to the wallet.
*/
function adminTransfer(address wallet, uint256 id) public onlyOwner {
uint256 oldId = passportId[wallet];
address idOwner = idPassport[id];
require(oldId != 0, "Wallet does not have a passport to transfer from");
require(idOwner == address(0), "New passport id already has a owner");
string memory source = idSource[oldId];
idSource[id] = source;
idSource[oldId] = "";
passportId[wallet] = id;
idPassport[oldId] = address(0);
walletActive[wallet] = true;
idActive[id] = true;
idActive[oldId] = false;
totalPassportTransfers++;
emit Transfer(oldId, id, wallet, wallet);
}
/**
* @notice Activates the passport with the given passport ID.
* @dev Can only be called by the owner when the contract is not paused.
* @param _passportId The ID of the passport to activate.
*/
function activate(uint256 _passportId) public whenNotPaused onlyOwner {
address wallet = idPassport[_passportId];
require(wallet != address(0), "Passport must exist");
require(walletActive[wallet] == false, "Passport must be inactive");
walletActive[wallet] = true;
idActive[_passportId] = true;
// emit event
emit Activate(wallet, _passportId);
}
/**
* @notice Deactivates the passport with the given passport ID.
* @dev Can only be called by the owner when the contract is not paused.
* @param _passportId The ID of the passport to deactivate.
*/
function deactivate(uint256 _passportId) public whenNotPaused onlyOwner {
address wallet = idPassport[_passportId];
require(wallet != address(0), "Passport must exist");
require(walletActive[wallet] == true, "Passport must be active");
walletActive[wallet] = false;
idActive[_passportId] = false;
// emit event
emit Deactivate(wallet, _passportId);
}
/**
* @notice Pauses the contract, disabling future creations.
* @dev Can only be called by the owner.
*/
function pause() public whenNotPaused onlyOwner {
_pause();
}
/**
* @notice Enables the contract, enabling new creations.
* @dev Can only be called by the owner.
*/
function unpause() public whenPaused onlyOwner {
_unpause();
}
/**
* @notice Changes the contract generation mode.
* @dev Can only be called by the owner.
* @param sequentialFlag Set to true for sequential generation mode, false for admin generation mode.
* @param nextSequentialPassportId The next sequential passport ID to be issued.
*/
function setGenerationMode(bool sequentialFlag, uint256 nextSequentialPassportId) public onlyOwner {
_sequencial = sequentialFlag;
_nextSequentialPassportId = nextSequentialPassportId;
emit PassportGenerationChanged(sequentialFlag, nextSequentialPassportId);
}
/**
* @dev Returns true if the contract is in sequencial mode, and false otherwise.
*/
function sequencial() public view virtual returns (bool) {
return _sequencial;
}
/**
* @dev Returns the next id to be generated.
*/
function nextId() public view virtual returns (uint256) {
return _nextSequentialPassportId;
}
// private
/**
* @dev Creates a new passport with the given ID for the specified wallet.
* @param wallet The address of the wallet to associate with the new passport.
* @param id The ID to assign to the new passport.
* @param source The source of the passport creation.
*/
function _create(address wallet, uint256 id, string memory source) private {
require(idPassport[id] == address(0), "Passport id already issued");
totalCreates++;
idPassport[id] = wallet;
passportId[wallet] = id;
walletActive[wallet] = true;
idActive[id] = true;
idSource[id] = source;
uint256 result = sourcePassports[source] + 1;
sourcePassports[source] = result;
emit Create(wallet, id, source);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/utils/math/Math.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "./PassportRegistry.sol";
contract PassportWalletRegistry is Ownable, Pausable {
// wallet => passport id
mapping(address => uint256) private _addressPassportId;
PassportRegistry public passportRegistry;
// A new wallet passportId relation is created
event WalletAdded(address indexed wallet, uint256 passportId);
// A wallet passportId relation is removed
event WalletRemoved(address indexed wallet, uint256 passportId);
// Emitted when the passport registry address is changed
event PassportRegistryChanged(address indexed oldAddress, address indexed newAddress);
constructor(address initialOwner, address passportRegistryAddress) Ownable(initialOwner) {
passportRegistry = PassportRegistry(passportRegistryAddress);
}
/**
* @notice Sets the passport registry address.
* @param passportRegistryAddress The address of the passport registry.
*/
function setPassportRegistry(address passportRegistryAddress) public onlyOwner {
require(passportRegistryAddress != address(0), "Invalid address");
emit PassportRegistryChanged(address(passportRegistry), passportRegistryAddress);
passportRegistry = PassportRegistry(passportRegistryAddress);
}
/**
* @notice Gets the passportID associated with a wallet.
* @param wallet The wallet to get the passportID for.
* @return The passportId of the given wallet.
*/
function passportId(address wallet) public view returns (uint256) {
uint256 _passportId = _addressPassportId[wallet];
return _passportId != 0 ? _addressPassportId[wallet] : passportRegistry.passportId(wallet);
}
/**
* @notice Creates a new passport with the next sequential ID.
* @dev Can only be called when the contract is not paused and by the owner.
* @param wallet The wallet address to associate.
* @param _passportId The passportId to associate.
*/
function addWallet(address wallet, uint256 _passportId) public whenNotPaused {
require(_addressPassportId[wallet] == 0, "Passport already exists");
require(passportRegistry.idPassport(_passportId) != address(0), "Passport ID does not exist");
require(passportRegistry.passportId(msg.sender) == _passportId, "Only the passport owner can add new wallets");
_addressPassportId[wallet] = _passportId;
emit WalletAdded(wallet, _passportId);
}
/**
* @notice Creates a new passport with the next sequential ID.
* @dev Can only be called when the contract is not paused and by the owner.
* @param wallet The wallet address to associate.
* @param _passportId The passportId to associate.
*/
function adminAddWallet(address wallet, uint256 _passportId) public whenNotPaused onlyOwner {
require(_addressPassportId[wallet] == 0, "Passport already exists");
require(passportRegistry.idPassport(_passportId) != address(0), "Passport ID does not exist");
_addressPassportId[wallet] = _passportId;
emit WalletAdded(wallet, _passportId);
}
/**
* @notice Removes a wallet.
* @dev Can only be called when the contract is not paused.
*/
function removeWallet() public whenNotPaused {
uint256 _passportId = _addressPassportId[msg.sender];
require(_passportId != 0, "Passport does not exist");
require(passportRegistry.idPassport(_passportId) != address(0), "Passport ID is not registered");
_addressPassportId[msg.sender] = 0;
emit WalletRemoved(msg.sender, _passportId);
}
/**
* @notice Removes a wallet.
* @dev Can only be called when the contract is not paused.
*/
function adminRemoveWallet(address wallet) public whenNotPaused onlyOwner {
uint256 _passportId = _addressPassportId[wallet];
require(_passportId != 0, "Passport does not exist");
require(passportRegistry.idPassport(_passportId) != address(0), "Passport ID is not registered");
_addressPassportId[wallet] = 0;
emit WalletRemoved(wallet, _passportId);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {Context} from "../utils/Context.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract Pausable is Context {
bool private _paused;
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Initializes the contract in unpaused state.
*/
constructor() {
_paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
}
// 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;
}
}
// SPDX-License-Identifier: MIT
// Based on: https://github.com/gnosis/safe-token-distribution/blob/master/tooling/contracts/MerkleDistribution.sol
pragma solidity ^0.8.24;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "../merkle/MerkleProof.sol";
import "../passport/PassportBuilderScore.sol";
import "../passport/PassportWalletRegistry.sol";
contract TalentTGEUnlock is Ownable {
using SafeERC20 for IERC20;
event Claimed(address indexed claimer, uint256 amount, uint256 burned);
address public immutable token;
bytes32 public merkleRoot;
PassportBuilderScore public passportBuilderScore;
PassportWalletRegistry public passportWalletRegistry;
uint256 public minimumClaimBuilderScore;
bool public isContractEnabled;
mapping(address => uint256) public claimed;
constructor(
address _token,
bytes32 _merkleRoot,
PassportBuilderScore _passportBuilderScore,
PassportWalletRegistry _passportWalletRegistry,
uint256 _minimumClaimBuilderScore,
address owner
) Ownable(owner) {
token = _token;
merkleRoot = _merkleRoot;
passportBuilderScore = _passportBuilderScore;
passportWalletRegistry = _passportWalletRegistry;
minimumClaimBuilderScore = _minimumClaimBuilderScore;
isContractEnabled = false;
}
function disableContract() external onlyOwner {
isContractEnabled = false;
}
function enableContract() external onlyOwner {
isContractEnabled = true;
}
function setMinimumBuilderScore(uint256 _minimumClaimBuilderScore) external onlyOwner {
minimumClaimBuilderScore = _minimumClaimBuilderScore;
}
function claim(
bytes32[] calldata merkleProofClaim,
uint256 amountAllocated
) external {
require(isContractEnabled, "Contracts are disabled");
require(claimed[msg.sender] == 0, "Already claimed");
address beneficiary = msg.sender;
uint256 passportId = passportWalletRegistry.passportId(beneficiary);
uint256 builderScore = passportBuilderScore.getScore(passportId);
require(builderScore >= minimumClaimBuilderScore, "Onchain Builder Score is too low");
verifyAmount(merkleProofClaim, amountAllocated);
claimed[beneficiary] += amountAllocated;
IERC20(token).safeTransfer(beneficiary, amountAllocated);
emit Claimed(beneficiary, amountAllocated, 0);
}
function verifyAmount(
bytes32[] calldata proof,
uint256 amountAllocated
) internal view {
bytes32 root = merkleRoot;
bytes32 leaf = keccak256(
bytes.concat(keccak256(abi.encode(msg.sender, amountAllocated)))
);
require(
MerkleProof.verify(proof, root, leaf),
"Invalid Allocation Proof"
);
}
function setMerkleRoot(bytes32 nextMerkleRoot) external onlyOwner {
merkleRoot = nextMerkleRoot;
}
function withdraw() external onlyOwner {
IERC20(token).transfer(owner(), IERC20(token).balanceOf(address(this)));
}
}
{
"compilationTarget": {
"contracts/talent/TalentTGEUnlock.sol": "TalentTGEUnlock"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 1000
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"_token","type":"address"},{"internalType":"bytes32","name":"_merkleRoot","type":"bytes32"},{"internalType":"contract PassportBuilderScore","name":"_passportBuilderScore","type":"address"},{"internalType":"contract PassportWalletRegistry","name":"_passportWalletRegistry","type":"address"},{"internalType":"uint256","name":"_minimumClaimBuilderScore","type":"uint256"},{"internalType":"address","name":"owner","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":"FailedInnerCall","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"claimer","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"burned","type":"uint256"}],"name":"Claimed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"inputs":[{"internalType":"bytes32[]","name":"merkleProofClaim","type":"bytes32[]"},{"internalType":"uint256","name":"amountAllocated","type":"uint256"}],"name":"claim","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"claimed","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"disableContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"enableContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"isContractEnabled","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"merkleRoot","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"minimumClaimBuilderScore","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"passportBuilderScore","outputs":[{"internalType":"contract PassportBuilderScore","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"passportWalletRegistry","outputs":[{"internalType":"contract PassportWalletRegistry","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"nextMerkleRoot","type":"bytes32"}],"name":"setMerkleRoot","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_minimumClaimBuilderScore","type":"uint256"}],"name":"setMinimumBuilderScore","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"token","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]