package octez-protocol-017-PtNairob-libs

  1. Overview
  2. Docs
Octez protocol 017-PtNairob 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

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-protocol-017-PtNairob-libs.test-helpers/Tezos_017_PtNairob_test_helpers/Liquidity_baking_machine/ValidationMachine/index.html

Module Liquidity_baking_machine.ValidationMachineSource

Sourcetype t = ConcreteMachine.t * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t state

The state of the ValidationMachine.

Sourcemodule Symbolic : sig ... end

A collections of functions to introspect the symbolic part of the ValidationMachine state.

Sourcemodule Concrete : sig ... end

A collections of functions to introspect the concrete part of the ValidationMachine state.

Sourceval build : ?invariant: (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env -> t -> bool Tezos_base.TzPervasives.tzresult Lwt.t) -> ?subsidy:xtz -> specs -> (t * Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env) Tezos_base.TzPervasives.tzresult Lwt.t

build specs asynchronously computes (1) an initial state for the ValidationMachine, and (2) the environment associated to this state.

The machine enforces the resulting state is consistent with the specs given as inputs, and raises an Assert_failure exception if it does not. It also enforces that the machines used underneath remain in sync.

One can use the optional argument subsidy to set the subsidy amount to a given value (by default, we use the same as the main chain). Additionally, the invariant optional argument can be used to verify that a given invariant holds at the end of the initialization.

Sourceval step : ?invariant: (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env -> t -> bool Tezos_base.TzPervasives.tzresult Lwt.t) -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t step -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env -> t -> t Tezos_base.TzPervasives.tzresult Lwt.t

step s env state asynchronously executes a single step s from state.

The invariant optional argument can be used to verify that a given invariant holds after each baked block.

Sourceval run : ?invariant: (Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env -> t -> bool Tezos_base.TzPervasives.tzresult Lwt.t) -> contract_id step list -> Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Contract.t env -> t -> t Tezos_base.TzPervasives.tzresult Lwt.t

run lss env state asynchronously executes a list of steps from state.

The invariant optional argument can be used to verify that a given invariant holds after each baked block.