From 1abd2b1b4f8dab1b5b97f2451e28f41fc4fa6428 Mon Sep 17 00:00:00 2001 From: Camila Ramos Date: Thu, 23 Nov 2023 13:16:15 -0500 Subject: [PATCH 1/8] updated docs for local deployment of rollup --- docs/dusknet/2-local-rollup-deployment.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 4594e4b..a01a352 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -11,14 +11,12 @@ 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 @@ -32,6 +30,10 @@ This gives us a local environment compatible with our helm charts. __NEVER__ use a private key you use on a live network. ::: +:::tip +Open a new terminal window for the following instructions. Keep your original terminal process running. +::: + You can add genesis account(s) to your rollup during configuration. You can create an account using: @@ -69,11 +71,10 @@ export ROLLUP_GENESIS_ACCOUNTS=:,: ## Install the `astria-cli` -Clone the [Astria repo](https://github.com/astriaorg/astria/tree/main) and build +Navigate to your [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 ``` @@ -84,8 +85,8 @@ Replace the tags in the commands and env vars below, as follows: | Var Name | Var Type | Description | |-----|-----|-----| -| `` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs| -| `` | u64 | The id of your network. Pick a > 6 digit number (eg. `123456`) | +| `` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs. Letters must be in lowercase.| +| `` | u64 | The id of your network. Pick a >= 6 digit number (eg. `123456`) | You can use environment variables to set the configuration for the rollup config creation. Replace all the `<>` tags with their corresponding values. From 6e9a8d94feb66d3ad3f4d632015c6735f3728e13 Mon Sep 17 00:00:00 2001 From: Camila Ramos Date: Thu, 23 Nov 2023 13:26:37 -0500 Subject: [PATCH 2/8] linter fixes --- docs/dusknet/2-local-rollup-deployment.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index a01a352..6d42510 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -31,7 +31,8 @@ __NEVER__ use a private key you use on a live network. ::: :::tip -Open a new terminal window for the following instructions. Keep your original terminal process running. +Open a new terminal window for the following instructions. +Keep your initial terminal process running. ::: You can add genesis account(s) to your rollup during configuration. @@ -71,8 +72,8 @@ export ROLLUP_GENESIS_ACCOUNTS=:,: ## Install the `astria-cli` -Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) and build -a new config using the `astria-cli`. +Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) +and build a new config using the `astria-cli`. ```bash cd astria From 40dfc5b4d9e1768316cf57bf5c642337989e9f3a Mon Sep 17 00:00:00 2001 From: Camila Ramos Date: Thu, 23 Nov 2023 13:30:00 -0500 Subject: [PATCH 3/8] linter fixes --- docs/dusknet/2-local-rollup-deployment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 6d42510..a7834c9 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -31,7 +31,7 @@ __NEVER__ use a private key you use on a live network. ::: :::tip -Open a new terminal window for the following instructions. +Open a new terminal window for the following instructions. Keep your initial terminal process running. ::: @@ -72,7 +72,7 @@ export ROLLUP_GENESIS_ACCOUNTS=:,: ## Install the `astria-cli` -Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) +Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) and build a new config using the `astria-cli`. ```bash From 1748cc6298374131ffe072b6339237ce22dd21e7 Mon Sep 17 00:00:00 2001 From: Camila Date: Thu, 23 Nov 2023 20:38:40 +0100 Subject: [PATCH 4/8] Update docs/dusknet/2-local-rollup-deployment.md Co-authored-by: Josh Bowen --- docs/dusknet/2-local-rollup-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index a7834c9..3060fa1 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -86,7 +86,7 @@ Replace the tags in the commands and env vars below, as follows: | Var Name | Var Type | Description | |-----|-----|-----| -| `` | String | The name of your rollup. This must be alphanumeric, `-` is allowed, this will be included in URLs. Letters must be in lowercase.| +| `` | String | The name of your rollup. This must be lowercase alphanumeric, `-` is allowed, this will be included in your rollup's URLs.| | `` | u64 | The id of your network. Pick a >= 6 digit number (eg. `123456`) | You can use environment variables to set the configuration for the rollup From c56cfe32384f46c5b071eb8b26085c62e330ab05 Mon Sep 17 00:00:00 2001 From: Camila Date: Thu, 23 Nov 2023 20:38:52 +0100 Subject: [PATCH 5/8] Update docs/dusknet/2-local-rollup-deployment.md Co-authored-by: Josh Bowen --- docs/dusknet/2-local-rollup-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 3060fa1..8ec506c 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -73,7 +73,7 @@ export ROLLUP_GENESIS_ACCOUNTS=:,: ## Install the `astria-cli` Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) -and build a new config using the `astria-cli`. +and install the `astria-cli`. ```bash cd astria From 5b36c1f123278afaf7745a6039ef5ccbd1e6c938 Mon Sep 17 00:00:00 2001 From: Camila Date: Thu, 23 Nov 2023 21:46:10 +0100 Subject: [PATCH 6/8] Update docs/dusknet/2-local-rollup-deployment.md Co-authored-by: Josh Bowen --- docs/dusknet/2-local-rollup-deployment.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 8ec506c..00a56ce 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -19,7 +19,6 @@ In the __dev-cluster repo__, run: ```sh just create-cluster just deploy-ingress-controller -just wait-for-ingress-controller ``` This gives us a local environment compatible with our helm charts. From 602e0a8d46f2e51904efef2d29b7f20feeea8831 Mon Sep 17 00:00:00 2001 From: Camila Ramos Date: Thu, 23 Nov 2023 15:47:46 -0500 Subject: [PATCH 7/8] remove tip --- docs/dusknet/2-local-rollup-deployment.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 00a56ce..53ac1f9 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -29,11 +29,6 @@ This gives us a local environment compatible with our helm charts. __NEVER__ use a private key you use on a live network. ::: -:::tip -Open a new terminal window for the following instructions. -Keep your initial terminal process running. -::: - You can add genesis account(s) to your rollup during configuration. You can create an account using: From 3614200df5cd37a19a21818e594df384c6b11979 Mon Sep 17 00:00:00 2001 From: Camila Ramos Date: Mon, 27 Nov 2023 15:19:18 -0500 Subject: [PATCH 8/8] update cli installation, chain id instructions --- docs/dusknet/1-overview.md | 4 ++-- docs/dusknet/2-local-rollup-deployment.md | 12 +----------- 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/dusknet/1-overview.md b/docs/dusknet/1-overview.md index 1605178..0b0f359 100644 --- a/docs/dusknet/1-overview.md +++ b/docs/dusknet/1-overview.md @@ -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: diff --git a/docs/dusknet/2-local-rollup-deployment.md b/docs/dusknet/2-local-rollup-deployment.md index 53ac1f9..5a3157e 100644 --- a/docs/dusknet/2-local-rollup-deployment.md +++ b/docs/dusknet/2-local-rollup-deployment.md @@ -64,16 +64,6 @@ You can specify multiple accounts to be funded at export ROLLUP_GENESIS_ACCOUNTS=:,: ``` -## Install the `astria-cli` - -Navigate to your [Astria repo](https://github.com/astriaorg/astria/tree/main) -and install the `astria-cli`. - -```bash -cd astria -just install-cli -``` - ## Create Rollup Config Replace the tags in the commands and env vars below, as follows: @@ -81,7 +71,7 @@ Replace the tags in the commands and env vars below, as follows: | Var Name | Var Type | Description | |-----|-----|-----| | `` | String | The name of your rollup. This must be lowercase alphanumeric, `-` is allowed, this will be included in your rollup's URLs.| -| `` | u64 | The id of your network. Pick a >= 6 digit number (eg. `123456`) | +| `` | 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.