From c00f1cb5329b12c5be95a6ea22c362f95811584e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 21 Aug 2025 09:43:42 +0200 Subject: [PATCH 1/5] doc: rearrange RC repo setup for more visbility --- docs/introduction/howtoget.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 2190d3692585..8e828dbaa870 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -114,24 +114,24 @@ We support the following distribution/releases: both on ``amd64`` and ``arm64`` architectures. -In order to add the Tezos package repository to your machine, do: +In order to set the Tezos package repository to your machine, do: :: export distribution=debian export release=bookworm -and run: +We also maintain a separate repository for release candidates. To set +the last release candidate simply prepend ``RC/`` to the distribution name +as in ``export distribution=RC/debian``. + +Now add the Tezos package repository: .. literalinclude:: install-bin-deb.sh :language: shell :start-after: [add repository] :end-before: [end add repository] -We also maintain a separate repository for release candidates. To install -the last release candidate simply prepend ``RC/`` to the distribution name -as in ``export distribution=RC/debian`` - Then, to install the binaries, run the following command to install the octez-baker and all its dependencies: :: -- GitLab From b4b98dfa56fffbebf373ff8bfac5e5237ef5541b Mon Sep 17 00:00:00 2001 From: Killian Delarue Date: Thu, 21 Aug 2025 17:45:30 +0200 Subject: [PATCH 2/5] Docs, v23: Fix warning typo --- docs/introduction/services.rst | 7 +++++-- docs/releases/version-23.rst | 3 ++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/introduction/services.rst b/docs/introduction/services.rst index ae34be73659a..a6dddbb673fb 100644 --- a/docs/introduction/services.rst +++ b/docs/introduction/services.rst @@ -9,7 +9,7 @@ However, in these tutorials, daemons are just run in background or left running This page shows how Octez daemons can be safely run from the official binary packages, as Unix services, which can ensure that they are started automatically and restarted in case of failures. This is a intermediate-level baking howto assuming some familiarity with the previous tutorials mentioned above, on installing, on setting up Octez, and on the notion of baking. -For a more accessible and detailed step-by-step tutorial on running an Octez baker, including the complete set up of a baking account and thorough manual verifications upon each step, see +For a more accessible and detailed step-by-step tutorial on running an Octez baker, including the complete set up of a baking account and thorough manual verifications upon each step, see `Run a Tezos node in 5 steps `__. Installing Octez @@ -53,6 +53,9 @@ For more details on configuring the Octez node, see :doc:`../user/setup-node`. The default for the octez-node is to connect to ``mainnet``. You may want to connect to a test network if your goal is learning, developing, or testing. + +.. _node_as_service: + Running the Octez node ~~~~~~~~~~~~~~~~~~~~~~ @@ -87,7 +90,7 @@ If you intend to bake on a testnet, you can simply create a key as follows, fund $ sudo su tezos -c "octez-client show address mybaker" Hash: tz1Ti8WHvfp3XKsTCKWLFv4TrER2HDofXG39 Public Key: edpkuGRKH8oZDP2PH2EULw9PGzJHdf5g2zCiHnaYG7tapeePUNAWeC - + $ ... # Fund mybaker with > 6000 tez, e.g. at https://faucet.ghostnet.teztnets.com $ sudo su tezos -c "octez-client register key mybaker as delegate" $ sudo su tezos -c "octez-client stake 6000 for mybaker" diff --git a/docs/releases/version-23.rst b/docs/releases/version-23.rst index a21f5907859b..035e8739b1b3 100644 --- a/docs/releases/version-23.rst +++ b/docs/releases/version-23.rst @@ -31,7 +31,7 @@ This binary is a protocol-independent that dynamically selects the appropriate baking process based on the active protocol. The bakers names with protocols are still released, but they will be deprecated in an upcoming version. - + Similarly, there is also a protocol-independent binary ``octez-accuser`` starting from v23. .. _bls_v23: @@ -81,6 +81,7 @@ Ubuntu and Debian packages sudo apt update octez-node octez-client octez-baker octez-dal-node octez-smart-rollup-node If you are installing Ubuntu and Debian packages from scratch, follow :ref:`their install instructions ` + .. warning:: If you are running the Octez node with a non-default data directory, check instructions :ref:`here `. -- GitLab From 61f09863d3cf1f441ba83ff8800f5d63aae0ccdb Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 22 Aug 2025 17:39:46 +0200 Subject: [PATCH 3/5] doc: mention possible bots for finalize_unstake --- docs/alpha/staking.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index 979e8c905806..c7b5c1746bbb 100644 --- a/docs/alpha/staking.rst +++ b/docs/alpha/staking.rst @@ -209,6 +209,7 @@ or more conveniently:: octez-client finalize unstake for Note that starting with protocol S, not only the staker, but anyone can trigger ``finalize_unstake`` (in any case, the unfrozen funds still go to the staker). +This paves the way for implementing bots that regularly check finalizable unstakes on block explorers and trigger their finalization automatically. In some circumstances, unstake and finalize can be done implicitly: any call to ``stake`` or ``unstake`` will implicitly finalize all currently finalizable pending -- GitLab From f64953b73777c1f67e0f58faf18da3a0bd2ff14e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 26 Aug 2025 13:45:52 +0200 Subject: [PATCH 4/5] doc: fix value burnt for a transfer to a new account --- docs/introduction/howtouse.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 865549d4a4b8..dba04d4012e9 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -367,8 +367,8 @@ Let's try:: octez-client transfer 1 from alice to bob --dry-run Fatal error: - The operation will burn 0.257 tez which is higher than the configured burn cap (0 tez). - Use `--burn-cap 0.257` to emit this operation. + The operation will burn 0.06425 tez which is higher than the configured burn cap (0 tez). + Use `--burn-cap 0.06425` to emit this operation. The client asks the node to validate the operation (without sending it) and obtains an error. @@ -378,11 +378,12 @@ Any storage on chain has a cost associated to it which should be accounted for either by paying a fee to a baker or by destroying (``burning``) some tez. This is particularly important to protect the system from spam. -Because storing an address requires burning 0.257 tez and the client has +The cost is given by ``origination_size * cost_per_byte``, where the two constants are defined in the protocol's source code (file :src:`default_parameters.ml `). +Because storing an address requires burning 0.06425 tez and the client has a default of 0, we need to explicitly set a cap on the amount that we allow to burn:: - octez-client transfer 1 from alice to bob --dry-run --burn-cap 0.257 + octez-client transfer 1 from alice to bob --dry-run --burn-cap 0.06425 This should do it and you should see a rather long receipt being produced, here's an excerpt:: @@ -415,7 +416,7 @@ produced, here's an excerpt:: Balance updates: tz1RjtZUVeLhADFHDL8UwDZA6vjWWhojpu5w ... -ꜩ1 tz1Rk5HA9SANn3bjo4qMXTZettPjjKMG14Ph ... +ꜩ1 - tz1RjtZUVeLhADFHDL8UwDZA6vjWWhojpu5w ... -ꜩ0.257 + tz1RjtZUVeLhADFHDL8UwDZA6vjWWhojpu5w ... -ꜩ0.06425 The client does a bit of magic to simplify our life and here we see that many details were automatically set for us. @@ -492,7 +493,7 @@ Let's originate our first contract and call it *id*:: octez-client originate contract id transferring 1 from alice \ running ./michelson_test_scripts/attic/id.tz \ - --init '"hello"' --burn-cap 0.4 + --init '"hello"' --burn-cap 0.1 The initial balance is 1 tez, generously provided by user account *alice*. The contract stores a Michelson program ``id.tz`` -- GitLab From e7c85b39aae9afa92a3cfcf806537356c0d1b51b Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 26 Aug 2025 16:04:40 +0200 Subject: [PATCH 5/5] doc: advise using prebuild distribution because compiling requires a big machine --- docs/introduction/howtobuild.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/introduction/howtobuild.rst b/docs/introduction/howtobuild.rst index 053f0be3f219..9a7d5cefd7d1 100644 --- a/docs/introduction/howtobuild.rst +++ b/docs/introduction/howtobuild.rst @@ -5,7 +5,9 @@ Building Octez from source .. _compiling_with_make: If you plan to contribute to the Octez codebase or if you want to build a version of Octez that is based on the most recent code, the way to go is to set up a complete development environment by cloning the repository and compiling the sources using the provided makefile. -If you rather want to install prebuilt binaries, refer to :doc:`howtoget`. + +Note that setting up a complete development environment requires a powerful machine, and the required resources are increasing in the long run. +If you are using Octez for production, consider installing forms of prebuilt binaries, refer to :doc:`howtoget`. You can either build all the executables, as illustrated below, or only a subset of the executables, as detailed in section :ref:`compile_sources`. -- GitLab