Home > @3rdweb/sdk > ISplitsModule
Signature:
export interface ISplitsModule
| Method | Description |
|---|---|
| balanceOf(address) | Returns the amount of royalty available for a recipient to withdraw in the native currency. |
| balanceOfToken(walletAddress, tokenAddress) | Returns the amount of royalty available for a recipient to withdraw in the native currency in a specific currency. |
| distribute() | Distributes all funds to the recipients. |
| distributeToken(tokenAddress) | Distributes all funds to the recipients in the specified currency. |
| getAllRecipients() | Returns a list of all recipients with their respective split percentages. |
| getRecipientSplitPercentage(address) | Get the split percentage of a recipient. |
| withdraw(address) | Transaction that will withdraw the split amount of royalty that the address is owed and transfer it to the wallet. |
| withdrawToken(walletAddress, tokenAddress) | Transaction that will withdraw the split amount of royalty that the address is owed and transfer it to the wallet, in the currency specified by tokenAddress.For example: If the native currency of a chain is ETH but the user wants to withdraw their split in $MATIC, they should pass the address of the $MATIC token as the tokenAddress parameter. |