Description:
Proxy contract enabling upgradeable smart contract patterns. Delegates calls to an implementation contract.
Blockchain: Ethereum
Source Code: View Code On The Blockchain
Solidity Source Code:
{{
"language": "Solidity",
"sources": {
"@openzeppelin/contracts/interfaces/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (interfaces/IERC20.sol)
pragma solidity ^0.8.0;
import "../token/ERC20/IERC20.sol";
"
},
"@openzeppelin/contracts/security/ReentrancyGuard.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}
"
},
"@openzeppelin/contracts/token/ERC20/extensions/IERC20Permit.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @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);
}
"
},
"@openzeppelin/contracts/token/ERC20/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @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 amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` 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 amount) 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 `amount` 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 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` 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 amount) external returns (bool);
}
"
},
"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/IERC20Permit.sol";
import "../../../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 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.encodeWithSelector(token.transfer.selector, 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.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20 token, address spender, uint256 value) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 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);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @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.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @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, "SafeERC20: low-level call failed");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @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.isContract(address(token));
}
}
"
},
"@openzeppelin/contracts/token/ERC721/IERC721.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
"
},
"@openzeppelin/contracts/utils/Address.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @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.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @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, it is bubbled up by this
* function (like regular Solidity function calls).
*
* 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.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @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`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) 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(errorMessage);
}
}
}
"
},
"@openzeppelin/contracts/utils/introspection/IERC165.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @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);
}
"
},
"contracts/interface/IDatabase.sol": {
"content": "pragma solidity ^0.8.0;
interface IDatabase {
enum STATUS {
NOTAUDITED,
PENDING,
PASSED,
FAILED,
REFUNDED
}
function hyacinthFee() external view returns (uint256);
function escrowWithdrawBuffer() external view returns (uint256);
function USDC() external view returns (address);
function proofOfDeveloper() external view returns (address);
function proofOfAuditor() external view returns (address);
function owner() external view returns (address);
function audits(uint256 auditId_) external view returns (address, address, STATUS, string memory, uint256, bool);
function auditors(address auditor_) external view returns (uint256, uint256, uint256, uint256);
function approvedAuditor(address auditor_) external view returns (bool isAuditor_);
function hyacinthWallet() external view returns (address);
function beingAudited() external;
function mintPOD() external returns (uint256 id_, address developerWallet_);
function addApprovedAuditor(address[] calldata auditors_) external;
function removeApprovedAuditor(address[] calldata auditors_) external;
function giveAuditorFeedback(uint256 auditId_, bool positive_) external;
function refundBounty(uint256 auditId_) external;
function submitResult(uint256 auditId_, STATUS result_, string memory description_) external;
function rollOverExpired(uint256 auditId_) external;
function levelsCompleted(address auditor_) external view returns (uint256[4] memory);
function auditStatus(address contractAddress_) external view returns (STATUS status_);
}
"
},
"contracts/interface/IProofOfAuditor.sol": {
"content": "pragma solidity ^0.8.0;
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
interface IProofOfAuditor is IERC721 {
function mint(address auditor_) external returns (uint256 id_);
function idHeld(address auditor_) external view returns (uint256 id_);
function level(uint256 tokenId_) external view returns (uint256 level_);
function totalSupply() external view returns (uint256 totalSupply_);
}
"
},
"contracts/retainer/Retainer.sol": {
"content": "pragma solidity ^0.8.30;
import "../interface/IDatabase.sol";
import "@openzeppelin/contracts/interfaces/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
interface IRetainerFactory {
function hyacinthFee() external view returns (uint256);
function hyacinthDatabase() external view returns (address);
}
/// @title Hyacinth Retainer
/// @author Hyacinth
contract HyacinthRetainer {
/// DEPENDENCIES ///
using SafeERC20 for IERC20;
/// ERRORS ///
/// @notice Error for if auditor has already been assigned
error AuditorAssigned();
/// @notice Error for if msg.sender is not developer
error NotDeveloper();
/// @notice Error for if msg.sender is not factory
error NotFactory();
/// @notice Error for if msg.sender is not Hyacinth
error NotHyacinth();
/// @notice Error for if msg.sender is not Hyacinth or developer
error NotHyacinthOrDeveloper();
/// @notice Error for if retainer has ended
error RetainerHasEnded();
/// @notice Error for if retainer has started
error RetainerHasStarted();
/// @notice Error for if invalid index
error InvalidIndex();
/// @notice Error for if not active retainer
error NotActiveRetainer();
/// @notice Error for if increasing previous pay period
error CanNotIncreasePreviousPeriods();
/// @notice Error for if invalid new payout amount
error InvalidNewPayoutAmount();
/// @notice Error for if invalid extenstion
error InvalidExtension();
/// @notice Error for if invalid claim
error InvalidClaim();
/// @notice Error for if zero claim
error ZeroClaim();
/// @notice Error for if withdrawing payout token
error WithdrawingPayoutToken();
/// STATE VARIABLES ///
/// @notice Address of developer
address public immutable developer;
/// @notice Address of retainer factory
address public immutable retainerFactory;
/// @notice Address of auditor
address public auditor;
/// @notice Address of Hyacinth Database
IDatabase public immutable hyacinthDatabase;
/// @notice Array of payout tokens
address[] public payoutTokens;
/// @notice Array of tokens per pay period
uint256[] public tokensPerPayoutPeriod;
/// @notice Payout period
uint256 public immutable payoutPeriod;
/// @notice Array length
uint256 public immutable arrayLength;
/// @notice Timestamp retainer started
uint256 public retainerStart;
/// @notice Timestmap retainer ends
uint256 public retainerEnd;
/// @notice Timestmap last payout period claimed
uint256 public lastInteraction;
/// @notice Amount of retainer periods
uint256 public periodsForRetainer;
/// @notice Bool if retainer has been severed
bool public severed;
/// @notice Bool if retainer has ended
bool public retainerEnded;
/// EVENTS ///
/// @notice Emitted after retainer has ended
event RetainerEnded();
/// @notice Emitted after retainer has been severed
event RetainerSevered();
/// CONSTRUCTOR ///
constructor(
address developer_,
address[] memory payoutTokens_,
uint256[] memory tokensPerPeriod_,
uint256 payoutPeriod_,
uint256 periodsForRetainer_
) {
retainerFactory = msg.sender;
hyacinthDatabase = IDatabase(IRetainerFactory(retainerFactory).hyacinthDatabase());
developer = developer_;
payoutTokens = payoutTokens_;
tokensPerPayoutPeriod = tokensPerPeriod_;
payoutPeriod = payoutPeriod_;
arrayLength = payoutTokens_.length;
periodsForRetainer = periodsForRetainer_;
}
/// FACTORY FUNCTIONS ///
/// @notice Add auditor
/// @param auditor_ Address of auditor accepting for `retainer_`
function addAuditor(address auditor_) external {
if (msg.sender != retainerFactory) revert NotFactory();
if (auditor != address(0)) revert AuditorAssigned();
if (retainerEnded) revert RetainerHasEnded();
auditor = auditor_;
retainerStart = block.timestamp;
lastInteraction = block.timestamp;
retainerEnd = block.timestamp + (payoutPeriod * periodsForRetainer);
}
/// @notice End not started retainer
function endNotStartedRetainer() external {
if (msg.sender != retainerFactory) revert NotFactory();
if (retainerEnded) revert RetainerHasEnded();
if (retainerStart != 0) revert RetainerHasStarted();
retainerEnded = true;
}
/// PROJECT FUNCTIONS ///
/// @notice Increase payout amount
function increaseAmount(uint256 index_, uint256 newAmount_) external {
if (msg.sender != developer) revert NotDeveloper();
if (index_ > arrayLength - 1) revert InvalidIndex();
if (periodsCanClaim() > 0) revert CanNotIncreasePreviousPeriods();
if (newAmount_ <= tokensPerPayoutPeriod[index_]) revert InvalidNewPayoutAmount();
tokensPerPayoutPeriod[index_] = newAmount_;
}
/// @notice Extend retainer
function extendPeriods(uint256 periodsToExtend_, uint256 periodsToFund_) external {
if (msg.sender != developer) revert NotDeveloper();
if (periodsToExtend_ == 0) revert InvalidExtension();
if (!activeRetainer()) revert NotActiveRetainer();
retainerEnd += payoutPeriod * periodsToExtend_;
if (periodsToFund_ > 0) {
for (uint256 i; i < payoutTokens.length; ++i) {
uint256 totalToFund_ = tokensPerPayoutPeriod[i] * periodsToFund_;
IERC20(payoutTokens[i]).safeTransferFrom(msg.sender, address(this), totalToFund_);
}
}
}
/// @notice Withdraw non payout token
function withdrawTokens(address token_, uint256 amount_) external {
if (msg.sender != developer) revert NotDeveloper();
if (activeRetainer()) {
for (uint256 i; i < payoutTokens.length; ++i) {
if (token_ == payoutTokens[i]) revert WithdrawingPayoutToken();
}
}
IERC20(token_).safeTransfer(developer, amount_);
}
/// AUDITOR FUNCTIONS ///
/// @notice Claim `periodsToClaim_` of retainer
function claim(uint256 periodsToClaim_) public {
if (!activeRetainer()) revert NotActiveRetainer();
if (periodsToClaim_ == 0) revert ZeroClaim();
if (msg.sender != auditor && msg.sender != hyacinthDatabase.owner()) revert NotHyacinthOrDeveloper();
uint256 periodCanClaim_ = periodsCanClaim();
if (periodCanClaim_ < periodsToClaim_) revert InvalidClaim();
lastInteraction += (periodsToClaim_ * payoutPeriod);
for (uint256 i; i < payoutTokens.length; ++i) {
uint256 totalToSend_ = tokensPerPayoutPeriod[i] * periodsToClaim_;
uint256 fee_ = (totalToSend_ * IRetainerFactory(retainerFactory).hyacinthFee()) / 100;
IERC20(payoutTokens[i]).safeTransfer(auditor, totalToSend_ - fee_);
IERC20(payoutTokens[i]).safeTransfer(hyacinthDatabase.hyacinthWallet(), fee_);
}
if (lastInteraction >= retainerEnd) {
retainerEnded = true;
emit RetainerEnded();
}
}
/// VIEW FUNCTIONS ///
/// @notice Returns how many pay periods can be claimed
function periodsCanClaim() public view returns (uint256 canClaim_) {
uint256 timeSince_;
if (block.timestamp <= retainerEnd) {
timeSince_ = block.timestamp - lastInteraction;
} else {
timeSince_ = retainerEnd - lastInteraction;
}
canClaim_ = timeSince_ / payoutPeriod;
}
/// @notice Returns how many pay periods are currently funded
function periodsFunded() public view returns (uint256 periodsFunded_) {
for (uint256 i; i < payoutTokens.length; ++i) {
if (i == 0) {
periodsFunded_ = IERC20(payoutTokens[i]).balanceOf(address(this)) / tokensPerPayoutPeriod[i];
} else {
uint256 fundedForToken_ = IERC20(payoutTokens[i]).balanceOf(address(this)) / tokensPerPayoutPeriod[i];
if (periodsFunded_ > fundedForToken_) {
periodsFunded_ = fundedForToken_;
}
}
}
}
/// @notice Returns if retainer is currently active
function activeRetainer() public view returns (bool _active) {
if (!severed && !retainerEnded) return true;
}
/// HYACINTH ///
/// @notice Severeing of retainer
function sever(uint256 additionalSeverance_) external {
if (msg.sender != hyacinthDatabase.owner()) revert NotHyacinth();
uint256 periodsToClaim_ = periodsCanClaim();
uint256 periodsFunded_ = periodsFunded();
if (periodsFunded_ < periodsToClaim_) periodsToClaim_ = periodsFunded_;
if (periodsToClaim_ > 0) claim(periodsToClaim_);
if (additionalSeverance_ > 0) {
for (uint256 i; i < payoutTokens.length; ++i) {
IERC20 token_ = IERC20(payoutTokens[i]);
uint256 totalToSend = tokensPerPayoutPeriod[i] * additionalSeverance_;
uint256 fee_ = (totalToSend * IRetainerFactory(retainerFactory).hyacinthFee()) / 100;
token_.safeTransfer(auditor, totalToSend - fee_);
token_.safeTransfer(hyacinthDatabase.hyacinthWallet(), fee_);
token_.safeTransfer(developer, token_.balanceOf(address(this)));
}
} else {
for (uint256 i; i < payoutTokens.length; ++i) {
IERC20 token_ = IERC20(payoutTokens[i]);
token_.safeTransfer(developer, token_.balanceOf(address(this)));
}
}
severed = true;
emit RetainerSevered();
}
/// @notice Emergency sever of retainer
function emergecnySever() external {
if (msg.sender != hyacinthDatabase.owner()) revert NotHyacinth();
severed = true;
emit RetainerSevered();
}
}
"
},
"contracts/retainer/RetainerFactory.sol": {
"content": "import "../interface/IProofOfAuditor.sol";
import "../interface/IDatabase.sol";
import "./Retainer.sol";
import "@openzeppelin/contracts/interfaces/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
pragma solidity ^0.8.30;
interface IRetainer {
function addAuditor(address auditor_) external;
function endNotStartedRetainer() external;
}
interface ILevel {
function level(uint256 tokenId_) external view returns (uint256 level_);
}
contract HyacinthRetainerFactory is ReentrancyGuard {
/// DEPENDENCIES ///
using SafeERC20 for IERC20;
/// ERRORS ///
/// @notice Error for if not valid retainer
error NotValidRetainer();
/// @notice Error for if auditor already requested retainer
error AlreadyRequested();
/// @notice Error for if not approved auditor
error NotApprovedAuditor();
/// @notice Error for if not required auditor level
error NotRequiredLevel();
/// @notice Error for if auditor has already been assigned
error AuditorAssigned();
/// @notice Error for if msg.sender is not developer
error NotDeveloper();
/// @notice Error for if not requested auditor
error NotRequestedAuditor();
/// @notice Error for if the address is not the owner
error NotOwner();
/// @notice Error for if creating retainer and does not own POD NFT
error DoesNotOwnPODNFT();
/// @notice Error for if different array lengths
error DifferentArrayLength();
/// @notice Error for if zero periods funded
error ZeroPeriodsFunded();
/// @notice Error for if zero tokens per period
error ZeroTokensPerPeriod();
/// @notice Error for if total retainer is less than one week
error TotalRetainerLessThanOneWeek();
/// @notice Error for if duplicate tokens added
error DuplicateToken();
/// @notice Error for if no payment added
error NoPaymentAdded();
/// @notice Error for if over max tokens
error MaxTokens();
/// @notice Error for if min level being set is invalid
error InvalidMinLevel();
/// @notice Error for if withdraw buffer not met
error CancelBufferNotMet();
/// EVENTS ///
/// @notice Emitted after Hyacinth fee is set
/// @param newFee New fee
event HyacinthFeeSet(uint256 newFee);
/// @notice Emitted after min upfront USDC has been set
/// @param newMinUpFrontUSDC New min upfront USDC required
event MinUpFronUSDCSet(uint256 newMinUpFrontUSDC);
/// @notice Emitted after min level has been set
/// @param newMinLevel New min level
event MinLevelSet(uint256 newMinLevel);
/// @notice Emitted after new levels contract has been set
/// @param newLevelsContract New levels contract
event LevelsContractSet(address newLevelsContract);
/// @notice Emitted after retainer has been created
/// @param retainerAddress Retainer address
/// @param developer Address of developer
/// @param periodsFunded Number of initial periods funded
/// @param payoutPeriod Frequency of payout period
/// @param periodsForRetainer Periods of retainer
/// @param numRetainerCreated The number retainer created
/// @param payoutTokens Array of payout tokens
/// @param payoutAmounts Array of payout amounts per period
event RetainerCreated(
address indexed retainerAddress,
address indexed developer,
uint256 periodsFunded,
uint256 payoutPeriod,
uint256 periodsForRetainer,
uint256 numRetainerCreated,
address[] payoutTokens,
uint256[] payoutAmounts
);
/// @notice Emitted after up front payment has been updated
/// @param retainerAddress Retainer address
/// @param developer Address of developer
/// @param payoutTokens Array of payout tokens
/// @param upFrontPayment Amount of tokens for up front payment
event UpFrontPayment(
address indexed retainerAddress, address indexed developer, address[] payoutTokens, uint256[] upFrontPayment
);
/// @notice Emitted after auditor request has been sent
/// @param auditor Address of auditor requesting
/// @param retainerAddress Retainer address
event AuditorRequest(address indexed auditor, address indexed retainerAddress);
/// @notice Emitted after auditor has been accepted
/// @param developer Address of developer of retainer
/// @param auditor Address of auditor accepted
/// @param retainerAddress Retainer address
event AuditorAccepted(address indexed developer, address indexed auditor, address indexed retainerAddress);
/// @notice Emitted after retainer has been canceled
/// @param retainer Address of retainer being cancelled
/// @param developer Address of developer of retainer
event RetainerCanceled(address indexed retainer, address indexed developer);
/// STATE VARIABLES ///
/// @notice Max tokens for retainer
uint256 public constant MAX_TOKENS = 4;
/// @notice Hyacinth fee
uint256 public hyacinthFee;
/// @notice Min level needed to request retainer
uint256 public minLevel;
/// @notice Min up front USDC needed
uint256 public minUpFrontUSDC;
/// @notice Num retainers created
uint256 public numRetainersCreated;
/// @notice Address of USDC
address public immutable USDC;
/// @notice Address of POD
address public immutable proofOfDeveloper;
/// @notice Address of POA
address public immutable proofOfAuditor;
/// @notice Address of Hyacinth database
IDatabase public immutable hyacinthDatabase;
/// @notice Address of contract to read levels
address public levels;
/// @notice Array of retainers creater
address[] public retainersCreated;
/// @notice Address of auditor for retainer
mapping(address => address) public auditorOfRetainer;
/// @notice Address of developer for retainer
mapping(address => address) public developerOfRetainer;
/// @notice Array of payout tokens for retainer
mapping(address => address[]) public payoutTokens;
/// @notice Array of up front payout for retainer
mapping(address => uint256[]) public upFrontPayment;
/// @notice Timestamp can cancel for retainer address
mapping(address => uint256) public cancelWithdrawTimestamp;
/// @notice Num of retainers for auditor
mapping(address => uint256) public retainersForAuditor;
/// @notice Num of retainers for project
mapping(address => uint256) public retainersForProject;
/// @notice Bool if token for retainer is a payout token
mapping(address => mapping(address => bool)) public isPayoutToken;
/// @notice Bool if address requested to be auditor of retainer address
mapping(address => mapping(address => bool)) public requestToBeAuditor;
/// CONSTRUCTOR ///
constructor(IDatabase _hyacinthDatabase, address _pod, address _poa, address _usdc) {
hyacinthFee = 15;
minLevel = 2;
minUpFrontUSDC = 500000000;
hyacinthDatabase = _hyacinthDatabase;
proofOfDeveloper = _pod;
proofOfAuditor = _poa;
USDC = _usdc;
levels = proofOfAuditor;
}
/// PROJECT FUNCTIONS ///
/// @notice Create retainer
/// @param payoutTokens_ Array of payout tokens for retainer
/// @param tokensPerPeriod_ Array of payout amonts per period for `payoutTokens_`
/// @param upFrontPayment_ Array of up front payment corresponding with `payoutTokens_`
/// @param periodsToFund_ Amount of periods to fund up front
/// @param payoutPeriod_ Length of a single payout period
/// @param periodsForRetainer_ Amount of periods for retainer
function createRetainer(
address[] memory payoutTokens_,
uint256[] memory tokensPerPeriod_,
uint256[] memory upFrontPayment_,
uint256 periodsToFund_,
uint256 payoutPeriod_,
uint256 periodsForRetainer_
) external nonReentrant returns (address retainerAddress_) {
if (IERC721(proofOfDeveloper).balanceOf(msg.sender) == 0) revert DoesNotOwnPODNFT();
if (periodsToFund_ == 0) revert ZeroPeriodsFunded();
if (payoutPeriod_ * periodsForRetainer_ < 7 days) revert TotalRetainerLessThanOneWeek();
if (payoutTokens_.length > MAX_TOKENS) revert MaxTokens();
if (payoutTokens_.length != tokensPerPeriod_.length && tokensPerPeriod_.length != upFrontPayment_.length) {
revert DifferentArrayLength();
}
HyacinthRetainer retainerContract =
new HyacinthRetainer(msg.sender, payoutTokens_, tokensPerPeriod_, payoutPeriod_, periodsForRetainer_);
retainerAddress_ = address(retainerContract);
developerOfRetainer[retainerAddress_] = msg.sender;
bool valid_;
for (uint256 i; i < payoutTokens_.length; i++) {
address token_ = payoutTokens_[i];
uint256 tokenPerPeriod_ = tokensPerPeriod_[i];
if (isPayoutToken[retainerAddress_][token_]) revert DuplicateToken();
if (tokenPerPeriod_ == 0) revert ZeroTokensPerPeriod();
isPayoutToken[retainerAddress_][token_] = true;
IERC20(token_).safeTransferFrom(msg.sender, retainerAddress_, tokenPerPeriod_ * periodsToFund_);
if (upFrontPayment_[i] > 0) {
if (token_ == USDC && upFrontPayment_[i] >= minUpFrontUSDC) valid_ = true;
IERC20(token_).safeTransferFrom(msg.sender, address(this), upFrontPayment_[i]);
}
}
if (!valid_) revert NotValidRetainer();
payoutTokens[retainerAddress_] = payoutTokens_;
upFrontPayment[retainerAddress_] = upFrontPayment_;
cancelWithdrawTimestamp[retainerAddress_] = block.timestamp + hyacinthDatabase.escrowWithdrawBuffer();
emit RetainerCreated(
retainerAddress_,
msg.sender,
periodsToFund_,
payoutPeriod_,
periodsForRetainer_,
numRetainersCreated,
payoutTokens_,
tokensPerPeriod_
);
++retainersForProject[msg.sender];
++numRetainersCreated;
retainersCreated.push(retainerAddress_);
emit UpFrontPayment(retainerAddress_, msg.sender, payoutTokens_, upFrontPayment_);
}
/// @notice Accept `auditor_` for `retainer_`
/// @param retainer_ Address of retainer to accept `audior_` for
/// @param auditor_ Address of auditor accepting for `retainer_`
function acceptAuditorForRetainer(address retainer_, address auditor_) external nonReentrant {
if (developerOfRetainer[retainer_] != msg.sender) revert NotDeveloper();
if (auditorOfRetainer[retainer_] != address(0)) revert AuditorAssigned();
if (requestToBeAuditor[retainer_][auditor_] != true) revert NotRequestedAuditor();
auditorOfRetainer[retainer_] = auditor_;
IRetainer(retainer_).addAuditor(auditor_);
++retainersForAuditor[auditor_];
for (uint256 i; i < upFrontPayment[retainer_].length; i++) {
uint256 payment_ = upFrontPayment[retainer_][i];
if (payment_ > 0) {
address token_ = payoutTokens[retainer_][i];
uint256 fee_ = (payment_ * hyacinthFee) / 100;
IERC20(token_).safeTransfer(auditor_, payment_ - fee_);
IERC20(token_).safeTransfer(hyacinthDatabase.hyacinthWallet(), fee_);
}
}
emit AuditorAccepted(msg.sender, auditor_, retainer_);
}
/// @notice Add `additionalAmounts_` to `retainer_`
/// @param retainer_ Address of retainer to add `additionalAmonts_`
/// @param additionalAmounts_ Array of additioanl amounts of corresponding tokens to add to `retainer_`
function addToUpFrontPayment(address retainer_, uint256[] memory additionalAmounts_) external nonReentrant {
if (developerOfRetainer[retainer_] != msg.sender) revert NotDeveloper();
if (auditorOfRetainer[retainer_] != address(0)) revert AuditorAssigned();
address[] memory tokenArray_ = payoutTokens[retainer_];
uint256[] storage upFrontAmounts_ = upFrontPayment[retainer_];
if (additionalAmounts_.length != tokenArray_.length) revert DifferentArrayLength();
bool added_;
for (uint256 i; i < additionalAmounts_.length; i++) {
uint256 payment_ = additionalAmounts_[i];
if (payment_ > 0) {
IERC20(tokenArray_[i]).safeTransferFrom(msg.sender, address(this), payment_);
upFrontAmounts_[i] += payment_;
if (!added_) added_ = true;
}
}
if (!added_) revert NoPaymentAdded();
emit UpFrontPayment(retainer_, msg.sender, tokenArray_, upFrontAmounts_);
}
/// @notice Cancel `retainer_`
/// @param retainer_ Address of retainer to cancel
function cancelRetainer(address retainer_) external nonReentrant {
if (developerOfRetainer[retainer_] != msg.sender) revert NotDeveloper();
if (auditorOfRetainer[retainer_] != address(0)) revert AuditorAssigned();
if (cancelWithdrawTimestamp[retainer_] > block.timestamp) revert CancelBufferNotMet();
IRetainer(retainer_).endNotStartedRetainer();
uint256[] memory upFrontPayment_ = upFrontPayment[retainer_];
delete upFrontPayment[retainer_];
for (uint256 i; i < upFrontPayment_.length; i++) {
uint256 payment_ = upFrontPayment_[i];
if (payment_ > 0) {
IERC20(payoutTokens[retainer_][i]).safeTransfer(msg.sender, payment_);
}
}
emit RetainerCanceled(retainer_, msg.sender);
}
/// AUDITOR FUNCTIONS ///
/// @notice Auditor requests for `retainer_`
/// @param retainer_ Address of retainer to request
function requestRetainer(address retainer_) external {
if (!hyacinthDatabase.approvedAuditor(msg.sender)) revert NotApprovedAuditor();
if (ILevel(levels).level(IProofOfAuditor(proofOfAuditor).idHeld(msg.sender)) < minLevel) {
revert NotRequiredLevel();
}
if (auditorOfRetainer[retainer_] != address(0)) revert AuditorAssigned();
if (requestToBeAuditor[retainer_][msg.sender] == true) revert AlreadyRequested();
requestToBeAuditor[retainer_][msg.sender] = true;
emit AuditorRequest(msg.sender, retainer_);
}
/// HYACINTH ///
/// @notice Update retainer fee
/// @param newFee_ New Hyacinth retainer fee
function setHyacinthfee(uint256 newFee_) external {
if (msg.sender != hyacinthDatabase.owner()) revert NotOwner();
hyacinthFee = newFee_;
emit HyacinthFeeSet(newFee_);
}
/// @notice Update min USDC up front
/// @param newMinUpFrontUSDC_ New min USDC up front
function setMinUpFrontUSDC(uint256 newMinUpFrontUSDC_) external {
if (msg.sender != hyacinthDatabase.owner()) revert NotOwner();
minUpFrontUSDC = newMinUpFrontUSDC_;
emit MinUpFronUSDCSet(newMinUpFrontUSDC_);
}
/// @notice Update min level
/// @param newMinLevel_ New min level
function setMinLevel(uint256 newMinLevel_) external {
if (msg.sender != hyacinthDatabase.owner()) revert NotOwner();
if (newMinLevel_ > 3) revert InvalidMinLevel();
minLevel = newMinLevel_;
emit MinLevelSet(newMinLevel_);
}
/// @notice Update levels contract
/// @param newLevelsContract_ New levels contract
function setLevelsContract(address newLevelsContract_) external {
if (msg.sender != hyacinthDatabase.owner()) revert NotOwner();
levels = newLevelsContract_;
emit LevelsContractSet(newLevelsContract_);
}
}"
}
},
"settings": {
"optimizer": {
"enabled": true,
"runs": 1000
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
}
}}
Submitted on: 2025-09-24 13:49:29
Comments
Log in to comment.
No comments yet.