Class User

A user instance to manage HD wallet and legacy wallets with detailed information. A user serialized value is secured by a secured password which is given by user. We should never store user's password but its encrypted one to do extra actions.

Hierarchy

User

Implements

IUser

Constructors

constructor

new User(password, options?, hdWalletPathTemplate?): User
Initialize a new user instnace
Parameters
- password: string
  
  a secure password to encrypt/decrypt user's data
- Optional options: Partial<IUserOptions>
  
  Options to work with user's instance
- Optional hdWalletPathTemplate: string
  
  Option to define a custom derivation path of HD wallet (default is m/PURPOSE'/COINT_TYPE'/INDEX')
Returns User
- Defined in user/user.ts:54

Properties

`Private` _hdWalletInfo

_hdWalletInfo: HDWalletInfo

`Private` _hdWalletPathTemplate

_hdWalletPathTemplate: string

`Private` _legacyWallets

_legacyWallets: WalletInfo[]

`Private` _passwordValidator

_passwordValidator: IPasswordValidator

`Private` _pwdOptions

_pwdOptions: PasswordOptions

Secret password (encrypted from user's password). To serialize/deserialize the wallet information

`Private` _underlyingHDWallet

_underlyingHDWallet: IHDWallet<Wallet>

Methods

addLegacyWallet

addLegacyWallet(wallet, info?): void
Add a legacy wallet
Parameters
- wallet: IWallet<Hex>
- Optional info: WalletDescriptor
Returns void
Implementation of IUser.addLegacyWallet
- Defined in user/user.ts:112

addWalletAccount

addWalletAccount(index, info?): Promise<IWallet<IHDKey>>
Add an account for HD wallet
Parameters
- index: number
- Optional info: WalletDescriptor
Returns Promise<IWallet<IHDKey>>
Implementation of IUser.addWalletAccount
- Defined in user/user.ts:98

decrypt

decrypt(value): Promise<string>
Decrypt the given value by user's password
Parameters
- value: string
Returns Promise<string>
Implementation of IUser.decrypt
- Defined in user/user.ts:281

deserialize

deserialize(value): Promise<void>
Deserializes the serialized and encrypted user information to merge back the current user instance.
Parameters
- value: string
  
  serialized user information
Returns Promise<void>
Implementation of IUser.deserialize
- Defined in user/user.ts:222

encrypt

encrypt(value): Promise<string>
Encrypt the given value by user's password. Everytime we call this method, a new salt will be generated and update directly to the current user instance. The caller must also store it in order to re-use later.
Parameters
- value: string
Returns Promise<string>
Implementation of IUser.encrypt
- Defined in user/user.ts:276

getHDWallet

getHDWallet(): HDWalletInfo
Get the HD wallet

Returns HDWalletInfo
Implementation of IUser.getHDWallet
- Defined in user/user.ts:86

getLegacyWallets

getLegacyWallets(): WalletInfo[]
Get all current legacy wallets

Returns WalletInfo[]
Implementation of IUser.getLegacyWallets
- Defined in user/user.ts:128

`Private` getWallet

getWallet(): IHDWallet<IWallet<IHDKey>>
Returns IHDWallet<IWallet<IHDKey>>
- Defined in user/user.ts:286

getWalletAccount

getWalletAccount(index): Promise<IWallet<IHDKey>>
Get the HD wallet account for the given index
Parameters
- index: number
  
  account index
Returns Promise<IWallet<IHDKey>>
Implementation of IUser.getWalletAccount
- Defined in user/user.ts:90

getWalletAccountByRefKey

getWalletAccountByRefKey(idOrPath): Promise<IWallet<IHDKey>>
Get the HD wallet account for the given reference key (path)
Parameters
- idOrPath: string
  
  account ref key (path)
Returns Promise<IWallet<IHDKey>>
Implementation of IUser.getWalletAccountByRefKey
- Defined in user/user.ts:94

getWalletInfo

getWalletInfo(id): WalletInfo
Get wallet information
Parameters
- id: string
  
  could be id or uid of from wallet info
Returns WalletInfo
Implementation of IUser.getWalletInfo
- Defined in user/user.ts:161

hasHDWallet

hasHDWallet(): boolean
Check if we set the HD wallet already

Returns boolean
Implementation of IUser.hasHDWallet
- Defined in user/user.ts:136

hasLegacyWallets

hasLegacyWallets(): boolean
Check if we have any legacy wallets

Returns boolean
Implementation of IUser.hasLegacyWallets
- Defined in user/user.ts:132

`Private` isHDWalletPath

isHDWalletPath(id): boolean
Check if the given id belongs to a HD wallet. The id of a HD wallet should be a path
Parameters
- id: string
Returns boolean
- Defined in user/user.ts:317

removeWalletAccount

removeWalletAccount(index): Promise<void>
Remove an account from HD wallet
Parameters
- index: number
Returns Promise<void>
Implementation of IUser.removeWalletAccount
- Defined in user/user.ts:107

removeWalletInfo

removeWalletInfo(id): void
Remove a wallet from user
Parameters
- id: string
  
  could be id or uid of from wallet info
Returns void
Implementation of IUser.removeWalletInfo
- Defined in user/user.ts:182

serialize

serialize(): Promise<string>
Serializes the wallet and encrypts it with the password.

Returns Promise<string>
The encrypted wallet.
Implementation of IUser.serialize
- Defined in user/user.ts:207

setHDWallet

setHDWallet(keyEntropy, encryptionType): Promise<void>
Set the HD wallet information
Parameters
- keyEntropy: Uint8Array
  
  the master key, either keyPhrase (12-24 words) or seed of keyPhrase
- encryptionType: EncryptionType
  
  the encryption type
Returns Promise<void>
Implementation of IUser.setHDWallet
- Defined in user/user.ts:78

`Private` setHDWalletAccount

setHDWalletAccount(id, info?): void
Parameters
- id: string
- Optional info: WalletDescriptor
Returns void
- Defined in user/user.ts:303

setWalletInfo

setWalletInfo(id, info): void
Set wallet information
Parameters
- id: string
  
  coule be id or uid from wallet info in case of updating, otherwise it must be an id (private key of legacy wallet or path of hd wallet)
- info: string | WalletDescriptor
Returns void
Implementation of IUser.setWalletInfo
- Defined in user/user.ts:140

updatePassword

updatePassword(password): Promise<void>
Update password to serialize user's information. A new salt will be generated regardless the given options.
Parameters
- password: string
Returns Promise<void>
Implementation of IUser.updatePassword
- Defined in user/user.ts:73

`Private` validatePassword

validatePassword(password): void
Confirms the given password matches requirements
Parameters
- password: string
Returns void
- Defined in user/user.ts:325

`Static` deserializeFrom

deserializeFrom(password, userEncryptedInfo, options?): Promise<User>
Deserialize user information to an instance of user
Parameters
- password: string
- userEncryptedInfo: string
- Optional options: Partial<IUserOptions>
  
  Options to work with user's instance
Returns Promise<User>
- Defined in user/user.ts:24

Class User

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

password: string

Optional options: Partial<IUserOptions>

Optional hdWalletPathTemplate: string

Returns User

Properties

Private _hdWalletInfo

Private _hdWalletPathTemplate

Private _legacyWallets

Private _passwordValidator

Private _pwdOptions

Private _underlyingHDWallet

Methods

addLegacyWallet

Parameters

wallet: IWallet<Hex>

Optional info: WalletDescriptor

Returns void

addWalletAccount

Parameters

index: number

Optional info: WalletDescriptor

Returns Promise<IWallet<IHDKey>>

decrypt

Parameters

value: string

Returns Promise<string>

deserialize

Parameters

value: string

Returns Promise<void>

encrypt

Parameters

value: string

Returns Promise<string>

getHDWallet

Returns HDWalletInfo

getLegacyWallets

Returns WalletInfo[]

Private getWallet

Returns IHDWallet<IWallet<IHDKey>>

getWalletAccount

Parameters

index: number

Returns Promise<IWallet<IHDKey>>

getWalletAccountByRefKey

Parameters

idOrPath: string

Returns Promise<IWallet<IHDKey>>

getWalletInfo

Parameters

id: string

Returns WalletInfo

hasHDWallet

Returns boolean

hasLegacyWallets

Returns boolean

Private isHDWalletPath

Parameters

id: string

Returns boolean

removeWalletAccount

Parameters

index: number

Returns Promise<void>

removeWalletInfo

Parameters

id: string

Returns void

serialize

Returns Promise<string>

`Optional` options: Partial<IUserOptions>

`Optional` hdWalletPathTemplate: string

`Private` _hdWalletInfo

`Private` _hdWalletPathTemplate

`Private` _legacyWallets

`Private` _passwordValidator

`Private` _pwdOptions

`Private` _underlyingHDWallet

`Optional` info: WalletDescriptor

`Optional` info: WalletDescriptor

`Private` getWallet

`Private` isHDWalletPath

`Private` setHDWalletAccount

`Optional` info: WalletDescriptor

`Private` validatePassword

`Static` deserializeFrom

`Optional` options: Partial<IUserOptions>