diff --git a/docs/alpha/smart_rollups.rst b/docs/alpha/smart_rollups.rst index 9e38194a01f9997eb69c81fa931fe017e4b94406..f3f3fa60fe156fce5e53b87c78ee35d7f4e0977b 100644 --- a/docs/alpha/smart_rollups.rst +++ b/docs/alpha/smart_rollups.rst @@ -252,6 +252,8 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_alpha: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period @@ -261,8 +263,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about 10 days. diff --git a/docs/developer/proposal_testing.rst b/docs/developer/proposal_testing.rst index 62d35163f1e24b8071881120fea55d355c0eb792..dbcd1c85885516c034fad8476d3038379d3c8d98 100644 --- a/docs/developer/proposal_testing.rst +++ b/docs/developer/proposal_testing.rst @@ -16,13 +16,17 @@ To run the protocol tests you must work in a clone of the Octez repository, in w You can run the tests for any protocol whose sources are in a subdirectory of the form ``src/proto*/``. For example, you can perform the protocol tests on protocol Alpha as follows:: - dune run tezt src/proto_alpha/lib_protocol/test + dune runtest src/proto_alpha/lib_protocol/test -You can execute only tests located in a particular subfolder, for example consensus-related tests:: +You can execute only tests located in a particular subfolder, for example consensus-related tests this way:: + + dune runtest src/proto_alpha/lib_protocol/test/integration/consensus + +or using ``dune exec``:: dune exec src/proto_alpha/lib_protocol/test/integration/consensus/main.exe -And you may further select tests by providing option such as:: +In the latter form you may further select tests by providing options such as:: dune exec src/proto_alpha/lib_protocol/test/integration/consensus/main.exe -- \ --file test_aggregate.ml @@ -41,6 +45,8 @@ To see all the options available, do:: dune exec tezt/tests/main.exe -- --help +See the `Dune documentation `__ for more information on using Dune to run tests. + Running the tests within Docker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/index.rst b/docs/index.rst index 1609d2904cd2d2fec2b1cff1a40543e5afbf5939..88311df28600d691eb3727ca8415150988ea8a4d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,8 @@ Welcome to the Octez and Protocol Documentation! ================================================ This documentation describes an implementation of the `Tezos blockchain `__ consisting of the **Octez toolsuite** and the **Tezos protocol**, for technical users of various kinds, including Tezos application developers, bakers, and Octez/protocol developers. -Enjoy reading this website and consider using the feedback button available in any page (:ref:`more details `). +Enjoy reading this website and consider using the feedback button available in any page (:ref:`more details `) to improve it. +If you have questions about Tezos, consider using the ``Ask AI`` button available on the right side of each page (`more details `__) before reaching out to the :ref:`Tezos community `. .. note:: diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index c007874cd692c72075baa3c03187b34f9a084b9b..2db5647d9d452f0f4990eb8cbe0d7e2704c9ca7c 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -42,7 +42,7 @@ of affected parameters with their old and new values can be found Unlike other parameters, the value of parameter ``smart_rollup_max_active_outbox_levels`` remains unchanged in terms of blocks. This means that the actual duration of the maximal allowed -period of withdrawal has decreased from ~14 days in protocol Seoul to +:ref:`period of withdrawal ` has decreased from ~14 days in protocol Seoul to ~10 days in protocol Tallinn. Consensus changes diff --git a/docs/introduction/tezos.rst b/docs/introduction/tezos.rst index 269fde4d8f7d697c612c6e82957a7efcbf7086c4..e2d67898711278618353749ba8e20a02da6252b1 100644 --- a/docs/introduction/tezos.rst +++ b/docs/introduction/tezos.rst @@ -21,6 +21,7 @@ is available at https://gitlab.com/tezos/tezos. This website contains technical documentation about both Octez and the Tezos protocol. The current latest release of Octez is :doc:`../releases/version-23`. +See that page for minimal hardware requirements for running Octez in a typical setup. A beta version for :doc:`../releases/version-24` is also available. diff --git a/docs/protocols/024_tallinn.rst b/docs/protocols/024_tallinn.rst index c494160b0267635d3c85394142af875dab472d6d..52159e177f0dfd6f023cc76dba9a6cf920665830 100644 --- a/docs/protocols/024_tallinn.rst +++ b/docs/protocols/024_tallinn.rst @@ -222,7 +222,7 @@ protocol. For example, the challenge window is still two weeks. Note that the ``smart_rollup_max_active_outbox_levels`` has not been updated, because the current storage implementation of the executed outbox message in the Layer 1 does not allow for a safe update. As a -consequence, the maximal allowed period for withdrawal of assets from +consequence, the maximal allowed :ref:`period for withdrawal ` of assets from smart rollups to Layer 1 has been reduced from ~14 days to ~10 days. diff --git a/docs/releases/version-18.rst b/docs/releases/version-18.rst index d91309997a0e53d445242ac2c6155396e666c336..b9df65d546097779f052ba59b2d71093f102b2d4 100644 --- a/docs/releases/version-18.rst +++ b/docs/releases/version-18.rst @@ -82,7 +82,7 @@ You can also install Octez using Opam by running ``opam install octez``. - :package-api:`octez-libs `: Contains the base libraries for Octez. - :package-api:`octez-shell `: Contains the Octez shell related libraries. - :package-api:`octez-proto-shell `: Contains the Tezos protocol dependent libraries. - - :package-api:`octez-l2-libs `: Contains the layer 2 related libraries. + - :package-api:`octez-l2-libs `: Contains the Layer 2 related libraries. - For each protocol ``P`` - :package-api:`octez-protocol-P-libs `: The protocol ``P`` dependent libraries. - ``tezos-protocol-P``: The Tezos protocol ``P`` itself. diff --git a/docs/seoul/smart_rollups.rst b/docs/seoul/smart_rollups.rst index 7c7c4516f4bf31e92eec68b935741872e34b1720..92c8cc4a271c51f4b75880f9c731778467c4de3a 100644 --- a/docs/seoul/smart_rollups.rst +++ b/docs/seoul/smart_rollups.rst @@ -254,6 +254,9 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_seoul: +.. _withdrawal_period: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period @@ -263,8 +266,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about two weeks. diff --git a/docs/tallinn/smart_rollups.rst b/docs/tallinn/smart_rollups.rst index 6c08f4f097ecf2408e388447aa4366aa0ff16291..bae64a12b403e8bd8108e0e0d581d6863600a735 100644 --- a/docs/tallinn/smart_rollups.rst +++ b/docs/tallinn/smart_rollups.rst @@ -252,6 +252,8 @@ There is no need to synchronize between operators: if two honest operators publish the same commitment for a given commitment period, the commitment will be published with two stakes on it. +.. _withdrawal_period_tallinn: + A commitment is optimistically trusted but it can be refuted until it is said to be **cemented** (i.e., final, unchangeable). Indeed, right after a commitment is published, a two-week refutation period @@ -261,8 +263,8 @@ concurrent commitment for the same commitment period to force the removal of the invalid commitment. If no one posts such a concurrent commitment during the refutation period, the commitment can be cemented with a dedicated operation injected in Layer 1, and the -outbox messages can be executed by the Layer 1 by an explicit Layer 1 -operation (see :doc:`../shell/smart_rollup_node`), typically +outbox messages can be executed by an explicit Layer 1 +operation (see :ref:`triggering_execution_outbox_message`), typically to transfer assets from the rollup to the Layer 1. Note that such withdrawals are possible during a limited time after cementation, given by the protocol constant ``smart_rollup_max_active_outbox_levels``, which currently corresponds to about 10 days.