package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-shell-libs.client-base-unix/Tezos_client_base_unix/Client_context_unix/class-unix_wallet/index.html

Class Client_context_unix.unix_walletSource

method load_passwords : string Lwt_stream.t option
method read_file : string -> string Tezos_base.TzPervasives.tzresult Lwt.t

read_file path reads the content of the file given by path. Note that the whole content of the file is loaded into memory: you shouldn't read big files using this method. Errors that may be returned are implementation-dependent.

method with_lock : (unit -> 'a Lwt.t) -> 'a Lwt.t

with_lock f calls f () exclusively from any other function that is wrapped within with_lock.

method load : string -> default:'a -> 'a Tezos_base.TzPervasives.Data_encoding.encoding -> 'a Tezos_base.TzPervasives.tzresult Lwt.t

load alias ~default enc reads the file corresponding to the alias, and parses using encoding. If the file does not exist, then default is returned.

method write : string -> 'a -> 'a Tezos_base.TzPervasives.Data_encoding.encoding -> unit Tezos_base.TzPervasives.tzresult Lwt.t

write alias x encoding writes in a file corresponding to the alias the information given by x using the encoding.

method last_modification_time : string -> float option Tezos_base.TzPervasives.tzresult Lwt.t

last_modification_time alias returns the last modification time of the file corresponding to the alias, if the file exists; otherwise None.

method get_base_dir : string

Current base directory. Stores the information of keys (public key hashes, public keys, secret keys) and watermarks.

OCaml

Innovation. Community. Security.