Split

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

contractType

function contractType() external pure returns (bytes32)

Returns the module type of the contract.

Returns

Name	Type	Description
_0	bytes32	undefined

contractURI

function contractURI() external view returns (string)

Contract level metadata.

Returns

Name	Type	Description
_0	string	undefined

contractVersion

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

Returns

Name	Type	Description
_0	uint8	undefined

distribute

function distribute(contract IERC20Upgradeable token) external nonpayable

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

Parameters

Name	Type	Description
token	contract IERC20Upgradeable	undefined

distribute

function distribute() external nonpayable

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

getRoleAdmin

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	bytes32	undefined

getRoleMember

function getRoleMember(bytes32 role, uint256 index) external view 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.

Parameters

Name	Type	Description
role	bytes32	undefined
index	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

getRoleMemberCount

function getRoleMemberCount(bytes32 role) external view returns (uint256)

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

Parameters

Name	Type	Description
role	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

grantRole

function grantRole(bytes32 role, address account) external nonpayable

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.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

hasRole

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

Returns true if account has been granted role.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

initialize

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

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

Parameters

Name	Type	Description
_defaultAdmin	address	undefined
_contractURI	string	undefined
_trustedForwarders	address[]	undefined
_payees	address[]	undefined
_shares	uint256[]	undefined

isTrustedForwarder

function isTrustedForwarder(address forwarder) external view returns (bool)

Parameters

Name	Type	Description
forwarder	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

multicall

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

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

Parameters

Name	Type	Description
data	bytes[]	undefined

Returns

Name	Type	Description
results	bytes[]	undefined

payee

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

Getter for the address of the payee number index.

Parameters

Name	Type	Description
index	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

payeeCount

function payeeCount() external view returns (uint256)

Get the number of payees

Returns

Name	Type	Description
_0	uint256	undefined

releasable

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

Getter for the amount of payee's releasable Ether.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

releasable

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

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

Parameters

Name	Type	Description
token	contract IERC20Upgradeable	undefined
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

release

function release(address payable account) external nonpayable

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.

Parameters

Name	Type	Description
account	address payable	undefined

release

function release(contract IERC20Upgradeable token, address account) external nonpayable

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.

Parameters

Name	Type	Description
token	contract IERC20Upgradeable	undefined
account	address	undefined

released

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

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

Parameters

Name	Type	Description
token	contract IERC20Upgradeable	undefined
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

released

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

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

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

renounceRole

function renounceRole(bytes32 role, address account) external nonpayable

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.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

revokeRole

function revokeRole(bytes32 role, address account) external nonpayable

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.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

setContractURI

function setContractURI(string _uri) external nonpayable

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

Parameters

Name	Type	Description
_uri	string	undefined

shares

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

Getter for the amount of shares held by an account.

Parameters

Name	Type	Description
account	address	undefined

Returns

Name	Type	Description
_0	uint256	undefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

See {IERC165-supportsInterface}.

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

totalReleased

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

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

Parameters

Name	Type	Description
token	contract IERC20Upgradeable	undefined

Returns

Name	Type	Description
_0	uint256	undefined

totalReleased

function totalReleased() external view returns (uint256)

Getter for the total amount of Ether already released.

Returns

Name	Type	Description
_0	uint256	undefined

totalShares

function totalShares() external view returns (uint256)

Getter for the total shares held by payees.

Returns

Name	Type	Description
_0	uint256	undefined

Events

ERC20PaymentReleased

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

Parameters

Name	Type	Description
token indexed	contract IERC20Upgradeable	undefined
to	address	undefined
amount	uint256	undefined

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

PayeeAdded

event PayeeAdded(address account, uint256 shares)

Parameters

Name	Type	Description
account	address	undefined
shares	uint256	undefined

PaymentReceived

event PaymentReceived(address from, uint256 amount)

Parameters

Name	Type	Description
from	address	undefined
amount	uint256	undefined

PaymentReleased

event PaymentReleased(address to, uint256 amount)

Parameters

Name	Type	Description
to	address	undefined
amount	uint256	undefined

RoleAdminChanged

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
previousAdminRole indexed	bytes32	undefined
newAdminRole indexed	bytes32	undefined

RoleGranted

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

RoleRevoked

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

Parameters

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined