package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.0.tar.gz
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-shell-libs.shell-services/Tezos_shell_services/Injection_services/index.html

Module Tezos_shell_services.Injection_servicesSource

Sourcetype Tezos_base.TzPervasives.Error_monad.error +=
  1. | Injection_operations_error

While injecting several operations (see private_operations), if one injection failed, we have to report the error. To avoid using recursive errors we do the reporting as follows:

  • We wrap the error into Injection_operations_error
  • If injecting the operation oph succeeded we use Injection_operation_succeed_case oph
  • If injecting the operation oph failed with err, we use Injection_operation_error_case oph followed by err.
Sourcetype Tezos_base.TzPervasives.Error_monad.error +=
  1. | Injection_operation_succeed_case of Tezos_base.TzPervasives.Operation_hash.t
Sourcetype Tezos_base.TzPervasives.Error_monad.error +=
  1. | Injection_operation_error_case of Tezos_base.TzPervasives.Operation_hash.t
Sourceval block : Tezos_rpc.Context.simple -> ?async:bool -> ?force:bool -> ?chain:Chain_services.chain -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.Operation.t list list -> Tezos_base.TzPervasives.Block_hash.t Tezos_base.TzPervasives.tzresult Lwt.t

block cctxt ?async ?force raw_block tries to inject raw_block inside the node. If ?async is true, raw_block will be validated before the result is returned. If ?force is true, the block will be injected even on non strictly increasing fitness.

Sourceval operation : Tezos_rpc.Context.simple -> ?async:bool -> ?chain:Chain_services.chain -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.TzPervasives.Operation_hash.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval private_operation : Tezos_rpc.Context.simple -> ?async:bool -> ?chain:Chain_services.chain -> Tezos_base.TzPervasives.Bytes.t -> Tezos_base.TzPervasives.Operation_hash.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourceval private_operations : Tezos_rpc.Context.simple -> ?async:bool -> ?force:bool -> ?chain:Chain_services.chain -> Tezos_base.TzPervasives.Bytes.t list -> Tezos_base.TzPervasives.Operation_hash.t list Tezos_base.TzPervasives.tzresult Lwt.t

private_operations injects multiple operations. The private_ prefix is because the service is bound to the /private/ path-prefix which is intended for tests only. See the ~description argument in the definition in the ml file for more information.

Sourceval protocol : Tezos_rpc.Context.simple -> ?async:bool -> Tezos_base.Protocol.t -> Tezos_base.TzPervasives.Protocol_hash.t Tezos_base.TzPervasives.tzresult Lwt.t
Sourcemodule S : sig ... end