// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.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
* ====
*
* [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://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].
*/
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);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^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.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
import { IFeeCollector } from "./interfaces/IFeeCollector.sol";
import { LibTransfer } from "./lib/LibTransfer.sol";
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { Multicall } from "@openzeppelin/contracts/utils/Multicall.sol";
/// @title A smart contract for registering vaults for payments.
contract FeeCollector is IFeeCollector, Multicall, Ownable {
using LibTransfer for address payable;
address payable public guildTreasury;
uint96 public totalFeeBps;
mapping(string => FeeShare[]) internal feeSchemas;
Vault[] internal vaults;
/// @param guildTreasury_ The address that will receive Guild's share from the funds.
/// @param totalFeeBps_ The percentage of Guild's and any partner's share expressed in basis points.
constructor(address payable guildTreasury_, uint256 totalFeeBps_) {
guildTreasury = guildTreasury_;
totalFeeBps = uint96(totalFeeBps_);
}
function registerVault(address payable owner, address token, bool multiplePayments, uint128 fee) external {
Vault storage vault = vaults.push();
vault.owner = owner;
vault.token = token;
vault.multiplePayments = multiplePayments;
vault.fee = fee;
emit VaultRegistered(vaults.length - 1, owner, token, fee);
}
function payFee(uint256 vaultId) external payable {
if (vaultId >= vaults.length) revert VaultDoesNotExist(vaultId);
Vault storage vault = vaults[vaultId];
if (!vault.multiplePayments && vault.paid[msg.sender]) revert AlreadyPaid(vaultId, msg.sender);
uint256 requiredAmount = vault.fee;
vault.balance += uint128(requiredAmount);
vault.paid[msg.sender] = true;
// If the tokenAddress is zero, the payment should be in Ether, otherwise in ERC20.
address tokenAddress = vault.token;
if (tokenAddress == address(0)) {
if (msg.value != requiredAmount) revert IncorrectFee(vaultId, msg.value, requiredAmount);
} else {
if (msg.value != 0) revert IncorrectFee(vaultId, msg.value, 0);
payable(address(this)).sendTokenFrom(msg.sender, tokenAddress, requiredAmount);
}
emit FeeReceived(vaultId, msg.sender, requiredAmount);
}
function withdraw(uint256 vaultId, string calldata feeSchemaKey) external {
if (vaultId >= vaults.length) revert VaultDoesNotExist(vaultId);
Vault storage vault = vaults[vaultId];
if (msg.sender != vault.owner) revert AccessDenied(msg.sender, vault.owner);
uint256 collected = vault.balance;
vault.balance = 0;
// Calculate fees to receive. Royalty is truncated - the remainder goes to the owner.
uint256 royaltyAmount = (collected * totalFeeBps) / 10000;
uint256 guildAmount = royaltyAmount;
// If the tokenAddress is zero, the collected fees are in Ether, otherwise in ERC20.
address tokenAddress = vault.token;
// Distribute fees for partners.
FeeShare[] memory feeSchema = feeSchemas[feeSchemaKey];
for (uint256 i; i < feeSchema.length; ) {
uint256 partnerAmount = (royaltyAmount * feeSchema[i].feeShareBps) / 10000;
guildAmount -= partnerAmount;
if (tokenAddress == address(0)) feeSchema[i].treasury.sendEther(partnerAmount);
else feeSchema[i].treasury.sendToken(tokenAddress, partnerAmount);
unchecked {
++i;
}
}
// Send the fees to Guild and the vault owner.
if (tokenAddress == address(0)) {
guildTreasury.sendEther(guildAmount);
vault.owner.sendEther(collected - royaltyAmount);
} else {
guildTreasury.sendToken(tokenAddress, guildAmount);
vault.owner.sendToken(tokenAddress, collected - royaltyAmount);
}
emit Withdrawn(vaultId);
}
function addFeeSchema(string calldata key, FeeShare[] calldata feeShare) external onlyOwner {
FeeShare[] storage fs = feeSchemas[key];
for (uint256 i; i < feeShare.length; ) {
fs.push(feeShare[i]);
unchecked {
++i;
}
}
emit FeeSchemaAdded(key);
}
function setGuildTreasury(address payable newTreasury) external onlyOwner {
guildTreasury = newTreasury;
emit GuildTreasuryChanged(newTreasury);
}
function setTotalFeeBps(uint96 newShare) external onlyOwner {
totalFeeBps = newShare;
emit TotalFeeBpsChanged(newShare);
}
function setVaultDetails(
uint256 vaultId,
address payable newOwner,
bool newMultiplePayments,
uint128 newFee
) external {
if (vaultId >= vaults.length) revert VaultDoesNotExist(vaultId);
Vault storage vault = vaults[vaultId];
if (msg.sender != vault.owner) revert AccessDenied(msg.sender, vault.owner);
vault.owner = newOwner;
vault.multiplePayments = newMultiplePayments;
vault.fee = newFee;
emit VaultDetailsChanged(vaultId);
}
function getFeeSchema(string calldata key) external view returns (FeeShare[] memory schema) {
return feeSchemas[key];
}
function getVault(
uint256 vaultId
)
external
view
returns (address payable owner, address token, bool multiplePayments, uint128 fee, uint128 balance)
{
if (vaultId >= vaults.length) revert VaultDoesNotExist(vaultId);
Vault storage vault = vaults[vaultId];
return (vault.owner, vault.token, vault.multiplePayments, vault.fee, vault.balance);
}
function hasPaid(uint256 vaultId, address account) external view returns (bool paid) {
if (vaultId >= vaults.length) revert VaultDoesNotExist(vaultId);
return vaults[vaultId].paid[account];
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.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);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @title A smart contract for registering vaults for payments.
interface IFeeCollector {
/// @notice An item that represents whom to transfer fees to and what percentage of the fees
/// should be sent (expressed in basis points).
struct FeeShare {
address payable treasury;
uint96 feeShareBps;
}
/// @notice Contains information about individual fee collections.
/// @dev See {getVault} for details.
struct Vault {
address payable owner;
address token;
bool multiplePayments;
uint128 fee;
uint128 balance;
mapping(address => bool) paid;
}
/// @notice Registers a vault and it's fee.
/// @param owner The address that receives the fees from the payment.
/// @param token The zero address for Ether, otherwise an ERC20 token.
/// @param multiplePayments Whether the fee can be paid multiple times.
/// @param fee The amount of fee to pay in base units.
function registerVault(address payable owner, address token, bool multiplePayments, uint128 fee) external;
/// @notice Registers the paid fee, both in Ether or ERC20.
/// @dev If ERC20 tokens are used, the contract needs to be approved using the {IERC20-approve} function.
/// @param vaultId The id of the vault to pay to.
function payFee(uint256 vaultId) external payable;
/// @notice Distributes the funds from a vault to the fee collectors and the owner.
/// @dev Callable only by the vault's owner.
/// @param vaultId The id of the vault whose funds should be distributed.
/// @param feeSchemaKey The key of the schema used to distribute fees.
function withdraw(uint256 vaultId, string calldata feeSchemaKey) external;
/// @notice Adds a new fee schema (array of FeeShares).
/// Note that any remaining percentage of the fees will go to Guild's treasury.
/// A FeeShare is an item that represents whom to transfer fees to and what percentage of the fees
/// should be sent (expressed in basis points).
/// @dev Callable only by the owner.
/// @param key The key of the schema, used to look it up in the feeSchemas mapping.
/// @param feeShares An array of FeeShare structs.
function addFeeSchema(string calldata key, FeeShare[] calldata feeShares) external;
/// @notice Sets the address that receives Guild's share from the funds.
/// @dev Callable only by the owner.
/// @param newTreasury The new address of Guild's treasury.
function setGuildTreasury(address payable newTreasury) external;
/// @notice Sets Guild's and any partner's share from the funds.
/// @dev Callable only by the owner.
/// @param newShare The percentual value expressed in basis points.
function setTotalFeeBps(uint96 newShare) external;
/// @notice Changes the details of a vault.
/// @dev Callable only by the owner of the vault to be changed.
/// @param vaultId The id of the vault whose details should be changed.
/// @param newOwner The address that will receive the fees from now on.
/// @param newMultiplePayments Whether the fee can be paid multiple times from now on.
/// @param newFee The amount of fee to pay in base units from now on.
function setVaultDetails(
uint256 vaultId,
address payable newOwner,
bool newMultiplePayments,
uint128 newFee
) external;
/// @notice Returns a fee schema for a given key.
/// @param key The key of the schema.
/// @param schema The fee schema corresponding to the key.
function getFeeSchema(string calldata key) external view returns (FeeShare[] memory schema);
/// @notice Returns a vault's details.
/// @param vaultId The id of the queried vault.
/// @return owner The owner of the vault who recieves the funds.
/// @return token The address of the token to receive funds in (the zero address in case of Ether).
/// @return multiplePayments Whether the fee can be paid multiple times.
/// @return fee The amount of required funds in base units.
/// @return balance The amount of already collected funds.
function getVault(
uint256 vaultId
) external view returns (address payable owner, address token, bool multiplePayments, uint128 fee, uint128 balance);
/// @notice Returns if an account has paid the fee to a vault.
/// @param vaultId The id of the queried vault.
/// @param account The address of the queried account.
function hasPaid(uint256 vaultId, address account) external view returns (bool paid);
/// @notice Returns the address that receives Guild's share from the funds.
function guildTreasury() external view returns (address payable);
/// @notice Returns the percentage of Guild's and any partner's share expressed in basis points.
function totalFeeBps() external view returns (uint96);
/// @notice Event emitted when a call to {payFee} succeeds.
/// @param vaultId The id of the vault that received the payment.
/// @param account The address of the account that paid.
/// @param amount The amount of fee received in base units.
event FeeReceived(uint256 indexed vaultId, address indexed account, uint256 amount);
/// @notice Event emitted when a new fee schema is added.
/// @param key The key of the schema, used to look it up in the feeSchemas mapping.
event FeeSchemaAdded(string key);
/// @notice Event emitted when the Guild treasury address is changed.
/// @param newTreasury The address to change Guild's treasury to.
event GuildTreasuryChanged(address newTreasury);
/// @notice Event emitted when the share of the total fee changes.
/// @param newShare The new value of totalFeeBps.
event TotalFeeBpsChanged(uint96 newShare);
/// @notice Event emitted when a vault's details are changed.
/// @param vaultId The id of the altered vault.
event VaultDetailsChanged(uint256 vaultId);
/// @notice Event emitted when a new vault is registered.
/// @param owner The address that receives the fees from the payment.
/// @param token The zero address for Ether, otherwise an ERC20 token.
/// @param fee The amount of fee to pay in base units.
event VaultRegistered(uint256 vaultId, address payable indexed owner, address indexed token, uint256 fee);
/// @notice Event emitted when funds are withdrawn by a vault owner.
/// @param vaultId The id of the vault.
event Withdrawn(uint256 indexed vaultId);
/// @notice Error thrown when a function is attempted to be called by the wrong address.
/// @param sender The address that sent the transaction.
/// @param owner The address that is allowed to call the function.
error AccessDenied(address sender, address owner);
/// @notice Error thrown when multiple payments aren't enabled, but the sender attempts to pay repeatedly.
/// @param vaultId The id of the vault.
/// @param sender The sender of the transaction.
error AlreadyPaid(uint256 vaultId, address sender);
/// @notice Error thrown when an incorrect amount of fee is attempted to be paid.
/// @dev requiredAmount might be 0 in cases when an ERC20 payment was expected but Ether was received, too.
/// @param vaultId The id of the vault.
/// @param paid The amount of funds received.
/// @param requiredAmount The amount of fees required by the vault.
error IncorrectFee(uint256 vaultId, uint256 paid, uint256 requiredAmount);
/// @notice Error thrown when a vault does not exist.
/// @param vaultId The id of the requested vault.
error VaultDoesNotExist(uint256 vaultId);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/// @title Library for functions related to transfers.
library LibTransfer {
/// @notice Error thrown when sending ether fails.
/// @param recipient The address that could not receive the ether.
error FailedToSendEther(address recipient);
/// @notice Error thrown when an ERC20 transfer failed.
/// @param from The sender of the token.
/// @param to The recipient of the token.
error TransferFailed(address from, address to);
/// @notice Sends ether to an address, forwarding all available gas and reverting on errors.
/// @param recipient The recipient of the ether.
/// @param amount The amount of ether to send in base units.
function sendEther(address payable recipient, uint256 amount) internal {
// solhint-disable-next-line avoid-low-level-calls
(bool success, ) = recipient.call{ value: amount }("");
if (!success) revert FailedToSendEther(recipient);
}
/// @notice Sends an ERC20 token to an address and reverts if the transfer returns false.
/// @dev Wrapper for {IERC20-transfer}.
/// @param to The recipient of the tokens.
/// @param token The address of the token to send.
/// @param amount The amount of the token to send in base units.
function sendToken(address to, address token, uint256 amount) internal {
if (!IERC20(token).transfer(to, amount)) revert TransferFailed(msg.sender, address(this));
}
/// @notice Sends an ERC20 token to an address from another address and reverts if transferFrom returns false.
/// @dev Wrapper for {IERC20-transferFrom}.
/// @dev The contract needs to be approved using the {IERC20-approve} function to move the tokens.
/// @param to The recipient of the tokens.
/// @param from The source of the tokens.
/// @param token The address of the token to send.
/// @param amount The amount of the token to send in base units.
function sendTokenFrom(address to, address from, address token, uint256 amount) internal {
if (!IERC20(token).transferFrom(from, to, amount)) revert TransferFailed(msg.sender, address(this));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (utils/Multicall.sol)
pragma solidity ^0.8.0;
import "./Address.sol";
/**
* @dev Provides a function to batch together multiple calls in a single external call.
*
* _Available since v4.1._
*/
abstract contract Multicall {
/**
* @dev Receives and executes a batch of function calls on this contract.
*/
function multicall(bytes[] calldata data) external virtual returns (bytes[] memory results) {
results = new bytes[](data.length);
for (uint256 i = 0; i < data.length; i++) {
results[i] = Address.functionDelegateCall(address(this), data[i]);
}
return results;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^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.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
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.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
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) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
{
"compilationTarget": {
"contracts/FeeCollector.sol": "FeeCollector"
},
"evmVersion": "paris",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 200
},
"remappings": []
}
[{"inputs":[{"internalType":"address payable","name":"guildTreasury_","type":"address"},{"internalType":"uint256","name":"totalFeeBps_","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"owner","type":"address"}],"name":"AccessDenied","type":"error"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"},{"internalType":"address","name":"sender","type":"address"}],"name":"AlreadyPaid","type":"error"},{"inputs":[{"internalType":"address","name":"recipient","type":"address"}],"name":"FailedToSendEther","type":"error"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"},{"internalType":"uint256","name":"paid","type":"uint256"},{"internalType":"uint256","name":"requiredAmount","type":"uint256"}],"name":"IncorrectFee","type":"error"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"}],"name":"TransferFailed","type":"error"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"VaultDoesNotExist","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"vaultId","type":"uint256"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"FeeReceived","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"string","name":"key","type":"string"}],"name":"FeeSchemaAdded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"newTreasury","type":"address"}],"name":"GuildTreasuryChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint96","name":"newShare","type":"uint96"}],"name":"TotalFeeBpsChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"VaultDetailsChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"vaultId","type":"uint256"},{"indexed":true,"internalType":"address payable","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"VaultRegistered","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"Withdrawn","type":"event"},{"inputs":[{"internalType":"string","name":"key","type":"string"},{"components":[{"internalType":"address payable","name":"treasury","type":"address"},{"internalType":"uint96","name":"feeShareBps","type":"uint96"}],"internalType":"struct IFeeCollector.FeeShare[]","name":"feeShare","type":"tuple[]"}],"name":"addFeeSchema","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"string","name":"key","type":"string"}],"name":"getFeeSchema","outputs":[{"components":[{"internalType":"address payable","name":"treasury","type":"address"},{"internalType":"uint96","name":"feeShareBps","type":"uint96"}],"internalType":"struct IFeeCollector.FeeShare[]","name":"schema","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"getVault","outputs":[{"internalType":"address payable","name":"owner","type":"address"},{"internalType":"address","name":"token","type":"address"},{"internalType":"bool","name":"multiplePayments","type":"bool"},{"internalType":"uint128","name":"fee","type":"uint128"},{"internalType":"uint128","name":"balance","type":"uint128"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"guildTreasury","outputs":[{"internalType":"address payable","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"},{"internalType":"address","name":"account","type":"address"}],"name":"hasPaid","outputs":[{"internalType":"bool","name":"paid","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes[]","name":"data","type":"bytes[]"}],"name":"multicall","outputs":[{"internalType":"bytes[]","name":"results","type":"bytes[]"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"payFee","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address payable","name":"owner","type":"address"},{"internalType":"address","name":"token","type":"address"},{"internalType":"bool","name":"multiplePayments","type":"bool"},{"internalType":"uint128","name":"fee","type":"uint128"}],"name":"registerVault","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address payable","name":"newTreasury","type":"address"}],"name":"setGuildTreasury","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint96","name":"newShare","type":"uint96"}],"name":"setTotalFeeBps","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"},{"internalType":"address payable","name":"newOwner","type":"address"},{"internalType":"bool","name":"newMultiplePayments","type":"bool"},{"internalType":"uint128","name":"newFee","type":"uint128"}],"name":"setVaultDetails","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"totalFeeBps","outputs":[{"internalType":"uint96","name":"","type":"uint96"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"},{"internalType":"string","name":"feeSchemaKey","type":"string"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]