Skip to content

Mnemonic Class v1.0 Spec

Gabriel Cardona edited this page Jun 18, 2018 · 1 revision

Mnemonic

generate

Arguments

  1. bits: Number optional. Default: 128
  2. wordlist: Array optional

Return Value

  1. mnemonic: String

fromEntropy

Arguments

  1. bytes: Buffer
  2. wordlist: Array optional

Return Value

  1. mnemonic: String

toEntropy

Arguments

  1. mnemonic: String

Return Value

  1. entropy: Buffer

validate

Arguments

  1. mnemonic: String
  2. wordlist: Array

Return Value

  1. isValid: String

toSeed

Arguments

  1. mnemonic: String
  2. password: String. Default: ''

Return Value

  1. seed: Buffer

wordLists

Arguments

  • None

Return Value

  1. wordlists: Object

toKeypairs

Arguments

  1. mnemonic: String
  2. numberOfKeypairs: Number. Default: 1

Return Value

  1. keypairs: Array

findNearestWord

Arguments

  1. word: String
  2. wordlist: Array

Return Value

  1. nearestWord: String