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=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

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.