diff --git a/docs/user/client-configuration.rst b/docs/user/client-configuration.rst index 07b8dcb6d5384d2c452288f693eab3cc0be6b2e5..0db1eee5340d8a1bdb4eb571e6212e46eb05375b 100644 --- a/docs/user/client-configuration.rst +++ b/docs/user/client-configuration.rst @@ -5,7 +5,7 @@ The Octez client can be configured in flexible ways to control various aspects of its behavior, such as running in different running modes (:doc:`./sandbox`, :doc:`./mockup`, ...), connecting to a public Tezos node, selecting the directory for storing data, and so on. All these aspects -can be customized by supplying **options** on the command line when running the client. Refer to :ref`the client manual ` for details. +can be customized by supplying **options** on the command line when running the client. Refer to :ref:`the client manual ` for details. A subset of these aspects can be customized by specifying parameters in a **configuration file** for the client. These include, for example: diff --git a/docs/user/sandbox.rst b/docs/user/sandbox.rst index 49b14d8f8baeb825efd8b58c6a134af5caec310c..679581e09ff2008b9dbe1e83512f4b3c7d634ae1 100644 --- a/docs/user/sandbox.rst +++ b/docs/user/sandbox.rst @@ -73,11 +73,15 @@ For instance: :: $ octez-client rpc get /chains/main/blocks/head/metadata - "next_protocol": "Ps9mPmXaRzmzk35gbAYNCAw6UXdE2qoABTHbN2oEEc1qM7CwT9P" + { "protocol": "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i", + "next_protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im", + ... } $ octez-activate-alpha Injected BMV9KnSPE1yw $ octez-client rpc get /chains/main/blocks/head/metadata - "protocol": "Ps9mPmXaRzmzk35gbAYNCAw6UXdE2qoABTHbN2oEEc1qM7CwT9P" + { "protocol": "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im", + "next_protocol": "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK", + ... } We now have the possibility to send transactions to the sandboxed network. As the genesis block used to initialize the sandboxed network differs from the @@ -121,6 +125,26 @@ Note that the ``bake for`` command of the client is exclusively for testing purposes, all baking should be done using the ``octez-baker`` binary. +We can now observe the transaction with: + +:: + + $ octez-client rpc get /chains/main/blocks/head + { "protocol": "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK", + ... + "header": + { "level": 2, + ... }, + "operations": + [ ... + [ { ... + "contents": + [ { "kind": "transaction", + "source": "tz1KqTpEZ7Yob7QbPE4Hy4Wo8fHG8LhKxZSx", + "fee": "268", "counter": "2", "gas_limit": "169", + "storage_limit": "0", "amount": "42000000", + "destination": "tz1gjaF81ZRRvdzjobyfVNsAeSC6PScjfQwN", + ... } ] } ] ] Tune protocol Alpha parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tezt/lib_cloud/README.md b/tezt/lib_cloud/README.md index 558e698eda3f0c546e235f1f23f8fa4430cdbdbf..572409f15873aee41a2b3d9b2a2ff5027b35720e 100644 --- a/tezt/lib_cloud/README.md +++ b/tezt/lib_cloud/README.md @@ -86,7 +86,7 @@ will run a docker image. This docker image must follow some conditions use your own dockerfile. To help you write such an image, a default one based on debian is -provided in `tezt/lib_cloud/debian.Dockerfile`. +provided in `tezt/lib_cloud/dockerfiles/debian.Dockerfile`. The library takes care for you to push this image on a dedicated GCP registry. A docker image such as the one generated from @@ -98,7 +98,7 @@ Finally, do note that with Tezt cloud you can specify for each VM individually the docker image to be used. The one provided by the dockerfile as discussed above will be the one by default. It is also possible to use docker images published by the Octez CI. At the -moment, the docker image from the latest released of Octez is +moment, the docker image from the latest release of Octez is supported. ## Write your own dockerfile @@ -271,7 +271,7 @@ Grafana can be used to visualize prometheus metrics (activated by default). This can be accessed on `http://localhost:3000`. Tezt cloud comes with a set of dashboards so that it is ready to use. Feel free to update/add new dashboards in -`tezt/lib_cloud/grafana/dasboards.json`. +`tezt/lib_cloud/grafana/dashboards`. ## Proxy mode @@ -361,7 +361,7 @@ You should see the name servers you just added. 3. The runner that will be used (this can be given to the agent). 3. Whenever it is possible, write your test without depending - specifically on a fixed number of machines. Whenver you want to + specifically on a fixed number of machines. Whenever you want to increase or decrease the number of machines, you can just run your test again and it will just work. This can be done by using a dispenser (via the OCaml module `Seq` for example).