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=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e

sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

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.