// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @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
* ====
*
* [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.
* ====
*/functionisContract(address account) internalviewreturns (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://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable 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._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionCall(target, data, "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._
*/functionfunctionCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
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._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value
) internalreturns (bytesmemory) {
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._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytesmemory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
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._
*/functionfunctionStaticCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
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._
*/functionfunctionDelegateCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (bytesmemory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
Contract Source Code
File 2 of 27: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^0.8.0;/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 3 of 27: ERC165Checker.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165Checker.sol)pragmasolidity ^0.8.0;import"./IERC165.sol";
/**
* @dev Library used to query support of an interface declared via {IERC165}.
*
* Note that these functions return the actual result of the query: they do not
* `revert` if an interface is not supported. It is up to the caller to decide
* what to do in these cases.
*/libraryERC165Checker{
// As per the EIP-165 spec, no interface should ever match 0xffffffffbytes4privateconstant _INTERFACE_ID_INVALID =0xffffffff;
/**
* @dev Returns true if `account` supports the {IERC165} interface,
*/functionsupportsERC165(address account) internalviewreturns (bool) {
// Any contract that implements ERC165 must explicitly indicate support of// InterfaceId_ERC165 and explicitly indicate non-support of InterfaceId_Invalidreturn
_supportsERC165Interface(account, type(IERC165).interfaceId) &&!_supportsERC165Interface(account, _INTERFACE_ID_INVALID);
}
/**
* @dev Returns true if `account` supports the interface defined by
* `interfaceId`. Support for {IERC165} itself is queried automatically.
*
* See {IERC165-supportsInterface}.
*/functionsupportsInterface(address account, bytes4 interfaceId) internalviewreturns (bool) {
// query support of both ERC165 as per the spec and support of _interfaceIdreturn supportsERC165(account) && _supportsERC165Interface(account, interfaceId);
}
/**
* @dev Returns a boolean array where each value corresponds to the
* interfaces passed in and whether they're supported or not. This allows
* you to batch check interfaces for a contract where your expectation
* is that some interfaces may not be supported.
*
* See {IERC165-supportsInterface}.
*
* _Available since v3.4._
*/functiongetSupportedInterfaces(address account, bytes4[] memory interfaceIds)
internalviewreturns (bool[] memory)
{
// an array of booleans corresponding to interfaceIds and whether they're supported or notbool[] memory interfaceIdsSupported =newbool[](interfaceIds.length);
// query support of ERC165 itselfif (supportsERC165(account)) {
// query support of each interface in interfaceIdsfor (uint256 i =0; i < interfaceIds.length; i++) {
interfaceIdsSupported[i] = _supportsERC165Interface(account, interfaceIds[i]);
}
}
return interfaceIdsSupported;
}
/**
* @dev Returns true if `account` supports all the interfaces defined in
* `interfaceIds`. Support for {IERC165} itself is queried automatically.
*
* Batch-querying can lead to gas savings by skipping repeated checks for
* {IERC165} support.
*
* See {IERC165-supportsInterface}.
*/functionsupportsAllInterfaces(address account, bytes4[] memory interfaceIds) internalviewreturns (bool) {
// query support of ERC165 itselfif (!supportsERC165(account)) {
returnfalse;
}
// query support of each interface in _interfaceIdsfor (uint256 i =0; i < interfaceIds.length; i++) {
if (!_supportsERC165Interface(account, interfaceIds[i])) {
returnfalse;
}
}
// all interfaces supportedreturntrue;
}
/**
* @notice Query if a contract implements an interface, does not check ERC165 support
* @param account The address of the contract to query for support of an interface
* @param interfaceId The interface identifier, as specified in ERC-165
* @return true if the contract at account indicates support of the interface with
* identifier interfaceId, false otherwise
* @dev Assumes that account contains a contract that supports ERC165, otherwise
* the behavior of this method is undefined. This precondition can be checked
* with {supportsERC165}.
* Interface identification is specified in ERC-165.
*/function_supportsERC165Interface(address account, bytes4 interfaceId) privateviewreturns (bool) {
bytesmemory encodedParams =abi.encodeWithSelector(IERC165.supportsInterface.selector, interfaceId);
(bool success, bytesmemory result) = account.staticcall{gas: 30000}(encodedParams);
if (result.length<32) returnfalse;
return success &&abi.decode(result, (bool));
}
}
Contract Source Code
File 4 of 27: IAddressLock.sol
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity >=0.8.0;import"./IRegistryProvider.sol";
import'@openzeppelin/contracts/utils/introspection/IERC165.sol';
/**
* @title Provider interface for Revest FNFTs
* @dev Address locks MUST be non-upgradeable to be considered for trusted status
* @author Revest
*/interfaceIAddressLockisIRegistryProvider, IERC165{
/// Creates a lock to the specified lockID/// @param fnftId the fnftId to map this lock to. Not recommended for typical locks, as it will break on splitting/// @param lockId the lockId to map this lock to. Recommended uint for storing references to lock configurations/// @param arguments an abi.encode() bytes array. Allows frontend to encode and pass in an arbitrary set of parameters/// @dev creates a lock for the specified lockId. Will be called during the creation process for address locks when the address/// of a contract implementing this interface is passed in as the "trigger" address for minting an address lock. The bytes/// representing any parameters this lock requires are passed through to this method, where abi.decode must be call on themfunctioncreateLock(uint fnftId, uint lockId, bytesmemory arguments) external;
/// Updates a lock at the specified lockId/// @param fnftId the fnftId that can map to a lock config stored in implementing contracts. Not recommended, as it will break on splitting/// @param lockId the lockId that maps to the lock config which should be updated. Recommended for retrieving references to lock configurations/// @param arguments an abi.encode() bytes array. Allows frontend to encode and pass in an arbitrary set of parameters/// @dev updates a lock for the specified lockId. Will be called by the frontend from the information section if an update is requested/// can further accept and decode parameters to use in modifying the lock's config or triggering other actions/// such as triggering an on-chain oracle to updatefunctionupdateLock(uint fnftId, uint lockId, bytesmemory arguments) external;
/// Whether or not the lock can be unlocked/// @param fnftId the fnftId that can map to a lock config stored in implementing contracts. Not recommended, as it will break on splitting/// @param lockId the lockId that maps to the lock config which should be updated. Recommended for retrieving references to lock configurations/// @dev this method is called during the unlocking and withdrawal processes by the Revest contract - it is also used by the frontend/// if this method is returning true and someone attempts to unlock or withdraw from an FNFT attached to the requested lock, the request will succeed/// @return whether or not this lock may be unlockedfunctionisUnlockable(uint fnftId, uint lockId) externalviewreturns (bool);
/// Provides an encoded bytes arary that represents values this lock wants to display on the info screen/// Info to decode these values is provided in the metadata file/// @param fnftId the fnftId that can map to a lock config stored in implementing contracts. Not recommended, as it will break on splitting/// @param lockId the lockId that maps to the lock config which should be updated. Recommended for retrieving references to lock configurations/// @dev used by the frontend to fetch on-chain data on the state of any given lock/// @return a bytes array that represents the result of calling abi.encode on values which the developer wants to appear on the frontendfunctiongetDisplayValues(uint fnftId, uint lockId) externalviewreturns (bytesmemory);
/// Maps to a URL, typically IPFS-based, that contains information on how to encode and decode paramters sent to and from this lock/// Please see additional documentation for JSON config info/// @dev this method will be called by the frontend only but is crucial to properly implement for proper minting and information workflows/// @return a URL to the JSON file containing this lock's metadata schemafunctiongetMetadata() externalviewreturns (stringmemory);
/// Whether or not this lock will need updates and should display the option for them/// @dev this will be called by the frontend to determine if update inputs and buttons should be displayed/// @return whether or not the locks created by this contract will need updatesfunctionneedsUpdate() externalviewreturns (bool);
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)pragmasolidity ^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}.
*/interfaceIERC165{
/**
* @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.
*/functionsupportsInterface(bytes4 interfaceId) externalviewreturns (bool);
}
Contract Source Code
File 8 of 27: IERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC20/IERC20.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Returns the amount of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (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.
*/functiontransfer(address to, uint256 amount) externalreturns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/functionallowance(address owner, address spender) externalviewreturns (uint256);
/**
* @dev Sets `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.
*/functionapprove(address spender, uint256 amount) externalreturns (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.
*/functiontransferFrom(addressfrom,
address to,
uint256 amount
) externalreturns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
}
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity >=0.8.0;import"./IOutputReceiver.sol";
import"./IRevest.sol";
import'@openzeppelin/contracts/utils/introspection/IERC165.sol';
/**
* @title Provider interface for Revest FNFTs
*/interfaceIOutputReceiverV2isIOutputReceiver{
// Future proofing for secondary callbacks during withdrawal// Could just use triggerOutputReceiverUpdate and call withdrawal function// But deliberately using reentry is poor form and reminds me too much of OAuth 2.0 functionreceiveSecondaryCallback(uint fnftId,
addresspayable owner,
uint quantity,
IRevest.FNFTConfig memory config,
bytesmemory args
) externalpayable;
// Allows for similar function to address lock, updating state while still locked// Called by the user directlyfunctiontriggerOutputReceiverUpdate(uint fnftId,
bytesmemory args
) external;
// This function should only ever be called when a split or additional deposit has occurred functionhandleFNFTRemaps(uint fnftId, uint[] memory newFNFTIds, address caller, bool cleanup) external;
}
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity >=0.8.0;import"./ITokenVault.sol";
interfaceITokenVaultV2isITokenVault{
/// Emitted when an FNFT is createdeventCreateFNFT(uintindexed fnftId, addressindexedfrom);
/// Emitted when an FNFT is redeemedeventRedeemFNFT(uintindexed fnftId, addressindexedfrom);
/// Emitted when an FNFT is created to denote what tokens have been depositedeventDepositERC20(addressindexed token, addressindexed user, uintindexed fnftId, uint tokenAmount, address smartWallet);
/// Emitted when an FNFT is withdraw to denote what tokens have been withdrawneventWithdrawERC20(addressindexed token, addressindexed user, uintindexed fnftId, uint tokenAmount, address smartWallet);
functiongetFNFTAddress(uint fnftId) externalviewreturns (address smartWallet);
functionrecordAdditionalDeposit(address user, uint fnftId, uint tokenAmount) external;
}
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity ^0.8.0;interfaceIWETH{
functiondeposit() externalpayable;
// Introduced later in developmentfunctiontransfer(address to, uint value) externalreturns (bool);
functionwithdraw(uint) external;
}
Contract Source Code
File 22 of 27: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)pragmasolidity ^0.8.0;import"../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.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
require(newOwner !=address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 23 of 27: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)pragmasolidity ^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].
*/abstractcontractReentrancyGuard{
// 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.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _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.
*/modifiernonReentrant() {
// On the first call to nonReentrant, _notEntered will be truerequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 24 of 27: Revest.sol
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity ^0.8.0;import"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import'@openzeppelin/contracts/utils/introspection/ERC165Checker.sol';
import"./interfaces/IRevest.sol";
import"./interfaces/IAddressRegistry.sol";
import"./interfaces/ILockManager.sol";
import"./interfaces/ITokenVaultV2.sol";
import"./interfaces/IRewardsHandler.sol";
import"./interfaces/IOutputReceiver.sol";
import"./interfaces/IOutputReceiverV2.sol";
import"./interfaces/IOutputReceiverV3.sol";
import"./interfaces/IAddressLock.sol";
import"./utils/RevestAccessControl.sol";
import"./utils/RevestReentrancyGuard.sol";
import"./lib/IWETH.sol";
/**
* This is the entrypoint for the frontend, as well as third-party Revest integrations.
* Solidity style guide ordering: receive, fallback, external, public, internal, private - within a grouping, view and pure go last - https://docs.soliditylang.org/en/latest/style-guide.html
*/contractRevestA4isIRevest, RevestAccessControl, RevestReentrancyGuard{
usingSafeERC20forIERC20;
usingERC165Checkerforaddress;
bytes4publicconstant ADDRESS_LOCK_INTERFACE_ID =type(IAddressLock).interfaceId;
bytes4publicconstant OUTPUT_RECEIVER_INTERFACE_V2_ID =type(IOutputReceiverV2).interfaceId;
bytes4publicconstant OUTPUT_RECEIVER_INTERFACE_V3_ID =type(IOutputReceiverV3).interfaceId;
addressimmutable WETH;
/// Point at which FNFTs should point to the new token vaultuintpublic erc20Fee; // out of 1000uintprivateconstant erc20multiplierPrecision =1000;
uintpublic flatWeiFee;
uintprivateconstant MAX_INT =2**256-1;
mapping(address=>bool) private approved;
mapping(address=>bool) public whitelisted;
/**
* @dev Primary constructor to create the Revest controller contract
*/constructor(address provider,
address weth
) RevestAccessControl(provider) {
WETH = weth;
}
// PUBLIC FUNCTIONS/**
* @dev creates a single time-locked NFT with <quantity> number of copies with <amount> of <asset> stored for each copy
* asset - the address of the underlying ERC20 token for this bond
* amount - the amount to store per NFT if multiple NFTs of this variety are being created
* unlockTime - the timestamp at which this will unlock
* quantity – the number of FNFTs to create with this operation
*/functionmintTimeLock(uint endTime,
address[] memory recipients,
uint[] memory quantities,
IRevest.FNFTConfig memory fnftConfig
) externalpayableoverridenonReentrantreturns (uint) {
// Get the next iduint fnftId = getFNFTHandler().getNextId();
// Get or create lock based on time, assign lock to ID
{
IRevest.LockParam memory timeLock;
timeLock.lockType = IRevest.LockType.TimeLock;
timeLock.timeLockExpiry = endTime;
getLockManager().createLock(fnftId, timeLock);
}
doMint(recipients, quantities, fnftId, fnftConfig, msg.value);
emit FNFTTimeLockMinted(fnftConfig.asset, _msgSender(), fnftId, endTime, quantities, fnftConfig);
return fnftId;
}
functionmintValueLock(address primaryAsset,
address compareTo,
uint unlockValue,
bool unlockRisingEdge,
address oracleDispatch,
address[] memory recipients,
uint[] memory quantities,
IRevest.FNFTConfig memory fnftConfig
) externalpayableoverridenonReentrantreturns (uint) {
// copy the fnftIduint fnftId = getFNFTHandler().getNextId();
// Initialize the lock structure
{
IRevest.LockParam memory valueLock;
valueLock.lockType = IRevest.LockType.ValueLock;
valueLock.valueLock.unlockRisingEdge = unlockRisingEdge;
valueLock.valueLock.unlockValue = unlockValue;
valueLock.valueLock.asset = primaryAsset;
valueLock.valueLock.compareTo = compareTo;
valueLock.valueLock.oracle = oracleDispatch;
getLockManager().createLock(fnftId, valueLock);
}
doMint(recipients, quantities, fnftId, fnftConfig, msg.value);
emit FNFTValueLockMinted(fnftConfig.asset, _msgSender(), fnftId, compareTo, oracleDispatch, quantities, fnftConfig);
return fnftId;
}
functionmintAddressLock(address trigger,
bytesmemory arguments,
address[] memory recipients,
uint[] memory quantities,
IRevest.FNFTConfig memory fnftConfig
) externalpayableoverridenonReentrantreturns (uint) {
uint fnftId = getFNFTHandler().getNextId();
{
IRevest.LockParam memory addressLock;
addressLock.addressLock = trigger;
addressLock.lockType = IRevest.LockType.AddressLock;
// Get or create lock based on address which can trigger unlock, assign lock to IDuint lockId = getLockManager().createLock(fnftId, addressLock);
// The lock ID is already incremented prior to calling a method that could allow for reentryif(trigger.supportsInterface(ADDRESS_LOCK_INTERFACE_ID)) {
IAddressLock(trigger).createLock(fnftId, lockId, arguments);
}
}
// This is a public call to a third-party contract. Must be done after everything else.
doMint(recipients, quantities, fnftId, fnftConfig, msg.value);
emit FNFTAddressLockMinted(fnftConfig.asset, _msgSender(), fnftId, trigger, quantities, fnftConfig);
return fnftId;
}
functionwithdrawFNFT(uint fnftId, uint quantity) externaloverridenonReentrant{
_withdrawFNFT(fnftId, quantity);
}
/// Advanced FNFT withdrawals removed for the time being – no active implementations/// Represents slightly increased surface area – may be utilized in ResolvefunctionunlockFNFT(uint fnftId) externaloverridenonReentrant{
// Works for value locks or time locks
IRevest.LockType lock = getLockManager().lockTypes(fnftId);
require(lock == IRevest.LockType.AddressLock || lock == IRevest.LockType.ValueLock, "E008");
require(getLockManager().unlockFNFT(fnftId, _msgSender()), "E056");
emit FNFTUnlocked(_msgSender(), fnftId);
}
functionsplitFNFT(uint fnftId,
uint[] memory proportions,
uint quantity
) externaloverridenonReentrantreturns (uint[] memory) {
// Splitting is entirely disabled for the time beingrevert("TMP_BRK");
}
/// @return the FNFT IDfunctionextendFNFTMaturity(uint fnftId,
uint endTime
) externaloverridenonReentrantreturns (uint) {
IFNFTHandler fnftHandler = getFNFTHandler();
uint supply = fnftHandler.getSupply(fnftId);
uint balance = fnftHandler.getBalance(_msgSender(), fnftId);
require(endTime >block.timestamp, 'E002');
require(fnftId < fnftHandler.getNextId(), "E007");
require(balance == supply , "E022");
IRevest.FNFTConfig memory config = getTokenVault().getFNFT(fnftId);
ILockManager manager = getLockManager();
// If it can't have its maturity extended, revert// Will also return false on non-time lock locksrequire(config.maturityExtension &&
manager.lockTypes(fnftId) == IRevest.LockType.TimeLock, "E029");
// If desired maturity is below existing date, reject operationrequire(manager.fnftIdToLock(fnftId).timeLockExpiry < endTime, "E030");
// Update the lock
IRevest.LockParam memory lock;
lock.lockType = IRevest.LockType.TimeLock;
lock.timeLockExpiry = endTime;
manager.createLock(fnftId, lock);
// Callback to IOutputReceiverV3// NB: All IOuputReceiver systems should be either marked non-reentrant or ensure they follow checks-effects-interactionsif(config.pipeToContract !=address(0) && config.pipeToContract.supportsInterface(OUTPUT_RECEIVER_INTERFACE_V3_ID)) {
IOutputReceiverV3(config.pipeToContract).handleTimelockExtensions(fnftId, endTime, _msgSender());
}
emit FNFTMaturityExtended(_msgSender(), fnftId, endTime);
return fnftId;
}
/**
* Amount will be per FNFT. So total ERC20s needed is amount * quantity.
* We don't charge an ETH fee on depositAdditional, but do take the erc20 percentage.
*/functiondepositAdditionalToFNFT(uint fnftId,
uint amount,
uint quantity
) externaloverridenonReentrantreturns (uint) {
address vault = addressesProvider.getTokenVault();
IRevest.FNFTConfig memory fnft = ITokenVault(vault).getFNFT(fnftId);
address handler = addressesProvider.getRevestFNFT();
require(fnftId < IFNFTHandler(handler).getNextId(), "E007");
require(fnft.isMulti, "E034");
require(fnft.depositStopTime >block.timestamp|| fnft.depositStopTime ==0, "E035");
require(quantity >0, "E070");
// This line will disable all legacy FNFTs from using this function// Unless they are using it for pass-throughrequire(fnft.depositMul ==0|| fnft.asset ==address(0), 'E084');
uint supply = IFNFTHandler(handler).getSupply(fnftId);
uint deposit = quantity * amount;
// Future versions may reintroduce series splitting, if it is ever in demandrequire(quantity == supply, 'E083');
// Transfer the ERC20 fee to the admin address, leave it at thatif(!whitelisted[_msgSender()]) {
uint totalERC20Fee = erc20Fee * deposit / erc20multiplierPrecision;
if(totalERC20Fee >0) {
// NB: The user has control of where this external call goes (fnft.asset)
IERC20(fnft.asset).safeTransferFrom(_msgSender(), addressesProvider.getAdmin(), totalERC20Fee);
}
}
// Transfer to the smart walletif(fnft.asset !=address(0)){
address smartWallet = ITokenVaultV2(vault).getFNFTAddress(fnftId);
// NB: The user has control of where this external call goes (fnft.asset)
IERC20(fnft.asset).safeTransferFrom(_msgSender(), smartWallet, deposit);
ITokenVaultV2(vault).recordAdditionalDeposit(_msgSender(), fnftId, deposit);
}
if(fnft.pipeToContract !=address(0) && fnft.pipeToContract.supportsInterface(OUTPUT_RECEIVER_INTERFACE_V3_ID)) {
IOutputReceiverV3(fnft.pipeToContract).handleAdditionalDeposit(fnftId, amount, quantity, _msgSender());
}
emit FNFTAddionalDeposited(_msgSender(), fnftId, quantity, amount);
return0;
}
//// INTERNAL FUNCTIONS//// Private function for use in withdrawing FNFTs, allow us to make universal use of reentrancy guard function_withdrawFNFT(uint fnftId, uint quantity) private{
address fnftHandler = addressesProvider.getRevestFNFT();
// Check if this many FNFTs exist in the first place for the given IDrequire(quantity >0, "E003");
// Burn the FNFTs being exchanged
IFNFTHandler(fnftHandler).burn(_msgSender(), fnftId, quantity);
require(getLockManager().unlockFNFT(fnftId, _msgSender()), 'E082');
address vault = addressesProvider.getTokenVault();
ITokenVault(vault).withdrawToken(fnftId, quantity, _msgSender());
emit FNFTWithdrawn(_msgSender(), fnftId, quantity);
}
functiondoMint(address[] memory recipients,
uint[] memory quantities,
uint fnftId,
IRevest.FNFTConfig memory fnftConfig,
uint weiValue
) internal{
bool isSingular;
uint totalQuantity = quantities[0];
{
uint rec = recipients.length;
uint quant = quantities.length;
require(rec == quant, "recipients and quantities arrays must match");
// Calculate total quantity
isSingular = rec ==1;
if(!isSingular) {
for(uint i =1; i < quant; i++) {
totalQuantity += quantities[i];
}
}
require(totalQuantity >0, "E003");
}
// Gas optimization// Will always be new token vaultaddress vault = addressesProvider.getTokenVault();
// Take feesif(weiValue >0) {
// Immediately convert all ETH to WETH
IWETH(WETH).deposit{value: weiValue}();
}
// For multi-chain deployments, will relay through RewardsHandlerSimplified to end up in admin wallet// Whitelist system will charge fees on all but approved parties, who may charge them using negotiated// values with the Revest Protocolif(!whitelisted[_msgSender()]) {
if(flatWeiFee >0) {
require(weiValue >= flatWeiFee, "E005");
address reward = addressesProvider.getRewardsHandler();
if(!approved[reward]) {
IERC20(WETH).approve(reward, MAX_INT);
approved[reward] =true;
}
IRewardsHandler(reward).receiveFee(WETH, flatWeiFee);
}
// If we aren't depositing any value, no point running thisif(fnftConfig.depositAmount >0) {
uint totalERC20Fee = erc20Fee * totalQuantity * fnftConfig.depositAmount / erc20multiplierPrecision;
if(totalERC20Fee >0) {
// NB: The user has control of where this external call goes (fnftConfig.asset)
IERC20(fnftConfig.asset).safeTransferFrom(_msgSender(), addressesProvider.getAdmin(), totalERC20Fee);
}
}
// If there's any leftover ETH after the flat fee, convert it to WETH
weiValue -= flatWeiFee;
}
// Convert ETH to WETH if necessaryif(weiValue >0) {
// If the asset is WETH, we also enable sending ETH to pay for the tx fee. Not required thoughrequire(fnftConfig.asset == WETH, "E053");
require(weiValue >= fnftConfig.depositAmount, "E015");
}
// Create the FNFT and update accounting within TokenVault
ITokenVault(vault).createFNFT(fnftId, fnftConfig, totalQuantity, _msgSender());
// Now, we move the funds to token vault from the message senderif(fnftConfig.asset !=address(0)){
address smartWallet = ITokenVaultV2(vault).getFNFTAddress(fnftId);
// NB: The user has control of where this external call goes (fnftConfig.asset)
IERC20(fnftConfig.asset).safeTransferFrom(_msgSender(), smartWallet, totalQuantity * fnftConfig.depositAmount);
}
// Mint NFT// Gas optimizationif(!isSingular) {
getFNFTHandler().mintBatchRec(recipients, quantities, fnftId, totalQuantity, '');
} else {
getFNFTHandler().mint(recipients[0], fnftId, quantities[0], '');
}
}
functionsetFlatWeiFee(uint wethFee) externaloverrideonlyOwner{
flatWeiFee = wethFee;
}
functionsetERC20Fee(uint erc20) externaloverrideonlyOwner{
erc20Fee = erc20;
}
functiongetFlatWeiFee() externalviewoverridereturns (uint) {
return flatWeiFee;
}
functiongetERC20Fee() externalviewoverridereturns (uint) {
return erc20Fee;
}
/**
* @dev Returns the cached IAddressRegistry connected to this contract
**/functiongetAddressesProvider() externalviewreturns (IAddressRegistry) {
return addressesProvider;
}
/// Used to whitelist a contract for custom fee behaviorfunctionmodifyWhitelist(address contra, bool listed) externalonlyOwner{
whitelisted[contra] = listed;
}
}
// SPDX-License-Identifier: GNU-GPL v3.0 or laterpragmasolidity ^0.8.0;import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
contractRevestReentrancyGuardisReentrancyGuard{
// Used to avoid reentrancyuintprivateconstant MAX_INT =0xFFFFFFFFFFFFFFFF;
uintprivate currentId = MAX_INT;
modifierrevestNonReentrant(uint fnftId) {
// On the first call to nonReentrant, _notEntered will be truerequire(fnftId != currentId, "E052");
// Any calls to nonReentrant after this point will fail
currentId = fnftId;
_;
currentId = MAX_INT;
}
}
Contract Source Code
File 27 of 27: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^0.8.0;import"../IERC20.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.
*/librarySafeERC20{
usingAddressforaddress;
functionsafeTransfer(
IERC20 token,
address to,
uint256 value
) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
functionsafeTransferFrom(
IERC20 token,
addressfrom,
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.
*/functionsafeApprove(
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));
}
functionsafeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
functionsafeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/function_callOptionalReturn(IERC20 token, bytesmemory data) private{
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that// the target address contains contract code and also asserts for success in the low-level call.bytesmemory returndata =address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length>0) {
// Return data is optionalrequire(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}