From 567b5bab012927ad7ba0b94b4c01fcb4224b5a54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Asbj=C3=B8rn=20Enge?= Date: Mon, 6 Feb 2023 09:53:38 +0100 Subject: [PATCH] Doc: Updates to SCORU docs --- docs/alpha/smart_rollups.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/alpha/smart_rollups.rst b/docs/alpha/smart_rollups.rst index 073903902022..b4a30399a349 100644 --- a/docs/alpha/smart_rollups.rst +++ b/docs/alpha/smart_rollups.rst @@ -314,11 +314,15 @@ a rollup node has been launched locally, typically by issuing: .. code:: sh octez-node config init --data-dir "${ONODE_DIR}" --network "${NETWORK}" - octez-node run --data-dir "${ONODE_DIR}" --network "${NETWORK}" --rpc-addr 127.0.0.1 + octez-node run --data-dir "${ONODE_DIR}" --network "${NETWORK}" --rpc-addr 127.0.0.1:8732 --allow-all-rpc 127.0.0.1:8732 --history-mode=archive in a terminal where ``${NETWORK}`` is of the form ``https://teztnets.xyz/dailynet-YYYY-MM-DD`` +(remember to replace YYYY-MM-DD with the relevant date) and ``${ONODE_DIR}`` is a path for the Octez node store. +We add ``--history-mode=archive`` in order to run the node in +archive mode. This is useful when running rollup nodes so we have +access to full block history. The commands will only work when ``proto_alpha`` is activated. This can be checked by: @@ -334,6 +338,9 @@ that must return: { "protocol": "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK", "next_protocol": "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK" } +Note that it might start out as a different protocol name at level 0, +but should update to the correct protocol at level 1024. + Finally, you need to check that your balance is greater than 10,000 tez to make sure that staking is possible. In case your balance is not sufficient, you can get test tokens from :ref:`a faucet `. @@ -425,8 +432,9 @@ Now that the rollup is originated, anyone can make it progress by deploying a rollup node. First, we need to decide on a directory where the rollup node stores -its data. Let us assign ``${ROLLUP_NODE_DIR}`` with this path. The -rollup node is configured with the following command: +its data. Let us assign ``${ROLLUP_NODE_DIR}`` with this path. The ``${OCLIENT_DIR}`` +is typically set to ``${ONODE_DIR}/client``. The rollup node is configured +with the following command: .. code:: sh @@ -519,7 +527,7 @@ Second, the configured rollup node can be run: .. code:: sh - octez-smart-rollup-node-alpha -d "${OCLIENT_DIR}" run --data-dir ${ROLLUP_NODE_DIR} + octez-smart-rollup-node-alpha --base-dir "${OCLIENT_DIR}" run --data-dir ${ROLLUP_NODE_DIR} The log should show that the rollup node follows the Layer 1 chain and processes the inbox of each level. -- GitLab