Skip to content

Commit

Permalink
[#518] Remove transaction rollup mentions from repo
Browse files Browse the repository at this point in the history
Problem: Despite that transaction rollup was depricated, we still have a lot of mentions of it
in our repo

Solution: Remove all mentions of transaction rollup and patched
some scripts that used old bianries
  • Loading branch information
PruStephan committed Nov 16, 2023
1 parent b3b7f3a commit 40eb1fe
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 35 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docker/package/defaults/tezos-rollup-node.conf
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ NODE_RPC_ADDR="localhost:8732"
ROLLUP_NODE_RPC_ENDPOINT="127.0.0.1:8472"
ROLLUP_MODE="observer"
ROLLUP_ALIAS="rollup"
ROLLUP_OPERATORS=baker
ROLLUP_DATA_DIR=/var/lib/tezos/rollup
2 changes: 1 addition & 1 deletion docker/package/packages.py
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ def mk_units(proto):
Unit(after=["network.target"], description=f"Tezos smart rollup node"),
Service(
environment_files=[f"/etc/default/tezos-smart-rollup-node-{proto}"],
environment=[f"PROTOCOL={proto}", f"TYPE=sc"],
environment=[f"PROTOCOL={proto}"],
exec_start_pre=[
"+/usr/bin/setfacl -m u:tezos:rwx /run/systemd/ask-password"
],
Expand Down
14 changes: 12 additions & 2 deletions docker/package/scripts/tezos-rollup-node-start
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,22 @@ 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" \
--data-dir "$ROLLUP_DATA_DIR" \
--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 \
--data-dir "$ROLLUP_DATA_DIR"
14 changes: 8 additions & 6 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<proto>` | Path to the tezos client data directory, e.g. `/var/lib/tezos/.tezos-client` | `tezos-tx-rollup-node-<proto>` |
| `NODE_RPC_SCHEME` | `tezos-tx-rollup-node-<proto>` | Scheme of the node RPC endpoint, e.g. `http`, `https` | `tezos-tx-rollup-node-<proto>` |
| `NODE_RPC_ADDR` | `tezos-tx-rollup-node-<proto>` | Address of the node RPC endpoint, e.g. `localhost:8732`, `node.example.org:8732` | `tezos-tx-rollup-node-<proto>` |
| `ROLLUP_NODE_RPC_ENDPOINT` | `tezos-tx-rollup-node-<proto>` | Address of this rollup node RPC endpoint, e.g. `127.0.0.1:8472` | `tezos-tx-rollup-node-<proto>` |
| `ROLLUP_MODE` | `tezos-tx-rollup-node-<proto>` | Rollup mode used by this node, e.g. `accuser`, `observer`, `batcher` | `tezos-tx-rollup-node-<proto>` |
| `ROLLUP_ALIAS` | `tezos-tx-rollup-node-<proto>` | Alias of the address to be used for rollup, e.g. `rollup` | `tezos-tx-rollup-node-<proto>` |
| `TEZOS_CLIENT_DIR` | `tezos-smart-rollup-node-<proto>` | Path to the tezos client data directory, e.g. `/var/lib/tezos/.tezos-client` | `tezos-smart-rollup-node-<proto>` |
| `NODE_RPC_SCHEME` | `tezos-smart-rollup-node-<proto>` | Scheme of the node RPC endpoint, e.g. `http`, `https` | `tezos-smart-rollup-node-<proto>` |
| `NODE_RPC_ADDR` | `tezos-smart-rollup-node-<proto>` | Address of the node RPC endpoint, e.g. `localhost:8732`, `node.example.org:8732` | `tezos-smart-rollup-node-<proto>` |
| `ROLLUP_NODE_RPC_ENDPOINT` | `tezos-smart-rollup-node-<proto>` | Address of this rollup node RPC endpoint, e.g. `127.0.0.1:8472` | `tezos-smart-rollup-node-<proto>` |
| `ROLLUP_MODE` | `tezos-smart-rollup-node-<proto>` | Rollup mode used by this node, e.g. `accuser`, `observer`, `batcher` | `tezos-smart-rollup-node-<proto>` |
| `ROLLUP_ALIAS` | `tezos-smart-rollup-node-<proto>` | Alias of the address to be used for rollup, e.g. `rollup` | `tezos-smart-rollup-node-<proto>` |
| `ROLLUP_OPERATORS` | `tezos-smart-rollup-node-<proto>` | Operator address or alias for node operations in non-observer modes |`tezos-smart-rollup-node-<proto>`|
| `ROLLUP_DATA_DIR`| `tezos-smart-rollup-node-<proto>` | Directory to store rollup data | `tezos-smart-rollup-node-<proto>` |
45 changes: 45 additions & 0 deletions docs/smart-rollup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!--
- SPDX-FileCopyrightText: 2022 Oxhead Alpha
- SPDX-License-Identifier: LicenseRef-MIT-OA
-->

# 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 smart rollup <ROLLUP_ALIAS> from <IMPLICIT_ACCOUNT_ALIAS> of kind <SMART_ROLLUP_KIND> of type <ROLLUP_PARAMETER_TYPE> with kernel <KERNEL>
```
Here:
* `ROLLUP_ALIAS` - Name for a new smart rollup
* `IMPLICIT_ACCOUNT_ALIAS` - Name of the account originating smart rollup
* `SMART_ROLLUP_KIND` - Kind of proof-generating virtual machine (PVM)
* `ROLLUP_PARAMETER_TYPE` - The interface of smart rollup (with entrypoints and signatures)
* `KERNEL` - The kernel of smart rollup that PVM can interpret

For more information on smart rollup origination you can check - https://tezos.gitlab.io/alpha/smart_rollups.html#origination

You can use the following command this way:

```
octez-client originate smart rollup "my-rollup" \
from "bob" \
of kind wasm_2_0_0 \
of type unit \
with kernel "file:kernel.hex"
```

For more extended example please proceed to https://www.marigold.dev/post/originating-a-smart-rollup

After that, with the active `tezos-node` service available with the provided uri, run the following command
```
systemctl start tezos-smart-rollup-node-<proto>.service
```
Note: The `proto` variable can be every active protocol.

For further details, see [the upstream documentation on smart rollups](http://tezos.gitlab.io/active/smart_rollups.html).

## Options and defaults

As any other `systemd` services ditributed here, rollup binaries have settable
options, see [the dedicated documentation](./configuration.md) to see their
default values and how to change these.
25 changes: 0 additions & 25 deletions docs/tx-rollup.md

This file was deleted.

0 comments on commit 40eb1fe

Please sign in to comment.