From 6caf3db7c8e7a2a007d6389246205002e1a03a82 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 25 Mar 2024 18:45:31 +0100 Subject: [PATCH 1/6] doc: remove per-protocol pages for smart-rollup-node --- docs/Makefile | 5 +---- docs/alpha/cli-commands.rst | 6 ------ docs/oxford/cli-commands.rst | 6 ------ docs/paris/cli-commands.rst | 6 ------ 4 files changed, 1 insertion(+), 22 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index b626b3ad2765..2215263985e0 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -53,14 +53,11 @@ html: octez-gen docexes-gen @../octez-baker-$($(@D)_short) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > $@ %/octez-accuser.html: @../octez-accuser-$($(@D)_short) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > $@ -%/octez-smart-rollup-node.html: - @../octez-smart-rollup-node-$($(@D)_short) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > $@ manuals: \ $(PROTOCOLS:%=%/octez-client.html) \ $(PROTOCOLS:%=%/octez-baker.html) \ - $(PROTOCOLS:%=%/octez-accuser.html) \ - $(PROTOCOLS:%=%/octez-smart-rollup-node.html) + $(PROTOCOLS:%=%/octez-accuser.html) # generic @../octez-admin-client man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > api/octez-admin-client.html @../octez-signer man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > api/octez-signer.html diff --git a/docs/alpha/cli-commands.rst b/docs/alpha/cli-commands.rst index 420008c547f5..38bf04030e04 100644 --- a/docs/alpha/cli-commands.rst +++ b/docs/alpha/cli-commands.rst @@ -39,9 +39,3 @@ Accuser manual .. raw:: html :file: octez-accuser.html - -Smart rollup node manual -======================== - -.. raw:: html - :file: octez-smart-rollup-node.html diff --git a/docs/oxford/cli-commands.rst b/docs/oxford/cli-commands.rst index 4ff974257a9c..72682756c8f7 100644 --- a/docs/oxford/cli-commands.rst +++ b/docs/oxford/cli-commands.rst @@ -42,9 +42,3 @@ Accuser manual .. raw:: html :file: octez-accuser.html - -Smart rollup node manual -======================== - -.. raw:: html - :file: octez-smart-rollup-node.html diff --git a/docs/paris/cli-commands.rst b/docs/paris/cli-commands.rst index fdfc9319ba01..e759afd11657 100644 --- a/docs/paris/cli-commands.rst +++ b/docs/paris/cli-commands.rst @@ -39,9 +39,3 @@ Accuser manual .. raw:: html :file: octez-accuser.html - -Smart rollup node manual -======================== - -.. raw:: html - :file: octez-smart-rollup-node.html -- GitLab From 674adc8e82046a8133dc2f7afe4d1c745314163a Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Fri, 12 Apr 2024 10:29:45 -0400 Subject: [PATCH 2/6] doc: improvements in index.rst --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a2da105e929b..660c9c9ac33f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,10 +25,10 @@ capability. This means that, unlike other blockchains like Bitcoin or Ethereum, Tezos comes to consensus not only about the state of its ledger, but also about how the protocol and the nodes should adapt and upgrade. -This is a fundamental design choice, allowing Tezos to be seamlessly upgradable and continuosly evolving. +This is a fundamental design choice, allowing Tezos to be seamlessly upgradable and continuously evolving. Due to this feature, Tezos is built to last, and always stay at the leading edge of blockchain technology. -To learn more about Tezos, the `Tezos documentation `__. +To learn more about Tezos, see . To learn more about how Octez & the protocol fit into Tezos and its ecosystem, see :doc:`introduction/tezos`. @@ -40,9 +40,9 @@ To learn more about how Octez & the protocol fit into Tezos and its ecosystem, s Getting started
-**Newcomer to Octez?** Start participating to Tezos using Octez! +**Newcomer to Octez?** Start participating in Tezos using Octez! -Start participating to Tezos by following the ``Introduction`` section in the documentation menu. +Start participating in Tezos by following the ``Introduction`` section in the documentation menu. These tutorials explain: -- GitLab From 85f92b11f940f628b0ab67e789edd7cae1c111c7 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 12 Apr 2024 18:15:12 +0200 Subject: [PATCH 3/6] doc: fix target xrefscheck in docs/Makefile --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 2215263985e0..fec731838271 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -121,8 +121,8 @@ redirectcheck: # - on the active protocol using its numeric name (not the "active" symlink) # - on each other protocol including alpha, also checking label defs (option -l) xrefscheck: - $(CHECKXREFS) paris $(CHECKXREFS) oxford + $(CHECKXREFS) -l paris $(CHECKXREFS) -l alpha installcheck: -- GitLab From 6eb7332e7db7bb3461c5febe980f8f0b5e4e400b Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Mon, 15 Apr 2024 14:20:32 +0200 Subject: [PATCH 4/6] Docs/smart-rollup: fix label to multiple rollup batcher keys --- docs/releases/version-19.rst | 2 +- docs/shell/smart_rollup_node.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/releases/version-19.rst b/docs/releases/version-19.rst index f4348f590129..152299d06e25 100644 --- a/docs/releases/version-19.rst +++ b/docs/releases/version-19.rst @@ -70,7 +70,7 @@ The keys in the Smart Rollup client use the same format as the Octez client. They can be imported with ``octez-client import secret key ``, or by merging the key files between the ``octez-client`` base directory and the ``smart-rollup-client-`` base directory. -The Smart Rollup node now allows multiple :ref:`batcher keys `. Setting multiple +The Smart Rollup node now allows :ref:`multiple batcher keys `. Setting multiple keys for the batching purpose allows to inject multiple operations of the same kind per block by the rollup node. diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index dec66d33542f..323a481f80a4 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -194,8 +194,6 @@ First, we need to decide on a mode the rollup node will run: rollup node will accept transactions in its queue and batch them on the Layer 1. -.. _rollup_batcher: - #. ``batcher`` means that the rollup node will accept transactions in its queue and batch them on the Layer 1. In this mode, the rollup node follows the Layer 1 chain, but it does not update its state @@ -304,6 +302,8 @@ capping the number of L2 messages that the rollup node's batcher purpose can inject per block to the maximum size of one L1 operation's maximal size (e.g., 32kb on mainnet). +.. _rollup_batcher_keys: + To bypass that limitation and inject multiple ``smart_rollup_add_messages`` L1 operations within a single L1 block, it is possible to provide multiple keys for the batcher purpose of a -- GitLab From 8e581deafc36381f5a31bbe4a0c2b6c2733e1c80 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 22 Apr 2024 09:45:55 +0200 Subject: [PATCH 5/6] doc: update mention of smart rollup node openAPI --- docs/api/openapi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/openapi.rst b/docs/api/openapi.rst index 4e8776b0d701..4d7263651b6f 100644 --- a/docs/api/openapi.rst +++ b/docs/api/openapi.rst @@ -103,7 +103,7 @@ Oxford RPCs The OpenAPI specifications for the RPCs of the smart rollup node for the Oxford (``Proxford``) protocol can be found at: -- `oxford-smart-rollup-node-openapi.json (version 19.1) +- `oxford-smart-rollup-node-openapi.json (version 19.2) `_ - `oxford-smart-rollup-node-openapi.json (version 20.0~rc1) -- GitLab From 706266723e89f99b7fde334aef72344304f15b7e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 22 Apr 2024 11:37:47 +0200 Subject: [PATCH 6/6] doc: fix footnotes in rollup node manual --- docs/shell/smart_rollup_node.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index 323a481f80a4..31226dec7486 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -246,27 +246,26 @@ The table below summarises the modes and their associated purposes: +-------------+------------+----------+------------+------------+------------------+ | | Operating | Batching | Cementing | Recovering | Executing_outbox | +=============+============+==========+============+============+==================+ -| Operator | Yes | Yes | Yes | No | Yes[^1]_ | +| Operator | Yes | Yes | Yes | No | Yes [#f1]_ | +-------------+------------+----------+------------+------------+------------------+ -| Maintenance | Yes | No | Yes | No | Yes[^1]_ | +| Maintenance | Yes | No | Yes | No | Yes [#f1]_ | +-------------+------------+----------+------------+------------+------------------+ -| Bailout | Yes[^2]_ | No | Yes | Yes | No | +| Bailout | Yes [#f2]_ | No | Yes | Yes | No | +-------------+------------+----------+------------+------------+------------------+ -| Accuser | Yes [^3]_ | No | No | No | No | +| Accuser | Yes [#f3]_ | No | No | No | No | +-------------+------------+----------+------------+------------+------------------+ | Batcher | No | Yes | No | No | No | +-------------+------------+----------+------------+------------+------------------+ | Observer | No | No | No | No | No | +-------------+------------+----------+------------+------------+------------------+ -.. [^1] If and only it's a private rollup. In that case, only the +.. [#f1] If and only it's a private rollup. In that case, only the whitelist update outbox message are injected. -.. [^2] A rollup node in bailout mode won't publish any new commitments but only +.. [#f2] A rollup node in bailout mode won't publish any new commitments but only defends the one published by the operator if they are refuted. -.. [^3] An accuser node will publish commitments only when it detects +.. [#f3] An accuser node will publish commitments only when it detects conflicts; for such cases it must make a deposit of 10,000 tez. - Then to run the rollup node, use the following command: .. code:: sh @@ -309,9 +308,8 @@ To bypass that limitation and inject multiple it is possible to provide multiple keys for the batcher purpose of a rollup node. At each block, the rollup node will use as many keys as possible to inject a corresponding number of queued L2 messages into -the L1 rollup inbox[^1]. - -[^1]: The order of the batches of L2 messages is not guaranteed to be +the L1 rollup inbox. +The order of the batches of L2 messages is not guaranteed to be preserved by the rollup node nor by the octez node mempool. The way to provide multiple batcher keys on the command line is: -- GitLab