Flexible Network Sandboxes¶
There are testing-only
0.0.2), make sure you have done
When running (semi-)interactive tests, it is recommended to wrap the
One can run a mini-network advancing fast with accusers, bakers, and endorsers:
rlwrap ./tezos-sandbox mini-network \ --root-path /tmp/zz-mininet-test \ --tezos-node-binary ./tezos-node \ --tezos-baker-alpha-binary ./tezos-baker-alpha \ --tezos-endorser-alpha-binary ./tezos-endorser-alpha \ --tezos-accuser-alpha-binary ./tezos-accuser-alpha \ --tezos-client-binary ./tezos-client
Once the network is started this test scenario becomes interactive:
Flextesa.mininet: Please enter command:
help) to see the available commands.
Double Endorsement Accusation¶
There are 3 “accusation scenarios” so far, see
./tezos-sandbox accusation --help. For instance, the following command
starts a small 3-node network, forces one baker to endorse two
concurrent branches, and then makes another baker inject (and bake) the
double-endorsement-evidence operation. The option
tezos-sandbox to start allocating P2P/RPC ports from 20 000 and
tezos-sandbox to enter an interactive
command prompt at the end of the test to give a chance to explore the
sandbox before killing all the nodes.
rlwrap ./tezos-sandbox accusations simple-double-endorsing \ --root $PWD/double-endorsing-test \ --base-port=20_000 \ --pause-at-end=true
This test among other ones can generate configuration files for Kiln to run alongside the Ꜩ-sandbox, for instance:
Voting With a Ledger Nano Device¶
The voting test tries to do a full round of voting and protocol switch,
including baking on the test-chain, see documentation in
./tezos-sandbox voting --help.
The test can run in a simpler-to-setup, or “degraded,” mode of operation
(cf. call in
./src/bin_flextesa/dune for the version which
run in Gitlab-CI pipelines). In this example, we run instead a full test
with a Ledger Nano device as one of the bakers/voters. The test automatically
becomes interactive because the user has to press buttons on the
device, including for changing between apps.
To make the test work, you need to provide it with a
which knows about the protocol which is tested and then wins the voting
One example is this branch:
which allows one to build an Apr2019-Zeronet-like code base with an extra
protocol, lets assume this is built at path
Also, get an URI for your ledger (the test requires both the Wallet and Baking apps):
tezos-client list connected ledgers
And use the URI (no need to import it) for the
rlwrap ./tezos-sandbox voting \ $zeronet_042/src/proto_042_Pt1GS1Zi/lib_protocol/src \ ./src/bin_client/test/proto_test_injection/ \ --with-ledger "ledger://crouching-tiger-hidden-dragon/ed25519/0'/0'" \ --serialize-proposals \ --base-port=20_000 \ --current-node-binary $zeronet_042/tezos-node \ --current-client-binary $zeronet_042/tezos-client \ --winner-client-binary $zeronet_042/tezos-client \ --current-admin-client-binary $zeronet_042/tezos-admin-client \ --pause-on-error=true
- The first path argument has to be the path to a valid protocol which
can be switched to from the current (
- The second protocol, the looser, only needs to be valid for the protocol compilation.
- The option
--serialize-proposalstells the test to call
tezos-client submit proposals for ...one proposal at a time which is the only method the ledger Baking app can really understand.
*-binaryoptions allow to set the paths to the executables for the different protocols:
The test becomes interactive and guides you through the interactions with the ledger, e.g.:
Flextesa.voting: Ledger-prompt Setting up "ledger://crouching-tiger-hidden-dragon/ed25519/0'/0'" for baking. The ledger should be showing the setup parameters (Address, Main chain, HWMs). Please hit “✔” on the ledger.
Running_processes is very high-level (actually agnostic to Dune).
Most processes are actually calls to
sh -c <script> where
<script> is the result of a
Genspio compilation, this leaves the
option to later easily run some processes over SSH (without OCaml
dependencies on the destination host) or in special containers (e.g.
docker run --cpu-shares ...).
The prompt commands for interactive use use
(because already a dependency, and we need a good string literal parser
so we cannot use
Special Coding Style¶
A fresh “just for testing project” is a good occasion to experiment a bit …
EF: we try to use combinators on top of Easy-format for most pretty-printing (it is still compatible with
Formatbut it is much more functional/composable and does not rely on
- Many standard modules are taken from Jane St Base (already a dependency of Dune): List, String, Option, Int, Float.
- Error monad uses more typed errors (polymorphic variants),
Asynchronous_result(and note that
Lwt_unix.auto_yield 0.005 ()).
- All state is kept in a (non-global) value passed as argument
everywhere needed. To simplify the dependency management the state
variables are objects (cf.
Also, everything uses OCamlFormat instead of