Class Keychain

A blockchain keychain for elliptic curve-based platforms implements: BIP32, BIP39, BIP44

Hierarchy

Keychain

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Keychain(): Keychain

- Defined in src/blockchain/keychain.ts:16
Returns Keychain

Properties

mnemonic

mnemonic: Buffer | undefined

secret

secret: string | undefined

seed

seed: Buffer | undefined

Methods

generateChildKey

generateChildKey(platform: PlatformType, derivationPath: string): Key

- Defined in src/blockchain/keychain.ts:27
generates a new child key for a chain along a derivation vector

Parameters
- platform: PlatformType
- derivationPath: string
Returns Key

Private generateMasterKey

generateMasterKey(platform: PlatformType): Key

- Defined in src/blockchain/keychain.ts:126
generates a bip32 compliant master key

Parameters
- platform: PlatformType
Returns Key

generateMnemonic

generateMnemonic(strength?: number): Buffer

- Defined in src/blockchain/keychain.ts:50
generates a bip39 mnemonic for the key

Parameters
- Default value strength: number = 256
Returns Buffer

generateSeed

generateSeed(secret?: string): Buffer

- Defined in src/blockchain/keychain.ts:60
generates a bip39 compliant seed

Parameters
- Default value secret: string = ""
Returns Buffer

importMnemonic

importMnemonic(mnemonic: string): void

- Defined in src/blockchain/keychain.ts:72
imports a mnemonic into the key

Parameters
- mnemonic: string
Returns void

importSeed

importSeed(seed: string): void

- Defined in src/blockchain/keychain.ts:78
Parameters
- seed: string
Returns void

Private newChildKey

newChildKey(platform: PlatformType, parentKey: Key, childIdx: number): Key

- Defined in src/blockchain/keychain.ts:86
generates a new child key along a childIdx

Parameters
- platform: PlatformType
- parentKey: Key
- childIdx: number
Returns Key

Generated using TypeDoc