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

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

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

Module Liquidity_baking_machine.SymbolicMachineSource

The state of the SymbolicMachine.

Sourceval get_xtz_balance : contract_id -> t -> xtz

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

Sourceval get_tzbtc_balance : contract_id -> contract_id env -> t -> tzbtc

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 : contract_id -> contract_id env -> t -> liquidity

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 : contract_id env -> t -> liquidity

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

Sourceval predict_required_tzbtc_deposit : xtz -> contract_id env -> t -> tzbtc

predict_required_tzbtc_deposit xtz_deposit env state predicts the deposit in TzBTC which will be required by the CPMM contract when executing a step AddLiquidity with xtz_deposit from state.

Sourceval build : ?invariant:(contract_id env -> t -> bool) -> ?subsidy:xtz -> specs -> t * contract_id env

build specs computes (1) an initial state for the SymbolicMachine, 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.

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:(contract_id env -> t -> bool) -> contract_id step -> contract_id env -> t -> t

step s env state 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:(contract_id env -> t -> bool) -> contract_id step list -> contract_id env -> t -> t

run steps env state 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.