Overview

Interfaces

Name	Description
AccountListener	Listener called when there is a change in account state.
AuthCallback	Callback called after authentication attempt.
MnemonicCallback	Callback called after attempting to reveal user's mnemonic phrase.
SendTransactionCallback	Callback called after submitting a transaction.
StateListener	Listener called when there is a change in state.
TransactionListener	Listener called when there is a change in transaction state.
UserListener	Listener called when there is a change in user state.
WalletCallback	Callback called after creating, unlocking or recovering wallet.

Classes

Name	Description
Account	Record containing account details.
FeeRates	Record containing cryptocurrency fee rates.
State	Record containing state details.
Transaction	Record containing transaction details.
TxServiceConnection	Record containing transaction service connection details.
User	Class containing user management methods.
Utils	Class containing utility methods.
Wallet	Class containing send transaction methods.
ZumoKit	The entry point of the ZumoKit SDK.

Enums

Name	Description
AccountType	Account type used in getAccount helper method.
ConnectionStatus	Transaction service connection status used in TxServiceConnection object.
NetworkType	Network type used in Account object.
TransactionStatus	Transaction status used in Transaction object.
TransactionType	Transaction type used in Transaction object.

Exceptions

Name	Description
APIConnectionException	Exception thrown on failure to connect to ZumoKit’s API.
APIException	Exception thrown if something goes wrong on our side.
AuthenticationException	Exception thrown on failure to authenticate with ZumoKit's API.
InvalidArgumentException	Exception thrown on failure to validate arguments.
InvalidRequestException	Exception thrown when request to API has invalid parameters.
RateLimitException	Exception thrown when too many requests hit the API too quickly.
WalletException	Exception thrown when user's action fails even if parameters are valid.
ZumoKitException	Base ZumoKit exception class from which other exceptions inherit.