Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace bip39

Variables

Functions

Variables

Const wordlists

wordlists: object

Type declaration

  • [index: string]: string[]

Functions

entropyToMnemonic

  • entropyToMnemonic(entropy: Buffer | string, wordlist?: string[]): string

  • Parameters

    • entropy: Buffer | string
    • Optional wordlist: string[]

    Returns string

generateMnemonic

  • generateMnemonic(strength?: number, rng?: function, wordlist?: string[]): string

  • Parameters

    • Optional strength: number
    • Optional rng: function
        • (size: number): Buffer

        • Parameters

          • size: number

          Returns Buffer

    • Optional wordlist: string[]

    Returns string

getDefaultWordlist

  • getDefaultWordlist(): string

  • Returns string

mnemonicToEntropy

  • mnemonicToEntropy(mnemonic: string, wordlist?: string[]): string

  • Parameters

    • mnemonic: string
    • Optional wordlist: string[]

    Returns string

mnemonicToSeed

  • mnemonicToSeed(mnemonic: string, password?: string): Promise<Buffer>

  • Parameters

    • mnemonic: string
    • Optional password: string

    Returns Promise<Buffer>

mnemonicToSeedSync

  • mnemonicToSeedSync(mnemonic: string, password?: string): Buffer

  • Parameters

    • mnemonic: string
    • Optional password: string

    Returns Buffer

setDefaultWordlist

  • setDefaultWordlist(language: string): void

  • Parameters

    • language: string

    Returns void

validateMnemonic

  • validateMnemonic(mnemonic: string, wordlist?: string[]): boolean

  • Parameters

    • mnemonic: string
    • Optional wordlist: string[]

    Returns boolean

Generated using TypeDoc