diff --git a/CHANGES.rst b/CHANGES.rst index ccf6be7ffc23944f21707546a1e4180e5d4d781c..a16ebcdaff6fa0ce3439f7edd466c5e3478161de 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,7 +1,7 @@ Development Changelog ''''''''''''''''''''' -**NB:** The changelog for releases can be found at: https://tezos.gitlab.io/CHANGES.html +**NB:** The changelog for releases can be found at: https://octez.tezos.com/docs/CHANGES.html This file lists the changes added to each version of octez-node, diff --git a/README.md b/README.md index 6c20216b90b2ae282cebb9eb1645d3e4ce7c2329..29192061024b9d3222c545b36b8aa41ebf46f6ef 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ For more information about the project, see https://tezos.com. ## Getting started Instructions to -[install](https://tezos.gitlab.io/introduction/howtoget.html), [start -using](https://tezos.gitlab.io/introduction/howtouse.html), and +[install](https://octez.tezos.com/docs/introduction/howtoget.html), [start +using](https://octez.tezos.com/docs/introduction/howtouse.html), and [taking part in the -consensus](https://tezos.gitlab.io/introduction/howtorun.html) are -available at https://tezos.gitlab.io/. +consensus](https://octez.tezos.com/docs/introduction/howtorun.html) are +available at https://octez.tezos.com/docs/. ## The Tezos software @@ -28,11 +28,11 @@ In more detail, this git repository contains: The Tezos software may run either on the nodes of the main Tezos network (mainnet) or on [various Tezos test -networks](https://tezos.gitlab.io/introduction/test_networks.html). +networks](https://octez.tezos.com/docs/introduction/test_networks.html). The documentation for developers, including developers of the Tezos software and developer of Tezos applications and tools, is available -online at https://tezos.gitlab.io/. This documentation is always in +online at https://octez.tezos.com/docs/. This documentation is always in sync with the master branch which may however be slightly desynchronized with the code running on the live networks. @@ -47,7 +47,7 @@ All development of the Tezos code happens on GitLab at https://gitlab.com/tezos/tezos. Merge requests (https://gitlab.com/tezos/tezos/-/merge_requests) should usually target the `master` branch; see [the contribution -instructions](https://tezos.gitlab.io/developer/contributing.html). +instructions](https://octez.tezos.com/docs/developer/contributing.html). The issue tracker at https://gitlab.com/tezos/tezos/issues can be used to report bugs and to request new simple features. The [Tezos Agora @@ -71,11 +71,11 @@ The core of the Tezos software that implements the economic ruleset is called the *protocol*. Unlike the rest of the source code, updates to the protocol must be further adopted through the [Tezos on-chain voting -procedure](https://tezos.gitlab.io/whitedoc/voting.html). Protocol +procedure](https://octez.tezos.com/docs/active/voting.html). Protocol contributors are encouraged to synchronize their contributions to minimize the number of protocol proposals that the stakeholders have to study and to maximize the throughput of the voting procedure. ## Community -Links to community websites are gathered at . +Links to community websites are gathered at . diff --git a/docs/alpha/adaptive_issuance.rst b/docs/alpha/adaptive_issuance.rst index 708d3f6d99ad40db723c24ad5581891342701891..47ce7d3309b5c1e79c13b982fd67febf829a65f5 100644 --- a/docs/alpha/adaptive_issuance.rst +++ b/docs/alpha/adaptive_issuance.rst @@ -433,7 +433,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``issuance_modification_delay`` cycles. diff --git a/docs/alpha/dal_support.rst b/docs/alpha/dal_support.rst index adf1d28f0e0c319cb0e16da92664f2010e9f942a..ab89063c65ae8d979ee28a2280a0da20687f5948 100644 --- a/docs/alpha/dal_support.rst +++ b/docs/alpha/dal_support.rst @@ -148,6 +148,7 @@ Penalties A baker that is correctly accused, through an accusation operation included in a block, loses their DAL rewards for the cycle containing the block. +.. _daL_rollups_integration: Smart Rollups integration ========================= diff --git a/docs/developer/error_monad_p3_advanced.rst b/docs/developer/error_monad_p3_advanced.rst index 2a46f600198a278463a0a5b5f53f1ad264b32c7d..00c5eb479306a347329b9703dc5ab8a6c570a432 100644 --- a/docs/developer/error_monad_p3_advanced.rst +++ b/docs/developer/error_monad_p3_advanced.rst @@ -213,8 +213,7 @@ you are registering: - ``Permanent``: is for irremediable failures, i.e., failures that happen and will always happen whatever the context. E.g., - `originating a - contract `__ + :ref:`originating a contract ` that does not type-check is a permanent error. This is used by the shell to mark the data as invalid. diff --git a/docs/developer/images/rpc.excalidraw b/docs/developer/images/rpc.excalidraw index 741e896b2a2b6c49822de7c70345e0c15ebde783..ec8ba50a2f096672fcf7bda2ae9aa4488202dfc9 100644 --- a/docs/developer/images/rpc.excalidraw +++ b/docs/developer/images/rpc.excalidraw @@ -2094,11 +2094,11 @@ "locked": false, "fontSize": 28, "fontFamily": 3, - "text": "Images used in https://tezos.gitlab.io/developer/rpc.html", + "text": "Images used in https://octez.tezos.com/docsab.io/developer/rpc.html", "textAlign": "left", "verticalAlign": "top", "containerId": null, - "originalText": "Images used in https://tezos.gitlab.io/developer/rpc.html", + "originalText": "Images used in https://octez.tezos.com/docsab.io/developer/rpc.html", "autoResize": true, "lineHeight": 1.2 }, diff --git a/docs/developer/python_environment.rst b/docs/developer/python_environment.rst index 96110e8a36fa56056c7959ec6c3b6d6a7a7a9ad6..89b973a2ddab5748559e5fef9df7d98b3e885371 100644 --- a/docs/developer/python_environment.rst +++ b/docs/developer/python_environment.rst @@ -1,7 +1,7 @@ Python Environment ================== -Octez uses Python to build this documentation website (:doc:`https://tezos.gitlab.io <../index>`) and for a limited set of +Octez uses Python to build this documentation website (:doc:`https://octez.tezos.com/docs/ <../index>`) and for a limited set of utility scripts (although this latter usage of Python is deprecated). This page contains installation instructions for the Python environment. diff --git a/docs/developer/rollup_metrics.csv b/docs/developer/rollup_metrics.csv new file mode 100644 index 0000000000000000000000000000000000000000..f37ff059bc1f63959a94ffc0e1c5caf182a20fb6 --- /dev/null +++ b/docs/developer/rollup_metrics.csv @@ -0,0 +1,35 @@ +Name,Type,Description,Labels +octez_sc_rollup_node_batcher_batches_size,Gauge,"Batcher batches sent", +octez_sc_rollup_node_batcher_get_time,Gauge,"Time to fetch batches", +octez_sc_rollup_node_batcher_inject_time,Gauge,"Time to inject batches", +octez_sc_rollup_node_batcher_last_batch_level,Gauge,"Last batch level", +octez_sc_rollup_node_batcher_last_batch_time,Gauge,"Last batch time", +octez_sc_rollup_node_batcher_message_queue_size,Gauge,"Batcher message queue size", +octez_sc_rollup_node_batcher_messages_size,Gauge,"Batcher messages size in batches", +octez_sc_rollup_node_block_timeout,Gauge,"Number of block before player timeout",opponent;start_level +octez_sc_rollup_node_challenge_window,Gauge,"Current challenge window", +octez_sc_rollup_node_commitment_period,Gauge,"Current commitment period", +octez_sc_rollup_node_dal_attestation_lag,Gauge,"DAL attestation lag", +octez_sc_rollup_node_dal_batcher_queue_length,Gauge,"Number of messages waiting for publication on the DAL", +octez_sc_rollup_node_dal_enabled,Gauge,"DAL enabled in protocol", +octez_sc_rollup_node_dal_injections_queue_length,Gauge,"Number of recently published DAL slots, who have not yet been forgotten", +octez_sc_rollup_node_dal_number_of_slots,Gauge,"DAL number of slots", +octez_sc_rollup_node_gc_oldest_available_level,Gauge,"Oldest Available Level after GC", +octez_sc_rollup_node_gc_process_time,Gauge,"GC processing time", +octez_sc_rollup_node_inbox_external_messages_number,Gauge,"Number of external messages in inbox", +octez_sc_rollup_node_inbox_fetch_time,Gauge,"The time the rollup node spent fetching the inbox", +octez_sc_rollup_node_inbox_internal_messages_number,Gauge,"Number of internal messages in inbox", +octez_sc_rollup_node_inbox_level,Gauge,"Level of last inbox", +octez_sc_rollup_node_inbox_process_time,Gauge,"The time the rollup node spent processing the head", +octez_sc_rollup_node_inbox_total_time,Gauge,"The total time the rollup node spent handling the inbox", +octez_sc_rollup_node_lcc_level_l1,Gauge,"Last cemented commitment level on L1", +octez_sc_rollup_node_lcc_level_local,Gauge,"Last cemented commitment level locally", +octez_sc_rollup_node_lpc_level_l1,Gauge,"Last published commitment on L1", +octez_sc_rollup_node_lpc_level_local,Gauge,"Last published commitment by operator", +octez_sc_rollup_node_node_info,Counter,"General information on the node",version;commit_hash;commit_date +octez_sc_rollup_node_number_of_conflicts,Gauge,"Number of conflicts", +octez_sc_rollup_node_protocol,Counter,"Rollup node current protocol",protocol +octez_sc_rollup_node_rollup_node_info,Counter,"Rollup node info",rollup_address;mode;genesis_level;genesis_hash;pvm_kind;history_mode +octez_sc_rollup_node_state_of_refutation_game,Gauge,"State of refutation game",opponent;start_level + + diff --git a/docs/michelson/michelson-meta.yaml b/docs/michelson/michelson-meta.yaml index a0266e5c23e8d742789634be9e6b2c910f9b0860..e6f821a6bcc29777b2b537a3acc93970276a2a78 100644 --- a/docs/michelson/michelson-meta.yaml +++ b/docs/michelson/michelson-meta.yaml @@ -709,7 +709,7 @@ instructions: The ``CONTRACT ty`` instruction has a variant ``CONTRACT %entrypoint ty``. It allows the specification of a specific - `entrypoint `_. + `entrypoint `_. In addition to the requirements above, this variant is only well-typed if the address is a contract with an entrypoint named ``%entrypoint``. This works as follows: @@ -1141,7 +1141,7 @@ instructions: documentation_short: Create an implicit account documentation: | Push on the stack the contract value corresponding to the - `implicit account `_ + `implicit account `_ of a public key hash. These contracts always have type ``unit``. ITER: @@ -1403,7 +1403,7 @@ instructions: the ``SELF`` instruction has a variant ``SELF %entrypoint``, that is only well-typed if the current contract has an entrypoint named ``%entrypoint``. It returns the ``contract ty1`` corresponding to a specific - `entrypoint `_ + `entrypoint `_ of the current contract, where ``ty1`` is the type of the ``%entrypoint``. Unlike for ``CONTRACT``, ``SELF %default`` is allowed and is strictly equal to ``SELF``. @@ -1785,7 +1785,7 @@ instructions: Lastly the instruction pushes the updated state and balance as an ``option`` on the stack. - Please see the `Sapling integration `_ + Please see the `Sapling integration `_ page for a more comprehensive description of the Sapling protocol. SAPLING_EMPTY_STATE: @@ -1796,7 +1796,7 @@ instructions: ``SAPLING_EMPTY_STATE ms`` pushes the empty Sapling state (i.e. no one can spend tokens from it) with memo size ``ms``. - Please see the `Sapling integration `_ + Please see the `Sapling integration `_ page for a more comprehensive description of the Sapling protocol. TICKET: @@ -2382,7 +2382,7 @@ types: ``sapling_transaction_deprecated ms`` is the type of Sapling transactions of memo-size ``ms``. - Please see the `Sapling integration `_ + Please see the `Sapling integration `_ page for a more comprehensive description of the Sapling protocol. insertions: - 'sapling_transaction_deprecated 8' @@ -2401,7 +2401,7 @@ types: ``sapling_state ms`` is the type of Sapling states of memo-size ``ms``. - Please see the `Sapling integration `_ + Please see the `Sapling integration `_ page for a more comprehensive description of the Sapling protocol. examples: - ['{}', 'sapling_state 8'] diff --git a/docs/protocols/020_paris.rst b/docs/protocols/020_paris.rst index 656559a4aa197e85abb22ffb5293166a1351b4ff..1a604eb547b174533258b271f985ed26204ab8fb 100644 --- a/docs/protocols/020_paris.rst +++ b/docs/protocols/020_paris.rst @@ -38,8 +38,8 @@ Data Availability Layer network. Do note that this operation itself does not contain the data themselves. Instead, it contains the slot index, the commitment over the data, and a proof regarding the size for those data. The data must be sent using the - DAL node. For more information on how it works, please read the `DAL - documentation `_. + DAL node. For more information on how it works, please read the :doc:`DAL + documentation <../shell/dal>`. - Optimize the DAL commitment publication operation by memoizing the cryptobox. (MR :gl:`!11594`) @@ -50,8 +50,7 @@ Data Availability Layer enables kernel to read the DAL parameters. This should ease the writing of smart rollups kernels to make them generic over the values of those parameters. For more information on how it works, - please read the `DAL smart rollup integration - `_. + please read :ref:`dal_rollups_integration`. Adaptive Issuance @@ -117,8 +116,8 @@ Breaking Changes - A new ``dal_attestation`` field has been added to the ``block_metadata`` indicating the attested slots. The slots being attested are the slots that were published ``attestation_lag`` levels - ago (MRs :gl:`!11903`, :gl:`!12063`) (see `DAL documentation - `_ for more context). + ago (MRs :gl:`!11903`, :gl:`!12063`) (see :doc:`DAL documentation + <../shell/dal>` for more context). - The protocol no longer relies on stake snapshots to compute rights. Instead: diff --git a/docs/protocols/021_quebec.rst b/docs/protocols/021_quebec.rst index 8b2be0a6e5b671bce9ba7c513e8143d7a25bc540..5424402bff65cc315189d22e6c020768883339d8 100644 --- a/docs/protocols/021_quebec.rst +++ b/docs/protocols/021_quebec.rst @@ -89,7 +89,7 @@ RPC Changes - In the following paths, ``../`` is short for ``/chains//blocks//context/delegates//``. - See https://tezos.gitlab.io/quebec/baking_power.html for more + See :doc:`../active/baking_power` for more details on the renamed and new RPCs. * Renamed RPC ``GET ../current_frozen_deposits`` to ``GET diff --git a/docs/quebec/adaptive_issuance.rst b/docs/quebec/adaptive_issuance.rst index a0dbdc9579e39ad4dc4bad6a7d04ce2b0cfd836c..d7d09cc16b4f60b1eb3cad34b0cd33b269b8c83c 100644 --- a/docs/quebec/adaptive_issuance.rst +++ b/docs/quebec/adaptive_issuance.rst @@ -437,7 +437,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``consensus_rights_delay`` cycles. diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index ca748609e3470ba31df7183aca4a6522eb6d1683..07da9fefcdfcee3fa6f82692f88a9651ff6b1229 100644 --- a/docs/releases/version-20.rst +++ b/docs/releases/version-20.rst @@ -54,7 +54,7 @@ Some deprecated RPCs have been removed. Please check `the changelog <../CHANGES. The RPC ``/health/ready`` has been introduced to get the status of the RPC server. -Starting from Octez v20, we strongly advise nodes and bakers operators to synchronise their clocks using NTP as issued in `the node section of getting started `__. +Starting from Octez v20, we strongly advise nodes and bakers operators to synchronise their clocks using NTP as issued in :ref:`start_node`. Smart rollup ~~~~~~~~~~~~ diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index a4cd22a8da02eaebb7f9de00ac2eba304f03652b..5bcfded4313556d0824307700081d35ed3a27d41 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -69,7 +69,7 @@ corresponding modes of an accompanying smart rollup node. The binary encoding of ``/config/netwok/dal`` changed. As a result, the v21 DAL node is not compatible with earlier versions of Octez -- it cannot interact with earlier versioned Octez nodes. If you are operating a Tezos DAL node, make sure to upgrade all Octez infra to v21.1 (or at least v21.0). - Also, for attesters, it is recommended that they start their DAL node using the argument ``--attester-profiles=`` where is the attester's address (not the alias). + Also, for attesters, it is recommended that they start their DAL node using the argument ``--attester-profile=`` where is the attester's address (not the alias). Octez v21.1 contains several improvements concerning the DAL, mainly concerning network reliability and diagnostics enabling bakers to detect more easily whether their DAL node is working as expected. In particular, the DAL node now does the following. diff --git a/docs/releases/version-22.rst b/docs/releases/version-22.rst index 66f04b6fad6afe23bbceb2f70f9532115e116dc9..62c9916ee3b114a805d3d3a9c9d2730b88d46eb2 100644 --- a/docs/releases/version-22.rst +++ b/docs/releases/version-22.rst @@ -9,7 +9,7 @@ Summary Version 22 introduces the following changes or new features: (1) Support of the **Rio Protocol proposal** (See :ref:`the protocol support section `) - (2) Source code is compiled with **OCaml 5 compiler** (See :ref:`the compiler version section `) + (2) Source code is compiled with the **OCaml 5 compiler** (See :ref:`the compiler version section `) (3) The baker requires an endpoint of a running DAL node or the ``--without-dal`` option to start. (See :ref:`the DAL node section `) (4) The default :doc:`history mode <../user/history_modes>` is now ``Rolling`` instead of ``Full``. (5) **New experimental agnostic baker executable**. (See :ref:`the experimental agnostic baker section `) @@ -32,8 +32,8 @@ Starting from Octez version 22, the source code can be compiled with version 5 o .. _dal_node_v22: -DAL Node -~~~~~~~~ +DAL operations and Bakers +~~~~~~~~~~~~~~~~~~~~~~~~~ The baker option ``--without-dal``, introduced in :doc:`Octez-v21.3 `, is now **mandatory** if not providing an endpoint of a DAL node. @@ -51,7 +51,7 @@ The Agnostic Baker is a protocol-independent binary that dynamically determines It continuously monitors the blockchain state and automatically transitions to the correct binary whenever a new protocol is detected by the node, such as during migrations or at startup. -The v22 agnostic is **EXPERIMENTAL ONLY** and should **NOT** be used on ``mainnet``. +The v22 agnostic baker is **EXPERIMENTAL ONLY** and should **NOT** be used on ``mainnet``. You can use the agnostic baker on test networks and give feedback. You can find more information on the agnostic baker in the corresponding :src:`README ` file. @@ -97,7 +97,7 @@ Packages In Octez v22, the new set of packages, that was introduced in the previous version of Octez, **replaces** the old one in the APT repository. Check :ref:`the documentation ` for more details. Therefore, upgrading to the new packages is done as usual with ``apt``. -Note just that the handling of Zcash parameters is done automatically in the new packages, hence the need to overwrite the old settings:: +Note however that the Zcash parameters are in a different package now, which needs to overwrite files from the old package:: $ sudo apt update $ sudo apt upgrade octez-baker -o DPkg::options::="--force-overwrite" diff --git a/docs/rio/adaptive_issuance.rst b/docs/rio/adaptive_issuance.rst index 8f728cce48e03e9a515f04676e224fe967aeddb1..8463021a09f77912e3b1a0541cddcac018bf2c58 100644 --- a/docs/rio/adaptive_issuance.rst +++ b/docs/rio/adaptive_issuance.rst @@ -433,7 +433,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``issuance_modification_delay`` cycles. diff --git a/docs/scripts/extract_content b/docs/scripts/extract_content index 9b5cf98a89720344968467405e1db6e5ebe645e5..3e5fe42364f897eddea8899aa3c063c3658dae60 100755 --- a/docs/scripts/extract_content +++ b/docs/scripts/extract_content @@ -26,7 +26,7 @@ if ($0 !~ /