From 922df97836ee36e29f69a19e18430ca5f1472066 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 21 Mar 2025 16:38:06 +0100 Subject: [PATCH 01/12] doc: make link to doc map more precise --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e98814ea3273..45874b26b60b 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -155,7 +155,7 @@ html_theme_options = { }, { "name": "Documentation map", - "url": "https://docs.tezos.com/overview/resources", + "url": "https://docs.tezos.com/overview/resources#documentation-map", "icon": "_static/map.png", "type": "local", }, -- GitLab From 9b2d6533c586070df7333edcfcb87147034b6dc6 Mon Sep 17 00:00:00 2001 From: Valentin Chaboche Date: Mon, 24 Mar 2025 11:09:41 +0100 Subject: [PATCH 02/12] Base: typo --- src/lib_base/unix/file_descriptor_sink.mli | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib_base/unix/file_descriptor_sink.mli b/src/lib_base/unix/file_descriptor_sink.mli index 91012a7cca37..1dfc132fa328 100644 --- a/src/lib_base/unix/file_descriptor_sink.mli +++ b/src/lib_base/unix/file_descriptor_sink.mli @@ -30,7 +30,7 @@ - ["file-descriptor-path"] outputs to the file at the URI path - ["file-descriptor-stdout"] outputs to [stdout] - ["file-descriptor-stderr"] outputs to [stderr] - - ["file-descriptor-syslog"] ouputs to a [syslog] facility + - ["file-descriptor-syslog"] outputs to a [syslog] facility Available options are -- GitLab From bfa216fb90c57a8c3a5c4994fc0170f35a886ae7 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 24 Mar 2025 14:19:28 +0100 Subject: [PATCH 03/12] doc: remove unused script install-bin-fedora --- docs/introduction/install-bin-fedora.sh | 38 ------------------------- 1 file changed, 38 deletions(-) delete mode 100755 docs/introduction/install-bin-fedora.sh diff --git a/docs/introduction/install-bin-fedora.sh b/docs/introduction/install-bin-fedora.sh deleted file mode 100755 index bb4cdf36ed81..000000000000 --- a/docs/introduction/install-bin-fedora.sh +++ /dev/null @@ -1,38 +0,0 @@ -#!/bin/sh - -usage() { - cat >&2 << !EOF -usage: - $0 [rc] -!EOF -} - -if [ $# -eq 1 ] && [ "$1" = "rc" ]; then - # [setup rc repository] - REPO="@Serokell/Tezos-rc" - # [end] -elif [ $# -eq 0 ]; then - # [setup stable repository] - REPO="@Serokell/Tezos" - # [end] -else - usage - exit 1 -fi - -# TODO tezos/tezos#2170: search shifted protocol name/number & adapt -set -e -set -x -# [install prerequisites] -dnf install -y dnf-plugins-core -# [install tezos] -dnf copr enable -y $REPO && dnf update -y -dnf install -y tezos-client -dnf install -y tezos-node -dnf install -y tezos-baker-Proxford -dnf install -y tezos-accuser-Proxford -# [test executables] -octez-client --version -octez-node --version -octez-baker-Proxford --version -octez-accuser-Proxford --version -- GitLab From 86694fad38361c390810c2d3cea94ba3497a6264 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 24 Mar 2025 14:54:57 +0100 Subject: [PATCH 04/12] doc: fix format in conf.py --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 45874b26b60b..83b35eb8d164 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -155,7 +155,8 @@ html_theme_options = { }, { "name": "Documentation map", - "url": "https://docs.tezos.com/overview/resources#documentation-map", + "url": "https://docs.tezos.com/overview/resources" + "#documentation-map", "icon": "_static/map.png", "type": "local", }, -- GitLab From 6652066190c8606f4407f1a2f78a9a464b521bf1 Mon Sep 17 00:00:00 2001 From: Valentin Chaboche Date: Tue, 25 Mar 2025 13:34:56 +0100 Subject: [PATCH 05/12] Rpc: it is or not it is --- client-libs/kaitai-struct-files/files/alpha__errors.ksy | 2 +- .../kaitai-struct-files/files/id_005__psbabym1__errors.ksy | 2 +- .../kaitai-struct-files/files/id_006__pscartha__errors.ksy | 2 +- .../kaitai-struct-files/files/id_007__psdelph1__errors.ksy | 2 +- .../kaitai-struct-files/files/id_008__ptedo2zk__errors.ksy | 2 +- .../kaitai-struct-files/files/id_009__psfloren__errors.ksy | 2 +- .../kaitai-struct-files/files/id_010__ptgranad__errors.ksy | 2 +- .../kaitai-struct-files/files/id_011__pthangz2__errors.ksy | 2 +- .../kaitai-struct-files/files/id_012__psithaca__errors.ksy | 2 +- .../kaitai-struct-files/files/id_013__ptjakart__errors.ksy | 2 +- .../kaitai-struct-files/files/id_014__ptkathma__errors.ksy | 2 +- .../kaitai-struct-files/files/id_015__ptlimapt__errors.ksy | 2 +- .../kaitai-struct-files/files/id_016__ptmumbai__errors.ksy | 2 +- .../kaitai-struct-files/files/id_017__ptnairob__errors.ksy | 2 +- .../kaitai-struct-files/files/id_018__proxford__errors.ksy | 2 +- .../kaitai-struct-files/files/id_019__ptparisb__errors.ksy | 2 +- .../kaitai-struct-files/files/id_020__psparisc__errors.ksy | 2 +- .../kaitai-struct-files/files/id_021__psquebec__errors.ksy | 2 +- .../kaitai-struct-files/files/id_022__psriotum__errors.ksy | 2 +- src/proto_004_Pt24m4xi/lib_client/alpha_client_context.ml | 2 +- src/proto_005_PsBabyM1/lib_client/protocol_client_context.ml | 2 +- src/proto_006_PsCARTHA/lib_client/protocol_client_context.ml | 2 +- src/proto_007_PsDELPH1/lib_client/protocol_client_context.ml | 2 +- src/proto_008_PtEdo2Zk/lib_client/protocol_client_context.ml | 2 +- src/proto_009_PsFLoren/lib_client/protocol_client_context.ml | 2 +- src/proto_010_PtGRANAD/lib_client/protocol_client_context.ml | 2 +- src/proto_011_PtHangz2/lib_client/protocol_client_context.ml | 2 +- src/proto_012_Psithaca/lib_client/protocol_client_context.ml | 2 +- src/proto_013_PtJakart/lib_client/protocol_client_context.ml | 2 +- src/proto_014_PtKathma/lib_client/protocol_client_context.ml | 2 +- src/proto_015_PtLimaPt/lib_client/protocol_client_context.ml | 2 +- src/proto_016_PtMumbai/lib_client/protocol_client_context.ml | 2 +- src/proto_017_PtNairob/lib_client/protocol_client_context.ml | 2 +- src/proto_018_Proxford/lib_client/protocol_client_context.ml | 2 +- src/proto_019_PtParisB/lib_client/protocol_client_context.ml | 2 +- src/proto_020_PsParisC/lib_client/protocol_client_context.ml | 2 +- src/proto_021_PsQuebec/lib_client/protocol_client_context.ml | 2 +- src/proto_022_PsRiotum/lib_client/protocol_client_context.ml | 2 +- src/proto_alpha/lib_client/protocol_client_context.ml | 2 +- 39 files changed, 39 insertions(+), 39 deletions(-) diff --git a/client-libs/kaitai-struct-files/files/alpha__errors.ksy b/client-libs/kaitai-struct-files/files/alpha__errors.ksy index 86fe7aa489eb..c82300b88a16 100644 --- a/client-libs/kaitai-struct-files/files/alpha__errors.ksy +++ b/client-libs/kaitai-struct-files/files/alpha__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: alpha.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_005__psbabym1__errors.ksy b/client-libs/kaitai-struct-files/files/id_005__psbabym1__errors.ksy index d6a42ade06fc..6127926141a3 100644 --- a/client-libs/kaitai-struct-files/files/id_005__psbabym1__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_005__psbabym1__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 005-PsBabyM1.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_006__pscartha__errors.ksy b/client-libs/kaitai-struct-files/files/id_006__pscartha__errors.ksy index 0fc505670ca8..23019477af25 100644 --- a/client-libs/kaitai-struct-files/files/id_006__pscartha__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_006__pscartha__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 006-PsCARTHA.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_007__psdelph1__errors.ksy b/client-libs/kaitai-struct-files/files/id_007__psdelph1__errors.ksy index f90fb6ac0c58..5941927fd98b 100644 --- a/client-libs/kaitai-struct-files/files/id_007__psdelph1__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_007__psdelph1__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 007-PsDELPH1.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_008__ptedo2zk__errors.ksy b/client-libs/kaitai-struct-files/files/id_008__ptedo2zk__errors.ksy index e979911baf76..ff6cd4505e1a 100644 --- a/client-libs/kaitai-struct-files/files/id_008__ptedo2zk__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_008__ptedo2zk__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 008-PtEdo2Zk.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_009__psfloren__errors.ksy b/client-libs/kaitai-struct-files/files/id_009__psfloren__errors.ksy index 884b6650d215..353c3a30f10a 100644 --- a/client-libs/kaitai-struct-files/files/id_009__psfloren__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_009__psfloren__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 009-PsFLoren.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_010__ptgranad__errors.ksy b/client-libs/kaitai-struct-files/files/id_010__ptgranad__errors.ksy index 314b491b1d54..2e1ab40811bb 100644 --- a/client-libs/kaitai-struct-files/files/id_010__ptgranad__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_010__ptgranad__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 010-PtGRANAD.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_011__pthangz2__errors.ksy b/client-libs/kaitai-struct-files/files/id_011__pthangz2__errors.ksy index 722d5d5e6c5a..db2b4dfc3ad7 100644 --- a/client-libs/kaitai-struct-files/files/id_011__pthangz2__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_011__pthangz2__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 011-PtHangz2.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_012__psithaca__errors.ksy b/client-libs/kaitai-struct-files/files/id_012__psithaca__errors.ksy index e9d6f05fadf3..c6007515dfb4 100644 --- a/client-libs/kaitai-struct-files/files/id_012__psithaca__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_012__psithaca__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 012-Psithaca.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_013__ptjakart__errors.ksy b/client-libs/kaitai-struct-files/files/id_013__ptjakart__errors.ksy index 951bfbd8b127..fbf75ee4a0b8 100644 --- a/client-libs/kaitai-struct-files/files/id_013__ptjakart__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_013__ptjakart__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 013-PtJakart.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_014__ptkathma__errors.ksy b/client-libs/kaitai-struct-files/files/id_014__ptkathma__errors.ksy index 6b83ccddbb57..c42b95f4e201 100644 --- a/client-libs/kaitai-struct-files/files/id_014__ptkathma__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_014__ptkathma__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 014-PtKathma.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_015__ptlimapt__errors.ksy b/client-libs/kaitai-struct-files/files/id_015__ptlimapt__errors.ksy index a13d50e7af4d..daae1e7992df 100644 --- a/client-libs/kaitai-struct-files/files/id_015__ptlimapt__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_015__ptlimapt__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 015-PtLimaPt.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_016__ptmumbai__errors.ksy b/client-libs/kaitai-struct-files/files/id_016__ptmumbai__errors.ksy index 799ef3d7beb9..c97ba010dd62 100644 --- a/client-libs/kaitai-struct-files/files/id_016__ptmumbai__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_016__ptmumbai__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 016-PtMumbai.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_017__ptnairob__errors.ksy b/client-libs/kaitai-struct-files/files/id_017__ptnairob__errors.ksy index d2e90d8306cd..0e122f705414 100644 --- a/client-libs/kaitai-struct-files/files/id_017__ptnairob__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_017__ptnairob__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 017-PtNairob.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_018__proxford__errors.ksy b/client-libs/kaitai-struct-files/files/id_018__proxford__errors.ksy index 60f21c6d791e..acf154efc41f 100644 --- a/client-libs/kaitai-struct-files/files/id_018__proxford__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_018__proxford__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 018-Proxford.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_019__ptparisb__errors.ksy b/client-libs/kaitai-struct-files/files/id_019__ptparisb__errors.ksy index 6324ff34a563..7a3f42ca2bad 100644 --- a/client-libs/kaitai-struct-files/files/id_019__ptparisb__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_019__ptparisb__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 019-PtParisB.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_020__psparisc__errors.ksy b/client-libs/kaitai-struct-files/files/id_020__psparisc__errors.ksy index 027701c3b9b7..552f5434e1d8 100644 --- a/client-libs/kaitai-struct-files/files/id_020__psparisc__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_020__psparisc__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 020-PsParisC.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_021__psquebec__errors.ksy b/client-libs/kaitai-struct-files/files/id_021__psquebec__errors.ksy index 04e1b04dba84..6d94ab03ff89 100644 --- a/client-libs/kaitai-struct-files/files/id_021__psquebec__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_021__psquebec__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 021-PsQuebec.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/client-libs/kaitai-struct-files/files/id_022__psriotum__errors.ksy b/client-libs/kaitai-struct-files/files/id_022__psriotum__errors.ksy index 9b808ae6fe0b..53e4741cf2ab 100644 --- a/client-libs/kaitai-struct-files/files/id_022__psriotum__errors.ksy +++ b/client-libs/kaitai-struct-files/files/id_022__psriotum__errors.ksy @@ -4,7 +4,7 @@ meta: doc: ! >- Encoding id: 022-PsRiotum.errors - Description: The full list of RPC errors would be too long to include.It is + Description: The full list of RPC errors would be too long to include. It is available through the RPC `/errors` (GET). types: diff --git a/src/proto_004_Pt24m4xi/lib_client/alpha_client_context.ml b/src/proto_004_Pt24m4xi/lib_client/alpha_client_context.ml index ede505a901ae..ecb771ac11b7 100644 --- a/src/proto_004_Pt24m4xi/lib_client/alpha_client_context.ml +++ b/src/proto_004_Pt24m4xi/lib_client/alpha_client_context.ml @@ -248,6 +248,6 @@ let () = @@ Data_encoding.def (stamp_proto "errors" []) ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_005_PsBabyM1/lib_client/protocol_client_context.ml b/src/proto_005_PsBabyM1/lib_client/protocol_client_context.ml index 81bbb0f1d704..c3e0423632c9 100644 --- a/src/proto_005_PsBabyM1/lib_client/protocol_client_context.ml +++ b/src/proto_005_PsBabyM1/lib_client/protocol_client_context.ml @@ -232,6 +232,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_006_PsCARTHA/lib_client/protocol_client_context.ml b/src/proto_006_PsCARTHA/lib_client/protocol_client_context.ml index 40d27c01b4b0..08b8229c734e 100644 --- a/src/proto_006_PsCARTHA/lib_client/protocol_client_context.ml +++ b/src/proto_006_PsCARTHA/lib_client/protocol_client_context.ml @@ -233,6 +233,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_007_PsDELPH1/lib_client/protocol_client_context.ml b/src/proto_007_PsDELPH1/lib_client/protocol_client_context.ml index 5125c5621ecc..8efd7868da77 100644 --- a/src/proto_007_PsDELPH1/lib_client/protocol_client_context.ml +++ b/src/proto_007_PsDELPH1/lib_client/protocol_client_context.ml @@ -259,6 +259,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_008_PtEdo2Zk/lib_client/protocol_client_context.ml b/src/proto_008_PtEdo2Zk/lib_client/protocol_client_context.ml index 8ed4e4b8c167..0efc305581c8 100644 --- a/src/proto_008_PtEdo2Zk/lib_client/protocol_client_context.ml +++ b/src/proto_008_PtEdo2Zk/lib_client/protocol_client_context.ml @@ -262,6 +262,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_009_PsFLoren/lib_client/protocol_client_context.ml b/src/proto_009_PsFLoren/lib_client/protocol_client_context.ml index 1ca2a65141fc..4bcf65448910 100644 --- a/src/proto_009_PsFLoren/lib_client/protocol_client_context.ml +++ b/src/proto_009_PsFLoren/lib_client/protocol_client_context.ml @@ -262,6 +262,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_010_PtGRANAD/lib_client/protocol_client_context.ml b/src/proto_010_PtGRANAD/lib_client/protocol_client_context.ml index c5ace46f8ca0..4fd9948424e3 100644 --- a/src/proto_010_PtGRANAD/lib_client/protocol_client_context.ml +++ b/src/proto_010_PtGRANAD/lib_client/protocol_client_context.ml @@ -262,6 +262,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_011_PtHangz2/lib_client/protocol_client_context.ml b/src/proto_011_PtHangz2/lib_client/protocol_client_context.ml index cf448061890f..64ef8cf5185a 100644 --- a/src/proto_011_PtHangz2/lib_client/protocol_client_context.ml +++ b/src/proto_011_PtHangz2/lib_client/protocol_client_context.ml @@ -262,6 +262,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_012_Psithaca/lib_client/protocol_client_context.ml b/src/proto_012_Psithaca/lib_client/protocol_client_context.ml index de61519f47ec..0b0898a4b8ea 100644 --- a/src/proto_012_Psithaca/lib_client/protocol_client_context.ml +++ b/src/proto_012_Psithaca/lib_client/protocol_client_context.ml @@ -251,6 +251,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_013_PtJakart/lib_client/protocol_client_context.ml b/src/proto_013_PtJakart/lib_client/protocol_client_context.ml index 36a706f815e6..63e96de76b26 100644 --- a/src/proto_013_PtJakart/lib_client/protocol_client_context.ml +++ b/src/proto_013_PtJakart/lib_client/protocol_client_context.ml @@ -246,6 +246,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_014_PtKathma/lib_client/protocol_client_context.ml b/src/proto_014_PtKathma/lib_client/protocol_client_context.ml index f98be0dfceb6..53b33d9a99b8 100644 --- a/src/proto_014_PtKathma/lib_client/protocol_client_context.ml +++ b/src/proto_014_PtKathma/lib_client/protocol_client_context.ml @@ -246,6 +246,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_015_PtLimaPt/lib_client/protocol_client_context.ml b/src/proto_015_PtLimaPt/lib_client/protocol_client_context.ml index fdf1b41ff26f..53633401fea7 100644 --- a/src/proto_015_PtLimaPt/lib_client/protocol_client_context.ml +++ b/src/proto_015_PtLimaPt/lib_client/protocol_client_context.ml @@ -246,6 +246,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_016_PtMumbai/lib_client/protocol_client_context.ml b/src/proto_016_PtMumbai/lib_client/protocol_client_context.ml index 3c9fbd954b40..d9f93e27cf1e 100644 --- a/src/proto_016_PtMumbai/lib_client/protocol_client_context.ml +++ b/src/proto_016_PtMumbai/lib_client/protocol_client_context.ml @@ -246,6 +246,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_017_PtNairob/lib_client/protocol_client_context.ml b/src/proto_017_PtNairob/lib_client/protocol_client_context.ml index 4fe07ce4465b..57e7e9c98f91 100644 --- a/src/proto_017_PtNairob/lib_client/protocol_client_context.ml +++ b/src/proto_017_PtNairob/lib_client/protocol_client_context.ml @@ -359,6 +359,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_018_Proxford/lib_client/protocol_client_context.ml b/src/proto_018_Proxford/lib_client/protocol_client_context.ml index 7b31098eab55..613cc8718583 100644 --- a/src/proto_018_Proxford/lib_client/protocol_client_context.ml +++ b/src/proto_018_Proxford/lib_client/protocol_client_context.ml @@ -335,6 +335,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_019_PtParisB/lib_client/protocol_client_context.ml b/src/proto_019_PtParisB/lib_client/protocol_client_context.ml index e9ccd074662d..9c2e3b986fc8 100644 --- a/src/proto_019_PtParisB/lib_client/protocol_client_context.ml +++ b/src/proto_019_PtParisB/lib_client/protocol_client_context.ml @@ -328,6 +328,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_020_PsParisC/lib_client/protocol_client_context.ml b/src/proto_020_PsParisC/lib_client/protocol_client_context.ml index e9ccd074662d..9c2e3b986fc8 100644 --- a/src/proto_020_PsParisC/lib_client/protocol_client_context.ml +++ b/src/proto_020_PsParisC/lib_client/protocol_client_context.ml @@ -328,6 +328,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_021_PsQuebec/lib_client/protocol_client_context.ml b/src/proto_021_PsQuebec/lib_client/protocol_client_context.ml index 8fe20cb2b646..19f5c940b8bf 100644 --- a/src/proto_021_PsQuebec/lib_client/protocol_client_context.ml +++ b/src/proto_021_PsQuebec/lib_client/protocol_client_context.ml @@ -311,6 +311,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_022_PsRiotum/lib_client/protocol_client_context.ml b/src/proto_022_PsRiotum/lib_client/protocol_client_context.ml index 8fe20cb2b646..19f5c940b8bf 100644 --- a/src/proto_022_PsRiotum/lib_client/protocol_client_context.ml +++ b/src/proto_022_PsRiotum/lib_client/protocol_client_context.ml @@ -311,6 +311,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding diff --git a/src/proto_alpha/lib_client/protocol_client_context.ml b/src/proto_alpha/lib_client/protocol_client_context.ml index 88f51735a709..85e5af658410 100644 --- a/src/proto_alpha/lib_client/protocol_client_context.ml +++ b/src/proto_alpha/lib_client/protocol_client_context.ml @@ -316,6 +316,6 @@ let () = "errors" [] ~description: - "The full list of RPC errors would be too long to include.It is\n\ + "The full list of RPC errors would be too long to include. It is\n\ available through the RPC `/errors` (GET)." error_encoding -- GitLab From 0244030440c18c0afabe270d0dd46a6c24645e75 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 26 Mar 2025 17:54:25 +0100 Subject: [PATCH 06/12] doc: clarify that contract calls are executed after the caller contract --- docs/alpha/michelson.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/alpha/michelson.rst b/docs/alpha/michelson.rst index cb7d6111f98b..efcd03214d8b 100644 --- a/docs/alpha/michelson.rst +++ b/docs/alpha/michelson.rst @@ -109,7 +109,8 @@ The subset of blockchain operations that can be emitted by Michelson programs as Internal operations are not included in any block, and are not signed. -Internal operations are run in an atomic sequence with the external operation who generated them, right after it, in depth-first order. +Internal operations are run in an atomic sequence with the external operation who triggered the contract call, *after* the contract execution, in depth-first order. +This implies in particular that any contract calls emitted by a contract C are executed after contract C successfully finishes execution returning its result (the list of internal operations and the new storage). Note that :ref:`manager operations batches ` contain a sequence of external operations signed as a whole by a source user account, which are executed atomically. For example, in case of a batch of two external operations, execution proceeds as follows: -- GitLab From 020bcf485814c7c4c551dd8e36910051e583bffd Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 27 Mar 2025 10:17:24 +0100 Subject: [PATCH 07/12] doc: handle user feedback on dal_overview.rst --- docs/shell/dal_overview.rst | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/shell/dal_overview.rst b/docs/shell/dal_overview.rst index aa22e2701d0c..298255d6a3c3 100644 --- a/docs/shell/dal_overview.rst +++ b/docs/shell/dal_overview.rst @@ -4,20 +4,19 @@ DAL overview The *Data-Availability Layer* (DAL) enables users to publish blobs of data outside of the Tezos Layer 1 (L1) blocks. A blob (for “binary -large object”) is a piece of data in binary form. While the primary -use case for these blobs is to store Layer 2 (L2) operations for Tezos -smart rollups, it is important to note that the DAL is more generic +large object”) is a piece of data in binary form. Currently, the primary +use case for these blobs is to represent Layer 2 (L2) operations for Tezos +smart rollups, but the DAL is more generic and could be used for other use cases in the future. -In practice, the DAL employs an additional P2P protocol to publish -blobs, enabling a better bandwidth sharing between the peers (further -elaborated in the P2P section below). The DAL aims to support a -bandwidth of 10 MiB/s, a stark contrast to the current situation on +In practice, the DAL is implemented by a network of *DAL nodes*, constituting a *DAL network*. +The DAL network employs a P2P protocol to publish blobs +(distinct from :doc:`the P2P layer used by the Octez node <../shell/p2p>`), enabling a better bandwidth sharing between the peers (further +elaborated in the P2P section below). The DAL currently supports a +data bandwidth of 0.5MiB/s, a stark contrast to the current situation on L1, which has an approximate bandwidth of 32 KiB/s. This highlights the significant boost in bandwidth provided by the DAL. - -Thanks to the DAL, the data bandwidth constraints imposed by the L1 -block size are put back by several orders of magnitudes. This +Furthermore, the DAL aims to put back by several orders of magnitudes the data bandwidth constraints imposed by the L1 block size, up to 100MiB/s. This translates into reduced fees for users when posting L2 operations without compromising the fundamental principle of decentralization. @@ -28,7 +27,7 @@ those data through the participation of bakers. Similarly to the Tezos L1, the DAL is permissionless, enabling any user to effectively contribute data to it, and allowing any smart -rollup kernel or smart rollup operator to access this data. +rollup kernel to access this data. .. |DAL overview| image:: dal_overview.png @@ -40,8 +39,8 @@ DAL as follows: The diagram depicts a scenario where a user intends to upload data for a dedicated rollup. -Anyone engaging with the DAL must utilize a tool known as the *DAL -node* (named ``octez-dal-node``). When a user decides to provide a new +Anyone engaging with the DAL must utilize a DAL +node, implemented by a binary named ``octez-dal-node``. When a user decides to provide a new blob to the DAL (depicted as step 1 in the diagram), the user transmits the data to the DAL node to calculate a commitment to the data. This commitment is then communicated to L1 via a dedicated @@ -54,17 +53,17 @@ economic protocol. Hence, the bakers, also connected to the DAL network, retrieve these assigned shards (step 5). The bakers must download and verify these shards within a specific timeframe, precisely defined by the economic protocol as the ``attestation lag`` -period. At the end of the attestation lag period, bakers declare using +period (see :ref:`dal_constants`). At the end of the attestation lag period, bakers declare using an optional field of the consensus attestation operation, whether they were able to download the shards effectively (illustrated in step 6). The economic protocol collates these attestations and, if a sufficient number of bakers have -successfully obtained the shards, the data is declared as available -(step 7). Only when the data is labeled as available can the rollup +successfully obtained the shards, the blob is declared as available +(step 7). Only when the blob is labeled as available can the rollup utilize it (represented as step 8). The rationale for having the attestation lag parameter is to give -bakers sufficient time to download their assigned shards and to -guarantee that the latency stays within acceptable limits (around one +bakers sufficient time to download their assigned shards, while +guaranteeing that the latency of publishing blobs stays within acceptable limits (around one minute). -- GitLab From dd8b579de84a2f053ba096954c62f16c1a0a90ec Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 27 Mar 2025 11:15:35 +0100 Subject: [PATCH 08/12] doc: fix link from services.rst to package install --- docs/introduction/howtoget.rst | 5 +++++ docs/introduction/services.rst | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index a08782696880..edb51cee47f0 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -52,6 +52,11 @@ However, if you encounter problems when performing one of the installation scena .. _installing_packages: +Installing binary packages +-------------------------- + +.. _installing_deb: + Ubuntu and Debian Octez packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/introduction/services.rst b/docs/introduction/services.rst index 49712a4b19bd..c0b6010b7853 100644 --- a/docs/introduction/services.rst +++ b/docs/introduction/services.rst @@ -54,7 +54,7 @@ Using the official deb or rpm packages offers several advantages: Installing Octez ---------------- -First of all, you must :ref:`install Octez from binary packages `, as explained in the installation tutorial. +First of all, you must :ref:`install Octez from binary packages `, as explained in the installation tutorial. To make things concrete, we are assuming here that you installed Octez Debian packages, but most commands should apply to other distributions. @@ -102,7 +102,7 @@ Once the node is configured, we can use ``systemd`` to start the daemon: sudo systemctl start octez-node If configured to do so during package installation, this will automatically download a snapshot -and import it before starting the ``octez-node`` service. +and import it before starting the ``octez-node`` service (starting with v22 packages). We can check the status of the daemon in the logs of the node that are stored by default in ``/var/log/tezos/node.log``. Logs are -- GitLab From 91f9995aebecaeed1e98c7dea8019ef0eeee61cb Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 27 Mar 2025 12:43:45 +0100 Subject: [PATCH 09/12] doc: instruction on services restarting --- docs/introduction/howtoget.rst | 7 +++++++ docs/introduction/services.rst | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index edb51cee47f0..02e5262c1026 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -108,6 +108,9 @@ To remove the Octez packages you can simply run the following command. If migrating from Serokell packages you can check out migration documentation :doc:`./serokell`. +To upgrade packages, use ``apt-get update`` and ``apt-get upgrade``. +If runnning Octez as services, see also how to :ref:`restart them `. + .. _installing_rpm: Fedora Octez packages @@ -166,6 +169,10 @@ To remove the Octez packages you can simply run the following command. :language: shell :start-after: [test autopurge] +To upgrade packages, use ``dnf update``. +If runnning Octez as services, see also how to :ref:`restart them `. + + .. _getting_static_binaries: Getting static binaries diff --git a/docs/introduction/services.rst b/docs/introduction/services.rst index c0b6010b7853..6c2585d02ad6 100644 --- a/docs/introduction/services.rst +++ b/docs/introduction/services.rst @@ -213,6 +213,9 @@ shipped with the package. The logs of the baker are available in ``/var/log/tezos/baker-.log``. + +.. _services_upgrade: + Upgrading Octez --------------- @@ -232,3 +235,7 @@ changes in governance. Mind reloading the new services using ``sudo systemctl daemon-reload`` and then restarting the running services using ``sudo systemctl restart ``. +When doing so: + +- Always make sure that all binaries or packages are on the same version of Octez. +- The restart order should follow the dependency order: (i) Octez node, (ii) DAL node, (iii) baker, (iv) accuser (if running one). -- GitLab From cbe450e492b08212ee2147da2d5e6e4abfe2584e Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Mon, 31 Mar 2025 15:42:19 -0400 Subject: [PATCH 10/12] doc: link to staking tutorial and correct target doc name --- docs/alpha/staking.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index 420a9b081939..50baf482c31a 100644 --- a/docs/alpha/staking.rst +++ b/docs/alpha/staking.rst @@ -1,5 +1,7 @@ .. note:: + For information about how to stake, see `Staking `__ on docs.tezos.com. + For operational details about the staking mechanism and its configuration, see `a staking mechanism tutorial `__. ================= -- GitLab From e7c05b48e4a9b05f555a67e109e8e7b0d02e543f Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 2 Apr 2025 16:00:10 +0200 Subject: [PATCH 11/12] doc: move ad of binary packages from services to howtoget --- docs/introduction/howtoget.rst | 48 +++++++++++++++++++++++++++++++--- docs/introduction/services.rst | 43 ------------------------------ 2 files changed, 44 insertions(+), 47 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 02e5262c1026..4c10411770c2 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -55,12 +55,52 @@ However, if you encounter problems when performing one of the installation scena Installing binary packages -------------------------- +When it comes to installing software, especially for critical +applications like Tezos/Octez, it’s crucial to ensure a secure and +stable environment. While compiling from source can provide +customization options, it often introduces complexities and risks. +Instead, opting for binary packages sucha as Deb or RPM packages from a trusted source simplifies +installation and enhances security. + +Deb or RPM packages compiled for a specific platform should be always preferred +over statically compiled binaries. Deb or RPM packages can also be used to +simplify the creation of `OCI `__ images or simply +deployed on bare metal using provisioning tools such as +`Ansible `__. + +Using the official Deb or RPM packages offers several advantages: + +- **Security**: Packages are pre-compiled and thoroughly tested, + reducing the risk of vulnerabilities introduced during compilation. + All our packages are signed and our supply chain is strictly + monitored to make sure the packages that we deliver only use + components that were vetted by our engineering team. + +- **Stability**: Packages from a trusted repository undergo rigorous testing, + ensuring stability and compatibility with the target system. We make sure to + compile our binaries in a clean environment and using an up-to-date software + distribution. We use LTS (long-term service) distributions to enhance + stability and reduce the attack surface. + +- **Ease of Installation**: Packages can be installed using standard package + management tools, streamlining the process. For instance, ``apt`` is + ubiquitous in the Debian world. These tools allow us to sign our packages + that can be automatically verified by the end user during installation. We + provide packages that allow the end user to easily tailor their installation + for different use cases. + +- **Reduced Downtime**: With reliable binaries and straightforward + installation, system downtime due to installation errors or + compatibility issues is minimized. We carefully test the upgrade + process of our packages to make sure that end users can enjoy a click and go + upgrade process with near to zero downtime. + .. _installing_deb: Ubuntu and Debian Octez packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you're using Ubuntu or Debian, you can install the packages +If you're using Ubuntu or Debian, you can install the Deb packages using ``apt`` directly from our APT repository. We support the following distribution/releases: @@ -113,10 +153,10 @@ If runnning Octez as services, see also how to :ref:`restart them Date: Wed, 2 Apr 2025 17:05:53 +0200 Subject: [PATCH 12/12] Packages: endorsement is actually attestation --- scripts/packaging/octez/manpages/octez-baker.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/packaging/octez/manpages/octez-baker.1 b/scripts/packaging/octez/manpages/octez-baker.1 index 83919f2823ff..c5bfc961967a 100644 --- a/scripts/packaging/octez/manpages/octez-baker.1 +++ b/scripts/packaging/octez/manpages/octez-baker.1 @@ -10,7 +10,7 @@ octez-baker \- Octez Baker Daemon .SH DESCRIPTION .B octez-baker includes the necessary tools and functionalities for participating in the -baking process, such as block creation, endorsement, and protocol-specific +baking process, such as block creation, attestations, and protocol-specific consensus mechanisms. .SH OPTIONS -- GitLab