typescript-sdk

Home > @3rdweb/sdk > ISplitsModule > withdrawToken

ISplitsModule.withdrawToken() method

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.

Signature:

withdrawToken(walletAddress: string, tokenAddress: string): Promise<void>;

Parameters

Parameter Type Description
walletAddress string The address to withdraw royalties for.
tokenAddress string  

Returns:

Promise<void>