EeseeSplit

Recipient

struct Recipient {
  address payable recipient;
  uint16 bps;
}

royaltyShare

uint256 royaltyShare

Share of total sale that goes to royalty. [10000 = 100%].

InvalidRoyaltyShare

error InvalidRoyaltyShare()

initializeWithRoyaltyShare

function initializeWithRoyaltyShare(uint256 _royaltyShare, address _defaultAdmin, string _contractURI, address[] _trustedForwarders, address[] _payees, uint256[] _shares) external

getRecipients

function getRecipients() external view returns (struct EeseeSplit.Recipient[] splitRecipients)

RoyaltyEngine requires this function to be present for Multi Recipient ERC2981 Royalties.

Inherited from Split

initialize

function initialize(address _defaultAdmin, string _contractURI, address[] _trustedForwarders, address[] _payees, uint256[] _shares) external

Performs the job of the constructor. shares are scaled by 10,000 to prevent precision loss when including fees_

contractType

function contractType() external pure returns (bytes32)

Returns the module type of the contract.

contractVersion

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

release

function release(address payable account) public virtual

Triggers a transfer to account of the amount of Ether they are owed, according to their percentage of the total shares and their previous withdrawals.

release

function release(contract IERC20Upgradeable token, address account) public virtual

Triggers a transfer to account of the amount of token tokens they are owed, according to their percentage of the total shares and their previous withdrawals. token must be the address of an IERC20 contract.

distribute

function distribute() public virtual

Release the owed amount of token to all of the payees.

distribute

function distribute(contract IERC20Upgradeable token) public virtual

Release owed amount of the token to all of the payees.

setContractURI

function setContractURI(string _uri) external

Sets contract URI for the contract-level metadata of the contract.

Inherited from PaymentSplitterUpgradeable

totalShares

function totalShares() public view returns (uint256)

Getter for the total shares held by payees.

totalReleased

function totalReleased() public view returns (uint256)

Getter for the total amount of Ether already released.

totalReleased

function totalReleased(contract IERC20Upgradeable token) public view returns (uint256)

Getter for the total amount of token already released. token should be the address of an IERC20 contract.

function shares(address account) public view returns (uint256)

Getter for the amount of shares held by an account.

released

function released(address account) public view returns (uint256)

Getter for the amount of Ether already released to a payee.

released

function released(contract IERC20Upgradeable token, address account) public view returns (uint256)

Getter for the amount of token tokens already released to a payee. token should be the address of an IERC20 contract.

payee

function payee(uint256 index) public view returns (address)

Getter for the address of the payee number index.

payeeCount

function payeeCount() public view returns (uint256)

Get the number of payees

releasable

function releasable(address account) public view returns (uint256)

Getter for the amount of payee's releasable Ether.

releasable

function releasable(contract IERC20Upgradeable token, address account) public view returns (uint256)

Getter for the amount of payee's releasable token tokens. token should be the address of an IERC20 contract.

PayeeAdded

event PayeeAdded(address account, uint256 shares)

PaymentReleased

event PaymentReleased(address to, uint256 amount)

ERC20PaymentReleased

event ERC20PaymentReleased(contract IERC20Upgradeable token, address to, uint256 amount)

PaymentReceived

event PaymentReceived(address from, uint256 amount)

Inherited from AccessControlEnumerableUpgradeable

supportsInterface

function supportsInterface(bytes4 interfaceId) public view virtual returns (bool)

See {IERC165-supportsInterface}.

getRoleMember

function getRoleMember(bytes32 role, uint256 index) public view virtual returns (address)

_Returns one of the accounts that have role. index must be a value between 0 and {getRoleMemberCount}, non-inclusive.

Role bearers are not sorted in any particular way, and their ordering may change at any point.

WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] for more information._

getRoleMemberCount

function getRoleMemberCount(bytes32 role) public view virtual returns (uint256)

Returns the number of accounts that have role. Can be used together with {getRoleMember} to enumerate all bearers of a role.

Inherited from AccessControlUpgradeable

hasRole

function hasRole(bytes32 role, address account) public view virtual returns (bool)

Returns true if account has been granted role.

getRoleAdmin

function getRoleAdmin(bytes32 role) public view virtual returns (bytes32)

_Returns the admin role that controls role. See {grantRole} and {revokeRole}.

To change a role's admin, use {setRoleAdmin}.

grantRole

function grantRole(bytes32 role, address account) public virtual

_Grants role to account.

If account had not been already granted role, emits a {RoleGranted} event.

Requirements:

the caller must have role's admin role.

May emit a {RoleGranted} event._

revokeRole

function revokeRole(bytes32 role, address account) public virtual

_Revokes role from account.

If account had been granted role, emits a {RoleRevoked} event.

Requirements:

the caller must have role's admin role.

May emit a {RoleRevoked} event._

renounceRole

function renounceRole(bytes32 role, address account) public virtual

_Revokes role from the calling account.

Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced).

If the calling account had been revoked role, emits a {RoleRevoked} event.

Requirements:

the caller must be account.

May emit a {RoleRevoked} event._

Inherited from ERC165Upgradeable

Inherited from IAccessControlUpgradeable

RoleAdminChanged

event RoleAdminChanged(bytes32 role, bytes32 previousAdminRole, bytes32 newAdminRole)

_Emitted when newAdminRole is set as role's admin role, replacing previousAdminRole

DEFAULT_ADMIN_ROLE is the starting admin for all roles, despite {RoleAdminChanged} not being emitted signaling this.

Available since v3.1._

RoleGranted

event RoleGranted(bytes32 role, address account, address sender)

_Emitted when account is granted role.

sender is the account that originated the contract call, an admin role bearer except when using {AccessControl-setupRole}.

RoleRevoked

event RoleRevoked(bytes32 role, address account, address sender)

_Emitted when account is revoked role.

sender is the account that originated the contract call:

if using revokeRole, it is the admin role bearer
if using renounceRole, it is the role bearer (i.e. account)_

Inherited from ERC2771ContextUpgradeable

isTrustedForwarder

function isTrustedForwarder(address forwarder) public view virtual returns (bool)

Inherited from ContextUpgradeable

Inherited from Multicall

multicall

function multicall(bytes[] data) external virtual returns (bytes[] results)

@notice Receives and executes a batch of function calls on this contract. @dev Receives and executes a batch of function calls on this contract.

@param data The bytes data that makes up the batch of function calls to execute. @return results The bytes data that makes up the result of the batch of function calls executed.

Inherited from Initializable

Initialized

event Initialized(uint8 version)

Triggered when the contract has been initialized or reinitialized.

Inherited from IThirdwebContract

contractURI

function contractURI() external view returns (string)

Returns the metadata URI of the contract.

PreviousEeseeProxy NextRouters

Last updated 1 year ago