User accounts.
Indicator if user has wallet.
User identifier.
Listen to all account data changes.
interface to listen to user changes
Create fiat account on specified network and currency code. User must already be fiat customer on specified network.
'MAINNET' or 'TESTNET'
country code in ISO 4217 format, e.g. 'GBP'
Create user wallet seeded by provided mnemonic and encrypted with user's password.
Mnemonic can be generated by Utils.generateMnemonic utility method.
mnemonic seed phrase
user provided password
Get account in specific currency, on specific network, with specific type.
currency code, e.g. 'BTC', 'ETH' or 'GBP'
network type, e.g. 'MAINNET', 'TESTNET' or 'RINKEBY'
account type, e.g. 'STANDARD', 'COMPATIBILITY' or 'SEGWIT'
Get nominated account details for specified account if it exists. Refer to Create Fiat Account for explanation about nominated account.
Account identifier
Check if user is a fiat customer on 'MAINNET' or 'TESTNET' network.
'MAINNET' or 'TESTNET'
Check if mnemonic seed phrase corresponds to user's wallet. This is useful for validating seed phrase before trying to recover wallet.
mnemonic seed phrase
Make user fiat customer on specified network by providing user's personal details.
'MAINNET' or 'TESTNET'
user's personal details.
Recover user wallet with mnemonic seed phrase corresponding to user's wallet. This can be used if user forgets his password or wants to change his wallet password.
mnemonic seed phrase corresponding to user's wallet
user provided password
Remove listener to state changes.
interface to listen to state changes
Reveal mnemonic seed phrase used to seed user wallet.
user provided password
Unlock user wallet with user's password.
user provided password
Generated using TypeDoc
User instance provides methods for managing user wallet and accounts.
User instance can be obtained via ZumoKit.signIn method.
See Manage User Wallet, Create Fiat Account and View User Data guides for usage details.