package octez-shell-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez shell libraries

Install

dune-project

Dependency

sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4

sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

Sourcetype t

Abstract type of a mnemonic

Sourceval pp : Format.formatter -> t -> unit

Sourceval show : t -> string

Sourceval index_of_word : string -> int option

find_index word is Some i where is is the index of word in the BIP39 word list, or None if no such word is in the list.

Sourceval of_indices : int list -> t option

of_indices idxs is Some mnemonic if indices are all in range 0-2047 or None otherwise.

Sourceval to_indices : t -> int list

to_indices t is the list of indices corresponding to t.

Sourceval of_words : string list -> t option

of_words words is Some mnemonic if words is a list containing a valids number of valid english words.

Sourceval to_words : t -> string list

to_words mnemonic is the list of words corresponding to mnemonic.

Sourceval of_entropy : Tezos_base.TzPervasives.Bytes.t -> t

of_entropy bytes is the mnemonic derived from bytes.

raises Invalid_argument
is List.length bytes is not in 16, 20, 24, 28, 32 .

val to_seed : 
  ?passphrase:Tezos_base.TzPervasives.Bytes.t ->
  t ->
  Tezos_base.TzPervasives.Bytes.t

to_seed ?passphrase mnemonic is 64 bytes derived from a BIP39 mnemonic mnemonic, using the optional passphrase passphrase if provided.