Skip to content

Commit

Permalink
fix(docs): Add missing step of updating rollup name in base-config.to…
Browse files Browse the repository at this point in the history
…ml (#114)

There was a missing step in the tutorials for updating the rollup name
in the `base-config.toml`:`astria_composer_rollups` value. This step and
a `sed` command have now been added.
  • Loading branch information
sambukowski authored Jan 30, 2025
1 parent 869628d commit ba7ee0f
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
16 changes: 14 additions & 2 deletions docs/tutorials/run-local-rollup-against-remote-sequencer.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,15 +124,27 @@ rollup_name = '<your rollup name>'
default_denom = 'ntia'
```

Open the `~/.astria/default/config/base-config.toml` and update the
`"astria_composer_rollups"` value to have your rollup name:

```toml
astria_composer_rollups = '<your rollup name>::ws://127.0.0.1:8546'
```

::: tip

You can perform the above steps using the following commands. `NEW_NAME` should
match the `"astriaRollupName"` in your `dev/geth-genesis-local.json`:

```shell
export NEW_NAME="my-new-chain"
cd ~/.astria/default/
sed -i '' '/\[networks\.local\]/,/^$/ s/rollup_name = .*/rollup_name = "'"$NEW_NAME"'"/' ~/.astria/default/networks-config.toml
export INSTANCE="default"
cd ~/.astria/$INSTANCE/
sed -i '' '/\[networks\.local\]/,/^$/ s/rollup_name = .*/rollup_name = "'"$NEW_NAME"'"/' \
./networks-config.toml
sed -i '' \
's/\(astria_composer_rollups = '"'"'\)[^:]*::/\1'"$NEW_NAME"'::/g' \
./config/base-config.toml
```

:::
Expand Down
18 changes: 15 additions & 3 deletions docs/tutorials/run-local-rollup-and-sequencer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Requires `Go`, `just`, `make`, and `Foundry`:

Open a new terminal window and clone and build Geth:

<!--@include: ../../components/_clone-build-astria-geth.md-->
<!--@include: ../components/_clone-build-astria-geth.md-->

Create a new genesis account for your Geth rollup:

Expand Down Expand Up @@ -98,15 +98,27 @@ rollup_name = '<your rollup name>'
default_denom = 'ntia'
```

Open the `~/.astria/default/config/base-config.toml` and update the
`"astria_composer_rollups"` value to have your rollup name:

```toml
astria_composer_rollups = '<your rollup name>::ws://127.0.0.1:8546'
```

::: tip

You can perform the above steps using the following commands. `NEW_NAME` should
match the `"astriaRollupName"` in your `dev/geth-genesis-local.json`:

```shell
export NEW_NAME="my-new-chain"
cd ~/.astria/default/
sed -i '' '/\[networks\.local\]/,/^$/ s/rollup_name = .*/rollup_name = "'"$NEW_NAME"'"/' ~/.astria/default/networks-config.toml
export INSTANCE="default"
cd ~/.astria/$INSTANCE/
sed -i '' '/\[networks\.local\]/,/^$/ s/rollup_name = .*/rollup_name = "'"$NEW_NAME"'"/' \
./networks-config.toml
sed -i '' \
's/\(astria_composer_rollups = '"'"'\)[^:]*::/\1'"$NEW_NAME"'::/g' \
./config/base-config.toml
```

:::
Expand Down

0 comments on commit ba7ee0f

Please sign in to comment.