Interface IKeyManager

Key provider

Hierarchy

IKeyManager

Index

Methods

generate getWordAt toEntropy toEntropyAsync toKey toKeyAsync toSeed toSeedArray toSeedArrayAsync toSeedAsync validate

Methods

generate

generate(wordsLength?): Uint8Array
Generate a new key (entropy of phrase)
Parameters
- Optional wordsLength: number
  
  number of words (default is 24), the words length should be from 12 to 24
Returns Uint8Array
- Defined in key/core/interfaces.ts:11

getWordAt

getWordAt(entropy, index, encode): string
Get a word at a specific index of the given entropy. If the index is not available, undefined will be returned
Parameters
- entropy: Hex
- index: number
- encode: boolean
Returns string
- Defined in key/core/interfaces.ts:53

toEntropy

toEntropy(key, encoded?): Uint8Array
Convert the readable key to entropy value
Parameters
- key: string[]
- Optional encoded: boolean
Returns Uint8Array
- Defined in key/core/interfaces.ts:24

toEntropyAsync

toEntropyAsync(key, encoded?): Promise<Uint8Array>
Convert the readable key to entropy value async
Parameters
- key: string[]
- Optional encoded: boolean
Returns Promise<Uint8Array>
- Defined in key/core/interfaces.ts:30

toKey

toKey(entropy, encode?): string[]
Convert the entropy value to readable key
Parameters
- entropy: Hex
- Optional encode: boolean
  
  to encode each word of key
Returns string[]
- Defined in key/core/interfaces.ts:37

toKeyAsync

toKeyAsync(entropy, encode?): Promise<string[]>
Convert the entropy value to readable key async
Parameters
- entropy: Hex
- Optional encode: boolean
  
  to encode each word of key
Returns Promise<string[]>
- Defined in key/core/interfaces.ts:44

toSeed

toSeed(entropy, password?): string
Convert the entropy of key to heximal seed
Parameters
- entropy: Uint8Array
- Optional password: string
  
  optional password to protect seed key
Returns string
- Defined in key/core/interfaces.ts:60

toSeedArray

toSeedArray(entropy, password?): Uint8Array
Convert the entropy of key to Uint8Array array seed
Parameters
- entropy: Uint8Array
- Optional password: string
  
  optional password to protect seed key
Returns Uint8Array
- Defined in key/core/interfaces.ts:74

toSeedArrayAsync

toSeedArrayAsync(entropy, password?): Promise<Uint8Array>
Convert the entropy of key to Uint8Array array seed async
Parameters
- entropy: Uint8Array
- Optional password: string
  
  optional password to protect seed key
Returns Promise<Uint8Array>
- Defined in key/core/interfaces.ts:81

toSeedAsync

toSeedAsync(entropy, password?): Promise<string>
Convert the entropy of key to heximal seed async
Parameters
- entropy: Uint8Array
- Optional password: string
  
  optional password to protect seed key
Returns Promise<string>
- Defined in key/core/interfaces.ts:67

validate

validate(key, encoded?): boolean
Validate the given key
Parameters
- key: string[]
- Optional encoded: boolean
  
  indicates that each word in key is encoded
Returns boolean
- Defined in key/core/interfaces.ts:18

Generated using TypeDoc