Type: Withdrawals

`GroupedBalances`

This type represents grouped balances. In the case of the getWithdrawableBalances method, it returns the balances of the wallet types from which the user can withdraw. These wallet types can be deduced from the getSupportedExchanges method.

We don't see balances by wallet type here because the Cede SDK will perform internal transfers between wallet types in order to withdraw the desired amount. Any amount that can be withdrawn will be shown in the freeBalance field.

type GroupedBalances = {
  [tokenSymbol: string]: {
    totalBalance: number;
    refTotalBalance: number;
    freeBalance: number;
    refFreeBalance: number;
  };
};

tokenSymbol - string
The token's symbol.
totalBalance - number
The total balance of the token.
refTotalBalance - number
The value of totalBalance in USD.
freeBalance - number
The balance able to be transfered, traded, sent without any action needed.
refFreeBalance - number
The value of freeBalance in USD.

`WhitelistedAddresses`

type WhitelistedAddresses = {
  address: string;
  key: string;
  network: string;
  tokenSymbol: string;
};

address - string
The address.
key - string
The identifier on the exchange side. Some exchanges require the key rather than the address.
network - string
The network internal ID. See Supported Networks for the list of supported networks.
tokenSymbol - string
The token's symbol.

Deposit Network