Class HDKey

HDKey handles hierarchical key generation according to ADR 0008 https://github.com/oasisprotocol/adrs/blob/main/0008-standard-account-key-generation.md

Index

Properties

Methods

generateMnemonic getAccountSigner

Properties

`Readonly`keypair

keypair: SignKeyPair

Methods

`Static`generateMnemonic

generateMnemonic(strength?: number): string
Generates a mnemonic
Parameters
- strength: number = 256
  Length in bits of the generated mnemonic
Returns string
Generated BIP-0039 Mnemonic
- Defined in core/src/hdkey.ts:44

`Static`getAccountSigner

getAccountSigner(
    mnemonic: string,
    index?: number,
    passphrase?: string,
): Promise<SignKeyPair>
Generates the keypair matching the supplied parameters
Parameters
- mnemonic: string
  BIP-0039 Mnemonic
- index: number = 0
  Account index
- Optionalpassphrase: string
  Optional BIP-0039 passphrase
Returns Promise<SignKeyPair>
SignKeyPair for these parameters
- Defined in core/src/hdkey.ts:25