package octez-protocol-017-PtNairob-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13
doc/octez-protocol-017-PtNairob-libs.test-helpers/Tezos_017_PtNairob_test_helpers/Liquidity_baking_machine/SymbolicMachine/index.html
Module Liquidity_baking_machine.SymbolicMachine
Source
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 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.
val 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.
val 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.