From d8697beac4171c8d8799e2857da09c8016420868 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 11 Jul 2025 09:58:29 +0200 Subject: [PATCH 01/10] doc: fix protocols/alpha intro --- docs/protocols/alpha.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/protocols/alpha.rst b/docs/protocols/alpha.rst index ff806f329b7b..9ebeada338ab 100644 --- a/docs/protocols/alpha.rst +++ b/docs/protocols/alpha.rst @@ -1,13 +1,15 @@ Protocol Alpha ============== -This page documents the changes brought by protocol Alpha with respect +This page lists the changes brought by protocol Alpha with respect to Seoul (see :ref:`naming_convention`). +For the list of changes brought by Seoul with respect to Rio, see :doc:`../protocols/023_seoul`. -For changes brought by Quebec with respect to Paris, see :doc:`../protocols/021_quebec`. +For a higher-level overview of the most salient new features see the +`announcement blog `__. The code can be found in directory :src:`src/proto_alpha` of the ``master`` -branch of Octez. +branch of Octez and the full documentation in :doc:`this page <../active/index>`. Environment Version ------------------- -- GitLab From 891d9fa89588ce4016ca9242a2b643f4964cf567 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 11 Jul 2025 09:58:52 +0200 Subject: [PATCH 02/10] doc: add link to blog announcing Seoul --- docs/protocols/023_seoul.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocols/023_seoul.rst b/docs/protocols/023_seoul.rst index 76fdf2a89335..81b3ce577670 100644 --- a/docs/protocols/023_seoul.rst +++ b/docs/protocols/023_seoul.rst @@ -6,7 +6,7 @@ to Rio (see :ref:`naming_convention`). For the list of changes brought by Rio with respect to Quebec, see :doc:`../protocols/022_rio`. For a higher-level overview of the most salient new features see the -`announcement blog `__. +`announcement blog `__. The code can be found in directory :src:`src/proto_023_PtSeouLo` of the ``master`` branch of Octez and the full documentation in :doc:`this page <../seoul/index>`. -- GitLab From 2c0a926d7d5e7caf5763c84348261cb7a6c9a319 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Fri, 11 Jul 2025 16:03:18 -0400 Subject: [PATCH 03/10] Thank you --- .gitlab/merge_request_templates/alcotezt.md | 4 ++-- .gitlab/merge_request_templates/debian-packages.md | 2 +- .gitlab/merge_request_templates/default.md | 2 +- .gitlab/merge_request_templates/rpm-packages.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.gitlab/merge_request_templates/alcotezt.md b/.gitlab/merge_request_templates/alcotezt.md index 6948c19febbd..f38ead4765ff 100644 --- a/.gitlab/merge_request_templates/alcotezt.md +++ b/.gitlab/merge_request_templates/alcotezt.md @@ -2,7 +2,7 @@ Template for the Alcotezt porting MRs (https://gitlab.com/tezos/tezos/-/milestones/65) --> @@ -66,7 +66,7 @@ tezt --list --file [TEST_FILE] ## In the CI As the tests are linked with `tezt/tests/main.exe`, they run in the CI -in the `tezt` jobs. The GitLab interface offers little +in the `tezt` jobs. The GitLab interface offers little to find individual test cases in the set of tezt jobs, but you can download the Tezt records from a pipeline on this MR (e.g. `[PIPELINE_ID]`) and check that they contain the test in diff --git a/.gitlab/merge_request_templates/debian-packages.md b/.gitlab/merge_request_templates/debian-packages.md index c2cabafd2545..503f21c33333 100644 --- a/.gitlab/merge_request_templates/debian-packages.md +++ b/.gitlab/merge_request_templates/debian-packages.md @@ -1,5 +1,5 @@ diff --git a/.gitlab/merge_request_templates/default.md b/.gitlab/merge_request_templates/default.md index 4bbb455f380a..807289980fe0 100644 --- a/.gitlab/merge_request_templates/default.md +++ b/.gitlab/merge_request_templates/default.md @@ -1,5 +1,5 @@ diff --git a/.gitlab/merge_request_templates/rpm-packages.md b/.gitlab/merge_request_templates/rpm-packages.md index 4a574eeffc7d..33f6f4f640fe 100644 --- a/.gitlab/merge_request_templates/rpm-packages.md +++ b/.gitlab/merge_request_templates/rpm-packages.md @@ -1,5 +1,5 @@ -- GitLab From 5de8955eedb0bcd12c5d06bd929b2fd59aec94ec Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Thu, 17 Jul 2025 14:29:23 -0400 Subject: [PATCH 04/10] doc: format commands properly --- docs/releases/version-10.rst | 4 +++- docs/releases/version-11.rst | 4 +++- docs/releases/version-12.rst | 4 +++- docs/releases/version-13.rst | 4 +++- docs/releases/version-14.rst | 4 +++- docs/releases/version-15.rst | 4 +++- docs/releases/version-16.rst | 4 +++- docs/releases/version-17.rst | 4 +++- docs/releases/version-18.rst | 4 +++- docs/releases/version-19.rst | 4 +++- docs/releases/version-20.rst | 4 +++- docs/releases/version-21.rst | 4 +++- docs/releases/version-22.rst | 4 +++- docs/releases/version-23.rst | 2 ++ docs/releases/version-7.rst | 4 +++- docs/releases/version-8.rst | 4 +++- docs/releases/version-9.rst | 4 +++- 17 files changed, 50 insertions(+), 16 deletions(-) diff --git a/docs/releases/version-10.rst b/docs/releases/version-10.rst index 36d6873b9a81..3a9593f9eb25 100644 --- a/docs/releases/version-10.rst +++ b/docs/releases/version-10.rst @@ -42,7 +42,9 @@ Version 10.3 prevents several corruptions of the store. Update Instructions ------------------- -To update from sources:: +To update from sources: + +.. code-block:: shell git fetch git checkout v10.3 diff --git a/docs/releases/version-11.rst b/docs/releases/version-11.rst index 6ab8e82755ea..ae349113164e 100644 --- a/docs/releases/version-11.rst +++ b/docs/releases/version-11.rst @@ -20,7 +20,9 @@ Version 11.1 fixes some storage issues, as well as some build issues. Update Instructions ------------------- -To update from sources:: +To update from sources: + +.. code-block:: shell git fetch git checkout v11.1 diff --git a/docs/releases/version-12.rst b/docs/releases/version-12.rst index 9118eadc839f..d4fef45536d3 100644 --- a/docs/releases/version-12.rst +++ b/docs/releases/version-12.rst @@ -35,7 +35,9 @@ Version 12.4 fixed a memory leak in the accuser and the baker. Update Instructions ------------------- -To update from sources:: +To update from sources: + +.. code-block:: shell git fetch git checkout v12.4 diff --git a/docs/releases/version-13.rst b/docs/releases/version-13.rst index 52fe05b73ff5..68d1c0726764 100644 --- a/docs/releases/version-13.rst +++ b/docs/releases/version-13.rst @@ -13,7 +13,9 @@ your vote for the liquidity baking toggle, see :ref:`the changelog `. -To update from sources:: +To update from sources: + +.. code-block:: shell git fetch git checkout v8.3 diff --git a/docs/releases/version-9.rst b/docs/releases/version-9.rst index 5a025cca7af2..7929bedb9dfd 100644 --- a/docs/releases/version-9.rst +++ b/docs/releases/version-9.rst @@ -43,7 +43,9 @@ to remove costly computations in cases where they are not needed. Update Instructions ------------------- -To update from sources:: +To update from sources: + +.. code-block:: shell git fetch git checkout v9.7 -- GitLab From 1ea1a47d26533804ce2ce45300ac7422bf226d92 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Thu, 24 Jul 2025 11:50:24 -0400 Subject: [PATCH 05/10] More infomration --- docs/user/sandbox.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/sandbox.rst b/docs/user/sandbox.rst index 679581e09ff2..27dd5439a822 100644 --- a/docs/user/sandbox.rst +++ b/docs/user/sandbox.rst @@ -31,7 +31,7 @@ to connect to. Lowering the number of expected connections removes the spurious “Too few connections” warnings. Set it to ``1`` for our two-nodes network (and you would set it to ``0`` for a single-node network). -More informations can be found in the :package-api:`api page of the octez node +More information can be found in the :package-api:`api page of the octez node config `: or by simply calling -- GitLab From d217a14308ac1065ef5abfe03a25a4124fbea212 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 30 Jul 2025 09:49:27 +0200 Subject: [PATCH 06/10] doc: turn consensus key draining into a warning --- docs/user/key-management.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/user/key-management.rst b/docs/user/key-management.rst index 069964aa6049..5babe32e5a9d 100644 --- a/docs/user/key-management.rst +++ b/docs/user/key-management.rst @@ -285,13 +285,17 @@ for example, a cloud platform providing hosted Key Management Systems (KMS) wher generated within the system and can never be downloaded by the operator. The delegate can designate such a KMS key as its consensus key. Shall they lose access to the cloud platform for any reason, they can simply switch to a new key. -However, both the delegate key and the consensus key give total control over the delegate's funds: indeed, the consensus -key may sign a ``Drain_delegate`` operation to transfer the delegate's -spendable balance to an arbitrary account. In :doc:`relevant -RPCs<../api/openapi>` like -``/chains/main/blocks/head/helpers/baking_rights``, both the -delegate's manager and consensus keys are listed. -As a consequence, the consensus key should be treated with equal care as the manager key. +.. warning:: + + However, both the delegate key and the consensus key give total control over the delegate's funds: indeed, the consensus + key may sign a ``Drain_delegate`` operation to transfer the delegate's + spendable balance to an arbitrary account. In :doc:`relevant + RPCs<../api/openapi>` like + ``/chains/main/blocks/head/helpers/baking_rights``, both the + delegate's manager and consensus keys are listed. + As a consequence, the consensus key should be treated with equal care as the manager key. + +Possible options to counter the risk of fund draining by the consensus key include: to stake all baking funds in the security deposit, and to rotate the consensus key before stopping the baking operations and unstaking the security deposit. Registering a Consensus Key ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- GitLab From 4db8fbe2f5abf3c33d9293e9cf1c3c8ac644137f Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 30 Jul 2025 16:53:46 +0200 Subject: [PATCH 07/10] doc: mention that bakers also commonly run the DAL --- docs/alpha/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/alpha/glossary.rst b/docs/alpha/glossary.rst index 40887f044105..4147b670d787 100644 --- a/docs/alpha/glossary.rst +++ b/docs/alpha/glossary.rst @@ -137,7 +137,7 @@ _`Baker` When using :ref:`Octez `, baking and other consensus actions are handled by the baker daemon, on behalf of one or more delegate_ accounts. - By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf. + By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf, participating to governance and to the DAL. _`Baking` The act of creating a new block_ by a baker_. @@ -188,7 +188,7 @@ _`Cycle` .. _def_delegate_alpha: _`Delegate` - A `user account`_ that can participate in consensus and in governance. + A `user account`_ that can participate in consensus, in governance, and in the DAL. Actual participation is under further provisions, like having a `minimal stake`_. A user account becomes a delegate by registering as such. Through delegation_, other accounts can delegate their rights to a delegate account. -- GitLab From 4c877984fd98c582db1858d4fa2f8d8ed1e11add Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Wed, 30 Jul 2025 13:22:09 -0400 Subject: [PATCH 08/10] doc: Do not use the same dir when switching DAL networks --- docs/shell/dal_run.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index 6c734056775f..631b5dbf9b9f 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -42,6 +42,8 @@ Follow these steps to run a DAL node along with a layer 1 node and a baker. octez-dal-node config init --endpoint http://127.0.0.1:8732 --attester-profiles="$MY_ADDRESS" --data-dir my-attester-tezos-dal-node + If you are switching from running the DAL node on a different network, use an empty directory instead of re-using the directory from another network. + You can specify parameters such as the RPC node in the ``config init`` command or in the ``run`` command. These commands have the same parameters. For information about them, run ``octez-dal-node config init --help`` or see :ref:`DAL node commands `. -- GitLab From 2962eb7201c49e9fcfed26a36f991197d672b320 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 31 Jul 2025 13:07:28 +0000 Subject: [PATCH 09/10] doc: apply fixes from reviewers --- docs/alpha/glossary.rst | 2 +- docs/protocols/alpha.rst | 2 +- docs/user/key-management.rst | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/alpha/glossary.rst b/docs/alpha/glossary.rst index 4147b670d787..141f7df904ab 100644 --- a/docs/alpha/glossary.rst +++ b/docs/alpha/glossary.rst @@ -137,7 +137,7 @@ _`Baker` When using :ref:`Octez `, baking and other consensus actions are handled by the baker daemon, on behalf of one or more delegate_ accounts. - By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf, participating to governance and to the DAL. + By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf, participating in governance and in the DAL. _`Baking` The act of creating a new block_ by a baker_. diff --git a/docs/protocols/alpha.rst b/docs/protocols/alpha.rst index 9ebeada338ab..c98287aff053 100644 --- a/docs/protocols/alpha.rst +++ b/docs/protocols/alpha.rst @@ -9,7 +9,7 @@ For a higher-level overview of the most salient new features see the `announcement blog `__. The code can be found in directory :src:`src/proto_alpha` of the ``master`` -branch of Octez and the full documentation in :doc:`this page <../active/index>`. +branch of Octez and the full documentation in :doc:`this page <../alpha/index>`. Environment Version ------------------- diff --git a/docs/user/key-management.rst b/docs/user/key-management.rst index 5babe32e5a9d..689b11a06b94 100644 --- a/docs/user/key-management.rst +++ b/docs/user/key-management.rst @@ -287,7 +287,7 @@ such a KMS key as its consensus key. Shall they lose access to the cloud platfor .. warning:: - However, both the delegate key and the consensus key give total control over the delegate's funds: indeed, the consensus + Note that the consensus key has also access to the delegate's spendable funds: indeed, the consensus key may sign a ``Drain_delegate`` operation to transfer the delegate's spendable balance to an arbitrary account. In :doc:`relevant RPCs<../api/openapi>` like @@ -295,7 +295,7 @@ such a KMS key as its consensus key. Shall they lose access to the cloud platfor delegate's manager and consensus keys are listed. As a consequence, the consensus key should be treated with equal care as the manager key. -Possible options to counter the risk of fund draining by the consensus key include: to stake all baking funds in the security deposit, and to rotate the consensus key before stopping the baking operations and unstaking the security deposit. +Further possible options to counter the risk of fund draining by a compromised consensus key include: staking (nearly) all funds available on the baking key, leaving just a minimum to pay operation fees, and, rotating consensus key regularly, specially before unstaking tez. Note that the activation delay for new consensus key is one cycle shorter than the unstake finalization delay. Registering a Consensus Key ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- GitLab From 30b5c6b2fc9509e72680cb4a773cb05af17d072d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 31 Jul 2025 15:17:50 +0200 Subject: [PATCH 10/10] doc: backport glossary changes to S --- docs/seoul/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/seoul/glossary.rst b/docs/seoul/glossary.rst index acfb335a8093..46e2a8268b21 100644 --- a/docs/seoul/glossary.rst +++ b/docs/seoul/glossary.rst @@ -137,7 +137,7 @@ _`Baker` When using :ref:`Octez `, baking and other consensus actions are handled by the baker daemon, on behalf of one or more delegate_ accounts. - By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf. + By extension, a baker designates the owner of such a delegate account, typically running the baker daemon on its behalf, participating in governance and in the DAL. _`Baking` The act of creating a new block_ by a baker_. @@ -188,7 +188,7 @@ _`Cycle` .. _def_delegate_seoul: _`Delegate` - A `user account`_ that can participate in consensus and in governance. + A `user account`_ that can participate in consensus, in governance, and in the DAL. Actual participation is under further provisions, like having a `minimal stake`_. A user account becomes a delegate by registering as such. Through delegation_, other accounts can delegate their rights to a delegate account. -- GitLab