Skip to main content

Split.balanceOfTokenAllRecipients() method

Returns all the recipients and their balances in a non-native currency.

Signature:

balanceOfTokenAllRecipients(tokenAddress: string): Promise<{
[key: string]: {
symbol: string;
value: BigNumber;
name: string;
decimals: number;
displayValue: string;
};
}>;

Parameters

ParameterTypeDescription
tokenAddressstringThe address of the currency to check the balances in.

Returns:

Promise<{ [key: string]: { symbol: string; value: BigNumber; name: string; decimals: number; displayValue: string; }; }>

A map of recipient addresses to their balances in the specified currency.