package octez-shell-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13
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
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.