Splitter Contract Architecture

Splitter Contracts

Constructor

constructor(address[] memory _payees, uint256[] memory _shares)
        PaymentSplitter(_payees, _shares)
{}
IndexNameDescription
0_payeesList of Payees
1_sharesList of shares for each Payee

Functions

Legend

FieldMeaning
πŸ› Function can modify state
πŸ’΅Function is payable
Publicpublic functions can be called internally from within the contract or externally via messages
ExternalExternal functions are part of the contract interface, which means they can be called from other contracts and via transactions. An external function f cannot be called internally (i.e. f() does not work, but this.f() works)

Description

Function NameVisibilityMutabilityDescription
totalPayeesPublic-Returns the total number of payees
isPayeePublic-Returns true if a supplied address is a payee
addPayeePublicπŸ› Adds a single address with a share to the payee list
addPayeesPublicπŸ› Adds a list of addresses, each with a share, to the payee list
releaseAllPublicπŸ› Releases all ETH in the contract to the payees
releaseAllPublicπŸ› Releases all ERC-20 tokens in the contract to the payees

Architecture

πŸ“˜

Want to see an example of how the math works out for a Splitter contract? See the Distributing Proceeds Example

Feedback

Something not quite right, unclear or can't find what you are looking for? Please let us know at [email protected] and we will get back to you as soon as we can.