package tezos-protocol-alpha

  1. Overview
  2. Docs
package tezos-protocol-alpha
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ('a, 'trace) t

This monad combines:

  • a state monad where the state is the context
  • two levels of error monad to distinguish gas exhaustion from other errors

It is useful for backtracking on type checking errors without backtracking the consumed gas.

type ('a, 'trace) gas_monad = ('a, 'trace) t

Alias of ('a, 'trace) t to avoid confusion when the module is open

val return : 'a -> ('a, 'trace) t

return x returns a value in the gas-monad.

val map : ('a -> 'b) -> ('a, 'trace) t -> ('b, 'trace) t

map f m maps over successful results of m using f.

val bind : ('a, 'trace) t -> ('a -> ('b, 'trace) t) -> ('b, 'trace) t

bind m f binds successful results of m and feeds it to f.

val bind_recover : ('a, 'trace) t -> (('a, 'trace) Tezos_protocol_environment_alpha.Pervasives.result -> ('b, 'trace') t) -> ('b, 'trace') t

bind_recover m f binds the result of m and feeds it to f. It's another variant of bind that allows recovery from inner errors.

val of_result : ('a, 'trace) Tezos_protocol_environment_alpha.Pervasives.result -> ('a, 'trace) t

of_result r is a gas-free embedding of the result r into the gas monad.

val consume_gas : Alpha_context.Gas.cost -> (unit, 'trace) t

consume_gas c consumes c amounts of gas. It's a wrapper around Gas.consume. If that fails, the whole computation within the gas-monad returns an error. See the Alpha_context.Gasmodule for details.

run ctxt m runs m using the given context and returns the result along with the new context with updated gas. The given context has unlimited mode enabled, through Gas.set_unlimited, no gas is consumed.

val record_trace_eval : error_details:('error_context, 'error_trace) Script_tc_errors.error_details -> ('error_context -> Tezos_protocol_environment_alpha.Error_monad.error) -> ('a, 'error_trace) t -> ('a, 'error_trace) t

record_trace_level ~error_details f m returns a new gas-monad value that when run, records trace levels using f. This function has no effect in the case of a gas-exhaustion error or if error_details is Fast.

val fail : 'trace -> ('a, 'trace) t

fail e is return (Error e) .

module Syntax : sig ... end

Syntax module for the Gas_monad. This is intended to be opened locally in functions. Within the scope of this module, the code can include binding operators, leading to a let-style syntax. Similar to Lwt_result_syntax and other syntax modules.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct