package octez-protocol-alpha-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Liquidity_baking_machine/SymbolicMachine/index.html
Module Liquidity_baking_machine.SymbolicMachineSource
The state of the SymbolicMachine.
get_xtz_balance c state returns the amount of mutez owned by c in state.
get_tzbtc_balance c env state returns the amount of TzBTC owned by c in state, according to the TzBTC contract.
get_liquidity_balance c env state returns the amount of liquidity token owned by c in state, according to the Liquidity contract.
get_cpmm_total_liquidity env state fetches the current amount of liquidity tokens distributed by the CPMM contract from the state state.
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.
val build :
?invariant:(contract_id env -> t -> bool) ->
?subsidy:xtz ->
specs ->
t * contract_id envbuild 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.
val step :
?invariant:(contract_id env -> t -> bool) ->
contract_id step ->
contract_id env ->
t ->
tstep 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.
val run :
?invariant:(contract_id env -> t -> bool) ->
contract_id step list ->
contract_id env ->
t ->
trun 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.