Packages

package mnemonic

A mnemonic represents a set of random entropy that can be used to derive a private key or other type of value. This implementation follows a combination of BIP-0039 and SLIP-0023. https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki https://github.com/satoshilabs/slips/blob/master/slip-0023.md

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. mnemonic
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait DeriveFailure extends AnyRef
  2. type Entropy = Type
  3. case class EntropyFailure(failure: ValidationFailure) extends DeriveFailure with Product with Serializable
  4. trait FromEntropy[T] extends Serializable
    Annotations
    @implicitNotFound()
  5. sealed abstract class Language extends AnyRef

    Represents a set of 2048 words that can be used to create a mnemonic.

  6. sealed abstract class MnemonicSize extends AnyRef

    Mnemonic size is an enum with additional parameters for calculating checksum and entropy lengths.

  7. type Phrase = Type
  8. case class PhraseFailure(failure: ValidationFailure) extends DeriveFailure with Product with Serializable
  9. case class WordListFailure(failure: ValidationFailure) extends DeriveFailure with Product with Serializable

Value Members

  1. def derive[T](uuid: UUID)(implicit arg0: FromEntropy[T]): T
  2. def derive[T](entropy: Array[Byte], size: MnemonicSize)(implicit arg0: FromEntropy[T]): Either[DeriveFailure, T]
  3. def derive[T](mnemonic: String, size: MnemonicSize, language: Language)(implicit arg0: FromEntropy[T]): Either[DeriveFailure, T]

    Derives a value T from the set of entropy underlying the given mnemonic.

    Derives a value T from the set of entropy underlying the given mnemonic.

    T

    the value to create from the generated entropy

    mnemonic

    a mnemonic phrase containing a set of words separated by white-space

    size

    the expected size of the mnemonic

    language

    the language that the words in the phrase come from

    returns

    either a DeriveFailure if a failure occurred or a value T

  4. object Entropy
  5. object FromEntropy extends Serializable
  6. object Language
  7. object MnemonicSize
  8. object Phrase

Inherited from AnyRef

Inherited from Any

Ungrouped