From 887a3b803bb1e0782544cc7eb8402ae279d7f5f3 Mon Sep 17 00:00:00 2001 From: Valentin Chaboche Date: Wed, 30 Apr 2025 10:24:10 +0200 Subject: [PATCH 1/6] Baker: trailing whitespace --- src/lib_agnostic_baker/protocol_plugin_sig.ml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib_agnostic_baker/protocol_plugin_sig.ml b/src/lib_agnostic_baker/protocol_plugin_sig.ml index 16c276e168b6..0960820ca76e 100644 --- a/src/lib_agnostic_baker/protocol_plugin_sig.ml +++ b/src/lib_agnostic_baker/protocol_plugin_sig.ml @@ -11,7 +11,7 @@ module type BAKER_COMMANDS_HELPERS = sig requires the [~configuration] which contains all the possible CLI arguments for the agnostic baker, together with a [~baking_mode] argument and delegates list given by [~sources] in the client context [~cctxt]. - + Depending on the protocol, the arguments can be transformed in the corresponding plugin, but the structure of the list of arguments will not grow or shrink, to prevent incompatibilities at migrations. *) -- GitLab From 4c64a3ce42ef0d2e37ae7cd6a5bceec7f36fa6e9 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 7 May 2025 18:09:34 +0200 Subject: [PATCH 2/6] doc: fix code blocks in howtoget.rst --- docs/introduction/howtoget.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index b2482a57f82d..890c7af69cdb 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -240,17 +240,17 @@ On macOS and Linux, you can compile and install Octez using Homebrew. If Homebrew is not yet installed on your system, please refer to the official [Homebrew installation guide](https://brew.sh/) for detailed instructions. -Once Homebrew is set up, follow these steps to install Octez: +Once Homebrew is set up, follow these steps to install Octez. -Download the Octez formula by executing the following command in your terminal: +Download the Octez formula by executing the following command in your terminal:: curl -q "https://packages.nomadic-labs.com/homebrew/Formula/octez.rb" -O -For ``RC`` versions, do rather: +For ``RC`` versions, do rather:: curl -q "https://packages.nomadic-labs.com/homebrew/RC/Formula/octez.rb" -O -Install Octez using the downloaded formula with the following command: +Install Octez using the downloaded formula with the following command:: brew install -v ./octez.rb -- GitLab From e59ebd814dd61065008e91dcf621e64f02d6020a Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 12 May 2025 12:16:51 +0200 Subject: [PATCH 3/6] doc: DAL requires baking app 2.5.0+ --- docs/shell/dal_run.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index d6ffe6c028e7..bdd9d636ffbb 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -240,3 +240,8 @@ For both producers and bakers, it is essential to maintain good connectivity by - If you're behind a firewall, you must configure it to allow both incoming and outgoing connections on the P2P port. - If you're not using the ``--public-addr`` argument, ensure that the NAT forwarding rule uses the same external and internal ports. + +DAL and the Ledger +^^^^^^^^^^^^^^^^^^ + +If you are using a Ledger device, make sure it runs a version of the Tezos baking app that supports the DAL, such as version 2.5.0 or later. -- GitLab From f3f03de885f3e57612afd5c498311b3e30fee9f8 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 13 May 2025 11:16:26 +0200 Subject: [PATCH 4/6] doc: fix broken/flky links --- docs/alpha/consensus.rst | 2 +- docs/conf.py | 4 +--- docs/rio/consensus.rst | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/alpha/consensus.rst b/docs/alpha/consensus.rst index 9207dc6f2ab1..d1e312c6c77f 100644 --- a/docs/alpha/consensus.rst +++ b/docs/alpha/consensus.rst @@ -20,7 +20,7 @@ with a probability that increases rapidly with fork length. `Tenderbake `_ instead, like any classic BFT-style consensus algorithm (such as -`PBFT `_ or +`PBFT `_ or `Tendermint `_), offers *deterministic* finality: a block that has just been appended to the chain of some node is known to be final once it has two additional blocks on top of it, regardless of diff --git a/docs/conf.py b/docs/conf.py index 69d4cfb0ad42..04895dc93926 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -307,9 +307,7 @@ linkcheck_ignore = [ r'^https://opentezos\.com/', r'^https://crates\.io/crates/tezos-smart-rollup', r'^https://rpc\.ghostnet\.teztnets\.com/chains/main/blocks/', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/2771', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3163', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3225', + r'^https://gitlab\.com/tezos/tezos/-/merge_requests/', ] linkcheck_allowed_redirects = dict( [ diff --git a/docs/rio/consensus.rst b/docs/rio/consensus.rst index 2ec12d117559..f5f059666ab2 100644 --- a/docs/rio/consensus.rst +++ b/docs/rio/consensus.rst @@ -20,7 +20,7 @@ with a probability that increases rapidly with fork length. `Tenderbake `_ instead, like any classic BFT-style consensus algorithm (such as -`PBFT `_ or +`PBFT `_ or `Tendermint `_), offers *deterministic* finality: a block that has just been appended to the chain of some node is known to be final once it has two additional blocks on top of it, regardless of -- GitLab From 35e5b8b85c5200e676447c4f16f999dc4cc2a6df Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 15 May 2025 14:46:35 +0200 Subject: [PATCH 5/6] doc: recommend Ledger Nano S+ --- docs/shell/dal_run.rst | 2 +- docs/user/key-management.rst | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index bdd9d636ffbb..400be2585485 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -244,4 +244,4 @@ For both producers and bakers, it is essential to maintain good connectivity by DAL and the Ledger ^^^^^^^^^^^^^^^^^^ -If you are using a Ledger device, make sure it runs a version of the Tezos baking app that supports the DAL, such as version 2.5.0 or later. +If you are using a Ledger device, make sure it runs a version of the `Tezos baking app `__ that supports the DAL, such as version 2.5.0 or later. diff --git a/docs/user/key-management.rst b/docs/user/key-management.rst index 82633c65501e..de0bed881c65 100644 --- a/docs/user/key-management.rst +++ b/docs/user/key-management.rst @@ -39,6 +39,8 @@ It is possible and advised to use a hardware wallet to securely store and manage keys. The Octez client supports Ledger Nano devices provided that they have two Tezos apps installed, `Tezos Wallet app `_ and `Tezos Baking app `_ which are provided by `Trilitech Ltd `_. They can be installed from the Ledger Live store. +For performance reasons (see `details `__), a Ledger Nano S Plus model is a preferable choice with respect to a Ledger Nano. + Ledger Manager ~~~~~~~~~~~~~~ @@ -94,6 +96,8 @@ Setup the Ledger baking app on any Tezos network using the following command:: More details on setting up baking with the Ledger can be found on the `Tezos Baking app readme `_. +For details about baking using a Ledger device, see a `dedicated tutorial `__. + .. _signer: Signer -- GitLab From dd037e256a50aafd29ba7cecee9c1d4e6a1b2ba1 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 16 May 2025 16:40:43 +0200 Subject: [PATCH 6/6] doc: SEED_NONCE_REVELATION_TIP is no longer a constant --- docs/alpha/randomness_generation.rst | 14 ++++++++------ docs/rio/randomness_generation.rst | 14 ++++++++------ 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/alpha/randomness_generation.rst b/docs/alpha/randomness_generation.rst index 4a8c825bdc6e..d8672b4ad9c3 100644 --- a/docs/alpha/randomness_generation.rst +++ b/docs/alpha/randomness_generation.rst @@ -113,8 +113,9 @@ bitstring is the hash of the concatenation of the previous bitstring with the iterated revealed nonce. A *nonce revelation* is an operation and multiple nonce revelations can thus be -included in a block. A reward ``SEED_NONCE_REVELATION_TIP``, :ref:`potentially adjusted -by the adaptive issuance coefficient `, is given for +included in a block. A reward ``seed_nonce_revelation_tip``, :ref:`potentially adjusted +by the adaptive issuance coefficient ` +and weighted by constant ``SEED_NONCE_REVELATION_TIP_WEIGHT``, is given for including a revelation. Revelations are free operations which do not compete with transactions for block space. Up to ``MAX_ANON_OPS_PER_BLOCK`` revelations, wallet activations and denunciations can be contained in any given block. @@ -135,9 +136,10 @@ solution: its value is set to be the hash of the RANDAO output and the VDF solution. -A *VDF revelation* is an operation. A reward ``SEED_NONCE_REVELATION_TIP``, +A *VDF revelation* is an operation. A reward ``seed_nonce_revelation_tip`` :ref:`potentially adjusted by the adaptive issuance coefficient -`, is given for the first correct VDF revelation, +` and weighted by constant ``SEED_NONCE_REVELATION_TIP_WEIGHT``, +is given for the first correct VDF revelation, subsequent VDF revelation operations being discarded. .. _rg_constants_alpha: @@ -157,8 +159,8 @@ Randomness generation parameters - 300 blocks * - ``MAX_ANON_OPS_PER_BLOCK`` - 132 revelations - * - ``SEED_NONCE_REVELATION_TIP`` - - 1/8 ꜩ + * - ``SEED_NONCE_REVELATION_TIP_WEIGHT`` + - 1 * - ``VDF_DIFFICULTY`` - 2,400,000,000 diff --git a/docs/rio/randomness_generation.rst b/docs/rio/randomness_generation.rst index 1d69e361ebfc..5ccbdef46fc2 100644 --- a/docs/rio/randomness_generation.rst +++ b/docs/rio/randomness_generation.rst @@ -115,8 +115,9 @@ bitstring is the hash of the concatenation of the previous bitstring with the iterated revealed nonce. A *nonce revelation* is an operation and multiple nonce revelations can thus be -included in a block. A reward ``SEED_NONCE_REVELATION_TIP``, :ref:`potentially adjusted -by the adaptive issuance coefficient `, is given for +included in a block. A reward ``seed_nonce_revelation_tip``, :ref:`potentially adjusted +by the adaptive issuance coefficient ` +and weighted by constant ``SEED_NONCE_REVELATION_TIP_WEIGHT``, is given for including a revelation. Revelations are free operations which do not compete with transactions for block space. Up to ``MAX_ANON_OPS_PER_BLOCK`` revelations, wallet activations and denunciations can be contained in any given block. @@ -137,9 +138,10 @@ solution: its value is set to be the hash of the RANDAO output and the VDF solution. -A *VDF revelation* is an operation. A reward ``SEED_NONCE_REVELATION_TIP``, +A *VDF revelation* is an operation. A reward ``seed_nonce_revelation_tip``, :ref:`potentially adjusted by the adaptive issuance coefficient -`, is given for the first correct VDF revelation, +` and weighted by constant ``SEED_NONCE_REVELATION_TIP_WEIGHT``, +is given for the first correct VDF revelation, subsequent VDF revelation operations being discarded. .. _rg_constants: @@ -160,8 +162,8 @@ Randomness generation parameters - 960 blocks * - ``MAX_ANON_OPS_PER_BLOCK`` - 132 revelations - * - ``SEED_NONCE_REVELATION_TIP`` - - 1/8 ꜩ + * - ``SEED_NONCE_REVELATION_TIP_WEIGHT`` + - 1 * - ``VDF_DIFFICULTY`` - 8,000,000,000 -- GitLab