diff --git a/README.md b/README.md index 8e88d07c7..94184b9f2 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ tezos-setup You can also read [the dedicated article](./docs/baking.md) to find out more about this setup, the binaries, and the services used. -For setting up experimental transaction rollup node, see [this doc](./docs/tx-rollup.md). +For setting up experimental smart rollup node, see [this doc](./docs/smart-rollup.md). #### Voting on Ubuntu diff --git a/docker/package/defaults/tezos-rollup-node.conf b/docker/package/defaults/tezos-rollup-node.conf old mode 100644 new mode 100755 index eb34b28ed..ec8d4a679 --- a/docker/package/defaults/tezos-rollup-node.conf +++ b/docker/package/defaults/tezos-rollup-node.conf @@ -9,3 +9,4 @@ NODE_RPC_ADDR="localhost:8732" ROLLUP_NODE_RPC_ENDPOINT="127.0.0.1:8472" ROLLUP_MODE="observer" ROLLUP_ALIAS="rollup" +ROLLUP_OPERATORS="" diff --git a/docker/package/scripts/tezos-rollup-node-start b/docker/package/scripts/tezos-rollup-node-start old mode 100644 new mode 100755 index 3274b087e..9e5f2785e --- a/docker/package/scripts/tezos-rollup-node-start +++ b/docker/package/scripts/tezos-rollup-node-start @@ -7,12 +7,20 @@ set -euo pipefail # Note: the 'TEZOS_CLIENT_DIR' env var is expected and used by the rollup node # $PROTOCOL should be defined in the system unit environment -node="/usr/bin/octez-$TYPE-rollup-node-$PROTOCOL" +node="/usr/bin/octez-smart-rollup-node-$PROTOCOL" + +# By default this script runs init in observer mode, which +# does not require rollup operator. If you want to run this script in +# any other mode, you should provide at least one operator, using +# ROLLUP_OPERATORS env variable. "$node" init "$ROLLUP_MODE" config \ for "$ROLLUP_ALIAS" \ + with operators \ + "$ROLLUP_OPERATORS" \ --rpc-addr "$ROLLUP_NODE_RPC_ENDPOINT" \ --force "$node" --endpoint "$NODE_RPC_SCHEME://$NODE_RPC_ADDR" \ - run "$ROLLUP_MODE" for "$ROLLUP_ALIAS" & + run "$ROLLUP_MODE" for "$ROLLUP_ALIAS" \ + with operators $ROLLUP_OPERATORS diff --git a/docs/configuration.md b/docs/configuration.md index e87435d52..26296a924 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -98,9 +98,11 @@ aware of the change as well. | `PORT` | `tezos-signer-tcp` | Listening TCP port for the signer, e.g. `7732` | `tezos-signer-tcp` | | `TIMEOUT` | `tezos-signer-tcp` | Timeout used by the signer to close client connections (in seconds), e.g. `8` | `tezos-signer-tcp` | | `SOCKET` | `tezos-signer-unix` | Path to the local socket file, e.g. `/var/lib/tezos/.tezos-signer/socket` | `tezos-signer-unix` | -| `TEZOS_CLIENT_DIR` | `tezos-tx-rollup-node-` | Path to the tezos client data directory, e.g. `/var/lib/tezos/.tezos-client` | `tezos-tx-rollup-node-` | -| `NODE_RPC_SCHEME` | `tezos-tx-rollup-node-` | Scheme of the node RPC endpoint, e.g. `http`, `https` | `tezos-tx-rollup-node-` | -| `NODE_RPC_ADDR` | `tezos-tx-rollup-node-` | Address of the node RPC endpoint, e.g. `localhost:8732`, `node.example.org:8732` | `tezos-tx-rollup-node-` | -| `ROLLUP_NODE_RPC_ENDPOINT` | `tezos-tx-rollup-node-` | Address of this rollup node RPC endpoint, e.g. `127.0.0.1:8472` | `tezos-tx-rollup-node-` | -| `ROLLUP_MODE` | `tezos-tx-rollup-node-` | Rollup mode used by this node, e.g. `accuser`, `observer`, `batcher` | `tezos-tx-rollup-node-` | -| `ROLLUP_ALIAS` | `tezos-tx-rollup-node-` | Alias of the address to be used for rollup, e.g. `rollup` | `tezos-tx-rollup-node-` | +| `TEZOS_CLIENT_DIR` | `tezos-smart-rollup-node-` | Path to the tezos client data directory, e.g. `/var/lib/tezos/.tezos-client` | `tezos-smart-rollup-node-` | +| `NODE_RPC_SCHEME` | `tezos-smart-rollup-node-` | Scheme of the node RPC endpoint, e.g. `http`, `https` | `tezos-smart-rollup-node-` | +| `NODE_RPC_ADDR` | `tezos-smart-rollup-node-` | Address of the node RPC endpoint, e.g. `localhost:8732`, `node.example.org:8732` | `tezos-smart-rollup-node-` | +| `ROLLUP_NODE_RPC_ENDPOINT` | `tezos-smart-rollup-node-` | Address of this rollup node RPC endpoint, e.g. `127.0.0.1:8472` | `tezos-smart-rollup-node-` | +| `ROLLUP_MODE` | `tezos-smart-rollup-node-` | Rollup mode used by this node, e.g. `accuser`, `observer`, `batcher` | `tezos-smart-rollup-node-` | +| `ROLLUP_ALIAS` | `tezos-smart-rollup-node-` | Alias of the address to be used for rollup, e.g. `rollup` | `tezos-smart-rollup-node-` | +| `ROLLUP_OPERATORS` | `tezos-smart-rollup-node-` | Operator address or alias for node operations in non-observer modes | +`tezos-smart-rollup-node-` | diff --git a/docs/tx-rollup.md b/docs/smart-rollup.md similarity index 64% rename from docs/tx-rollup.md rename to docs/smart-rollup.md index 018710cd0..30f7a49dc 100644 --- a/docs/tx-rollup.md +++ b/docs/smart-rollup.md @@ -3,20 +3,20 @@ - SPDX-License-Identifier: LicenseRef-MIT-OA --> -# Setting up transaction rollup node on Ubuntu +# Setting up smart rollup node on Ubuntu At first you should originate rollup with the provided alias for some implicit account: ``` -sudo -u tezos tezos-client originate tx rollup from +sudo -u tezos tezos-client originate smart rollup from ``` After that, with the active `tezos-node` service available with the provided uri, run the following command ``` -systemctl start tezos-tx-rollup-node-.service +systemctl start tezos-smart-rollup-node-.service ``` Note: The `proto` variable can be every active protocol. -For futher details, see [the upstream documentation on transaction rollups](http://tezos.gitlab.io/active/transaction_rollups.html). +For further details, see [the upstream documentation on smart rollups](http://tezos.gitlab.io/active/smart_rollups.html). ## Options and defaults