package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053
doc/octez-shell-libs.client-base/Tezos_client_base/Client_context/index.html
Module Tezos_client_base.Client_context
Source
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
printer
is a class for objects that provide output functions to display information to the end-user.
prompter
is a class of objects that provide input functions to request data from the end-user, whether normal inputs or passwords.
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.
User experience options.
A comprehensive class type gathering the above class types, that is used for #Protocol_client_context.full.
A simple printer can be used to implement a printer as it is done in class Client_context_unix.unix_logger
.