package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install

Dune Dependency

Authors

Maintainers

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-shell-libs.client-base/Tezos_client_base/Client_context/index.html

Module Tezos_client_base.Client_contextSource

This module contains several class types used to provide I/O services for the client, the wallet, etc.

This interface is independent of the backend. This is intended for the client library code, so it can be independent of the backend. The client, and each other client-like systems (wallet apps, in-browser widgets, etc.), are responsible for providing a backend-specific implementation.

To find examples on how these methods are called, you can have a look at

  • src/bin_client/client_protocols_commands.ml
  • src/lib_client_base/client_aliases.ml
  • src/lib_client_base_unix/client_context_unix.ml
Sourcetype ('a, 'b) lwt_format = ('a, Format.formatter, unit, 'b Lwt.t) format4
Sourceclass type printer = object ... end

printer is a class for objects that provide output functions to display information to the end-user.

Sourceclass type prompter = object ... end

prompter is a class of objects that provide input functions to request data from the end-user, whether normal inputs or passwords.

Sourceclass type io = object ... end
Sourceclass type wallet = object ... end

Operations on the wallet.

Sourceclass type chain = object ... end

Accessor on the chain.

Sourceclass type block = object ... end

Operations on blocks.

Sourceclass type io_wallet = object ... end

Primitives for input, output and wallet. The general organisation of the code in this module is to provide small classes that are also combined into bigger classes. It allows different client library functions to only depend on some features, but not all, so that these functions can be used in places that only have access to these features.

Sourceclass type io_rpcs = object ... end

Primitives for input, output and RPCs.

Sourceclass type ui = object ... end

User interface related operations.

Sourceclass type ux_options = object ... end

User experience options.

Sourceclass type full = object ... end

A comprehensive class type gathering the above class types, that is used for #Protocol_client_context.full.

Sourceclass simple_printer : (string -> string -> unit Lwt.t) -> printer

A simple printer can be used to implement a printer as it is done in class Client_context_unix.unix_logger.

Sourceval null_printer : printer
OCaml

Innovation. Community. Security.