Class HDKey

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

Properties

keypair

Methods

generateMnemonic getAccountSigner

Properties

Readonly keypair

keypair: SignKeyPair

Methods

Static generateMnemonic

  • generateMnemonic(strength?): string

  • Generates a mnemonic

    Parameters

    • strength: number = 256

      Length in bits of the generated mnemonic

    Returns string

    Generated BIP-0039 Mnemonic

Static getAccountSigner

  • getAccountSigner(mnemonic, index?, passphrase?): Promise<SignKeyPair>

  • Generates the keypair matching the supplied parameters

    Parameters

    • mnemonic: string

      BIP-0039 Mnemonic

    • index: number = 0

      Account index

    • Optional passphrase: string

      Optional BIP-0039 passphrase

    Returns Promise<SignKeyPair>

    SignKeyPair for these parameters

Settings

Member Visibility

Theme

On This Page

keypairgenerateMnemonicgetAccountSigner