Skip to content

Commit

Permalink
update docs for local deployment of rollup (#22)
Browse files Browse the repository at this point in the history
## Description
Removes repeated instructions and adds clarity to the "Overview" and
"Local Deployment" on dusknet sections.

## Motivation and Context
Make sure docs are clear and easy to follow- existing docs had repeated
instructions and had parts that were missing clarity.

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [X] Edits to existing documentation
- [ ] Changing documentation structure (relocating existing files,
ensure redirects exist)
- [ ] Stylistic changes (provide screenshots above)

---------

Co-authored-by: Camila Ramos <cami@Camilas-MacBook-Pro.local>
Co-authored-by: Josh Bowen <josh@astria.org>
  • Loading branch information
3 people committed Nov 28, 2023
1 parent f4645c4 commit 2aedc98
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/dusknet/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ the Sequencer.
## Local Dependencies

Clone the [dev-cluster](https://github.com/astriaorg/dev-cluster/tree/main) and
the main [astria repo](https://github.com/astriaorg/astria) repo:
install the astria cli [astria repo](https://github.com/astriaorg/astria):

```bash
git clone git@github.com:astriaorg/astria.git
git clone git@github.com:astriaorg/dev-cluster.git
cargo install astria-cli --git=https://github.com/astriaorg/astria --locked
```

And install the following tools:
Expand Down
20 changes: 3 additions & 17 deletions docs/dusknet/2-local-rollup-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,14 @@ dev-cluster](https://github.com/astriaorg/dev-cluster) to setup a local
Kubernetes (k8s) cluster where we will deploy our local rollup.

:::tip
Make sure that Docker is running before deploying with `just`.
Make sure that Docker is running before continuing.
:::

In the __dev-cluster repo__, run:

```sh
git clone git@github.com:astriaorg/dev-cluster.git
cd dev-cluster
just create-cluster
just deploy-ingress-controller
just wait-for-ingress-controller
```

This gives us a local environment compatible with our helm charts.
Expand Down Expand Up @@ -67,25 +64,14 @@ You can specify multiple accounts to be funded at
export ROLLUP_GENESIS_ACCOUNTS=<ADDRESS_1>:<BALANCE_1>,<ADDRESS_2>:<BALANCE_2>
```

## Install the `astria-cli`

Clone the [Astria repo](https://github.com/astriaorg/astria/tree/main) and build
a new config using the `astria-cli`.

```bash
git clone git@github.com:astriaorg/astria.git
cd astria
just install-cli
```

## Create Rollup Config

Replace the tags in the commands and env vars below, as follows:

| Var Name | Var Type | Description |
|-----|-----|-----|
| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs|
| `<YOUR_NETWORK_ID>` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) |
| `<YOUR_ROLLUP_NAME>` | String | The name of your rollup. This must be lowercase alphanumeric, `-` is allowed, this will be included in your rollup's URLs.|
| `<YOUR_NETWORK_ID>` | u64 | The id of your network. You must select an id that has not already been claimed. You can view claimed chain IDs [here](https://chainlist.org/).|

You can use environment variables to set the configuration for the rollup
config creation. Replace all the `<>` tags with their corresponding values.
Expand Down

0 comments on commit 2aedc98

Please sign in to comment.