Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update docs for local deployment of rollup #22

Merged
merged 8 commits into from
Nov 28, 2023
Merged

update docs for local deployment of rollup #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1abd2b1
updated docs for local deployment of rollup
Nov 23, 2023
6e9a8d9
linter fixes
Nov 23, 2023
40dfc5b
linter fixes
Nov 23, 2023
1748cc6
Update docs/dusknet/2-local-rollup-deployment.md
camiinthisthang Nov 23, 2023
c56cfe3
Update docs/dusknet/2-local-rollup-deployment.md
camiinthisthang Nov 23, 2023
5b36c1f
Update docs/dusknet/2-local-rollup-deployment.md
camiinthisthang Nov 23, 2023
602e0a8
remove tip
Nov 23, 2023
3614200
update cli installation, chain id instructions
Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dusknet/1-overview.md
View file
Open in desktop
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 [email protected]:astriaorg/astria.git
git clone [email protected]: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
View file
Open in desktop
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 [email protected]: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 [email protected]: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