package octez-protocol-alpha-libs

  1. Overview
  2. Docs
Octez protocol alpha 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-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Liquidity_baking_machine/ConcreteMachine/index.html

Module Liquidity_baking_machine.ConcreteMachineSource

A machine that can execute scenarios onchain.

Sourcetype t = Block.t

The state of the ConcreteMachine.

Sourceval get_xtz_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> t -> xtz Tezos_base.TzPervasives.tzresult Lwt.t

get_xtz_balance c state returns the amount of mutez owned by c in state.

Sourceval get_tzbtc_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t env -> t -> tzbtc Tezos_base.TzPervasives.tzresult Lwt.t

get_tzbtc_balance c env state returns the amount of TzBTC owned by c in state, according to the TzBTC contract.

Sourceval get_liquidity_balance : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t env -> t -> liquidity Tezos_base.TzPervasives.tzresult Lwt.t

get_liquidity_balance c env state returns the amount of liquidity token owned by c in state, according to the Liquidity contract.

Sourceval get_cpmm_total_liquidity : Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t env -> t -> liquidity Tezos_base.TzPervasives.tzresult Lwt.t

get_cpmm_total_liquidity env state fetches the current amount of liquidity tokens distributed by the CPMM contract from the state state.

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

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

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_alpha.Protocol.Alpha_context.Contract.t env -> t -> bool Tezos_base.TzPervasives.tzresult Lwt.t) -> Tezos_protocol_alpha.Protocol.Alpha_context.Contract.t step -> Tezos_protocol_alpha.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_alpha.Protocol.Alpha_context.Contract.t env -> t -> bool Tezos_base.TzPervasives.tzresult Lwt.t) -> contract_id step list -> Tezos_protocol_alpha.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.